U d2@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@seZdZdZd=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/d0ZdBd1d2ZdCd3d4Zd5d6Zd7d8Z d9d:Z!ed;d<Z"dS)D 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|_|r2|ng|_g|_t |_ d|_ ||_ ||_ g|_d|krv|j|dttd|j|_dS)Napi.)name description_pathZ_schema _validatemodelsurls decorators resourcesrerror_handlersdefault_error_handlerauthorizationsorderedapisappendlogging getLogger__name__logger) selfrrpathrvalidater r!kwargsr,9/tmp/pip-unpacked-wheel-dt_sn2ih/flask_restx/namespace.py__init__#s" zNamespace.__init__cCs|jpd|jdS)N/)rrrstripr(r,r,r-r)AszNamespace.pathcOsR|di}|jt|||||jD]$}|||}|j||f||q(dS)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_urlsZregister_resource)r(resourcerr+r2rr4r,r,r- add_resourceEs    zNamespace.add_resourcecsfdd}|S)z1 A decorator to route resources. cs:dd}|dk r$||d<j|f|S)Ndocr2)r3 _build_docr6)clsr7r+r(rr,r-wrapperfs  z Namespace.route..wrapperr,)r(rr+r;r,r:r-routeaszNamespace.routecCs|dkr dSt|t|tD]j}||kr ||dkr:q t||t||d||kr t||dttfs ||dg||d<q tt|di|S)NFexpect __apidoc__)unshortcut_params_descriptionhandle_deprecationsr isinstancelisttuplergetattr)r(r9r7Z http_methodr,r,r-r8ps     zNamespace._build_docc s8t|tr|d<t|tr |ndfdd}|S)zAA decorator to add some api documentation to the decorated objectidTcs|rnd|_|S)NF)r8r>)Z documentedr+r(showr,r-r;s  zNamespace.doc..wrapper)rAstrbool)r(Zshortcutr+r;r,rFr-r7s  z Namespace.doccCs|d|S)z>A decorator to hide a resource or a method from specificationsFr7r(funcr,r,r-hideszNamespace.hidecOst||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(rZ definitionrr,r,r- add_models   zNamespace.add_modelcKs6|jr tnt}|||||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>updaterQ)r(rmodelrRrSr+r9r,r,r-rUs  zNamespace.modelcCst||}|||S)zG Register a model .. seealso:: :class:`Model` )rrQ)r(rZschemarUr,r,r- schema_models zNamespace.schema_modelcCs@t|tr&||g}tj|f|}nt|||}|||S)zr Extend a model (Duplicate all fields) :deprecated: since 0.9. Use :meth:`clone` instead )rArBr extendrQ)r(rparentfieldsparentsrUr,r,r-rWs   zNamespace.extendcGstj|f|}|||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 clonerQr(rspecsrUr,r,r-r[s zNamespace.clonecGstj|f|}|||S)z~ Inherit a model (use the Swagger composition pattern aka. allOf) .. seealso:: :meth:`Model.inherit` )r inheritrQr\r,r,r-r^szNamespace.inheritcOs8g}|d|j|d}|D]}||q|jf|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=)getrr#r7)r(inputsr+r=paramsparamr,r,r-r=s  zNamespace.expectcCstS)z%Instanciate a :class:`~RequestParser`rr1r,r,r-parserszNamespace.parsercCstt|diddi|_|S)z/Allow to specify nested lists for documentationr>as_listT)rrDr>)r(fieldr,r,r-rdszNamespace.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^trgfnfiddd}tt|di||_tfdji|S)NrRT) responsesZ__mask__r>r!)rHr_rrDr>r r!)rLr7rdcoderrYr+r(r,r-r;s z'Namespace.marshal_with..wrapperr,)r(rYrdrhrr+r;r,rgr-r s zNamespace.marshal_withcKs|j|df|S)zHA shortcut decorator for :meth:`~Api.marshal_with` with ``as_list=True``T)r )r(rYr+r,r,r-marshal_list_with szNamespace.marshal_list_withcOs t||S)z(A shortcut to the :func:`marshal` helper)r rNr,r,r-r szNamespace.marshalcs4tr&ttr&fdd}|S_SdS)z>A decorator to register an error handler for a given exceptioncs|j<|SrP)r)rL exceptionr(r,r-r;s z'Namespace.errorhandler..wrapperN)inspectisclass issubclass Exceptionr)r(rkr;r,rjr- 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)rarJ)r(rrZ_inr+rbr,r,r-rb#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 )rf)r7rH)r(rhrrUr+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)headersrTr7)r(rrr+headerr,r,r-rv;s zNamespace.headercCs |j|dS)z9A decorator to specify the MIME types the API can produce)producesrJ)r( mimetypesr,r,r-rwGszNamespace.producescCs|jdd|S)z8A decorator to mark a resource or a method as deprecatedT) deprecatedrJrKr,r,r-ryKszNamespace.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 )vendorru)r(rOr+argr,r,r-rzOs  zNamespace.vendorcCstS)z6Store the input payload in the current request context)rZget_jsonr1r,r,r-payload\szNamespace.payload)NNNNNF)N)NNNF)NN)Nrq)N)N)#r& __module__ __qualname____doc__r.propertyr)r6r<r8r7rMr rQrUrVrWr[r^r=rcrdrOKr rir rprbrsrvrwryrzr|r,r,r,r-rsP           rcCs<d|kr8|dD]"\}}t|trd|i|d|<qdS)Nrar)itemsrArH)datarrr,r,r-r?bs r?cCsld|kr4tjdtdd|dg|dg|d<d|krhtjdtdd|dg|dg|d<dS)Nrcz6The parser attribute is deprecated, use expect instead) stacklevelr=bodyz4The body attribute is deprecated, use expect instead)warningswarnDeprecationWarningr_r3rJr,r,r-r@isr@)rlrr$ collectionsrrZflaskrZ flask.viewsrZ_httprerrorsr Z marshallingr r rUr r rZreqparserutilsrrobjectrr?r@r,r,r,r-s"       P