a ΝGd^@sddlZddlZddlZddlZddlmZddlmZddlZddl m Z ddl m Z ddl mZmZddlmZmZmZmZddlmZdd lmZdd lmZdd lmZmZdd lm Z d dl!m"Z"e#e$Z%Gddde&Z'Gddde&Z(dde(dddddddddddddfddZ)ddZ*ddZ+ddZ,ddZ-ddZ.dd Z/d!d"Z0d#d$Z1d:d%d&Z2d'd(Z3d)d*Z4d+d,Z5d-d.Z6d;d2d3Z7d4d5Z8d6d7Z9d8d9Z:dS)<N) OrderedDict)Decimal)models) force_str) serializersstatus)DestroyModelMixinListModelMixinRetrieveModelMixinUpdateModelMixin)FileUploadParseris_form_media_type) api_settings)encodersjson)APIView)swagger_settingsc@seZdZdZdS)no_bodyzcUsed as a sentinel value to forcibly remove the body of a request via :func:`.swagger_auto_schema`.N__name__ __module__ __qualname____doc__rrJ/var/www/html/django/DPS/env/lib/python3.9/site-packages/drf_yasg/utils.pyrsrc@seZdZdZdS)unsetzmUsed as a sentinel value for function parameters not set by the caller where ``None`` would be a valid value.Nrrrrrrsrc 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`` cstfddtjDr Jd   r>t ndrLtndrZtndrhtndd tturd<sStdg}tdi}fdd |D}||}td dfd d td gD}||td i } s rs(Jdt t ksBJdt t rVJd rh g}ndd D}t fdd|DsJdtfdd|DrJdr^t |t |ksJdtdkr|sJdn |p}tfdd|DrJdtfdd|Dr>Jdfdd|D_n"|rlJdrzJd_S)Nc3s|]}|vVqdSNr).0Zhm)extra_overridesrr sz9swagger_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)rmthname) view_methodrr r"z:swagger_auto_schema..decorator..clscsg|]}t|r|qSr)hasattr)rmview_clsrrr6r"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|] }|qSrlowerrr3rrrr6r"c3s|]}|vVqdSrrr@)available_http_methodsrrr!r"zhttp method not bound to viewc3s|]}|vVqdSrrr@ 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)Nr=)r8getattrr@r:rrr!r"z+swagger_auto_schema applied twice to methodc3s|]}|vVqdSrrr@rBrrr!r"c3s|]}|fVqdSrr>r@)datarrr!r"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)anyrr<list filter_nonerupdaterDitemsbool isinstancestrr?alllenr=)r5r1r2Zmapping_methodsZaction_http_methodsZapi_view_http_methodsZ_methodsr0r(r r.r,r%methodmethodsr)r&r'r-r$r#r+r*r/)rArErCr;r5r decoratorrst            z&swagger_auto_schema..decoratorr)rQrRr0r#r$r%r&r)r'r*r(r+r.r,r-r/r rSrrPrswagger_auto_schema"sP,NrTcsfdd}|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)Z_swagger_serializer)Zserializer_methodserializer_or_fieldrrrSsz,swagger_serializer_method..decoratorr)rVrSrrUrswagger_serializer_methods rWcCst|dd}t||dp|}t|dd}t|dd}|dvsL|dusL|dkrPd S|d vsh|d ush|d krldSt|trzd St|tttfrdS|d d }|rd |dvrdSd 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)rGcreateFListT)retrieverIZpartial_updatedestroyInstance/{)rDrLr r r rstripsplit)pathrQviewrXrZr[Zpath_componentsrrr is_list_views    rhcCs&|dkrtjS|dkrtjStjSdS)Npostdelete)rZHTTP_201_CREATEDZHTTP_204_NO_CONTENTZ HTTP_200_OK)rQrrrguess_response_statuss rkcCs.tdd|D}t|t|ks*Jd|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)r4Zin_)rparamrrrr! r"z¶m_list_to_odict..zduplicate Parameters found)rrO) parametersresultrrrparam_list_to_odicts rocCs"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] )rorIrGvalues)rmZ overridesrrr merge_paramss rqcCsx|dur dSd}t|tr4t|dd|D}t|ttfrXt|dd|D}|durtt|t|krt|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||fVqdSrr)rkvrrrr!*r"zfilter_none..css|]}|dur|VqdSrr)rrsrrrr!,r")rLdicttyperJrGtuplerO)objZnew_objrrrrH s rHcCsLt|r*t|tjs$Jd|j|St|tjsHJdt|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 issubclassrZBaseSerializerrrLru serializerrrrforce_serializer_instance2s  rcCsZ|dur dSt|r4t|tjs0Jd|j|St|tjsRJdt|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] Nrxryrzr~rrrget_serializer_classDs  rcCsZ|pg}g}|D]D}t|r8|r,t||rT||q|rFt||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 )r{r|r}appendrLru)Zclasses_or_instancesZexpected_base_classrnrwrrrget_object_classesXs   rcCsJt|}dd|D}dd|p"gD}dd|D}t|dkrF|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)r}r )rZpcrrrr6xr"z get_consumes..cSsg|] }|jqSr media_type)rparserrrrr6yr"cSsg|]}t|s|qSrr )rencodingrrrr6zr"r)rrO)Zparser_classes media_typesZnon_form_media_typesrrr get_consumesos rcCs,t|}dd|pgD}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] cSsg|] }|jqSrr)rrendererrrrr6r"z get_produces..cs(g|] tfddtjDsqS)c3s|]}|vVqdSrr)rexcludedrrrr!r"z*get_produces...)rFrZEXCLUDED_MEDIA_TYPES)rrrrr6s)r)Zrenderer_classesrrrr get_producessrcCs,t|tjst|tjr(t|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 Zcoerce_to_stringF)rLrZ DecimalFieldrrDrest_framework_settingsZCOERCE_DECIMAL_TO_STRING)fieldrrrdecimal_as_floatsrcCsxt|dd}t|j}t|dr(|j}nL|dkrTt|tjrTt dt |d}n |}| drt|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 ZMetaNref_nameZNestedSerializerzDForcing inline output for ModelSerializer named 'NestedSerializer': Serializer) rDrurr8rrLrZModelSerializerloggerdebugrMendswithrO)rZserializer_metaZserializer_namerrrrget_serializer_ref_names    rutf-8FstrictcCs8|dur4t||||}t|tkr*d|}t|}|S)zi Force `s` into a ``str`` instance. Fix for https://github.com/axnsan12/drf-yasg/issues/159 NrY)rrurMtextwrapdedent)srZ strings_onlyerrorsrrrforce_real_strs   rcCsX||}t|tr.t|r&t|}nt|}t|tjrBt|}t tj |t j dS)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 )r7) Zto_representationrLrrfloatrMpytzZ BaseTzInforloadsdumpsr JSONEncoder)rvaluerrrfield_value_to_representations    rcCst|dtj}|tjurt|r~z4t|dr6||t|ddrL||}n|}Wn(ty|tjd|ddtj}Yn0|tjur|durzt ||}Wn(tytjd |ddtj}Yn0|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_contextZrequires_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) rDremptycallabler8r Exceptionrwarningr)rrrrrget_field_defaults.          rcCstjdkrt|tSt|tS)zCheck if a given object is a dict that maintains insertion order. :param obj: the dict object to check :rtype: bool ))sys version_inforLrtr)rwrrrdict_has_ordered_keyss  r)N)rFr);r{loggingrr collectionsrdecimalrrZ django.dbrZdjango.utils.encodingrZrest_frameworkrrZrest_framework.mixinsrr r r Zrest_framework.parsersr Zrest_framework.requestrZrest_framework.settingsrrZrest_framework.utilsrrZrest_framework.viewsrZ app_settingsr getLoggerrrobjectrrrTrWrhrkrorqrHrrrrrrrrrrrrrrrsT             "$    !