j FUdZddlmZddlZddlmZddlmZmZddl m Z m Z m Z m Z mZmZmZddlmZmZddlmZmZmZdd lmZd d lmZd d lmZd d lmZd dl m!Z!ej"ddGddZ#ej"ddGddZ$e r9dZ%de&d<dZ'de&d< dZ(de&d< dZ)de&d< ede'Z*ed e(Z+ed!d!d!d"dUd0Z,ed!d!d!d!d1dVd4Z,d5ed6dd1dWd9Z,e ree ee ge fZ-de&d:< ee ge fZ.de&d;< d< ee ege fZ1de&d?< d@Z2de&dA< dBZ3de&dC<edDe/Z4edEe2Z5edXdGZ6ed6d!dHdYdJZ6ed!d6d!dKdZdMZ6 d[d5d6edKd\dPZ6edQZ7e r e e7d!fZ8dSej"dRGdSdTZ8dS)]zEThis module contains related classes and functions for serialization.) annotationsN)Callable)partial partialmethod) TYPE_CHECKING AnnotatedAnyLiteral TypeAliasTypeVaroverload)PydanticUndefined core_schema)SerializationInfoSerializerFunctionWrapHandlerWhenUsed)TypeForm)PydanticUndefinedAnnotation) _decorators)GetCoreSchemaHandler)PydanticUserErrorT)slotsfrozencBeZdZUdZded<eZded<dZded<ddZdS)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.SerializerFunctionfunc TypeForm[Any] return_typealwaysr when_used source_typer handlerrreturncore_schema.CoreSchemac||}|jtur|j}n[ tj|j|j}n'#t$r}tj ||d}~wwxYw|turdn| |}tj |jtj |jd||j|d<|S)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)rrrget_callable_return_typer_get_types_namespacelocals NameErrorrfrom_name_errorgenerate_schemar$plain_serializer_function_ser_schemainspect_annotated_serializerr!selfr"r#schemarer-s OC:\Projects\Muse2API\.venv\Lib\site-packages\pydantic/functional_serializers.py__get_pydantic_core_schema__z,PlainSerializer.__get_pydantic_core_schema__7s%%  #4 4 4*KK L*BI#88::A  L L L1A!DD!K L!,/@ @ @gF]F]^iFjFj "-"RY =diQQ'n # # #   2A A: A55A:Nr"r r#rr$r% __name__ __module__ __qualname____doc____annotations__rrr!r<r;rrsd:)(((!2K2222"I""""      rFrcBeZdZUdZded<eZded<dZded<ddZdS)WrapSerializeraWrap 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, SerializationInfo, SerializerFunctionWrapHandler, WrapSerializer, ) def convert_to_utc( value: Any, handler: SerializerFunctionWrapHandler, info: SerializationInfo ): # Note that `handler` can actually help serialize the `value` for # further custom serialization in case it's a subclass. serialized = handler(value) if info.mode == 'json': return datetime.fromisoformat(serialized).astimezone(timezone.utc) else: return serialized.astimezone(timezone.utc) UTCDatetime = Annotated[datetime, WrapSerializer(convert_to_utc)] class EventModel(BaseModel): event_datetime: UTCDatetime event = EventModel(event_datetime='2024-01-01T07:00:00-08:00') print(event.model_dump()) ''' { 'event_datetime': datetime.datetime( 2024, 1, 1, 15, 0, tzinfo=datetime.timezone.utc ) } ''' print(event.model_dump_json()) #> {"event_datetime":"2024-01-01T15: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.WrapSerializerFunctionrrrr rr!r"r r#rr$r%c||}|jtur|j}n[ tj|j|j}n'#t$r}tj ||d}~wwxYw|turdn| |}tj |jtj |jd||j|d<|S)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.)rrrr/rr0r1r2rr3r4r#wrap_serializer_function_ser_schemar6r!r7s r;r<z+WrapSerializer.__get_pydantic_core_schema__s%%  #4 4 4*KK L*BI#88::A  L L L1A!DD!K L!,/@ @ @gF]F]^iFjFj "-"QY =diPP'n # # #   r=Nr>r?rErFr;rHrHZse33j-,,,!2K2222"I""""      rFrHz!partial[Any] | partialmethod[Any]r _Partialz)core_schema.SerializerFunction | _PartialFieldPlainSerializerz-core_schema.WrapSerializerFunction | _PartialFieldWrapSerializerz*FieldPlainSerializer | FieldWrapSerializerFieldSerializer_FieldPlainSerializerT)bound_FieldWrapSerializerT.)rr! check_fieldsfieldstrfieldsmodeLiteral['wrap']rrr!rrS bool | Noner$8Callable[[_FieldWrapSerializerT], _FieldWrapSerializerT]cdSNrErTrWrr!rSrVs r;field_serializerr^s @CsrF)rWrr!rSLiteral['plain']:Callable[[_FieldPlainSerializerT], _FieldPlainSerializerT]cdSr\rEr]s r;r^r^s BErFr)r Literal['plain', 'wrap']uCallable[[_FieldWrapSerializerT], _FieldWrapSerializerT] | Callable[[_FieldPlainSerializerT], _FieldPlainSerializerT]ct|st|trtdd|gRt dDstddd fd }|S) aDecorator 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)codec3@K|]}t|tVdSr\) isinstancerU).0rTs r; z#field_serializer..!s,::%z%%%::::::rFzThe provided field names to the `@field_serializer` decorator should be strings. For example: `@field_serializer('', '', ...).`zdecorator-invalid-fieldsfrOr$(_decorators.PydanticDescriptorProxy[Any]c`tj}tj||S)N)rVrWrr!rS)rFieldSerializerDecoratorInfoPydanticDescriptorProxy)rjdec_inforSrVrWrr!s r;deczfield_serializer..dec(s>;#%    21h???rF)rjrOr$rk)callablerg classmethodrall)rTrWrr!rSrVrps ````` r;r^r^sr *UK88  E.    ^V^^F ::6::: : :  Y+    @@@@@@@@@@ JrFModelPlainSerializerWithInfoModelPlainSerializerWithoutInfoz>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. rjrzr$rkc\tj}tj||S)N)rWrr!)rModelSerializerDecoratorInforn)rjrorWrr!s r;rpzmodel_serializer..decs/;S^jsttt21h???rFN)rjrzr$rkrE)rjrWr!rrps ``` r;r~r~csO@@@@@@@@@ y s1vv rFAnyType)rc0eZdZdZd dZd d ZejZd S)SerializeAsAnyzAnnotation used to mark a type as having duck-typing serialization behavior. See [usage documentation](../concepts/serialization.md#serializing-with-duck-typing) for more details. itemr r$c8t|tfSr\)rr)clsrs r;__class_getitem__z SerializeAsAny.__class_getitem__sT>#3#334 4rFr"r#rr%c||}|}|ddkr(|}|d}|ddk(tjd|d<|S)Ntype definitionsr9anyr.)copyrsimple_ser_schema)r8r"r#r9schema_to_updates r;r<z+SerializeAsAny.__get_pydantic_core_schema__suW[))F% "6*m;;#3#8#8#:#: #3H#= #6*m;;1<0Me0T0T _ -MrFN)rr r$r r>)r@rArBrCrr<object__hash__rErFr;rrsI   5 5 5 5    ?rFr)rTrUrVrUrWrXrrr!rrSrYr$rZ)rTrUrVrUrWr_rrr!rrSrYr$r`)rTrUrVrUrWrbrrr!rrSrYr$rc)rjr{r$r{)rWrXr!rrrr$r)rWr_r!rrrr$rr\) rjrrWrbr!rrrr$r)9rC __future__r dataclassescollections.abcr functoolsrrtypingrrr r r r r pydantic_corerrpydantic_core.core_schemarrrtyping_extensionsrr _internalrannotated_handlersrerrorsr dataclassrrHrLrDrMrNrOrPrRr^rtrurvrwrxryrzr{r|r~rrrErFr;rsNKKK""""""$$$$$$,,,,,,,,WWWWWWWWWWWWWWWWWW88888888``````````&&&&&&))))))""""""444444%%%%%%T$///BBBBBBB0/BJT$///ZZZZZZZ0/Zz X=H====&QQQQQ@%TTTTT?!MOMMMM0$W%=EYZZZ#G$;CVWWW "% #CCCCC C !!$ #EEEEE E&-!2" $RRRRRRjX/7=Ns=S7TVY7Y.Z ZZZZN193%*1E#EEEEQ&fffff4-5s