U ǽbD@sddlZddlmZddlmZddlmZddlmZddl m Z ddl m Z dd l mZmZmZmZmZmZmZmZmZd d lmZmZeeZGd d d eZdS)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_methodcseZdZd4fdd Zd5ddZddZdd Zd d Zd d ZddZ ddZ ddZ ddZ ddZ ddZddZddZddZd d!Zd"d#Zd6d$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd7d.d/Zd0d1Zd2d3ZZS)8SwaggerAutoSchemaNcs4tt|||||||t|_||j_||_dSN)superr__init__r_schviewoperation_keys)selfrpathmethod componentsrequest overridesr __class__Osz@SwaggerAutoSchema.get_request_body_parameters..z$form request body cannot be a Schema) get_request_serializerr7rSchemaOR_REFanyr get_request_form_parametersget_request_body_schemamake_body_parameter)rr, serializerschemar%r%r&r1<s   z-SwaggerAutoSchema.get_request_body_parameterscCs t|jdS)zReturn the serializer as defined by the view's ``get_serializer()`` method. :return: the view's ``Serializer`` :rtype: rest_framework.serializers.Serializer Zget_serializer)rrrr%r%r&get_view_serializerXsz%SwaggerAutoSchema.get_view_serializercCsd|jdd}|dk r`|tkr"tS|j|jkrFtdd|jdt|tj j rX|St |S|S)zOParse the request_body key in the override dict. This method is not public API. request_bodyNz%request_body can only be applied to (,z=); are you looking for query_serializer or manual_parameters?) r"getrr body_methodsr joinr7rrErFr rZ body_overrider%r%r&_get_request_body_override`s z,SwaggerAutoSchema._get_request_body_overridecCs4|}|dkr$|j|jkr$|S|tkr0dS|S)zReturn 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)rUrZimplicit_body_methodsrNrrTr%r%r&rDps z(SwaggerAutoSchema.get_request_serializercCs|j|tjdS)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_parametersrIN_FORMrrKr%r%r&rHsz-SwaggerAutoSchema.get_request_form_parameterscCs ||S)zReturn 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_schemarZr%r%r&rIsz)SwaggerAutoSchema.get_request_body_schemacCstjdtjd|dS)zGiven a :class:`.Schema` object, create an ``in: body`` :class:`.Parameter`. :param openapi.Schema schema: the request body schema :rtype: openapi.Parameter dataT)namerWrequiredrL)r ParameterIN_BODY)rrLr%r%r&rJsz%SwaggerAutoSchema.make_body_parametercCs|jddpg}tdd|Dr,tdtdd|Drtdd|D}|sjtdd|Dsrtd |j|jkrtd d |jd t||S) zAdd/replace parameters from the given list of automatically generated request parameters. :param list[openapi.Parameter] parameters: genereated parameters :return: modified parameters :rtype: list[openapi.Parameter] manual_parametersNcss|]}|jtjkVqdSrrWrr`rAparamr%r%r&rCsz:SwaggerAutoSchema.add_manual_parameters..zDspecify the body parameter as a Schema or Serializer in request_bodycss|]}|jtjkVqdSr)rWrrYrcr%r%r&rCscss|]}|jtjkVqdSrrbrcr%r%r&rCscss|]}t|VqdSrrr@r%r%r&rCsz~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 (rPz) HTTP methods) r"rQrGr r rrRrSr)rr+raZhas_body_parameterr%r%r&r3s  z'SwaggerAutoSchema.add_manual_parameterscCs|}tj||dS)zGet the possible responses for this view as a swagger :class:`.Responses` object. :return: the documented responses :rtype: openapi.Responses )r*)get_response_serializersrZ Responsesget_response_schemas)rresponse_serializersr%r%r&r<szSwaggerAutoSchema.get_responsescCs |}|r|tk r|S|S)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`` )rUrrNrTr%r%r&get_default_response_serializers z1SwaggerAutoSchema.get_default_response_serializercCs|j}t|}d}|dkr&|}|p,d}|rLt|tjsL||pJd}|r~|rhtjtj |d}| r~| |p||}t t ||iS)zGet the default responses determined for this view from the request serializer and request method. :type: dict[str, openapi.Schema] )rQpostputpatch)typeitems)rlowerrrhr7rrEr[Zhas_list_response TYPE_ARRAYZ should_pageZget_paginated_responserstr)rrZdefault_statusZdefault_schemar%r%r&get_default_responsess z'SwaggerAutoSchema.get_default_responsescCsd|jddpi}tdd|D}t}tdd|DsH|}|dd|D|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*Ncss|]\}}t||fVqdSrrqrAscrespr%r%r&rCsz=SwaggerAutoSchema.get_response_serializers..css"|]}|dkrtt|VqdS)defaultN)rint)rArur%r%r&rCscss|]\}}t||fVqdSrrsrtr%r%r&rCs)r"rQrrnrGrrupdate)rZmanual_responsesr*r%r%r&res z*SwaggerAutoSchema.get_response_serializerscCst}|D]\}}t|tr2tjt|d}n|s:qn|t|tjr||}t|drt|jtj j st |j}| ||_n:t|tj j rtjd|d}nt |}tjd| |d}||t|<q|S)a7Return 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(rLri)r(rL) rrnr7rqrResponser hasattrrLrErFr r[)rrgr*rurKresponser%r%r&rfs2   z&SwaggerAutoSchema.get_response_schemascCs"|jdd}|dk rt|}|S)zReturn the query serializer (used for parsing query parameters) for this endpoint. :return: the query serializer, or ``None`` query_serializerN)r"rQr )rr}r%r%r&get_query_serializersz&SwaggerAutoSchema.get_query_serializercCsp||}|}g}|dk rh|j|tjd}ttt|tt|@dkrht d|j |j f||S)zdReturn the query parameters accepted by this view. :rtype: list[openapi.Parameter] NrVrzryour query_serializer contains fields that conflict with the filter_backend or paginator_class on the view - %s %s) Zget_filter_parametersZget_pagination_parametersr~rXrZIN_QUERYlensetrr rr)rZnatural_parametersr}Zserializer_parametersr%r%r&r2s  z&SwaggerAutoSchema.get_query_parameterscCs*|p|j}|jdd}|s&d|}|S)apReturn 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 pathdescribing the hierarchical layout of this view in the API; e.g. ``('snippets', 'list')``, ``('snippets', 'retrieve')``, etc. :rtype: str r'ri_)rr"rQrS)rrr'r%r%r&r42s   z"SwaggerAutoSchema.get_operation_idcCsXd}d}|dd}t|dkrP|d|d<t|d|krP|\}}|}||fS)aSDecide 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)rr(r)Zsummary_max_lensectionsr%r%r&split_summary_from_descriptionAs   z0SwaggerAutoSchema.split_summary_from_descriptioncCsl|jdd}|jdd}|dkrd|j|j|jp8d}|dd}|rd|dkrd||\}}||fS)zReturn an operation summary and description determined from the view's docstring. :return: summary and description :rtype: (str,str) Zoperation_descriptionNZoperation_summaryri ) r"rQrget_descriptionrrrreplacer)rr(r)r%r%r&r5Us z-SwaggerAutoSchema.get_summary_and_descriptioncCs|jddS)aTReturn 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 secuirty requirements. :return: security requirements :rtype: list[dict[str,list[str]]]r/Nr"rQrMr%r%r&r6gszSwaggerAutoSchema.get_securitycCs|jddS)zReturn ``True`` if this operation is to be marked as deprecated. :return: deprecation status :rtype: bool r0NrrMr%r%r&r:qszSwaggerAutoSchema.is_deprecatedcCs(|p|j}|jd}|s$|dg}|S)a Get 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 pathdescribing the hierarchical layout of this view in the API; e.g. ``('snippets', 'list')``, ``('snippets', 'retrieve')``, etc. :rtype: list[str] r.r)rr"rQ)rrr.r%r%r&r;ys   zSwaggerAutoSchema.get_tagscCs t|S)zTReturn the MIME types this endpoint can consume. :rtype: list[str] )r Zget_parser_classesrMr%r%r&r szSwaggerAutoSchema.get_consumescCs t|S)zTReturn the MIME types this endpoint can produce. :rtype: list[str] )rZget_renderer_classesrMr%r%r&rszSwaggerAutoSchema.get_produces)N)N)N)N)__name__ __module__ __qualname__rr?r1rNrUrDrHrIrJr3r<rhrrrerfr~r2r4rr5r6r:r;r r __classcell__r%r%r#r&rs2 "  $    r)logging collectionsrZrest_framework.requestrZrest_framework.schemasrZrest_framework.statusrrirerrorsr utilsr r r r rrrrrbaserr getLoggerrloggerrr%r%r%r&s      ,