fields.cpython-310.pyc•48.1 kB
o
�I�g+� � $ @ sh U d Z ddlmZ ddlZddlZddlZddlZddlm Z ddl
m
Z
ddlm Z ddl
mZ ddlmZmZmZmZmZmZmZmZ dd lmZ ddlZddlZdd
lm Z dd lm Z m Z m Z dd l m!Z! dd
l"m#Z#m$Z$m%Z%m&Z&m'Z' ddl(m)Z) ddl*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1 ddl2m3Z3m4Z4 ddl5m6Z6m7Z7 ddl8m9Z9 ddl:m;Z;m<Z< ddl=m>Z> ddlm?Z? ej@r�ddlAmBZB ne?ZCdZDe ZEdeFd< ejGdkr�ddlZej e B ZHd eFd < ne ZHd eFd < G d d � d ejId d!�ZJG d"d#� d#eJd d!�ZKG d$d%� d%e/jL�ZMG d&d'� d'ejI�ZNi d(d)�d*d�d+d�d,d�d-d�d.d�d/d�d0d�d1d�d2d�d3d�d4d�d5d�d6d�d7d8�d9d�d:d�ddddddddddddddd;��ZOed<�ZPeeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEd=�!d�dedf��Z eeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEd=�!d�dgdf��Z eeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEd=�!d�didf��Z eeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEd=�!d�djdf��Z e feEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEeEdk�"d�dmdf�Z eQe�Re �jS�ZTeT�Udb� G dndo� doe/jL�ZVed dp�d�drds��ZWed dp�d�duds��ZWed dp�d�dvds��ZWe fdd dw�d�dyds�ZWejXd�i e.jY��G dzd{� d{��ZZd�d~d�Z[e�d��Z\ejd�d�d���Z]ejddddddddd8e d��
d�d�d���Z] d�ddddddddde d��
d�d�d��Z]dS )�zDefining fields on models.� )� annotationsN)�Mapping)�copy)�Field)�cached_property)� Annotated�Any�Callable�ClassVar�Literal�TypeVar�cast�overload)�warn)�PydanticUndefined)� TypeAlias�Unpack�
deprecated)�typing_objects)�UNKNOWN�AnnotationSource�ForbiddenQualifier� Qualifier�inspect_annotation� )�types)� _decorators�_fields� _generics�_internal_dataclass�_repr�
_typing_extra�_utils)�GlobalsNamespace�MappingNamespace)� AliasChoices� AliasPath)�JsonDict)�PydanticForbiddenQualifier�PydanticUserError)�PydanticJsonSchemaWarning)�PydanticDeprecatedSince20)�ReprArgs)r � PrivateAttr�computed_fieldr �_Unset)� �
r �
Deprecatedc @ s* e Zd ZU dZded< ded< ded< ded < d
ed < ded < ded
< ded< ded< ded< ded< ded< ded< ded< ded < d ed < ded < ded < ded!< d"ed#< ded$< ded%< ded&< d'ed(< d)ed*< d+ed,< d-ed.< ded/< ded0< d1ed2< ded3< ded4< ded5< ded6< ded7< d8S )9�_FromFieldInfoInputsz[This class exists solely to add type checking for the `**kwargs` in `FieldInfo.from_field`.�type[Any] | None�
annotation�:Callable[[], Any] | Callable[[dict[str, Any]], Any] | None�default_factory�
str | None�alias�
int | None�alias_priority�%str | AliasPath | AliasChoices | None�validation_alias�serialization_alias�title�&Callable[[str, FieldInfo], str] | None�field_title_generator� description�list[Any] | None�examples� bool | None�exclude�!annotated_types.SupportsGt | None�gt�!annotated_types.SupportsGe | None�ge�!annotated_types.SupportsLt | None�lt�!annotated_types.SupportsLe | None�le� float | None� multiple_of�strict�
min_length�
max_length� str | typing.Pattern[str] | None�pattern�
allow_inf_nan�
max_digits�decimal_placesz(Literal['smart', 'left_to_right'] | None�
union_mode� str | types.Discriminator | None�
discriminator� Deprecated | str | bool | Noner �,JsonDict | Callable[[JsonDict], None] | None�json_schema_extra�frozen�validate_default�bool�repr�init�init_var�kw_only�coerce_numbers_to_str� fail_fastN��__name__�
__module__� __qualname__�__doc__�__annotations__� rn rn �]C:\Users\apqls\Documents\Github\tkbase\api-docs-mcp\venv\Lib\site-packages\pydantic/fields.pyr3 4 sJ
r3 F)�totalc @ s e Zd ZU dZded< dS )�_FieldInfoInputszYThis class exists solely to add type checking for the `**kwargs` in `FieldInfo.__init__`.r �defaultNrh rn rn rn ro rq ] s
rq c @ s� e Zd ZU dZded< ded< ded< ded < d
ed < d ed
< ded< ded< ded< ded< ded< ded< ded< ded< ded < ded < ded < d ed < ded!< ded"< ded#< d$ed%< d&Zejej ej
ej ej ej
ejejd'd'd'd'd'd'ejd(�Zd)ed*< dhd/d0�Zeefdid2d3��Zeejd4�djd8d9��Zeejd4�dkd:d;��Zedld>d?��ZedmdBdC��ZedndEdF��Z e dodGdH��Z e dpdIdJ��Z e d'dK�dqdPdQ��Z!e dRdS�drdUdQ��Z!dVd'dW�dsdXdQ�Z!dtdYdZ�Z"dud[d\�Z# ' 'dvdwdcdd�Z$dxdfdg�Z%d'S )y� FieldInfoa� This class holds information about a field.
`FieldInfo` is used for any field definition regardless of whether the [`Field()`][pydantic.fields.Field]
function is explicitly used.
!!! warning
You generally shouldn't be creating `FieldInfo` directly, you'll only need to use it when accessing
[`BaseModel`][pydantic.main.BaseModel] `.model_fields` internals.
Attributes:
annotation: The type annotation of the field.
default: The default value of the field.
default_factory: A callable to generate the default value. The callable can either take 0 arguments
(in which case it is called as is) or a single argument containing the already validated data.
alias: The alias name of the field.
alias_priority: The priority of the field's alias.
validation_alias: The validation alias of the field.
serialization_alias: The serialization alias of the field.
title: The title of the field.
field_title_generator: A callable that takes a field name and returns title for it.
description: The description of the field.
examples: List of examples of the field.
exclude: Whether to exclude the field from the model serialization.
discriminator: Field name or Discriminator for discriminating the type in a tagged union.
deprecated: A deprecation message, an instance of `warnings.deprecated` or the `typing_extensions.deprecated` backport,
or a boolean. If `True`, a default deprecation message will be emitted when accessing the field.
json_schema_extra: A dict or callable to provide extra JSON schema properties.
frozen: Whether the field is frozen.
validate_default: Whether to validate the default value of the field.
repr: Whether to include the field in representation of the model.
init: Whether the field should be included in the constructor of the dataclass.
init_var: Whether the field should _only_ be included in the constructor of the dataclass, and not stored.
kw_only: Whether the field should be a keyword-only argument in the constructor of the dataclass.
metadata: List of metadata constraints.
r4 r5 r rr r6 r7 r8 r9 r: r; r< r= r> r? r@ rA rB rC rD rE rF rZ r[ r\ r r] r^ r_ r` ra rb rc rd re � list[Any]�metadata)r5 rr r7 r9 r; r= r> r? rA rB rD rF r[ r r^ r_ r` rb rc rd re ru �_attributes_set� _qualifiers� _complete�_original_assignment�_original_annotationN)rQ rH rJ rL rN rP rR rS rU rV rW rX rY rf rg z7ClassVar[dict[str, typing.Callable[[Any], Any] | None]]�metadata_lookup�kwargs�Unpack[_FieldInfoInputs]�return�Nonec K s� dd� |� � D �| _dd� |� � D �}|�d�| _|�dt�}|tu r.t| _| j�dd� n|| _|�dd�| _| jturF| jdurFt d��|�d d�| _
|�d
d�| _ |�d d�| _ t
d d
� | j
| j | j fD ��}|rt|�dd�psdnd| _|�dd�| _|�dd�| _|�dd�| _|�dd�| _|�dd�| _|�dd�| _|�dt| dd��| _|�dd�| _|�dd�| _|�dd�| _|�dd�| _|�d d�| _|�d d�| _ |�d d�| _ | � |�| _ t � | _!d| _"t| _#t| _$dS ) a This class should generally not be initialized directly; instead, use the `pydantic.fields.Field` function
or one of the constructor classmethods.
See the signature of `pydantic.fields.Field` for more details about the expected arguments.
c S s i | ] \}}|t ur||�qS rn )r/ ��.0�k�vrn rn ro �
<dictcomp>� � z&FieldInfo.__init__.<locals>.<dictcomp>c S s( i | ]\}}||t u rt�|�n|�qS rn )r/ �_DefaultValues�getr� rn rn ro r� � s ( r5 rr Nr7 �/cannot specify both default and default_factoryr9 r= r> c s s � | ]}|d uV qd S �Nrn )r� r9 rn rn ro � <genexpr>� � � z%FieldInfo.__init__.<locals>.<genexpr>r; � r? rA rB rD rF r[ r rb Tr^ r` r_ rc rd re )%�itemsrv r� r5 �popr �Ellipsisrr r7 � TypeErrorr9 r= r> �anyr; r? rA rB rD rF r[ �getattrr rb r^ r` r_ rc rd re �_collect_metadataru �setrw rx rz ry )�selfr| rr Z alias_is_setrn rn ro �__init__� sJ �
zFieldInfo.__init__� Unpack[_FromFieldInfoInputs]c K s" d|v rt d��tdd| i|��S )a~ Create a new `FieldInfo` object with the `Field` function.
Args:
default: The default value for the field. Defaults to Undefined.
**kwargs: Additional arguments dictionary.
Raises:
TypeError: If 'annotation' is passed as a keyword argument.
Returns:
A new FieldInfo object with the given parameters.
Example:
This is how you can create a field with default value like this:
```python
import pydantic
class MyModel(pydantic.BaseModel):
foo: int = pydantic.Field(4)
```
r5 z9"annotation" is not permitted as a Field keyword argumentrr Nrn )r� rs )rr r| rn rn ro �
from_field s zFieldInfo.from_field)�_source� type[Any]r� r c
C s
z t | |dd�}W n ty } zt|j| ��d}~ww |jtu r#tn|j}d|jv }|j}|s>t ||p5dd�}|j|_
|S dd� |D �}t j |d|i�}t |�} || _
|pX|j| _g }
|D ] } t�| �rj| j| _nt| t �su|
�| � n|
�| j� |
| _q^|j| _
| S ) a� Creates a `FieldInfo` instance from a bare annotation.
This function is used internally to create a `FieldInfo` from a bare annotation like this:
```python
import pydantic
class MyModel(pydantic.BaseModel):
foo: int # <-- like this
```
We also account for the case where the annotation can be an instance of `Annotated` and where
one of the (not first) arguments in `Annotated` is an instance of `FieldInfo`, e.g.:
```python
from typing import Annotated
import annotated_types
import pydantic
class MyModel(pydantic.BaseModel):
foo: Annotated[int, annotated_types.Gt(42)]
bar: Annotated[int, pydantic.Field(gt=42)]
```
Args:
annotation: An annotation object.
Returns:
An instance of the field metadata.
�skip�Zannotation_sourceZunpack_type_aliasesN�final)r5 r_ c S � g | ] }t |t�r|�qS rn ��
isinstancers �r� �arn rn ro �
<listcomp>] � z-FieldInfo.from_annotation.<locals>.<listcomp>r5 )r r r( � qualifier�typer r �
qualifiersru rs rw �merge_field_infosr r5 r_ r �
is_deprecated�messager r� �append�extend) r5 r� �
inspected_ann�e� type_exprr� ru �
field_infoZfield_info_annotationsZnew_field_info�field_metadatar� rn rn ro �from_annotation" s@ "
� ��
zFieldInfo.from_annotationc
C s� | |u r
t ddd��z t| |dd�}W n ty% } zt|j| ��d}~ww |jtu r-tn|j}d|jv }|j }t
|t �rf||_ | j |7 _ t j
g dd � |D ��|�R d
|j i�}|p^|j|_|j|_|S t
|tj�r�t �|�} || _ | j |7 _ t j
g d d � |D ��| �R d
| j i�} |p�| j| _d |jv | _t|d
d�| _t|dd�| _|j| _| S |s�t |||p�dd�}
|j|
_|
S dd � |D �} t j
| ||d��}
g } |D ] }
t�|
�r�|
j|
_q�t
|
t �s�| �|
� q�| � |
j � q�| |
_ |j|
_|
S )a� Create `FieldInfo` from an annotation with a default value.
This is used in cases like the following:
```python
from typing import Annotated
import annotated_types
import pydantic
class MyModel(pydantic.BaseModel):
foo: int = 4 # <-- like this
bar: Annotated[int, annotated_types.Gt(4)] = 4 # <-- or this
spam: Annotated[int, pydantic.Field(gt=4)] = 4 # <-- or this
```
Args:
annotation: The type annotation of the field.
default: The default value of the field.
Returns:
A field object with the passed values.
z�Error when building FieldInfo from annotated attribute. Make sure you don't have any field name clashing with a type annotation.zunevaluable-type-annotation��coder� r� Nr� c S r� rn r� �r� �xrn rn ro r� � r� z6FieldInfo.from_annotated_attribute.<locals>.<listcomp>r5 c S r� rn r� r� rn rn ro r� � r� rd rc re )r5 rr r_ c S r� rn r� r� rn rn ro r� � r� )r5 rr ) r) r r r( r� r� r r r� ru r� rs r5 r� r_ rw � dataclassesr �_from_dataclass_fieldrd r� rc re r r� r� r r� r� )r5 rr r� r� r� r� r� ru Zmerged_defaultZpydantic_fieldr� � field_infosr� r� rn rn ro �from_annotated_attributeo s� �
� ��
���
���
z"FieldInfo.from_annotated_attributer� � overridesc O sb t | �dkr6t| d �}|j�|� |�dt�}|tu r t}|tur%||_|�� D ]
\}}t |||� q)|S i }i }| D ]_}|j�� }z8|�d�} |�
d�}
|
du rV| |d< t |
t �rrt | t �rhi |
�| �|d< t
| �rqtdt� nt
| �rz| |d< W n ty� Y nw |�|� |jD ]
} t | t�s�| |t| �< q�q<|�|� tdi |��}t|�� �|_|S )z�Merge `FieldInfo` instances keeping only explicitly set attributes.
Later `FieldInfo` instances override earlier ones.
Returns:
FieldInfo: A merged FieldInfo instance.
r r rr r^ Nz�Composing `dict` and `callable` type `json_schema_extra` is not supported.The `callable` type is being ignored.If you'd like support for this behavior, please open an issue on pydantic.rn )�lenr rv �updater� r r� rr r� �setattrr� r� �dict�callabler r* �KeyErrorru rs r� �list�values) r� r� r� Zdefault_overrider� r� Zmerged_field_info_kwargsru Zattributes_setr^ Zexisting_json_schema_extrar� rn rn ro r� � sb
����� �
��
zFieldInfo.merge_field_infos�dc_field�DataclassField[Any]c C sX | j }|tju r
t}| jtju rt}n| j}dd� | j�� D �}td||| jd�|��S )a] Return a new `FieldInfo` instance from a `dataclasses.Field` instance.
Args:
dc_field: The `dataclasses.Field` instance to convert.
Returns:
The corresponding `FieldInfo` instance.
Raises:
TypeError: If any of the `FieldInfo` kwargs does not match the `dataclass.Field` kwargs.
c S s i | ] \}}|t v r||�qS rn )�_FIELD_ARG_NAMESr� rn rn ro r� / r� z3FieldInfo._from_dataclass_field.<locals>.<dictcomp>)rr r7 rb Nrn ) rr r� �MISSINGr/ r7 ru r� r rb )r� rr r7 Zdc_field_metadatarn rn ro r� s
z FieldInfo._from_dataclass_field�dict[str, Any]c C s� g }i }t | �� �D ],\}}ztj| }W n ty Y q
w | |= |dur6|du r/|||< q
|�||�� q
|rD|�tjdi |��� |S )a Collect annotations from kwargs.
Args:
kwargs: Keyword arguments passed to the function.
Returns:
A list of metadata objects - a combination of `annotated_types.BaseMetadata` and
`PydanticMetadata`.
Nrn )r� r� rs r{ r� r� r Zpydantic_general_metadata)r| ru Zgeneral_metadata�key�value�markerrn rn ro r� 2 s" �
�zFieldInfo._collect_metadatac C �B | j du rdS t| j t�r| j rdS dS t| j t�r | j S | j jS �z<The deprecation message to be emitted, or `None` if not set.Nr �r r� ra �strr� �r� rn rn ro �deprecation_messageO �
z FieldInfo.deprecation_messagec C s | j dur t�| j �S dS )z�Whether the provided default factory callable has a validated data parameter.
Returns `None` if no default factory is set.
N)r7 r Z takes_validated_data_argumentr� rn rn ro �$default_factory_takes_validated_dataX s
�z.FieldInfo.default_factory_takes_validated_data)�validated_data�call_default_factory�
Literal[True]r� �dict[str, Any] | Nonec C � d S r� rn )r� r� r� rn rn ro � get_defaulta s zFieldInfo.get_default.)r� �Literal[False]c C r� r� rn )r� r� rn rn ro r� f � F)r� r� c C sZ | j du r t�| j�S |r+| jr"td| j �}|du r td��||�S td| j �}|� S dS )a` Get the default value.
We expose an option for whether to call the default_factory (if present), as calling it may
result in side effects that we want to avoid. However, there are times when it really should
be called (namely, when instantiating a model via `model_construct`).
Args:
call_default_factory: Whether to call the default factory or not.
validated_data: The already validated data to be passed to the default factory.
Returns:
The default value, calling the default factory if requested or `None` if not set.
Nz Callable[[dict[str, Any]], Any]znThe default factory requires the 'validated_data' argument, which was not provided when calling 'get_default'.zCallable[[], Any])r7 r" �smart_deepcopyrr r� r
�
ValueError)r� r� r� Zfacrn rn ro r� i s
� c C s | j tu o | jdu S )z�Check if the field is required (i.e., does not have a default value or factory).
Returns:
`True` if the field is required, `False` otherwise.
N)rr r r7 r� rn rn ro � is_required� s zFieldInfo.is_requiredc C s | j s| jS t| jg| j �R S )a( Attempts to rebuild the original annotation for use in function signatures.
If metadata is present, it adds it to the original annotation using
`Annotated`. Otherwise, it returns the original annotation as-is.
Note that because the metadata has been flattened, the original annotation
may not be reconstructed exactly as originally provided, e.g. if the original
type had unrecognized annotations, or was annotated with a call to `pydantic.Field`.
Returns:
The rebuilt annotation.
N)ru r5 r r� rn rn ro �rebuild_annotation� s
z FieldInfo.rebuild_annotation� typevars_map� Mapping[TypeVar, Any] | None�globalns�GlobalsNamespace | None�localns�MappingNamespace | Nonec C s& t �| j||�\}}t�||�| _dS )a� Apply a `typevars_map` to the annotation.
This method is used when analyzing parametrized generic types to replace typevars with their concrete types.
This method applies the `typevars_map` to the annotation in place.
Args:
typevars_map: A dictionary mapping type variables to their concrete types.
globalns: The globals namespace to use during type annotation evaluation.
localns: The locals namespace to use during type annotation evaluation.
See Also:
pydantic._internal._generics.replace_types is used for replacing the typevars with
their concrete types.
N)r! Z
try_eval_typer5 r Z
replace_types)r� r� r� r� r5 �_rn rn ro �apply_typevars_map� s z FieldInfo.apply_typevars_mapr, c c s � dt �t �| j��fV d| �� fV | jD ]q}|dv r q|dkr&| js&q|dkr0| jdu r0q|dkr:| jdu r:q|d krE| j | j
krEq|d
krP| j | j
krPq|d kr`| j t
ur`d | j fV q|d krv| jd urvd t �t �| j��fV qt| |�}|d ur�|t
ur�||fV qd S )
Nr5 �required)r5 rv rw rx ry rz ru rb Tr_ Fr= r> rr r7 )r Z PlainReprZdisplay_as_typer5 r� � __slots__ru rb r_ r= r9 r> rr r r7 r� )r� �sr� rn rn ro �
__repr_args__� s2 �
��zFieldInfo.__repr_args__)r| r} r~ r )rr r r| r� r~ rs )r5 r� r� r r~ rs )r5 r� rr r r� r r~ rs )r� rs r� r r~ rs )r� r� r~ rs )r| r� r~ rt �r~ r8 )r~ rE )r� r� r� r� r~ r )r� r� r~ r )r� ra r� r� r~ r )r~ ra �r~ r )NN)r� r� r� r� r� r� r~ r )r~ r, )&ri rj rk rl rm r� r ZStrict�annotated_types�GtZGe�LtZLeZ
MultipleOfZMinLenZMaxLenZFailFastr{ r� � staticmethodr r� r �ANYr� r� r� r� r� �propertyr� r� r r� r� r� r� r� rn rn rn ro rs c s�
$!�
5L�f A �
�rs c @ s e Zd ZdZdS )� _EmptyKwargsz_This class exists solely to ensure that type checking warns about passing `**extra` in `Field`.N)ri rj rk rl rn rn rn ro r� � s r� rr .r7 r9 r; r= r> r? rB rD rF r[ r^ r_ r` rb Trc rd )re rU rQ rH rJ rL rN rP rV rW rX rR rS rf �_T)!r9 r; r= r> r? rA rB rD rF r[ r r^ r_ r` rb rc rd re rU rQ rf rH rJ rL rN rP rV rW rX rR rS rY rg �ellipsisr8 r: r< rA r@ rC rE rZ r r\ r] ra re rU rT rQ rf rH rG rJ rI rL rK rN rM rP rO rV rW rX rR rS rY �!Literal['smart', 'left_to_right']rg �extra�Unpack[_EmptyKwargs]r~ c ! # K r� r� rn �#rr r9 r; r= r> r? rA rB rD rF r[ r r^ r_ r` rb rc rd re rU rQ rf rH rJ rL rN rP rV rW rX rR rS rY rg r� rn rn ro r
� &r c ! # K r� r� rn r� rn rn ro r 1 r� �1Callable[[], _T] | Callable[[dict[str, Any]], _T]c " # K r� r� rn )#r7 r9 r; r= r> r? rA rB rD rF r[ r r^ r_ r` rb rc rd re rU rQ rf rH rJ rL rN rP rV rW rX rR rS rY rg r� rn rn ro r X r� c ! " K r� r� rn )"r9 r; r= r> r? rA rB rD rF r[ r r^ r_ r` rb rc rd re rU rQ rf rH rJ rL rN rP rV rW rX rR rS rY rg r� rn rn ro r s %)"r7 r9 r; r= r> r? rA rB rD rF r[ r r^ r_ r` rb rc rd re rU rQ rf rH rJ rL rN rP rV rW rX rR rS rY rg r6 c " + K sf |#� dd�}$|$durtddd��|#� dd�}%|%dur'tdt� | dtfv r'|%} |#� dd�}&|&dur>td t� | dtfv r>|&} |#� d
d�}'|'durNtd dd��|#� d d�}(|(durctd
t� |(du rcd}|#� dd�})|)durstddd��|#r�tdd�dd� |#�� D ��� d�t� |
r�|
tu r�|#}
|r�|tur�t|tt t
f�s�t d��|tdfv r�t|t�r�|}|tdfv r�|}|#� dd�}*|*dur�tdt� t j
| fi d|�d|�d |�d |�d |�d |�d |�d!|�d"| �d#|
�d$| �d%| �d&|
�d'|�d(|�d)|�d*|�d+|�d,|�d-|�d.|�d/|�d0|�d1|�d2|�d3|�d4|�d5| �d6| �d7| �d8| �d9| �d:|!�d;|"��S )<a !!! abstract "Usage Documentation"
[Fields](../concepts/fields.md)
Create a field for objects that can be configured.
Used to provide extra information about a field, either for the model schema or complex validation. Some arguments
apply only to number fields (`int`, `float`, `Decimal`) and some apply only to `str`.
Note:
- Any `_Unset` objects will be replaced by the corresponding value defined in the `_DefaultValues` dictionary. If a key for the `_Unset` object is not found in the `_DefaultValues` dictionary, it will default to `None`
Args:
default: Default value if the field is not set.
default_factory: A callable to generate the default value. The callable can either take 0 arguments
(in which case it is called as is) or a single argument containing the already validated data.
alias: The name to use for the attribute when validating or serializing by alias.
This is often used for things like converting between snake and camel case.
alias_priority: Priority of the alias. This affects whether an alias generator is used.
validation_alias: Like `alias`, but only affects validation, not serialization.
serialization_alias: Like `alias`, but only affects serialization, not validation.
title: Human-readable title.
field_title_generator: A callable that takes a field name and returns title for it.
description: Human-readable description.
examples: Example values for this field.
exclude: Whether to exclude the field from the model serialization.
discriminator: Field name or Discriminator for discriminating the type in a tagged union.
deprecated: A deprecation message, an instance of `warnings.deprecated` or the `typing_extensions.deprecated` backport,
or a boolean. If `True`, a default deprecation message will be emitted when accessing the field.
json_schema_extra: A dict or callable to provide extra JSON schema properties.
frozen: Whether the field is frozen. If true, attempts to change the value on an instance will raise an error.
validate_default: If `True`, apply validation to the default value every time you create an instance.
Otherwise, for performance reasons, the default value of the field is trusted and not validated.
repr: A boolean indicating whether to include the field in the `__repr__` output.
init: Whether the field should be included in the constructor of the dataclass.
(Only applies to dataclasses.)
init_var: Whether the field should _only_ be included in the constructor of the dataclass.
(Only applies to dataclasses.)
kw_only: Whether the field should be a keyword-only argument in the constructor of the dataclass.
(Only applies to dataclasses.)
coerce_numbers_to_str: Whether to enable coercion of any `Number` type to `str` (not applicable in `strict` mode).
strict: If `True`, strict validation is applied to the field.
See [Strict Mode](../concepts/strict_mode.md) for details.
gt: Greater than. If set, value must be greater than this. Only applicable to numbers.
ge: Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers.
lt: Less than. If set, value must be less than this. Only applicable to numbers.
le: Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers.
multiple_of: Value must be a multiple of this. Only applicable to numbers.
min_length: Minimum length for iterables.
max_length: Maximum length for iterables.
pattern: Pattern for strings (a regular expression).
allow_inf_nan: Allow `inf`, `-inf`, `nan`. Only applicable to float and [`Decimal`][decimal.Decimal] numbers.
max_digits: Maximum number of allow digits for strings.
decimal_places: Maximum number of decimal places allowed for numbers.
union_mode: The strategy to apply when validating a union. Can be `smart` (the default), or `left_to_right`.
See [Union Mode](../concepts/unions.md#union-modes) for details.
fail_fast: If `True`, validation will stop on the first error. If `False`, all validation errors will be collected.
This option can be applied only to iterable types (list, tuple, set, and frozenset).
extra: (Deprecated) Extra fields that will be included in the JSON schema.
!!! warning Deprecated
The `extra` kwargs is deprecated. Use `json_schema_extra` instead.
Returns:
A new [`FieldInfo`][pydantic.fields.FieldInfo]. The return annotation is `Any` so `Field` can be used on
type-annotated fields without causing a type error.
�constNz)`const` is removed, use `Literal` insteadzremoved-kwargsr� � min_itemszG`min_items` is deprecated and will be removed, use `min_length` instead� max_itemszG`max_items` is deprecated and will be removed, use `max_length` instead� unique_itemsz`unique_items` is removed, use `Set` instead(this feature is discussed in https://github.com/pydantic/pydantic-core/issues/296)�allow_mutationzH`allow_mutation` is deprecated and will be removed. use `frozen` insteadFT�regexz)`regex` is removed. use `pattern` insteadzzUsing extra keyword arguments on `Field` is deprecated and will be removed. Use `json_schema_extra` instead. (Extra keys: z, c s s � | ]}|� � V qd S r� )�__repr__)r� r� rn rn ro r� 7 r� zField.<locals>.<genexpr>�)zSInvalid `validation_alias` type. it should be `str`, `AliasChoices`, or `AliasPath`�includezS`include` is deprecated and does nothing. It will be removed, use `exclude` insteadr7 r9 r; r= r> r? rA rB rD rF r[ r r^ r_ rU r` rb rc rd re rf rQ rH rJ rL rN rP rR rS rV rW rX rY rg )r� r) r �DeprecationWarningr/ �join�keysr� r� r% r& r� rs r� )+rr r7 r9 r; r= r> r? rA rB rD rF r[ r r^ r_ r` rb rc rd re rU rQ rf rH rJ rL rN rP rV rW rX rR rS rY rg r� r� r� r� r r r r rn rn ro r � s� j
�
�� ���
�������� �
� � �
��������������� � � � � �!�"�#�c @ sV e Zd ZdZdZefdd�d d d �Zejsd dd�Z d dd�Z
d dd�Z d dd�Z dS )!�ModelPrivateAttra� A descriptor for private attributes in class models.
!!! warning
You generally shouldn't be creating `ModelPrivateAttr` instances directly, instead use
`pydantic.fields.PrivateAttr`. (This is similar to `FieldInfo` vs. `Field`.)
Attributes:
default: The default value of the attribute if not provided.
default_factory: A callable function that generates the default value of the
attribute if not provided.
)rr r7 N�r7 rr r r7 � typing.Callable[[], Any] | Noner~ r c C s |t u rt| _n|| _|| _d S r� )r� r rr r7 )r� rr r7 rn rn ro r� � s
zModelPrivateAttr.__init__�itemr� c C s8 |dv rt | j|�rt| j|�S tt| �j�d|����)z�This function improves compatibility with custom descriptors by ensuring delegation happens
as expected when the default value of a private attribute is a descriptor.
> �__get__�
__delete__�__set__z object has no attribute N)�hasattrrr r� �AttributeErrorr� ri )r� r rn rn ro � __getattr__� s z ModelPrivateAttr.__getattr__�clsr� �namec C s8 | j }|tu r dS t|dd�}t|�r|||� dS dS )zMPreserve `__set_name__` protocol defined in https://peps.python.org/pep-0487.N� __set_name__)rr r r� r� )r� r r rr �set_namern rn ro r � s �z ModelPrivateAttr.__set_name__c C s | j du r t�| j�S | � � S )aU Retrieve the default value of the object.
If `self.default_factory` is `None`, the method will return a deep copy of the `self.default` object.
If `self.default_factory` is not `None`, it will call `self.default_factory` and return the value returned.
Returns:
The default value of the object.
N)r7 r" r� rr r� rn rn ro r� � s
z ModelPrivateAttr.get_default�otherra c C s$ t || j�o| j| jf|j|jfkS r� )r� � __class__rr r7 )r� r rn rn ro �__eq__� s �zModelPrivateAttr.__eq__)rr r r7 r r~ r )r r� r~ r )r r� r r� r~ r r� )r r r~ ra )
ri rj rk rl r� r r� �typing�
TYPE_CHECKINGr r r� r rn rn rn ro r y s ��
r �rc r� c C r� r� rn )rr rc rn rn ro r- � � r- �Callable[[], _T]c C r� r� rn �r7 rc rn rn ro r- � r c C r� r� rn r rn rn ro r- � s r �Callable[[], Any] | Nonec C s$ | t ur |dur td��t| |d�S )a� !!! abstract "Usage Documentation"
[Private Model Attributes](../concepts/models.md#private-model-attributes)
Indicates that an attribute is intended for private use and not handled during normal validation/serialization.
Private attributes are not validated by Pydantic, so it's up to you to ensure they are used in a type-safe manner.
Private attributes are stored in `__private_attributes__` on the model.
Args:
default: The attribute's default value. Defaults to Undefined.
default_factory: Callable that will be
called when a default value is needed for this attribute.
If both `default` and `default_factory` are set, an error will be raised.
init: Whether the attribute should be included in the constructor of the dataclass. Always `False`.
Returns:
An instance of [`ModelPrivateAttr`][pydantic.fields.ModelPrivateAttr] class.
Raises:
ValueError: If both `default` and `default_factory` are set.
Nr� r
)r r� r )rr r7 rc rn rn ro r- � s �c @ s� e Zd ZU dZdZded< ded< ded< d ed
< d ed < d ed
< ded< d ed< ded< ded< ded< ded< ed dd��Zd S ) �ComputedFieldInfoa4 A container for data from `@computed_field` so that we can access it while building the pydantic-core schema.
Attributes:
decorator_repr: A class variable representing the decorator string, '@computed_field'.
wrapped_property: The wrapped computed field property.
return_type: The type of the computed field property's return value.
alias: The alias of the property to be used during serialization.
alias_priority: The priority of the alias. This affects whether an alias generator is used.
title: Title of the computed field to include in the serialization JSON schema.
field_title_generator: A callable that takes a field name and returns title for it.
description: Description of the computed field to include in the serialization JSON schema.
deprecated: A deprecation message, an instance of `warnings.deprecated` or the `typing_extensions.deprecated` backport,
or a boolean. If `True`, a default deprecation message will be emitted when accessing the field.
examples: Example values of the computed field to include in the serialization JSON schema.
json_schema_extra: A dict or callable to provide extra JSON schema properties.
repr: A boolean indicating whether to include the field in the __repr__ output.
z@computed_fieldz
ClassVar[str]�decorator_reprr� Zwrapped_propertyr � return_typer8 r9 r: r; r? �5typing.Callable[[str, ComputedFieldInfo], str] | NonerA rB r\ r rC rD �3JsonDict | typing.Callable[[JsonDict], None] | Noner^ ra rb r~ c C r� r� r� r� rn rn ro r� r� z%ComputedFieldInfo.deprecation_messageNr� )ri rj rk rl r" rm r� r� rn rn rn ro r! � s
r! � property_�cached_property | propertyc C sL d}t | t�rt| jdd�}n t | t�rt| jdd�}|�d�o%|�d� S )z>Returns true if provided property is private, False otherwise.� ri r� �__N)r� r� r� �fgetr �func�
startswith)r& Z wrapped_namern rn ro � _wrapped_property_is_private s
r- � PropertyTr+ c C r� r� rn )r+ rn rn ro r. - r� r. �
r9 r; r? rA rB r rD r^ rb r# r$ r% r# �'typing.Callable[[PropertyT], PropertyT]c
C r� r� rn r/ rn rn ro r. 1 s
�PropertyT | None�3PropertyT | typing.Callable[[PropertyT], PropertyT]c
s4 d� ��������� f
dd� } | du r| S | | �S )a� !!! abstract "Usage Documentation"
[The `computed_field` decorator](../concepts/fields.md#the-computed_field-decorator)
Decorator to include `property` and `cached_property` when serializing models or dataclasses.
This is useful for fields that are computed from other fields, or for fields that are expensive to compute and should be cached.
```python
from pydantic import BaseModel, computed_field
class Rectangle(BaseModel):
width: int
length: int
@computed_field
@property
def area(self) -> int:
return self.width * self.length
print(Rectangle(width=3, length=2).model_dump())
#> {'width': 3, 'length': 2, 'area': 6}
```
If applied to functions not yet decorated with `@property` or `@cached_property`, the function is
automatically wrapped with `property`. Although this is more concise, you will lose IntelliSense in your IDE,
and confuse static type checkers, thus explicit use of `@property` is recommended.
!!! warning "Mypy Warning"
Even with the `@property` or `@cached_property` applied to your function before `@computed_field`,
mypy may throw a `Decorated property not supported` error.
See [mypy issue #1362](https://github.com/python/mypy/issues/1362), for more information.
To avoid this error message, add `# type: ignore[prop-decorator]` to the `@computed_field` line.
[pyright](https://github.com/microsoft/pyright) supports `@computed_field` without error.
```python
import random
from pydantic import BaseModel, computed_field
class Square(BaseModel):
width: float
@computed_field
def area(self) -> float: # converted to a `property` by `computed_field`
return round(self.width**2, 2)
@area.setter
def area(self, new_area: float) -> None:
self.width = new_area**0.5
@computed_field(alias='the magic number', repr=False)
def random_number(self) -> int:
return random.randint(0, 1_000)
square = Square(width=1.3)
# `random_number` does not appear in representation
print(repr(square))
#> Square(width=1.3, area=1.69)
print(square.random_number)
#> 3
square.area = 4
print(square.model_dump_json(by_alias=True))
#> {"width":2.0,"area":4.0,"the magic number":3}
```
!!! warning "Overriding with `computed_field`"
You can't override a field from a parent class with a `computed_field` in the child class.
`mypy` complains about this behavior if allowed, and `dataclasses` doesn't allow this pattern either.
See the example below:
```python
from pydantic import BaseModel, computed_field
class Parent(BaseModel):
a: str
try:
class Child(Parent):
@computed_field
@property
def a(self) -> str:
return 'new a'
except TypeError as e:
print(e)
'''
Field 'a' of class 'Child' overrides symbol of same name in a parent class. This override with a computed_field is incompatible.
'''
```
Private properties decorated with `@computed_field` have `repr=False` by default.
```python
from functools import cached_property
from pydantic import BaseModel, computed_field
class Model(BaseModel):
foo: int
@computed_field
@cached_property
def _private_cached_property(self) -> int:
return -self.foo
@computed_field
@property
def _private_property(self) -> int:
return -self.foo
m = Model(foo=1)
print(repr(m))
#> Model(foo=1)
```
Args:
func: the function to wrap.
alias: alias to use when serializing this computed field, only used when `by_alias=True`
alias_priority: priority of the alias. This affects whether an alias generator is used
title: Title to use when including this computed field in JSON Schema
field_title_generator: A callable that takes a field name and returns title for it.
description: Description to use when including this computed field in JSON Schema, defaults to the function's
docstring
deprecated: A deprecation message (or an instance of `warnings.deprecated` or the `typing_extensions.deprecated` backport).
to be emitted when accessing the field. Or a boolean. This will automatically be set if the property is decorated with the
`deprecated` decorator.
examples: Example values to use when including this computed field in JSON Schema
json_schema_extra: A dict or callable to provide extra JSON schema properties.
repr: whether to include this computed field in model repr.
Default is `False` for private properties and `True` for public properties.
return_type: optional return for serialization logic to expect when serializing to JSON, if included
this must be correct, otherwise a `TypeError` is raised.
If you don't include a return type Any is used, which does runtime introspection to handle arbitrary
objects.
Returns:
A proxy wrapper for the property.
�fr r~ c s� t �| �}�d u r|jrt�|j���d u r t|d�r |j�t �| �} � d ur+�p*dnd ��d u r8t| d� }n�}t | �� �� �����|� }t �
| |�S )N�__deprecated__r� )r& ) r Zunwrap_wrapped_functionrl �inspect�cleandocr r4 Zensure_propertyr- r! ZPydanticDescriptorProxy)r3 Z unwrapped�repr_Zdec_info�
r9 r; r rB rD rA r^ rb r# r? rn ro �dec� s4
� �
zcomputed_field.<locals>.decN)r3 r r~ r rn ) r+ r9 r; r? rA rB r rD r^ rb r# r9 rn r8 ro r. A s
!")Hrr r� r9 r8 r; r: r= r< r> r8 r? r8 rA r@ rB r8 rD rC rF rE r[ rZ r r\ r^ r] r_ rE r` rE rb ra rc rE rd rE re rE rU rT rQ rE rf rE rH rG rJ rI rL rK rN rM rP rO rV rE rW r: rX r: rR r: rS r: rY r� rg rE r� r� r~ r )Hrr r� r9 r8 r; r: r= r< r> r8 r? r8 rA r@ rB r8 rD rC rF rE r[ rZ r r\ r^ r] r_ rE r` rE rb ra rc rE rd rE re rE rU rT rQ rE rf rE rH rG rJ rI rL rK rN rM rP rO rV rE rW r: rX r: rR r: rS r: rY r� rg rE r� r� r~ r� )Hr7 r� r9 r8 r; r: r= r< r> r8 r? r8 rA r@ rB r8 rD rC rF rE r[ rZ r r\ r^ r] r_ rE r` rE rb ra rc rE rd rE re rE rU rT rQ rE rf rE rH rG rJ rI rL rK rN rM rP rO rV rE rW r: rX r: rR r: rS r: rY r� rg rE r� r� r~ r� )Fr9 r8 r; r: r= r< r> r8 r? r8 rA r@ rB r8 rD rC rF rE r[ rZ r r\ r^ r] r_ rE r` rE rb ra rc rE rd rE re rE rU rT rQ rE rf rE rH rG rJ rI rL rK rN rM rP rO rV rE rW r: rX r: rR r: rS r: rY r� rg rE r� r� r~ r )Jrr r r7 r6 r9 r8 r; r: r= r< r> r8 r? r8 rA r@ rB r8 rD rC rF rE r[ rZ r r\ r^ r] r_ rE r` rE rb ra rc rE rd rE re rE rU rT rQ rE rf rE rH rG rJ rI rL rK rN rM rP rO rV rE rW r: rX r: rR r: rS r: rY r� rg rE r� r� r~ r )rr r� rc r� r~ r� )r7 r rc r� r~ r� )rc r� r~ r )rr r r7 r rc r� r~ r rn )r& r' r~ ra )r+ r. r~ r. )r9 r8 r; r: r? r8 rA r$ rB r8 r r\ rD rC r^ r% rb ra r# r r~ r0 r� )r+ r1 r9 r8 r; r: r? r8 rA r$ rB r8 r r\ rD rC r^ r% rb rE r# r r~ r2 )^rl �
__future__r Z _annotationsr� r5 �sysr �collections.abcr r r ZDataclassField� functoolsr r r r r
r r r
r �warningsr r� Ztyping_extensionsZ
pydantic_corer r r r Ztyping_inspectionr Z typing_inspection.introspectionr r r r r r( r � _internalr r r r r r! r" Z_internal._namespace_utilsr# r$ �aliasesr% r& �configr' �errorsr( r) Z json_schemar* r+ r Z_internal._reprr, r �__all__r/ rm � version_infor2 � TypedDictr3 rq ZRepresentationrs r� r� r� r� � signature�
parametersr� �remover r- � dataclassZ
slots_truer! r- r. r. rn rn rn ro �<module> s� ( $
) �������� �
� � �
������#�&�&�&�&�� Q
B�����%
*
���