E6i2ddlZddlZddlZddlmZmZddlmZddlm Z ddl m Z ddl m Z ddlmZmZdd lmZmZmZdd lmZdd lmZed d ZGddeZdZdZy)N) namedtuple OrderedDict)request)http_method_funcs) HTTPStatusabort)marshal marshal_with)Model OrderedModel SchemaModel RequestParser)merge ResourceRoutezresource urls route_doc kwargsceZdZdZ d dZedZdZdZdZ d!d Z d Z d Z d Z d"d Zd#dZdZdZdZdZdZdZdej.dfdZdZdZdZd$dZd!dZd!dZdZdZ dZ!edZ"y)% Namespaceak Group resources together. Namespace is to API what :class:`flask:flask.Blueprint` is for :class:`flask:flask.Flask`. :param str name: The namespace name :param str description: An optional short description :param str path: An optional prefix path. If not provided, prefix is ``/+name`` :param list decorators: A list of decorators to apply to each resources :param bool validate: Whether or not to perform validation on this namespace :param bool ordered: Whether or not to preserve order on models and marshalling :param Api api: an optional API to attache to the namespace NFc ||_||_||_d|_||_i|_i|_|r|ng|_g|_t|_ d|_ ||_ ||_ g|_d|vr|jj|dt!j"t$dz|jz|_y)Napi.)name description_path_schema _validatemodelsurls decorators resourcesrerror_handlersdefault_error_handlerauthorizationsorderedapisappendlogging getLogger__name__logger) selfrrpathr validater$r%kwargss X/home/azureuser/techstart-app/venv/lib/python3.12/site-packages/flask_restx/namespace.py__init__zNamespace.__init__#s &  !  (2*)m%)",  F? II  VE] +''3(BC cZ|jxsd|jzjdS)N/)rrrstripr,s r0r-zNamespace.pathAs$ /sTYY77<.wrapperfsL**UD)C&*ooc3&?{# D  c 3D 3F 3Jr2)r,rr/rCs``` r0routezNamespace.routeas  r2c6|duryt|t|tD]_}||vs||durt||t||d||vs4t||dtt frQ||dg||d<at t|di|S)NFexpect __apidoc__)unshortcut_params_descriptionhandle_deprecationsr isinstancelisttuplergetattr)r,rBr@ http_methods r0rAzNamespace._build_docps %<%c*C , NKc!{#u,-c+.>?#C $45s;//  $X.u 936k2B82L1MC $X. NWS,3S99r2c lt|tr|d<t|tr|ndfd}|S)zAA decorator to add some api documentation to the decorated objectidTc>j|rnd|_|S)NF)rArH) documentedr/r,shows r0rCzNamespace.doc..wrappers%$(OOdF%J ! r2)rKstrbool)r,shortcutr/rCrTs` ` @r0r@z Namespace.docs2 h $#F4L%h5x4  r2c0|jd|S)z>A decorator to hide a resource or a method from specificationsFr@r,funcs r0hidezNamespace.hidestxxt$$r2ct|i|y)zd Properly abort the current request See: :func:`~flask_restx.errors.abort` Nr r,argsr/s r0r zNamespace.aborts tvr2cd||j|<|jD]}||j|<|SN)rr&)r,r definitionrs r0 add_modelzNamespace.add_models7& D99 *C)CJJt  *r2c |jrtnt}|||||}|jj ||j ||S)z Register a model :param bool strict - should model validation raise error when non-specified param is provided? .. seealso:: :class:`Model` )maskstrict)r%rr rHupdaterc)r,rmodelrerfr/rBs r0rhzNamespace.modelsF#lllD%d6: '~~dE**r2c>t||}|j||S)zG Register a model .. seealso:: :class:`Model` )rrc)r,rschemarhs r0 schema_modelzNamespace.schema_models! D&)~~dE**r2ct|tr||gz}tj|g|}ntj|||}|j ||S)zr Extend a model (Duplicate all fields) :deprecated: since 0.9. Use :meth:`clone` instead )rKrLr extendrc)r,rparentfieldsparentsrhs r0rmzNamespace.extendsP fd #x'GLL00ELLvv6E~~dE**r2cRtj|g|}|j||S)z Clone a model (Duplicate all fields) :param str name: the resulting model name :param specs: a list of models from which to clone the fields .. seealso:: :meth:`Model.clone` )r clonercr,rspecsrhs r0rrzNamespace.clones( D)5)~~dE**r2cRtj|g|}|j||S)z~ Inherit a model (use the Swagger composition pattern aka. allOf) .. seealso:: :meth:`Model.inherit` )r inheritrcrss r0rvzNamespace.inherits(  d+U+~~dE**r2cg}|jd|j|d}|D]}|j||jdi|S)z A decorator to Specify the expected input model :param ModelBase|Parse inputs: An expect model or request parser :param bool validate: whether to perform validation or not r.)r.rGrD)getrr'r@)r,inputsr/rGparamsparams r0rGzNamespace.expectsR$jjT^^DPVW !E MM%  !txx!&!!r2ctS)z%Instanciate a :class:`~RequestParser`rr6s r0parserzNamespace.parsers r2cBtt|diddi|_|S)z/Allow to specify nested lists for documentationrHas_listT)rrNrH)r,fields r0rzNamespace.as_lists$  b!AItCTU r2c &fd}|S)a A decorator specifying the fields to use for serialization. :param bool as_list: Indicate that the return type is a list (for the documentation) :param int code: Optionally give the expected HTTP response code if its different from 200 ctrgfnfijddd}tt|di||_t fdj i|S)NreT) responses__mask__rHr%)rUrxrrNrHr r%)r[r@rcoderror/r,s r0rCz'Namespace.marshal_with..wrappersI!,fXv>%vv6 #JJD C$GD,$CSIDOG<G GGM Mr2rD)r,rorrrr/rCs`````` r0r zNamespace.marshal_withs N Nr2c *|j|dfi|S)zHA shortcut decorator for :meth:`~Api.marshal_with` with ``as_list=True``T)r )r,ror/s r0marshal_list_withzNamespace.marshal_list_with s t  888r2ct|i|S)z(A shortcut to the :func:`marshal` helper)r r^s r0r zNamespace.marshals'''r2crtjrttrfd}|S_S)z>A decorator to register an error handler for a given exceptionc&|j<|Sra)r")r[ exceptionr,s r0rCz'Namespace.errorhandler..wrappers15##I. r2)inspectisclass issubclass Exceptionr#)r,rrCs`` r0 errorhandlerzNamespace.errorhandlers4 ??9 %*Y *J N*3D & r2c B|}||d<||d<|j||iS)z A decorator to specify one of the expected parameters :param str name: the parameter name :param str description: a small description :param str _in: the parameter location `(query|header|formData|body|cookie)` inr)rzrY)r,rr_inr/r{s r0r{zNamespace.param#s1d *mxxe}x--r2c B|jt||||fiS)z A decorator to specify one of the expected responses :param int code: the HTTP status code :param str description: a small description about the response :param ModelBase model: an optional response model )r)r@rU)r,rrrhr/s r0responsezNamespace.response0s%xx3t9{E6.J"KxLLr2c Td|i}|j||j||iS)z A decorator to specify one of the expected headers :param str name: the HTTP header name :param str description: a description about the header r)headersrgr@)r,rrr/headers r0rzNamespace.header;s/ - fxxvx//r2c&|j|S)z9A decorator to specify the MIME types the API can produce)producesrY)r, mimetypess r0rzNamespace.producesGsxxx++r2c2|jd|S)z8A decorator to mark a resource or a method as deprecatedT) deprecatedrYrZs r0rzNamespace.deprecatedKs(txx4x(..r2cV|D]}|j||j|S)a A decorator to expose vendor extensions. Extensions can be submitted as dict or kwargs. The ``x-`` prefix is optionnal and will be added if missing. See: http://swagger.io/specification/#specification-extensions-128 )vendorr)r,r_r/args r0rzNamespace.vendorOs0 C MM#  xxvx&&r2c*tjS)z6Store the input payload in the current request context)rget_jsonr6s r0payloadzNamespace.payload\s!!r2)NNNNNFra)NNNF)NN)Nquery)#r* __module__ __qualname____doc__r1propertyr-r=rErAr@r\r rcrhrkrmrrrvrGr}rrOKr rr rr{rrrrrrrDr2r0rrs " D<==F8 :" % ++ + ++ " $*--T69(  . M 0,/ '""r2rczd|vr7|djD] \}}t|tsd|i|d|<"yy)Nrzr)itemsrKrU)datarrs r0rIrIbsO4!%h!5!5!7 D D++s+(5{'CXt$ Dr2c&d|vrDtjdtd|jdg|j dgz|d<d|vrEtjdtd|jdg|j dgz|d<yy)Nr}z6The parser attribute is deprecated, use expect instead) stacklevelrGbodyz4The body attribute is deprecated, use expect instead)warningswarnDeprecationWarningrxr9rYs r0rJrJis3 D  "-1B0CCH  } B  "-0AAH r2)rrr( collectionsrrflaskr flask.viewsr_httprerrorsr marshallingr r rhr rrreqparserutilsrrobjectrrIrJrDr2r0rsV/).33#?,LM K"K"\ DBr2