a Šxdp\ã@s,ddlZddlZddlZddlmZmZddlZddlmZddl m Z m Z ddl m Z ddlmZddlmZddlmZmZdd lmZdd lmZd d lmZd d lmZd dlmZd dlm Z m!Z!m"Z"d dlm#Z#m$Z$d dl%m&Z&m'Z'm(Z(e )e*¡Z+e ,d¡Z-Gdd„deƒZGdd„de.ƒZ/dS)éN)Ú OrderedDictÚ defaultdict)Úurlparse)Ú URLPatternÚ URLResolver)Ú versioning)ÚSchemaGenerator)ÚEndpointEnumerator)Úendpoint_orderingÚ get_pk_name)Úget_pk_description)Ú api_settingsé)Úopenapi)Úswagger_settings)ÚSwaggerGenerationError)Úget_basic_type_infoÚget_queryset_fieldÚget_queryset_from_view)ÚReferenceResolverÚ SwaggerDict)Úforce_real_strÚ get_consumesÚ get_producesz{(?P\w+)}csZeZdZd‡fdd„ Z‡fdd„Zd‡fdd„ Zd d „Zdd d „Zd d„Zdd„Z ‡Z S)r Ncstt|ƒ ||¡||_dS©N)Úsuperr Ú__init__Úrequest)ÚselfÚpatternsÚurlconfr©Ú __class__©úK/var/www/html/Ranjet/env/lib/python3.9/site-packages/drf_yasg/generators.pyrszEndpointEnumerator.__init__cs,| d¡rt d|¡| tt|ƒ |¡¡S)Nú)zEurl pattern does not end in $ ('%s') - unexpected things might happen)ÚendswithÚloggerÚwarningÚ unescape_pathrr Úget_path_from_regex)rÚ path_regexr!r#r$r*!s  z&EndpointEnumerator.get_path_from_regexÚcsxtt|ƒ ||¡sdSt|jddƒ}t|jddƒ}|dur\t|tjƒr\|r\||  d¡vr\dSt|jdt ƒƒdurtdSdS)NFÚversionÚversioning_classú:Úswagger_schemaT) rr Úshould_include_endpointÚgetattrrÚclsÚ issubclassrZNamespaceVersioningÚsplitÚobject)rÚpathÚcallbackÚapp_nameÚ namespaceÚurl_namer-r.r!r#r$r1&sz*EndpointEnumerator.should_include_endpointcCsvt|jddƒ}|durrt|tjƒrrt|jddƒ}|rrt|ddƒ}d|}||vrft d|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) r2r3r4rZURLPathVersioningrr'ÚinfoÚreplace)rr7r8r.r-r<r#r#r$Úreplace_version5s  ÿ z"EndpointEnumerator.replace_versionc Cs`|dur|j}g}|dur tƒ}|D](}|t|jƒ}t|tƒràzz| |¡} |j} |j} |  | | |phd|pnd| ¡rº|  | | ¡} | |vrŒWq$|  | ¡|  | ¡D]} | | | f} |  | ¡q Wn tyÜtjdddYn0q$t|tƒr:|j|j||r d||jfn|j|r"d||jfn|j|d}| |¡q$t d t|ƒ¡¡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)rÚprefixr9r:Úignored_endpointszunknown pattern type {}©Úkey)rÚsetÚstrÚpatternÚ isinstancerr*r8Únamer1r@ÚaddZget_allowed_methodsÚappendÚ Exceptionr'r(rÚget_api_endpointsZ url_patternsr9r:ÚextendÚformatÚtypeÚsortedr )rrrBr9r:rCZ api_endpointsrHr+r7r8r;ÚmethodZendpointZnested_endpointsr#r#r$rNJsD        û  z$EndpointEnumerator.get_api_endpointscCst dd|¡S)zzUnescape all backslash escapes from `s`. :param str s: string with backslash escapes :rtype: str z\\(.)z\1)ÚreÚsub)rÚsr#r#r$Úunescape}szEndpointEnumerator.unescapecCsbd}|r^t |¡}|s&|| |¡7}q^|| |d| ¡…¡7}|| ¡7}|| ¡d…}q|S)aÔRemove backslashe 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_REÚsearchrWÚstartÚgroupÚend)rr7Z clean_pathÚmatchr#r#r$r)†s   z EndpointEnumerator.unescape_path)NNN)r,r,N)Nr,NNN) Ú__name__Ú __module__Ú __qualname__rr*r1r@rNrWr)Ú __classcell__r#r#r!r$r s  3 r c@sªeZdZdZeZeZd'dd„Ze dd„ƒZ dd „Z d d „Z d(d d„Z d)dd„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd „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,NcCsŠt|j|| dd¡||ƒ|_||_||_g|_g|_|durLtj durLtj }|r†t   |¡}|j dvsj|j srt dƒ‚|jr†t d|¡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)ÚhttpÚhttpsz%`url` must be an absolute HTTP(S) urlzKpath component of api base URL %s is ignored; use FORCE_SCRIPT_NAME instead)rÚtitleÚgetÚ_genr>r-ÚconsumesÚproducesrZDEFAULT_API_URLrÚschemeÚnetlocrr7r'r()rr>r-Úurlrr Ú parsed_urlr#r#r$r¦s zOpenAPISchemaGenerator.__init__cCs|jjSr)rhrm)rr#r#r$rmÇszOpenAPISchemaGenerator.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)rÚsecurity_definitionsr#r#r$Úget_security_definitionsËs 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|] }|gi‘qSr#r#)Ú.0Zsecurity_schemer#r#r$Ú âózDOpenAPISchemaGenerator.get_security_requirements..cSsg|]}t |i¡‘qSr#)rro)rrÚsrr#r#r$rsärtrD)rZSECURITY_REQUIREMENTSrRÚlist)rrpÚsecurity_requirementsr#r#r$Úget_security_requirementsØs  z0OpenAPISchemaGenerator.get_security_requirementsFc Cs¸| |¡}|jtjdd}ttjƒ|_ttj ƒ|_ |  ||||¡\}}|  ¡}|r^|  |¡}nd}|j} | dur€|dur€| ¡} tjf|j||jp”d|j pœd||| ||jdœ t|ƒ¤ŽS)aªGenerate 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>ÚpathsrirjrpÚsecurityÚ_urlÚ_prefixÚ_version)Ú get_endpointsÚreference_resolver_classrZSCHEMA_DEFINITIONSrr ZDEFAULT_PARSER_CLASSESrirZDEFAULT_RENDERER_CLASSESrjÚ get_pathsrqrxrmZbuild_absolute_uriZSwaggerr>r-Údict) rrÚpublicÚ endpointsÚ componentsryrBrprwrmr#r#r$Ú get_schemaès&    ýý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)rhÚ create_viewr2ÚitemsÚsetattrÚ__func__)rr8rSrÚviewÚ 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}ÚmodelNÚidr=)r2rr r?)rr7r‹rŽÚ field_namer#r#r$Ú coerce_paths z"OpenAPISchemaGenerator.coerce_pathc sˆ|j|jj|jj|d}| ¡}ttƒ}i‰|D]@\}}}| |||¡}| ||¡}||  ||f¡|j ˆ|<q0‡fdd„|  ¡DƒS)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|]\}}|ˆ||f“qSr#r#)rrr7Úmethods©Úview_clsr#r$Ú Artz8OpenAPISchemaGenerator.get_endpoints..) Úendpoint_enumerator_classrhrr rNrrvr‡r‘rLr3rˆ) rrZ enumeratorrƒZ view_pathsr7rSr8r‹r#r“r$r~/s  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] )rhZget_keys)rÚsubpathrSr‹r#r#r$Úget_operation_keysCsz)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 )rhÚdetermine_path_prefix©rryr#r#r$r™Tsz,OpenAPISchemaGenerator.determine_path_prefixcCs|p|j |||¡S)a†Check 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 )rhZhas_view_permissions)rr7rSr‹r‚r#r#r$r1hs z.OpenAPISchemaGenerator.should_include_endpointcCs tj|dS)zßConstruct 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)rÚPathsršr#r#r$Úget_paths_objecttsz'OpenAPISchemaGenerator.get_paths_objectc Csì|stjiddfS| t| ¡ƒ¡p(d}d|vs:Jdƒ‚tƒ}t| ¡ƒD]\}\}} i} | D]B\} } | || | |¡szq`|  | ||| ||¡} | dur`| | |   ¡<q`| rL|t |ƒd…}|  d¡sÊd|}|  ||| ¡||<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] r›r,Ú{z,base path cannot be templated in swagger 2.0Nú/)rrœr™rvÚkeysrrRrˆr1Ú get_operationÚlowerÚlenÚ startswithÚ get_path_itemr)rrƒr„rr‚rBryr7r”r’Ú operationsrSr‹Ú operationZ path_suffixr#r#r$r€}s&   z OpenAPISchemaGenerator.get_pathsc Cs¾| |t|ƒd…||¡}| ||¡}tj} t|d| ƒ} | d| ¡} | durPdS| |||||||ƒ} |  |¡} | durzdSd| vršt| j ƒt|j ƒkrš| ` d| vrºt| j ƒt|j ƒkrº| ` | S)a÷Get 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 Nr0Z auto_schemarirj) r˜r£Ú get_overridesrZDEFAULT_AUTO_SCHEMA_CLASSr2rgr¡rFrirj) rr‹r7rBrSr„rZoperation_keysrŒZview_inspector_clsZview_inspectorr§r#r#r$r¡¢s     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)rr7r”r¦Zpath_parametersr#r#r$r¥Ès 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†)r¢r2ÚcopyÚdeepcopy)rr‹rSr«Z action_methodrŒr#r#r$r¨Ôs   z$OpenAPISchemaGenerator.get_overridesc CsÜg}t|ƒ}tt |¡ƒD]¼}t||ƒ\}}t|ƒps.