参数¶

litestar.params.Body(*, const: bool | None = None, content_encoding: str | None = None, default: Any = _EmptyEnum.EMPTY, description: str | None = None, examples: list[Example] | None = None, external_docs: ExternalDocumentation | None = None, ge: float | None = None, gt: float | None = None, le: float | None = None, lt: float | None = None, max_items: int | None = None, max_length: int | None = None, media_type: str | RequestEncodingType = RequestEncodingType.JSON, min_items: int | None = None, min_length: int | None = None, multipart_form_part_limit: int | None = None, multiple_of: float | None = None, pattern: str | None = None, title: str | None = None, schema_extra: dict[str, Any] | None = None, schema_component_key: str | None = None) → Any¶: 创建扩展的请求体关键字参数定义。 Args: const: 一个布尔标志，指示该参数是否为常量。如果为 True，则传递给该参数的值必须等于其默认值。这也会导致 OpenAPI 的 const 字段被填充为默认值。 content_encoding: 值的编码方式。仅适用于字符串值。详见 OpenAPI 3.1。 description: 用于给定参数在 OpenAPI 架构描述部分中的字符串值。 examples: 示例模型列表。 external_docs: 指向给定参数外部文档的 URL。 ge: 将值限制为大于或等于给定的浮点数或整数。等同于 OpenAPI 规范中的 minimum。 gt: 将值限制为大于给定的浮点数或整数。等同于 OpenAPI 规范中的 exclusiveMinimum。 le: 将值限制为小于或等于给定的浮点数或整数。等同于 OpenAPI 规范中的 maximum。 lt: 将值限制为小于给定的浮点数或整数。等同于 OpenAPI 规范中的 exclusiveMaximum。 max_items: 将集合或列表限制为具有最大项目数。等同于 OpenAPI 规范中的 maxItems。 max_length: 将字符串或字节值限制为具有最大长度。等同于 OpenAPI 规范中的 maxLength。 media_type: 默认为 RequestEncodingType.JSON。 min_items: 将集合或列表限制为具有最小项目数。等同于 OpenAPI 规范中的 minItems。 min_length: 将字符串或字节值限制为具有最小长度。等同于 OpenAPI 规范中的 minLength。 multipart_form_part_limit: multipart/formdata 请求中允许的最大部分数。此限制旨在防止 DoS 攻击。 multiple_of: 将值限制为给定浮点数或整数的倍数。等同于 OpenAPI 规范中的 multipleOf。 pattern: 表示正则表达式的字符串，用于匹配给定的字符串。等同于 OpenAPI 规范中的 pattern。 title: 用于给定参数在 OpenAPI 架构标题部分中的字符串值。 schema_extra: 对生成的架构的扩展。如果设置，将覆盖生成架构中匹配的字段。 .. versionadded:: 2.8.0 schema_component_key: 在为此类型创建组件时，将其用作引用的键。 .. versionadded:: 2.12.0

class litestar.params.BodyKwarg¶

基类：KwargDefinition

表示请求体的数据容器。

__init__(examples: list[Example] | None = None, external_docs: ExternalDocumentation | None = None, content_encoding: str | None = None, default: Any = _EmptyEnum.EMPTY, title: str | None = None, description: str | None = None, const: bool | None = None, gt: float | None = None, ge: float | None = None, lt: float | None = None, le: float | None = None, multiple_of: float | None = None, min_items: int | None = None, max_items: int | None = None, min_length: int | None = None, max_length: int | None = None, pattern: str | None = None, lower_case: bool | None = None, upper_case: bool | None = None, format: str | None = None, enum: Sequence[Any] | None = None, read_only: bool | None = None, schema_extra: dict[str, Any] | None = None, schema_component_key: str | None = None, include_in_schema: bool = True, media_type: str | RequestEncodingType = RequestEncodingType.JSON, multipart_form_part_limit: int | None = None) → None¶

media_type: str | RequestEncodingType = 'application/json'¶: Media-Type of the body.

multipart_form_part_limit: int | None = None¶: The maximal number of allowed parts in a multipart/formdata request. This limit is intended to protect from DoS attacks.

__hash__() → int¶: 以安全的方式对数据类进行哈希处理。 Returns: 一个哈希值

litestar.params.Dependency(*, default: Any = _EmptyEnum.EMPTY, skip_validation: bool = False) → Any¶

Create a dependency kwarg definition.

参数:

default¶ -- A default value to use in case a dependency is not provided.
skip_validation¶ -- If True provided dependency values are not validated by signature model.

class litestar.params.DependencyKwarg¶

基类：object

Data container representing a dependency.

__init__(default: Any = _EmptyEnum.EMPTY, skip_validation: bool = False) → None¶

default: Any = 0¶: A default value.

skip_validation: bool = False¶: Flag dictating whether to skip validation.

__hash__() → int¶

Hash the dataclass in a safe way.

返回:: A hash

class litestar.params.KwargDefinition¶

基类：object

表示受限关键字参数的数据容器。

examples: list[Example] | None = None¶: A list of Example models.

external_docs: ExternalDocumentation | None = None¶: A url pointing at external documentation for the given parameter.

content_encoding: str | None = None¶

The content encoding of the value.

Applicable on to string values. See OpenAPI 3.1 for details.

default: Any = 0¶

A default value.

If const is true, this value is required.

title: str | None = None¶: String value used in the title section of the OpenAPI schema for the given parameter.

description: str | None = None¶: String value used in the description section of the OpenAPI schema for the given parameter.

const: bool | None = None¶

A boolean flag dictating whether this parameter is a constant.

If True, the value passed to the parameter must equal its default value. This also causes the OpenAPI const field to be populated with the default value.

gt: float | None = None¶

Constrict value to be greater than a given float or int.

Equivalent to exclusiveMinimum in the OpenAPI specification.

ge: float | None = None¶

Constrict value to be greater or equal to a given float or int.

Equivalent to minimum in the OpenAPI specification.

lt: float | None = None¶

Constrict value to be less than a given float or int.

Equivalent to exclusiveMaximum in the OpenAPI specification.

le: float | None = None¶

Constrict value to be less or equal to a given float or int.

Equivalent to maximum in the OpenAPI specification.

multiple_of: float | None = None¶

Constrict value to a multiple of a given float or int.

Equivalent to multipleOf in the OpenAPI specification.

min_items: int | None = None¶

Constrict a set or a list to have a minimum number of items.

Equivalent to minItems in the OpenAPI specification.

max_items: int | None = None¶

Constrict a set or a list to have a maximum number of items.

Equivalent to maxItems in the OpenAPI specification.

min_length: int | None = None¶

Constrict a string or bytes value to have a minimum length.

Equivalent to minLength in the OpenAPI specification.

max_length: int | None = None¶

Constrict a string or bytes value to have a maximum length.

Equivalent to maxLength in the OpenAPI specification.

pattern: str | None = None¶

A string representing a regex against which the given string will be matched.

Equivalent to pattern in the OpenAPI specification.

lower_case: bool | None = None¶: Constrict a string value to be lower case.

upper_case: bool | None = None¶: Constrict a string value to be upper case.

format: str | None = None¶: Specify the format to which a string value should be converted.

enum: Sequence[Any] | None = None¶: A sequence of valid values.

read_only: bool | None = None¶: A boolean flag dictating whether this parameter is read only.

__init__(examples: list[Example] | None = None, external_docs: ExternalDocumentation | None = None, content_encoding: str | None = None, default: Any = _EmptyEnum.EMPTY, title: str | None = None, description: str | None = None, const: bool | None = None, gt: float | None = None, ge: float | None = None, lt: float | None = None, le: float | None = None, multiple_of: float | None = None, min_items: int | None = None, max_items: int | None = None, min_length: int | None = None, max_length: int | None = None, pattern: str | None = None, lower_case: bool | None = None, upper_case: bool | None = None, format: str | None = None, enum: Sequence[Any] | None = None, read_only: bool | None = None, schema_extra: dict[str, Any] | None = None, schema_component_key: str | None = None, include_in_schema: bool = True) → None¶

schema_extra: dict[str, Any] | None = None¶

Extensions to the generated schema.

If set, will overwrite the matching fields in the generated schema.

在 2.8.0 版本加入.

schema_component_key: str | None = None¶: Use as the key for the reference when creating a component for this type .. versionadded:: 2.12.0

include_in_schema: bool = True¶: A boolean flag dictating whether this parameter should be included in the schema. .. versionadded:: 2.17.0

property is_constrained: bool¶: 如果设置了任何约束，则返回 True。

litestar.params.Parameter(annotation: Any = _EmptyEnum.EMPTY, *, const: bool | None = None, content_encoding: str | None = None, cookie: str | None = None, default: Any = _EmptyEnum.EMPTY, description: str | None = None, examples: list[Example] | None = None, external_docs: ExternalDocumentation | None = None, ge: float | None = None, gt: float | None = None, header: str | None = None, le: float | None = None, lt: float | None = None, max_items: int | None = None, max_length: int | None = None, min_items: int | None = None, min_length: int | None = None, multiple_of: float | None = None, pattern: str | None = None, query: str | None = None, required: bool | None = None, title: str | None = None, schema_extra: dict[str, Any] | None = None, schema_component_key: str | None = None, include_in_schema: bool = True) → Any¶: 创建扩展的参数关键字参数定义。 Args: annotation: 默认为 Empty。 const: 一个布尔标志，指示该参数是否为常量。如果为 True，则传递给该参数的值必须等于其默认值。这也会导致 OpenAPI 的 const 字段被填充为默认值。 content_encoding: 值的编码方式。仅适用于字符串值。详见 OpenAPI 3.1。 cookie: Cookie 参数的键 - 对于 cookie 参数是必需的。 description: 用于给定参数的 OpenAPI 架构描述部分的字符串值。 examples: Example 模型列表。 external_docs: 指向给定参数外部文档的 URL。 ge: 将值限制为大于或等于给定的浮点数或整数。等同于 OpenAPI 规范中的 minimum。 gt: 将值限制为大于给定的浮点数或整数。等同于 OpenAPI 规范中的 exclusiveMinimum。 header: 请求头参数的键 - 对于请求头参数是必需的。 le: 将值限制为小于或等于给定的浮点数或整数。等同于 OpenAPI 规范中的 maximum。 lt: 将值限制为小于给定的浮点数或整数。等同于 OpenAPI 规范中的 exclusiveMaximum。 max_items: 将集合或列表限制为具有最大项目数。等同于 OpenAPI 规范中的 maxItems。 max_length: 将字符串或字节值限制为具有最大长度。等同于 OpenAPI 规范中的 maxLength。 min_items: 将集合或列表限制为具有最小项目数。等同于 OpenAPI 规范中的 minItems。 min_length: 将字符串或字节值限制为具有最小长度。等同于 OpenAPI 规范中的 minLength。 multiple_of: 将值限制为给定浮点数或整数的倍数。等同于 OpenAPI 规范中的 multipleOf。 pattern: 表示正则表达式的字符串，用于匹配给定的字符串。等同于 OpenAPI 规范中的 pattern。 query: 此参数的查询参数键。 required: 一个布尔标志，指示该参数是否为必需。如果设置为 False，则允许 None 值。默认为 True。 title: 用于给定参数的 OpenAPI 架构标题部分的字符串值。 schema_extra: 对生成的架构的扩展。如果设置，将覆盖生成架构中匹配的字段。 .. versionadded:: 2.8.0 schema_component_key: 在为此类型创建组件时，将其用作引用的键。 .. versionadded:: 2.12.0 include_in_schema: 一个布尔标志，指示该参数是否应包含在架构中。

class litestar.params.ParameterKwarg¶

基类：KwargDefinition

表示参数的数据容器。

__init__(examples: list[Example] | None = None, external_docs: ExternalDocumentation | None = None, content_encoding: str | None = None, default: Any = _EmptyEnum.EMPTY, title: str | None = None, description: str | None = None, const: bool | None = None, gt: float | None = None, ge: float | None = None, lt: float | None = None, le: float | None = None, multiple_of: float | None = None, min_items: int | None = None, max_items: int | None = None, min_length: int | None = None, max_length: int | None = None, pattern: str | None = None, lower_case: bool | None = None, upper_case: bool | None = None, format: str | None = None, enum: Sequence[Any] | None = None, read_only: bool | None = None, schema_extra: dict[str, Any] | None = None, schema_component_key: str | None = None, include_in_schema: bool = True, annotation: Any = _EmptyEnum.EMPTY, header: str | None = None, cookie: str | None = None, query: str | None = None, required: bool | None = None) → None¶

annotation: Any = 0¶: The field value - Empty by default.

header: str | None = None¶: The header parameter key - required for header parameters.

cookie: str | None = None¶: The cookie parameter key - required for cookie parameters.

query: str | None = None¶: The query parameter key for this parameter.

required: bool | None = None¶

A boolean flag dictating whether this parameter is required.

If set to False, None values will be allowed. Defaults to True.

__hash__() → int¶: 以安全的方式对数据类进行哈希处理。 Returns: 一个哈希值