docs_src/dependencies/tutorial002.py

from typing import Union

from fastapi import Depends, FastAPI

app = FastAPI()


fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]


class CommonQueryParams:
    def __init__(self, q: Union[str, None] = None, skip: int = 0, limit: int = 100):
        self.q = q
        self.skip = skip
        self.limit = limit


@app.get("/items/")
async def read_items(commons: CommonQueryParams = Depends(CommonQueryParams)):
    response = {}
    if commons.q:
        response.update({"q": commons.q})
    items = fake_items_db[commons.skip : commons.skip + commons.limit]
    response.update({"items": items})
    return response
📝 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 Depends, FastAPI`

:memo: Add fist Dependency Injection docs 2018-12-15 18:15:42 +04:00			`app = FastAPI()`


			`fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]`


:memo: Update and add docs for dependencies 2018-12-23 21:21:37 +04:00			`class CommonQueryParams:`
📝 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			`def __init__(self, q: Union[str, None] = None, skip: int = 0, limit: int = 100):`
:memo: Update and add docs for dependencies 2018-12-23 21:21:37 +04:00			`self.q = q`
			`self.skip = skip`
			`self.limit = limit`
:memo: Add fist Dependency Injection docs 2018-12-15 18:15:42 +04:00

			`@app.get("/items/")`
:memo: Update and add docs for dependencies 2018-12-23 21:21:37 +04:00			`async def read_items(commons: CommonQueryParams = Depends(CommonQueryParams)):`
:memo: Add fist Dependency Injection docs 2018-12-15 18:15:42 +04:00			`response = {}`
			`if commons.q:`
			`response.update({"q": commons.q})`
:arrow_up: Add tests, fix issues and update Pydantic 2018-12-28 16:10:29 +04:00			`items = fake_items_db[commons.skip : commons.skip + commons.limit]`
:memo: Add fist Dependency Injection docs 2018-12-15 18:15:42 +04:00			`response.update({"items": items})`
			`return response`