|
|
|
@ -13,8 +13,7 @@ from typing_extensions import deprecated |
|
|
|
from ._compat import ( |
|
|
|
Undefined, |
|
|
|
) |
|
|
|
|
|
|
|
_Unset: Any = Undefined |
|
|
|
from .datastructures import _Unset |
|
|
|
|
|
|
|
|
|
|
|
class ParamTypes(Enum): |
|
|
|
@ -31,10 +30,10 @@ class Param(FieldInfo): # type: ignore[misc] |
|
|
|
self, |
|
|
|
default: Any = Undefined, |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
title: str | None = None, |
|
|
|
@ -53,11 +52,11 @@ class Param(FieldInfo): # type: ignore[misc] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
@ -142,10 +141,10 @@ class Path(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
self, |
|
|
|
default: Any = ..., |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
title: str | None = None, |
|
|
|
@ -164,11 +163,11 @@ class Path(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
@ -226,10 +225,10 @@ class Query(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
self, |
|
|
|
default: Any = Undefined, |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
title: str | None = None, |
|
|
|
@ -248,11 +247,11 @@ class Query(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
@ -308,10 +307,10 @@ class Header(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
self, |
|
|
|
default: Any = Undefined, |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
convert_underscores: bool = True, |
|
|
|
@ -331,11 +330,11 @@ class Header(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
@ -392,10 +391,10 @@ class Cookie(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
self, |
|
|
|
default: Any = Undefined, |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
title: str | None = None, |
|
|
|
@ -414,11 +413,11 @@ class Cookie(Param): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
@ -472,12 +471,12 @@ class Body(FieldInfo): # type: ignore[misc] |
|
|
|
self, |
|
|
|
default: Any = Undefined, |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
embed: bool | None = None, |
|
|
|
media_type: str = "application/json", |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
title: str | None = None, |
|
|
|
@ -496,11 +495,11 @@ class Body(FieldInfo): # type: ignore[misc] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
@ -584,11 +583,11 @@ class Form(Body): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
self, |
|
|
|
default: Any = Undefined, |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
media_type: str = "application/x-www-form-urlencoded", |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
title: str | None = None, |
|
|
|
@ -607,11 +606,11 @@ class Form(Body): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
@ -666,11 +665,11 @@ class File(Form): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
self, |
|
|
|
default: Any = Undefined, |
|
|
|
*, |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
default_factory: Callable[[], Any] | None = _Unset, |
|
|
|
annotation: Any | None = None, |
|
|
|
media_type: str = "multipart/form-data", |
|
|
|
alias: str | None = None, |
|
|
|
alias_priority: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
alias_priority: int | None = _Unset, |
|
|
|
validation_alias: str | AliasPath | AliasChoices | None = None, |
|
|
|
serialization_alias: str | None = None, |
|
|
|
title: str | None = None, |
|
|
|
@ -689,11 +688,11 @@ class File(Form): # type: ignore[misc] # ty: ignore[unused-ignore-comment] |
|
|
|
), |
|
|
|
] = None, |
|
|
|
discriminator: str | None = None, |
|
|
|
strict: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
multiple_of: float | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
allow_inf_nan: bool | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
max_digits: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
decimal_places: int | None = _Unset, # ty: ignore[invalid-parameter-default] |
|
|
|
strict: bool | None = _Unset, |
|
|
|
multiple_of: float | None = _Unset, |
|
|
|
allow_inf_nan: bool | None = _Unset, |
|
|
|
max_digits: int | None = _Unset, |
|
|
|
decimal_places: int | None = _Unset, |
|
|
|
examples: list[Any] | None = None, |
|
|
|
example: Annotated[ |
|
|
|
Any | None, |
|
|
|
|