a ΝGd\@s,ddlZddlZddlZddlmZddlmZmZddl Z ddl m Z m Z ddl mZddlmZddlmZddlmZmZddlmZdd lmZd d lmZd d lmZd d lmZd dl m!Z!m"Z"m#Z#d dlm$Z$m%Z%d dl&m'Z'm(Z(m)Z)e*e+Z,e-dZ.GdddeZGddde/Z0dS)N) OrderedDict defaultdict) URLPattern URLResolver) versioning)SchemaGenerator)EndpointEnumerator)endpoint_ordering get_pk_name)get_pk_description) api_settings)openapi)swagger_settings)SwaggerGenerationError)get_basic_type_infoget_queryset_fieldget_queryset_from_view)ReferenceResolver SwaggerDict)force_real_str get_consumes get_producesz{(?P\w+)}csZeZdZdfdd ZfddZdfdd Zd d Zdd d Zd dZddZ Z S)rNcstt|||||_dSN)superr__init__request)selfpatternsurlconfr __class__O/var/www/html/django/DPS/env/lib/python3.9/site-packages/drf_yasg/generators.pyrszEndpointEnumerator.__init__cs,|drtd||tt||S)N)zEurl pattern does not end in $ ('%s') - unexpected things might happen)endswithloggerwarning unescape_pathrrget_path_from_regex)r path_regexr r"r#r)!s  z&EndpointEnumerator.get_path_from_regexcsxtt|||sdSt|jdd}t|jdd}|dur\t|tjr\|r\|| dvr\dSt|jdt durtdSdS)NFversionversioning_class:swagger_schemaT) rrshould_include_endpointgetattrrcls issubclassrZNamespaceVersioningsplitobject)rpathcallbackapp_name namespaceurl_namer,r-r r"r#r0&sz*EndpointEnumerator.should_include_endpointcCsvt|jdd}|durrt|tjrrt|jdd}|rrt|dd}d|}||vrftd|j||f|||}|S)a"If ``request.version`` is not ``None`` and `callback` uses ``URLPathVersioning``, this function replaces the ``version`` parameter in `path` with the actual version. :param str path: the templated path :param callback: the view callback :rtype: str r-Nr, version_param{%s}z9view %s uses URLPathVersioning but URL %s has no param %s) r1r2r3rZURLPathVersioningrr&inforeplace)rr6r7r-r,r;r"r"r#replace_version5s   z"EndpointEnumerator.replace_versionc Cs`|dur|j}g}|dur t}|D](}|t|j}t|trzz||} |j} |j} | | | |phd|pnd| r| | | } | |vrWq$| | | | D]} | | | f} | | qWn tytjdddYn0q$t|tr:|j|j||r d||jfn|j|r"d||jfn|j|d}||q$tdt|q$t|td }|S) z Return a list of all available API endpoints by inspecting the URL conf. Copied entirely from super. Nr+zfailed to enumerate viewT)exc_infoz%s:%s)rprefixr8r9ignored_endpointszunknown pattern type {}key)rsetstrpattern isinstancerr)r7namer0r?addZget_allowed_methodsappend Exceptionr&r'rget_api_endpointsZ url_patternsr8r9extendformattypesortedr )rrrAr8r9rBZ api_endpointsrGr*r6r7r:methodZendpointZnested_endpointsr"r"r#rMJsD          z$EndpointEnumerator.get_api_endpointscCstdd|S)zzUnescape all backslash escapes from `s`. :param str s: string with backslash escapes :rtype: str z\\(.)z\1)resub)rsr"r"r#unescape}szEndpointEnumerator.unescapecCsbd}|r^t|}|s&|||7}q^|||d|7}||7}||d}q|S)aRemove backslashes escapes from all path components outside {parameters}. This is needed because ``simplify_regex`` does not handle this correctly. **NOTE:** this might destructively affect some url regex patterns that contain metacharacters (e.g. \w, \d) outside path parameter groups; if you are in this category, God help you :param str path: path possibly containing :return: the unescaped path :rtype: str r+N)PATH_PARAMETER_REsearchrVstartgroupend)rr6Z clean_pathmatchr"r"r#r(s   z EndpointEnumerator.unescape_path)NNN)r+r+N)Nr+NNN) __name__ __module__ __qualname__rr)r0r?rMrVr( __classcell__r"r"r r#rs  3 rc@seZdZdZeZeZd'ddZe ddZ dd Z d d Z d(d dZ d)ddZddZddZddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&ZdS)*OpenAPISchemaGeneratorz This class iterates over all registered API endpoints and returns an appropriate OpenAPI 2.0 compliant schema. Method implementations shamelessly stolen and adapted from rest-framework ``SchemaGenerator``. r+NcCst|j||dd|||_||_||_g|_g|_|durLtj durLtj }|rt |}|j dvsj|j srt d|jrtd|n||j_dS)a :param openapi.Info info: information about the API :param str version: API version string; if omitted, `info.default_version` will be used :param str url: API scheme, host and port; if ``None`` is passed and ``DEFAULT_API_URL`` is not set, the url will be inferred from the request made against the schema view, so you should generally not need to set this parameter explicitly; if the empty string is passed, no host and scheme will be emitted If `url` is not ``None`` or the empty string, it must be a scheme-absolute uri (i.e. starting with http:// or https://), and any path component is ignored; See also: :ref:`documentation on base URL construction ` :param patterns: if given, only these patterns will be enumerated for inclusion in the API spec :param urlconf: if patterns is not given, use this urlconf to enumerate patterns; if not given, the default urlconf is used descriptionr+N)httphttpsz%`url` must be an absolute HTTP(S) urlzKpath component of api base URL %s is ignored; use FORCE_SCRIPT_NAME instead)rtitleget_genr=r,consumesproducesrZDEFAULT_API_URLurlparseschemenetlocrr6r&r'url)rr=r,rmrr parsed_urlr"r"r#rs zOpenAPISchemaGenerator.__init__cCs|jjSr)rgrm)rr"r"r#rmszOpenAPISchemaGenerator.urlcCstj}|durt|i}|S)aGet the security schemes for this API. This determines what is usable in security requirements, and helps clients configure their authorization credentials. :return: the security schemes usable with this API :rtype: dict[str,dict] or None N)rZSECURITY_DEFINITIONSr _as_odict)rsecurity_definitionsr"r"r#get_security_definitionss z/OpenAPISchemaGenerator.get_security_definitionscCs:tj}|durdd|D}dd|D}t|td}|S)ajGet the base (global) security requirements of the API. This is never called if :meth:`.get_security_definitions` returns `None`. :param security_definitions: security definitions as returned by :meth:`.get_security_definitions` :return: the security schemes accepted by default :rtype: list[dict[str,list[str]]] or None NcSsg|] }|giqSr"r").0Zsecurity_schemer"r"r# zDOpenAPISchemaGenerator.get_security_requirements..cSsg|]}t|iqSr")rro)rrsrr"r"r#rsrtrC)rZSECURITY_REQUIREMENTSrQlist)rrpsecurity_requirementsr"r"r#get_security_requirementss  z0OpenAPISchemaGenerator.get_security_requirementsFc Cs||}|jtjdd}ttj|_ttj |_ | ||||\}}| }|r^| |}nd}|j} | dur|dur|} tjf|j||jpd|j pd||| ||jd t|S)aGenerate a :class:`.Swagger` object representing the API schema. :param request: the request used for filtering accessible endpoints and finding the spec URI :type request: rest_framework.request.Request or None :param bool public: if True, all endpoints are included regardless of access through `request` :return: the generated Swagger specification :rtype: openapi.Swagger T)Z force_initN) r=pathsrhrirpsecurity_url_prefix_version) get_endpointsreference_resolver_classrZSCHEMA_DEFINITIONSrr ZDEFAULT_PARSER_CLASSESrhrZDEFAULT_RENDERER_CLASSESri get_pathsrqrxrmZbuild_absolute_uriZSwaggerr=r,dict) rrpublic endpoints componentsryrArprwrmr"r"r# get_schemas&    z!OpenAPISchemaGenerator.get_schemacCsh|j|||}t|dd}|durX|D]*\}}t||d}|dur,t|jd|q,t|dd|S)aPCreate a view instance from a view callback as registered in urlpatterns. :param callback: view callback registered in urlpatterns :param str method: HTTP method :param request: request to bind to the view :type request: rest_framework.request.Request or None :return: the view instance _swagger_auto_schemaNZswagger_fake_viewT)rg create_viewr1itemssetattr__func__)rr7rRrview overrides_Z view_methodr"r"r#r s    z"OpenAPISchemaGenerator.create_viewcCs>d|vr |Stt|dd}|r*t|}nd}|dd|S)aKCoerce {pk} path arguments into the name of the model field, where possible. This is cleaner for an external representation (i.e. "this is an identifier", not "this is a database primary key"). :param str path: the path :param rest_framework.views.APIView view: associated view :rtype: str z{pk}modelNidr<)r1rr r>)rr6rr field_namer"r"r# coerce_paths z"OpenAPISchemaGenerator.coerce_pathc s|j|jj|jj|d}|}tt}i|D]@\}}}||||}|||}|| ||f|j |<q0fdd| DS)aIterate over all the registered endpoints in the API and return a fake view with the right parameters. :param request: request to bind to the endpoint views :type request: rest_framework.request.Request or None :return: {path: (view_class, list[(http_method, view_instance)]) :rtype: dict[str,(type,list[(str,rest_framework.views.APIView)])] )rcsi|]\}}|||fqSr"r")rrr6methodsview_clsr"r# Crtz8OpenAPISchemaGenerator.get_endpoints..) endpoint_enumerator_classrgrrrMrrvrrrKr2r) rrZ enumeratorrZ view_pathsr6rRr7rr"rr#r~1s  z$OpenAPISchemaGenerator.get_endpointscCs|j|||S)aXReturn a list of keys that should be used to group an operation within the specification. :: /users/ ("users", "list"), ("users", "create") /users/{pk}/ ("users", "read"), ("users", "update"), ("users", "delete") /users/enabled/ ("users", "enabled") # custom viewset list action /users/{pk}/star/ ("users", "star") # custom viewset detail action /users/{pk}/groups/ ("users", "groups", "list"), ("users", "groups", "create") /users/{pk}/groups/{pk}/ ("users", "groups", "read"), ("users", "groups", "update") :param str subpath: path to the operation with any common prefix/base path removed :param str method: HTTP method :param view: the view associated with the operation :rtype: list[str] )rgZget_keys)rsubpathrRrr"r"r#get_operation_keysEsz)OpenAPISchemaGenerator.get_operation_keyscCs |j|S)a Given a list of all paths, return the common prefix which should be discounted when generating a schema structure. This will be the longest common string that does not include that last component of the URL, or the last component before a path parameter. For example: :: /api/v1/users/ /api/v1/users/{pk}/ The path prefix is ``/api/v1/``. :param list[str] paths: list of paths :rtype: str )rgdetermine_path_prefixrryr"r"r#rVsz,OpenAPISchemaGenerator.determine_path_prefixcCs|p|j|||S)aCheck if a given endpoint should be included in the resulting schema. :param str path: request path :param str method: http request method :param view: instantiated view callback :param bool public: if True, all endpoints are included regardless of access through `request` :returns: true if the view should be excluded :rtype: bool )rgZhas_view_permissions)rr6rRrrr"r"r#r0js z.OpenAPISchemaGenerator.should_include_endpointcCs tj|dS)zConstruct the Swagger Paths object. :param OrderedDict[str,openapi.PathItem] paths: mapping of paths to :class:`.PathItem` objects :returns: the :class:`.Paths` object :rtype: openapi.Paths ry)rPathsrr"r"r#get_paths_objectvsz'OpenAPISchemaGenerator.get_paths_objectc Cs|stjiddfS|t|p(d}d|vs:Jdt}t|D]\}\}} i} | D]B\} } ||| | |szq`| | ||| ||} | dur`| | | <q`| rL|t |d}| dsd|}| ||| ||<qL|||fS)a+Generate the Swagger Paths for the API from the given endpoints. :param dict endpoints: endpoints as returned by get_endpoints :param ReferenceResolver components: resolver/container for Swagger References :param Request request: the request made against the schema view; can be None :param bool public: if True, all endpoints are included regardless of access through `request` :returns: the :class:`.Paths` object and the longest common path prefix, as a 2-tuple :rtype: tuple[openapi.Paths,str] rr+{z,base path cannot be templated in swagger 2.0N/)rrrrvkeysrrQrr0 get_operationlowerlen startswith get_path_itemr)rrrrrrAryr6rr operationsrRr operationZ path_suffixr"r"r#rs&   z OpenAPISchemaGenerator.get_pathsc Cs||t|d||}|||}tj} t|d| } |d| } | durPdS| |||||||} | |} | durzdSd| vrt| j t|j kr| ` d| vrt| j t|j kr| ` | S)aGet an :class:`.Operation` for the given API endpoint (path, method). This method delegates to :meth:`~.inspectors.ViewInspector.get_operation` of a :class:`~.inspectors.ViewInspector` determined according to settings and :func:`@swagger_auto_schema <.swagger_auto_schema>` overrides. :param view: the view associated with this endpoint :param str path: the path component of the operation URL :param str prefix: common path prefix among all endpoints :param str method: the http method of the operation :param openapi.ReferenceResolver components: referenceable components :param Request request: the request made against the schema view; can be None :rtype: openapi.Operation Nr/Z auto_schemarhri) rr get_overridesrZDEFAULT_AUTO_SCHEMA_CLASSr1rfrrErhri) rrr6rArRrrZoperation_keysrZview_inspector_clsZview_inspectorrr"r"r#rs     z$OpenAPISchemaGenerator.get_operationcCs |||}tjfd|i|S)aGet a :class:`.PathItem` object that describes the parameters and operations related to a single path in the API. :param str path: the path :param type view_cls: the view that was bound to this path in urlpatterns :param dict[str,openapi.Operation] operations: operations defined on this path, keyed by lowercase HTTP method :rtype: openapi.PathItem parameters)get_path_parametersrZPathItem)rr6rrZpath_parametersr"r"r#rs z$OpenAPISchemaGenerator.get_path_itemcCsF|}t|d|}t||d}t|di}||vr<||}t|S)a"Get overrides specified for a given operation. :param view: the view associated with the operation :param str method: HTTP method :return: a dictionary containing any overrides set by :func:`@swagger_auto_schema <.swagger_auto_schema>` :rtype: dict actionNr)rr1copydeepcopy)rrrRrZ action_methodrr"r"r#rs   z$OpenAPISchemaGenerator.get_overridesc Csg}t|}tt|D]}t||\}}t|ps.