VwgfzddlZddlZddlZddlmZddlmZmZddl Z ddl m Z m Z ddl mZddlmZddlmZddlmZmZddlmZmZdd lmZd d lmZd d lmZd d lm Z d dl!m"Z"m#Z#m$Z$d dlm%Z%m&Z&d dl'm(Z(m)Z)m*Z*ejVe,Z-ej\dZ/dZ0dZ1GddeZGddZ2y)N) OrderedDict defaultdict) URLPattern URLResolver) versioning)SchemaGenerator)EndpointEnumerator)endpoint_ordering get_pk_name)get_pk_description is_list_view) 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+)}c|Dcgc]"}|jdjd$}}t|}t|}|}t |D]\}}|||k7s|d|}nddj |zScc}w)N/)stripsplitminmax enumeratejoin)pathspath split_pathss1s2commonics J/var/www/horilla/myenv/lib/python3.12/site-packages/drf_yasg/generators.py common_pathr,s:?@$4::c?((-@K@ [ B [ B F" 1 1:VF  &! !!As'A<c |dvS)N>listcreateupdatedestroyretrievepartial_update)actions r+is_custom_actionr6(s  cPeZdZdfd ZfdZd fd ZdZd dZdZdZ xZ S) r c<tt| ||||_yN)superr __init__request)selfpatternsurlconfr= __class__s r+r<zEndpointEnumerator.__init__/s  $07C r7c|jdrtjd||jtt ||S)N)zEurl pattern does not end in $ ('%s') - unexpected things might happen)endswithloggerwarning unescape_pathr;r get_path_from_regex)r> path_regexrAs r+rHz&EndpointEnumerator.get_path_from_regex3s@   s # NNbdn o!!%(:D"UV`"abbr7c0tt| ||syt|jdd}t|j dd}|0t |tjr|r||jdvryt|j dtyy)NFversionversioning_class:swagger_schemaT) r;r should_include_endpointgetattrr=cls issubclassrNamespaceVersioningrobject) r>r$callbackapp_name namespaceurl_namerKrLrAs r+rOz*EndpointEnumerator.should_include_endpoint8s'FtXV$,, 48"8<<1CTJ  'J7GIgIg,h7)//#*>> 8<t|jdd}|t|tjrit|j dd}|rPt|dd}d|z}||vr(t jd|jd|d||j||}|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 rLNrK version_param{%s}zview z uses URLPathVersioning but URL z has no param ) rPrQrRrURLPathVersioningr=rEinforeplace)r>r$rUrLrKrZs r+replace_versionz"EndpointEnumerator.replace_versionGs#8<<1CTJ  'J7GIeIe,fdllItr?rcrVrWrd api_endpointsrirIr$rUrXmethodendpointnested_endpointss r+rpz$EndpointEnumerator.get_api_endpoints\s  }}H  $ #  PG#goo"66J':.N33J?D&//H&||H33D(HNPRT]Tcacemn#33D(C #44$)--d3&*&>&>x&H;F(,fh'?H)00:; G[1#'#9#9$11%GO'2B2BCU\UeUeJSG4E4EFY`YjYj&7 $:$ $$%568??W NOA PD}2CD #!NNN#=NMNs AF')=F'' G  G c0tjdd|S)zzUnescape all backslash escapes from `s`. :param str s: string with backslash escapes :rtype: str z\\(.)z\1)resub)r>ss r+unescapezEndpointEnumerator.unescapesvvhq))r7cd}|r|tj|}|s||j|z } |S||j|d|jz }||j z }||j d}|r||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 raN)PATH_PARAMETER_REsearchr~startgroupend)r>r$ clean_pathmatchs r+rGz EndpointEnumerator.unescape_paths %,,T2EdmmD11   $--^ekkm(<= =J %++- 'J %Dr7)NNN)raraN)NraNNN) __name__ __module__ __qualname__r<rHrOr_rpr~rG __classcell__)rAs@r+r r .s(c *1f*r7r ceZdZdZeZeZddddddZdd Z e d Z d Z d Z dd ZddZdZdZdZdZdZdZdZdZdZdZdZy)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``. r2r/r0r3r1)getpostputpatchdeleteNct|j||jdd|||_||_||_g|_g|_tj|_ | tjtj}|rqtj|}|jdvs |js t!d|j"rt$j'd|zy||j_yy)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 descriptionraN)httphttpsz%`url` must be an absolute HTTP(S) urlzKpath component of api base URL %s is ignored; use FORCE_SCRIPT_NAME instead)rtitler_genr]rKconsumesproducesrSCHEMA_COERCE_METHOD_NAMEScoerce_method_namesrDEFAULT_API_URLurlparseschemenetlocrr$rErFurl)r>r]rKrr?r@ parsed_urls r+r<zOpenAPISchemaGenerator.__init__s"$DJJTXXmR5PRZ\cd     #/#J#J ;+;;G"22C !**3/J  (99ARAR,-TUUlorrs #  r7c.|jjSr:)rr)r>s r+rzOpenAPISchemaGenerator.urlsyy}}r7cVtj}|tj|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 )rSECURITY_DEFINITIONSr _as_odict)r>security_definitionss r+get_security_definitionsz/OpenAPISchemaGenerator.get_security_definitionss0 0DD  +#.#8#89Mr#R ##r7ctj}||Dcgc]}|gi}}|Dcgc]}tj|i}}t |t }|Scc}wcc}w)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 re)rSECURITY_REQUIREMENTSrrrur.)r>rsecurity_requirementssecurity_schemesrs r+get_security_requirementsz0OpenAPISchemaGenerator.get_security_requirementssm!1 F F (Rf$gor%:$g !$gI^ _2!6!6r2!> _ _ &'<$ G$$ %h _s AAc H|j|}|jtjd}t t j |_tt j|_ |j||||\}}|j}|r|j|}nd}|j} | ||j} tj d|j"||jxsd|jxsd||| ||j$d 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) force_initN) r]r#rrrsecurity_url_prefix_versionr4) get_endpointsreference_resolver_classrSCHEMA_DEFINITIONSrrDEFAULT_PARSER_CLASSESrrDEFAULT_RENDERER_CLASSESr get_pathsrrrbuild_absolute_uriSwaggerr]rKdict) r>r=public endpoints componentsr#rcrrrs r+ get_schemaz!OpenAPISchemaGenerator.get_schemas&&w/ 2273M3MZ^2_ $\%H%HI $\%J%JK y*gvN v#<<> $($B$BCW$X !$( !hh ;7.,,.C %$--2G4RVR_R_Rgcg!5@Uft|| @DJ?O  r7c|jj|||}t|dd}|?|jD],\}}t||d}|t |j d|.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_schemaNswagger_fake_viewT)r create_viewrPitemssetattr__func__)r>rUrwr=view overrides_ view_methods r+rz"OpenAPISchemaGenerator.create_view&syy$$Xvw?H&r$rr field_names r+ coerce_pathz"OpenAPISchemaGenerator.coerce_path;sM  K.t4gtD $U+JJ||FFZ$788r7c|j|jj|jj|}|j }t t }i}|D]P\}}}|j|||} |j|| }||j|| f|j||<R|jD cic] \}} |||| fc} }Scc} }w)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)])] )r=) endpoint_enumerator_classrr?r@rprr.rrrnrQr) r>r= enumeratorr view_pathsview_clsr$rwrUrmethodss r+rz$OpenAPISchemaGenerator.get_endpointsMs33DII4F4F HYHYcj3k 002  & &/ * "D&(##Hfg>D##D$/D t  # #VTN 3%\\HTN  * FPEUEUEWXMD'x~w//XXXsCcLt|dr |j}n-t|||rd}n|j|j }|j dj dDcgc]}d|vr| }}t|rv|jDchc] }|dk7s | }}t|dkDr@|jj }||jvr|j|}||gzS|dd|gzS||jvr|j|}||gzScc}wcc}w) 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] r5r.r{headrN) hasattrr5r default_mappinglowerrrr6 action_maplenr)r>subpathrwrr5 componentnamed_path_componentsmapped_methodss r+get_operation_keysz)OpenAPISchemaGenerator.get_operation_keysasH 4 "[[FGVT2--flln=}}S!'',! #)# ! ! F #&*__!&8HN>"Q&--flln=T555!55f=F,x77,Sb1VH<< T-- ---f5F%x//1! s) D D!D!cg}|D]q}|jdjd}g}|D]}d|vrn|j|dj|dd}|sy|jd|zdzst |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 rrNr)rrrnr"r,)r>r#prefixesr$rinitial_componentsrrcs r+determine_path_prefixz,OpenAPISchemaGenerator.determine_path_prefixs$ 0DC..s3J!# ' 5 )#")))4 5XX0"56F OOC&L3. / 08$$r7cD|xs|jj|||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 )rhas_view_permissions)r>r$rwrrs r+rOz.OpenAPISchemaGenerator.should_include_endpoints"K77fdKKr7c.tj|S)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 r#)rPaths)r>r#s r+get_paths_objectz'OpenAPISchemaGenerator.get_paths_objects}}5))r7c :|stjidfS|jt|j xsd}d|vsJdt }t |jD]\}\}} i} | D]F\} } |j|| | |s|j| ||| ||} | 4| | | j<H| sY|t|d}|jdsd|z}|j||| ||<|j||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] rrarz,base path cannot be templated in swagger 2.0Nr)rrrr.keysrrurrO get_operationrr startswith get_path_itemr)r>rrr=rrcr#r$rr operationsrwr operation path_suffixs r+rz OpenAPISchemaGenerator.get_pathss>==r*B. .++D1A,BCIr& P"PP  )/ 0A)B T %D%8WJ ' ; 33D&$O ..tT66:W^_ (1:Jv||~.  ;#3v;<0 "--c2"% "3K%)%7%7h %Sk"! T$$$U+V33r7c |j|t|d||}|j||}tj} t |d| } |j d| } | y| |||||||} | j|} | yd| vr-t| jt|jk(r| ` d| vr-t| jt|jk(r| ` | 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 NrN auto_schemarr) rr get_overridesrDEFAULT_AUTO_SCHEMA_CLASSrPrrrgrr) r>rr$rcrwrr=operation_keysrview_inspector_clsview_inspectorrs r+rz$OpenAPISchemaGenerator.get_operations00c&kl1CVTR&&tV4 .GG$T+;=OP&]]=:LM  %+D$ GU^`no"00@    "s9+=+='>#dmmBT'T"  "s9+=+='>#dmmBT'T"r7cT|j||}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 parametersr4)get_path_parametersrPathItem)r>r$rrpath_parameterss r+rz$OpenAPISchemaGenerator.get_path_items/224BI?IjIIr7c|j}t|d|}t||d}t|di}||vr||}tj|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 r5Nr)rrPcopydeepcopy)r>rrwr5 action_methodrs r+rz$OpenAPISchemaGenerator.get_overrides"s[x0fd3 M+A2F Y !&)I}}Y''r7c 4g}t|}tj|D]}t||\}}t |xsdt j i}t|dd|k(r6|dt j k(r t|d|jdd|d<|rt|ddr |j} n|rt|ddr t||} nd} t jd |t| d t jd |} |j| |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] rt lookup_fieldNlookup_value_regexri help_textF primary_keyT)rkrrequiredin_r4)r uritemplate variablesrrr TYPE_STRINGrPrr r ParameterrIN_PATHrn) r>r$rrquerysetvariabler model_fieldattrsrfields r+rz*OpenAPISchemaGenerator.get_path_parameters3s  )(3#--d3 %H!3Hh!G E;' 4UATAT8UEx6(BuV}X_XkXkGk#*85I599U^`dKe#fi w{KG)33 mU!K0 D " %%*;7OO   E   e $) %,r7)raNNN)NFr:)rrr__doc__r rrrrr<propertyrrrrrrrrrrOrrrrrrr4r7r+rrs!30! O"$H $%  @*9$Y(10f %D L*#4J$L J("!r7r)3rloggingr{ urllib.parseparser collectionsrrr django.urlsrrrest_frameworkrrest_framework.schemas.openapir!rest_framework.schemas.generatorsr _EndpointEnumeratorr r rest_framework.schemas.utilsr r rest_framework.settingsrrar app_settingsrerrorsrinspectors.fieldrrrrrutilsrrr getLoggerrrEcompilerr,r6rr4r7r+r+s  0/%:WLI0**]]3==   8 $BJJ67 " ,Dddr7