o hp\@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,dZ-GdddeZGddde.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_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)r Ncstt|||||_dSN)superr __init__request)selfpatternsurlconfr __class__[/var/www/html/magazine_api/magazine_env/lib/python3.10/site-packages/drf_yasg/generators.pyrs zEndpointEnumerator.__init__cs,|dr td||tt||S)N)zEurl pattern does not end in $ ('%s') - unexpected things might happen)endswithloggerwarning unescape_pathrr get_path_from_regex)r path_regexr!r#r$r*!s  z&EndpointEnumerator.get_path_from_regexcsxtt|||s dSt|jdd}t|jdd}|dur.t|tjr.|r.|| dvr.dSt|jdt dur:dSdS)NFversionversioning_class:swagger_schemaT) rr should_include_endpointgetattrrcls issubclassrZNamespaceVersioningsplitobject)rpathcallbackapp_name namespaceurl_namer-r.r!r#r$r1&sz*EndpointEnumerator.should_include_endpointcCsvt|jdd}|dur9t|tjr9t|jdd}|r9t|dd}d|}||vr3td|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'inforeplace)rr7r8r.r-r<r#r#r$replace_version5s   z"EndpointEnumerator.replace_versionc CsV|dur|j}g}|durt}|D]}|t|j}t|trnz=||} |j} |j} | | | |p3d|p6d| r\| | | } | |vrEWq| | | | D] } | | | f} | | qOWqtymtjdddYqwt|tr|j|j||rd||jfn|j|rd||jfn|j|d}||qtdt|qt|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)rprefixr9r:ignored_endpointszunknown pattern type {}key)rsetstrpattern isinstancerr*r8namer1r@addZget_allowed_methodsappend Exceptionr'r(rget_api_endpointsZ url_patternsr9r:extendformattypesortedr )rrrBr9r:rCZ api_endpointsrHr+r7r8r;methodZendpointZnested_endpointsr#r#r$rNJsH          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.unescapecCshd}|r2t|}|s|||7} |S|||d|7}||7}||d}|s|S)aRemove 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_REsearchrWstartgroupend)rr7Z clean_pathmatchr#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@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|_|dur&tj dur&tj }|rEt |}|j dvs5|j s9t d|jrGtd|dSdSdS)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_URLrschemenetlocrr7r'r()rr>r-urlrr parsed_urlr#r#r$rs zOpenAPISchemaGenerator.__init__cCs|jjSr)rhrm)rr#r#r$rmszOpenAPISchemaGenerator.urlcCstj}|dur t|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$ szDOpenAPISchemaGenerator.get_security_requirements..cSsg|]}t|iqSr#)rro)rrsrr#r#r$rssrD)rZSECURITY_REQUIREMENTSrRlist)rrpsecurity_requirementsr#r#r$get_security_requirementss  z0OpenAPISchemaGenerator.get_security_requirementsFc Cs||}|jtjdd}ttj|_ttj |_ | ||||\}}| }|r/| |}nd}|j} | dur@|dur@|} tjd|j||jpJd|j pNd||| ||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>pathsrirjrpsecurity_url_prefix_versionr#) get_endpointsreference_resolver_classrZSCHEMA_DEFINITIONSrr ZDEFAULT_PARSER_CLASSESrirZDEFAULT_RENDERER_CLASSESrj get_pathsrqrwrmZbuild_absolute_uriZSwaggerr>r-dict) rrpublic endpoints componentsrxrBrprvrmr#r#r$ get_schemas&    z!OpenAPISchemaGenerator.get_schemacCsh|j|||}t|dd}|dur,|D]\}}t||d}|dur+t|jd|qt|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_viewr2itemssetattr__func__)rr8rSrview overrides_Z view_methodr#r#r$rs   z"OpenAPISchemaGenerator.create_viewcCs>d|vr|Stt|dd}|rt|}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=)r2rr r?)rr7rr field_namer#r#r$ coerce_paths z"OpenAPISchemaGenerator.coerce_pathc s|j|jj|jj|d}|}tt}i|D] \}}}||||}|||}|| ||f|j |<qfdd| 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#)rrr7methodsview_clsr#r$ Asz8OpenAPISchemaGenerator.get_endpoints..) endpoint_enumerator_classrhrr rNrrurrrLr3r) rrZ enumeratorrZ view_pathsr7rSr8rr#rr$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)rsubpathrSrr#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 )rhdetermine_path_prefixrrxr#r#r$rTs z,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 )rhZhas_view_permissions)rr7rSrrr#r#r$r1hs 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 rx)rPathsrr#r#r$get_paths_objectts z'OpenAPISchemaGenerator.get_paths_objectc Cs|s tjiddfS|t|pd}d|vsJdt}t|D]H\}\}} i} | D]!\} } ||| | |s=q0| | ||| ||} | durQ| | | <q0| rn|t |d}| dsed|}| ||| ||<q&|||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/)rrrrukeysrrRrr1 get_operationlowerlen startswith get_path_itemr)rrrrrrBrxr7rr operationsrSr operationZ path_suffixr#r#r$r}s*    z OpenAPISchemaGenerator.get_pathsc Cs||t|d||}|||}tj} t|d| } |d| } | dur(dS| |||||||} | |} | dur=dSd| vrMt| j t|j krM| ` d| vr]t| 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 Nr0Z auto_schemarirj) rr get_overridesrZDEFAULT_AUTO_SCHEMA_CLASSr2rgrrFrirj) rrr7rBrSrrZoperation_keysrZview_inspector_clsZview_inspectorrr#r#r$rs     z$OpenAPISchemaGenerator.get_operationcCs |||}tjdd|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 parametersNr#)get_path_parametersrZPathItem)rr7rrZpath_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)rr2copydeepcopy)rrrSrZ action_methodrr#r#r$rs    z$OpenAPISchemaGenerator.get_overridesc Csg}t|}tt|D]^}t||\}}t|pdtji}t|dd|kr:|dtjkr:t|d| dd|d<|rFt|ddrF|j } n|rTt|ddrTt ||} nd} tj d |t | d tjd |} || q |S) aReturn a list of Parameter instances corresponding to any templated path variables. :param str path: templated request path :param type view_cls: the view class associated with the path :return: path parameters :rtype: list[openapi.Parameter] rQZ lookup_fieldNZlookup_value_regexrH help_textFZ primary_keyT)rJrcrequiredin_r#)rrR uritemplate variablesrrrZ TYPE_STRINGr2rgrr ParameterrZIN_PATHrL) rr7rrZquerysetvariablerZ model_fieldattrsrcfieldr#r#r$rs,  z*OpenAPISchemaGenerator.get_path_parameters)r,NNN)NFr)r^r_r`__doc__r rrr~rpropertyrmrqrwrrrr}rrr1rrrrrrr#r#r#r$rbs, !     %& rb)0rloggingrT collectionsrrrZcoreapi.compatrZ django.urlsrrZrest_frameworkrZrest_framework.schemasrZ!rest_framework.schemas.generatorsr Z_EndpointEnumeratorr r Zrest_framework.schemas.utilsr Zrest_framework.settingsr r,rZ app_settingsrerrorsrZinspectors.fieldrrrrrutilsrrr getLoggerr^r'compilerXr6rbr#r#r#r$s0