a ΝGdR@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 rT/var/www/html/django/DPS/env/lib/python3.9/site-packages/drf_yasg/inspectors/base.pyis_callable_methods   rcCsnt||rRzt||\}}|r&|WSWn(tyPtjdt|jddYn0|rjt||rjt||S|S)aCall a view method which might throw an exception. If an exception is thrown, log an informative error message and return the value of fallback_attr, or default if not present. The method must be callable without any arguments except cls or self. :param view: view class or instance; if a class is passed, instance methods won't be called :type view: rest_framework.views.APIView or type[rest_framework.views.APIView] :param str method_name: name of a method on the view :param str fallback_attr: name of an attribute on the view to fall back on, if calling the method fails :param default: default value if all else fails :return: view method's return value, or value of view's fallback_attr, or default :rtype: any or None zview's %s raised exception during schema generation; use `getattr(self, 'swagger_fake_view', False)` to detect and short-circuit thisT)exc_info)hasattrr Exceptionloggerwarningtype__name__r )viewrZ fallback_attrdefaultZ view_methodZ is_callabalerrrcall_view_methods     rc@s6eZdZddZddZd ddZdd Zd d ZdS) BaseInspectorcCs"||_||_||_||_||_dS)a :param rest_framework.views.APIView view: the view associated with this endpoint :param str path: the path component of the operation URL :param str method: the http method of the operation :param openapi.ReferenceResolver components: referenceable components :param rest_framework.request.Request request: the request made against the schema view; can be None N)rpathr componentsrequest)selfrr rr!r"rrr__init__7s zBaseInspector.__init__cKs|S)apAfter an inspector handles an object (i.e. returns a value other than :data:`.NotHandled`), all inspectors that were probed get the chance to alter the result, in reverse order. The inspector that handled the object is the first to receive a ``process_result`` call with the object it just returned. This behavior is similar to the Django request/response middleware processing. If this inspector has no post-processing to do, it should just ``return result`` (the default implementation). :param result: the return value of the winning inspector, or ``None`` if no inspector handled the object :param str method_name: name of the method that was called on the inspector :param obj: first argument passed to inspector method :param kwargs: additional arguments passed to inspector method :return: r)r#resultrobjkwargsrrrprocess_resultEszBaseInspector.process_resultNc Ks|pi}g}|D]}t|s&Jdt|ts8Jd||j|j|j|j|jfi|}| |t ||d}|durzq||fi|} | t urqqt d|||d} t|D]}|j| ||fi|} q| S)afProbe a list of inspectors with a given object. The first inspector in the list to return a value that is not :data:`.NotHandled` wins. :param list[type[BaseInspector]] inspectors: list of inspectors to probe :param str method_name: name of the target method on the inspector :param obj: first argument to inspector method :param dict initkwargs: extra kwargs for instantiating inspector class :param kwargs: additional arguments to inspector method :return: the return value of the winning inspector, or ``None`` if no inspector handled the object z(inspector must be a class, not an objectz&inspectors must subclass BaseInspectorNz@%s ignored because no inspector in %s handled it (operation: %s))r isclass issubclassrrr rr!r"appendr NotHandledrrreversedr() r# inspectorsrr&Z initkwargsr'Ztried_inspectorsZ inspectorrr%rrrprobe_inspectorsVs( "   zBaseInspector.probe_inspectorscCstt|jddgS)zGet the renderer classes of this view by calling `get_renderers`. :return: renderer classes :rtype: list[type[rest_framework.renderers.BaseRenderer]] Z get_renderersZrenderer_classesrrrr#rrrget_renderer_classes{sz"BaseInspector.get_renderer_classescCstt|jddgS)zGet the parser classes of this view by calling `get_parsers`. :return: parser classes :rtype: list[type[rest_framework.parsers.BaseParser]] Z get_parsersZparser_classesr0r1rrrget_parser_classessz BaseInspector.get_parser_classes)N)r __module__ __qualname__r$r(r/r2r3rrrrr6s  %rc@s eZdZdZddZddZdS)PaginatorInspectorzBase inspector for paginators. Responsible for determining extra query parameters and response structure added by given paginators. cCstS)aGet the pagination parameters for a single paginator **instance**. Should return :data:`.NotHandled` if this inspector does not know how to handle the given `paginator`. :param BasePagination paginator: the paginator :rtype: list[openapi.Parameter] r,)r# paginatorrrrget_paginator_parameterssz+PaginatorInspector.get_paginator_parameterscCstS)adAdd appropriate paging fields to a response :class:`.Schema`. Should return :data:`.NotHandled` if this inspector does not know how to handle the given `paginator`. :param BasePagination paginator: the paginator :param openapi.Schema response_schema: the response schema that must be paged. :rtype: openapi.Schema r7)r#r8response_schemarrrget_paginated_responses z)PaginatorInspector.get_paginated_responseN)rr4r5__doc__r9r;rrrrr6s r6c@seZdZdZddZdS)FilterInspectorzBase inspector for filter backends. Responsible for determining extra query parameters added by given filter backends. cCstS)a.Get the filter parameters for a single filter backend **instance**. Should return :data:`.NotHandled` if this inspector does not know how to handle the given `filter_backend`. :param BaseFilterBackend filter_backend: the filter backend :rtype: list[openapi.Parameter] r7)r#filter_backendrrrget_filter_parameterssz%FilterInspector.get_filter_parametersN)rr4r5r<r?rrrrr=sr=cs@eZdZdZfddZddZddZdd Zd d ZZ S) FieldInspectorz6Base inspector for serializers and serializer fields. cs"tt||||||||_dS)N)superr@r$field_inspectors)r#rr rr!r"rB __class__rrr$szFieldInspector.__init__cCs>t|dd}t|di}|r:|D]\}}t|||q$dS)aVSet fields from the ``swagger_schema_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_fieldZschemametarEattrvalrrradd_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 r7r#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 rPrB)rNrOr/rBrLrrrprobe_field_inspectorssz%FieldInspector.probe_field_inspectorsc stjtjtjfvsJttjr,Jdjr.SwaggerType)NT) rr_rWrXrZ SwaggerDictlabelrr )r#rMrNrOr'rSrbZchild_swagger_typerrar_get_partial_typess "z!FieldInspector._get_partial_types) rr4r5r<r$rKrPrRrd __classcell__rrrCrr@s    r@c@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 r7r# serializerrrr get_schema6szSerializerInspector.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] r7r#rhin_rrrget_request_parameters@s z*SerializerInspector.get_request_parametersN)rr4r5rirlrrrrrf5s rfcseZdZdZdZdZgZgZgZfddZ ddZ dd Z d d Z d d Z ddZddZddZddZddZddZddZZS) ViewInspector)PUTPATCHPOSTDELETE)rnrorp)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>` rBfilter_inspectorspaginator_inspectorsN)rArmr$ overrides_prepend_inspector_overrides)r#rr rr!r"rurCrrr$Zs   zViewInspector.__init__cs>|j|dr:fddt||D}t|||dS)Ncsg|]}|vr|qSrr).0ZinspZextra_inspectorsrr iz>ViewInspector._prepend_inspector_overrides..)rurZr rG)r#r.Zdefault_inspectorsrrxrrvfsz*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_operationlszViewInspector.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 response (: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 rrr1rrrrvszViewInspector.is_list_viewcCs|o|j|jvS)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_methodsr1rrrhas_list_responseszViewInspector.has_list_responsecCst|jddo|S)zoDetermine whether filter backend parameters should be included for this request. :rtype: bool filter_backendsNr rrr1rrr 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 rr/rs)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 r8Nrr1rrr should_pageszViewInspector.should_pagecCs(|s gS||jdt|jdp&gS)zkReturn the parameters added to the view by its paginator. :rtype: list[openapi.Parameter] r9r8)rr/rtr rr1rrrget_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 rirBrQrgrrrserializer_to_schemasz"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] rlrB)rkrQrjrrrserializer_to_parameterss z&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;r8)r:)r/rtr r)r#r:rrrr;s  z$ViewInspector.get_paginated_response)rr4r5Z body_methodsZimplicit_body_methodsr~rBrsrtr$rvr|rrrr?rrrrr;rerrrCrrmLs$      rm)NN)r loggingZrest_frameworkrrutilsrrrrobjectr, getLoggerrrrrrr6r=r@rfrmrrrrs    V|