OpenQuizz
Une application de gestion des contenus pédagogiques
Flask Class Reference
Inheritance diagram for Flask:
Collaboration diagram for Flask:

Public Member Functions

def __init__ (self, import_name, static_url_path=None, static_folder="static", static_host=None, host_matching=False, subdomain_matching=False, template_folder="templates", instance_path=None, instance_relative_config=False, root_path=None)
 
def name (self)
 
def propagate_exceptions (self)
 
def preserve_context_on_exception (self)
 
def logger (self)
 
def jinja_env (self)
 
def got_first_request (self)
 
def make_config (self, instance_relative=False)
 
def auto_find_instance_path (self)
 
def open_instance_resource (self, resource, mode="rb")
 
def templates_auto_reload (self)
 
def templates_auto_reload (self, value)
 
def create_jinja_environment (self)
 
def create_global_jinja_loader (self)
 
def select_jinja_autoescape (self, filename)
 
def update_template_context (self, context)
 
def make_shell_context (self)
 
def debug (self)
 
def debug (self, value)
 
def run (self, host=None, port=None, debug=None, load_dotenv=True, **options)
 
def test_client (self, use_cookies=True, **kwargs)
 
def test_cli_runner (self, **kwargs)
 
def open_session (self, request)
 
def save_session (self, session, response)
 
def make_null_session (self)
 
def register_blueprint (self, blueprint, **options)
 
def iter_blueprints (self)
 
def add_url_rule (self, rule, endpoint=None, view_func=None, provide_automatic_options=None, **options)
 
def route (self, rule, **options)
 
def endpoint (self, endpoint)
 
def errorhandler (self, code_or_exception)
 
def register_error_handler (self, code_or_exception, f)
 
def template_filter (self, name=None)
 
def add_template_filter (self, f, name=None)
 
def template_test (self, name=None)
 
def add_template_test (self, f, name=None)
 
def template_global (self, name=None)
 
def add_template_global (self, f, name=None)
 
def before_request (self, f)
 
def before_first_request (self, f)
 
def after_request (self, f)
 
def teardown_request (self, f)
 
def teardown_appcontext (self, f)
 
def context_processor (self, f)
 
def shell_context_processor (self, f)
 
def url_value_preprocessor (self, f)
 
def url_defaults (self, f)
 
def handle_http_exception (self, e)
 
def trap_http_exception (self, e)
 
def handle_user_exception (self, e)
 
def handle_exception (self, e)
 
def log_exception (self, exc_info)
 
def raise_routing_exception (self, request)
 
def dispatch_request (self)
 
def full_dispatch_request (self)
 
def finalize_request (self, rv, from_error_handler=False)
 
def try_trigger_before_first_request_functions (self)
 
def make_default_options_response (self)
 
def should_ignore_error (self, error)
 
def make_response (self, rv)
 
def create_url_adapter (self, request)
 
def inject_url_defaults (self, endpoint, values)
 
def handle_url_build_error (self, error, endpoint, values)
 
def preprocess_request (self)
 
def process_response (self, response)
 
def do_teardown_request (self, exc=_sentinel)
 
def do_teardown_appcontext (self, exc=_sentinel)
 
def app_context (self)
 
def request_context (self, environ)
 
def test_request_context (self, *args, **kwargs)
 
def wsgi_app (self, environ, start_response)
 
def __call__ (self, environ, start_response)
 
def __repr__ (self)
 
- Public Member Functions inherited from _PackageBoundObject
def __init__ (self, import_name, template_folder=None, root_path=None)
 
def static_folder (self)
 
def static_folder (self, value)
 
def static_url_path (self)
 
def static_url_path (self, value)
 
def has_static_folder (self)
 
def jinja_loader (self)
 
def get_send_file_max_age (self, filename)
 
def send_static_file (self, filename)
 
def open_resource (self, resource, mode="rb")
 

Data Fields

 static_url_path
 
 static_folder
 
 instance_path
 
 config
 
 view_functions
 
 error_handler_spec
 
 url_build_error_handlers
 
 before_request_funcs
 
 before_first_request_funcs
 
 after_request_funcs
 
 teardown_request_funcs
 
 teardown_appcontext_funcs
 
 url_value_preprocessors
 
 url_default_functions
 
 template_context_processors
 
 shell_context_processors
 
 blueprints
 
 extensions
 
 url_map
 
 subdomain_matching
 
 debug
 
- Data Fields inherited from _PackageBoundObject
 cli
 

Static Public Attributes

 request_class = Request
 
 response_class = Response
 
 jinja_environment = Environment
 
 app_ctx_globals_class = _AppCtxGlobals
 
 config_class = Config
 
 testing = ConfigAttribute("TESTING")
 
 secret_key = ConfigAttribute("SECRET_KEY")
 
 session_cookie_name = ConfigAttribute("SESSION_COOKIE_NAME")
 
 permanent_session_lifetime
 
 send_file_max_age_default
 
 use_x_sendfile = ConfigAttribute("USE_X_SENDFILE")
 
 json_encoder = json.JSONEncoder
 
 json_decoder = json.JSONDecoder
 
dictionary jinja_options = {"extensions": ["jinja2.ext.autoescape", "jinja2.ext.with_"]}
 
 default_config
 
 url_rule_class = Rule
 
 url_map_class = Map
 
 test_client_class = None
 
 test_cli_runner_class = None
 
 session_interface = SecureCookieSessionInterface()
 
 import_name = None
 
 template_folder = None
 
 root_path = None
 
 env = ConfigAttribute("ENV")
 
- Static Public Attributes inherited from _PackageBoundObject
 import_name
 
 template_folder
 
 root_path
 

Detailed Description

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: Flask by default will automatically calculate the path
                  to the root of the application.  In certain situations
                  this cannot be achieved (for instance if the package
                  is a Python 3 namespace package) and needs to be
                  manually defined.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  import_name,
  static_url_path = None,
  static_folder = "static",
  static_host = None,
  host_matching = False,
  subdomain_matching = False,
  template_folder = "templates",
  instance_path = None,
  instance_relative_config = False,
  root_path = None 
)

Member Function Documentation

◆ __call__()

def __call__ (   self,
  environ,
  start_response 
)
The WSGI server calls the Flask application object as the
WSGI application. This calls :meth:`wsgi_app` which can be
wrapped to applying middleware.

◆ __repr__()

def __repr__ (   self)

◆ add_template_filter()

def add_template_filter (   self,
  f,
  name = None 
)
Register a custom template filter.  Works exactly like the
:meth:`template_filter` decorator.

:param name: the optional name of the filter, otherwise the
     function name will be used.

◆ add_template_global()

def add_template_global (   self,
  f,
  name = None 
)
Register a custom template global function. Works exactly like the
:meth:`template_global` decorator.

.. versionadded:: 0.10

:param name: the optional name of the global function, otherwise the
     function name will be used.

◆ add_template_test()

def add_template_test (   self,
  f,
  name = None 
)
Register a custom template test.  Works exactly like the
:meth:`template_test` decorator.

.. versionadded:: 0.10

:param name: the optional name of the test, otherwise the
     function name will be used.

◆ add_url_rule()

def add_url_rule (   self,
  rule,
  endpoint = None,
  view_func = None,
  provide_automatic_options = None,
**  options 
)
Connects a URL rule.  Works exactly like the :meth:`route`
decorator.  If a view_func is provided it will be registered with the
endpoint.

Basically this example::

    @app.route('/')
    def index():
pass

Is equivalent to the following::

    def index():
pass
    app.add_url_rule('/', 'index', index)

If the view_func is not provided you will need to connect the endpoint
to a view function like so::

    app.view_functions['index'] = index

Internally :meth:`route` invokes :meth:`add_url_rule` so if you want
to customize the behavior via subclassing you only need to change
this method.

For more information refer to :ref:`url-route-registrations`.

.. versionchanged:: 0.2
   `view_func` parameter added.

.. versionchanged:: 0.6
   ``OPTIONS`` is added automatically as method.

:param rule: the URL rule as string
:param endpoint: the endpoint for the registered URL rule.  Flask
         itself assumes the name of the view function as
         endpoint
:param view_func: the function to call when serving a request to the
          provided endpoint
:param provide_automatic_options: controls whether the ``OPTIONS``
    method should be added automatically. This can also be controlled
    by setting the ``view_func.provide_automatic_options = False``
    before adding the rule.
:param options: the options to be forwarded to the underlying
        :class:`~werkzeug.routing.Rule` object.  A change
        to Werkzeug is handling of method options.  methods
        is a list of methods this rule should be limited
        to (``GET``, ``POST`` etc.).  By default a rule
        just listens for ``GET`` (and implicitly ``HEAD``).
        Starting with Flask 0.6, ``OPTIONS`` is implicitly
        added and handled by the standard request handling.

◆ after_request()

def after_request (   self,
  f 
)
Register a function to be run after each request.

Your function must take one parameter, an instance of
:attr:`response_class` and return a new response object or the
same (see :meth:`process_response`).

As of Flask 0.7 this function might not be executed at the end of the
request in case an unhandled exception occurred.

◆ app_context()

def app_context (   self)
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

◆ auto_find_instance_path()

def auto_find_instance_path (   self)
Tries to locate the instance path if it was not provided to the
constructor of the application class.  It will basically calculate
the path to a folder named ``instance`` next to your main file or
the package.

.. versionadded:: 0.8

◆ before_first_request()

def before_first_request (   self,
  f 
)
Registers a function to be run before the first request to this
instance of the application.

The function will be called without any arguments and its return
value is ignored.

.. versionadded:: 0.8

◆ before_request()

def before_request (   self,
  f 
)
Registers a function to run before each request.

For example, this can be used to open a database connection, or to load
the logged in user from the session.

The function will be called without any arguments. If it 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.

◆ context_processor()

def context_processor (   self,
  f 
)
Registers a template context processor function.

◆ create_global_jinja_loader()

def create_global_jinja_loader (   self)
Creates the loader for the Jinja2 environment.  Can be used to
override just the loader and keeping the rest unchanged.  It's
discouraged to override this function.  Instead one should override
the :meth:`jinja_loader` function instead.

The global loader dispatches between the loaders of the application
and the individual blueprints.

.. versionadded:: 0.7

◆ create_jinja_environment()

def create_jinja_environment (   self)
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

◆ create_url_adapter()

def create_url_adapter (   self,
  request 
)
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.

◆ debug() [1/2]

def debug (   self)
Whether debug mode is enabled. When using ``flask run`` to start
the development server, an interactive debugger will be shown for
unhandled exceptions, and the server will be reloaded when code
changes. This maps to the :data:`DEBUG` config key. This is
enabled when :attr:`env` is ``'development'`` and is overridden
by the ``FLASK_DEBUG`` environment variable. It may not behave as
expected if set in code.

**Do not enable debug mode when deploying in production.**

Default: ``True`` if :attr:`env` is ``'development'``, or
``False`` otherwise.

◆ debug() [2/2]

def debug (   self,
  value 
)

◆ dispatch_request()

def dispatch_request (   self)
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`.

◆ do_teardown_appcontext()

def do_teardown_appcontext (   self,
  exc = _sentinel 
)
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

◆ do_teardown_request()

def do_teardown_request (   self,
  exc = _sentinel 
)
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.

◆ endpoint()

def endpoint (   self,
  endpoint 
)
A decorator to register a function as an endpoint.
Example::

    @app.endpoint('example.endpoint')
    def example():
return "example"

:param endpoint: the name of the endpoint

◆ errorhandler()

def errorhandler (   self,
  code_or_exception 
)
Register a function to handle errors by code or exception class.

A decorator that is used to register a function given an
error code.  Example::

    @app.errorhandler(404)
    def page_not_found(error):
return 'This page does not exist', 404

You can also register handlers for arbitrary exceptions::

    @app.errorhandler(DatabaseError)
    def special_exception_handler(error):
return 'Database connection failed', 500

.. versionadded:: 0.7
    Use :meth:`register_error_handler` instead of modifying
    :attr:`error_handler_spec` directly, for application wide error
    handlers.

.. versionadded:: 0.7
   One can now additionally also register custom exception types
   that do not necessarily have to be a subclass of the
   :class:`~werkzeug.exceptions.HTTPException` class.

:param code_or_exception: the code as integer for the handler, or
                  an arbitrary exception

◆ finalize_request()

def finalize_request (   self,
  rv,
  from_error_handler = False 
)
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:

◆ full_dispatch_request()

def full_dispatch_request (   self)
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

◆ got_first_request()

def got_first_request (   self)
This attribute is set to ``True`` if the application started
handling the first request.

.. versionadded:: 0.8

◆ handle_exception()

def handle_exception (   self,
  e 
)
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 :attr:`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``.

.. note::
    Prior to Werkzeug 1.0.0, ``InternalServerError`` will not
    always have an ``original_exception`` attribute. Use
    ``getattr(e, "original_exception", None)`` to simulate the
    behavior for compatibility.

.. 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

◆ handle_http_exception()

def handle_http_exception (   self,
  e 
)
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
    ``HTTPExcpetion`` subclasses can be handled with a catch-all
    handler for the base ``HTTPException``.

.. versionadded:: 0.3

◆ handle_url_build_error()

def handle_url_build_error (   self,
  error,
  endpoint,
  values 
)
Handle :class:`~werkzeug.routing.BuildError` on :meth:`url_for`.

◆ handle_user_exception()

def handle_user_exception (   self,
  e 
)
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

◆ inject_url_defaults()

def inject_url_defaults (   self,
  endpoint,
  values 
)
Injects the URL defaults for the given endpoint directly into
the values dictionary passed.  This is used internally and
automatically called on URL building.

.. versionadded:: 0.7

◆ iter_blueprints()

def iter_blueprints (   self)
Iterates over all blueprints by the order they were registered.

.. versionadded:: 0.11

◆ jinja_env()

def jinja_env (   self)
The Jinja environment used to load templates.

The environment is created the first time this property is
accessed. Changing :attr:`jinja_options` after that will have no
effect.

◆ log_exception()

def log_exception (   self,
  exc_info 
)
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

◆ logger()

def logger (   self)
A standard Python :class:`~logging.Logger` for the app, with
the same name as :attr:`name`.

In debug mode, the logger's :attr:`~logging.Logger.level` will
be set to :data:`~logging.DEBUG`.

If there are no handlers configured, a default handler will be
added. See :doc:`/logging` for more information.

.. versionchanged:: 1.1.0
    The logger takes the same name as :attr:`name` rather than
    hard-coding ``"flask.app"``.

.. versionchanged:: 1.0.0
    Behavior was simplified. The logger is always named
    ``"flask.app"``. The level is only set during configuration,
    it doesn't check ``app.debug`` each time. Only one format is
    used, not different ones depending on ``app.debug``. No
    handlers are removed, and a handler is only added if no
    handlers are already configured.

.. versionadded:: 0.3

◆ make_config()

def make_config (   self,
  instance_relative = False 
)
Used to create the config attribute by the Flask constructor.
The `instance_relative` parameter is passed in from the constructor
of Flask (there named `instance_relative_config`) and indicates if
the config should be relative to the instance path or the root path
of the application.

.. versionadded:: 0.8

◆ make_default_options_response()

def make_default_options_response (   self)
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

◆ make_null_session()

def make_null_session (   self)
Creates a new instance of a missing session.  Instead of overriding
this method we recommend replacing the :class:`session_interface`.

.. deprecated: 1.0
    Will be removed in 2.0. Use
    ``session_interface.make_null_session`` instead.

.. versionadded:: 0.7

◆ make_response()

def make_response (   self,
  rv 
)
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`` (``unicode`` in Python 2)
A response object is created with the string encoded to UTF-8
as the body.

    ``bytes`` (``str`` in Python 2)
A response object is created with the bytes as the body.

    ``dict``
A dictionary that will be jsonify'd before being returned.

    ``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:: 0.9
   Previously a tuple was interpreted as the arguments for the
   response object.

◆ make_shell_context()

def make_shell_context (   self)
Returns the shell context for an interactive shell for this
application.  This runs all the registered shell context
processors.

.. versionadded:: 0.11

◆ name()

def name (   self)
The name of the application.  This is usually the import name
with the difference that it's guessed from the run file if the
import name is main.  This name is used as a display name when
Flask needs the name of the application.  It can be set and overridden
to change the value.

.. versionadded:: 0.8

◆ open_instance_resource()

def open_instance_resource (   self,
  resource,
  mode = "rb" 
)
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'.

◆ open_session()

def open_session (   self,
  request 
)
Creates or opens a new session.  Default implementation stores all
session data in a signed cookie.  This requires that the
:attr:`secret_key` is set.  Instead of overriding this method
we recommend replacing the :class:`session_interface`.

.. deprecated: 1.0
    Will be removed in 2.0. Use
    ``session_interface.open_session`` instead.

:param request: an instance of :attr:`request_class`.

◆ preprocess_request()

def preprocess_request (   self)
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.

◆ preserve_context_on_exception()

def preserve_context_on_exception (   self)
Returns the value of the ``PRESERVE_CONTEXT_ON_EXCEPTION``
configuration value in case it's set, otherwise a sensible default
is returned.

.. versionadded:: 0.7

◆ process_response()

def process_response (   self,
  response 
)
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`.

◆ propagate_exceptions()

def propagate_exceptions (   self)
Returns the value of the ``PROPAGATE_EXCEPTIONS`` configuration
value in case it's set, otherwise a sensible default is returned.

.. versionadded:: 0.7

◆ raise_routing_exception()

def raise_routing_exception (   self,
  request 
)
Exceptions that are recording during routing are reraised with
this method.  During debug we are not reraising redirect requests
for non ``GET``, ``HEAD``, or ``OPTIONS`` requests and we're raising
a different error instead to help debug situations.

:internal:

◆ register_blueprint()

def register_blueprint (   self,
  blueprint,
**  options 
)
Register a :class:`~flask.Blueprint` on the application. Keyword
arguments passed to this method will override the defaults set on the
blueprint.

Calls the blueprint's :meth:`~flask.Blueprint.register` method after
recording the blueprint in the application's :attr:`blueprints`.

:param blueprint: The blueprint to register.
:param url_prefix: Blueprint routes will be prefixed with this.
:param subdomain: Blueprint routes will match on this subdomain.
:param url_defaults: Blueprint routes will use these default values for
    view arguments.
:param options: Additional keyword arguments are passed to
    :class:`~flask.blueprints.BlueprintSetupState`. They can be
    accessed in :meth:`~flask.Blueprint.record` callbacks.

.. versionadded:: 0.7

◆ register_error_handler()

def register_error_handler (   self,
  code_or_exception,
  f 
)
Alternative error attach function to the :meth:`errorhandler`
decorator that is more straightforward to use for non decorator
usage.

.. versionadded:: 0.7

◆ request_context()

def request_context (   self,
  environ 
)
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

◆ route()

def route (   self,
  rule,
**  options 
)
A decorator that is used to register a view function for a
given URL rule.  This does the same thing as :meth:`add_url_rule`
but is intended for decorator usage::

    @app.route('/')
    def index():
return 'Hello World'

For more information refer to :ref:`url-route-registrations`.

:param rule: the URL rule as string
:param endpoint: the endpoint for the registered URL rule.  Flask
         itself assumes the name of the view function as
         endpoint
:param options: the options to be forwarded to the underlying
        :class:`~werkzeug.routing.Rule` object.  A change
        to Werkzeug is handling of method options.  methods
        is a list of methods this rule should be limited
        to (``GET``, ``POST`` etc.).  By default a rule
        just listens for ``GET`` (and implicitly ``HEAD``).
        Starting with Flask 0.6, ``OPTIONS`` is implicitly
        added and handled by the standard request handling.

◆ run()

def run (   self,
  host = None,
  port = None,
  debug = None,
  load_dotenv = True,
**  options 
)
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 :ref:`deployment` 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.

    If set, the :envvar:`FLASK_ENV` and :envvar:`FLASK_DEBUG`
    environment variables will override :attr:`env` and
    :attr:`debug`.

    Threaded mode is enabled by default.

.. versionchanged:: 0.10
    The default port is now picked from the ``SERVER_NAME``
    variable.

◆ save_session()

def save_session (   self,
  session,
  response 
)
Saves the session if it needs updates.  For the default
implementation, check :meth:`open_session`.  Instead of overriding this
method we recommend replacing the :class:`session_interface`.

.. deprecated: 1.0
    Will be removed in 2.0. Use
    ``session_interface.save_session`` instead.

:param session: the session to be saved (a
        :class:`~werkzeug.contrib.securecookie.SecureCookie`
        object)
:param response: an instance of :attr:`response_class`

◆ select_jinja_autoescape()

def select_jinja_autoescape (   self,
  filename 
)
Returns ``True`` if autoescaping should be active for the given
template name. If no template name is given, returns `True`.

.. versionadded:: 0.5

◆ shell_context_processor()

def shell_context_processor (   self,
  f 
)
Registers a shell context processor function.

.. versionadded:: 0.11

◆ should_ignore_error()

def should_ignore_error (   self,
  error 
)
This is called to figure out if an error should be ignored
or not as far as the teardown system is concerned.  If this
function returns ``True`` then the teardown handlers will not be
passed the error.

.. versionadded:: 0.10

◆ teardown_appcontext()

def teardown_appcontext (   self,
  f 
)
Registers a function to be called when the application context
ends.  These functions are typically also called when the request
context is popped.

Example::

    ctx = app.app_context()
    ctx.push()
    ...
    ctx.pop()

When ``ctx.pop()`` is executed in the above example, the teardown
functions are called just before the app context moves from the
stack of active contexts.  This becomes relevant if you are using
such constructs in tests.

Since a request context typically also manages an application
context it would also be called when you pop a request context.

When a teardown function was called because of an unhandled exception
it will be passed an error object. If an :meth:`errorhandler` is
registered, it will handle the exception and the teardown will not
receive it.

The return values of teardown functions are ignored.

.. versionadded:: 0.9

◆ teardown_request()

def teardown_request (   self,
  f 
)
Register a function to be run at the end of each request,
regardless of whether there was an exception or not.  These functions
are executed when the request context is popped, even if not an
actual request was performed.

Example::

    ctx = app.test_request_context()
    ctx.push()
    ...
    ctx.pop()

When ``ctx.pop()`` is executed in the above example, the teardown
functions are called just before the request context moves from the
stack of active contexts.  This becomes relevant if you are using
such constructs in tests.

Generally teardown functions must take every necessary step to avoid
that they will fail.  If they do execute code that might fail they
will have to surround the execution of these code by try/except
statements and log occurring errors.

When a teardown function was called because of an exception it will
be passed an error object.

The return values of teardown functions are ignored.

.. admonition:: Debug Note

   In debug mode Flask will not tear down a request on an exception
   immediately.  Instead it will keep it alive so that the interactive
   debugger can still access it.  This behavior can be controlled
   by the ``PRESERVE_CONTEXT_ON_EXCEPTION`` configuration variable.

◆ template_filter()

def template_filter (   self,
  name = None 
)
A decorator that is used to register custom template filter.
You can specify a name for the filter, otherwise the function
name will be used. Example::

  @app.template_filter()
  def reverse(s):
      return s[::-1]

:param name: the optional name of the filter, otherwise the
     function name will be used.

◆ template_global()

def template_global (   self,
  name = None 
)
A decorator that is used to register a custom template global function.
You can specify a name for the global function, otherwise the function
name will be used. Example::

    @app.template_global()
    def double(n):
return 2 * n

.. versionadded:: 0.10

:param name: the optional name of the global function, otherwise the
     function name will be used.

◆ template_test()

def template_test (   self,
  name = None 
)
A decorator that is used to register custom template test.
You can specify a name for the test, otherwise the function
name will be used. Example::

  @app.template_test()
  def is_prime(n):
      if n == 2:
  return True
      for i in range(2, int(math.ceil(math.sqrt(n))) + 1):
  if n % i == 0:
      return False
      return True

.. versionadded:: 0.10

:param name: the optional name of the test, otherwise the
     function name will be used.

◆ templates_auto_reload() [1/2]

def templates_auto_reload (   self)
Reload templates when they are changed. Used by
:meth:`create_jinja_environment`.

This attribute can be configured with :data:`TEMPLATES_AUTO_RELOAD`. If
not set, it will be enabled in debug mode.

.. versionadded:: 1.0
    This property was added but the underlying config and behavior
    already existed.

◆ templates_auto_reload() [2/2]

def templates_auto_reload (   self,
  value 
)

◆ test_cli_runner()

def test_cli_runner (   self,
**  kwargs 
)
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

◆ test_client()

def test_client (   self,
  use_cookies = True,
**  kwargs 
)
Creates a test client for this application.  For information
about unit testing head over to :ref:`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`.

◆ test_request_context()

def test_request_context (   self,
args,
**  kwargs 
)
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 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`.

◆ trap_http_exception()

def trap_http_exception (   self,
  e 
)
Checks if an HTTP exception should be trapped or not.  By default
this will return ``False`` for all exceptions except for a bad request
key error if ``TRAP_BAD_REQUEST_ERRORS`` is set to ``True``.  It
also returns ``True`` if ``TRAP_HTTP_EXCEPTIONS`` is set to ``True``.

This is called for all HTTP exceptions raised by a view function.
If it returns ``True`` for any exception the error handler for this
exception is not called and it shows up as regular exception in the
traceback.  This is helpful for debugging implicitly raised HTTP
exceptions.

.. versionchanged:: 1.0
    Bad request errors are not trapped by default in debug mode.

.. versionadded:: 0.8

◆ try_trigger_before_first_request_functions()

def try_trigger_before_first_request_functions (   self)
Called before each request and will ensure that it triggers
the :attr:`before_first_request_funcs` and only exactly once per
application instance (which means process usually).

:internal:

◆ update_template_context()

def update_template_context (   self,
  context 
)
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.

◆ url_defaults()

def url_defaults (   self,
  f 
)
Callback function for URL defaults for all view functions of the
application.  It's called with the endpoint and values and should
update the values passed in place.

◆ url_value_preprocessor()

def url_value_preprocessor (   self,
  f 
)
Register a URL value preprocessor function for all view
functions in the application. These functions will be called before the
:meth:`before_request` functions.

The function can modify the values captured from the matched url before
they are passed to the view. For example, this can be used to pop a
common language code value and place it in ``g`` rather than pass it to
every view.

The function is passed the endpoint name and values dict. The return
value is ignored.

◆ wsgi_app()

def wsgi_app (   self,
  environ,
  start_response 
)
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.

Field Documentation

◆ after_request_funcs

after_request_funcs

◆ app_ctx_globals_class

app_ctx_globals_class = _AppCtxGlobals
static

◆ before_first_request_funcs

before_first_request_funcs

◆ before_request_funcs

before_request_funcs

◆ blueprints

blueprints

◆ config

config

◆ config_class

config_class = Config
static

◆ debug

debug

◆ default_config

default_config
static

◆ env

env = ConfigAttribute("ENV")
static

◆ error_handler_spec

error_handler_spec

◆ extensions

extensions

◆ import_name

import_name = None
static

◆ instance_path

instance_path

◆ jinja_environment

jinja_environment = Environment
static

◆ jinja_options

dictionary jinja_options = {"extensions": ["jinja2.ext.autoescape", "jinja2.ext.with_"]}
static

◆ json_decoder

json_decoder = json.JSONDecoder
static

◆ json_encoder

json_encoder = json.JSONEncoder
static

◆ permanent_session_lifetime

permanent_session_lifetime
static
Initial value:
= ConfigAttribute(
"PERMANENT_SESSION_LIFETIME", get_converter=_make_timedelta
)

◆ request_class

request_class = Request
static

◆ response_class

response_class = Response
static

◆ root_path

root_path = None
static

◆ secret_key

secret_key = ConfigAttribute("SECRET_KEY")
static

◆ send_file_max_age_default

send_file_max_age_default
static
Initial value:
= ConfigAttribute(
"SEND_FILE_MAX_AGE_DEFAULT", get_converter=_make_timedelta
)

◆ session_cookie_name

session_cookie_name = ConfigAttribute("SESSION_COOKIE_NAME")
static

◆ session_interface

session_interface = SecureCookieSessionInterface()
static

◆ shell_context_processors

shell_context_processors

◆ static_folder

static_folder

◆ static_url_path

static_url_path

◆ subdomain_matching

subdomain_matching

◆ teardown_appcontext_funcs

teardown_appcontext_funcs

◆ teardown_request_funcs

teardown_request_funcs

◆ template_context_processors

template_context_processors

◆ template_folder

template_folder = None
static

◆ test_cli_runner_class

test_cli_runner_class = None
static

◆ test_client_class

test_client_class = None
static

◆ testing

testing = ConfigAttribute("TESTING")
static

◆ url_build_error_handlers

url_build_error_handlers

◆ url_default_functions

url_default_functions

◆ url_map

url_map

◆ url_map_class

url_map_class = Map
static

◆ url_rule_class

url_rule_class = Rule
static

◆ url_value_preprocessors

url_value_preprocessors

◆ use_x_sendfile

use_x_sendfile = ConfigAttribute("USE_X_SENDFILE")
static

◆ view_functions

view_functions

The documentation for this class was generated from the following file: