U ǽbR@sddlZddlZddlmZddlmZddlmZmZm Z m Z e Z e eZddZddd ZGd d d e ZGd d d eZGdddeZGdddeZGdddeZGdddeZdS)N) serializers)openapi)force_real_strget_field_defaultget_object_classes is_list_viewcCsJt||}t|r(t|ddr(|dfSddlm}|t|||dtfS)N__self__Tr)getattr_static)getattrinspectismethodr isinstance staticmethod)Zcls_or_instance method_namemethodr rsr>cs@eZdZdZfddZddZddZdd Zd d ZZ S) FieldInspectorz6Base inspector for serializers and serializer fields. cs"tt||||||||_dS)N)superrAr$field_inspectors)r#rr rr!r"rC __class__rrr$szFieldInspector.__init__cCs>t|dd}t|di}|r:|D]\}}t|||q$dS)aUSet fields from the ``swagger_schem_fields`` attribute on the Meta class. This method is called only for serializers or fields that are converted into ``openapi.Schema`` objects. :param serializer_or_field: serializer or field instance :param openapi.Schema schema: the schema object to be modified in-place ZMetaNswagger_schema_fields)r itemssetattr)r#Zserializer_or_fieldZschemametarFattrvalrrradd_manual_fieldss   z FieldInspector.add_manual_fieldscKstS)aConvert a drf Serializer or Field instance into a Swagger object. Should return :data:`.NotHandled` if this inspector does not know how to handle the given `field`. :param rest_framework.serializers.Field field: the source field :param type[openapi.SwaggerDict] swagger_object_type: should be one of Schema, Parameter, Items :param bool use_references: if False, forces all objects to be declared inline instead of by referencing other components :param kwargs: extra attributes for constructing the object; if swagger_object_type is Parameter, ``name`` and ``in_`` should be provided :return: the swagger object :rtype: openapi.Parameter or openapi.Items or openapi.Schema or openapi.SchemaRef r8r#fieldswagger_object_typeuse_referencesr'rrrfield_to_swagger_objectsz&FieldInspector.field_to_swagger_objectcKs&|j|jd|d|jif||d|S)zHelper method for recursively probing `field_inspectors` to handle a given field. All arguments are the same as :meth:`.field_to_swagger_object`. :rtype: openapi.Parameter or openapi.Items or openapi.Schema or openapi.SchemaRef rQrC)rOrPr0rCrMrrrprobe_field_inspectorssz%FieldInspector.probe_field_inspectorsc stjtjtjfkstttjr,tdjr.SwaggerType)NT) rr`rXrYr*rZ SwaggerDictlabelrr )r#rNrOrPr'rTrcZchild_swagger_typerrbr_get_partial_typess !z!FieldInspector._get_partial_types) rr5r6r=r$rLrQrSre __classcell__rrrDrrAs    rAc@seZdZddZddZdS)SerializerInspectorcCstS)a-Convert a DRF Serializer instance to an :class:`.openapi.Schema`. Should return :data:`.NotHandled` if this inspector does not know how to handle the given `serializer`. :param serializers.BaseSerializer serializer: the ``Serializer`` instance :rtype: openapi.Schema r8r# serializerrrr get_schema5szSerializerInspector.get_schemacCstS)aConvert a DRF serializer into a list of :class:`.Parameter`\ s. Should return :data:`.NotHandled` if this inspector does not know how to handle the given `serializer`. :param serializers.BaseSerializer serializer: the ``Serializer`` instance :param str in_: the location of the parameters, one of the `openapi.IN_*` constants :rtype: list[openapi.Parameter] r8r#riin_rrrget_request_parameters?s z*SerializerInspector.get_request_parametersN)rr5r6rjrmrrrrrg4s rgcseZdZdZdZdZgZgZgZfddZ ddZ dd Z d d Z d d Z ddZddZddZddZddZddZddZZS) ViewInspector)PUTPATCHPOSTDELETE)rorprq)GETcs@tt||||||||_|d|d|ddS)z Inspector class responsible for providing :class:`.Operation` definitions given a view, path and method. :param dict overrides: manual overrides as passed to :func:`@swagger_auto_schema <.swagger_auto_schema>` rCfilter_inspectorspaginator_inspectorsN)rBrnr$ overrides_prepend_inspector_overrides)r#rr rr!r"rvrDrrr$Ys   zViewInspector.__init__cs>|j|dr:fddt||D}t|||dS)Ncsg|]}|kr|qSrr).0ZinspZextra_inspectorsrr hsz>ViewInspector._prepend_inspector_overrides..)rvr[r rH)r#r/Zdefault_inspectorsrryrrwesz*ViewInspector._prepend_inspector_overridescCs tddS)awGet an :class:`.Operation` for the given API endpoint (path, method). This includes query, body parameters and response schemas. :param tuple[str] operation_keys: an array of keys describing the hierarchical layout of this view in the API; e.g. ``('snippets', 'list')``, ``('snippets', 'retrieve')``, etc. :rtype: openapi.Operation z-ViewInspector must implement get_operation()!N)NotImplementedError)r#Zoperation_keysrrr get_operationkszViewInspector.get_operationcCst|j|j|jS)aDetermine whether this view is a list or a detail view. The difference between the two is that detail views depend on a pk/id path parameter. Note that a non-detail view does not necessarily imply a list reponse (:meth:`.has_list_response`), nor are list responses limited to non-detail views. For example, one might have a `/topic//posts` endpoint which is a detail view that has a list response. :rtype: bool)rr rrr2rrrruszViewInspector.is_list_viewcCs|o|j|jkS)zDetermine whether this view returns multiple objects. By default this is any non-detail view (see :meth:`.is_list_view`) whose request method is one of :attr:`.implicit_list_response_methods`. :rtype: bool )rrupperimplicit_list_response_methodsr2rrrhas_list_responseszViewInspector.has_list_responsecCst|jddo|S)zoDetermine whether filter backend parameters should be included for this request. :rtype: bool filter_backendsNr rrr2rrr should_filterszViewInspector.should_filtercCs@|s gSg}t|jdD]}|||jd|p6g7}q|S)zqReturn the parameters added to the view by its filter backends. :rtype: list[openapi.Parameter] rr@)rr rr0rt)r#fieldsr?rrrr@s z#ViewInspector.get_filter_parameterscCst|jddo|S)zDetermine whether paging parameters and structure should be added to this operation's request and response. :rtype: bool r9Nrr2rrr should_pageszViewInspector.should_pagecCs(|s gS||jdt|jdp&gS)zkReturn the parameters added to the view by its paginator. :rtype: list[openapi.Parameter] r:r9)rr0rur rr2rrrget_pagination_parameterss  z'ViewInspector.get_pagination_parameterscCs||jd|d|jiS)a#Convert a serializer to an OpenAPI :class:`.Schema`. :param serializers.BaseSerializer serializer: the ``Serializer`` instance :returns: the converted :class:`.Schema`, or ``None`` in case of an unknown serializer :rtype: openapi.Schema or openapi.SchemaRef rjrCrRrhrrrserializer_to_schemas z"ViewInspector.serializer_to_schemacCs |j|jd|d|ji|dpgS)a(Convert a serializer to a possibly empty list of :class:`.Parameter`\ s. :param serializers.BaseSerializer serializer: the ``Serializer`` instance :param str in_: the location of the parameters, one of the `openapi.IN_*` constants :rtype: list[openapi.Parameter] rmrC)rlrRrkrrrserializer_to_parameterssz&ViewInspector.serializer_to_parameterscCs|j|jdt|jd|dS)a+Add appropriate paging fields to a response :class:`.Schema`. :param openapi.Schema response_schema: the response schema that must be paged. :returns: the paginated response class:`.Schema`, or ``None`` in case of an unknown pagination scheme :rtype: openapi.Schema r<r9)r;)r0rur r)r#r;rrrr<s  z$ViewInspector.get_paginated_response)rr5r6Z body_methodsZimplicit_body_methodsr~rCrtrur$rwr|rrrr@rrrrr<rfrrrDrrnKs$      rn)NN)r loggingZrest_frameworkrrutilsrrrrobjectr- getLoggerrrrrrr7r>rArgrnrrrrs    V{