h\rddlZddlZddlZddlmZddlmZmZddl 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)ej*e+Z,ej-dZ.GddeZGdde/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+)}cPeZdZd fd ZfdZd fd ZdZd dZdZd Z xZ S) r Nchtt|||||_dSN)superr __init__request)selfpatternsurlconfr __class__s O/var/www/html/Sam_Eipo/venv/lib/python3.11/site-packages/drf_yasg/generators.pyrzEndpointEnumerator.__init__s/  $''007CCC c|drtd||t t ||S)N)zEurl pattern does not end in $ ('%s') - unexpected things might happen)endswithloggerwarning unescape_pathrr get_path_from_regex)r path_regexr#s r$r,z&EndpointEnumerator.get_path_from_regex!s^   s # # p NNbdn o o o!!%(:D"A"A"U"UV`"a"abbbr%cltt|||sdSt|jdd}t|jdd}|5t |tjr|r|| dvrdSt|jdtdSdS)NFversionversioning_class:swagger_schemaT) rr should_include_endpointgetattrrcls issubclassrNamespaceVersioningsplitobject) r pathcallbackapp_name namespaceurl_namer0r1r#s r$r4z*EndpointEnumerator.should_include_endpoint&s'..FFtXVV 5$, 488"8<1CTJJ  'J7GIg,h,h ' 7)//#*>*>>>u 8ignored_endpointszunknown pattern type {}key)r!setstrpattern isinstancerr,r<namer4rFaddget_allowed_methodsappend Exceptionr)r*rget_api_endpoints url_patternsr=r>extendformattypesortedr )r r!rIr=r>rJ api_endpointsrOr-r;r<r?methodendpointnested_endpointss r$rVz$EndpointEnumerator.get_api_endpointsJsA  }H  $ #  P PG#go"6"66J':.. PN33J??D&/H&|H33D(HNPRT]Tcacemnn ;#33D(CC #444$)--d333&*&>&>x&H&H;;F(,fh'?H)00:::: NNNNN#=NMMMMMNG[11 P#'#9#9$1%GOe'2B2BCCU\UeJSjG4E4EFFY`Yj&7 $:$$ $$%566668??W NNOOOO}2CDDD sAC1)AC11&DDc.tjdd|S)zzUnescape all backslash escapes from `s`. :param str s: string with backslash escapes :rtype: str z\\(.)z\1)resub)r ss r$unescapezEndpointEnumerator.unescape}svhq)))r%cFd}|rt|}|s|||z }ng|||d|z }||z }||d}||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_REsearchrdstartgroupend)r r; clean_pathmatchs r$r+z EndpointEnumerator.unescape_paths  &%,,T22E dmmD111  $--^ekkmm^(<== =J %++-- 'J %D &r%)NNN)r.r.N)Nr.NNN) __name__ __module__ __qualname__rr,r4rFrVrdr+ __classcell__)r#s@r$r r sccccc      *1111f***r%r ceZdZdZeZeZddZe dZ dZ dZ dd Z dd Zd Zd Zd ZdZdZdZdZdZdZdZdZdS)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.Nct|j||dd|||_||_||_g|_g|_|tj tj }|rgtj |}|j dvs|j std|jrtd|zdS||j_dSdS)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_genrDr0consumesproducesrDEFAULT_API_URLurlparseschemenetlocrr;r)r*url)r rDr0rr!r" parsed_urls r$rzOpenAPISchemaGenerator.__init__s"$DJTXXmR5P5PRZ\cdd     ;+;G"2C  $!*3//J (999AR9,-TUUU $lorrsssss #  $ $r%c|jjSr)ryr)r s r$rzOpenAPISchemaGenerator.urls y}r%cLtj}|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_definitionss- 0D  +#.#89Mr#R#R ##r%c~tj}| d|D}d|D}t|t}|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 Ncg|]}|giSr).0security_schemes r$ zDOpenAPISchemaGenerator.get_security_requirements..s$g$g$gor%:$g$g$gr%c8g|]}tj|iSr)rr)rsrs r$rzDOpenAPISchemaGenerator.get_security_requirements..s% _ _ _2!6r2!>!> _ _ _r%rK)rSECURITY_REQUIREMENTSr[list)r rsecurity_requirementss r$get_security_requirementsz0OpenAPISchemaGenerator.get_security_requirementssW!1 F ($g$gRf$g$g$g ! _ _I^ _ _ _ &'<$ G G G$$r%Fc 6||}|tjd}t t j|_tt j |_ | ||||\}}| }|r| |}nd}|j} | ||} tjd|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) force_initN) rDpathsrzr{rsecurity_url_prefix_versionr) get_endpointsreference_resolver_classrSCHEMA_DEFINITIONSrr DEFAULT_PARSER_CLASSESrzrDEFAULT_RENDERER_CLASSESr{ get_pathsrrrbuild_absolute_uriSwaggerrDr0dict) r rpublic endpoints componentsrrIrrrs r$ get_schemaz!OpenAPISchemaGenerator.get_schemas)&&w// 2273MZ^2__ $\%HII $\%JKK y*gvNN v#<<>>  )$($B$BCW$X$X ! !$( !h ;7.,,..C %$-2G4RVR_Rgcg!5@Uft|  @DJ?O?O   r%c |j|||}t|dd}|C|D].\}}t||d}|t |jd|/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)ry create_viewr5itemssetattr__func__)r r<r]rview overrides_ view_methods r$rz"OpenAPISchemaGenerator.create_view sy$$Xvw??H&z8OpenAPISchemaGenerator.get_endpoints..Cs(XXXMD'x~w/XXXr%) endpoint_enumerator_classryr!r"rVrrrrrTr6r) r r enumeratorr view_pathsr;r]r<rrs @r$rz$OpenAPISchemaGenerator.get_endpoints1s33DI4F HYcj3kk 0022  && &/ * * "D&(##Hfg>>D##D$//D t  # #VTN 3 3 3%\HTNNXXXXZEUEUEWEWXXXXr%c:|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] )ryget_keys)r subpathr]rs r$get_operation_keysz)OpenAPISchemaGenerator.get_operation_keysEsy!!'64888r%c6|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 )rydetermine_path_prefixr rs r$rz,OpenAPISchemaGenerator.determine_path_prefixVs$y..u555r%c>|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 )ryhas_view_permissions)r r;r]rrs r$r4z.OpenAPISchemaGenerator.should_include_endpointjs#K77fdKKKr%c,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)rPathsrs r$get_paths_objectz'OpenAPISchemaGenerator.get_paths_objectvs}5))))r%c |stjidfS|t|pd}d|vs Jdt }t |D]\}\}} i} | D]Q\} } ||| | |s| | ||| ||} | | | | <R| rK|t|d}| dsd|z}| ||| ||<|||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/)rrrrkeysrr[rr4 get_operationlowerlen startswith get_path_itemr)r rrrrrIrr;rr operationsr]r operation path_suffixs r$rz OpenAPISchemaGenerator.get_pathss /=r***B. .++D1A1A,B,BCCIr&   "P    )/ 0A0A)B)B T T %D%8WJ ' ; ; 33D&$OO ..tT66:W^__ (1:Jv||~~. T#3v;;<<0 "--c224"% "3K%)%7%7h %S%Sk"$$U++V33r%c  ||t|d||}|||}tj} t |d| } |d| } | dS| |||||||} | |} | dSd| vr,t| j t|j kr| ` 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 Nr3 auto_schemarzr{) rr get_overridesrDEFAULT_AUTO_SCHEMA_CLASSr5rxrrMrzr{) r rr;rIr]rroperation_keysrview_inspector_clsview_inspectorrs r$rz$OpenAPISchemaGenerator.get_operations 00c&kkll1CVTRR&&tV44 .G$T+;=OPP&]]=:LMM  %4++D$ GU^`noo"00@@  4  " "s9+='>'>#dmBTBT'T'T"  " "s9+='>'>#dmBTBT'T'T"r%cT|||}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 parametersr)get_path_parametersrPathItem)r r;rrpath_parameterss r$rz$OpenAPISchemaGenerator.get_path_items5224BBII?IjIIIr%c|}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 actionNr)rr5copydeepcopy)r rr]r action_methodrs r$rz$OpenAPISchemaGenerator.get_overridessjx00fd33 M+A2FF Y  !&)I}Y'''r%c g}t|}ttj|D] }t ||\}}t |p dt ji}t|dd|kr>|dt jkr(t|d| dd|d<|rt|ddr|j } n&|r"t|ddrt||} nd} t j d |t| d t jd |} ||  |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] rZ lookup_fieldNlookup_value_regexrO help_textF primary_keyT)rQrtrequiredin_r)rr[ uritemplate variablesrrr TYPE_STRINGr5rxrr ParameterrIN_PATHrT) r r;rrquerysetvariabler model_fieldattrsrtfields r$rz*OpenAPISchemaGenerator.get_path_parameterssg )(33{4T::;; % %H!3Hh!G!G E;' 44UAT8UEx66(BBuV}X_XkGkGk#*85I599U^`dKeKe#f#fi  #w{KGG #)3  #mU!K!K #0 DD " %*;77O   E   e $ $ $ $r%)r.NNN)NFr)rmrnro__doc__r rrrrpropertyrrrrrrrrrr4rrrrrrrr%r$rrrrsS!30!$!$!$!$FX $ $ $%%%     @*999$YYY(999"666( L L L***#4#4#4J$$$L J J J((("!!!!!r%rr)1rloggingra urllib.parseparser} collectionsrrr django.urlsrrrest_frameworkrrest_framework.schemasr!rest_framework.schemas.generatorsr _EndpointEnumeratorr r rest_framework.schemas.utilsr rest_framework.settingsr r.r app_settingsrerrorsrinspectors.fieldrrrrrutilsrrr getLoggerrmr)compilerfr:rrrr%r$rs  00000000////////%%%%%%222222WWWWWWLLLLLLLL;;;;;;000000************]]]]]]]]]]33333333==========  8 $ $BJ677,DjjjjjVjjjjjr%