pyiFr%SrSSKJr SSKrSSKJrJr SSKJrJ r J r J r J r J r Jr SSKJrJr SSKJrJrJr SSKJr S S KJr S S KJrJr S S KJr S S KJ r \RB"S=0\RDDSS0D6"SS55r#\RB"S=0\RDDSS0D6"SS55r$\(a-Sr%S\&S'Sr'S\&S'Sr(S\&S'Sr)S\&S'\ "S\'S9r*\ "S\(S9r+\S S S S!.S>S"jj5r,\S S S S S#.S?S$jj5r,S%\S&SS#.S@S'jjr,\(ag\ \ \\ /\ 4r-S\&S('\ \ /\ 4r.S\&S)'S*r/S\&S+'\ \ \\\ /\ 4r0S\&S,'\ \ \/\ 4r1S\&S-'S.r2S\&S/'S0r3S\&S1'\ "S2\/S9r4\ "S3\2S9r5\SAS4j5r6\S&S S5.SBS6jj5r6\S S&S S7.SCS8jj5r6SDS%S&\S7.SES9jjjr6\ "S:5r7\(a\ \7S 4r8g\RB"S=0\RDD6"S;S<55r8g)FzEThis module contains related classes and functions for serialization.) annotationsN)partial partialmethod) TYPE_CHECKING AnnotatedAnyCallableLiteralTypeVaroverload)PydanticUndefined core_schema)SerializationInfoSerializerFunctionWrapHandlerWhenUsed) TypeAlias)PydanticUndefinedAnnotation) _decorators_internal_dataclass)GetCoreSchemaHandler)PydanticUserErrorfrozenTcJ\rSrSr%SrS\S'\rS\S'SrS\S 'S S jr S r g )PlainSerializeraPlain serializers use a function to modify the output of serialization. This is particularly helpful when you want to customize the serialization for annotated types. Consider an input of `list`, which will be serialized into a space-delimited string. ```python from typing import Annotated from pydantic import BaseModel, PlainSerializer CustomStr = Annotated[ list, PlainSerializer(lambda x: ' '.join(x), return_type=str) ] class StudentModel(BaseModel): courses: CustomStr student = StudentModel(courses=['Math', 'Chemistry', 'English']) print(student.model_dump()) #> {'courses': 'Math Chemistry English'} ``` Attributes: func: The serializer function. return_type: The return type for the function. If omitted it will be inferred from the type annotation. when_used: Determines when this serializer should be used. Accepts a string with values `'always'`, `'unless-none'`, `'json'`, and `'json-unless-none'`. Defaults to 'always'. zcore_schema.SerializerFunctionfuncr return_typealwaysr when_usedcU"U5nUR[La URnO8[R"URUR 5R S9nU[LaSOURU5n[R"UR[R"URS5UURS9US'U$![an[R"U5UeSnAff=f)zGets the Pydantic core schema. Args: source_type: The source type. handler: The `GetCoreSchemaHandler` instance. Returns: The Pydantic core schema. localnsNplainfunctioninfo_arg return_schemar serialization)rr rget_callable_return_typer_get_types_namespacelocals NameErrorrfrom_name_errorgenerate_schemar$plain_serializer_function_ser_schemainspect_annotated_serializerr self source_typehandlerschemarer(s \/home/mande/repo/quber/.venv/lib/python3.13/site-packages/pydantic/functional_serializers.py__get_pydantic_core_schema__,PlainSerializer.__get_pydantic_core_schema__6s%   #4 4**K L*BBII#88:AA !,/@ @gF]F]^iFj "-"R"RYY ==diiQ'nn #    L1AA!D!K L7C C2C--C2Nr4rr5rreturnzcore_schema.CoreSchema __name__ __module__ __qualname____firstlineno____doc____annotations__r rr r9__static_attributes__r<r8rrs(: )((K("Ix" rGrcJ\rSrSr%SrS\S'\rS\S'SrS\S 'S S jr S r g )WrapSerializerYa*Wrap serializers receive the raw inputs along with a handler function that applies the standard serialization logic, and can modify the resulting value before returning it as the final output of serialization. For example, here's a scenario in which a wrap serializer transforms timezones to UTC **and** utilizes the existing `datetime` serialization logic. ```python from datetime import datetime, timezone from typing import Annotated, Any from pydantic import BaseModel, WrapSerializer class EventDatetime(BaseModel): start: datetime end: datetime def convert_to_utc(value: Any, handler, info) -> dict[str, datetime]: # Note that `handler` can actually help serialize the `value` for # further custom serialization in case it's a subclass. partial_result = handler(value, info) if info.mode == 'json': return { k: datetime.fromisoformat(v).astimezone(timezone.utc) for k, v in partial_result.items() } return {k: v.astimezone(timezone.utc) for k, v in partial_result.items()} UTCEventDatetime = Annotated[EventDatetime, WrapSerializer(convert_to_utc)] class EventModel(BaseModel): event_datetime: UTCEventDatetime dt = EventDatetime( start='2024-01-01T07:00:00-08:00', end='2024-01-03T20:00:00+06:00' ) event = EventModel(event_datetime=dt) print(event.model_dump()) ''' { 'event_datetime': { 'start': datetime.datetime( 2024, 1, 1, 15, 0, tzinfo=datetime.timezone.utc ), 'end': datetime.datetime( 2024, 1, 3, 14, 0, tzinfo=datetime.timezone.utc ), } } ''' print(event.model_dump_json()) ''' {"event_datetime":{"start":"2024-01-01T15:00:00Z","end":"2024-01-03T14:00:00Z"}} ''' ``` Attributes: func: The serializer function to be wrapped. return_type: The return type for the function. If omitted it will be inferred from the type annotation. when_used: Determines when this serializer should be used. Accepts a string with values `'always'`, `'unless-none'`, `'json'`, and `'json-unless-none'`. Defaults to 'always'. z"core_schema.WrapSerializerFunctionrrrrrr cU"U5nUR[La URnO8[R"URUR 5R S9nU[LaSOURU5n[R"UR[R"URS5UURS9US'U$![an[R"U5UeSnAff=f)zThis method is used to get the Pydantic core schema of the class. Args: source_type: Source type. handler: Core schema handler. Returns: The generated core schema of the class. r"Nwrapr%r))rr rr*rr+r,r-rr.r/r#wrap_serializer_function_ser_schemar1r r2s r8r9+WrapSerializer.__get_pydantic_core_schema__s%   #4 4**K L*BBII#88:AA !,/@ @gF]F]^iFj "-"Q"QYY ==diiP'nn #    L1AA!D!K Lr;r<Nr=r?r<rGr8rIrIYs)<| -,(K("Ix" rGrIz!partial[Any] | partialmethod[Any]r_Partialz)core_schema.SerializerFunction | _PartialFieldPlainSerializerz-core_schema.WrapSerializerFunction | _PartialFieldWrapSerializerz*FieldPlainSerializer | FieldWrapSerializerFieldSerializer_FieldPlainSerializerT)bound_FieldWrapSerializerT.)rr check_fieldscgNr<fieldmoderr rVfieldss r8field_serializerr]s @CrG)r[rr rVcgrXr<rYs r8r]r]s BErGr$rc^^^^^[U5(d[U[5(a [SSS9eU/TQ7m[ ST55(d [SSS9eSUUUUU4SjjnU$) a5Decorator that enables custom field serialization. In the below example, a field of type `set` is used to mitigate duplication. A `field_serializer` is used to serialize the data as a sorted list. ```python from pydantic import BaseModel, field_serializer class StudentModel(BaseModel): name: str = 'Jane' courses: set[str] @field_serializer('courses', when_used='json') def serialize_courses_in_order(self, courses: set[str]): return sorted(courses) student = StudentModel(courses={'Math', 'Chemistry', 'English'}) print(student.model_dump_json()) #> {"name":"Jane","courses":["Chemistry","English","Math"]} ``` See [the usage documentation](../concepts/serialization.md#serializers) for more information. Four signatures are supported for the decorated serializer: - `(self, value: Any, info: FieldSerializationInfo)` - `(self, value: Any, nxt: SerializerFunctionWrapHandler, info: FieldSerializationInfo)` - `(value: Any, info: SerializationInfo)` - `(value: Any, nxt: SerializerFunctionWrapHandler, info: SerializationInfo)` Args: *fields: The field names the serializer should apply to. mode: The serialization mode. - `plain` means the function will be called instead of the default serialization logic, - `wrap` means the function will be called with an argument to optionally call the default serialization logic. return_type: Optional return type for the function, if omitted it will be inferred from the type annotation. when_used: Determines the serializer will be used for serialization. check_fields: Whether to check that the fields actually exist on the model. Raises: PydanticUserError: - If the decorator is used without any arguments (at least one field name must be provided). - If the provided field names are not strings. zThe `@field_serializer` decorator cannot be used without arguments, at least one field must be provided. For example: `@field_serializer('', ...)`.zdecorator-missing-arguments)codec3B# UHn[U[5v M g7frX) isinstancestr).0rZs r8 #field_serializer..*s:6%z%%%6szThe provided field names to the `@field_serializer` decorator should be strings. For example: `@field_serializer('', '', ...).`zdecorator-invalid-fieldsc`>[R"TTTTTS9n[R"X5$)N)r\r[rr rV)rFieldSerializerDecoratorInfoPydanticDescriptorProxy)fdec_inforVr\r[rr s r8decfield_serializer..dec1s5;;#%  221??rG)rjrRr>(_decorators.PydanticDescriptorProxy[Any])callablerb classmethodrall)rZr[rr rVr\rls ````` r8r]r]sxt*UK88 E.  ^V^F :6: : : Y+  @@ JrGModelPlainSerializerWithInfoModelPlainSerializerWithoutInfoz>ModelPlainSerializerWithInfo | ModelPlainSerializerWithoutInfoModelPlainSerializerModelWrapSerializerWithInfoModelWrapSerializerWithoutInfoz {'unit': 'C', 'value': 100} ``` Two signatures are supported for `mode='plain'`, which is the default: - `(self)` - `(self, info: SerializationInfo)` And two other signatures for `mode='wrap'`: - `(self, nxt: SerializerFunctionWrapHandler)` - `(self, nxt: SerializerFunctionWrapHandler, info: SerializationInfo)` See [the usage documentation](../concepts/serialization.md#serializers) for more information. Args: f: The function to be decorated. mode: The serialization mode. - `'plain'` means the function will be called instead of the default serialization logic - `'wrap'` means the function will be called with an argument to optionally call the default serialization logic. when_used: Determines when this serializer should be used. return_type: The return type for the function. If omitted it will be inferred from the type annotation. Returns: The decorator function. c\>[R"TTTS9n[R"X5$)N)r[rr )rModelSerializerDecoratorInfori)rjrkr[rr s r8rlmodel_serializer..decs*;;S^jst221??rG)rjrxr>rnr<)rjr[r rrls ``` r8r|r|ls%@@@ y 1v rGAnyTypecP\rSrSrSrSSjrSSjr\RrSr g) SerializeAsAnyizAnnotation used to mark a type as having duck-typing serialization behavior. See [usage documentation](../concepts/serialization.md#serializing-with-duck-typing) for more details. c([U[54$rX)rr)clsitems r8__class_getitem__ SerializeAsAny.__class_getitem__sT>#334 4rGcU"U5nUnUSS:Xa UR5nUSnUSS:XaM [R"S5US'U$)Ntype definitionsr6anyr))copyrsimple_ser_schema)r3r4r5r6schema_to_updates r8r9+SerializeAsAny.__get_pydantic_core_schema__sg[)F% "6*m;#3#8#8#: #3H#= #6*m;1<0M0Me0T _ -MrGr<N)rrr>rr=) r@rArBrCrDrr9object__hash__rFr<rGr8rrs4  5 " -A  # ??rGrr<)rZrcr\rcr[Literal['wrap']rrr rrV bool | Noner>z8Callable[[_FieldWrapSerializerT], _FieldWrapSerializerT])rZrcr\rcr[Literal['plain']rrr rrVrr>z:Callable[[_FieldPlainSerializerT], _FieldPlainSerializerT])rZrcr\rcr[Literal['plain', 'wrap']rrr rrVrr>zuCallable[[_FieldWrapSerializerT], _FieldWrapSerializerT] | Callable[[_FieldPlainSerializerT], _FieldPlainSerializerT])rjryr>ry)r[rr rrrr>z8Callable[[_ModelWrapSerializerT], _ModelWrapSerializerT])r[rr rrrr>z:Callable[[_ModelPlainSerializerT], _ModelPlainSerializerT]rX) rjz5_ModelPlainSerializerT | _ModelWrapSerializerT | Noner[rr rrrr>z_ModelPlainSerializerT | Callable[[_ModelWrapSerializerT], _ModelWrapSerializerT] | Callable[[_ModelPlainSerializerT], _ModelPlainSerializerT])9rD __future__r dataclasses functoolsrrtypingrrrr r r r pydantic_corer rpydantic_core.core_schemarrrtyping_extensionsrr _internalrrannotated_handlersrerrorsr dataclass slots_truerrIrOrErPrQrRrSrUr]rrrsrtrurvrwrxryrzr|rrr<rGr8rsGK",VVV8``')74% E,77EEBBFBJ E,77EEccFcL=Hi=&Q)Q@%TT?!MOYM0$%=EYZ#$;CVW  #C CC  C  C  CC>C C ! #E EE  E  E  EE@E E&-(" $S SS # S  SSSASl/7=Ns=S7TVY7Y.Z )ZN193%*1E#YEQ&f)f4-5s