Parameters

Request parameters are functions returning an object used to provide the parameter metadata before request, such as param type, validation, alias, etc.

These functions include:

• Query
• Body
• Path
• Form
• File
• Header
• Cookie

Import them directly from sensei

from sensei import Query, Body, Path, Form, File, Header, Cookie

There are two ways how to use them:

AnnotatedDirect

@router.get('/users/{id_}')
def get_user(id_: Annotated[int, Path()]) -> User:
    pass

@router.get('/users/{id_}')
def get_user(id_: int = Path()) -> User:
    pass

sensei.Query

Query(default=Undefined, *, default_factory=_Unset, alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, **extra)

Declare a query parameter for a path operation.

Example

@router.get('/search')
def search_users(cls, query: Annotated[str, Query()] = "") -> list[User]:
    pass

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	Callable to generate the default value. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset
alias	Alternative name for the parameter field, used when parameter name conflicts with reserved words. TYPE: Optional[str] DEFAULT: None
title	Human-readable title for the parameter. TYPE: Optional[str] DEFAULT: None
description	Human-readable description for the parameter. TYPE: Optional[str] DEFAULT: None
gt	Specifies that the value must be greater than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
ge	Specifies that the value must be greater than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
lt	Specifies that the value must be less than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
le	Specifies that the value must be less than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
min_length	Minimum length for string values. TYPE: Optional[int] DEFAULT: None
max_length	Maximum length for string values. TYPE: Optional[int] DEFAULT: None
pattern	Regular expression pattern for string values. TYPE: Optional[str] DEFAULT: None
discriminator	Field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None
strict	Enables strict validation if set to True. TYPE: Union[bool, None] DEFAULT: _Unset
multiple_of	Specifies that the value must be a multiple of this value, applicable only to numbers. TYPE: Union[float, None] DEFAULT: _Unset
allow_inf_nan	Allows values inf, -inf, and nan, applicable only to numbers. TYPE: Union[bool, None] DEFAULT: _Unset
max_digits	Maximum number of digits allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
decimal_places	Maximum number of decimal places allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
examples	Example values for the parameter. TYPE: Optional[List[Any]] DEFAULT: None
**extra	Extra fields for JSON Schema. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
_params_Query	Query parameter for a path operation TYPE: Query

Source code in sensei/_internal/_core/params_functions.py

def Query(
        default: Any = Undefined,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        alias: Optional[str] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[List[Any]] = None,
        **extra: Any,
) -> _params_Query:
    """
    Declare a query parameter for a **path operation**.

    Example:
        ```python
        @router.get('/search')
        def search_users(cls, query: Annotated[str, Query()] = "") -> list[User]:
            pass
        ```

    Args:
        default (Any):
            Default value if the parameter field is not set.
        default_factory (Union[Callable[[], Any], None]):
            Callable to generate the default value.
        alias (Optional[str]):
            Alternative name for the parameter field, used when parameter name
            conflicts with reserved words.
        title (Optional[str]):
            Human-readable title for the parameter.
        description (Optional[str]):
            Human-readable description for the parameter.
        gt (Optional[float]):
            Specifies that the value must be greater than this value, applicable only to numbers.
        ge (Optional[float]):
            Specifies that the value must be greater than or equal to this value, applicable only to numbers.
        lt (Optional[float]):
            Specifies that the value must be less than this value, applicable only to numbers.
        le (Optional[float]):
            Specifies that the value must be less than or equal to this value, applicable only to numbers.
        min_length (Optional[int]):
            Minimum length for string values.
        max_length (Optional[int]):
            Maximum length for string values.
        pattern (Optional[str]):
            Regular expression pattern for string values.
        discriminator (Union[str, None]):
            Field name for discriminating the type in a tagged union.
        strict (Union[bool, None]):
            Enables strict validation if set to `True`.
        multiple_of (Union[float, None]):
            Specifies that the value must be a multiple of this value, applicable only to numbers.
        allow_inf_nan (Union[bool, None]):
            Allows values `inf`, `-inf`, and `nan`, applicable only to numbers.
        max_digits (Union[int, None]):
            Maximum number of digits allowed for numeric values.
        decimal_places (Union[int, None]):
            Maximum number of decimal places allowed for numeric values.
        examples (Optional[List[Any]]):
            Example values for the parameter.
        **extra (Any):
            Extra fields for JSON Schema.

    Returns:
        _params_Query: Query parameter for a **path operation**
    """
    return _params_Query(
        default=default,
        default_factory=default_factory,
        alias=alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        **extra,
    )

sensei.Body

Body(default=Undefined, *, default_factory=_Unset, embed=True, media_type='application/json', alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, **extra)

Declare a body parameter for a path operation

Example

@router.post('/create_user')
def create_user(cls, user: Annotated[User, Body()]) -> User:
    pass

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	Callable to generate the default value. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset
embed	If True, the parameter will be expected in a JSON body as a key, instead of being the JSON body itself. TYPE: bool DEFAULT: True
media_type	The media type of this parameter field, e.g., "application/json". TYPE: str DEFAULT: 'application/json'
alias	Alternative name for the parameter field, used when parameter name conflicts with reserved words. TYPE: Optional[str] DEFAULT: None
title	Human-readable title for the parameter. TYPE: Optional[str] DEFAULT: None
description	Human-readable description for the parameter. TYPE: Optional[str] DEFAULT: None
gt	Specifies that the value must be greater than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
ge	Specifies that the value must be greater than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
lt	Specifies that the value must be less than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
le	Specifies that the value must be less than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
min_length	Minimum length for string values. TYPE: Optional[int] DEFAULT: None
max_length	Maximum length for string values. TYPE: Optional[int] DEFAULT: None
pattern	Regular expression pattern for string values. TYPE: Optional[str] DEFAULT: None
discriminator	Field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None
strict	Enables strict validation if set to True. TYPE: Union[bool, None] DEFAULT: _Unset
multiple_of	Specifies that the value must be a multiple of this value, applicable only to numbers. TYPE: Union[float, None] DEFAULT: _Unset
allow_inf_nan	Allows values inf, -inf, and nan, applicable only to numbers. TYPE: Union[bool, None] DEFAULT: _Unset
max_digits	Maximum number of digits allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
decimal_places	Maximum number of decimal places allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
examples	Example values for the parameter. TYPE: Optional[List[Any]] DEFAULT: None
**extra	Extra fields for JSON Schema. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
_params_Body	Body parameter for a path operation TYPE: Body

Source code in sensei/_internal/_core/params_functions.py

def Body(
        default: Any = Undefined,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        embed: bool = True,
        media_type: str = "application/json",
        alias: Optional[str] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[List[Any]] = None,
        **extra: Any,
) -> _params_Body:
    """
    Declare a body parameter for a **path operation**

    Example:
        ```python
        @router.post('/create_user')
        def create_user(cls, user: Annotated[User, Body()]) -> User:
            pass
        ```

    Args:
        default (Any):
            Default value if the parameter field is not set.
        default_factory (Union[Callable[[], Any], None]):
            Callable to generate the default value.
        embed (bool):
            If `True`, the parameter will be expected in a JSON body as a key, instead
            of being the JSON body itself.
        media_type (str):
            The media type of this parameter field, e.g., "application/json".
        alias (Optional[str]):
            Alternative name for the parameter field, used when parameter name
            conflicts with reserved words.
        title (Optional[str]):
            Human-readable title for the parameter.
        description (Optional[str]):
            Human-readable description for the parameter.
        gt (Optional[float]):
            Specifies that the value must be greater than this value, applicable only to numbers.
        ge (Optional[float]):
            Specifies that the value must be greater than or equal to this value, applicable only to numbers.
        lt (Optional[float]):
            Specifies that the value must be less than this value, applicable only to numbers.
        le (Optional[float]):
            Specifies that the value must be less than or equal to this value, applicable only to numbers.
        min_length (Optional[int]):
            Minimum length for string values.
        max_length (Optional[int]):
            Maximum length for string values.
        pattern (Optional[str]):
            Regular expression pattern for string values.
        discriminator (Union[str, None]):
            Field name for discriminating the type in a tagged union.
        strict (Union[bool, None]):
            Enables strict validation if set to `True`.
        multiple_of (Union[float, None]):
            Specifies that the value must be a multiple of this value, applicable only to numbers.
        allow_inf_nan (Union[bool, None]):
            Allows values `inf`, `-inf`, and `nan`, applicable only to numbers.
        max_digits (Union[int, None]):
            Maximum number of digits allowed for numeric values.
        decimal_places (Union[int, None]):
            Maximum number of decimal places allowed for numeric values.
        examples (Optional[List[Any]]):
            Example values for the parameter.
        **extra (Any):
            Extra fields for JSON Schema.

    Returns:
        _params_Body: Body parameter for a **path operation**
    """
    return _params_Body(
        default=default,
        default_factory=default_factory,
        embed=embed,
        media_type=media_type,
        alias=alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        **extra,
    )

sensei.Path

Path(default=..., *, default_factory=_Unset, alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, **extra)

Declare a path parameter for a path operation.

Example

@router.get('/posts/{id_}')
def get_post(cls, id_: Annotated[int, Path()]) -> Post:
    pass

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: ...
default_factory	Callable to generate the default value. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset
alias	Alternative name for the parameter field, used for data extraction, useful when parameter name conflicts with reserved words. TYPE: Optional[str] DEFAULT: None
title	Human-readable title for the parameter. TYPE: Optional[str] DEFAULT: None
description	Human-readable description for the parameter. TYPE: Optional[str] DEFAULT: None
gt	Specifies that the value must be greater than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
ge	Specifies that the value must be greater than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
lt	Specifies that the value must be less than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
le	Specifies that the value must be less than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
min_length	Minimum length for string values. TYPE: Optional[int] DEFAULT: None
max_length	Maximum length for string values. TYPE: Optional[int] DEFAULT: None
pattern	Regular expression pattern for string values. TYPE: Optional[str] DEFAULT: None
discriminator	Field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None
strict	Enables strict validation if set to True. TYPE: Union[bool, None] DEFAULT: _Unset
multiple_of	Specifies that the value must be a multiple of this value, applicable only to numbers. TYPE: Union[float, None] DEFAULT: _Unset
allow_inf_nan	Allows values inf, -inf, and nan, applicable only to numbers. TYPE: Union[bool, None] DEFAULT: _Unset
max_digits	Maximum number of digits allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
decimal_places	Maximum number of decimal places allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
examples	Example values for the parameter. TYPE: Optional[List[Any]] DEFAULT: None
**extra	Extra fields for JSON Schema. This argument is deprecated in favor of json_schema_extra. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
_params_Path	Path parameter for a path operation TYPE: Path

Source code in sensei/_internal/_core/params_functions.py

def Path(
        default: Any = ...,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        alias: Optional[str] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[List[Any]] = None,
        **extra: Any,
) -> _params_Path:
    """
    Declare a path parameter for a **path operation**.

    Example:
        ```python
        @router.get('/posts/{id_}')
        def get_post(cls, id_: Annotated[int, Path()]) -> Post:
            pass
        ```

    Args:
        default (Any):
            Default value if the parameter field is not set.
        default_factory (Union[Callable[[], Any], None]):
            Callable to generate the default value.
        alias (Optional[str]):
            Alternative name for the parameter field, used for data extraction,
            useful when parameter name conflicts with reserved words.
        title (Optional[str]):
            Human-readable title for the parameter.
        description (Optional[str]):
            Human-readable description for the parameter.
        gt (Optional[float]):
            Specifies that the value must be greater than this value, applicable only to numbers.
        ge (Optional[float]):
            Specifies that the value must be greater than or equal to this value, applicable only to numbers.
        lt (Optional[float]):
            Specifies that the value must be less than this value, applicable only to numbers.
        le (Optional[float]):
            Specifies that the value must be less than or equal to this value, applicable only to numbers.
        min_length (Optional[int]):
            Minimum length for string values.
        max_length (Optional[int]):
            Maximum length for string values.
        pattern (Optional[str]):
            Regular expression pattern for string values.
        discriminator (Union[str, None]):
            Field name for discriminating the type in a tagged union.
        strict (Union[bool, None]):
            Enables strict validation if set to `True`.
        multiple_of (Union[float, None]):
            Specifies that the value must be a multiple of this value, applicable only to numbers.
        allow_inf_nan (Union[bool, None]):
            Allows values `inf`, `-inf`, and `nan`, applicable only to numbers.
        max_digits (Union[int, None]):
            Maximum number of digits allowed for numeric values.
        decimal_places (Union[int, None]):
            Maximum number of decimal places allowed for numeric values.
        examples (Optional[List[Any]]):
            Example values for the parameter.
        **extra (Any):
            Extra fields for JSON Schema. This argument is deprecated in favor of `json_schema_extra`.

    Returns:
        _params_Path: Path parameter for a **path operation**
    """
    return _params_Path(
        default=default,
        default_factory=default_factory,
        alias=alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        example=_Unset,
        examples=examples,
        **extra,
    )

sensei.Form

Form(default=Undefined, *, default_factory=_Unset, embed=True, alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, **extra)

Declare a form parameter for a path operation.

Example

@router.post('/login')
def login_user(cls, username: Annotated[str, Form()], password: Annotated[str, Form()]) -> str:
    pass

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	Callable to generate the default value. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset
embed	If True, the parameter will be expected in a JSON body as a key, instead of being the JSON body itself. TYPE: bool DEFAULT: True
alias	Alternative name for the parameter field, used when parameter name conflicts with reserved words. TYPE: Optional[str] DEFAULT: None
title	Human-readable title for the parameter. TYPE: Optional[str] DEFAULT: None
description	Human-readable description for the parameter. TYPE: Optional[str] DEFAULT: None
gt	Specifies that the value must be greater than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
ge	Specifies that the value must be greater than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
lt	Specifies that the value must be less than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
le	Specifies that the value must be less than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
min_length	Minimum length for string values. TYPE: Optional[int] DEFAULT: None
max_length	Maximum length for string values. TYPE: Optional[int] DEFAULT: None
pattern	Regular expression pattern for string values. TYPE: Optional[str] DEFAULT: None
discriminator	Field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None
strict	Enables strict validation if set to True. TYPE: Union[bool, None] DEFAULT: _Unset
multiple_of	Specifies that the value must be a multiple of this value, applicable only to numbers. TYPE: Union[float, None] DEFAULT: _Unset
allow_inf_nan	Allows values inf, -inf, and nan, applicable only to numbers. TYPE: Union[bool, None] DEFAULT: _Unset
max_digits	Maximum number of digits allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
decimal_places	Maximum number of decimal places allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
examples	Example values for the parameter. TYPE: Optional[List[Any]] DEFAULT: None
**extra	Extra fields for JSON Schema. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
_params_Form	Form parameter for a path operation TYPE: Any

Source code in sensei/_internal/_core/params_functions.py

def Form(
        default: Any = Undefined,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        embed: bool = True,
        alias: Optional[str] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[List[Any]] = None,
        **extra: Any,
) -> Any:
    """
    Declare a form parameter for a **path operation**.

    Example:
        ```python
        @router.post('/login')
        def login_user(cls, username: Annotated[str, Form()], password: Annotated[str, Form()]) -> str:
            pass
        ```

    Args:
        default (Any):
            Default value if the parameter field is not set.
        default_factory (Union[Callable[[], Any], None]):
            Callable to generate the default value.
        embed (bool):
            If `True`, the parameter will be expected in a JSON body as a key, instead
            of being the JSON body itself.
        alias (Optional[str]):
            Alternative name for the parameter field, used when parameter name
            conflicts with reserved words.
        title (Optional[str]):
            Human-readable title for the parameter.
        description (Optional[str]):
            Human-readable description for the parameter.
        gt (Optional[float]):
            Specifies that the value must be greater than this value, applicable only to numbers.
        ge (Optional[float]):
            Specifies that the value must be greater than or equal to this value, applicable only to numbers.
        lt (Optional[float]):
            Specifies that the value must be less than this value, applicable only to numbers.
        le (Optional[float]):
            Specifies that the value must be less than or equal to this value, applicable only to numbers.
        min_length (Optional[int]):
            Minimum length for string values.
        max_length (Optional[int]):
            Maximum length for string values.
        pattern (Optional[str]):
            Regular expression pattern for string values.
        discriminator (Union[str, None]):
            Field name for discriminating the type in a tagged union.
        strict (Union[bool, None]):
            Enables strict validation if set to `True`.
        multiple_of (Union[float, None]):
            Specifies that the value must be a multiple of this value, applicable only to numbers.
        allow_inf_nan (Union[bool, None]):
            Allows values `inf`, `-inf`, and `nan`, applicable only to numbers.
        max_digits (Union[int, None]):
            Maximum number of digits allowed for numeric values.
        decimal_places (Union[int, None]):
            Maximum number of decimal places allowed for numeric values.
        examples (Optional[List[Any]]):
            Example values for the parameter.
        **extra (Any):
            Extra fields for JSON Schema.

    Returns:
        _params_Form: Form parameter for a **path operation**
    """
    media_type = "application/x-www-form-urlencoded"
    return _params_Form(
        default=default,
        default_factory=default_factory,
        embed=embed,
        media_type=media_type,
        alias=alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        **extra,
    )

sensei.File

File(default=Undefined, *, default_factory=_Unset, alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, **extra)

Declare a file parameter for a path operation.

Example

@router.post('/upload')
def upload_image(cls, image: Annotated[bytes, File()]) -> str:
    pass

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	Callable to generate the default value. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset
alias	Alternative name for the parameter field, used when parameter name conflicts with reserved words. TYPE: Optional[str] DEFAULT: None
title	Human-readable title for the parameter. TYPE: Optional[str] DEFAULT: None
description	Human-readable description for the parameter. TYPE: Optional[str] DEFAULT: None
gt	Specifies that the value must be greater than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
ge	Specifies that the value must be greater than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
lt	Specifies that the value must be less than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
le	Specifies that the value must be less than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
min_length	Minimum length for string values. TYPE: Optional[int] DEFAULT: None
max_length	Maximum length for string values. TYPE: Optional[int] DEFAULT: None
pattern	Regular expression pattern for string values. TYPE: Optional[str] DEFAULT: None
discriminator	Field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None
strict	Enables strict validation if set to True. TYPE: Union[bool, None] DEFAULT: _Unset
multiple_of	Specifies that the value must be a multiple of this value, applicable only to numbers. TYPE: Union[float, None] DEFAULT: _Unset
allow_inf_nan	Allows values inf, -inf, and nan, applicable only to numbers. TYPE: Union[bool, None] DEFAULT: _Unset
max_digits	Maximum number of digits allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
decimal_places	Maximum number of decimal places allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
examples	Example values for the parameter. TYPE: Optional[List[Any]] DEFAULT: None
**extra	Extra fields for JSON Schema. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
_params_File	File parameter for a path operation TYPE: Any

Source code in sensei/_internal/_core/params_functions.py

def File(
        default: Any = Undefined,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        alias: Optional[str] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[List[Any]] = None,
        **extra: Any,
) -> Any:
    """
    Declare a file parameter for a **path operation**.

    Example:
        ```python
        @router.post('/upload')
        def upload_image(cls, image: Annotated[bytes, File()]) -> str:
            pass
        ```

    Args:
        default (Any):
            Default value if the parameter field is not set.
        default_factory (Union[Callable[[], Any], None]):
            Callable to generate the default value.
        alias (Optional[str]):
            Alternative name for the parameter field, used when parameter name
            conflicts with reserved words.
        title (Optional[str]):
            Human-readable title for the parameter.
        description (Optional[str]):
            Human-readable description for the parameter.
        gt (Optional[float]):
            Specifies that the value must be greater than this value, applicable only to numbers.
        ge (Optional[float]):
            Specifies that the value must be greater than or equal to this value, applicable only to numbers.
        lt (Optional[float]):
            Specifies that the value must be less than this value, applicable only to numbers.
        le (Optional[float]):
            Specifies that the value must be less than or equal to this value, applicable only to numbers.
        min_length (Optional[int]):
            Minimum length for string values.
        max_length (Optional[int]):
            Maximum length for string values.
        pattern (Optional[str]):
            Regular expression pattern for string values.
        discriminator (Union[str, None]):
            Field name for discriminating the type in a tagged union.
        strict (Union[bool, None]):
            Enables strict validation if set to `True`.
        multiple_of (Union[float, None]):
            Specifies that the value must be a multiple of this value, applicable only to numbers.
        allow_inf_nan (Union[bool, None]):
            Allows values `inf`, `-inf`, and `nan`, applicable only to numbers.
        max_digits (Union[int, None]):
            Maximum number of digits allowed for numeric values.
        decimal_places (Union[int, None]):
            Maximum number of decimal places allowed for numeric values.
        examples (Optional[List[Any]]):
            Example values for the parameter.
        **extra (Any):
            Extra fields for JSON Schema.

    Returns:
        _params_File: File parameter for a **path operation**
    """
    media_type = "multipart/form-data"
    return _params_File(
        default=default,
        default_factory=default_factory,
        media_type=media_type,
        alias=alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        **extra,
    )

sensei.Header

Header(default=Undefined, *, default_factory=_Unset, alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, **extra)

Declare a header parameter for a path operation.

Example

@router.get('/download')
def download_file(cls, x_token: Annotated[str, Header()]) -> bytes:
    pass

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	Callable to generate the default value. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset
alias	Alternative name for the parameter field, used when parameter name conflicts with reserved words. TYPE: Optional[str] DEFAULT: None
title	Human-readable title for the parameter. TYPE: Optional[str] DEFAULT: None
description	Human-readable description for the parameter. TYPE: Optional[str] DEFAULT: None
gt	Specifies that the value must be greater than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
ge	Specifies that the value must be greater than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
lt	Specifies that the value must be less than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
le	Specifies that the value must be less than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
min_length	Minimum length for string values. TYPE: Optional[int] DEFAULT: None
max_length	Maximum length for string values. TYPE: Optional[int] DEFAULT: None
pattern	Regular expression pattern for string values. TYPE: Optional[str] DEFAULT: None
discriminator	Field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None
strict	Enables strict validation if set to True. TYPE: Union[bool, None] DEFAULT: _Unset
multiple_of	Specifies that the value must be a multiple of this value, applicable only to numbers. TYPE: Union[float, None] DEFAULT: _Unset
allow_inf_nan	Allows values inf, -inf, and nan, applicable only to numbers. TYPE: Union[bool, None] DEFAULT: _Unset
max_digits	Maximum number of digits allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
decimal_places	Maximum number of decimal places allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
examples	Example values for the parameter. TYPE: Optional[List[Any]] DEFAULT: None
**extra	Extra fields for JSON Schema. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
_params_Header	Header parameter for a path operation TYPE: Header

Source code in sensei/_internal/_core/params_functions.py

def Header(
        default: Any = Undefined,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        alias: Optional[str] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[List[Any]] = None,
        **extra: Any,
) -> _params_Header:
    """
    Declare a header parameter for a **path operation**.

    Example:
        ```python
        @router.get('/download')
        def download_file(cls, x_token: Annotated[str, Header()]) -> bytes:
            pass
        ```

    Args:
        default (Any):
            Default value if the parameter field is not set.
        default_factory (Union[Callable[[], Any], None]):
            Callable to generate the default value.
        alias (Optional[str]):
            Alternative name for the parameter field, used when parameter name
            conflicts with reserved words.
        title (Optional[str]):
            Human-readable title for the parameter.
        description (Optional[str]):
            Human-readable description for the parameter.
        gt (Optional[float]):
            Specifies that the value must be greater than this value, applicable only to numbers.
        ge (Optional[float]):
            Specifies that the value must be greater than or equal to this value, applicable only to numbers.
        lt (Optional[float]):
            Specifies that the value must be less than this value, applicable only to numbers.
        le (Optional[float]):
            Specifies that the value must be less than or equal to this value, applicable only to numbers.
        min_length (Optional[int]):
            Minimum length for string values.
        max_length (Optional[int]):
            Maximum length for string values.
        pattern (Optional[str]):
            Regular expression pattern for string values.
        discriminator (Union[str, None]):
            Field name for discriminating the type in a tagged union.
        strict (Union[bool, None]):
            Enables strict validation if set to `True`.
        multiple_of (Union[float, None]):
            Specifies that the value must be a multiple of this value, applicable only to numbers.
        allow_inf_nan (Union[bool, None]):
            Allows values `inf`, `-inf`, and `nan`, applicable only to numbers.
        max_digits (Union[int, None]):
            Maximum number of digits allowed for numeric values.
        decimal_places (Union[int, None]):
            Maximum number of decimal places allowed for numeric values.
        examples (Optional[List[Any]]):
            Example values for the parameter.
        **extra (Any):
            Extra fields for JSON Schema.

    Returns:
        _params_Header: Header parameter for a **path operation**
    """
    return _params_Header(
        default=default,
        default_factory=default_factory,
        alias=alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        **extra,
    )

sensei.Cookie

Cookie(default=Undefined, *, default_factory=_Unset, alias=None, title=None, description=None, gt=None, ge=None, lt=None, le=None, min_length=None, max_length=None, pattern=None, discriminator=None, strict=_Unset, multiple_of=_Unset, allow_inf_nan=_Unset, max_digits=_Unset, decimal_places=_Unset, examples=None, **extra)

Declare a cookie parameter for a path operation.

Example

@router.get('/verify')
def verify_user(cls, session_id: Annotated[str, Cookie()]) -> bool:
    pass

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	Callable to generate the default value. TYPE: Union[Callable[[], Any], None] DEFAULT: _Unset
alias	Alternative name for the parameter field, used when parameter name conflicts with reserved words. TYPE: Optional[str] DEFAULT: None
title	Human-readable title for the parameter. TYPE: Optional[str] DEFAULT: None
description	Human-readable description for the parameter. TYPE: Optional[str] DEFAULT: None
gt	Specifies that the value must be greater than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
ge	Specifies that the value must be greater than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
lt	Specifies that the value must be less than this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
le	Specifies that the value must be less than or equal to this value, applicable only to numbers. TYPE: Optional[float] DEFAULT: None
min_length	Minimum length for string values. TYPE: Optional[int] DEFAULT: None
max_length	Maximum length for string values. TYPE: Optional[int] DEFAULT: None
pattern	Regular expression pattern for string values. TYPE: Optional[str] DEFAULT: None
discriminator	Field name for discriminating the type in a tagged union. TYPE: Union[str, None] DEFAULT: None
strict	Enables strict validation if set to True. TYPE: Union[bool, None] DEFAULT: _Unset
multiple_of	Specifies that the value must be a multiple of this value, applicable only to numbers. TYPE: Union[float, None] DEFAULT: _Unset
allow_inf_nan	Allows values inf, -inf, and nan, applicable only to numbers. TYPE: Union[bool, None] DEFAULT: _Unset
max_digits	Maximum number of digits allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
decimal_places	Maximum number of decimal places allowed for numeric values. TYPE: Union[int, None] DEFAULT: _Unset
examples	Example values for the parameter. TYPE: Optional[List[Any]] DEFAULT: None
**extra	Extra fields for JSON Schema. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
_params_Cookie	Cookie parameter for a path operation. TYPE: Cookie

Source code in sensei/_internal/_core/params_functions.py

def Cookie(
        default: Any = Undefined,
        *,
        default_factory: Union[Callable[[], Any], None] = _Unset,
        alias: Optional[str] = None,
        title: Optional[str] = None,
        description: Optional[str] = None,
        gt: Optional[float] = None,
        ge: Optional[float] = None,
        lt: Optional[float] = None,
        le: Optional[float] = None,
        min_length: Optional[int] = None,
        max_length: Optional[int] = None,
        pattern: Optional[str] = None,
        discriminator: Union[str, None] = None,
        strict: Union[bool, None] = _Unset,
        multiple_of: Union[float, None] = _Unset,
        allow_inf_nan: Union[bool, None] = _Unset,
        max_digits: Union[int, None] = _Unset,
        decimal_places: Union[int, None] = _Unset,
        examples: Optional[List[Any]] = None,
        **extra: Any,
) -> _params_Cookie:
    """
    Declare a cookie parameter for a **path operation**.

    Example:
        ```python
        @router.get('/verify')
        def verify_user(cls, session_id: Annotated[str, Cookie()]) -> bool:
            pass
        ```

    Args:
        default (Any):
            Default value if the parameter field is not set.
        default_factory (Union[Callable[[], Any], None]):
            Callable to generate the default value.
        alias (Optional[str]):
            Alternative name for the parameter field, used when parameter name
            conflicts with reserved words.
        title (Optional[str]):
            Human-readable title for the parameter.
        description (Optional[str]):
            Human-readable description for the parameter.
        gt (Optional[float]):
            Specifies that the value must be greater than this value, applicable only to numbers.
        ge (Optional[float]):
            Specifies that the value must be greater than or equal to this value, applicable only to numbers.
        lt (Optional[float]):
            Specifies that the value must be less than this value, applicable only to numbers.
        le (Optional[float]):
            Specifies that the value must be less than or equal to this value, applicable only to numbers.
        min_length (Optional[int]):
            Minimum length for string values.
        max_length (Optional[int]):
            Maximum length for string values.
        pattern (Optional[str]):
            Regular expression pattern for string values.
        discriminator (Union[str, None]):
            Field name for discriminating the type in a tagged union.
        strict (Union[bool, None]):
            Enables strict validation if set to `True`.
        multiple_of (Union[float, None]):
            Specifies that the value must be a multiple of this value, applicable only to numbers.
        allow_inf_nan (Union[bool, None]):
            Allows values `inf`, `-inf`, and `nan`, applicable only to numbers.
        max_digits (Union[int, None]):
            Maximum number of digits allowed for numeric values.
        decimal_places (Union[int, None]):
            Maximum number of decimal places allowed for numeric values.
        examples (Optional[List[Any]]):
            Example values for the parameter.
        **extra (Any):
            Extra fields for JSON Schema.

    Returns:
        _params_Cookie: Cookie parameter for a *path operation*.
    """
    return _params_Cookie(
        default=default,
        default_factory=default_factory,
        alias=alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        **extra,
    )