`Tc@shdZddlZddlZddlZddlZddlZddlmZddlmZddl m Z ddl m Z ddl mZyddlmZWn!ek rdd lmZnXdd lmZdd lmZydd lmZWn!ek r!dd lmZnXdd lmZddlmZddlm Z m!Z!m"Z"m#Z#m$Z$ddl%m&Z&m'Z'e(Z)e*dej+j,ej+j-gDZ.dZ/dZ0dZ1dZ2dZ3ddZ4e5gdZ6de5de8de5dZ9dZ:dZ;dZ<dZ=d e(fd!YZ>d"e(fd#YZ?dS($s flask.helpers ~~~~~~~~~~~~~ Implements various helpers. :copyright: (c) 2011 by Armin Ronacher. :license: BSD, see LICENSE for more details. iN(ttime(tadler32(tRLock(t BuildError(tupdate_wrapper(t url_quote(tquote(tHeaders(tNotFound(t wrap_file(tFileSystemLoaderi(tmessage_flashed(tsessiont_request_ctx_stackt_app_ctx_stackt current_apptrequest(t string_typest text_typeccs!|]}|dkr|VqdS(t/N(NR(tNone(t.0tsep((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pys 4scCs|dk std|jS(ssInternal helper that returns the default endpoint for a given function. This always is the function name. s/expected view func if endpoint is not provided.N(RtAssertionErrort__name__(t view_func((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyt_endpoint_from_view_func8scscytWn*tk r<fd}t|SXfd}|}t||S(sRequest contexts disappear when the response is started on the server. This is done for efficiency reasons and to make it less likely to encounter memory leaks with badly written WSGI middlewares. The downside is that if you are using streamed responses, the generator cannot access request bound information any more. This function however can help you keep the context around for longer:: from flask import stream_with_context, request, Response @app.route('/stream') def streamed_response(): @stream_with_context def generate(): yield 'Hello ' yield request.args['name'] yield '!' return Response(generate()) Alternatively it can also be used around a specific generator:: from flask import stream_with_context, request, Response @app.route('/stream') def streamed_response(): def generate(): yield 'Hello ' yield request.args['name'] yield '!' return Response(stream_with_context(generate())) .. versionadded:: 0.9 cs}t|S(N(tstream_with_context(targstkwargstgen(tgenerator_or_function(sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyt decoratorfs c 3sttj}|dkr$tdn|DdVzxD] }|Vq:WWdtdrijnXWdQXdS(Ns\Attempted to stream with context but there was no context in the first place to keep around.tclose(R ttopRt RuntimeErrorthasattrR!(tctxtitem(R(sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyt generatorks    (titert TypeErrorRtnext(RR R't wrapped_g((RRsS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyRAs"   cGs<|stjSt|dkr/|d}ntj|S(sySometimes it is necessary to set additional headers in a view. Because views do not have to return response objects but can return a value that is converted into a response object by Flask itself, it becomes tricky to add headers to it. This function can be called instead of using a return and you will get a response object which you can use to attach headers. If view looked like this and you want to add a new header:: def index(): return render_template('index.html', foo=42) You can now do something like this:: def index(): response = make_response(render_template('index.html', foo=42)) response.headers['X-Parachutes'] = 'parachutes are cool' return response This function accepts the very same arguments you can return from a view function. This for example creates a response with a 404 error code:: response = make_response(render_template('not_found.html'), 404) The other use case of this function is to force the return value of a view function into a response which is helpful with view decorators:: response = make_response(view_function()) response.headers['X-Parachutes'] = 'parachutes are cool' Internally this function does the following things: - if no arguments are passed, it creates a new response argument - if one argument is passed, :meth:`flask.Flask.make_response` is invoked with it. - if more than one argument is passed, the arguments are passed to the :meth:`flask.Flask.make_response` function as tuple. .. versionadded:: 0.6 ii(Rtresponse_classtlent make_response(R((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyR.s *  c Ks)tj}tj}|d kr-tdn|d k r|j}tj}|jjs|d dkr|d k r||}q|d}qnHd|kr|d k r|d|}qn|j dr|d}n|j dt }n6|j}|d krtdn|j dt }|j dd }|j dd }|j dd } |j j||| d k r|std n| |_ny"|j||d |d |} WnDtk r} ||d<||d<||d<|j j| ||SX|d k r%| d t|7} n| S(s Generates a URL to the given endpoint with the method provided. Variable arguments that are unknown to the target endpoint are appended to the generated URL as query arguments. If the value of a query argument is `None`, the whole pair is skipped. In case blueprints are active you can shortcut references to the same blueprint by prefixing the local endpoint with a dot (``.``). This will reference the index function local to the current blueprint:: url_for('.index') For more information, head over to the :ref:`Quickstart `. To integrate applications, :class:`Flask` has a hook to intercept URL build errors through :attr:`Flask.build_error_handler`. The `url_for` function results in a :exc:`~werkzeug.routing.BuildError` when the current app does not have a URL for the given endpoint and values. When it does, the :data:`~flask.current_app` calls its :attr:`~Flask.build_error_handler` if it is not `None`, which can return a string to use as the result of `url_for` (instead of `url_for`'s default to raise the :exc:`~werkzeug.routing.BuildError` exception) or re-raise the exception. An example:: def external_url_handler(error, endpoint, **values): "Looks up an external URL when `url_for` cannot build a URL." # This is an example of hooking the build_error_handler. # Here, lookup_url is some utility function you've built # which looks up the endpoint in some external URL registry. url = lookup_url(endpoint, **values) if url is None: # External lookup did not have a URL. # Re-raise the BuildError, in context of original traceback. exc_type, exc_value, tb = sys.exc_info() if exc_value is error: raise exc_type, exc_value, tb else: raise error # url_for will use this result, instead of raising BuildError. return url app.build_error_handler = external_url_handler Here, `error` is the instance of :exc:`~werkzeug.routing.BuildError`, and `endpoint` and `**values` are the arguments passed into `url_for`. Note that this is for building URLs outside the current application, and not for handling 404 NotFound errors. .. versionadded:: 0.10 The `_scheme` parameter was added. .. versionadded:: 0.9 The `_anchor` and `_method` parameters were added. .. versionadded:: 0.9 Calls :meth:`Flask.handle_build_error` on :exc:`~werkzeug.routing.BuildError`. :param endpoint: the endpoint of the URL (name of the function) :param values: the variable arguments of the URL rule :param _external: if set to `True`, an absolute URL is generated. Server address can be changed via `SERVER_NAME` configuration variable which defaults to `localhost`. :param _scheme: a string specifying the desired URL scheme. The `_external` parameter must be set to `True` or a `ValueError` is raised. :param _anchor: if provided this is added as anchor to the URL. :param _method: if provided this explicitly specifies an HTTP method. sAttempted to generate a URL without the application context being pushed. This has to be executed when application context is available.it.t _externalsApplication was not able to create a URL adapter for request independent URL generation. You might be able to fix this by setting the SERVER_NAME config variable.t_anchort_methodt_schemes/When specifying _scheme, _external must be Truetmethodtforce_externalt#N(RR"R RR#t url_adapterRt blueprintt_is_old_modulet startswithtpoptFalsetTruetapptinject_url_defaultst ValueErrort url_schemetbuildRthandle_url_build_errorR( tendpointtvaluestappctxtreqctxR7tblueprint_nametexternaltanchorR4tschemetrvterror((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyturl_forsRE                     cCsttjj|j|S(sRLoads a macro (or variable) a template exports. This can be used to invoke a macro from within Python code. If you for example have a template named `_cider.html` with the following contents: .. sourcecode:: html+jinja {% macro hello(name) %}Hello {{ name }}!{% endmacro %} You can access this from Python code like this:: hello = get_template_attribute('_cider.html', 'hello') return hello('World') .. versionadded:: 0.2 :param template_name: the name of the template :param attribute: the name of the variable of macro to access (tgetattrRt jinja_envt get_templatetmodule(t template_namet attribute((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pytget_template_attribute?stmessagecCsRtjdg}|j||f|tdsiN(R R"R]RR R;tlisttfilter(twith_categoriesR`R]tx((R`sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pytget_flashed_messagesss  .!cCs}d}t|tr$|}d} n}ddlm} |} t| dd}| r| rt|tr| tdddn|r| tdddn|dk rtjj |stjj t j |}qn|dkr|s|rt j|p|d}n|dkr&d }nt} |r|dkrq|dkr\td ntjj|}n| jd d d |nt jr|r| dk r| jn|| d') def wiki_page(filename): filename = safe_join(app.config['WIKI_FOLDER'], filename) with open(filename, 'rb') as fd: content = fd.read() # Read and process the file content... :param directory: the base directory. :param filename: the untrusted filename relative to that directory. :raises: :class:`~werkzeug.exceptions.NotFound` if the resulting path would fall out of `directory`. s..s../( t posixpathtnormpatht _os_alt_sepsRRsRtRuR:Rv(t directoryRkR((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyt safe_join.s    cKsJt||}tjj|s-tn|jdtt||S(sSend a file from a given directory with :func:`send_file`. This is a secure way to quickly expose static files from an upload folder or something similar. Example usage:: @app.route('/uploads/') def download_file(filename): return send_from_directory(app.config['UPLOAD_FOLDER'], filename, as_attachment=True) .. admonition:: Sending files and Performance It is strongly recommended to activate either `X-Sendfile` support in your webserver or (if no authentication happens) to tell the webserver to serve files for the given path on its own without calling into the web application for improved performance. .. versionadded:: 0.5 :param directory: the directory where all the files are stored. :param filename: the filename relative to that directory to download. :param options: optional keyword arguments that are directly forwarded to :func:`send_file`. R(RRsRttisfileRt setdefaultR=R(RRktoptions((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pytsend_from_directoryIs  cCstjj|}|dk rLt|drLtjjtjj|j St j |}|dkss|dkr}tj St|dr|j |}nt|tj|j }tjjtjj|S(sReturns the path to a package or cwd if that cannot be found. This returns the path of a package or the folder that contains a module. Not to be confused with the package path returned by :func:`find_package`. t__file__t__main__t get_filenameN(tsystmodulesRYRR$RsRttdirnametabspathRtpkgutilt get_loadertgetcwdRt __import__(t import_nametmodtloadertfilepath((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyt get_root_pathks  c Cs|jdd}tj|}|dks:|dkrItj}nt|drj|j|}n5t|dr|j}nt |t j |j }tj jtj j|}|j|rtj j|}ntj j|\}}tj jt j}|j|r'||fS|jdkrtj j|\}} | jdkrl|} n9tj j|jdkrtj j|} n|} | |fSd|fS( sFinds a package and returns the prefix (or None if the package is not installed) as well as the folder that contains the package or module as a tuple. The package path returned is the module that would have to be added to the pythonpath in order to make it possible to import the module. The prefix is the path below which a UNIX like folder structure exists (lib, share etc.). R/iRRtarchives site-packagestlibN(tsplitRRRRsRR$RRRRRRRtRRt is_packagetprefixR:tlowerRz( Rt root_mod_nameRt package_pathRkt site_parentt site_foldert py_prefixtparenttfoldertbase_dir((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyt find_packages4     tlocked_cached_propertycBs)eZdZdddZddZRS(s#A decorator that converts a function into a lazy property. The function wrapped is called the first time to retrieve the result and then that calculated result is used the next time you access the value. Works like the one in Werkzeug but has a lock for thread safety. cCsI|p |j|_|j|_|p*|j|_||_t|_dS(N(Rt __module__t__doc__tfuncRtlock(tselfRRhtdoc((sS/var/www/send.findwatt.com/datamanager/lib/python2.7/site-packages/flask/helpers.pyt__init__s   cCsn|dkr|S|jO|jj|jt}|tkr`|j|}||j|j sT       ( ( H 1  '  " ! 3