o hz]@sddlZddlZddlZddlmZddlmZddlZddlm Z ddl m Z ddl m Z mZddlmZmZmZmZddlmZdd lmZdd lmZdd lmZmZdd lmZd dl m!Z!zddl"Z"Wne#yzddl$m"Z"Wn e#ydZ"YnwYnwe%e&Z'Gddde(Z)Gddde(Z*dde*dddddddddddddfddZ+ddZ,ddZ-ddZ.ddZ/ddZ0d d!Z1d"d#Z2d$d%Z3d9d&d'Z4d(d)Z5d*d+Z6d,d-Z7d.d/Z8d:d3d4Z9d5d6Z:d7d8Z;dS);N) OrderedDict)Decimal)models) force_str) serializersstatus)DestroyModelMixinListModelMixinRetrieveModelMixinUpdateModelMixin)FileUploadParseris_form_media_type) api_settings)encodersjson)APIView)swagger_settings)zoneinfoc@eZdZdZdS)no_bodyzcUsed as a sentinel value to forcibly remove the body of a request via :func:`.swagger_auto_schema`.N__name__ __module__ __qualname____doc__rrN/var/www/html/premium_crap/venv/lib/python3.10/site-packages/drf_yasg/utils.pyr rc@r)unsetzmUsed as a sentinel value for function parameters not set by the caller where ``None`` would be a valid value.Nrrrrrr %rr c s0 fdd}|S)aDecorate a view method to customize the :class:`.Operation` object generated from it. `method` and `methods` are mutually exclusive and must only be present when decorating a view method that accepts more than one HTTP request method. The `auto_schema` and `operation_description` arguments take precedence over view- or method-level values. :param str method: for multi-method views, the http method the options should apply to :param list[str] methods: for multi-method views, the http methods the options should apply to :param drf_yasg.inspectors.SwaggerAutoSchema auto_schema: custom class to use for generating the Operation object; this overrides both the class-level ``swagger_schema`` attribute and the ``DEFAULT_AUTO_SCHEMA_CLASS`` setting, and can be set to ``None`` to prevent this operation from being generated :param request_body: custom request body which will be used as the ``schema`` property of a :class:`.Parameter` with ``in: 'body'``. A Schema or SchemaRef is not valid if this request consumes form-data, because ``form`` and ``body`` parameters are mutually exclusive in an :class:`.Operation`. If you need to set custom ``form`` parameters, you can use the `manual_parameters` argument. If a ``Serializer`` class or instance is given, it will be automatically converted into a :class:`.Schema` used as a ``body`` :class:`.Parameter`, or into a list of ``form`` :class:`.Parameter`\ s, as appropriate. :type request_body: drf_yasg.openapi.Schema or drf_yasg.openapi.SchemaRef or rest_framework.serializers.Serializer or type[no_body] :param rest_framework.serializers.Serializer query_serializer: if you use a ``Serializer`` to parse query parameters, you can pass it here and have :class:`.Parameter` objects be generated automatically from it. If any ``Field`` on the serializer cannot be represented as a ``query`` :class:`.Parameter` (e.g. nested Serializers, file fields, ...), the schema generation will fail with an error. Schema generation will also fail if the name of any Field on the `query_serializer` conflicts with parameters generated by ``filter_backends`` or ``paginator``. :param list[drf_yasg.openapi.Parameter] manual_parameters: a list of manual parameters to override the automatically generated ones :class:`.Parameter`\ s are identified by their (``name``, ``in``) combination, and any parameters given here will fully override automatically generated parameters if they collide. It is an error to supply ``form`` parameters when the request does not consume form-data. :param str operation_id: operation ID override; the operation ID must be unique across the whole API :param str operation_description: operation description override :param str operation_summary: operation summary string :param list[dict] security: security requirements override; used to specify which authentication mechanism is required to call this API; an empty list marks the endpoint as unauthenticated (i.e. removes all accepted authentication schemes), and ``None`` will inherit the top-level security requirements :param bool deprecated: deprecation status for operation :param responses: a dict of documented manual responses keyed on response status code. If no success (``2xx``) response is given, one will automatically be generated from the request body and http method. If any ``2xx`` response is given the automatic response is suppressed. * if a plain string is given as value, a :class:`.Response` with no body and that string as its description will be generated * if ``None`` is given as a value, the response is ignored; this is mainly useful for disabling default 2xx responses, i.e. ``responses={200: None, 302: 'something'}`` * if a :class:`.Schema`, :class:`.SchemaRef` is given, a :class:`.Response` with the schema as its body and an empty description will be generated * a ``Serializer`` class or instance will be converted into a :class:`.Schema` and treated as above * a :class:`.Response` object will be used as-is; however if its ``schema`` attribute is a ``Serializer``, it will automatically be converted into a :class:`.Schema` :type responses: dict[int or str, (drf_yasg.openapi.Schema or drf_yasg.openapi.SchemaRef or drf_yasg.openapi.Response or str or rest_framework.serializers.Serializer)] :param list[type[drf_yasg.inspectors.FieldInspector]] field_inspectors: extra serializer and field inspectors; these will be tried before :attr:`.ViewInspector.field_inspectors` on the :class:`.inspectors.SwaggerAutoSchema` :param list[type[drf_yasg.inspectors.FilterInspector]] filter_inspectors: extra filter inspectors; these will be tried before :attr:`.ViewInspector.filter_inspectors` on the :class:`.inspectors.SwaggerAutoSchema` :param list[type[drf_yasg.inspectors.PaginatorInspector]] paginator_inspectors: extra paginator inspectors; these will be tried before :attr:`.ViewInspector.paginator_inspectors` on the :class:`.inspectors.SwaggerAutoSchema` :param list[str] tags: tags override :param extra_overrides: extra values that will be saved into the ``overrides`` dict; these values will be available in the handling :class:`.inspectors.SwaggerAutoSchema` instance via ``self.overrides`` csntfddtjDrJd   rt ndr&tndr-tndr4tndd tturDd<sMStdg}tdi}fdd |D}||}td dfd d td gD}||td i } s rӈsJdt t ksJdt t rJd r g}ndd D}t fdd|DsJdtfdd|DrJdr$t |t |ksJdtdkr|sJdn|p}tfdd|DrJdtfdd|DrJdfdd|D_S|r+Jdr2Jd_S)Nc3|]}|vVqdSNr).0hm)extra_overridesrr {z9swagger_auto_schema..decorator..z"HTTP method names not allowed here) request_bodyquery_serializermanual_parameters operation_idoperation_summary deprecatedoperation_descriptionsecurity responsesfilter_inspectorspaginator_inspectorsfield_inspectorstags auto_schemabind_to_methodsmappingcsg|] \}}|jkr|qSr)r)r#mthname) view_methodrr sz:swagger_auto_schema..decorator..clscsg|] }t|r|qSr)hasattr)r#mview_clsrrr;http_method_names_swagger_auto_schemazI`method` or `methods` can only be specified on @action or @api_view viewsz specify either method or methodszR`methods` expects to receive a list of methods; use `method` for a single argumentcSsg|]}|qSrlowerr#r8rrrr;sc3r!r"rrF)available_http_methodsrrr&r'zhttp method not bound to viewc3r!r"rrF existing_datarrr&r'z"http method defined multiple timeszthis should never happenrzon multi-method api_view or action, you must specify swagger_auto_schema on a per-method basis using one of the `method` or `methods` argumentsc3s"|] }tt|ddVqdS)NrC)r=getattrrFr?rrr&s z+swagger_auto_schema applied twice to methodc3r!r"rrFrHrrr&r'c3s|] }|fVqdSr"rDrF)datarrr&zthe methods argument should only be specified when decorating an action; you should also ensure that you put the swagger_auto_schema decorator AFTER (above) the _route decorator)anyrrBlist filter_noner updaterJitemsbool isinstancestrrEalllenrC)r:r6r7mapping_methodsaction_http_methodsapi_view_http_methods_methodsr5r-r%r3r1r*methodmethodsr.r+r,r2r)r(r0r/r4)rGrKrIr@r:r decoratorzsv           z&swagger_auto_schema..decoratorr)r\r]r5r(r)r*r+r.r,r/r-r0r3r1r2r4r%r^rr[rswagger_auto_schema*s,PNr_csfdd}|S)z Decorates the method of a serializers.SerializerMethodField to hint as to how Swagger should be generated for this field. :param serializer_or_field: ``Serializer``/``Field`` class or instance :return: cs |_|Sr")_swagger_serializer)serializer_methodserializer_or_fieldrrr^sz,swagger_serializer_method..decoratorr)rcr^rrbrswagger_serializer_methods rdcCst|dd}t||dp |}t|dd}t|dd}|dvs&|dus&|dkr(d S|d vs4|d us4|d kr6dSt|tr=d St|tttfrGdS|d d }|rYd |dvrYdSd S)zCheck if the given path/method appears to represent a list view (as opposed to a detail/instance view). :param str path: view path :param str method: http method :param APIView view: target view :rtype: bool actionNdetailsuffix)rNcreateFListT)retrieverPpartial_updatedestroyInstance/{)rJrSr r r rstripsplit)pathr\viewrergrhpath_componentsrrr is_list_views    rwcCs"|dkrtjS|dkrtjStjS)Npostdelete)rHTTP_201_CREATEDHTTP_204_NO_CONTENT HTTP_200_OK)r\rrrguess_response_statuss r}cCs.tdd|D}t|t|ksJd|S)aTransform a list of :class:`.Parameter` objects into an ``OrderedDict`` keyed on the ``(name, in_)`` tuple of each parameter. Raises an ``AssertionError`` if `parameters` contains duplicate parameters (by their name + in combination). :param list[drf_yasg.openapi.Parameter] parameters: the list of parameters :return: `parameters` keyed by ``(name, in_)`` :rtype: dict[(str,str),drf_yasg.openapi.Parameter] css |] }|j|jf|fVqdSr")r9in_)r#paramrrrr&sz¶m_list_to_odict..zduplicate Parameters found)rrV) parametersresultrrrparam_list_to_odict s rcCs"t|}|t|t|S)aMerge `overrides` into `parameters`. This is the same as appending `overrides` to `parameters`, but any element of `parameters` whose ``(name, in_)`` tuple collides with an element in `overrides` is replaced by it. Raises an ``AssertionError`` if either list contains duplicate parameters. :param list[drf_yasg.openapi.Parameter] parameters: initial parameters :param list[drf_yasg.openapi.Parameter] overrides: overriding parameters :return: merged list :rtype: list[drf_yasg.openapi.Parameter] )rrPrNvalues)r overridesrrr merge_paramss  rcCsx|durdSd}t|trt|dd|D}t|ttfr,t|dd|D}|dur:t|t|kr:|S|S)zRemove ``None`` values from tuples, lists or dictionaries. Return other objects as-is. :param obj: the object :return: collection with ``None`` values removed Ncss,|]\}}|dur|dur||fVqdSr"r)r#kvrrrr&2s*zfilter_none..css|] }|dur|VqdSr"r)r#rrrrr&4rL)rSdicttyperQrNtuplerV)objnew_objrrrrO(s rOcCsLt|rt|tjsJd|j|St|tjs$Jdt|j|S)aYForce `serializer` into a ``Serializer`` instance. If it is not a ``Serializer`` class or instance, raises an assertion error. :param serializer: serializer class or instance :type serializer: serializers.BaseSerializer or type[serializers.BaseSerializer] :return: serializer instance :rtype: serializers.BaseSerializer Serializer required, not %s-Serializer class or instance required, not %sinspectisclass issubclassrBaseSerializerrrSr serializerrrrforce_serializer_instance:s  rcCsZ|durdSt|rt|tjsJd|j|St|tjs)Jdt|jt|S)a6Given a ``Serializer`` class or instance, return the ``Serializer`` class. If `serializer` is not a ``Serializer`` class or instance, raises an assertion error. :param serializer: serializer class or instance, or ``None`` :return: serializer class :rtype: type[serializers.BaseSerializer] Nrrrrrrrget_serializer_classLs  rcCsZ|pg}g}|D]"}t|r|rt||r||q|r#t||r*|t|q|S)atGiven a list of instances or class objects, return the list of their classes. :param classes_or_instances: mixed list to parse :type classes_or_instances: list[type or object] :param expected_base_class: if given, only subclasses or instances of this type will be returned :type expected_base_class: type :return: list of classes :rtype: list )rrrappendrSr)classes_or_instancesexpected_base_classrrrrrget_object_classes`s   rcCsJt|}dd|D}dd|pgD}dd|D}t|dkr#|S|S)aExtract ``consumes`` MIME types from a list of parser classes. :param list parser_classes: parser classes :type parser_classes: list[rest_framework.parsers.BaseParser or type[rest_framework.parsers.BaseParser]] :return: MIME types for ``consumes`` :rtype: list[str] cSsg|] }t|ts|qSr)rr )r#pcrrrr;rAz get_consumes..cSg|]}|jqSr media_type)r#parserrrrr;cSsg|]}t|s|qSrr )r#encodingrrrr;sr)rrV)parser_classes media_typesnon_form_media_typesrrr get_consumesws rcCs,t|}dd|p gD}dd|D}|S)a/Extract ``produces`` MIME types from a list of renderer classes. :param list renderer_classes: renderer classes :type renderer_classes: list[rest_framework.renderers.BaseRenderer or type[rest_framework.renderers.BaseRenderer]] :return: MIME types for ``produces`` :rtype: list[str] cSrrr)r#rendererrrrr;rz get_produces..cs(g|]tfddtjDsqS)c3r!r"r)r#excludedrrrr&r'z*get_produces...)rMrEXCLUDED_MEDIA_TYPES)r#rrrr;s )r)renderer_classesrrrr get_producessrcCs,t|tjs t|tjrt|dtj SdS)zReturns true if ``field`` is a django-rest-framework DecimalField and its ``coerce_to_string`` attribute or the ``COERCE_DECIMAL_TO_STRING`` setting is set to ``False``. :rtype: bool coerce_to_stringF)rSr DecimalFieldrrJrest_framework_settingsCOERCE_DECIMAL_TO_STRING)fieldrrrdecimal_as_floatsrcCs|t|dd}t|j}t|dr|j}|S|dkr,t|tjr,t dt |d}|S|}| dr<|dt d }|S)zGet serializer's ref_name (or None for ModelSerializer if it is named 'NestedSerializer') :param serializer: Serializer instance :return: Serializer's ``ref_name`` or ``None`` for inline serializer :rtype: str or None MetaNref_nameNestedSerializerzDForcing inline output for ModelSerializer named 'NestedSerializer': Serializer) rJrrr=rrSrModelSerializerloggerdebugrTendswithrV)rserializer_metaserializer_namerrrrget_serializer_ref_names    rutf-8FstrictcCs8|durt||||}t|turd|}t|}|S)zi Force `s` into a ``str`` instance. Fix for https://github.com/axnsan12/drf-yasg/issues/159 Nrf)rrrTtextwrapdedent)sr strings_onlyerrorsrrrforce_real_strs   rcCsx||}t|trt|rt|}nt|}nt|tjr#t|}ntdur1t|tj r1t|}t t j |t jdS)zConvert a python value related to a field (default, choices, etc.) into its OpenAPI-compatible representation. :param serializers.Field field: field associated with the value :param object value: value :return: the converted value N)r<)to_representationrSrrfloatrTpytz BaseTzInforZoneInforloadsdumpsr JSONEncoder)rvaluerrrfield_value_to_representations      rcCst|dtj}|tjurft|r?zt|dr||t|ddr&||}n|}Wnty>tjd|ddtj}Ynw|tjurf|durfzt ||}W|Styetjd |ddtj}Y|Sw|S) z Get the default value for a field, converted to a JSON-compatible value while properly handling callables. :param field: field instance :return: default value default set_contextrequires_contextFzfdefault for %s is callable but it raised an exception when called; 'default' will not be set on schemaT)exc_infoNzX'default' on schema for %s will not be set because to_representation raised an exception) rJremptycallabler=r Exceptionrwarningr)rrrrrget_field_defaults8         rr")rFr)sf                "$