| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460 |
- from collections.abc import Callable, Sequence
- from typing import Annotated, Any, Literal
- from annotated_doc import Doc
- from fastapi import params
- from fastapi._compat import Undefined
- from fastapi.datastructures import _Unset
- from fastapi.openapi.models import Example
- from pydantic import AliasChoices, AliasPath
- from typing_extensions import deprecated
- def Path( # noqa: N802
- default: Annotated[
- Any,
- Doc(
- """
- Default value if the parameter field is not set.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = ...,
- *,
- default_factory: Annotated[
- Callable[[], Any] | None,
- Doc(
- """
- A callable to generate the default value.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = _Unset,
- alias: Annotated[
- str | None,
- Doc(
- """
- An alternative name for the parameter field.
- This will be used to extract the data and for the generated OpenAPI.
- It is particularly useful when you can't use the name you want because it
- is a Python reserved keyword or similar.
- """
- ),
- ] = None,
- alias_priority: Annotated[
- int | None,
- Doc(
- """
- Priority of the alias. This affects whether an alias generator is used.
- """
- ),
- ] = _Unset,
- validation_alias: Annotated[
- str | AliasPath | AliasChoices | None,
- Doc(
- """
- 'Whitelist' validation step. The parameter field will be the single one
- allowed by the alias or set of aliases defined.
- """
- ),
- ] = None,
- serialization_alias: Annotated[
- str | None,
- Doc(
- """
- 'Blacklist' validation step. The vanilla parameter field will be the
- single one of the alias' or set of aliases' fields and all the other
- fields will be ignored at serialization time.
- """
- ),
- ] = None,
- title: Annotated[
- str | None,
- Doc(
- """
- Human-readable title.
- Read more about it in the
- [FastAPI docs for Path Parameters and Numeric Validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#declare-metadata)
- """
- ),
- ] = None,
- description: Annotated[
- str | None,
- Doc(
- """
- Human-readable description.
- """
- ),
- ] = None,
- gt: Annotated[
- float | None,
- Doc(
- """
- Greater than. If set, value must be greater than this. Only applicable to
- numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- ge: Annotated[
- float | None,
- Doc(
- """
- Greater than or equal. If set, value must be greater than or equal to
- this. Only applicable to numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- lt: Annotated[
- float | None,
- Doc(
- """
- Less than. If set, value must be less than this. Only applicable to numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- le: Annotated[
- float | None,
- Doc(
- """
- Less than or equal. If set, value must be less than or equal to this.
- Only applicable to numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- min_length: Annotated[
- int | None,
- Doc(
- """
- Minimum length for strings.
- """
- ),
- ] = None,
- max_length: Annotated[
- int | None,
- Doc(
- """
- Maximum length for strings.
- """
- ),
- ] = None,
- pattern: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- ] = None,
- regex: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- deprecated(
- "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
- ),
- ] = None,
- discriminator: Annotated[
- str | None,
- Doc(
- """
- Parameter field name for discriminating the type in a tagged union.
- """
- ),
- ] = None,
- strict: Annotated[
- bool | None,
- Doc(
- """
- If `True`, strict validation is applied to the field.
- """
- ),
- ] = _Unset,
- multiple_of: Annotated[
- float | None,
- Doc(
- """
- Value must be a multiple of this. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- allow_inf_nan: Annotated[
- bool | None,
- Doc(
- """
- Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- max_digits: Annotated[
- int | None,
- Doc(
- """
- Maximum number of digits allowed for decimal values.
- """
- ),
- ] = _Unset,
- decimal_places: Annotated[
- int | None,
- Doc(
- """
- Maximum number of decimal places allowed for decimal values.
- """
- ),
- ] = _Unset,
- examples: Annotated[
- list[Any] | None,
- Doc(
- """
- Example values for this field.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
- """
- ),
- ] = None,
- example: Annotated[
- Any | None,
- deprecated(
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
- "although still supported. Use examples instead."
- ),
- ] = _Unset,
- openapi_examples: Annotated[
- dict[str, Example] | None,
- Doc(
- """
- OpenAPI-specific examples.
- It will be added to the generated OpenAPI (e.g. visible at `/docs`).
- Swagger UI (that provides the `/docs` interface) has better support for the
- OpenAPI-specific examples than the JSON Schema `examples`, that's the main
- use case for this.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
- """
- ),
- ] = None,
- deprecated: Annotated[
- deprecated | str | bool | None,
- Doc(
- """
- Mark this parameter field as deprecated.
- It will affect the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = None,
- include_in_schema: Annotated[
- bool,
- Doc(
- """
- To include (or not) this parameter field in the generated OpenAPI.
- You probably don't need it, but it's available.
- This affects the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = True,
- json_schema_extra: Annotated[
- dict[str, Any] | None,
- Doc(
- """
- Any additional JSON schema data.
- """
- ),
- ] = None,
- **extra: Annotated[
- Any,
- Doc(
- """
- Include extra fields used by the JSON Schema.
- """
- ),
- deprecated(
- """
- The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
- """
- ),
- ],
- ) -> Any:
- """
- Declare a path parameter for a *path operation*.
- Read more about it in the
- [FastAPI docs for Path Parameters and Numeric Validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/).
- ```python
- from typing import Annotated
- from fastapi import FastAPI, Path
- app = FastAPI()
- @app.get("/items/{item_id}")
- async def read_items(
- item_id: Annotated[int, Path(title="The ID of the item to get")],
- ):
- return {"item_id": item_id}
- ```
- """
- return params.Path(
- default=default,
- default_factory=default_factory,
- alias=alias,
- alias_priority=alias_priority,
- validation_alias=validation_alias,
- serialization_alias=serialization_alias,
- title=title,
- description=description,
- gt=gt,
- ge=ge,
- lt=lt,
- le=le,
- min_length=min_length,
- max_length=max_length,
- pattern=pattern,
- regex=regex,
- discriminator=discriminator,
- strict=strict,
- multiple_of=multiple_of,
- allow_inf_nan=allow_inf_nan,
- max_digits=max_digits,
- decimal_places=decimal_places,
- example=example,
- examples=examples,
- openapi_examples=openapi_examples,
- deprecated=deprecated,
- include_in_schema=include_in_schema,
- json_schema_extra=json_schema_extra,
- **extra,
- )
- def Query( # noqa: N802
- default: Annotated[
- Any,
- Doc(
- """
- Default value if the parameter field is not set.
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#alternative-old-query-as-the-default-value)
- """
- ),
- ] = Undefined,
- *,
- default_factory: Annotated[
- Callable[[], Any] | None,
- Doc(
- """
- A callable to generate the default value.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = _Unset,
- alias: Annotated[
- str | None,
- Doc(
- """
- An alternative name for the parameter field.
- This will be used to extract the data and for the generated OpenAPI.
- It is particularly useful when you can't use the name you want because it
- is a Python reserved keyword or similar.
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#alias-parameters)
- """
- ),
- ] = None,
- alias_priority: Annotated[
- int | None,
- Doc(
- """
- Priority of the alias. This affects whether an alias generator is used.
- """
- ),
- ] = _Unset,
- validation_alias: Annotated[
- str | AliasPath | AliasChoices | None,
- Doc(
- """
- 'Whitelist' validation step. The parameter field will be the single one
- allowed by the alias or set of aliases defined.
- """
- ),
- ] = None,
- serialization_alias: Annotated[
- str | None,
- Doc(
- """
- 'Blacklist' validation step. The vanilla parameter field will be the
- single one of the alias' or set of aliases' fields and all the other
- fields will be ignored at serialization time.
- """
- ),
- ] = None,
- title: Annotated[
- str | None,
- Doc(
- """
- Human-readable title.
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#declare-more-metadata)
- """
- ),
- ] = None,
- description: Annotated[
- str | None,
- Doc(
- """
- Human-readable description.
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#declare-more-metadata)
- """
- ),
- ] = None,
- gt: Annotated[
- float | None,
- Doc(
- """
- Greater than. If set, value must be greater than this. Only applicable to
- numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- ge: Annotated[
- float | None,
- Doc(
- """
- Greater than or equal. If set, value must be greater than or equal to
- this. Only applicable to numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- lt: Annotated[
- float | None,
- Doc(
- """
- Less than. If set, value must be less than this. Only applicable to numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- le: Annotated[
- float | None,
- Doc(
- """
- Less than or equal. If set, value must be less than or equal to this.
- Only applicable to numbers.
- Read more about it in the
- [FastAPI docs about Path parameters numeric validations](https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#number-validations-greater-than-and-less-than-or-equal)
- """
- ),
- ] = None,
- min_length: Annotated[
- int | None,
- Doc(
- """
- Minimum length for strings.
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/)
- """
- ),
- ] = None,
- max_length: Annotated[
- int | None,
- Doc(
- """
- Maximum length for strings.
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/)
- """
- ),
- ] = None,
- pattern: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#add-regular-expressions
- """
- ),
- ] = None,
- regex: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- deprecated(
- "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
- ),
- ] = None,
- discriminator: Annotated[
- str | None,
- Doc(
- """
- Parameter field name for discriminating the type in a tagged union.
- """
- ),
- ] = None,
- strict: Annotated[
- bool | None,
- Doc(
- """
- If `True`, strict validation is applied to the field.
- """
- ),
- ] = _Unset,
- multiple_of: Annotated[
- float | None,
- Doc(
- """
- Value must be a multiple of this. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- allow_inf_nan: Annotated[
- bool | None,
- Doc(
- """
- Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- max_digits: Annotated[
- int | None,
- Doc(
- """
- Maximum number of digits allowed for decimal values.
- """
- ),
- ] = _Unset,
- decimal_places: Annotated[
- int | None,
- Doc(
- """
- Maximum number of decimal places allowed for decimal values.
- """
- ),
- ] = _Unset,
- examples: Annotated[
- list[Any] | None,
- Doc(
- """
- Example values for this field.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
- """
- ),
- ] = None,
- example: Annotated[
- Any | None,
- deprecated(
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
- "although still supported. Use examples instead."
- ),
- ] = _Unset,
- openapi_examples: Annotated[
- dict[str, Example] | None,
- Doc(
- """
- OpenAPI-specific examples.
- It will be added to the generated OpenAPI (e.g. visible at `/docs`).
- Swagger UI (that provides the `/docs` interface) has better support for the
- OpenAPI-specific examples than the JSON Schema `examples`, that's the main
- use case for this.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
- """
- ),
- ] = None,
- deprecated: Annotated[
- deprecated | str | bool | None,
- Doc(
- """
- Mark this parameter field as deprecated.
- It will affect the generated OpenAPI (e.g. visible at `/docs`).
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#deprecating-parameters)
- """
- ),
- ] = None,
- include_in_schema: Annotated[
- bool,
- Doc(
- """
- To include (or not) this parameter field in the generated OpenAPI.
- You probably don't need it, but it's available.
- This affects the generated OpenAPI (e.g. visible at `/docs`).
- Read more about it in the
- [FastAPI docs about Query parameters](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi
- """
- ),
- ] = True,
- json_schema_extra: Annotated[
- dict[str, Any] | None,
- Doc(
- """
- Any additional JSON schema data.
- """
- ),
- ] = None,
- **extra: Annotated[
- Any,
- Doc(
- """
- Include extra fields used by the JSON Schema.
- """
- ),
- deprecated(
- """
- The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
- """
- ),
- ],
- ) -> Any:
- return params.Query(
- default=default,
- default_factory=default_factory,
- alias=alias,
- alias_priority=alias_priority,
- validation_alias=validation_alias,
- serialization_alias=serialization_alias,
- title=title,
- description=description,
- gt=gt,
- ge=ge,
- lt=lt,
- le=le,
- min_length=min_length,
- max_length=max_length,
- pattern=pattern,
- regex=regex,
- discriminator=discriminator,
- strict=strict,
- multiple_of=multiple_of,
- allow_inf_nan=allow_inf_nan,
- max_digits=max_digits,
- decimal_places=decimal_places,
- example=example,
- examples=examples,
- openapi_examples=openapi_examples,
- deprecated=deprecated,
- include_in_schema=include_in_schema,
- json_schema_extra=json_schema_extra,
- **extra,
- )
- def Header( # noqa: N802
- default: Annotated[
- Any,
- Doc(
- """
- Default value if the parameter field is not set.
- """
- ),
- ] = Undefined,
- *,
- default_factory: Annotated[
- Callable[[], Any] | None,
- Doc(
- """
- A callable to generate the default value.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = _Unset,
- alias: Annotated[
- str | None,
- Doc(
- """
- An alternative name for the parameter field.
- This will be used to extract the data and for the generated OpenAPI.
- It is particularly useful when you can't use the name you want because it
- is a Python reserved keyword or similar.
- """
- ),
- ] = None,
- alias_priority: Annotated[
- int | None,
- Doc(
- """
- Priority of the alias. This affects whether an alias generator is used.
- """
- ),
- ] = _Unset,
- validation_alias: Annotated[
- str | AliasPath | AliasChoices | None,
- Doc(
- """
- 'Whitelist' validation step. The parameter field will be the single one
- allowed by the alias or set of aliases defined.
- """
- ),
- ] = None,
- serialization_alias: Annotated[
- str | None,
- Doc(
- """
- 'Blacklist' validation step. The vanilla parameter field will be the
- single one of the alias' or set of aliases' fields and all the other
- fields will be ignored at serialization time.
- """
- ),
- ] = None,
- convert_underscores: Annotated[
- bool,
- Doc(
- """
- Automatically convert underscores to hyphens in the parameter field name.
- Read more about it in the
- [FastAPI docs for Header Parameters](https://fastapi.tiangolo.com/tutorial/header-params/#automatic-conversion)
- """
- ),
- ] = True,
- title: Annotated[
- str | None,
- Doc(
- """
- Human-readable title.
- """
- ),
- ] = None,
- description: Annotated[
- str | None,
- Doc(
- """
- Human-readable description.
- """
- ),
- ] = None,
- gt: Annotated[
- float | None,
- Doc(
- """
- Greater than. If set, value must be greater than this. Only applicable to
- numbers.
- """
- ),
- ] = None,
- ge: Annotated[
- float | None,
- Doc(
- """
- Greater than or equal. If set, value must be greater than or equal to
- this. Only applicable to numbers.
- """
- ),
- ] = None,
- lt: Annotated[
- float | None,
- Doc(
- """
- Less than. If set, value must be less than this. Only applicable to numbers.
- """
- ),
- ] = None,
- le: Annotated[
- float | None,
- Doc(
- """
- Less than or equal. If set, value must be less than or equal to this.
- Only applicable to numbers.
- """
- ),
- ] = None,
- min_length: Annotated[
- int | None,
- Doc(
- """
- Minimum length for strings.
- """
- ),
- ] = None,
- max_length: Annotated[
- int | None,
- Doc(
- """
- Maximum length for strings.
- """
- ),
- ] = None,
- pattern: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- ] = None,
- regex: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- deprecated(
- "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
- ),
- ] = None,
- discriminator: Annotated[
- str | None,
- Doc(
- """
- Parameter field name for discriminating the type in a tagged union.
- """
- ),
- ] = None,
- strict: Annotated[
- bool | None,
- Doc(
- """
- If `True`, strict validation is applied to the field.
- """
- ),
- ] = _Unset,
- multiple_of: Annotated[
- float | None,
- Doc(
- """
- Value must be a multiple of this. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- allow_inf_nan: Annotated[
- bool | None,
- Doc(
- """
- Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- max_digits: Annotated[
- int | None,
- Doc(
- """
- Maximum number of digits allowed for decimal values.
- """
- ),
- ] = _Unset,
- decimal_places: Annotated[
- int | None,
- Doc(
- """
- Maximum number of decimal places allowed for decimal values.
- """
- ),
- ] = _Unset,
- examples: Annotated[
- list[Any] | None,
- Doc(
- """
- Example values for this field.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
- """
- ),
- ] = None,
- example: Annotated[
- Any | None,
- deprecated(
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
- "although still supported. Use examples instead."
- ),
- ] = _Unset,
- openapi_examples: Annotated[
- dict[str, Example] | None,
- Doc(
- """
- OpenAPI-specific examples.
- It will be added to the generated OpenAPI (e.g. visible at `/docs`).
- Swagger UI (that provides the `/docs` interface) has better support for the
- OpenAPI-specific examples than the JSON Schema `examples`, that's the main
- use case for this.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
- """
- ),
- ] = None,
- deprecated: Annotated[
- deprecated | str | bool | None,
- Doc(
- """
- Mark this parameter field as deprecated.
- It will affect the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = None,
- include_in_schema: Annotated[
- bool,
- Doc(
- """
- To include (or not) this parameter field in the generated OpenAPI.
- You probably don't need it, but it's available.
- This affects the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = True,
- json_schema_extra: Annotated[
- dict[str, Any] | None,
- Doc(
- """
- Any additional JSON schema data.
- """
- ),
- ] = None,
- **extra: Annotated[
- Any,
- Doc(
- """
- Include extra fields used by the JSON Schema.
- """
- ),
- deprecated(
- """
- The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
- """
- ),
- ],
- ) -> Any:
- return params.Header(
- default=default,
- default_factory=default_factory,
- alias=alias,
- alias_priority=alias_priority,
- validation_alias=validation_alias,
- serialization_alias=serialization_alias,
- convert_underscores=convert_underscores,
- title=title,
- description=description,
- gt=gt,
- ge=ge,
- lt=lt,
- le=le,
- min_length=min_length,
- max_length=max_length,
- pattern=pattern,
- regex=regex,
- discriminator=discriminator,
- strict=strict,
- multiple_of=multiple_of,
- allow_inf_nan=allow_inf_nan,
- max_digits=max_digits,
- decimal_places=decimal_places,
- example=example,
- examples=examples,
- openapi_examples=openapi_examples,
- deprecated=deprecated,
- include_in_schema=include_in_schema,
- json_schema_extra=json_schema_extra,
- **extra,
- )
- def Cookie( # noqa: N802
- default: Annotated[
- Any,
- Doc(
- """
- Default value if the parameter field is not set.
- """
- ),
- ] = Undefined,
- *,
- default_factory: Annotated[
- Callable[[], Any] | None,
- Doc(
- """
- A callable to generate the default value.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = _Unset,
- alias: Annotated[
- str | None,
- Doc(
- """
- An alternative name for the parameter field.
- This will be used to extract the data and for the generated OpenAPI.
- It is particularly useful when you can't use the name you want because it
- is a Python reserved keyword or similar.
- """
- ),
- ] = None,
- alias_priority: Annotated[
- int | None,
- Doc(
- """
- Priority of the alias. This affects whether an alias generator is used.
- """
- ),
- ] = _Unset,
- validation_alias: Annotated[
- str | AliasPath | AliasChoices | None,
- Doc(
- """
- 'Whitelist' validation step. The parameter field will be the single one
- allowed by the alias or set of aliases defined.
- """
- ),
- ] = None,
- serialization_alias: Annotated[
- str | None,
- Doc(
- """
- 'Blacklist' validation step. The vanilla parameter field will be the
- single one of the alias' or set of aliases' fields and all the other
- fields will be ignored at serialization time.
- """
- ),
- ] = None,
- title: Annotated[
- str | None,
- Doc(
- """
- Human-readable title.
- """
- ),
- ] = None,
- description: Annotated[
- str | None,
- Doc(
- """
- Human-readable description.
- """
- ),
- ] = None,
- gt: Annotated[
- float | None,
- Doc(
- """
- Greater than. If set, value must be greater than this. Only applicable to
- numbers.
- """
- ),
- ] = None,
- ge: Annotated[
- float | None,
- Doc(
- """
- Greater than or equal. If set, value must be greater than or equal to
- this. Only applicable to numbers.
- """
- ),
- ] = None,
- lt: Annotated[
- float | None,
- Doc(
- """
- Less than. If set, value must be less than this. Only applicable to numbers.
- """
- ),
- ] = None,
- le: Annotated[
- float | None,
- Doc(
- """
- Less than or equal. If set, value must be less than or equal to this.
- Only applicable to numbers.
- """
- ),
- ] = None,
- min_length: Annotated[
- int | None,
- Doc(
- """
- Minimum length for strings.
- """
- ),
- ] = None,
- max_length: Annotated[
- int | None,
- Doc(
- """
- Maximum length for strings.
- """
- ),
- ] = None,
- pattern: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- ] = None,
- regex: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- deprecated(
- "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
- ),
- ] = None,
- discriminator: Annotated[
- str | None,
- Doc(
- """
- Parameter field name for discriminating the type in a tagged union.
- """
- ),
- ] = None,
- strict: Annotated[
- bool | None,
- Doc(
- """
- If `True`, strict validation is applied to the field.
- """
- ),
- ] = _Unset,
- multiple_of: Annotated[
- float | None,
- Doc(
- """
- Value must be a multiple of this. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- allow_inf_nan: Annotated[
- bool | None,
- Doc(
- """
- Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- max_digits: Annotated[
- int | None,
- Doc(
- """
- Maximum number of digits allowed for decimal values.
- """
- ),
- ] = _Unset,
- decimal_places: Annotated[
- int | None,
- Doc(
- """
- Maximum number of decimal places allowed for decimal values.
- """
- ),
- ] = _Unset,
- examples: Annotated[
- list[Any] | None,
- Doc(
- """
- Example values for this field.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
- """
- ),
- ] = None,
- example: Annotated[
- Any | None,
- deprecated(
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
- "although still supported. Use examples instead."
- ),
- ] = _Unset,
- openapi_examples: Annotated[
- dict[str, Example] | None,
- Doc(
- """
- OpenAPI-specific examples.
- It will be added to the generated OpenAPI (e.g. visible at `/docs`).
- Swagger UI (that provides the `/docs` interface) has better support for the
- OpenAPI-specific examples than the JSON Schema `examples`, that's the main
- use case for this.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
- """
- ),
- ] = None,
- deprecated: Annotated[
- deprecated | str | bool | None,
- Doc(
- """
- Mark this parameter field as deprecated.
- It will affect the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = None,
- include_in_schema: Annotated[
- bool,
- Doc(
- """
- To include (or not) this parameter field in the generated OpenAPI.
- You probably don't need it, but it's available.
- This affects the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = True,
- json_schema_extra: Annotated[
- dict[str, Any] | None,
- Doc(
- """
- Any additional JSON schema data.
- """
- ),
- ] = None,
- **extra: Annotated[
- Any,
- Doc(
- """
- Include extra fields used by the JSON Schema.
- """
- ),
- deprecated(
- """
- The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
- """
- ),
- ],
- ) -> Any:
- return params.Cookie(
- default=default,
- default_factory=default_factory,
- alias=alias,
- alias_priority=alias_priority,
- validation_alias=validation_alias,
- serialization_alias=serialization_alias,
- title=title,
- description=description,
- gt=gt,
- ge=ge,
- lt=lt,
- le=le,
- min_length=min_length,
- max_length=max_length,
- pattern=pattern,
- regex=regex,
- discriminator=discriminator,
- strict=strict,
- multiple_of=multiple_of,
- allow_inf_nan=allow_inf_nan,
- max_digits=max_digits,
- decimal_places=decimal_places,
- example=example,
- examples=examples,
- openapi_examples=openapi_examples,
- deprecated=deprecated,
- include_in_schema=include_in_schema,
- json_schema_extra=json_schema_extra,
- **extra,
- )
- def Body( # noqa: N802
- default: Annotated[
- Any,
- Doc(
- """
- Default value if the parameter field is not set.
- """
- ),
- ] = Undefined,
- *,
- default_factory: Annotated[
- Callable[[], Any] | None,
- Doc(
- """
- A callable to generate the default value.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = _Unset,
- embed: Annotated[
- bool | None,
- Doc(
- """
- When `embed` is `True`, the parameter will be expected in a JSON body as a
- key instead of being the JSON body itself.
- This happens automatically when more than one `Body` parameter is declared.
- Read more about it in the
- [FastAPI docs for Body - Multiple Parameters](https://fastapi.tiangolo.com/tutorial/body-multiple-params/#embed-a-single-body-parameter).
- """
- ),
- ] = None,
- media_type: Annotated[
- str,
- Doc(
- """
- The media type of this parameter field. Changing it would affect the
- generated OpenAPI, but currently it doesn't affect the parsing of the data.
- """
- ),
- ] = "application/json",
- alias: Annotated[
- str | None,
- Doc(
- """
- An alternative name for the parameter field.
- This will be used to extract the data and for the generated OpenAPI.
- It is particularly useful when you can't use the name you want because it
- is a Python reserved keyword or similar.
- """
- ),
- ] = None,
- alias_priority: Annotated[
- int | None,
- Doc(
- """
- Priority of the alias. This affects whether an alias generator is used.
- """
- ),
- ] = _Unset,
- validation_alias: Annotated[
- str | AliasPath | AliasChoices | None,
- Doc(
- """
- 'Whitelist' validation step. The parameter field will be the single one
- allowed by the alias or set of aliases defined.
- """
- ),
- ] = None,
- serialization_alias: Annotated[
- str | None,
- Doc(
- """
- 'Blacklist' validation step. The vanilla parameter field will be the
- single one of the alias' or set of aliases' fields and all the other
- fields will be ignored at serialization time.
- """
- ),
- ] = None,
- title: Annotated[
- str | None,
- Doc(
- """
- Human-readable title.
- """
- ),
- ] = None,
- description: Annotated[
- str | None,
- Doc(
- """
- Human-readable description.
- """
- ),
- ] = None,
- gt: Annotated[
- float | None,
- Doc(
- """
- Greater than. If set, value must be greater than this. Only applicable to
- numbers.
- """
- ),
- ] = None,
- ge: Annotated[
- float | None,
- Doc(
- """
- Greater than or equal. If set, value must be greater than or equal to
- this. Only applicable to numbers.
- """
- ),
- ] = None,
- lt: Annotated[
- float | None,
- Doc(
- """
- Less than. If set, value must be less than this. Only applicable to numbers.
- """
- ),
- ] = None,
- le: Annotated[
- float | None,
- Doc(
- """
- Less than or equal. If set, value must be less than or equal to this.
- Only applicable to numbers.
- """
- ),
- ] = None,
- min_length: Annotated[
- int | None,
- Doc(
- """
- Minimum length for strings.
- """
- ),
- ] = None,
- max_length: Annotated[
- int | None,
- Doc(
- """
- Maximum length for strings.
- """
- ),
- ] = None,
- pattern: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- ] = None,
- regex: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- deprecated(
- "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
- ),
- ] = None,
- discriminator: Annotated[
- str | None,
- Doc(
- """
- Parameter field name for discriminating the type in a tagged union.
- """
- ),
- ] = None,
- strict: Annotated[
- bool | None,
- Doc(
- """
- If `True`, strict validation is applied to the field.
- """
- ),
- ] = _Unset,
- multiple_of: Annotated[
- float | None,
- Doc(
- """
- Value must be a multiple of this. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- allow_inf_nan: Annotated[
- bool | None,
- Doc(
- """
- Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- max_digits: Annotated[
- int | None,
- Doc(
- """
- Maximum number of digits allowed for decimal values.
- """
- ),
- ] = _Unset,
- decimal_places: Annotated[
- int | None,
- Doc(
- """
- Maximum number of decimal places allowed for decimal values.
- """
- ),
- ] = _Unset,
- examples: Annotated[
- list[Any] | None,
- Doc(
- """
- Example values for this field.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
- """
- ),
- ] = None,
- example: Annotated[
- Any | None,
- deprecated(
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
- "although still supported. Use examples instead."
- ),
- ] = _Unset,
- openapi_examples: Annotated[
- dict[str, Example] | None,
- Doc(
- """
- OpenAPI-specific examples.
- It will be added to the generated OpenAPI (e.g. visible at `/docs`).
- Swagger UI (that provides the `/docs` interface) has better support for the
- OpenAPI-specific examples than the JSON Schema `examples`, that's the main
- use case for this.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
- """
- ),
- ] = None,
- deprecated: Annotated[
- deprecated | str | bool | None,
- Doc(
- """
- Mark this parameter field as deprecated.
- It will affect the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = None,
- include_in_schema: Annotated[
- bool,
- Doc(
- """
- To include (or not) this parameter field in the generated OpenAPI.
- You probably don't need it, but it's available.
- This affects the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = True,
- json_schema_extra: Annotated[
- dict[str, Any] | None,
- Doc(
- """
- Any additional JSON schema data.
- """
- ),
- ] = None,
- **extra: Annotated[
- Any,
- Doc(
- """
- Include extra fields used by the JSON Schema.
- """
- ),
- deprecated(
- """
- The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
- """
- ),
- ],
- ) -> Any:
- return params.Body(
- default=default,
- default_factory=default_factory,
- embed=embed,
- media_type=media_type,
- alias=alias,
- alias_priority=alias_priority,
- validation_alias=validation_alias,
- serialization_alias=serialization_alias,
- title=title,
- description=description,
- gt=gt,
- ge=ge,
- lt=lt,
- le=le,
- min_length=min_length,
- max_length=max_length,
- pattern=pattern,
- regex=regex,
- discriminator=discriminator,
- strict=strict,
- multiple_of=multiple_of,
- allow_inf_nan=allow_inf_nan,
- max_digits=max_digits,
- decimal_places=decimal_places,
- example=example,
- examples=examples,
- openapi_examples=openapi_examples,
- deprecated=deprecated,
- include_in_schema=include_in_schema,
- json_schema_extra=json_schema_extra,
- **extra,
- )
- def Form( # noqa: N802
- default: Annotated[
- Any,
- Doc(
- """
- Default value if the parameter field is not set.
- """
- ),
- ] = Undefined,
- *,
- default_factory: Annotated[
- Callable[[], Any] | None,
- Doc(
- """
- A callable to generate the default value.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = _Unset,
- media_type: Annotated[
- str,
- Doc(
- """
- The media type of this parameter field. Changing it would affect the
- generated OpenAPI, but currently it doesn't affect the parsing of the data.
- """
- ),
- ] = "application/x-www-form-urlencoded",
- alias: Annotated[
- str | None,
- Doc(
- """
- An alternative name for the parameter field.
- This will be used to extract the data and for the generated OpenAPI.
- It is particularly useful when you can't use the name you want because it
- is a Python reserved keyword or similar.
- """
- ),
- ] = None,
- alias_priority: Annotated[
- int | None,
- Doc(
- """
- Priority of the alias. This affects whether an alias generator is used.
- """
- ),
- ] = _Unset,
- validation_alias: Annotated[
- str | AliasPath | AliasChoices | None,
- Doc(
- """
- 'Whitelist' validation step. The parameter field will be the single one
- allowed by the alias or set of aliases defined.
- """
- ),
- ] = None,
- serialization_alias: Annotated[
- str | None,
- Doc(
- """
- 'Blacklist' validation step. The vanilla parameter field will be the
- single one of the alias' or set of aliases' fields and all the other
- fields will be ignored at serialization time.
- """
- ),
- ] = None,
- title: Annotated[
- str | None,
- Doc(
- """
- Human-readable title.
- """
- ),
- ] = None,
- description: Annotated[
- str | None,
- Doc(
- """
- Human-readable description.
- """
- ),
- ] = None,
- gt: Annotated[
- float | None,
- Doc(
- """
- Greater than. If set, value must be greater than this. Only applicable to
- numbers.
- """
- ),
- ] = None,
- ge: Annotated[
- float | None,
- Doc(
- """
- Greater than or equal. If set, value must be greater than or equal to
- this. Only applicable to numbers.
- """
- ),
- ] = None,
- lt: Annotated[
- float | None,
- Doc(
- """
- Less than. If set, value must be less than this. Only applicable to numbers.
- """
- ),
- ] = None,
- le: Annotated[
- float | None,
- Doc(
- """
- Less than or equal. If set, value must be less than or equal to this.
- Only applicable to numbers.
- """
- ),
- ] = None,
- min_length: Annotated[
- int | None,
- Doc(
- """
- Minimum length for strings.
- """
- ),
- ] = None,
- max_length: Annotated[
- int | None,
- Doc(
- """
- Maximum length for strings.
- """
- ),
- ] = None,
- pattern: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- ] = None,
- regex: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- deprecated(
- "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
- ),
- ] = None,
- discriminator: Annotated[
- str | None,
- Doc(
- """
- Parameter field name for discriminating the type in a tagged union.
- """
- ),
- ] = None,
- strict: Annotated[
- bool | None,
- Doc(
- """
- If `True`, strict validation is applied to the field.
- """
- ),
- ] = _Unset,
- multiple_of: Annotated[
- float | None,
- Doc(
- """
- Value must be a multiple of this. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- allow_inf_nan: Annotated[
- bool | None,
- Doc(
- """
- Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- max_digits: Annotated[
- int | None,
- Doc(
- """
- Maximum number of digits allowed for decimal values.
- """
- ),
- ] = _Unset,
- decimal_places: Annotated[
- int | None,
- Doc(
- """
- Maximum number of decimal places allowed for decimal values.
- """
- ),
- ] = _Unset,
- examples: Annotated[
- list[Any] | None,
- Doc(
- """
- Example values for this field.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
- """
- ),
- ] = None,
- example: Annotated[
- Any | None,
- deprecated(
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
- "although still supported. Use examples instead."
- ),
- ] = _Unset,
- openapi_examples: Annotated[
- dict[str, Example] | None,
- Doc(
- """
- OpenAPI-specific examples.
- It will be added to the generated OpenAPI (e.g. visible at `/docs`).
- Swagger UI (that provides the `/docs` interface) has better support for the
- OpenAPI-specific examples than the JSON Schema `examples`, that's the main
- use case for this.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
- """
- ),
- ] = None,
- deprecated: Annotated[
- deprecated | str | bool | None,
- Doc(
- """
- Mark this parameter field as deprecated.
- It will affect the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = None,
- include_in_schema: Annotated[
- bool,
- Doc(
- """
- To include (or not) this parameter field in the generated OpenAPI.
- You probably don't need it, but it's available.
- This affects the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = True,
- json_schema_extra: Annotated[
- dict[str, Any] | None,
- Doc(
- """
- Any additional JSON schema data.
- """
- ),
- ] = None,
- **extra: Annotated[
- Any,
- Doc(
- """
- Include extra fields used by the JSON Schema.
- """
- ),
- deprecated(
- """
- The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
- """
- ),
- ],
- ) -> Any:
- return params.Form(
- default=default,
- default_factory=default_factory,
- media_type=media_type,
- alias=alias,
- alias_priority=alias_priority,
- validation_alias=validation_alias,
- serialization_alias=serialization_alias,
- title=title,
- description=description,
- gt=gt,
- ge=ge,
- lt=lt,
- le=le,
- min_length=min_length,
- max_length=max_length,
- pattern=pattern,
- regex=regex,
- discriminator=discriminator,
- strict=strict,
- multiple_of=multiple_of,
- allow_inf_nan=allow_inf_nan,
- max_digits=max_digits,
- decimal_places=decimal_places,
- example=example,
- examples=examples,
- openapi_examples=openapi_examples,
- deprecated=deprecated,
- include_in_schema=include_in_schema,
- json_schema_extra=json_schema_extra,
- **extra,
- )
- def File( # noqa: N802
- default: Annotated[
- Any,
- Doc(
- """
- Default value if the parameter field is not set.
- """
- ),
- ] = Undefined,
- *,
- default_factory: Annotated[
- Callable[[], Any] | None,
- Doc(
- """
- A callable to generate the default value.
- This doesn't affect `Path` parameters as the value is always required.
- The parameter is available only for compatibility.
- """
- ),
- ] = _Unset,
- media_type: Annotated[
- str,
- Doc(
- """
- The media type of this parameter field. Changing it would affect the
- generated OpenAPI, but currently it doesn't affect the parsing of the data.
- """
- ),
- ] = "multipart/form-data",
- alias: Annotated[
- str | None,
- Doc(
- """
- An alternative name for the parameter field.
- This will be used to extract the data and for the generated OpenAPI.
- It is particularly useful when you can't use the name you want because it
- is a Python reserved keyword or similar.
- """
- ),
- ] = None,
- alias_priority: Annotated[
- int | None,
- Doc(
- """
- Priority of the alias. This affects whether an alias generator is used.
- """
- ),
- ] = _Unset,
- validation_alias: Annotated[
- str | AliasPath | AliasChoices | None,
- Doc(
- """
- 'Whitelist' validation step. The parameter field will be the single one
- allowed by the alias or set of aliases defined.
- """
- ),
- ] = None,
- serialization_alias: Annotated[
- str | None,
- Doc(
- """
- 'Blacklist' validation step. The vanilla parameter field will be the
- single one of the alias' or set of aliases' fields and all the other
- fields will be ignored at serialization time.
- """
- ),
- ] = None,
- title: Annotated[
- str | None,
- Doc(
- """
- Human-readable title.
- """
- ),
- ] = None,
- description: Annotated[
- str | None,
- Doc(
- """
- Human-readable description.
- """
- ),
- ] = None,
- gt: Annotated[
- float | None,
- Doc(
- """
- Greater than. If set, value must be greater than this. Only applicable to
- numbers.
- """
- ),
- ] = None,
- ge: Annotated[
- float | None,
- Doc(
- """
- Greater than or equal. If set, value must be greater than or equal to
- this. Only applicable to numbers.
- """
- ),
- ] = None,
- lt: Annotated[
- float | None,
- Doc(
- """
- Less than. If set, value must be less than this. Only applicable to numbers.
- """
- ),
- ] = None,
- le: Annotated[
- float | None,
- Doc(
- """
- Less than or equal. If set, value must be less than or equal to this.
- Only applicable to numbers.
- """
- ),
- ] = None,
- min_length: Annotated[
- int | None,
- Doc(
- """
- Minimum length for strings.
- """
- ),
- ] = None,
- max_length: Annotated[
- int | None,
- Doc(
- """
- Maximum length for strings.
- """
- ),
- ] = None,
- pattern: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- ] = None,
- regex: Annotated[
- str | None,
- Doc(
- """
- RegEx pattern for strings.
- """
- ),
- deprecated(
- "Deprecated in FastAPI 0.100.0 and Pydantic v2, use `pattern` instead."
- ),
- ] = None,
- discriminator: Annotated[
- str | None,
- Doc(
- """
- Parameter field name for discriminating the type in a tagged union.
- """
- ),
- ] = None,
- strict: Annotated[
- bool | None,
- Doc(
- """
- If `True`, strict validation is applied to the field.
- """
- ),
- ] = _Unset,
- multiple_of: Annotated[
- float | None,
- Doc(
- """
- Value must be a multiple of this. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- allow_inf_nan: Annotated[
- bool | None,
- Doc(
- """
- Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
- """
- ),
- ] = _Unset,
- max_digits: Annotated[
- int | None,
- Doc(
- """
- Maximum number of digits allowed for decimal values.
- """
- ),
- ] = _Unset,
- decimal_places: Annotated[
- int | None,
- Doc(
- """
- Maximum number of decimal places allowed for decimal values.
- """
- ),
- ] = _Unset,
- examples: Annotated[
- list[Any] | None,
- Doc(
- """
- Example values for this field.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/)
- """
- ),
- ] = None,
- example: Annotated[
- Any | None,
- deprecated(
- "Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, "
- "although still supported. Use examples instead."
- ),
- ] = _Unset,
- openapi_examples: Annotated[
- dict[str, Example] | None,
- Doc(
- """
- OpenAPI-specific examples.
- It will be added to the generated OpenAPI (e.g. visible at `/docs`).
- Swagger UI (that provides the `/docs` interface) has better support for the
- OpenAPI-specific examples than the JSON Schema `examples`, that's the main
- use case for this.
- Read more about it in the
- [FastAPI docs for Declare Request Example Data](https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter).
- """
- ),
- ] = None,
- deprecated: Annotated[
- deprecated | str | bool | None,
- Doc(
- """
- Mark this parameter field as deprecated.
- It will affect the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = None,
- include_in_schema: Annotated[
- bool,
- Doc(
- """
- To include (or not) this parameter field in the generated OpenAPI.
- You probably don't need it, but it's available.
- This affects the generated OpenAPI (e.g. visible at `/docs`).
- """
- ),
- ] = True,
- json_schema_extra: Annotated[
- dict[str, Any] | None,
- Doc(
- """
- Any additional JSON schema data.
- """
- ),
- ] = None,
- **extra: Annotated[
- Any,
- Doc(
- """
- Include extra fields used by the JSON Schema.
- """
- ),
- deprecated(
- """
- The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
- """
- ),
- ],
- ) -> Any:
- return params.File(
- default=default,
- default_factory=default_factory,
- media_type=media_type,
- alias=alias,
- alias_priority=alias_priority,
- validation_alias=validation_alias,
- serialization_alias=serialization_alias,
- title=title,
- description=description,
- gt=gt,
- ge=ge,
- lt=lt,
- le=le,
- min_length=min_length,
- max_length=max_length,
- pattern=pattern,
- regex=regex,
- discriminator=discriminator,
- strict=strict,
- multiple_of=multiple_of,
- allow_inf_nan=allow_inf_nan,
- max_digits=max_digits,
- decimal_places=decimal_places,
- example=example,
- examples=examples,
- openapi_examples=openapi_examples,
- deprecated=deprecated,
- include_in_schema=include_in_schema,
- json_schema_extra=json_schema_extra,
- **extra,
- )
- def Depends( # noqa: N802
- dependency: Annotated[
- Callable[..., Any] | None,
- Doc(
- """
- A "dependable" callable (like a function).
- Don't call it directly, FastAPI will call it for you, just pass the object
- directly.
- Read more about it in the
- [FastAPI docs for Dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/)
- """
- ),
- ] = None,
- *,
- use_cache: Annotated[
- bool,
- Doc(
- """
- By default, after a dependency is called the first time in a request, if
- the dependency is declared again for the rest of the request (for example
- if the dependency is needed by several dependencies), the value will be
- re-used for the rest of the request.
- Set `use_cache` to `False` to disable this behavior and ensure the
- dependency is called again (if declared more than once) in the same request.
- Read more about it in the
- [FastAPI docs about sub-dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/sub-dependencies/#using-the-same-dependency-multiple-times)
- """
- ),
- ] = True,
- scope: Annotated[
- Literal["function", "request"] | None,
- Doc(
- """
- Mainly for dependencies with `yield`, define when the dependency function
- should start (the code before `yield`) and when it should end (the code
- after `yield`).
- * `"function"`: start the dependency before the *path operation function*
- that handles the request, end the dependency after the *path operation
- function* ends, but **before** the response is sent back to the client.
- So, the dependency function will be executed **around** the *path operation
- **function***.
- * `"request"`: start the dependency before the *path operation function*
- that handles the request (similar to when using `"function"`), but end
- **after** the response is sent back to the client. So, the dependency
- function will be executed **around** the **request** and response cycle.
- Read more about it in the
- [FastAPI docs for FastAPI Dependencies with yield](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#early-exit-and-scope)
- """
- ),
- ] = None,
- ) -> Any:
- """
- Declare a FastAPI dependency.
- It takes a single "dependable" callable (like a function).
- Don't call it directly, FastAPI will call it for you.
- Read more about it in the
- [FastAPI docs for Dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/).
- **Example**
- ```python
- from typing import Annotated
- from fastapi import Depends, FastAPI
- app = FastAPI()
- async def common_parameters(q: str | None = None, skip: int = 0, limit: int = 100):
- return {"q": q, "skip": skip, "limit": limit}
- @app.get("/items/")
- async def read_items(commons: Annotated[dict, Depends(common_parameters)]):
- return commons
- ```
- """
- return params.Depends(dependency=dependency, use_cache=use_cache, scope=scope)
- def Security( # noqa: N802
- dependency: Annotated[
- Callable[..., Any] | None,
- Doc(
- """
- A "dependable" callable (like a function).
- Don't call it directly, FastAPI will call it for you, just pass the object
- directly.
- Read more about it in the
- [FastAPI docs for Dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/)
- """
- ),
- ] = None,
- *,
- scopes: Annotated[
- Sequence[str] | None,
- Doc(
- """
- OAuth2 scopes required for the *path operation* that uses this Security
- dependency.
- The term "scope" comes from the OAuth2 specification, it seems to be
- intentionally vague and interpretable. It normally refers to permissions,
- in cases to roles.
- These scopes are integrated with OpenAPI (and the API docs at `/docs`).
- So they are visible in the OpenAPI specification.
- Read more about it in the
- [FastAPI docs about OAuth2 scopes](https://fastapi.tiangolo.com/advanced/security/oauth2-scopes/)
- """
- ),
- ] = None,
- use_cache: Annotated[
- bool,
- Doc(
- """
- By default, after a dependency is called the first time in a request, if
- the dependency is declared again for the rest of the request (for example
- if the dependency is needed by several dependencies), the value will be
- re-used for the rest of the request.
- Set `use_cache` to `False` to disable this behavior and ensure the
- dependency is called again (if declared more than once) in the same request.
- Read more about it in the
- [FastAPI docs about sub-dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/sub-dependencies/#using-the-same-dependency-multiple-times)
- """
- ),
- ] = True,
- ) -> Any:
- """
- Declare a FastAPI Security dependency.
- The only difference with a regular dependency is that it can declare OAuth2
- scopes that will be integrated with OpenAPI and the automatic UI docs (by default
- at `/docs`).
- It takes a single "dependable" callable (like a function).
- Don't call it directly, FastAPI will call it for you.
- Read more about it in the
- [FastAPI docs for Security](https://fastapi.tiangolo.com/tutorial/security/) and
- in the
- [FastAPI docs for OAuth2 scopes](https://fastapi.tiangolo.com/advanced/security/oauth2-scopes/).
- **Example**
- ```python
- from typing import Annotated
- from fastapi import Security, FastAPI
- from .db import User
- from .security import get_current_active_user
- app = FastAPI()
- @app.get("/users/me/items/")
- async def read_own_items(
- current_user: Annotated[User, Security(get_current_active_user, scopes=["items"])]
- ):
- return [{"item_id": "Foo", "owner": current_user.username}]
- ```
- """
- return params.Security(dependency=dependency, scopes=scopes, use_cache=use_cache)
|