9Vc@@sddlmZddlZddlmZmZddlZddlmZm Z m Z ddlm Z ddlm ZddlmZddlmZdd lmZmZmZmZmZdd lmZdd lmZdd lmZm Z m!Z!dd l"m#Z#ddl$Z$ddl%m&Z&ddl'm(Z(ddl)Z)ddddddfZ*dZ ie#d6Z+de,fdYZ-defdYZ.e/dZ0de,fdYZ1de,fdYZ2dS(i(tabsolute_importN(twrapstpartial(trequestturl_fort current_app(tabort(t make_response(t MethodView(tgot_request_exception(t HTTPExceptiontMethodNotAllowedtNotFoundt NotAcceptabletInternalServerError(tHTTP_STATUS_CODES(tResponse(thttp_status_messagetunpackt OrderedDict(t output_json(t_endpoint_from_view_func(t MethodTypetApitResourcetmarshalt marshal_withtmarshal_with_fieldRcK@sCyt|Wn.tk r>}t|r8||_nnXdS(sRaise a HTTPException for the given http_status_code. Attach any keyword arguments to the exception for later processing. N(toriginal_flask_abortR tlentdata(thttp_status_codetkwargste((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs   sapplication/jsonc B@seZdZddddeedddZdZdZedddZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZRS(sr The main entry point for the application. You need to initialize it with a Flask Application: :: >>> app = Flask(__name__) >>> api = restful.Api(app) Alternatively, you can use :meth:`init_app` to set the Flask application after it has been constructed. :param app: the Flask application object :type app: flask.Flask :param prefix: Prefix all routes with a value, eg v1 or 2010-04-01 :type prefix: str :param default_mediatype: The default media type to return :type default_mediatype: str :param decorators: Decorators to attach to every resource :type decorators: list :param catch_all_404s: Use :meth:`handle_error` to handle 404 errors throughout your app :param serve_challenge_on_401: Whether to serve a challenge response to clients on receiving 401. This usually leads to a username/password popup in web browers. :param url_part_order: A string that controls the order that the pieces of the url are concatenated when the full url is constructed. 'b' is the blueprint (or blueprint registration) prefix, 'a' is the api prefix, and 'e' is the path component the endpoint is added with :type catch_all_404s: bool :param errors: A dictionary to define a custom response for each exception or error raised during a request :type errors: dict tsapplication/jsontbaec C@stt|_i|_||_||_|r6|ng|_||_||_||_ |pci|_ d|_ t |_g|_d|_d|_|dk r||_|j|ndS(N(tdicttDEFAULT_REPRESENTATIONStrepresentationsturlstprefixtdefault_mediatypet decoratorstcatch_all_404stserve_challenge_on_401turl_part_orderterrorstNonetblueprint_setuptsett endpointst resourcestappt blueprinttinit_app( tselfR4R(R)R*R+R,R-R.((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt__init__Js"             cC@sBy|j|jWntk r4|j|n X||_dS(siInitialize this class with the given :class:`flask.Flask` application or :class:`flask.Blueprint` object. :param app: the Flask application or blueprint object :type app: flask.Flask :type app: flask.Blueprint Examples:: api = Api() api.add_resource(...) api.init_app(app) N(trecordt_deferred_blueprint_inittAttributeErrort _init_appR5(R7R4((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR6as  c@s>i|d6|jd6|d6djfd|jDS(siThis method is used to defer the construction of the final url in the case that the Api is created with a Blueprint. :param url_part: The part of the url the endpoint is registered with :param registration_prefix: The part of the url contributed by the blueprint. Generally speaking, BlueprintSetupState.url_prefix tbtaR!R"c3@s#|]}|r|VqdS(N((t.0tkey(tparts(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pys s(R(tjoinR-(R7turl_parttregistration_prefix((RAs=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt _complete_urlys   cK@st|r||j}n|jr7|j|}n|jd|j|dkret|}n|j}d|krt||jd}n|j j |d|j j |f|d||dS(swMethod used to patch BlueprintSetupState.add_url_rule for setup state instance corresponding to this Api instance. Exists primarily to enable _complete_url's function. :param blueprint_setup: The BlueprintSetupState instance (self) :param rule: A string or callable that takes a string and returns a string(_complete_url) that is the url rule for the endpoint being registered :param endpoint: See BlueprintSetupState.add_url_rule :param view_func: See BlueprintSetupState.add_url_rule :param **options: See BlueprintSetupState.add_url_rule t subdomaintdefaultss%s.%sN( tcallablet url_prefixt setdefaultRFR/Rt url_defaultsR$tpopR4t add_url_ruleR5tname(R0truletendpointt view_functoptionsRG((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt#_blueprint_setup_add_url_rule_patchs     cC@sk||_|jjdkr?|j|_ttj||_n|jsWtdn|j |j dS(sSynchronize prefix between blueprint/api and registration options, then perform initialization with setup_state.app :class:`flask.Flask` object. When a :class:`flask_restful.Api` object is initialized with a blueprint, this method is recorded on the blueprint to be run when the blueprint is later registered to a :class:`flask.Flask` object. This method also monkeypatches BlueprintSetupState.add_url_rule with _blueprint_setup_add_url_rule_patch. :param setup_state: The setup state object passed to deferred functions during blueprint registration :type setup_state: flask.blueprints.BlueprintSetupState RSs5flask-restful blueprints can only be registered once.N( R0RMt__name__t_original_add_url_ruleRRRStfirst_registrationt ValueErrorR<R4(R7t setup_state((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR:s    cC@st|j|j|_t|j|j|_t|jdkr{x3|jD]%\}}}|j||||qOWndS(sPerform initialization actions with the given :class:`flask.Flask` object. :param app: The flask application object :type app: flask.Flask iN(Rt error_routerthandle_exceptionthandle_user_exceptionRR3t_register_view(R7R4tresourceR'R ((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR<s cC@sU|jrH|j|jjrA|j|jjddd}qHtSn||jkS(sTests if an endpoint name (not path) belongs to this Api. Takes in to account the Blueprint name part of the endpoint name. :param endpoint: The name of the endpoint being checked :return: bool t.ii(R5t startswithRNtsplittFalseR2(R7RP((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt owns_endpoints  #cC@stjt}y|jWnetk rj}|jd}|jd|dt\}}|j|jSt k r~|j SnXdS(s- Determine if error should be handled with FR or default Flask The goal is to return Flask error handlers for non-FR-related routes, and FR errors (with the correct media type) for FR endpoints. This method currently handles 404 and 405 errors. :return: bool itmethodt return_ruleN( Rtcreate_url_adapterRtmatchR t valid_methodstTrueRbRPR R+(R7tadapterR!tvalid_route_methodROt_((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt_should_use_fr_error_handlers   cC@s0|jrtStjstS|jtjjS(sGEncapsulating the rules for whether the request was to a Flask endpoint(RlRhRturl_ruleRaRbRP(R7((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt _has_fr_routes   cC@s>|jr4y|j|SWq4tk r0q4Xn||S(sThis function decides whether the error occured in a flask-restful endpoint or not. If it happened in a flask-restful endpoint, our handler will be dispatched. If it happened in an unrelated view, the app's original error handler will be dispatched. In the event that the error occurred in a flask-restful endpoint but the local handler can't resolve the situation, the router will fall back onto the original_handler as last resort. :param original_handler: the original Flask error handler for the app :type original_handler: function :param e: the exception raised while handling the request :type e: Exception (Rnt handle_errort Exception(R7toriginal_handlerR!((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRYs   c @stjtjd|t|t rbtjrbtj\}}}||krYqb|nt|tr|j }it |dt |d6}nd}it |d6}t |d|}i}|dkrtjdkrtj jdqtj jdntjjdt} |dkr| rtgtjjD]'} tjd d | j| jf^qKtjtjj} | rd|kr|djd d |d)R"R^s. sYou have requested this URI [s] but did you mean s or c3@s|]}|VqdS(N((R?Rf(trules(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pys Fss ?itAllowtstatusiis text/plaintfallback_mediatypeiN(NNN(*R tsendRt_get_current_objectt isinstanceR tpropagate_exceptionstsystexc_infotcodetgetattrRR/tloggerterrorRrtconfigtgetRhR$turl_mapt iter_rulestretsubROtdifflibtget_close_matchesRtpathtkeystrstripRBRgttypeRTR.tupdateR)tlistR&Rt unauthorized(R7R!texc_typet exc_valuettbRt default_dataRtheaderst help_on_404ROt close_matchesterror_cls_namet custom_datatsupported_mediatypesRytresp((Rvs=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRosb    =   8   c@s fdS(s:Return a method that returns a list of mediatypes c@sjjgS(N(t mediatypesR)(t resource_cls(R7(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pytis((R7((R7s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pytmediatypes_methodfscO@sH|jdk r+|j|j|||n|jj|||fdS(sAdds a resource to the api. :param resource: the class name of your resource :type resource: :class:`Resource` :param 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. :type urls: str :param endpoint: endpoint name (defaults to :meth:`Resource.__name__.lower` Can be used to reference this route in :class:`fields.Url` fields :type endpoint: str :param resource_class_args: args to be forwarded to the constructor of the resource. :type resource_class_args: tuple :param resource_class_kwargs: kwargs to be forwarded to the constructor of the resource. :type resource_class_kwargs: dict Additional keyword arguments not specified above will be passed as-is to :meth:`flask.Flask.add_url_rule`. Examples:: api.add_resource(HelloWorld, '/', '/hello') api.add_resource(Foo, '/foo', endpoint="foo") api.add_resource(FooSpecial, '/special/foo', endpoint="foo") N(R4R/R\R3tappend(R7R]R'R ((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt add_resourceks c@sfd}|S(sWraps a :class:`~flask_restful.Resource` class, adding it to the api. Parameters are the same as :meth:`~flask_restful.Api.add_resource`. Example:: app = Flask(__name__) api = restful.Api(app) @api.resource('/foo') class Foo(Resource): def get(self): return 'Hello, World!' c@sj||S(N(R(tcls(R R7R'(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt decorators((R7R'R R((R R7R's=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR]sc O@s|jddp|jj}|jj||jdd}|jdi}||jjkr|j|jd}||krt d||jfqn|j |_ ||_ |j |j|||} x|jD]} | | } qWx||D]t} |jrR|jr=|jj| d| |qqdt|j| } n|j| d} |j| d| |qWdS( NRPtresource_class_argstresource_class_kwargst view_classs2This endpoint (%s) is already set to the class %s.RQR"((RLR/RTtlowerR2taddtview_functionsRt__dict__RWRRRPtoutputtas_viewR*R5R0RMRRE( R7R4R]R'R RPRRtprevious_view_classt resource_funcRturlRO((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR\s,!      c@s"tfd}|S(sWraps a resource (as a flask view function), for cases where the resource does not directly return a response object :param resource: The resource as a flask view function c@sM||}t|tr"|St|\}}}j||d|S(NR(R|t ResponseBaseRR(targsR RRRR(R]R7(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pytwrappers (R(R7R]R((R]R7s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRscK@s:|j}|jr-dj|jj|}nt||S(sQGenerates a URL to the given resource. Works like :func:`flask.url_for`.s{0}.{1}(RPR5tformatRNR(R7R]tvaluesRP((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs  cO@s|jddp|j}tjj|jd|}|dkrNtn||jkr|j||||}||jd<|S|dkrt t |||}d|jd<|St dS(sLooks up the representation transformer for the requested media type, invoking the transformer to create a response object. This defaults to default_mediatype if no transformer is found for the requested mediatype. If default_mediatype is None, a 406 Not Acceptable response will be sent as per RFC 2616 section 14.1 :param data: Python object containing response data to be transformed Rytdefaults Content-Types text/plainN( RLR/R)Rtaccept_mimetypest best_matchR&R Rtoriginal_flask_make_responsetstrR(R7RRR R)t mediatypeR((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs         cC@s;gttjdtjddtD]\}}|^q%S(s@Returns a list of requested mediatypes sent in the Accept headerR@itreverse(tsortedRRtoperatort itemgetterRh(R7thtq((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRsc@sfd}|S(sAllows additional representation transformers to be declared for the api. Transformers are functions that must be decorated with this method, passing the mediatype the transformer represents. Three arguments are passed to the transformer: * The data to be represented in the response body * The http status code * A dictionary of headers The transformer should convert the data appropriately for the mediatype and return a Flask response object. Ex:: @api.representation('application/xml') def xml(data, code, headers): resp = make_response(convert_data_to_xml(data), code) resp.headers.extend(headers) return resp c@s|j<|S(N(R&(tfunc(RR7(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs ((R7RR((RR7s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pytrepresentationscC@sD|jr@tjjdd}djd|}||jd>> from flask_restful import fields, marshal >>> data = { 'a': 100, 'b': 'foo' } >>> mfields = { 'a': fields.Raw } >>> marshal(data, mfields) OrderedDict([('a', 100)]) >>> marshal(data, mfields, envelope='data') OrderedDict([('data', OrderedDict([('a', 100)]))]) cS@st|tr|S|S(N(R|R(R((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pytmakensc3@sQ|]G\}}|t|tr0t|n|j|fVqdS(N(R|R$RR(R?tktv(RR(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pys ws(R|RttupleRRtitems(RtfieldstenvelopetdR((RRs=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRWs  UcB@s#eZdZddZdZRS(s1A decorator that apply marshalling to the return values of your methods. >>> from flask_restful import fields, marshal_with >>> mfields = { 'a': fields.Raw } >>> @marshal_with(mfields) ... def get(): ... return { 'a': 100, 'b': 'foo' } ... ... >>> get() OrderedDict([('a', 100)]) >>> @marshal_with(mfields, envelope='data') ... def get(): ... return { 'a': 100, 'b': 'foo' } ... ... >>> get() OrderedDict([('data', OrderedDict([('a', 100)]))]) see :meth:`flask_restful.marshal` cC@s||_||_dS(s :param fields: a dict of whose keys will make up the final serialized response output :param envelope: optional key that will be used to envelop the serialized response N(RR(R7RR((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR8s c@s"tfd}|S(Nc@sl||}t|trRt|\}}}t|jj||fSt|jjSdS(N(R|RRRRR(RR RRRR(tfR7(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs (R(R7RR((RR7s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyt__call__sN(RTRRR/R8R(((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR}s cB@s eZdZdZdZRS(sT A decorator that formats the return values of your methods with a single field. >>> from flask_restful import marshal_with_field, fields >>> @marshal_with_field(fields.List(fields.Integer)) ... def get(): ... return ['1', 2, 3.0] ... >>> get() [1, 2, 3] see :meth:`flask_restful.marshal_with` cC@s+t|tr||_n ||_dS(sP :param field: a single field with which to marshal the output. N(R|Rtfield(R7R((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyR8sc@s"tfd}|S(Nc@s\||}t|trLt|\}}}jj|||fSjj|S(N(R|RRRR(RR RRRR(RR7(s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs (R(R7RR((RR7s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs (RTRRR8R(((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyRs  (3t __future__RRt functoolsRRRtflaskRRRRRRRt flask.viewsRt flask.signalsR twerkzeug.exceptionsR R R R Rt werkzeug.httpRtwerkzeug.wrappersRRtflask_restful.utilsRRRt"flask_restful.representations.jsonRR~t flask.helpersRttypesRRt__all__R%tobjectRRR/RRR(((s=/tmp/pip-build-Q6F9ld/flask-restful/flask_restful/__init__.pyts6  (   + &-