_B @s/dZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z ddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlm Z ddlm!Z!ddlm"Z"ddl#m$Z$ddl#m%Z%ddl#m&Z&ddl#m'Z'ddl#m(Z(ddl)m*Z*e+Z,e-ddej.j/ej.j0gDZ1ddZ2ddZ3d d!d"Z4d#d$Z5d%d&Z6d'd(Z7d)d*Z8d+d,Z9d-d.d/Z:d0fd1d2Z;dd0dd dd0dd3d4Z<d5d6Z=d7d8Z>d9d:Z?d;d<Z@d=d>ZAd?d@ZBGdAdBdBe+ZCGdCdDdDe+ZDdEdFZEdGdHZFdS)Iz flask.helpers ~~~~~~~~~~~~~ Implements various helpers. :copyright: 2010 Pallets :license: BSD-3-Clause N)update_wrapper)RLock)time)adler32)FileSystemLoader)Headers) BadRequest)NotFound)RequestedRangeNotSatisfiable) BuildError) url_quote) wrap_file)fspath)PY2) string_types) text_type)_app_ctx_stack)_request_ctx_stack) current_app)request)session)message_flashedccs!|]}|dkr|VqdS)N/)Nr).0seprr./tmp/pip-build-5gj8f0j9/flask/flask/helpers.py 4srcCstjjdpdS)zGet the environment the app is running in, indicated by the :envvar:`FLASK_ENV` environment variable. The default is ``'production'``. Z FLASK_ENV production)osenvirongetrrrrget_env8sr#cCs5tjjd}|s%tdkS|jdkS)zGet whether debug mode should be enabled for the app, indicated by the :envvar:`FLASK_DEBUG` environment variable. The default is ``True`` if :func:`.get_env` returns ``'development'``, or ``False`` otherwise. Z FLASK_DEBUGZ development0falseno)r$r%r&)r r!r"r#lower)valrrrget_debug_flag@s r)TcCs,tjjd}|s|S|jdkS)zGet whether the user has disabled loading dotenv files by setting :envvar:`FLASK_SKIP_DOTENV`. The default is ``True``, load the files. :param default: What to return if the env var isn't set. ZFLASK_SKIP_DOTENVr$r%r&)r$r%r&)r r!r"r')defaultr(rrrget_load_dotenvNsr+cCs|dk std|jS)zsInternal helper that returns the default endpoint for a given function. This always is the function name. Nz/expected view func if endpoint is not provided.)AssertionError__name__)Z view_funcrrr_endpoint_from_view_func]sr.c smytWn1tk rCfdd}t|SYnXfdd}|}t||S)aRequest 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)stream_with_context)argskwargsgen)generator_or_functionrr decoratorsz&stream_with_context..decoratorc3sotj}|dkr!td|AdVzxD] }|Vq7WWdtdrcjXWdQRXdS)Nz\Attempted to stream with context but there was no context in the first place to keep around.close)rtop RuntimeErrorhasattrr5)ctxitem)r2rr generators     z&stream_with_context..generator)iter TypeErrorrnext)r3r4r;Z wrapped_gr)r2r3rr/es"   r/cGs9|stjSt|dkr,|d}tj|S)aySometimes 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 rr)rresponse_classlen make_response)r0rrrrAs *  rAc Kstj}tj}|dkr*td|dk r|j}tj}|dddkr|dk rw||}n|dd}|jdd}n3|j}|dkrtd|jdd}|jd d}|jd d}|jd d} |jj ||d} | dk rN|s<t d |j } | |_ y?z"|j ||d |d|} Wd| dk r| |_ XWnct k r} zC||d<||d <||d <| |d <|jj| ||SWYdd} ~ XnX|dk r| dt|7} | S)aGenerates 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 `. Configuration values ``APPLICATION_ROOT`` and ``SERVER_NAME`` are only used when generating URLs outside of a request context. To integrate applications, :class:`Flask` has a hook to intercept URL build errors through :attr:`Flask.url_build_error_handlers`. 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.url_build_error_handlers` 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.url_build_error_handlers.append(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 falls back to the `Host` header, then to the IP and port of the request. :param _scheme: a string specifying the desired URL scheme. The `_external` parameter must be set to ``True`` or a :exc:`ValueError` is raised. The default behavior uses the same scheme as the current request, or ``PREFERRED_URL_SCHEME`` from the :ref:`app configuration ` if no request context is available. As of Werkzeug 0.10, this also can be set to an empty string to build protocol-relative URLs. :param _anchor: if provided this is added as anchor to the URL. :param _method: if provided this explicitly specifies an HTTP method. NzAttempted to generate a URL without the application context being pushed. This has to be executed when application context is available.r.Z _externalFzApplication 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.TZ_anchor_method_schemez/When specifying _scheme, _external must be TruemethodZforce_external#)rr6rr7 url_adapterrZ blueprintpopZappZinject_url_defaults ValueErrorZ url_schemebuildr Zhandle_url_build_errorr ) ZendpointvaluesZappctxZreqctxrGZblueprint_nameZexternalanchorrEschemeZ old_schemerverrorrrrurl_forsVL                     ) rPcCsttjj|j|S)aXLoads 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 :file:`_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 )getattrrZ jinja_envZ get_templatemodule)Z template_name attributerrrget_template_attributeysrTmessagecCsRtjdg}|j||f|tdsz&get_flashed_messages..cSsg|]}|dqS)rr)rxrrr s z(get_flashed_messages..)rr6rZrrHlistfilter)Zwith_categoriesr]rZr)r]rget_flashed_messagess  +!rcc$Csud}d} t|dr't|}t|tr|} tjj| sftjjtj | } d} |dkrtjj | }n |} d} |dkr|dk rt j |dpd}|dkrt dt} |r|dkr tdt|ts'|jd}y|jd}WnLtk rd tjd |jdd d d t|ddi} Yn Xd |i} | jdd| tjr| r| dk r| j| | 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 trusted base directory. :param pathnames: the untrusted pathnames relative to that directory. :raises: :class:`~werkzeug.exceptions.NotFound` if one or more passed paths fall out of its boundaries. c3s|]}|kVqdS)Nr)rr)rerrrszsafe_join..z..z../) posixpathnormpathany _os_alt_sepsr rqrr startswithr rXrs) directoryZ pathnamespartsr)rer safe_joins     rc Kst|}t|}t||}tjj|sQtjjtj|}ytjj|sot Wn!t t fk rt YnX|j ddt||S)aSend 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`. rT)rrr rqrrrsrrtisfiler r=rIr setdefaultr)rreoptionsrrrsend_from_directorys   rcCstjj|}|dk rLt|drLtjjtjj|jSt j |}|dkss|dkr}tj St|dr|j |}nEt |tj|}t|dd}|dkrtd|tjjtjj|S)zReturns 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`. N__file____main__ get_filenameaNo root path can be found for the provided module "%s". This can happen because the module came from an import hook that does not provide file name information or because it's a namespace package. In this case the root path needs to be explicitly provided.)sysmodulesr"r8r rqdirnameabspathrpkgutil get_loadergetcwdr __import__rQr7) import_namemodloaderfilepathrrr get_root_paths      rcCs^t|dr|j|S|jjdkrD|jjdkrDdStd|jjdS)zGiven the loader that loaded a module and the module this function attempts to figure out if the given module is actually a package. is_package_frozen_importlibZNamespaceLoaderTz%s.is_package() method is missing but is required by Flask of PEP 302 import hooks. If you do not use import hooks and you encounter this error please file a bug against Flask.N)r8r __class__ __module__r-r)rZmod_namerrr)_matching_loader_thinks_module_is_package6s rc Cstjd krddl}y.|jj|}|dkrHtdWnttfk rcYnjX|jd krtj j t t |j S|j rtj j tj j |jStj j |jStj|}|dks|dkrtjSt|dr|j|}n5t|d r:|j}nt|tj|j}tj jtj j |}t||rtj j |}|S) z/Find the path where the module's root exists inrNz not found namespacerrarchive)rr>Nr)r version_infoimportlib.utilutil find_specrI ImportErrororiginr rqrr>r<submodule_search_locationsrrrr8rrrrrrr) root_mod_name importlibspecrre package_pathrrr_find_package_pathRs4      rc Cs|jd\}}}t|}tjj|\}}tjjtj}|j|rj||fS|j dkrtjj|\}}|j dkr|} n9tjj |j dkrtjj |} n|} | |fSd|fS)aFinds 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.). rBz site-packageslibN) partitionrr rqsplitrrprefixrr'rur) rr_rZ site_parentZ site_folderZ py_prefixparentZfolderbase_dirrrr find_packages    rc@s7eZdZdZddddZdddZdS)locked_cached_propertya#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. NcCsI|p |j|_|j|_|p*|j|_||_t|_dS)N)r-r__doc__funcrlock)selfrnamedocrrr__init__s   zlocked_cached_property.__init__c Csl|dkr|S|jL|jj|jt}|tkr]|j|}||j|j<|SWdQRXdS)N)r__dict__r"r-_missingr)robjtypevaluerrr__get__s   zlocked_cached_property.__get__)r-r __qualname__rrrrrrrrs rc@seZdZdZdZdZddddZeddZej ddZeddZ e j d dZ ed d Z e d d Z ddZddZdddZdS)_PackageBoundObjectNcCsh||_||_|dkr-t|j}||_d|_d|_ddlm}||_dS)Nr)AppGroup)rtemplate_folderrrt_static_folder_static_url_pathclir)rrrrtrrrrrs      z_PackageBoundObject.__init__cCs,|jdk r(tjj|j|jSdS)z2The absolute path to the configured static folder.N)rr rqrsrt)rrrr static_foldersz!_PackageBoundObject.static_foldercCs(|dk r|jd}||_dS)Nz/\)rstripr)rrrrrrs cCsO|jdk r|jS|jdk rKtjj|j}d|jdSdS)zThe URL prefix that the static route will be accessible from. If it was not configured during init, it is derived from :attr:`static_folder`. Nr)rrr rqrur)rrurrrstatic_url_paths z#_PackageBoundObject.static_url_pathcCs(|dk r|jd}||_dS)Nr)rr)rrrrrrs cCs |jdk S)zThis is ``True`` if the package bound object's container has a folder for static files. .. versionadded:: 0.5 N)r)rrrrhas_static_foldersz%_PackageBoundObject.has_static_foldercCs2|jdk r.ttjj|j|jSdS)zWThe Jinja loader for this package bound object. .. versionadded:: 0.5 N)rrr rqrsrt)rrrr jinja_loader sz _PackageBoundObject.jinja_loadercCs ttjS)aProvides default cache_timeout for the :func:`send_file` functions. By default, this function returns ``SEND_FILE_MAX_AGE_DEFAULT`` from the configuration of :data:`~flask.current_app`. Static file functions such as :func:`send_from_directory` use this function, and :func:`send_file` calls this function on :data:`~flask.current_app` when the given cache_timeout is ``None``. If a cache_timeout is given in :func:`send_file`, that timeout is used; otherwise, this method is called. This allows subclasses to change the behavior when sending files based on the filename. For example, to set the cache timeout for .js files to 60 seconds:: class MyFlask(flask.Flask): def get_send_file_max_age(self, name): if name.lower().endswith('.js'): return 60 return flask.Flask.get_send_file_max_age(self, name) .. versionadded:: 0.9 ) total_secondsrZsend_file_max_age_default)rrerrrrsz)_PackageBoundObject.get_send_file_max_agecCs:|jstd|j|}t|j|d|S)zFunction used internally to send static files from the static folder to the browser. .. versionadded:: 0.5 z No static folder for this objectr)rr7rrr)rrerrrrsend_static_file0s   z$_PackageBoundObject.send_static_filerjcCs7|dkrtdttjj|j||S)a:Opens a resource from the application's resource folder. To see how this works, consider the following folder structure:: /myapplication.py /schema.sql /static /style.css /templates /layout.html /index.html If you want to open the :file:`schema.sql` file you would do the following:: with app.open_resource('schema.sql') as f: contents = f.read() do_something_with(contents) :param resource: the name of the resource. To access resources within subfolders use forward slashes as separator. :param mode: Open file in this mode. Only reading is supported, valid values are "r" (or "rt") and "rb". rrtrjz(Resources can only be opened for reading>rrrj)rIrr rqrsrt)rresourcemoderrr open_resource?s  z!_PackageBoundObject.open_resource)r-rrrrrtrpropertyrsetterrrrrrrrrrrrrs    rcCs|jddd|jS)zReturns the total seconds from a timedelta object. :param timedelta td: the timedelta to be converted in seconds :returns: number of seconds :rtype: int <)daysseconds)tdrrrr]srcCstrFtjdkrFytj|dSWntjk rEdSYnXxJtjtjfD]6}ytj||Wntjk rYqYXdSqYWdS)aDetermine if the given string is an IP address. Python 2 on Windows doesn't provide ``inet_pton``, so this only checks IPv4 addresses in that environment. :param value: value to check :type value: str :return: True if string is an IP address :rtype: bool ntTF) rr rsocket inet_atonrOAF_INETAF_INET6 inet_pton)rfamilyrrris_iphs   r)Grrrvr rrrrr{ functoolsr threadingrrzlibrZjinja2rZwerkzeug.datastructuresrZwerkzeug.exceptionsrr r Zwerkzeug.routingr Z werkzeug.urlsr Z werkzeug.wsgir _compatrrrrglobalsrrrrrZsignalsrobjectrrarqraltseprr#r)r+r.r/rArPrTr[rcrrrrrrrrrrrrrrr sx         (    L 1 * % ) 0  :