+}&iXddlZddlZddlmZddlmZddlmZmZm Z m Z e Z ejeZdZddZGdd ZGd d eZGd d eZGddeZGddeZGddeZy)N) serializers)openapi)force_real_strget_field_defaultget_object_classes is_list_viewct||}tj|rt|ddr|dfSddlm}|t |||dt fS)N__self__Tr)getattr_static)getattrinspectismethodr isinstance staticmethod)cls_or_instance method_namemethodr s P/usr/local/footviz/venv/lib/python3.12/site-packages/drf_yasg/inspectors/base.pyis_callable_methodrsV _k 2FGFJ$Et|& : T:L ct||r t||\}}|r|S |rt||r t||S|S#t$r/tj dt |j |dYSwxYw)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.%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 )viewr fallback_attrdefault view_method is_callabales rcall_view_methodr%st[! (:4(M %K"}$}5t]++ N  NN%T ##   sA5A;:A;c,eZdZdZdZddZdZdZy) BaseInspectorcJ||_||_||_||_||_y)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)r pathr componentsrequest)selfr r)rr*r+s r__init__zBaseInspector.__init__Bs'   $ rc |S)aAfter 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,resultrobjkwargss rprocess_resultzBaseInspector.process_resultQs $ rNc |xsi}g}|D]}tj|sJdt|tsJd||j|j |j |j|jfi|}|j|t||d}|||fi|} | tusntjd|||d} t|D]}|j| ||fi|} | S)arProbe 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))risclass issubclassr'r r)rr*r+appendr NotHandledrrreversedr3) r, inspectorsrr1 initkwargsr2tried_inspectors inspectorrr0s rprobe_inspectorszBaseInspector.probe_inspectorses. %2 # I??9- : -i7 8 7"      I  # #I .Y T:F~C*6*FZ'/ 2 NNR   F!"23 RI-Y--fk3Q&QF R rcDtt|jddgS)zGet the renderer classes of this view by calling `get_renderers`. :return: renderer classes :rtype: list[type[rest_framework.renderers.BaseRenderer]] get_renderersrenderer_classesrr%r r,s rget_renderer_classesz"BaseInspector.get_renderer_classess$ " TYY9KR P  rcDtt|jddgS)zGet the parser classes of this view by calling `get_parsers`. :return: parser classes :rtype: list[type[rest_framework.parsers.BaseParser]] get_parsersparser_classesrBrCs rget_parser_classesz BaseInspector.get_parser_classess$ " TYY 7G L  rN)r __module__ __qualname__r-r3r>rDrHr/rrr'r'As (3j  rr'ceZdZdZdZdZy)PaginatorInspectorzBase inspector for paginators. Responsible for determining extra query parameters and response structure added by given paginators. ctS)a#Get 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] r8)r, paginators rget_paginator_parametersz+PaginatorInspector.get_paginator_parameters rctS)alAdd 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 rO)r,rPresponse_schemas rget_paginated_responsez)PaginatorInspector.get_paginated_responses rN)rrJrK__doc__rQrUr/rrrMrMs  rrMceZdZdZdZy)FilterInspectorzBase inspector for filter backends. Responsible for determining extra query parameters added by given filter backends. ctS)a6Get 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] rO)r,filter_backends rget_filter_parametersz%FilterInspector.get_filter_parametersrRrN)rrJrKrVr[r/rrrXrXs  rrXc:eZdZdZfdZdZdZdZdZxZ S)FieldInspectorz5Base inspector for serializers and serializer fields.cBtt| |||||||_yrI)superr]r-field_inspectors)r,r r)rr*r+r` __class__s rr-zFieldInspector.__init__s" nd,T4WU 0rct|dd}t|di}|r&|jD]\}}t|||yy)a^Set 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 MetaNswagger_schema_fields)r itemssetattr)r,serializer_or_fieldschemametardattrvals radd_manual_fieldsz FieldInspector.add_manual_fieldssS*FD9 '.Er J 288: + cc* + !rc tS)a1Convert 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 rOr,fieldswagger_object_typeuse_referencesr2s rfield_to_swagger_objectz&FieldInspector.field_to_swagger_objects &rc `|j|jd|d|jif||d|S)aHelper 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 rrr`)rprqr>r`rns rprobe_field_inspectorsz%FieldInspector.probe_field_inspectors sM%t$$  ! ! %  !6!6 7  !4)    rc  tjtjtjfvsJt tj rJdj rtj nd tjk(r nd tdd}|r t|ndtjk7rndd fd }tjk(rtjntj}||fS)aHelper method to extract generic information from a field and return a partial constructor for the appropriate openapi object. All arguments are the same as :meth:`.field_to_swagger_object`. The return value is a tuple consisting of: * a function for constructing objects of `swagger_object_type`; its prototype is: :: def SwaggerType(existing_object=None, **instance_kwargs): This function creates an instance of `swagger_object_type`, passing the following attributes to its init, in order of precedence: - arguments specified by the ``kwargs`` parameter of :meth:`._get_partial_types` - ``instance_kwargs`` passed to the constructor function - ``title``, ``description``, ``required``, ``x-nullable`` and ``default`` inferred from the field, where appropriate If ``existing_object`` is not ``None``, it is updated instead of creating a new object. * a type that should be used for child objects if `field` is of an array type. This can currently have two values: - :class:`.Schema` if `swagger_object_type` is :class:`.Schema` - :class:`.Items` if `swagger_object_type` is :class:`.Parameter` or :class:`.Items` :rtype: (function,type[openapi.Schema] or type[openapi.Items]) z,passed field is already a SwaggerDict objectN help_textcd|vr" tjk(rj|d<d|vr7 tjk7r$t }|dt j fvr||d<|r5|jddtjk7r|jd |jdtddrd|d<|j |?t| sJt|jD]\}}t||||}n d i|} tj k(r j#||S) Nrequiredr"rtitle description allow_nullT x_nullabler/)r ParameterryItemsrremptyget TYPE_ARRAY setdefaultr updatersortedrerfSchemarl) existing_objectuse_field_titleinstance_kwargsr"keyrkr0r{ror2r,rprzs r SwaggerTypez6FieldInspector._get_partial_types..SwaggerTypeOsG/1'7+<+<<.3nn +0'7==8+E24):):";;18OI. #''59K9KK**7E:&**=+FulD104 -  " "6 **!/3FGGG &'<'<'> ?7HCOS#67(,??#gnn4&&uf5Mr)NT) rrr~rr SwaggerDictlabelrr ) r,rorprqr2rwrchild_swagger_typer{rzs ``` ` @@r_get_partial_typesz!FieldInspector._get_partial_typessD#w~~w7H7H'--&XXXXeW%8%89 : 905{{u{{+(GNN:E E;5 3` r`filter_inspectorspaginator_inspectorsN)r_rr- overrides_prepend_inspector_overrides)r,r r)rr*r+rras rr-zViewInspector.__init__sP mT+D$ GT" ))*<= ))*=> ))*@Arc|jj|d}|r.t||Dcgc]}||vr| }}t||||zyycc}wrI)rrr rf)r,r:extra_inspectorsinspdefault_inspectorss rrz*ViewInspector._prepend_inspector_overridessk>>--j$? $D*5"//" " D*&69K&K L "s Actd)aGet 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()!)NotImplementedError)r,operation_keyss r get_operationzViewInspector.get_operations""QRRrcXt|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)r r)rr rCs rr zViewInspector.is_list_viewsDIIt{{DII>>rcr|jxr&|jj|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 )r rupperimplicit_list_response_methodsrCs rhas_list_responsezViewInspector.has_list_responses5  " KK   4#F#F F rcTt|jddxr|jS)zwDetermine whether filter backend parameters should be included for this request. :rtype: bool filter_backendsNr r rrCs r should_filterzViewInspector.should_filters& tyy"3T:Wt?U?U?WWrc|jsgSg}t|jdD]+}||j|jd|xsgz }-|S)zqReturn the parameters added to the view by its filter backends. :rtype: list[openapi.Parameter] rr[)rr r r>r)r,fieldsrZs rr[z#ViewInspector.get_filter_parametersso !!#I%dii1BC N %%**,C^EU  F  rcTt|jddxr|jS)zDetermine whether paging parameters and structure should be added to this operation's request and response. :rtype: bool rPNrrCs r should_pagezViewInspector.should_pages% tyy+t4Q9O9O9QQrc|jsgS|j|jdt|jdxsgS)zkReturn the parameters added to the view by its paginator. :rtype: list[openapi.Parameter] rQrP)rr>rr r rCs rget_pagination_parametersz'ViewInspector.get_pagination_parameterssN !I  ! !))* ;/     rcV|j|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 rr`rtrs rserializer_to_schemaz"ViewInspector.serializer_to_schemas4$$  ! !   !6!6 7   rcb|j|jd|d|ji|xsgS)a4Convert 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] rr`)rrtrs rserializer_to_parametersz&ViewInspector.serializer_to_parameters.sF  ! !%%(#T%:%:; "   rch|j|jdt|jd|S)a7Add 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 rUrP)rT)r>rr r )r,rTs rrUz$ViewInspector.get_paginated_responseAs9$$  % % $ DII{ ++ %  r)rrJrK body_methodsimplicit_body_methodsrr`rrr-rrr rrr[rrrrrUrrs@rrrsoL5&." BM S ?  X&R "   &  rr)NN)rloggingrest_frameworkrrutilsrrrr objectr8 getLoggerrrrr%r'rMrXr]rrr/rrrs&WWX   8 $ !Hk k \>m$^/]^/B.4s Ms r