docs_src/body/tutorial004.py

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None


app = FastAPI()


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item, q: Union[str, None] = None):
    result = {"item_id": item_id, **item.dict()}
    if q:
        result.update({"q": q})
    return result
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) * 📝 Add docs recommending Union over Optional * 📝 Update docs recommending Union over Optional * 📝 Update source examples for docs, recommend Union over Optional * 📝 Update highlighted lines with updated source examples * 📝 Update highlighted lines in Markdown with recent code changes * 📝 Update docs, use Union instead of Optional * ♻️ Update source examples to recommend Union over Optional * 🎨 Update highlighted code in Markdown after moving from Optional to Union 2022-05-14 06:59:59 -05:00			`from typing import Union`
📝 Use Optional in docs (#1644) * Updated .py files with Optional tag (up to body_nested_models) * Update optionals * docs_src/ all updates, few I was unsure of * Updated markdown files with Optional param * es: Add Optional typing to index.md * Last of markdown files updated with Optional param * Update highlight lines * it: Add Optional typings * README.md: Update with Optional typings * Update more highlight increments * Update highlights * schema-extra-example.md: Update highlights * updating highlighting on website to reflect .py changes * Update highlighting for query-params & response-directly * Address PR comments * Get rid of unnecessary comment * ⏪ Revert Optional in Chinese docs as it probably also requires changes in text * 🎨 Apply format * ⏪ Revert modified example * ♻️ Simplify example in docs * 📝 Update OpenAPI callback example to use Optional * ✨ Add Optional types to tests * 📝 Update docs about query params, default to using Optional * 🎨 Update code examples line highlighting * 📝 Update nested models docs to use "type parameters" instead of "subtypes" * 📝 Add notes about FastAPI usage of None including: = None and = Query(None) and clarify relationship with Optional[str] * 📝 Add note about response_model_by_alias * ♻️ Simplify query param list example * 🔥 Remove test for removed example * ✅ Update test for updated example Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com> Co-authored-by: yk396 <yk396@cornell.edu> Co-authored-by: Kai Chen <kaichen120@gmail.com> 2020-06-28 20:13:30 +02:00
:recycle: Re-format tutorials, files names and tests for tutorial files 2018-12-18 21:59:06 +04:00			`from fastapi import FastAPI`
:green_heart: Revert to flit install and re-format As it has shown to be more reliable, and closer to final user environments 2018-12-18 22:36:04 +04:00			`from pydantic import BaseModel`
:recycle: Re-format tutorials, files names and tests for tutorial files 2018-12-18 21:59:06 +04:00
:art: Lint and format tutorial src files 2018-12-13 21:48:37 +04:00
:truck: Re-sort tutorial example files 2018-12-13 21:25:45 +04:00			`class Item(BaseModel):`
			`name: str`
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) * 📝 Add docs recommending Union over Optional * 📝 Update docs recommending Union over Optional * 📝 Update source examples for docs, recommend Union over Optional * 📝 Update highlighted lines with updated source examples * 📝 Update highlighted lines in Markdown with recent code changes * 📝 Update docs, use Union instead of Optional * ♻️ Update source examples to recommend Union over Optional * 🎨 Update highlighted code in Markdown after moving from Optional to Union 2022-05-14 06:59:59 -05:00			`description: Union[str, None] = None`
:truck: Re-sort tutorial example files 2018-12-13 21:25:45 +04:00			`price: float`
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) * 📝 Add docs recommending Union over Optional * 📝 Update docs recommending Union over Optional * 📝 Update source examples for docs, recommend Union over Optional * 📝 Update highlighted lines with updated source examples * 📝 Update highlighted lines in Markdown with recent code changes * 📝 Update docs, use Union instead of Optional * ♻️ Update source examples to recommend Union over Optional * 🎨 Update highlighted code in Markdown after moving from Optional to Union 2022-05-14 06:59:59 -05:00			`tax: Union[float, None] = None`
:memo: Add first tutorial src files 2018-12-13 21:05:15 +04:00

:truck: Re-sort tutorial example files 2018-12-13 21:25:45 +04:00			`app = FastAPI()`
:memo: Add first tutorial src files 2018-12-13 21:05:15 +04:00
:art: Lint and format tutorial src files 2018-12-13 21:48:37 +04:00
:truck: Re-sort tutorial example files 2018-12-13 21:25:45 +04:00			`@app.put("/items/{item_id}")`
📝 Update code examples in docs for body, replace name `create_item` with `update_item` when appropriate (#5913) 2024-01-09 21:28:58 +07:00			`async def update_item(item_id: int, item: Item, q: Union[str, None] = None):`
:truck: Re-sort tutorial example files 2018-12-13 21:25:45 +04:00			`result = {"item_id": item_id, **item.dict()}`
:memo: Add first tutorial src files 2018-12-13 21:05:15 +04:00			`if q:`
:truck: Re-sort tutorial example files 2018-12-13 21:25:45 +04:00			`result.update({"q": q})`
			`return result`