CasperSecurity
o
_�Kj�� � @ s� d dl mZ d dlmZ d dlZd dlZd dlZd dl Z d dl
m Z d dl m
Z
d dlmZ d dlmZ d dlmZ d dlZd dlmZ d d lmZ d d
lmZ d d lmZ d d lm Z d d
l m Z d dl m Z d dl m Z d dl m!Z! d dl m"Z" d dl#m$Z$ d dl%m&Z' ddl(m)Z) ddl(mZ* ddl+m,Z, ddl+m-Z- ddl.m/Z/ ddl.m0Z0 ddl.m1Z1 dd l.m2Z2 dd l.m3Z3 dd l.m4Z4 dd l.m5Z5 dd l6m7Z7 dd!l6m8Z8 dd"l6m9Z9 dd#l6m:Z: dd$l;m<Z< dd%l=m>Z> dd&l?m@Z@ dd'l?mAZA dd(lBmCZC dd)lBmDZD dd*lBmEZE dd+lBmFZF dd,lBmGZG dd-lHmIZI dd.lJmKZK ddlJm&Z& ejL�rDd d/lMmNZN d d0lMmOZO dd1lPmQZQ dd2lPmRZR ejSd3e*jTd4�ZUejSd5e*jVd4�ZWejSd6e*jXd4�ZYejSd7e*jZd4�Z[ejSd8e*j\d4�Z]dAd=d>�Z^G d?d@� d@e<�Z_dS )B� )� annotationsN)� timedelta)�iscoroutinefunction)�chain)�
TracebackType)�quote)�Headers)�
ImmutableDict)�BadRequestKeyError)�
HTTPException)�InternalServerError)�
BuildError)�
MapAdapter)�RequestRedirect)�RoutingException)�Rule)�is_running_from_reloader)�Response� )�cli)�typing��
AppContext��RequestContext)�_cv_app)� _cv_request)� current_app)�g)�request)� request_ctx)�session)�get_debug_flag)�get_flashed_messages)�get_load_dotenv)�send_from_directory)�App)� _sentinel)� SecureCookieSessionInterface)�SessionInterface)�appcontext_tearing_down)�got_request_exception)�request_finished)�request_started)�request_tearing_down)� Environment)�Request)�
StartResponse)�WSGIEnvironment�� FlaskClient��FlaskCliRunner�T_shell_context_processor)�bound�
T_teardown�T_template_filter�T_template_global�T_template_test�value�timedelta | int | None�return�timedelta | Nonec C s | d u s t | t�r | S t| d�S )N)�seconds)�
isinstancer )r= � rC �</opt/hikvison/venv/lib/python3.10/site-packages/flask/app.py�_make_timedeltaH s
rE c sV e Zd ZU dZei dd�dd�dd�dd�ded d
��d d�d d�d
d�dd�dd�dd�dd�dd�dd�dd�dd�dd�ddddddd ���ZeZd e d < e
Z d e d < e � Z
d!e d"< # $ d�d�� fd3d4�
Zd�d8d9�Zd�d;d<�Zd�d�dAdB�Zd�d�dCdD�Zd�dFdG�Zd�dKdL�Zd�dOdP�Zd�dTdU�Zd�dVdW�Z d�d�d_d`�Zd�d�ddde�Zd�dgdh�Zd�dldm�Zd�dodp�Z d�dqdr�Z d�dudv�Z d�dxdy�Z d�dzd{�Z d�d�dd��Z!d�d�d��Z"d�d�d��Z#d�d�d��Z$ddddd��d�d�d��Z%d�d�d��Z&d�d�d��Z'd�d�d��Z(e)fd�d�d��Z*e)fd�d�d��Z+d�d�d��Z,d�d�d��Z-d�d�d��Z.d�d�d��Z/d�d�d��Z0� Z1S )��Flaska� The flask object implements a WSGI application and acts as the central
object. It is passed the name of the module or package of the
application. Once it is created it will act as a central registry for
the view functions, the URL rules, template configuration and much more.
The name of the package is used to resolve resources from inside the
package or the folder the module is contained in depending on if the
package parameter resolves to an actual python package (a folder with
an :file:`__init__.py` file inside) or a standard module (just a ``.py`` file).
For more information about resource loading, see :func:`open_resource`.
Usually you create a :class:`Flask` instance in your main module or
in the :file:`__init__.py` file of your package like this::
from flask import Flask
app = Flask(__name__)
.. admonition:: About the First Parameter
The idea of the first parameter is to give Flask an idea of what
belongs to your application. This name is used to find resources
on the filesystem, can be used by extensions to improve debugging
information and a lot more.
So it's important what you provide there. If you are using a single
module, `__name__` is always the correct value. If you however are
using a package, it's usually recommended to hardcode the name of
your package there.
For example if your application is defined in :file:`yourapplication/app.py`
you should create it with one of the two versions below::
app = Flask('yourapplication')
app = Flask(__name__.split('.')[0])
Why is that? The application will work even with `__name__`, thanks
to how resources are looked up. However it will make debugging more
painful. Certain extensions can make assumptions based on the
import name of your application. For example the Flask-SQLAlchemy
extension will look for the code in your application that triggered
an SQL query in debug mode. If the import name is not properly set
up, that debugging information is lost. (For example it would only
pick up SQL queries in `yourapplication.app` and not
`yourapplication.views.frontend`)
.. versionadded:: 0.7
The `static_url_path`, `static_folder`, and `template_folder`
parameters were added.
.. versionadded:: 0.8
The `instance_path` and `instance_relative_config` parameters were
added.
.. versionadded:: 0.11
The `root_path` parameter was added.
.. versionadded:: 1.0
The ``host_matching`` and ``static_host`` parameters were added.
.. versionadded:: 1.0
The ``subdomain_matching`` parameter was added. Subdomain
matching needs to be enabled manually now. Setting
:data:`SERVER_NAME` does not implicitly enable it.
:param import_name: the name of the application package
:param static_url_path: can be used to specify a different path for the
static files on the web. Defaults to the name
of the `static_folder` folder.
:param static_folder: The folder with static files that is served at
``static_url_path``. Relative to the application ``root_path``
or an absolute path. Defaults to ``'static'``.
:param static_host: the host to use when adding the static route.
Defaults to None. Required when using ``host_matching=True``
with a ``static_folder`` configured.
:param host_matching: set ``url_map.host_matching`` attribute.
Defaults to False.
:param subdomain_matching: consider the subdomain relative to
:data:`SERVER_NAME` when matching routes. Defaults to False.
:param template_folder: the folder that contains the templates that should
be used by the application. Defaults to
``'templates'`` folder in the root path of the
application.
:param instance_path: An alternative instance path for the application.
By default the folder ``'instance'`` next to the
package or module is assumed to be the instance
path.
:param instance_relative_config: if set to ``True`` relative filenames
for loading the config are assumed to
be relative to the instance path instead
of the application root.
:param root_path: The path to the root of the application files.
This should only be set manually when it can't be detected
automatically, such as for namespace packages.
�DEBUGN�TESTINGF�PROPAGATE_EXCEPTIONS�
SECRET_KEY�PERMANENT_SESSION_LIFETIME� )�days�USE_X_SENDFILE� SERVER_NAME�APPLICATION_ROOT�/�SESSION_COOKIE_NAMEr! �SESSION_COOKIE_DOMAIN�SESSION_COOKIE_PATH�SESSION_COOKIE_HTTPONLYT�SESSION_COOKIE_SECURE�SESSION_COOKIE_SAMESITE� SESSION_REFRESH_EACH_REQUEST�MAX_CONTENT_LENGTH�SEND_FILE_MAX_AGE_DEFAULT�httpi� )�TRAP_BAD_REQUEST_ERRORS�TRAP_HTTP_EXCEPTIONS�EXPLAIN_TEMPLATE_LOADING�PREFERRED_URL_SCHEME�TEMPLATES_AUTO_RELOAD�MAX_COOKIE_SIZEz
type[Request]�
request_classztype[Response]�response_classr) �session_interface�static� templates� import_name�str�static_url_path�
str | None�
static_folder� str | os.PathLike[str] | None� static_host�
host_matching�bool�subdomain_matching�template_folder�
instance_path�instance_relative_config� root_pathc s� t � j||||||||| |
d�
t�� | _| j| j_| jr?t|�|ks'J d��t�| �� | j | j
� d�d|� fdd�d� d S d S )N)
rg ri rk rm rn rp rq rr rs rt z-Invalid static_host/host_matching combinationz/<path:filename>re c s � � j di | ��S )NrC )�send_static_file)�kw��self_refrC rD �<lambda> s z Flask.__init__.<locals>.<lambda>)�endpoint�host� view_func) �super�__init__r �AppGroup�name�has_static_folderro �weakref�ref� add_url_ruleri ) �selfrg ri rk rm rn rp rq rr rs rt �� __class__rw rD r~ � s4
�
�
��zFlask.__init__�filenamer? �
int | Nonec C s0 t jd }|du r dS t|t�rt|�� �S |S )an Used by :func:`send_file` to determine the ``max_age`` cache
value for a given file path if it wasn't passed.
By default, this returns :data:`SEND_FILE_MAX_AGE_DEFAULT` from
the configuration of :data:`~flask.current_app`. This defaults
to ``None``, which tells the browser to use conditional requests
instead of a timed cache, which is usually preferable.
Note this is a duplicate of the same method in the Flask
class.
.. versionchanged:: 2.0
The default configuration is ``None`` instead of 12 hours.
.. versionadded:: 0.9
rZ N)r �configrB r �int�
total_seconds)r� r� r= rC rC rD �get_send_file_max_age s
zFlask.get_send_file_max_ager c C s0 | j std��| �|�}tt�t| j�||d�S )aA The view function used to serve files from
:attr:`static_folder`. A route is automatically registered for
this view at :attr:`static_url_path` if :attr:`static_folder` is
set.
Note this is a duplicate of the same method in the Flask
class.
.. versionadded:: 0.5
z2'static_folder' must be set to serve static_files.)�max_age)r� � RuntimeErrorr� r% �t�castrh rk )r� r� r� rC rC rD ru , s
�zFlask.send_static_file�rb�resource�mode�t.IO[t.AnyStr]c C s& |dvrt d��ttj�| j|�|�S )a� Open a resource file relative to :attr:`root_path` for
reading.
For example, if the file ``schema.sql`` is next to the file
``app.py`` where the ``Flask`` app is defined, it can be opened
with:
.. code-block:: python
with app.open_resource("schema.sql") as f:
conn.executescript(f.read())
:param resource: Path to the resource relative to
:attr:`root_path`.
:param mode: Open the file in this mode. Only reading is
supported, valid values are "r" (or "rt") and "rb".
Note this is a duplicate of the same method in the Flask
class.
> �rr� �rtz)Resources can only be opened for reading.)�
ValueError�open�os�path�joinrt �r� r� r� rC rC rD �
open_resourceB s zFlask.open_resourcec C s t tj�| j|�|�S )a� Opens a resource from the application's instance folder
(:attr:`instance_path`). Otherwise works like
:meth:`open_resource`. Instance resources can also be opened for
writing.
:param resource: the name of the resource. To access resources within
subfolders use forward slashes as separator.
:param mode: resource file opening mode, default is 'rb'.
)r� r� r� r� rr r� rC rC rD �open_instance_resource] s
z Flask.open_instance_resourcer/ c C s� t | j�}d|vr| j|d< d|vr"| jd }|du r | j}||d< | j| fi |��}|jj| jt | jt
t t d� | j
j|jd< |S )a� Create the Jinja environment based on :attr:`jinja_options`
and the various Jinja-related methods of the app. Changing
:attr:`jinja_options` after this will have no effect. Also adds
Flask-related globals and filters to the environment.
.. versionchanged:: 0.11
``Environment.auto_reload`` set in accordance with
``TEMPLATES_AUTO_RELOAD`` configuration option.
.. versionadded:: 0.5
�
autoescape� auto_reloadr` N)�url_forr# r� r r! r zjson.dumps_function)�dict�
jinja_options�select_jinja_autoescaper� �debug�jinja_environment�globals�updater� r# r r! r �json�dumps�policies)r� �optionsr� �rvrC rC rD �create_jinja_environmenti s&
� z Flask.create_jinja_environmentr �Request | None�MapAdapter | Nonec C sp |dur | j s| jjp d}nd}| jj|j| jd |d�S | jd dur6| jj| jd | jd | jd d�S dS )a* Creates a URL adapter for the given request. The URL adapter
is created at a point where the request context is not yet set
up so the request is passed explicitly.
.. versionadded:: 0.6
.. versionchanged:: 0.9
This can now also be called without a request object when the
URL adapter is created for the application context.
.. versionchanged:: 1.0
:data:`SERVER_NAME` no longer implicitly enables subdomain
matching. Use :attr:`subdomain_matching` instead.
NrO )� server_name� subdomainrP r_ )� script_name�
url_scheme)rp �url_map�default_subdomain�bind_to_environ�environr� �bind)r� r r� rC rC rD �create_url_adapter� s ��zFlask.create_url_adapterr0 �
t.NoReturnc C sB | j rt|jt�r|jjdv s|jdv r|j�ddlm} ||��)a� Intercept routing exceptions and possibly do something else.
In debug mode, intercept a routing redirect and replace it with
an error if the body will be discarded.
With modern Werkzeug this shouldn't occur, since it now uses a
308 status which tells the browser to resend the method and
body.
.. versionchanged:: 2.1
Don't intercept 307 and 308 redirects.
:meta private:
:internal:
> �3 �4 > �GET�HEAD�OPTIONSr )�FormDataRoutingRedirect)r� rB �routing_exceptionr �code�method� debughelpersr� )r� r r� rC rC rD �raise_routing_exception� s �
�
z Flask.raise_routing_exception�context�dict[str, t.Any]�Nonec C sd d}t r t|tt j��}|�� }|D ]}|| jv r*| j| D ] }|�| �|�� � q q|�|� dS )a Update the template context with some commonly used variables.
This injects request, session, config and g into the template
context as well as everything template context processors want
to inject. Note that the as of Flask 0.6, the original values
in the context will not be overridden if a context processor
decides to return a value with the same key.
:param context: the context as a dictionary that is updated in place
to add extra variables.
�NN)r r �reversed�
blueprints�copy�template_context_processorsr� � ensure_sync)r� r� �names�orig_ctxr� �funcrC rC rD �update_template_context� s
�z Flask.update_template_contextc C s& | t d�}| jD ]}|�|� � q|S )z�Returns the shell context for an interactive shell for this
application. This runs all the registered shell context
processors.
.. versionadded:: 0.11
)�appr )r �shell_context_processorsr� )r� r� � processorrC rC rD �make_shell_context� s
zFlask.make_shell_contextr{ �portr� � bool | None� load_dotenvr� �t.Anyc K s4 t j�d�dkrt� stjddd� dS t|�r%t�� dt jv r%t � | _
|dur.t |�| _
| j �d�}d }}|rB|�
d �\}} }|sK|rI|}nd
}|sQ|d krVt|�}n |r]t|�}nd }|�d
| j
� |�d| j
� |�dd� t�| j
| j� d dlm}
z|
t�t|�|| fi |�� W d| _dS d| _w )a�
Runs the application on a local development server.
Do not use ``run()`` in a production setting. It is not intended to
meet security and performance requirements for a production server.
Instead, see :doc:`/deploying/index` for WSGI server recommendations.
If the :attr:`debug` flag is set the server will automatically reload
for code changes and show a debugger in case an exception happened.
If you want to run the application in debug mode, but disable the
code execution on the interactive debugger, you can pass
``use_evalex=False`` as parameter. This will keep the debugger's
traceback screen active, but disable code execution.
It is not recommended to use this function for development with
automatic reloading as this is badly supported. Instead you should
be using the :command:`flask` command line script's ``run`` support.
.. admonition:: Keep in Mind
Flask will suppress any server error with a generic error page
unless it is in debug mode. As such to enable just the
interactive debugger without the code reloading, you have to
invoke :meth:`run` with ``debug=True`` and ``use_reloader=False``.
Setting ``use_debugger`` to ``True`` without being in debug mode
won't catch any exceptions because there won't be any to
catch.
:param host: the hostname to listen on. Set this to ``'0.0.0.0'`` to
have the server available externally as well. Defaults to
``'127.0.0.1'`` or the host in the ``SERVER_NAME`` config variable
if present.
:param port: the port of the webserver. Defaults to ``5000`` or the
port defined in the ``SERVER_NAME`` config variable if present.
:param debug: if given, enable or disable debug mode. See
:attr:`debug`.
:param load_dotenv: Load the nearest :file:`.env` and :file:`.flaskenv`
files to set environment variables. Will also change the working
directory to the directory containing the first file found.
:param options: the options to be forwarded to the underlying Werkzeug
server. See :func:`werkzeug.serving.run_simple` for more
information.
.. versionchanged:: 1.0
If installed, python-dotenv will be used to load environment
variables from :file:`.env` and :file:`.flaskenv` files.
The :envvar:`FLASK_DEBUG` environment variable will override :attr:`debug`.
Threaded mode is enabled by default.
.. versionchanged:: 0.10
The default port is now picked from the ``SERVER_NAME``
variable.
�FLASK_RUN_FROM_CLI�truez� * Ignoring a call to 'app.run()' that would block the current 'flask' CLI command.
Only call 'app.run()' in an 'if __name__ == "__main__"' guard.�red)�fgN� FLASK_DEBUGrO �:z 127.0.0.1r i� � use_reloader� use_debugger�threadedT)�
run_simpleF)r� r� �getr �click�sechor$ r r� r" r� ro r� � partitionr� �
setdefault�show_server_bannerr� �werkzeug.servingr� r� r� rh �_got_first_request) r� r{ r� r� r� r� r� �sn_host�sn_port�_r� rC rC rD �run� sD A�
z Flask.run� use_cookies�kwargsr4 c K s2 | j }|du r
ddlm} || | jfd|i|��S )a� Creates a test client for this application. For information
about unit testing head over to :doc:`/testing`.
Note that if you are testing for assertions or exceptions in your
application code, you must set ``app.testing = True`` in order for the
exceptions to propagate to the test client. Otherwise, the exception
will be handled by the application (not visible to the test client) and
the only indication of an AssertionError or other exception will be a
500 status code response to the test client. See the :attr:`testing`
attribute. For example::
app.testing = True
client = app.test_client()
The test client can be used in a ``with`` block to defer the closing down
of the context until the end of the ``with`` block. This is useful if
you want to access the context locals for testing::
with app.test_client() as c:
rv = c.get('/?vodka=42')
assert request.args['vodka'] == '42'
Additionally, you may pass optional keyword arguments that will then
be passed to the application's :attr:`test_client_class` constructor.
For example::
from flask.testing import FlaskClient
class CustomClient(FlaskClient):
def __init__(self, *args, **kwargs):
self._authentication = kwargs.pop("authentication")
super(CustomClient,self).__init__( *args, **kwargs)
app.test_client_class = CustomClient
client = app.test_client(authentication='Basic ....')
See :class:`~flask.testing.FlaskClient` for more information.
.. versionchanged:: 0.4
added support for ``with`` block usage for the client.
.. versionadded:: 0.7
The `use_cookies` parameter was added as well as the ability
to override the client to be used by setting the
:attr:`test_client_class` attribute.
.. versionchanged:: 0.11
Added `**kwargs` to support passing additional keyword arguments to
the constructor of :attr:`test_client_class`.
Nr r3 r� )�test_client_class�testingr4 rc )r� r� r� �clsrC rC rD � test_clientx s 3 ���zFlask.test_clientr6 c K s* | j }|du r
ddlm} || fi |��S )a- Create a CLI runner for testing CLI commands.
See :ref:`testing-cli`.
Returns an instance of :attr:`test_cli_runner_class`, by default
:class:`~flask.testing.FlaskCliRunner`. The Flask app object is
passed as the first argument.
.. versionadded:: 1.0
Nr r5 )�test_cli_runner_classr� r6 )r� r� r� rC rC rD �test_cli_runner� s
zFlask.test_cli_runner�er �&HTTPException | ft.ResponseReturnValuec C sD |j du r|S t|t�r|S | �|tj�}|du r|S | �|�|�S )ac Handles an HTTP exception. By default this will invoke the
registered error handlers and fall back to returning the
exception as response.
.. versionchanged:: 1.0.3
``RoutingException``, used internally for actions such as
slash redirects during routing, is not passed to error
handlers.
.. versionchanged:: 1.0
Exceptions are looked up by code *and* by MRO, so
``HTTPException`` subclasses can be handled with a catch-all
handler for the base ``HTTPException``.
.. versionadded:: 0.3
N)r� rB r �_find_error_handlerr r� r� �r� r� �handlerrC rC rD �handle_http_exception� s
zFlask.handle_http_exception� Exceptionc C sd t |t�r| js
| jd rd|_t |t�r | �|�s | �|�S | �|t j
�}|du r+� | � |�|�S )a> This method is called whenever an exception occurs that
should be handled. A special case is :class:`~werkzeug
.exceptions.HTTPException` which is forwarded to the
:meth:`handle_http_exception` method. This function will either
return a response value or reraise the exception with the same
traceback.
.. versionchanged:: 1.0
Key errors raised from request data like ``form`` show the
bad key in debug mode rather than a generic bad request
message.
.. versionadded:: 0.7
r\ TN) rB r
r� r� �show_exceptionr �trap_http_exceptionr r� r r� r� r� rC rC rD �handle_user_exception� s
��
zFlask.handle_user_exceptionc C s� t �� }tj| | j|d� | jd }|du r | jp| j}|r'|d |u r%� |�| �|� t |d�}| �
|t j �}|durC| �|�|�}| j
|dd�S )a� Handle an exception that did not have an error handler
associated with it, or that was raised from an error handler.
This always causes a 500 ``InternalServerError``.
Always sends the :data:`got_request_exception` signal.
If :data:`PROPAGATE_EXCEPTIONS` is ``True``, such as in debug
mode, the error will be re-raised so that the debugger can
display it. Otherwise, the original exception is logged, and
an :exc:`~werkzeug.exceptions.InternalServerError` is returned.
If an error handler is registered for ``InternalServerError`` or
``500``, it will be used. For consistency, the handler will
always receive the ``InternalServerError``. The original
unhandled exception is available as ``e.original_exception``.
.. versionchanged:: 1.1.0
Always passes the ``InternalServerError`` instance to the
handler, setting ``original_exception`` to the unhandled
error.
.. versionchanged:: 1.1.0
``after_request`` functions and other finalization is done
even for the default 500 response when there is no handler.
.. versionadded:: 0.3
)�_async_wrapper� exceptionrI Nr )�original_exceptionT)�from_error_handler)�sys�exc_infor+ �sendr� r� r� r� �
log_exceptionr r� r r� �finalize_request)r� r� r
� propagate� server_errorr� rC rC rD �handle_exception s
zFlask.handle_exceptionr
�Ctuple[type, BaseException, TracebackType] | tuple[None, None, None]c C s& | j jdtj� dtj� d�|d� dS )a
Logs an exception. This is called by :meth:`handle_exception`
if debugging is disabled and right before the handler is called.
The default implementation logs the exception as error on the
:attr:`logger`.
.. versionadded:: 0.8
z
Exception on z [�])r
N)�logger�errorr r� r� )r� r
rC rC rD r ; s
�zFlask.log_exception�ft.ResponseReturnValuec C s` t j}|jdur
| �|� |j}t|dd�r |jdkr | �� S |j}| � | j
|j �di |��S )a� Does the request dispatching. Matches the URL and returns the
return value of the view or error handler. This does not have to
be a response object. In order to convert the return value to a
proper response object, call :func:`make_response`.
.. versionchanged:: 0.7
This no longer does the exception handling, this code was
moved to the new :meth:`full_dispatch_request`.
N�provide_automatic_optionsFr� rC ) r r r� r� �url_rule�getattrr� � make_default_options_response� view_argsr� �view_functionsrz )r� �req�ruler rC rC rD �dispatch_requestJ s
�
zFlask.dispatch_requestc
C sl d| _ ztj| | jd� | �� }|du r| �� }W n ty0 } z | �|�}W Y d}~nd}~ww | �|�S )z�Dispatches the request and on top of that performs request
pre and postprocessing as well as HTTP exception catching and
error handling.
.. versionadded:: 0.7
T)r N) r� r- r r� �preprocess_requestr r r r
)r� r� r� rC rC rD �full_dispatch_requestc s ���
zFlask.full_dispatch_requestr� �&ft.ResponseReturnValue | HTTPExceptionr c C sT | � |�}z| �|�}tj| | j|d� W |S ty) |s � | j�d� Y |S w )a) Given the return value from a view function this finalizes
the request by converting it into a response and invoking the
postprocessing functions. This is invoked for both normal
request dispatching as well as error handlers.
Because this means that it might be called as a result of a
failure a special safe mode is available which can be enabled
with the `from_error_handler` flag. If enabled, failures in
response processing will be logged and otherwise ignored.
:internal:
)r �responsez?Request finalizing failed with an error while handling an error)�
make_response�process_responser, r r� r r r )r� r� r r" rC rC rD r
u s
� ���zFlask.finalize_requestc C s& t j}|�� }| �� }|j�|� |S )z�This method is called to create the default ``OPTIONS`` response.
This can be changed through subclassing to change the default
behavior of ``OPTIONS`` responses.
.. versionadded:: 0.7
)r � url_adapter�allowed_methodsrc �allowr� )r� �adapter�methodsr� rC rC rD r � s
z#Flask.make_default_options_responser� �t.Callable[..., t.Any]c C s t |�r | �|�S |S )a) Ensure that the function is synchronous for WSGI workers.
Plain ``def`` functions are returned as-is. ``async def``
functions are wrapped to run and wait for the response.
Override this method to change how the app runs async views.
.. versionadded:: 2.0
)r �
async_to_sync)r� r� rC rC rD r� � s
zFlask.ensure_sync�1t.Callable[..., t.Coroutine[t.Any, t.Any, t.Any]]c C s0 z ddl m} W ||�S ty td�d�w )a1 Return a sync function that will run the coroutine function.
.. code-block:: python
result = app.async_to_sync(func)(*args, **kwargs)
Override this method to change how the app converts async code
to be synchronously callable.
.. versionadded:: 2.0
r )r+ zAInstall Flask with the 'async' extra in order to use async views.N)� asgiref.syncr+ � ImportErrorr� )r� r� �asgiref_async_to_syncrC rC rD r+ � s ����zFlask.async_to_sync��_anchor�_method�_scheme� _externalrz r1 r2 r3 r4 �valuesc
K sH t �d�}|dur2|j}|jj} |dd� dkr)| dur#| � |� �}n|dd� }|du r1|du}n t�d�}
|
dur?|
j}n| �d�}|du rLtd��|du rRd}|dur\|s\td��| � ||� z |j
|||||d�} W n" t y� } z|j ||||d� | �
| ||�W Y d} ~ S d} ~ ww |dur�t|d d
�}| � d |� �} | S ) a Generate a URL to the given endpoint with the given values.
This is called by :func:`flask.url_for`, and can be called
directly as well.
An *endpoint* is the name of a URL rule, usually added with
:meth:`@app.route() <route>`, and usually the same name as the
view function. A route defined in a :class:`~flask.Blueprint`
will prepend the blueprint's name separated by a ``.`` to the
endpoint.
In some cases, such as email messages, you want URLs to include
the scheme and domain, like ``https://example.com/hello``. When
not in an active request, URLs will be external by default, but
this requires setting :data:`SERVER_NAME` so Flask knows what
domain to use. :data:`APPLICATION_ROOT` and
:data:`PREFERRED_URL_SCHEME` should also be configured as
needed. This config is only used when not in an active request.
Functions can be decorated with :meth:`url_defaults` to modify
keyword arguments before the URL is built.
If building fails for some reason, such as an unknown endpoint
or incorrect values, the app's :meth:`handle_url_build_error`
method is called. If that returns a string, that is returned,
otherwise a :exc:`~werkzeug.routing.BuildError` is raised.
:param endpoint: The endpoint name associated with the URL to
generate. If this starts with a ``.``, the current blueprint
name (if any) will be used.
:param _anchor: If given, append this as ``#anchor`` to the URL.
:param _method: If given, generate the URL associated with this
method for the endpoint.
:param _scheme: If given, the URL will have this scheme if it
is external.
:param _external: If given, prefer the URL to be internal
(False) or require it to be external (True). External URLs
include the scheme and domain. When not in an active
request, URLs are external by default.
:param values: Values to use for the variable parts of the URL
rule. Unknown keys are appended as query string arguments,
like ``?a=b&c=d``.
.. versionadded:: 2.2
Moved from ``flask.url_for``, which calls this method.
Nr �.z�Unable to build URLs outside an active request without 'SERVER_NAME' configured. Also configure 'APPLICATION_ROOT' and 'PREFERRED_URL_SCHEME' as needed.Tz4When specifying '_scheme', '_external' must be True.)r� r� �force_externalr0 z%!#$&'()*+,/:;=?@)�safe�#)r r� r% r � blueprintr r� r� r� �inject_url_defaults�buildr
r� �handle_url_build_error�
_url_quote)
r� rz r1 r2 r3 r4 r5 �req_ctxr% �blueprint_name�app_ctxr� r rC rC rD r� � sV
9 �
�
���� z
Flask.url_forc
C s� d }}t |t�r4t|�}|dkr|\}}}n |dkr0t |d ttttf�r+|\}}n |\}}ntd��|du rAtdtj�d���t || j �s�t |t
t t f�sUt |t
j�rb| j |||d�}d }}nNt |ttf�rp| j�|�}n@t |t�syt|�r�z
| j �|tj�}W n, ty� } zt|� d t|�j� d
���t�� d �d�d}~ww td t|�j� d
���t�t |�}|dur�t |t
t t f�r�||_ n||_ |r�|j � |� |S ) a� Convert the return value from a view function to an instance of
:attr:`response_class`.
:param rv: the return value from the view function. The view function
must return a response. Returning ``None``, or the view ending
without returning, is not allowed. The following types are allowed
for ``view_rv``:
``str``
A response object is created with the string encoded to UTF-8
as the body.
``bytes``
A response object is created with the bytes as the body.
``dict``
A dictionary that will be jsonify'd before being returned.
``list``
A list that will be jsonify'd before being returned.
``generator`` or ``iterator``
A generator that returns ``str`` or ``bytes`` to be
streamed as the response.
``tuple``
Either ``(body, status, headers)``, ``(body, status)``, or
``(body, headers)``, where ``body`` is any of the other types
allowed here, ``status`` is a string or an integer, and
``headers`` is a dictionary or a list of ``(key, value)``
tuples. If ``body`` is a :attr:`response_class` instance,
``status`` overwrites the exiting value and ``headers`` are
extended.
:attr:`response_class`
The object is returned unchanged.
other :class:`~werkzeug.wrappers.Response` class
The object is coerced to :attr:`response_class`.
:func:`callable`
The function is called as a WSGI application. The result is
used to create a response object.
.. versionchanged:: 2.2
A generator will be converted to a streaming response.
A list will be converted to a JSON response.
.. versionchanged:: 1.1
A dict will be converted to a JSON response.
.. versionchanged:: 0.9
Previously a tuple was interpreted as the arguments for the
response object.
N� � r z�The view function did not return a valid response tuple. The tuple must have the form (body, status, headers), (body, status), or (body, headers).zThe view function for zh did not return a valid response. The function either returned None or ended without a return statement.)�status�headersz�
The view function did not return a valid response. The return type must be a string, dict, list, tuple with headers or status, Response instance, or WSGI callable, but it was a r6 z�The view function did not return a valid response. The return type must be a string, dict, list, tuple with headers or status, Response instance, or WSGI callable, but it was a )!rB �tuple�lenr r� �list� TypeErrorr rz rc rh �bytes� bytearray�cabc�Iteratorr� r" � BaseResponse�callable�
force_typer� �type�__name__�with_tracebackr r
r� r� r rD � status_coderE r� )r� r� rD rE �len_rvr� rC rC rD r# D sn 9
� � �
������ �� zFlask.make_response� ft.ResponseReturnValue | Nonec C s� dgt tj��R }|D ]}|| jv r!| j| D ] }|tjtj� qq |D ] }|| jv rC| j| D ]}| �|�� }|durB| S q0q$dS )a� Called before the request is dispatched. Calls
:attr:`url_value_preprocessors` registered with the app and the
current blueprint (if any). Then calls :attr:`before_request_funcs`
registered with the app and the blueprint.
If any :meth:`before_request` handler returns a non-None value, the
value is handled as if it was the return value from the view, and
further request handling is stopped.
N)r� r r� �url_value_preprocessorsrz r �before_request_funcsr� )r� r� r� �url_func� before_funcr� rC rC rD r � s
�
��zFlask.preprocess_requestr" c C s� t �� }|jD ] }| �|�|�}qttjd�D ]}|| jv r/t| j| �D ] }| �|�|�}q%q| j �
|j �s@| j � | |j |� |S )a Can be overridden in order to modify the response object
before it's sent to the WSGI server. By default this will
call all the :meth:`after_request` decorated functions.
.. versionchanged:: 0.5
As of Flask 0.5 the functions registered for after request
execution are called in reverse order of registration.
:param response: a :attr:`response_class` object.
:return: a new response object or the same, has to be an
instance of :attr:`response_class`.
r� )
r �_get_current_object�_after_request_functionsr� r r r� �after_request_funcsr� rd �is_null_sessionr! � save_session)r� r" �ctxr� r� rC rC rD r$ � s
�zFlask.process_response�exc�BaseException | Nonec C sh |t u r
t�� d }ttjd�D ]}|| jv r(t| j| �D ] }| �|�|� q qt j
| | j|d� dS )a2 Called after the request is dispatched and the response is
returned, right before the request context is popped.
This calls all functions decorated with
:meth:`teardown_request`, and :meth:`Blueprint.teardown_request`
if a blueprint handled the request. Finally, the
:data:`request_tearing_down` signal is sent.
This is called by
:meth:`RequestContext.pop() <flask.ctx.RequestContext.pop>`,
which may be delayed during testing to maintain access to
resources.
:param exc: An unhandled exception raised while dispatching the
request. Detected from the current exception information if
not passed. Passed to each teardown function.
.. versionchanged:: 0.9
Added the ``exc`` argument.
r r� �r ra N) r' r r
r r r� �teardown_request_funcsr� r� r. r )r� ra r� r� rC rC rD �do_teardown_request s
�zFlask.do_teardown_requestc C sH |t u r
t�� d }t| j�D ] }| �|�|� qtj| | j|d� dS )a� Called right before the application context is popped.
When handling a request, the application context is popped
after the request context. See :meth:`do_teardown_request`.
This calls all functions decorated with
:meth:`teardown_appcontext`. Then the
:data:`appcontext_tearing_down` signal is sent.
This is called by
:meth:`AppContext.pop() <flask.ctx.AppContext.pop>`.
.. versionadded:: 0.9
r rc N)r' r r
r� �teardown_appcontext_funcsr� r* r )r� ra r� rC rC rD �do_teardown_appcontext* s
z Flask.do_teardown_appcontextr c C s t | �S )aF Create an :class:`~flask.ctx.AppContext`. Use as a ``with``
block to push the context, which will make :data:`current_app`
point at this application.
An application context is automatically pushed by
:meth:`RequestContext.push() <flask.ctx.RequestContext.push>`
when handling a request, and when running a CLI command. Use
this to manually create a context outside of these situations.
::
with app.app_context():
init_db()
See :doc:`/appcontext`.
.. versionadded:: 0.9
r )r� rC rC rD � app_contextD s zFlask.app_contextr� r2 r c C s
t | |�S )a$ Create a :class:`~flask.ctx.RequestContext` representing a
WSGI environment. Use a ``with`` block to push the context,
which will make :data:`request` point at this request.
See :doc:`/reqcontext`.
Typically you should not call this from your own code. A request
context is automatically pushed by the :meth:`wsgi_app` when
handling a request. Use :meth:`test_request_context` to create
an environment and context instead of this method.
:param environ: a WSGI environment
r )r� r� rC rC rD �request_contextY s
zFlask.request_context�argsc O sF ddl m} || g|�R i |��}z | �|�� �W |�� S |�� w )a� Create a :class:`~flask.ctx.RequestContext` for a WSGI
environment created from the given values. This is mostly useful
during testing, where you may want to run a function that uses
request data without dispatching a full request.
See :doc:`/reqcontext`.
Use a ``with`` block to push the context, which will make
:data:`request` point at the request for the created
environment. ::
with app.test_request_context(...):
generate_report()
When using the shell, it may be easier to push and pop the
context manually to avoid indentation. ::
ctx = app.test_request_context(...)
ctx.push()
...
ctx.pop()
Takes the same arguments as Werkzeug's
:class:`~werkzeug.test.EnvironBuilder`, with some defaults from
the application. See the linked Werkzeug docs for most of the
available arguments. Flask-specific behavior is listed here.
:param path: URL path being requested.
:param base_url: Base URL where the app is being served, which
``path`` is relative to. If not given, built from
:data:`PREFERRED_URL_SCHEME`, ``subdomain``,
:data:`SERVER_NAME`, and :data:`APPLICATION_ROOT`.
:param subdomain: Subdomain name to append to
:data:`SERVER_NAME`.
:param url_scheme: Scheme to use instead of
:data:`PREFERRED_URL_SCHEME`.
:param data: The request body, either as a string or a dict of
form keys and values.
:param json: If given, this is serialized as JSON and passed as
``data``. Also defaults ``content_type`` to
``application/json``.
:param args: other positional arguments passed to
:class:`~werkzeug.test.EnvironBuilder`.
:param kwargs: other keyword arguments passed to
:class:`~werkzeug.test.EnvironBuilder`.
r )�EnvironBuilder)r� rk ri � get_environ�close)r� rj r� rk �builderrC rC rD �test_request_contexti s
/zFlask.test_request_context�start_responser1 �cabc.Iterable[bytes]c
C s | � |�}d}zWz
|�� | �� }W n" ty+ } z
|}| �|�}W Y d}~nd}~w t�� d }� |||�W d|v rN|d t�� � |d t �� � |durY| �
|�rYd}|� |� S d|v rs|d t�� � |d t �� � |dur~| �
|�r~d}|� |� w )a� The actual WSGI application. This is not implemented in
:meth:`__call__` so that middlewares can be applied without
losing a reference to the app object. Instead of doing this::
app = MyMiddleware(app)
It's a better idea to do this instead::
app.wsgi_app = MyMiddleware(app.wsgi_app)
Then you still have the original application object around and
can continue to call methods on it.
.. versionchanged:: 0.7
Teardown events for the request and app contexts are called
even if an unhandled error occurs. Other events may not be
called depending on when an error occurs during dispatch.
See :ref:`callbacks-and-errors`.
:param environ: A WSGI environment.
:param start_response: A callable accepting a status code,
a list of headers, and an optional exception context to
start the response.
Nr z werkzeug.debug.preserve_context) ri �pushr r r r r
r r� r �should_ignore_error�pop)r� r� rp r` r r" r� rC rC rD �wsgi_app� s4
�
� zFlask.wsgi_appc C s | � ||�S )z�The WSGI server calls the Flask application object as the
WSGI application. This calls :meth:`wsgi_app`, which can be
wrapped to apply middleware.
)ru )r� r� rp rC rC rD �__call__� s zFlask.__call__) Nre NFFrf NFN)rg rh ri rj rk rl rm rj rn ro rp ro rq rl rr rj rs ro rt rj )r� rj r? r� )r� rh r? r )r� )r� rh r� rh r? r� )r? r/ )r r� r? r� )r r0 r? r� )r� r� r? r� )r? r� )NNNT) r{ rj r� r� r� r� r� ro r� r� r? r� )T)r� ro r� r� r? r4 )r� r� r? r6 )r� r r? r� )r� r r? r� )r� r r? r )r
r r? r� )r? r )r? r )F)r� r! r ro r? r )r� r* r? r* )r� r, r? r* )rz rh r1 rj r2 rj r3 rj r4 r� r5 r� r? rh )r� r r? r )r? rV )r" r r? r )ra rb r? r� )r? r )r� r2 r? r )rj r� r� r� r? r )r� r2 rp r1 r? rq )2rR �
__module__� __qualname__�__doc__r r �default_configr0 rb �__annotations__r rc r( rd r~ r� ru r� r� r� r� r� r� r� r� r� r� r r r r r r r
r r� r+ r� r# r r$ r' re rg rh ri ro ru rv �
__classcell__rC rC r� rD rF O s�
`����
���� �
� � �
������� �
7
(
(
� {
:
#
5
�
�
~
�$ �
82rF )r= r> r? r@ )`�
__future__r �collections.abc�abcrL r� r r r� r� �datetimer �inspectr � itertoolsr �typesr � urllib.parser r> r� �werkzeug.datastructuresr r �werkzeug.exceptionsr
r r �werkzeug.routingr
r r r r r� r �werkzeug.wrappersr rN � r �ftr` r r r� r r r r r r r! �helpersr" r# r$ r% �
sansio.appr& �sansio.scaffoldr' �sessionsr( r) �signalsr* r+ r, r- r. �
templatingr/ �wrappersr0 �
TYPE_CHECKING�_typeshed.wsgir1 r2 r� r4 r6 �TypeVar� ShellContextProcessorCallabler7 �TeardownCallabler9 �TemplateFilterCallabler: �TemplateGlobalCallabler; �TemplateTestCallabler< rE rF rC rC rC rD �<module> s� �