<%iu)NddlZddlZddlmZmZmZmZmZmZm Z m Z m Z ddl m Z ejdk\r ddlmZmZnddlmZmZddlmZmZddlmZmZddlmZdd lmZmZmZmZmZdd l m!Z!m"Z"e ee efZ#e ee efZ$e ee efZ%ed Z&e e'e fZ(ee'efZ)ed Z*Gd deZ+GddZ,Gdde,Z-Gdde,Z.Gdde,Z/Gdde,Z0e dedefZ1Gdde,Z2Gdde,Z3ddeeddddddddddddddfd ee'd!eee e.e$fd"ed#ed$eee'd%ee(d&ee(d'ee4d(eee'd)ee4d*ee4d+ee)d,eee'd-eee'd.eee-d/eee'efd0eee2d1ee ee'e'fe'fd2ee1ge1ff&d3Z5 d?d4e e$e%e!e)e"fd5ee'd2ee1ge1ffd6Z6 d@d7ee4d8eee'd9eee'd.eee-d/eee'efd5ee'd%ee(d2ee1ge1ffd:Z7d2ee1ge1ffd;Z8dZ9y)AN) AnyCallableDictOptionalSequenceTupleTypeTypeVarUnion)Promise))FinalLiteral)Fieldempty)ListSerializer Serializer) api_settings)errorget_view_method_namesisolate_view_method set_overridewarn) OpenApiTypes_KnownPythonTypes)querypathheadercookie)requestresponsec eZdZdZ ddedeeeeeefe geefe geeefffde ede e ffd Z fdZ edZej d Zed Zd Zd Zd ZxZS)PolymorphicProxySerializera This class is to be used with :func:`@extend_schema <.extend_schema>` to signal a request/response might be polymorphic (accepts/returns data possibly from different serializers). Usage usually looks like this: .. code-block:: @extend_schema( request=PolymorphicProxySerializer( component_name='MetaPerson', serializers=[ LegalPersonSerializer, NaturalPersonSerializer, ], resource_type_field_name='person_type', ) ) def create(self, request, *args, **kwargs): return Response(...) **Beware** that this is not a real serializer and it will raise an AssertionError if used in that way. It **cannot** be used in views as ``serializer_class`` or as field in an actual serializer. It is solely meant for annotation purposes. Also make sure that each sub-serializer has a field named after the value of ``resource_type_field_name`` (discriminator field). Generated clients will likely depend on the existence of this field. Setting ``resource_type_field_name`` to ``None`` will remove the discriminator altogether. This may be useful in certain situations, but will most likely break client generation. Another use-case is explicit control over sub-serializer's ``many`` attribute. To explicitly control this aspect, you need disable the discriminator with ``resource_type_field_name=None`` as well as disable automatic list handling with ``many=False``. It is **strongly** recommended to pass the ``Serializers`` as **list**, and by that let *drf-spectacular* retrieve the field and handle the mapping automatically. In special circumstances, the field may not available when *drf-spectacular* processes the serializer. In those cases you can explicitly state the mapping with ``{'legal': LegalPersonSerializer, ...}``, but it is then your responsibility to have a valid mapping. It is also permissible to provide a callable with no parameters for ``serializers``, such as a lambda that will return an appropriate list or dict when evaluated. component_name serializersresource_type_field_namemanyc ||_||_||_|jdur t |dd|j dij |||dt| di|y)NFr(contextr%r&r') r%r&r'_manyr setdefaultupdatesuper__init__)selfr%r&r'r(kwargs __class__s M/usr/local/footviz/venv/lib/python3.12/site-packages/drf_spectacular/utils.pyr1z#PolymorphicProxySerializer.__init__Lsp-&(@% ::  vu -)R(//,&(@1  "6"c|jdd}|durE|jdi}dD]}||vs|j|||<|j|i|}nt||g|i|}||_|S)Nr(Tr*r+)popget many_initr0__new__r-)clsargsr3r(r*arginstancer4s r5r;z"PolymorphicProxySerializer.__new__fszz&$' 4<jjB/GT 3'>")++c"2F3K 3%s}}d5f5Hws`_. rQUERYrPATHrHEADERr COOKIEFr`NTratypelocationrequiredrdenumpattern deprecatedstyleexplodedefault allow_blankr(examples extensionsexcluder"c||_||_||_||_||_||_||_||_| |_| |_ | |_ | |_ | |_ |xsg|_ ||_||_||_yrA)rartrurvrdrwrxryrzr{r|r}r(r~rrr")r2rartrurvrdrwrxryrzr{r|r}r(r~rrr"s r5r1zOpenApiParameter.__init__s(      &  $   &  B $   r6)rRrSrTrUrpr__annotations__rqrrrsrVr rWrr _SchemaTyperlrXrkrrrr_rrmr1r,r6r5rorosh E5D%FEFE Z]/4")+,0%)$#'&* $#';?37!?D%$!$!):L+UV$!- $!  $! ' $!8C=)$!c]$!$!C=$!d^$!$!$!4.$!x78$! !c3h0!$!"#$!$D(5c?";;<%$!r6roc 8eZdZdZ ddededeeefdZ y)OpenApiResponseam Helper class to bundle a response object (``Serializer``, ``OpenApiType``, raw schema, etc) together with a response object description and/or examples. Examples can alternatively be provided via :func:`@extend_schema <.extend_schema>`. This class is especially helpful for explicitly describing status codes on a "Response Object" level. Nr"rdr~c6||_||_|xsg|_yrA)r"rdr~)r2r"rdr~s r5r1zOpenApiResponse.__init__s ! & B r6)Nr`N) rRrSrTrUrrkrrr_r1r,r6r5rrs=!)+;? ''''x78 'r6rc ReZdZdZ ddedeeeeeeffdeee fdZ y)OpenApiRequestaf Helper class to combine a request object (``Serializer``, ``OpenApiType``, raw schema, etc.) together with an encoding object and/or examples. Examples can alternatively be provided via :func:`@extend_schema <.extend_schema>`. This class is especially helpful for customizing value encoding for ``application/x-www-form-urlencoded`` and ``multipart/*``. The encoding parameter takes a dictionary with field names as keys and encoding objects as values. Refer to the `specification `_ on how to build a valid encoding object. Nr!encodingr~c6||_||_|xsg|_yrA)r!rr~)r2r!rr~s r5r1zOpenApiRequest.__init__s     B r6)NNN) rRrSrTrUrrrrVrr_r1r,r6r5rrsT  <@;? ''tCc3h$789'x78 'r6rF.)boundc \eZdZdZdededeeegefe eeegeffe ee fffdZ y)OpenApiCallbacka Helper class to bundle a callback definition. This specifies a view on the callee's side, effectively stating the expectations on the receiving end. Please note that this particular :func:`@extend_schema <.extend_schema>` instance operates from the perspective of the callback origin, which means that ``request`` specifies the outgoing request. For convenience sake, we assume the callback sends ``application/json`` and return a ``200``. If that is not sufficient, you can use ``request`` and ``responses`` overloads just as you normally would. :param name: Name under which the this callback is listed in the schema. :param path: Path on which the callback operation is performed. To reference request body contents, please refer to OpenAPI specification's `key expressions `_ for valid choices. :param decorator: :func:`@extend_schema <.extend_schema>` decorator that specifies the receiving endpoint. In this special context the allowed parameters are ``requests``, ``responses``, ``summary``, ``description``, ``deprecated``. rar decoratorc.||_||_||_yrA)rarr)r2rarrs r5r1zOpenApiCallback.__init__4s   "r6N) rRrSrTrUrkrVr rrrrr1r,r6r5rr!s_$###Xqc1f-tC1#q&9I4I/JDQTVYQYNZ[ #r6rc XeZdZdZdedeeegefee eegeffee e fffdZ y)OpenApiWebhooka Helper class to document webhook definitions. A webhook specifies a possible out-of-band request initiated by the API provider and the expected responses from the consumer. Please note that this particular :func:`@extend_schema <.extend_schema>` instance operates from the perspective of the webhook origin, which means that ``request`` specifies the outgoing request. For convenience sake, we assume the API provider sends a POST request with a body of type ``application/json`` and the receiver responds with ``200`` if the event was successfully received. :param name: Name under which this webhook is listed in the schema. :param decorator: :func:`@extend_schema <.extend_schema>` decorator that specifies the receiving endpoint. In this special context the allowed parameters are ``requests``, ``responses``, ``summary``, ``description``, ``deprecated``. rarc ||_||_yrA)rar)r2rars r5r1zOpenApiWebhook.__init__Qs  "r6N) rRrSrTrUrkr rrrrVrr1r,r6r5rr?sU"##Xqc1f-tC1#q&9I4I/JDQTVYQYNZ[#r6r operation_id parametersr! responsesauthrdrcrytagsfiltersr operationmethodsversionsr~r callbacks external_docsreturnc   Dcgc]}|jc}    fd}|Scc}w)a3 Decorator mainly for the "view" method kind. Partially or completely overrides what would be otherwise generated by drf-spectacular. :param operation_id: replaces the auto-generated operation_id. make sure there are no naming collisions. :param parameters: list of additional or replacement parameters added to the auto-discovered fields. :param responses: replaces the discovered Serializer. Takes a variety of inputs that can be used individually or combined - ``Serializer`` class - ``Serializer`` instance (e.g. ``Serializer(many=True)`` for listings) - basic types or instances of ``OpenApiTypes`` - :class:`.OpenApiResponse` for bundling any of the other choices together with either a dedicated response description and/or examples. - :class:`.PolymorphicProxySerializer` for signaling that the operation may yield data from different serializers depending on the circumstances. - ``dict`` with status codes as keys and one of the above as values. Additionally in this case, it is also possible to provide a raw schema dict as value. - ``dict`` with tuples (status_code, media_type) as keys and one of the above as values. Additionally in this case, it is also possible to provide a raw schema dict as value. :param request: replaces the discovered ``Serializer``. Takes a variety of inputs - ``Serializer`` class/instance - basic types or instances of ``OpenApiTypes`` - :class:`.PolymorphicProxySerializer` for signaling that the operation accepts a set of different types of objects. - ``dict`` with media_type as keys and one of the above as values. Additionally, in this case, it is also possible to provide a raw schema dict as value. :param auth: replace discovered auth with explicit list of auth methods :param description: replaces discovered doc strings :param summary: an optional short summary of the description :param deprecated: mark operation as deprecated :param tags: override default list of tags :param filters: ignore list detection and forcefully enable/disable filter discovery :param exclude: set True to exclude operation from schema :param operation: manually override what auto-discovery would generate. you must provide a OpenAPI3-compliant dictionary that gets directly translated to YAML. :param methods: scope extend_schema to specific methods. matches all by default. :param versions: scope extend_schema to specific API version. matches all by default. :param examples: attach request/response examples to the operation :param extensions: specification extensions, e.g. ``x-badges``, ``x-code-samples``, etc. :param callbacks: associate callbacks with this endpoint :param external_docs: Link external documentation. Provide a dict with an "url" key and optionally a "description" key. For convenience, if only a string is given it is treated as the URL. :return: ct|ddxsYt|dijddxs:tt|dddijddxstj}t j |s |j }fdG fdd|}t j |rtd|jd| t|| D]Q}dtt||divrt||}td |jd|fi|jd<S||_ |St|ret|drYt!|j"dd|i|j"j$D]%}t!t|j"|dd|i'|St|r$t|dsi|_ ||jd<|S|S) Nschemar3r<c|jj|jjfi|jj\}}duxs|v}duxs|jv}|xr|SrA)viewdetermine_versionr!r3method) ext_schemaversion_ version_scope method_scoperrs r5 is_in_scopez5extend_schema..decorator..is_in_scopesv:::''//((JGQ%,C80CM"d?Jj.?.?7.JL1M 1r6ceZdZ fdZ fdZ fdZ fdZ fdZ fdZ fdZ fdZ  fd Z fd Z  fd Z fd Z fd Z fdZ fdZ fdZxZS)8extend_schema..decorator..ExtendedSchemacl|j|_ |rSt| |||||SrA)upperrr0 get_operation) r2r path_regex path_prefixrregistryr4rrs r5rzFextend_schema..decorator..ExtendedSchema.get_operations<$lln ([->$$w,T:{FT\]]r6c8 |rSt|SrA)r0 is_excluded)r2r4rrs r5rzDextend_schema..decorator..ExtendedSchema.is_excludeds#&;t+<"Nw*,,r6c8r |rSt|SrA)r0get_operation_id)r2r4rrs r5rzIextend_schema..decorator..ExtendedSchema.get_operation_ids!K$5''w/11r6cVr|rt|zSt|SrA)r0get_override_parameters)r2r4rrs r5rzPextend_schema..decorator..ExtendedSchema.get_override_parameterss.+d"3 7:.decorator..ExtendedSchema.get_auth## D(9Kw'))r6cVr|rt|zSt|SrA)r0 get_examples)r2r4r~rs r5rzEextend_schema..decorator..ExtendedSchema.get_exampless. D 1 7/1H<<w+--r6cDtur |rSt| SrA)rr0get_request_serializer)r2r4rr!s r5rzOextend_schema..decorator..ExtendedSchema.get_request_serializers%%'K,="Nw577r6cDtur |rSt| SrA)rr0get_response_serializers)r2r4rrs r5rzQextend_schema..decorator..ExtendedSchema.get_response_serializerss&E)k$.?$$w799r6c8r |rSt|SrA)r0get_description)r2r4rdrs r5rzHextend_schema..decorator..ExtendedSchema.get_descriptions!;t#4&&w.00r6cJr|r tSt| SrA)rVr0 get_summary)r2r4rrcs r5rzDextend_schema..decorator..ExtendedSchema.get_summarys%{40w<'w*,,r6c8r |rSt|SrA)r0 is_deprecated)r2r4ryrs r5rzFextend_schema..decorator..ExtendedSchema.is_deprecateds!+d"3%%w,..r6c8 |rSt|SrA)r0get_tags)r2r4rrs r5rzAextend_schema..decorator..ExtendedSchema.get_tagsrr6c8r |rSt|SrA)r0get_extensions)r2r4rrs r5rzGextend_schema..decorator..ExtendedSchema.get_extensionss!+d"3%%w-//r6cj#|rrt|jdgSgSt| S)Nfilter_backends)getattrrr0get_filter_backends)r2r4rrs r5rzLextend_schema..decorator..ExtendedSchema.get_filter_backendss:&;t+.decorator..ExtendedSchema.get_callbackss$([->$$w,..r6c8 |rSt|SrA)r0get_external_docs)r2r4rrs r5rzJextend_schema..decorator..ExtendedSchema.get_external_docs s$ ,T1B((w022r6)rRrSrTrrrrrrrrrrrrrrrrr[)r4rrryrdr~rrrrrrrrr!rrcrs@r5ExtendedSchemarsY ^ -  2  9  *  .  8  :  1  -  /  *  0  5  /  3 3r6rz&using @extend_schema on viewset class zV with parameters operation_id or operation will most likely result in a broken schema.delayed)rrExtendedMetaSchema)rr9rDEFAULT_SCHEMA_CLASSinspectisclassr4rrRrrrtr3rrBhasattrsetattrr<http_method_names)f BaseSchemarview_method_name view_methodrrrrryrdr~rrrrrrrrr!rrcrrs @r5rz extend_schema..decorators Ax & 1q(B'++Hd; 1wq%."=AA(DQ  1 00 z*#--J 2Q 3Q 3Q 3ZQ 3f ??1 '9+@8SSSj o9sA fieldr%cfd}|S)a} Decorator for the "field" kind. Can be used with ``SerializerMethodField`` (annotate the actual method) or with custom ``serializers.Field`` implementations. If your custom serializer field base class is already the desired type, decoration is not necessary. To override the discovered base class type, you can decorate your custom field class. Always takes precedence over other mechanisms (e.g. type hints, auto-discovery). :param field: accepts a ``Serializer``, :class:`~.types.OpenApiTypes` or raw ``dict`` :param component_name: signals that the field should be broken out as separate component c<t|dt|d|S)Nrfield_component_namer)rr%rs r5rz&extend_schema_field..decoratorNs!Q'Q.?r6r,)rr%rs`` r5extend_schema_fieldr=s" r6r(exclude_fieldsdeprecate_fieldsc*fd}|S)a` Decorator for the "serializer" kind. Intended for overriding default serializer behaviour that cannot be influenced through :func:`@extend_schema <.extend_schema>`. :param many: override how serializer is initialized. Mainly used to coerce the list view detection heuristic to acknowledge a non-list serializer. :param exclude_fields: fields to ignore while processing the serializer. only affects the schema. fields will still be exposed through the API. :param deprecate_fields: fields to mark as deprecated while processing the serializer. :param examples: define example data to serializer. :param extensions: specification extensions, e.g. ``x-is-dynamic``, etc. :param component_name: override default class name extraction. :param description: override the class docstring for component description c t|dr t|dr t|dr t|dr t|dr t|d t|d|S)Nr(rrr~rr%rdr)klassr%rrdr~rrr(s r5rz+extend_schema_serializer..decoratorms{    -   0. A   24D E   H 5   j 9   0. A  "  { ; r6r,)r(rrr~rr%rdrs``````` r5extend_schema_serializerrVs." r6c fd}|S)a Convenience decorator for the "view" kind. Intended for annotating derived view methods that are are not directly present in the view (usually methods like ``list`` or ``retrieve``). Spares you from overriding methods like ``list``, only to perform a super call in the body so that you have have something to attach :func:`@extend_schema <.extend_schema>` to. This decorator also takes care of safely attaching annotations to derived view methods, preventing leakage into unrelated views. This decorator also supports custom DRF ``@action`` with the method name as the key. :param kwargs: method names as argument names and :func:`@extend_schema <.extend_schema>` calls as values c rt|r)t|drtdi|j|St |}j D]c\}}||vr"t d|d|jd|d|,t|dr|D]}|t||R|t||e|S) Nr<z@extend_schema_view argument "z" was not found on view z. method override for "z" will be ignored.r__iter__r,) rBrextend_schema_viewr<ritemsrrRr)ravailable_view_methods method_namemethod_decoratorsub_method_decoratorr3s r5rz%extend_schema_view..decorators D>gdE2 (  ( ( 2K!6t!<-3\\^ I )K)"884[MAY}}o%<[MI[]   '4,<Q(()`, where one needs an implicit one-off serializer that is not reflected in an actual class. :param name: name of the :param fields: dict with field names as keys and serializer fields as values :param kwargs: optional kwargs for serializer initialization r,)rtr)rarr3serializer_classs r5inline_serializerrs#D:-8  %f %%r6rA)NNNNNNN):rsystypingrrrrrrr r r django.utils.functionalr version_inforrtyping_extensionsrest_framework.fieldsrrrest_framework.serializersrrrest_framework.settingsrdrf_spectacular.drainagerrrrrdrf_spectacular.typesrr_ListSerializerTyperW _FieldTyperlrVrkr Directionr$r]r_rorrrrrrXrrrrrr,r6r5r s WWW+v%%0.A0BND,@@A D$445 5$u+% &  !DEc7l# 38n ) * l l ^  ')&')T4!(4!n'''('&'. CxS)*#'#<#&#8'+SW(,/3+/%)(,"&"&+/+/,07;/39=>B%`sm`Xe,