o !i2@sddlZddlZddlZddlmZmZddlmZddlm Z ddl m Z ddl m Z ddlmZmZdd lmZmZmZdd lmZdd lmZed d ZGdddeZddZddZdS)N) namedtuple OrderedDict)request)http_method_funcs) HTTPStatusabort)marshal marshal_with)Model OrderedModel SchemaModel RequestParser)merge ResourceRoutezresource urls route_doc kwargsc@seZdZdZ      d=ddZeddZdd Zd d Zd d Z d>ddZ ddZ ddZ ddZ d?ddZd@ddZddZddZddZd d!Zd"d#Zd$d%Zdejdfd&d'Zd(d)Zd*d+Zd,d-ZdAd/d0Zd>d1d2Zd>d3d4Zd5d6Zd7d8Z d9d:Z!ed;d<Z"dS)B 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 Ks||_||_||_d|_||_i|_i|_|r|ng|_g|_t |_ d|_ ||_ ||_ g|_d|vr;|j|dttd|j|_dS)Napi.)name description_path_schema _validatemodelsurls decorators resourcesrerror_handlersdefault_error_handlerauthorizationsorderedapisappendlogging getLogger__name__logger) selfrrpathrvalidater!r"kwargsr-Z/var/www/html/crm_dreinet/venv_linux/lib/python3.10/site-packages/flask_restx/namespace.py__init__#s" zNamespace.__init__cCs|jpd|jdS)N/)rrrstripr)r-r-r.r*AszNamespace.pathcOsX|di}|jt|||||jD]}|||}|j||g|Ri|qdS)a/ Register a Resource for a given API Namespace :param Resource resource: the resource ro register :param str urls: one or more url routes to match for the resource, standard flask routing rules apply. Any url variables will be passed to the resource method as args. :param str endpoint: endpoint name (defaults to :meth:`Resource.__name__.lower` Can be used to reference this route in :class:`fields.Url` fields :param list|tuple resource_class_args: args to be forwarded to the constructor of the resource. :param dict resource_class_kwargs: kwargs to be forwarded to the constructor of the resource. Additional keyword arguments not specified above will be passed as-is to :meth:`flask.Flask.add_url_rule`. Examples:: namespace.add_resource(HelloWorld, '/', '/hello') namespace.add_resource(Foo, '/foo', endpoint="foo") namespace.add_resource(FooSpecial, '/special/foo', endpoint="foo") route_docN)poprr$rr#ns_urlsregister_resource)r)resourcerr,r3rr5r-r-r. add_resourceEs   zNamespace.add_resourcecsfdd}|S)z1 A decorator to route resources. cs@dd}|dur||d<j|gRi|S)Ndocr3)r4 _build_docr8)clsr9r,r)rr-r.wrapperfs z Namespace.route..wrapperr-)r)rr,r=r-r<r.routeaszNamespace.routecCs|durdSt|t|tD]5}||vrE||durqt||t||d||vrEt||dttfsE||dg||d<qtt|di|S)NFexpect __apidoc__)unshortcut_params_descriptionhandle_deprecationsr isinstancelisttuplergetattr)r)r;r9 http_methodr-r-r.r:ps    zNamespace._build_docc s8t|tr |d<t|tr|ndfdd}|S)zAA decorator to add some api documentation to the decorated objectidTcs|rnd|_|S)NF)r:r@) documentedr,r)showr-r.r=s zNamespace.doc..wrapper)rCstrbool)r)shortcutr,r=r-rJr.r9s z Namespace.doccCs|d|S)z>A decorator to hide a resource or a method from specificationsFr9r)funcr-r-r.hidezNamespace.hidecOst|i|dS)zd Properly abort the current request See: :func:`~flask_restx.errors.abort` Nrr)argsr,r-r-r.r szNamespace.abortcCs$||j|<|jD]}||j|<q|SN)rr#)r)r definitionrr-r-r. add_models   zNamespace.add_modelcKs6|jrtnt}|||||d}|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"r r r@updaterX)r)rmodelrYrZr,r;r-r-r.r\s   zNamespace.modelcCst||}|||S)zG Register a model .. seealso:: :class:`Model` )rrX)r)rschemar\r-r-r. schema_models  zNamespace.schema_modelcCsBt|tr||g}tj|g|R}nt|||}|||S)zr Extend a model (Duplicate all fields) :deprecated: since 0.9. Use :meth:`clone` instead )rCrDr extendrX)r)rparentfieldsparentsr\r-r-r.r_s   zNamespace.extendcGtj|g|R}|||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 clonerXr)rspecsr\r-r-r.rds zNamespace.clonecGrc)z~ Inherit a model (use the Swagger composition pattern aka. allOf) .. seealso:: :meth:`Model.inherit` )r inheritrXrer-r-r.rgs zNamespace.inheritcOs<g}|d|j|d}|D]}||q|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+r?Nr-)getrr$r9)r)inputsr,r?paramsparamr-r-r.r?s  zNamespace.expectcCstS)z%Instanciate a :class:`~RequestParser`rr2r-r-r.parserszNamespace.parsercCstt|diddi|_|S)z/Allow to specify nested lists for documentationr@as_listT)rrFr@)r)fieldr-r-r.rmszNamespace.as_listc sfdd}|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 cs^tr gfnfiddd}tt|di||_tfdji|S)NrYT) responses__mask__r@r")rLrhrrFr@r r")rQr9rmcoderrar,r)r-r.r=s z'Namespace.marshal_with..wrapperr-)r)rarmrrrr,r=r-rqr.r s zNamespace.marshal_withcKs|j|dfi|S)zHA shortcut decorator for :meth:`~Api.marshal_with` with ``as_list=True``T)r )r)rar,r-r-r.marshal_list_with szNamespace.marshal_list_withcOst|i|S)z(A shortcut to the :func:`marshal` helper)r rTr-r-r.r rSzNamespace.marshalcs0trttrfdd}|S_S)z>A decorator to register an error handler for a given exceptioncs|j<|SrV)r)rQ exceptionr)r-r.r=s z'Namespace.errorhandler..wrapper)inspectisclass issubclass Exceptionr )r)rur=r-rtr. errorhandlers zNamespace.errorhandlerquerycKs$|}||d<||d<|j||idS)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)rjrO)r)rr_inr,rkr-r-r.rk#szNamespace.paramcKs|jt||||fidS)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 )ro)r9rL)r)rrrr\r,r-r-r.response0s zNamespace.responsecKs"d|i}|||j||idS)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)headersr[r9)r)rrr,headerr-r-r.r;s zNamespace.headercCs |j|dS)z9A decorator to specify the MIME types the API can produce)producesrO)r) mimetypesr-r-r.rGs zNamespace.producescCs|jdd|S)z8A decorator to mark a resource or a method as deprecatedT) deprecatedrOrPr-r-r.rKszNamespace.deprecatedcOs |D]}||q|j|dS)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)rUr,argr-r-r.rOs  zNamespace.vendorcCstS)z6Store the input payload in the current request context)rget_jsonr2r-r-r.payload\szNamespace.payload)NNNNNFrV)NNNF)NN)Nr{)#r' __module__ __qualname____doc__r/propertyr*r8r>r:r9rRr rXr\r^r_rdrgr?rlrmrOKr rsr rzrkr~rrrrrr-r-r-r.rsN              rcCs@d|vr|dD]\}}t|trd|i|d|<q dSdS)Nrjr)itemsrCrL)datarrr-r-r.rAbs rAcCspd|vrtjdtdd|dg|dg|d<d|vr6tjdtdd|dg|dg|d<dSdS)Nrlz6The parser attribute is deprecated, use expect instead) stacklevelr?bodyz4The body attribute is deprecated, use expect instead)warningswarnDeprecationWarningrhr4rOr-r-r.rBis rB)rvrr% collectionsrrflaskr flask.viewsr_httprerrorsr marshallingr r r\r r rreqparserutilsrrobjectrrArBr-r-r-r.s$       P