Query

No overview available.

def Query(
    default: Any = Undefined,
    default_factory: Callable[[], Any] | None = _Unset,
    alias: str | None = None,
    alias_priority: int | None = _Unset,
    validation_alias: str | AliasPath | AliasChoices | None = None,
    serialization_alias: str | None = None,
    title: str | None = None,
    description: str | None = None,
    gt: float | None = None,
    ge: float | None = None,
    lt: float | None = None,
    le: float | None = None,
    min_length: int | None = None,
    max_length: int | None = None,
    pattern: str | None = None,
    regex: str | None = None,
    discriminator: str | None = None,
    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: Any | None = _Unset,
    openapi_examples: dict[str, Example] | None = None,
    deprecated: deprecated | str | bool | None = None,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any] | None = None,
    extra: Any
) - > Any

Creates a Query parameter that can be used to define metadata and validation rules for query parameters in a web application. This function allows you to specify default values, aliases, validation constraints (like min/max length, greater/less than, regex patterns), and OpenAPI documentation details for query parameters.

Parameters

Name	Type	Description
default	Any = Undefined	The default value to be used if the parameter field is not provided in the request. This value will be used if the query parameter is omitted.
default_factory	`Callable[[], Any]	None` = _Unset
alias	`str	None` = None
alias_priority	`int	None` = _Unset
validation_alias	`str	AliasPath
serialization_alias	`str	None` = None
title	`str	None` = None
description	`str	None` = None
gt	`float	None` = None
ge	`float	None` = None
lt	`float	None` = None
le	`float	None` = None
min_length	`int	None` = None
max_length	`int	None` = None
pattern	`str	None` = None
regex	`str	None` = None
discriminator	`str	None` = None
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	`Any	None` = _Unset
openapi_examples	`dict[str, Example]	None` = None
deprecated	`deprecated	str
include_in_schema	bool = True	Determines whether this parameter field should be included in the generated OpenAPI schema. Setting this to False will hide the parameter from the API documentation.
json_schema_extra	`dict[str, Any]	None` = None
extra	Any	Extra fields used by the JSON Schema. This parameter is deprecated; use json_schema_extra instead.

Returns

Type	Description
Any	A Query parameter object with the specified metadata and validation rules.