Register a :class:`~flask.Blueprint` on the application. Keyword arguments passed to this method will override the defaults set on the

Creates a test client for this application. For information about unit testing head over to :doc:`/testing`. Note that if you are te

Create a :class:`~flask.ctx.RequestContext` for a WSGI environment created from the given values. This is mostly useful during testing

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 we

Pops the app context.

Get the value of an attribute if it is present, otherwise set and return a default value. Like :meth:`dict.setdefault`. :param name:

Create an :class:`~flask.ctx.AppContext`. Use as a ``with`` block to push the context, which will make :data:`current_app` point at th

Get an attribute by name, or a default value. Like :meth:`dict.get`. :param name: Name of attribute to get. :param default: V

Convert the class into a view function that can be registered for a route. By default, the generated view will create a new instance

Connect to the application's configured database. The connection is unique for each request and will be reused if this is called again.

Serialize data as JSON. :param obj: The data to serialize. :param kwargs: May be passed to the underlying JSON library.

Render a template by name with the given context. :param template_name_or_list: The name of the template to render. If a list is given, t

Ensure that the function is synchronous for WSGI workers. Plain ``def`` functions are returned as-is. ``async def`` functions are wrap

Works like :meth:`record` but wraps the function in another function that will ensure the function is only called once. If the bluepr

Runs the application on a local development server. Do not use ``run()`` in a production setting. It is not intended to meet security

Generate a URL to the given endpoint with the given values. This requires an active request or application context, and calls :meth:`current_

Convert the return value from a view function to an instance of :attr:`response_class`. :param rv: the return value from the view fun

Create a redirect response object. If :data:`~flask.current_app` is available, it will use its :meth:`~flask.Flask.redirect` method, otherwis

Register a :class:`~flask.Blueprint` on this blueprint. Keyword arguments passed to this method will override the defaults set on the

Loads the Flask app (if not yet loaded) and returns it. Calling this multiple times will just result in the already loaded app to be

Binds the app context to the current context.

Create a redirect response object. This is called by :func:`flask.redirect`, and can be called directly as well. :param loca

Convert the value to a valid JSON type and add the tag structure around it.

Create a CLI runner for testing CLI commands. See :ref:`testing-cli`. Returns an instance of :attr:`test_cli_runner_class`, by defaul

Register a template filter, available in any template rendered by the application. Works like the :meth:`app_template_filter` decorator. Equiv

Register a template test, available in any template rendered by the application. Works like the :meth:`app_template_test` decorator. Equivalen

Register a custom template filter. Works exactly like the :meth:`template_filter` decorator. :param name: the optional name of the f

Register a custom template test. Works exactly like the :meth:`template_test` decorator. .. versionadded:: 0.10 :param name

Updates the values in the config from a Python file. This function behaves as if the file was imported as module with the :meth:`from

Get whether debug mode should be enabled for the app, indicated by the :envvar:`FLASK_DEBUG` environment variable. The default is ``False``.

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`

When used in combination with a ``with`` statement this opens a session transaction. This can be used to modify the session that the

Creates a copy of this request context with the same request object. This can be used to move a request context to a different greenlet.

Flashes a message to the next request. In order to remove the flashed message from the session and to display it to the user, the template ha

Updates the config like :meth:`update` ignoring items with non-upper keys. :return: Always returns ``True``. .. versionadded

Updates the values from the given object. An object can be of one of the following two types: - a string: in this case the object

Load any environment variables that start with ``FLASK_``, dropping the prefix from the env key for the config key. Values are passed

Shortcut for :meth:`route` with ``methods=["GET"]``. .. versionadded:: 2.0

Load "dotenv" files to set environment variables. A given path takes precedence over ``.env``, which takes precedence over ``.flaskenv``. After

Deserialize data as JSON. :param s: Text or UTF-8 bytes. :param kwargs: May be passed to the underlying JSON library.

Register a new tag with this serializer. :param tag_class: tag class to register. Will be instantiated with this serializer insta

Create a :class:`~flask.ctx.RequestContext` representing a WSGI environment. Use a ``with`` block to push the context, which will make

Return a registered error handler for an exception in this order: blueprint handler for a specific code, app handler for a specific code,

Register a URL rule with the blueprint. See :meth:`.Flask.add_url_rule` for full documentation. The URL rule is prefixed with the blu

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

Update the values in the config from a file that is loaded using the ``load`` parameter. The loaded data is passed to the :meth:`from_

Dispatches the request and on top of that performs request pre and postprocessing as well as HTTP exception catching and error handlin

Serialize the given arguments as JSON, and return a :class:`~flask.Response` object with the ``application/json`` mimetype. A dict or list ret

Deserialize data as JSON read from a file. :param fp: A file opened for reading text or UTF-8 bytes. :param kwargs: May be passed to

Alternative error attach function to the :meth:`errorhandler` decorator that is more straightforward to use for non decorator usage.

Serialize the given arguments as JSON, and return a :class:`~flask.Response` object with the ``application/json`` mimetype. T

Decorate a view function to register it with the given URL rule and options. Calls :meth:`add_url_rule`, which has more details about

The view function used to serve files from :attr:`static_folder`. A route is automatically registered for this view at :attr:`static_u

Check whether calling a function raised a ``TypeError`` because the call failed or because something in the factory raised the error. :pa

Internal helper that returns the default endpoint for a given function. This always is the function name.

Get the exception class being handled. For HTTP status codes or ``HTTPException`` subclasses, return both the exception and status cod

Create and configure an instance of the Flask application.

Serialize data as JSON and write to a file. :param obj: The data to serialize. :param fp: A file opened for writing text. Should use

Tag the value and dump it to a compact JSON string.

Given the return value from a view function this finalizes the request by converting it into a response and invoking the postprocessin

Given a module instance this tries to find the best possible application in the module or raises an exception.

Loads a configuration from an environment variable pointing to a configuration file. This is basically just a shortcut with nicer err

The name of the session cookie. Uses``app.config["SESSION_COOKIE_NAME"]``.

Get whether the user has disabled loading default dotenv files by setting :envvar:`FLASK_SKIP_DOTENV`. The default is ``True``, load the files

Get a post and its author by id. Checks that the id exists and optionally that the current user is the author. :param id: id of post to