+}&iHddlZddlmZddlmZddlmZddlmZddl m Z ddl m Z dd l mZmZmZmZmZmZmZmZmZd d lmZmZej4eZGd d eZy)N) OrderedDictis_form_media_type) AutoSchema) is_success)openapi)SwaggerGenerationError) filter_noneforce_real_strforce_serializer_instance get_consumes get_producesguess_response_status merge_paramsno_bodyparam_list_to_odict) ViewInspectorcall_view_methodceZdZ dfd ZddZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZddZdZdZdZdZddZdZdZxZS)SwaggerAutoSchemactt| ||||||t|_||j_||_yN)superr__init__r_schviewoperation_keys) selfrpathmethod componentsrequest overridesr __class__s P/usr/local/footviz/venv/lib/python3.12/site-packages/drf_yasg/inspectors/view.pyrzSwaggerAutoSchema.__init__s@ / $ GY L  ,c D|xs |j}|j}|j}|j|}|j }||z}t |}|j |}|j|}|j\}} |j} | t| tsJd|j} |j|} |j} tj |t#| t#|| |||| | |  S)Nz7security must be a list of security requirement objects) operation_id descriptionsummary responses parametersconsumesproducestagssecurity deprecated)rrrget_request_body_parametersget_query_parametersr add_manual_parametersget_operation_idget_summary_and_description get_security isinstancelist is_deprecatedget_tags get_responsesr Operationr )r rr/r0bodyqueryr.r*r,r+r2r3r1r-s r' get_operationzSwaggerAutoSchema.get_operation%s&'>4+>+>$$&$$&//9))+E\  , // ; ,,^< #??A$$&:h#= E ='') }}^,&&(   %&{3"7+!!  r(c,|j}d}|gSt|tjjr|}t d|Dr| t d|j|S||j|}||j|gSgS)a$Return the request body parameters for this view. |br| This is either: - a list with a single object Parameter with a :class:`.Schema` derived from the request serializer - a list of primitive Parameters parsed as form data :param list[str] consumes: a list of accepted MIME types as returned by :meth:`.get_consumes` :return: a (potentially empty) list of :class:`.Parameter`\ s either ``in: body`` or ``in: formData`` :rtype: list[openapi.Parameter] Nc32K|]}t|ywrr.0encodings r' z@SwaggerAutoSchema.get_request_body_parameters.._sE!(+Ez$form request body cannot be a Schema) get_request_serializerr:r SchemaOR_REFanyr get_request_form_parametersget_request_body_schemamake_body_parameter)r r/ serializerschemas r'r4z-SwaggerAutoSchema.get_request_body_parametersIs002   I j'.."7"7 8F EHE E!,-STT33J? ?~55jA9?9KD,,V45 SQS Sr(c.t|jdS)zReturn the serializer as defined by the view's ``get_serializer()`` method. :return: the view's ``Serializer`` :rtype: rest_framework.serializers.Serializer get_serializer)rrr s r'get_view_serializerz%SwaggerAutoSchema.get_view_serializerhs   +;<4@  $'{{$"3"33,;hht0012UV -)>)>?$$,]; ;r(c|j}|(|j|jvr|jS|tury|S)aReturn the request serializer (used for parsing the request payload) for this endpoint. :return: the request serializer, or one of :class:`.Schema`, :class:`.SchemaRef`, ``None`` :rtype: rest_framework.serializers.Serializer N)r_r"implicit_body_methodsrVrr]s r'rJz(SwaggerAutoSchema.get_request_serializersI779  T[[D4N4N%N++- - G #r(cD|j|tjS)zGiven a Serializer, return a list of ``in: formData`` :class:`.Parameter`\ s. :param serializer: the view's request serializer as returned by :meth:`.get_request_serializer` :rtype: list[openapi.Parameter] in_)serializer_to_parametersr IN_FORMr rQs r'rNz-SwaggerAutoSchema.get_request_form_parameterss,,ZW__,MMr(c$|j|S)aReturn the :class:`.Schema` for a given request's body data. Only applies to PUT, PATCH and POST requests. :param serializer: the view's request serializer as returned by :meth:`.get_request_serializer` :rtype: openapi.Schema )serializer_to_schemargs r'rOz)SwaggerAutoSchema.get_request_body_schemas((44r(cPtjdtjd|S)zGiven a :class:`.Schema` object, create an ``in: body`` :class:`.Parameter`. :param openapi.Schema schema: the request body schema :rtype: openapi.Parameter dataT)namerdrequiredrR)r ParameterIN_BODY)r rRs r'rPz%SwaggerAutoSchema.make_body_parameters$   W__tF  r(c|jjddxsg}td|Dr tdtd|Drtd|D}|s td|j Ds td|j |j vr*td d j|j zd zt||S) aAdd/replace parameters from the given list of automatically generated request parameters. :param list[openapi.Parameter] parameters: generated parameters :return: modified parameters :rtype: list[openapi.Parameter] manual_parametersNc3VK|]!}|jtjk(#ywrrdr rorFparams r'rHz:SwaggerAutoSchema.add_manual_parameters.." -2EII ( ')zDspecify the body parameter as a Schema or Serializer in request_bodyc3VK|]!}|jtjk(#ywr)rdr rfrts r'rHz:SwaggerAutoSchema.add_manual_parameters..rvrwc3VK|]!}|jtjk(#ywrrsrts r'rHz:SwaggerAutoSchema.add_manual_parameters..s"%16 W__,%rwc32K|]}t|ywrrrEs r'rHz:SwaggerAutoSchema.add_manual_parameters..s-19"8,-rIz~cannot add form parameters when the request has a request body; did you forget to set an appropriate parser class on the view?z(form parameters can only be applied to (rYz) HTTP methods) r%rZrMr rr"r[r\r)r r.rqhas_body_parameters r'r6z'SwaggerAutoSchema.add_manual_parameterss!NN../BDIOR  6G  )V   6G  "%%:D%" "-=A=N=N=P-*-U{{$"3"33,((4#4#4568HI J(9::r(cl|j}tj|j|S)zGet the possible responses for this view as a swagger :class:`.Responses` object. :return: the documented responses :rtype: openapi.Responses )r-)get_response_serializersr Responsesget_response_schemas)r response_serializerss r'r>zSwaggerAutoSchema.get_responsess5 $<<>  //0DE  r(cZ|j}|r |tur|S|jS)aReturn the default response serializer for this endpoint. This is derived from either the ``request_body`` override or the request serializer (:meth:`.get_view_serializer`). :return: response serializer, :class:`.Schema`, :class:`.SchemaRef`, ``None`` )r_rrVr]s r'get_default_response_serializerz1SwaggerAutoSchema.get_default_response_serializers1779 ]'9 ''))r(c|jj}t|}d}|dvr|j}|xsd}|r/t |t j s|j|xsd}|rZ|jr%t j t j|}|jr|j|xs|}tt||iS)zGet the default responses determined for this view from the request serializer and request method. :type: dict[str, openapi.Schema] )rZpostputpatch)typeitems)r"lowerrrr:r rKrihas_list_response TYPE_ARRAY should_pageget_paginated_responserstr)r r"default_statusdefault_schemas r'get_default_responsesz'SwaggerAutoSchema.get_default_responsess ""$.v6 4 4!AACN'-2 *^W^^"L!66~FL"N %%'!( ++>"!//?Q>C/@AAr(c*|jjddxsi}td|jD}t}t d|Ds|j }|j d|jD|S)aReturn the response codes that this view is expected to return, and the serializer for each response body. The return value should be a dict where the keys are possible status codes, and values are either strings, ``Serializer``\ s, :class:`.Schema`, :class:`.SchemaRef` or :class:`.Response` objects. See :func:`@swagger_auto_schema <.swagger_auto_schema>` for more details. :return: the response serializers :rtype: dict r-Nc3<K|]\}}t||fywrrrFscresps r'rHz=SwaggerAutoSchema.get_response_serializers..s!' (DSWdO' c3PK|]}|dk7s tt| yw)defaultN)rint)rFrs r'rHz=SwaggerAutoSchema.get_response_serializers.. sU2R9_:c"g&Us &&c3<K|]\}}t||fywrrrs r'rHz=SwaggerAutoSchema.get_response_serializers..#sRXR#b'4Rr)r%rZrrrMrupdate)r manual_responsesr-s r'r}z*SwaggerAutoSchema.get_response_serializerss >>--k4@FB&' ,<,B,B,D'   M U1AUU224IR9I9O9O9QRRr(ct}|jD]T\}}t|tr!t j t |}n|s;t|tj rh|}t|drt|jtjjst|j}|j||_nt|tjjrt j d|}nNt|tjr|}n1t|}t j d|j|}||t|<W|S)aCReturn the :class:`.openapi.Response` objects calculated for this view. :param dict response_serializers: response serializers as returned by :meth:`.get_response_serializers` :return: a dictionary of status code to :class:`.Response` object :rtype: dict[str, openapi.Response] )r+rRr)r+rR)rrr:rr Responser hasattrrRrKrLr ri_Ref)r rr-rrQresponses r'rz&SwaggerAutoSchema.get_response_schemas&s) M 288: *NB *c*"++z8RSJ(8(89%8X.zOOW^^%:%:8";8??!KJ&*&?&? &KHOJ(=(=>"++ "%J 5%6zB "++ "44Z@ "*Ic"g 5 *8r(cX|jjdd}| t|}|S)zReturn the query serializer (used for parsing query parameters) for this endpoint. :return: the query serializer, or ``None`` query_serializerN)r%rZr )r rs r'get_query_serializerz&SwaggerAutoSchema.get_query_serializerMs4  >>--.@$G  '89IJ r(cl|j|jz}|j}g}|{|j|tj }t tt|tt|zdk7r%td|jd|j||zS)zdReturn the query parameters accepted by this view. :rtype: list[openapi.Parameter] rcrzmyour query_serializer contains fields that conflict with the filter_backend or paginator_class on the view -  ) get_filter_parametersget_pagination_parametersrrer IN_QUERYlensetrr r"r!)r natural_parametersrserializer_parameterss r'r5z&SwaggerAutoSchema.get_query_parametersXs  & & (4+I+I+K K  446 "  '$($A$A g&6&6%B% ! +,>?@-.CDEF  -{{DII/ "$999r(c|xs |j}|jjdd}|sdj|}|S)a}Return an unique ID for this operation. The ID must be unique across all :class:`.Operation` objects in the API. :param tuple[str] operation_keys: an array of keys derived from the path describing the hierarchical layout of this view in the API; e.g. ``('snippets', 'list')``, ``('snippets', 'retrieve')``, etc. :rtype: str r*r_)rr%rZr\)r rr*s r'r7z"SwaggerAutoSchema.get_operation_idwsA(>4+>+>~~))."= 88N3Lr(cd}d}|jdd}t|dk(r<|dj|d<t|d|kr|\}}|j}||fS)a[Decide if and how to split a summary out of the given description. The default implementation uses the first paragraph of the description as a summary if it is less than 120 characters long. :param description: the full description to be analyzed :return: summary and description :rtype: (str,str) Nxz rrr)splitrstrip)r r+r,summary_max_lensectionss r'split_summary_from_descriptionz0SwaggerAutoSchema.split_summary_from_descriptions{  $$VQ/ x=A "1+++-HQK8A;/1'/$)//1  ##r(cV|jjdd}|jjdd}|l|jj|j|j xsd}|j jdd}|r||j|\}}||fS)zReturn an operation summary and description determined from the view's docstring. :return: summary and description :rtype: (str,str) operation_descriptionNoperation_summaryr ) r%rZrget_descriptionr!r"rreplacer)r r+r,s r'r8z-SwaggerAutoSchema.get_summary_and_descriptionsnn(()@$G ..$$%8$?  ))33DIIt{{KQrK%++-55dB?K'+'J'J;'W$ ##r(c:|jjddS)a\Return a list of security requirements for this operation. Returning an empty list marks the endpoint as unauthenticated (i.e. removes all accepted authentication schemes). Returning ``None`` will inherit the top-level security requirements. :return: security requirements :rtype: list[dict[str,list[str]]]r2Nr%rZrUs r'r9zSwaggerAutoSchema.get_securitys~~!!*d33r(c:|jjddS)zReturn ``True`` if this operation is to be marked as deprecated. :return: deprecation status :rtype: bool r3NrrUs r'r<zSwaggerAutoSchema.is_deprecateds ~~!!,55r(cl|xs |j}|jjd}|s|dg}|S)aGet a list of tags for this operation. Tags determine how operations relate with each other, and in the UI each tag will show as a group containing the operations that use it. If not provided in overrides, tags will be inferred from the operation url. :param tuple[str] operation_keys: an array of keys derived from the path describing the hierarchical layout of this view in the API; e.g. ``('snippets', 'list')``, ``('snippets', 'retrieve')``, etc. :rtype: list[str] r1r)rr%rZ)r rr1s r'r=zSwaggerAutoSchema.get_tagss=(>4+>+>~~!!&)"1%&D r(cn|jjdxst|jS)zTReturn the MIME types this endpoint can consume. :rtype: list[str] r/)r%rZrget_parser_classesrUs r'rzSwaggerAutoSchema.get_consumess, ~~!!*-Xd>U>U>W1XXr(cn|jjdxst|jS)zTReturn the MIME types this endpoint can produce. :rtype: list[str] r0)r%rZrget_renderer_classesrUs r'rzSwaggerAutoSchema.get_producess3 ~~!!*-   % % '2  r(r)__name__ __module__ __qualname__rrBr4rVr_rJrNrOrPr6r>rrr}rrr5r7rr8r9r<r=rr __classcell__)r&s@r'rrsQU-" HT>=($N5 #;J   *B:.%N  :> $.$& 46&Y r(r)logging collectionsrrest_framework.requestrrest_framework.schemasrrest_framework.statusrrr errorsr utilsr r r rrrrrrbaserr getLoggerrloggerrr(r'rsN#5-,+   2   8 $K K r(