gz]ddlZddlZddlZddlmZddlmZddlZddlm Z ddl m Z ddl m Z mZddlmZmZmZmZddlmZdd lmZdd lmZdd lmZmZdd lmZd dl m!Z! ddl"Z"ejJe&Z'Gdde(Z)Gdde(Z*dde*dddddddddddddfdZ+dZ,dZ-dZ.dZ/dZ0dZ1dZ2dZ3d%dZ4dZ5dZ6d Z7d!Z8d&d"Z9d#Z:d$Z;y#e#$r ddl$m"Z"n #e#$rdZ"YnwxYwYwxYw)'N) OrderedDict)Decimal)models) force_str) serializersstatus)DestroyModelMixinListModelMixinRetrieveModelMixinUpdateModelMixin)FileUploadParser)is_form_media_type) api_settings)encodersjson)APIView)swagger_settings)zoneinfoceZdZdZy)no_bodyzcUsed as a sentinel value to forcibly remove the body of a request via :func:`.swagger_auto_schema`.N__name__ __module__ __qualname____doc__L/var/www/skyplay_api_hub/venv/lib/python3.12/site-packages/drf_yasg/utils.pyrr smrrceZdZdZy)unsetzmUsed as a sentinel value for function parameters not set by the caller where ``None`` would be a valid value.Nrrrrr!r!%swrr!c R    fd}|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`` cF tfdtjDrJdr tndr tndr tndr tndd t  t ur d< j  s|St|dg}t|di}|jDcgc]\}}||jk(s|}}}||z}t|dd t dgDcgc]}t |s|}}||z t|d i } sr sJd ttk7sJd ttrJd rjg} nDcgc]}|j} }t fd | DsJdt fd| DrJd rt|t|k7sJdt! dkDr | s Jd| xs } t fd| DrJdt fd| DrJd j fd| D |_|S| rJd rJd |_|Scc}}wcc}wcc}w)Nc3&K|]}|v ywNr).0hmextra_overridess r z9swagger_auto_schema..decorator..{sQr_,Qz"HTTP method names not allowed here) request_bodyquery_serializermanual_parameters operation_idoperation_summary deprecatedoperation_descriptionsecurity responsesfilter_inspectorspaginator_inspectorsfield_inspectorstags auto_schemabind_to_methodsmappingclshttp_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 argumentc3&K|]}|v ywr%r)r&mthavailable_http_methodss rr)z9swagger_auto_schema..decorator..sIs44Ir*zhttp method not bound to viewc3&K|]}|v ywr%rr&r? existing_datas rr)z9swagger_auto_schema..decorator..DC3-/Dr*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` argumentsc3LK|]}tt|ddyw)Nr=)hasattrgetattr)r&r?view_clss rr)z9swagger_auto_schema..decorator..s#m]`778S$#?AWXms!$z+swagger_auto_schema applied twice to methodc3&K|]}|v ywr%rrBs rr)z9swagger_auto_schema..decorator..rDr*c3BK|]}|jfywr%)lower)r&r?datas rr)z9swagger_auto_schema..decorator..s I#))+t!4 Iszthe 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_noner!updaterGitemsrrFbool isinstancestrrKalllenr=) view_methodr9r:r?namemapping_methodsaction_http_methodsmapi_view_http_methods_methodsr@rLrCrHr8r0r(r6r4r-methodmethodsr1r.r/r5r,r+r3r2r7s @@@@r decoratorz&swagger_auto_schema..decoratorzsQw7P7PQQwSwwQ( 0!2(!2$%: "\`:J%5 6PT"&DJD 4  e #"-D  O$ "+/@"E+y"507 `934;K_K_C_3``-?;t4,3H>QSU,V oqZabjlmZn o o!69L!L -CRH  f) v+v v)=DL0 T2T T0!'3/ W2W W/"LLN+3:;CCIIK;;III jKj jID8DD jFj jD !-.$7J2KK gMg gK)*Q.qqqx $='=mdlmm >= >mD8DD sFs sD  I I I/.decorators0C-  rr)rfr`s` rswagger_serializer_methodrgs! rcZt|dd}t||dxs|}t|dd}t|dd}|dvs |dus|dk(ry |d vs |d us|d k(ryt|try t|ttt fry|j d jd }|rd |dvryy )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/{)rGrSr r r r stripsplit)pathr^viewrirkrlpath_componentss r is_list_viewr{sT8R (F T64 ( 2FF VXt ,F T8T *F ##v&F:J DDRVZ`dnZn$'$+-=?PQRjjo++C0O3/""55 rcv|dk(rtjS|dk(rtjStjS)Npostdelete)rHTTP_201_CREATEDHTTP_204_NO_CONTENT HTTP_200_OK)r^s rguess_response_statusrs6 &&& 8 )))!!!rcftd|D}t|t|k(sJd|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] c3PK|]}|j|jf|f ywr%)rXin_)r&params rr)z¶m_list_to_odict..s"Re5::uyy159Rs$&zduplicate Parameters found)rrV) parametersresults rparam_list_to_odictr s5RzR RF v;#j/ )G+GG ) Mrc~t|}|jt|t|jS)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 overridess r merge_paramsrs6%Z0J))45  !!# $$rc|yd}t|tr&t|d|jD}t|tt frt|d|D}|t |t |k7r|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 Nc36K|]\}}| | ||fywr%r)r&kvs rr)zfilter_none..2s"^tq!amPQP]QF^s  c3&K|] }|| ywr%r)r&rs rr)zfilter_none..4s.sixh(2ir*)rrrMrEXCLUDED_MEDIA_TYPES)renderer_classesrendererrrs `r get_producesrsu**:;7G7M2N88&&NKN,7kiCSChChiikKk Oks A+A#ct|tjst|tjrt |dt j  Sy)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 DecimalFieldrrGrest_framework_settingsCOERCE_DECIMAL_TO_STRING)fields rdecimal_as_floatrs@ %112jH[H[6\5"46M6f6fggg rcJt|dd}t|j}t|dr|j}|S|dk(r?t |t jr%tjdt|zd}|S|}|jdr|dtd }|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) rGrrrFrrSrModelSerializerloggerdebugrTendswithrV)rserializer_metaserializer_namers rget_serializer_ref_namersj&$7O:&//O +"++ O . .:j+JeJe3f \_bcm_nno O#   \ * 3#l"3!34H Orc||9t||||}t|turd|z}tj|}|S)zi Force `s` into a ``str`` instance. Fix for https://github.com/axnsan12/drf-yasg/issues/159 rj)rrrTtextwrapdedent)sr strings_onlyerrorss rforce_real_strrsC  } a< 8 7# QA OOA  Hrc|j|}t|tr#t|r t |}n]t |}nQt|t jr t |}n+t%t|tjr t |}tjtj|tjS)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 )r;)to_representationrSrrfloatrTpytz BaseTzInforZoneInforloadsdumpsr JSONEncoder)rvalues rfield_value_to_representationrs  # #E *E%! E "%LEJE E4?? +E   *UH4E4E"FE  ::djjH,@,@A BBrct|dtj}|tjurit|r; t |dr|j |t|ddr ||}n|}|tjur| t||}|S|S#t $r+tjd|dtj}YXwxYw#t $r,tjd|dtj}Y|SwxYw) 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_infozX'default' on schema for %s will not be set because to_representation raised an exception) rGremptycallablerFr Exceptionrwarningr)rrs rget_field_defaultrseY (9(9:Gk''' G  ,7M2''.7$6>%enG%iG +++ +0C ,7wG N7N , MNS^bd%++ , , GHMX\^%++ N  ,s#:B C1C  C 1DDr%)zutf-8Fstrict)rs# +.ii35K/(*   8 $ f  F $TuSWjn*.TY]qu!%$$Y]qu-1^B"!H"  % $$(. 0 * "C2e& s6$CC4C$#C4$C.+C4-C..C43C4