API¶

This part of the documentation covers all the interfaces of Flask. For parts where Flask depends on external libraries, we document the most important right here and provide links to the canonical documentation.

Objeto Application¶

class flask.Flask(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)¶

El objeto flask implementa una aplicación WSGI y actúa como objeto central. Se le pasa el nombre del módulo o paquete de la aplicación. Una vez creado actuará como un registro central para las funciones de la vista, las reglas de la URL, la configuración de la plantilla y mucho más.

El nombre del paquete se utiliza para resolver los recursos de dentro del paquete o de la carpeta en la que está contenido el módulo, dependiendo de si el parámetro paquete resuelve a un paquete python real (una carpeta con un archivo __init__.py dentro) o a un módulo estándar (sólo un archivo .py).

Para más información sobre la carga de recursos, véase open_resource().

Normalmente creas una instancia Flask en tu módulo principal o en el archivo __init__.py de tu paquete así:

from flask import Flask
app = Flask(__name__)

Sobre el primer parámetro

La idea del primer parámetro es dar a Flask una idea de lo que pertenece a tu aplicación. Este nombre se utiliza para encontrar recursos en el sistema de archivos, puede ser utilizado por las extensiones para mejorar la información de depuración y mucho más.

Así que es importante lo que proporcione allí. Si estás usando un módulo único, __name__ es siempre el valor correcto. Sin embargo, si estás usando un paquete, normalmente se recomienda codificar el nombre de tu paquete allí.

Por ejemplo, si su aplicación está definida en yourapplication/app.py debe crearla con una de las dos versiones siguientes:

app = Flask('yourapplication')
app = Flask(__name__.split('.')[0])

¿Por qué? La aplicación funcionará incluso con __name__, gracias a cómo se buscan los recursos. Sin embargo, esto hará que la depuración sea más dolorosa. Algunas extensiones pueden hacer suposiciones basadas en el nombre de importación de tu aplicación. Por ejemplo, la extensión Flask-SQLAlchemy buscará el código en tu aplicación que ha lanzado una consulta SQL en modo de depuración. Si el nombre de importación no está bien configurado, esa información de depuración se pierde. (Por ejemplo, sólo recogerá las consultas SQL en tuaplicacion.app y no en tuaplicacion.views.frontend)

Changelog

Nuevo en la versión 1.0: Se han añadido los parámetros host_matching y static_host.

Nuevo en la versión 1.0: Se ha añadido el parámetro subdomain_matching. Ahora es necesario habilitar manualmente la coincidencia de subdominios. La configuración de SERVER_NAME no la activa implícitamente.

Nuevo en la versión 0.11: Se ha añadido el parámetro root_path.

Nuevo en la versión 0.8: Se han añadido los parámetros instance_path y instance_relative_config.

Nuevo en la versión 0.7: Se han añadido los parámetros static_url_path, static_folder y template_folder.

Parámetros

import_name (str) – el nombre del paquete de aplicaciones
static_url_path (str | None) – se puede utilizar para especificar una ruta diferente para los archivos estáticos en la web. Por defecto, el nombre de la carpeta es static_folder.
static_folder (str | os.PathLike | None) – La carpeta con archivos estáticos que se sirve en static_url_path. Relativo a la aplicación root_path o una ruta absoluta. El valor predeterminado es 'static.
static_host (str | None) – el host que se utilizará al añadir la ruta estática. El valor predeterminado es None. Se requiere cuando se utiliza host_matching=True con una carpeta estática configurada.
host_matching (bool) – establece el atributo url_map.host_matching. Por defecto es False.
subdomain_matching (bool) – considerar el subdominio relativo a SERVER_NAME cuando se comparan las rutas. Por defecto es False.
template_folder (str | os.PathLike | None) – la carpeta que contiene las plantillas que debe utilizar la aplicación. Por defecto es la carpeta 'templates' en la ruta raíz de la aplicación.
instance_path (str | None) – Una ruta de instancia alternativa para la aplicación. Por defecto, se asume que la carpeta instancia junto al paquete o módulo es la ruta de la instancia.
instance_relative_config (bool) – si se establece como True se asume que los nombres de archivos relativos para cargar la configuración son relativos a la ruta de la instancia en lugar de la raíz de la aplicación.
root_path (str | None) – La ruta a la raíz de los archivos de la aplicación. Sólo debe establecerse manualmente cuando no pueda detectarse automáticamente, como en el caso de los paquetes de espacios de nombres.

aborter¶: Una instancia de aborter_class creada por make_aborter(). Es llamado por flask.abort() para lanzar errores HTTP, y también puede ser llamado directamente.

Changelog

Nuevo en la versión 2.2: Movido de flask.abort, que llama a este objeto.

aborter_class¶: alias of werkzeug.exceptions.Aborter

add_template_filter(f, name=None)¶

Registra un filtro de plantilla personalizado. Funciona exactamente igual que el decorador template_filter().

Parámetros

name (str | None) – el nombre opcional del filtro, de lo contrario se utilizará el nombre de la función.
f (Callable[[...], Any]) –

Tipo del valor devuelto

None

add_template_global(f, name=None)¶

Registra una función global de plantilla personalizada. Funciona exactamente igual que el decorador template_global().

Changelog

Nuevo en la versión 0.10.

Parámetros

name (str | None) – el nombre opcional de la función global, de lo contrario se utilizará el nombre de la función.
f (Callable[[...], Any]) –

Tipo del valor devuelto

None

add_template_test(f, name=None)¶

Registra una prueba de plantilla personalizada. Funciona exactamente igual que el decorador template_test().

Changelog

Nuevo en la versión 0.10.

Parámetros

name (str | None) – el nombre opcional de la prueba, de lo contrario se utilizará el nombre de la función.
f (Callable[[...], bool]) –

Tipo del valor devuelto

None

add_url_rule(rule, endpoint=None, view_func=None, provide_automatic_options=None, **options)¶

Registra una regla para enrutar las solicitudes entrantes y construir URLs. El decorador route() es un atajo para llamar a esto con el argumento view_func. Son equivalentes:

@app.route("/")
def index():
    ...

def index():
    ...

app.add_url_rule("/", view_func=index)

Véase Registros de rutas URL.

El nombre del endpoint de la ruta es por defecto el nombre de la función de la vista si no se pasa el parámetro endpoint. Se producirá un error si ya se ha registrado una función para el endpoint.

El parámetro methods es por defecto ["GET"]. El parámetro HEAD siempre se añade automáticamente, y OPTIONS se añade automáticamente por defecto.

view_func no necesita ser pasado, pero si la regla debe participar en el enrutamiento un nombre del endpoint debe ser asociado con una función de vista en algún momento con el decorador endpoint().

app.add_url_rule("/", endpoint="index")

@app.endpoint("index")
def index():
    ...

Si view_func tiene un atributo required_methods, esos métodos se añaden a los métodos pasados y automáticos. Si tiene el atributo provide_automatic_methods, se utiliza como método por defecto si no se pasa el parámetro.

Parámetros

rule (str) – La cadena de reglas URL.
endpoint (str | None) – El nombre del endpoint a asociar con la regla y la función de la vista. Se utiliza cuando se enrutan y construyen URLs. Por defecto es view_func.__name__.
view_func (ft.RouteCallable | None) – La función de la vista a asociar con el nombre del endpoint.
provide_automatic_options (bool | None) – Añade el método OPTIONS y responde a las peticiones OPTIONS automáticamente.
options (t.Any) – Opciones extra pasadas al objeto Rule.

Tipo del valor devuelto

None

after_request(f)¶

Registrar una función que se ejecute después de cada petición a este objeto.

La función se llama con el objeto response, y debe devolver un objeto response. Esto permite que las funciones modifiquen o sustituyan la respuesta antes de ser enviada.

Si una función lanza una excepción, cualquier función after_request restante no será llamada. Por lo tanto, esto no debe ser utilizado para las acciones que deben ejecutarse, como para cerrar los recursos. Utilice teardown_request() para eso.

This is available on both app and blueprint objects. When used on an app, this executes after every request. When used on a blueprint, this executes after every request that the blueprint handles. To register with a blueprint and execute after every request, use Blueprint.after_app_request().

Parámetros: f (flask.scaffold.T_after_request) –
Tipo del valor devuelto: flask.scaffold.T_after_request

after_request_funcs: dict[ft.AppOrBlueprintKey, list[ft.AfterRequestCallable]]¶

Una estructura de datos de funciones a llamar al final de cada solicitud, con el formato {scope: [functions]}. La clave scope es el nombre de un blueprint para el que las funciones están activas, o None para todas las peticiones.

Para registrar una función, utilice el decorador after_request().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

app_context()¶

Crea un AppContext. Úsalo como un bloque with para empujar el contexto, lo que hará que current_app apunte a esta aplicación.

Un contexto de aplicación es automáticamente empujado por RequestContext.push() cuando se maneja una solicitud, y cuando se ejecuta un comando CLI. Use esto para crear manualmente un contexto fuera de estas situaciones.

with app.app_context():
    init_db()

Véase El contexto de la aplicación.

Changelog

Nuevo en la versión 0.9.

Tipo del valor devuelto: flask.ctx.AppContext

app_ctx_globals_class¶: alias of flask.ctx._AppCtxGlobals

async_to_sync(func)¶

Devuelve una función de sincronización que ejecutará la función coroutine.

result = app.async_to_sync(func)(*args, **kwargs)

Sobrescribe este método para cambiar la forma en que la aplicación convierte el código asíncrono para que se pueda llamar de forma sincrónica.

Changelog

Nuevo en la versión 2.0.

Parámetros: func (Callable[[...], Coroutine]) –
Tipo del valor devuelto: Callable[[…], Any]

auto_find_instance_path()¶

Intenta localizar la ruta de la instancia si no fue proporcionada al constructor de la clase de la aplicación. Básicamente calculará la ruta de una carpeta llamada instance junto a su archivo principal o al paquete.

Changelog

Nuevo en la versión 0.8.

Tipo del valor devuelto: str

before_request(f)¶

Registrar una función para ejecutar antes de cada solicitud.

Por ejemplo, esto se puede utilizar para abrir una conexión a la base de datos, o para cargar el usuario conectado desde la sesión.

@app.before_request
def load_user():
    if "user_id" in session:
        g.user = db.session.get(session["user_id"])

La función será llamada sin ningún argumento. Si devuelve un valor que no sea None, el valor se maneja como si fuera el valor de retorno de la vista, y se detiene el manejo de la solicitud.

This is available on both app and blueprint objects. When used on an app, this executes before every request. When used on a blueprint, this executes before every request that the blueprint handles. To register with a blueprint and execute before every request, use Blueprint.before_app_request().

Parámetros: f (flask.scaffold.T_before_request) –
Tipo del valor devuelto: flask.scaffold.T_before_request

before_request_funcs: dict[ft.AppOrBlueprintKey, list[ft.BeforeRequestCallable]]¶

Una estructura de datos de funciones a llamar al principio de cada petición, con el formato {scope: [functions]}. La clave scope es el nombre de un plano para el que las funciones están activas, o None para todas las peticiones.

Para registrar una función, utilice el decorador before_request().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

blueprints: dict[str, Blueprint]¶: Asigna nombres de planos registrados a objetos de planos. El dictado conserva el orden en que se registraron los planos. Los planos se pueden registrar varias veces, este dict no registra la frecuencia con la que se adjuntaron.

Changelog

Nuevo en la versión 0.7.

cli¶: El grupo de comandos Click para registrar los comandos CLI para este objeto. Los comandos están disponibles desde el comando flask una vez que se ha descubierto la aplicación y se han registrado los blueprints.

config¶: El diccionario de configuración como Config. Se comporta exactamente como un diccionario normal, pero admite métodos adicionales para cargar una configuración desde archivos.

config_class¶: alias of flask.config.Config

context_processor(f)¶

Registers a template context processor function. These functions run before rendering a template. The keys of the returned dict are added as variables available in the template.

This is available on both app and blueprint objects. When used on an app, this is called for every rendered template. When used on a blueprint, this is called for templates rendered from the blueprint’s views. To register with a blueprint and affect every template, use Blueprint.app_context_processor().

Parámetros: f (flask.scaffold.T_template_context_processor) –
Tipo del valor devuelto: flask.scaffold.T_template_context_processor

create_global_jinja_loader()¶

Crea el cargador para el entorno Jinja2. Se puede utilizar para anular sólo el cargador y mantener el resto sin cambios. Se desaconseja anular esta función. En su lugar se debe sobrescribir la función jinja_loader().

El cargador global despacha entre los cargadores de la aplicación y los blueprints individuales.

Changelog

Nuevo en la versión 0.7.

Tipo del valor devuelto: flask.templating.DispatchingJinjaLoader

create_jinja_environment()¶

Crea el entorno Jinja basado en jinja_options y en los distintos métodos de la aplicación relacionados con Jinja. Cambiar jinja_options después de esto no tendrá ningún efecto. También añade al entorno los globales y filtros relacionados con Flask.

Changelog

Distinto en la versión 0.11: Environment.auto_reload establecido de acuerdo con la opción de configuración TEMPLATES_AUTO_RELOAD.

Nuevo en la versión 0.5.

Tipo del valor devuelto: flask.templating.Environment

create_url_adapter(request)¶

Crea un adaptador de URL para la solicitud dada. El adaptador de URL se crea en un punto en el que el contexto de la solicitud aún no está configurado, por lo que la solicitud se pasa explícitamente.

Changelog

Distinto en la versión 1.0: SERVER_NAME ya no permite implícitamente la coincidencia de subdominios. Utilice subdomain_matching en su lugar.

Distinto en la versión 0.9: Ahora también se puede llamar sin un objeto de solicitud cuando se crea el adaptador de URL para el contexto de la aplicación.

Nuevo en la versión 0.6.

Parámetros: request (flask.wrappers.Request | None) –
Tipo del valor devuelto: werkzeug.routing.map.MapAdapter | None

property debug: bool¶

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 DEBUG config key. It may not behave as expected if set late.

No active el modo de depuración cuando se despliegue en producción.

Default: False

default_config = {'APPLICATION_ROOT': '/', 'DEBUG': None, 'EXPLAIN_TEMPLATE_LOADING': False, 'MAX_CONTENT_LENGTH': None, 'MAX_COOKIE_SIZE': 4093, 'PERMANENT_SESSION_LIFETIME': datetime.timedelta(days=31), 'PREFERRED_URL_SCHEME': 'http', 'PROPAGATE_EXCEPTIONS': None, 'SECRET_KEY': None, 'SEND_FILE_MAX_AGE_DEFAULT': None, 'SERVER_NAME': None, 'SESSION_COOKIE_DOMAIN': None, 'SESSION_COOKIE_HTTPONLY': True, 'SESSION_COOKIE_NAME': 'session', 'SESSION_COOKIE_PATH': None, 'SESSION_COOKIE_SAMESITE': None, 'SESSION_COOKIE_SECURE': False, 'SESSION_REFRESH_EACH_REQUEST': True, 'TEMPLATES_AUTO_RELOAD': None, 'TESTING': False, 'TRAP_BAD_REQUEST_ERRORS': None, 'TRAP_HTTP_EXCEPTIONS': False, 'USE_X_SENDFILE': False}¶: Parámetros de configuración por defecto.

delete(rule, **options)¶

Acceso directo a route() con methods=["DELETE"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

dispatch_request()¶

Realiza el envío de la solicitud. Coincide con la URL y devuelve el valor de retorno de la vista o del manejador de errores. Esto no tiene que ser un objeto de respuesta. Para convertir el valor de retorno en un objeto de respuesta adecuado, llame a make_response().

Changelog

Distinto en la versión 0.7: Esto ya no hace el manejo de excepciones, este código fue movido al nuevo full_dispatch_request().

Tipo del valor devuelto: ft.ResponseReturnValue

do_teardown_appcontext(exc=<object object>)¶

Se llama justo antes de que aparezca el contexto de la aplicación.

Cuando se maneja una solicitud, el contexto de la aplicación se despliega después del contexto de la solicitud. Véase do_teardown_request().

Esto llama a todas las funciones decoradas con teardown_appcontext(). Entonces se envía la señal appcontext_tearing_down.

Esto es llamado por AppContext.pop().

Changelog

Nuevo en la versión 0.9.

Parámetros: exc (BaseException | None) –
Tipo del valor devuelto: None

do_teardown_request(exc=<object object>)¶

Se llama después de que se envíe la solicitud y se devuelva la respuesta, justo antes de que el contexto de la solicitud se vacíe.

Esto llama a todas las funciones decoradas con teardown_request(), y Blueprint.teardown_request() si un blueprint manejó la solicitud. Finalmente, se envía la señal request_tearing_down.

Esto es llamado por RequestContext.pop(), que puede ser retrasado durante las pruebas para mantener el acceso a los recursos.

Parámetros: exc (BaseException | None) – Una excepción no controlada que se ha producido durante el envío de la solicitud. Se detecta a partir de la información de excepción actual si no se pasa. Se pasa a cada función de desmontaje.
Tipo del valor devuelto: None

Changelog

Distinto en la versión 0.9: Se ha añadido el argumento exc.

endpoint(endpoint)¶

Decora una función de vista para registrarla para el punto final dado. Se utiliza si se añade una regla sin una view_func con add_url_rule().

app.add_url_rule("/ex", endpoint="example")

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

Parámetros: endpoint (str) – El nombre del punto final a asociar con la función de la vista.
Tipo del valor devuelto: Callable[[flask.scaffold.F], flask.scaffold.F]

ensure_sync(func)¶

Asegúrese de que la función es sincrónica para los trabajadores WSGI. Las funciones def simples se devuelven tal cual. Las funciones async def se envuelven para ejecutarse y esperar la respuesta.

Anula este método para cambiar la forma en que la aplicación ejecuta las vistas asíncronas.

Changelog

Nuevo en la versión 2.0.

Parámetros: func (Callable) –
Tipo del valor devuelto: Callable

error_handler_spec: dict[ft.AppOrBlueprintKey, dict[int | None, dict[type[Exception], ft.ErrorHandlerCallable]]]¶

Una estructura de datos de los gestores de errores registrados, con el formato scope: {code: {class: handler}}. La clave scope es el nombre de un plano para el que los manejadores están activos, o None para todas las peticiones. La clave code es el código de estado HTTP para HTTPException, o None para otras excepciones. El diccionario más interno asigna las clases de excepción a las funciones de los manejadores.

Para registrar un manejador de errores, utilice el decorador errorhandler().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

errorhandler(code_or_exception)¶

Registrar una función para manejar errores por código o clase de excepción.

Un decorador que se utiliza para registrar una función dado un código de error. Ejemplo:

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

También puedes registrar manejadores para excepciones arbitrarias:

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

This is available on both app and blueprint objects. When used on an app, this can handle errors from every request. When used on a blueprint, this can handle errors from requests that the blueprint handles. To register with a blueprint and affect every request, use Blueprint.app_errorhandler().

Changelog

Nuevo en la versión 0.7: Utilice register_error_handler() en lugar de modificar error_handler_spec directamente, para los manejadores de error de toda la aplicación.

Nuevo en la versión 0.7: Ahora también se pueden registrar tipos de excepción personalizados que no necesariamente tienen que ser una subclase de la clase HTTPException.

Parámetros: code_or_exception (type[Exception] | int) – el código como entero para el manejador, o una excepción arbitraria
Tipo del valor devuelto: Callable[[flask.scaffold.T_error_handler], flask.scaffold.T_error_handler]

extensions: dict¶

un lugar donde las extensiones pueden almacenar el estado específico de la aplicación. Por ejemplo, aquí es donde una extensión podría almacenar motores de bases de datos y cosas similares.

La clave debe coincidir con el nombre del módulo de extensión. Por ejemplo, en el caso de una extensión «Flask-Foo» en flask_foo, la clave sería 'foo'.

Changelog

Nuevo en la versión 0.7.

full_dispatch_request()¶

Despacha la solicitud y, además, realiza el pre y postprocesamiento de la misma, así como la captura de excepciones HTTP y el manejo de errores.

Changelog

Nuevo en la versión 0.7.

Tipo del valor devuelto: flask.wrappers.Response

get(rule, **options)¶

Acceso directo a route() con methods=["GET"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

get_send_file_max_age(filename)¶

Utilizado por send_file() para determinar el valor de la caché max_age para una ruta de archivo dada si no se ha pasado.

Por defecto, esto devuelve SEND_FILE_MAX_AGE_DEFAULT de la configuración de current_app. Este valor por defecto es None, lo que indica al navegador que utilice peticiones condicionales en lugar de una caché temporizada, lo que suele ser preferible.

Changelog

Distinto en la versión 2.0: La configuración por defecto es None en lugar de 12 horas.

Nuevo en la versión 0.9.

Parámetros: filename (str | None) –
Tipo del valor devuelto: int | None

property got_first_request: bool¶: Este atributo se establece como True si la aplicación comenzó a manejar la primera solicitud.

Obsoleto desde la versión 2.3: Will be removed in Flask 2.4.

Changelog

Nuevo en la versión 0.8.

handle_exception(e)¶

Maneja una excepción que no tiene un manejador de errores asociado, o que fue lanzada desde un manejador de errores. Esto siempre provoca un error 500 InternalServerError.

Siempre envía la señal got_request_exception.

If 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 InternalServerError is returned.

Si se registra un gestor de errores para InternalServerError o 500, se utilizará. Por consistencia, el manejador siempre recibirá el InternalServerError. La excepción original no manejada está disponible como e.original_exception.

Changelog

Distinto en la versión 1.1.0: Siempre pasa la instancia InternalServerError al manejador, estableciendo original_exception al error no manejado.

Distinto en la versión 1.1.0: Las funciones after_request y otras finalizaciones se realizan incluso para la respuesta 500 por defecto cuando no hay un manejador.

Nuevo en la versión 0.3.

Parámetros: e (Exception) –
Tipo del valor devuelto: flask.wrappers.Response

handle_http_exception(e)¶

Maneja una excepción HTTP. Por defecto, esto invocará los manejadores de error registrados y volverá a devolver la excepción como respuesta.

Changelog

Distinto en la versión 1.0.3: RoutingException, que se utiliza internamente para acciones como redireccionamientos de barras durante el enrutamiento, no se pasa a los manejadores de errores.

Distinto en la versión 1.0: Las excepciones son buscadas por el código y por MRO, por lo que las subclases de HTTPException pueden ser manejadas con un manejador catch-all para la HTTPException base.

Nuevo en la versión 0.3.

Parámetros: e (HTTPException) –
Tipo del valor devuelto: HTTPException | ft.ResponseReturnValue

handle_url_build_error(error, endpoint, values)¶

Llamada por url_for() si se ha producido un BuildError. Si esto devuelve un valor, será devuelto por url_for, de lo contrario el error se volverá a lanzar.

Cada función en url_build_error_handlers es llamada con error, endpoint y values. Si una función devuelve None o genera un BuildError, se omite. De lo contrario, su valor de retorno es devuelto por url_for.

Parámetros

error (werkzeug.routing.exceptions.BuildError) – El BuildError activo que se está manejando.
endpoint (str) – El punto final que se construye.
values (dict[str, Any]) – Los argumentos de la palabra clave pasada a url_for.

Tipo del valor devuelto

str

handle_user_exception(e)¶

Este método es llamado cada vez que ocurre una excepción que debe ser manejada. Un caso especial es HTTPException que se reenvía al método handle_http_exception(). Esta función devolverá un valor de respuesta o volverá a lanzar la excepción con el mismo traceback.

Changelog

Distinto en la versión 1.0: Los errores de clave que se producen a partir de datos de solicitud como form muestran la clave errónea en modo de depuración en lugar de un mensaje genérico de solicitud errónea.

Nuevo en la versión 0.7.

Parámetros: e (Exception) –
Tipo del valor devuelto: HTTPException | ft.ResponseReturnValue

property has_static_folder: bool¶: True si static_folder está establecido.

Changelog

Nuevo en la versión 0.5.

import_name¶: El nombre del paquete o módulo al que pertenece este objeto. No lo cambie una vez que lo haya establecido el constructor.

inject_url_defaults(endpoint, values)¶

Inyecta los valores predeterminados de la URL para el punto final dado directamente en el diccionario de valores pasado. Esto se utiliza internamente y se llama automáticamente en la construcción de la URL.

Changelog

Nuevo en la versión 0.7.

Parámetros

endpoint (str) –
values (dict) –

Tipo del valor devuelto

None

instance_path¶: Contiene la ruta de la carpeta de la instancia.

Changelog

Nuevo en la versión 0.8.

iter_blueprints()¶

Itera sobre todos los planos por el orden en que fueron registrados.

Changelog

Nuevo en la versión 0.11.

Tipo del valor devuelto: t.ValuesView[Blueprint]

property jinja_env: flask.templating.Environment¶

El entorno Jinja utilizado para cargar las plantillas.

El entorno se crea la primera vez que se accede a esta propiedad. Cambiar jinja_options después no tendrá ningún efecto.

jinja_environment¶: alias of flask.templating.Environment

property jinja_loader: jinja2.loaders.FileSystemLoader | None¶: El cargador de Jinja para las plantillas de este objeto. Por defecto es una clase jinja2.loaders.FileSystemLoader a template_folder si se establece.

Changelog

Nuevo en la versión 0.5.

jinja_options: dict = {}¶: Opciones que se pasan al entorno Jinja en create_jinja_environment(). Cambiar estas opciones después de crear el entorno (accediendo a jinja_env) no tendrá ningún efecto.

Changelog

Distinto en la versión 1.1.0: Es un dict en lugar de un ImmutableDict para permitir una configuración más fácil.

json: JSONProvider¶

Provides access to JSON methods. Functions in flask.json will call methods on this provider when the application context is active. Used for handling JSON requests and responses.

An instance of json_provider_class. Can be customized by changing that attribute on a subclass, or by assigning to this attribute afterwards.

The default, DefaultJSONProvider, uses Python’s built-in json library. A different provider can use a different JSON library.

Changelog

Nuevo en la versión 2.2.

json_provider_class¶: alias of flask.json.provider.DefaultJSONProvider

log_exception(exc_info)¶

Registra una excepción. Es llamado por handle_exception() si la depuración está deshabilitada y justo antes de llamar al manejador. La implementación por defecto registra la excepción como error en el logger.

Changelog

Nuevo en la versión 0.8.

Parámetros: exc_info (tuple[type, BaseException, traceback] | tuple[None, None, None]) –
Tipo del valor devuelto: None

property logger: logging.Logger¶

Un Logger estándar de Python para la aplicación, con el mismo nombre que name.

En el modo de depuración, el level del registrador se establecerá en DEBUG.

Si no hay ningún gestor configurado, se añadirá un gestor por defecto. Consulte Registro para obtener más información.

Changelog

Distinto en la versión 1.1.0: El registrador toma el mismo nombre que name en lugar de codificar con fuerza "flask.app".

Distinto en la versión 1.0.0: Se ha simplificado el comportamiento. El registrador siempre se llama "flask.app". El nivel sólo se establece durante la configuración, no comprueba app.debug cada vez. Sólo se utiliza un formato, no diferentes dependiendo de app.debug. No se eliminan manejadores, y sólo se añade un manejador si no hay ninguno ya configurado.

Nuevo en la versión 0.3.

make_aborter()¶

Crea el objeto para asignar a aborter. Ese objeto es llamado por flask.abort() para levantar errores HTTP, y también puede ser llamado directamente.

Por defecto, esto crea una instancia de aborter_class, que por defecto es werkzeug.exceptions.Aborter.

Changelog

Nuevo en la versión 2.2.

Tipo del valor devuelto: werkzeug.exceptions.Aborter

make_config(instance_relative=False)¶

Usado para crear el atributo config por el constructor de Flask. El parámetro instance_relative se pasa desde el constructor de Flask (allí llamado instance_relative_config) e indica si el config debe ser relativo a la ruta de la instancia o a la ruta raíz de la aplicación.

Changelog

Nuevo en la versión 0.8.

Parámetros: instance_relative (bool) –
Tipo del valor devuelto: flask.config.Config

make_default_options_response()¶

Este método es llamado para crear la respuesta OPTIONS por defecto. Esto se puede cambiar a través de la subclase para cambiar el comportamiento por defecto de las respuestas OPTIONS.

Changelog

Nuevo en la versión 0.7.

Tipo del valor devuelto: flask.wrappers.Response

make_response(rv)¶

Convierte el valor de retorno de una función de la vista en una instancia de response_class.

Parámetros: rv (ft.ResponseReturnValue) – el valor de retorno de la función de la vista. La función de la vista debe devolver una respuesta. No se permite devolver None, o que la vista termine sin devolver. Se permiten los siguientes tipos para view_rv: str Se crea un objeto de respuesta con la cadena codificada en UTF-8 como cuerpo. Se crea un objeto de respuesta con los bytes como cuerpo. dict Un diccionario que será jsonificado antes de ser devuelto. Una lista que será jsonificada antes de ser devuelta. Un generador que devuelve str o bytes para ser transmitido como respuesta. Una tupla puede ser (body, status, header), (body, status), o (body, header), donde body es cualquiera de los otros tipos permitidos, state es una cadena o un entero, y header es un diccionario o una lista de tuplas (key, value). Si body es una instancia de response_class, status sobrescribe el valor de salida y headers se extiende. response_class El objeto se devuelve sin cambios. other Response class El objeto se coacciona a response_class. callable() La función se llama como una aplicación WSGI. El resultado se utiliza para crear un objeto de respuesta.
Tipo del valor devuelto: Response

Changelog

Distinto en la versión 2.2: Un generador se convertirá en una respuesta en streaming. Una lista se convertirá en una respuesta JSON.

Distinto en la versión 1.1: Un diccionario se convertirá en una respuesta JSON.

Distinto en la versión 0.9: Anteriormente se interpretaba una tupla como los argumentos del objeto de respuesta.

make_shell_context()¶

Devuelve el contexto de shell para un shell interactivo para esta aplicación. Esto ejecuta todos los procesadores de contexto de shell registrados.

Changelog

Nuevo en la versión 0.11.

Tipo del valor devuelto: dict

property name: str¶: El nombre de la aplicación. Suele ser el nombre de importación con la diferencia de que se adivina a partir del archivo de ejecución si el nombre de importación es main. Este nombre se utiliza como nombre de visualización cuando Flask necesita el nombre de la aplicación. Se puede establecer y anular para cambiar el valor.

Changelog

Nuevo en la versión 0.8.

open_instance_resource(resource, mode='rb')¶

Abre un recurso de la carpeta de instancia de la aplicación (instance_path). Por lo demás, funciona como open_resource(). Los recursos de instancia también se pueden abrir para escribir.

Parámetros

resource (str) – el nombre del recurso. Para acceder a los recursos dentro de las subcarpetas, utilice barras inclinadas como separador.
mode (str) – modo de apertura del archivo de recursos, por defecto es “rb”.

Tipo del valor devuelto

IO

open_resource(resource, mode='rb')¶

Abre un archivo de recursos relativo a root_path para su lectura.

Por ejemplo, si el archivo schema.sql está junto al archivo app.py donde está definida la aplicación Flask, se puede abrir con:

with app.open_resource("schema.sql") as f:
    conn.executescript(f.read())

Parámetros

resource (str) – Ruta del recurso relativa a root_path.
mode (str) – Abre el archivo en este modo. Sólo se admite la lectura, los valores válidos son «r» (o «rt») y «rb».

Tipo del valor devuelto

IO

patch(rule, **options)¶

Acceso directo a route() con methods=["PATCH"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

permanent_session_lifetime¶

Una timedelta que se utiliza para establecer la fecha de expiración de una sesión permanente. El valor predeterminado es 31 días, lo que hace que una sesión permanente sobreviva aproximadamente un mes.

Este atributo también se puede configurar desde la configuración con la clave de configuración PERMANENT_SESSION_LIFETIME. Por defecto es timedelta(days=31)

post(rule, **options)¶

Acceso directo a route() con methods=["POST"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

preprocess_request()¶

Se llama antes de que se envíe la solicitud. Llama a url_value_preprocessors registrado con la app y el blueprint actual (si lo hay). Luego llama a before_request_funcs registrado con la app y el blueprint.

Si cualquier manejador before_request() devuelve un valor que no es None, el valor se maneja como si fuera el valor de retorno de la vista, y se detiene el manejo posterior de la solicitud.

Tipo del valor devuelto: ft.ResponseReturnValue | None

process_response(response)¶

Puede ser sobreescrito para modificar el objeto de respuesta antes de que sea enviado al servidor WSGI. Por defecto, esto llamará a todas las funciones decoradas after_request().

Changelog

Distinto en la versión 0.5: A partir de Flask 0.5 las funciones registradas para después de la ejecución de la solicitud son llamadas en orden inverso al registro.

Parámetros: response (flask.wrappers.Response) – un objeto response_class.
Returns: un nuevo objeto de respuesta o el mismo, tiene que ser una instancia de response_class.
Tipo del valor devuelto: flask.wrappers.Response

put(rule, **options)¶

Acceso directo a route() con methods=["PUT"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

redirect(location, code=302)¶

Crea un objeto de respuesta de redirección.

Esto es llamado por flask.redirect(), y puede ser llamado directamente también.

Parámetros

location (str) – La URL a la que se redirige.
code (int) – El código de estado de la redirección.

Tipo del valor devuelto

werkzeug.wrappers.response.Response

Changelog

Nuevo en la versión 2.2: Movido de flask.redirect, que llama a este método.

register_blueprint(blueprint, **options)¶

Registra un Blueprint en la aplicación. Los argumentos de palabras clave pasados a este método anulan los valores predeterminados establecidos en el plano.

Llama al método register() del blueprint después de registrar el blueprint en el blueprints de la aplicación.

Parámetros

blueprint (Blueprint) – El blueprint para registrarse.
url_prefix – Las rutas de los blueprint llevarán este prefijo.
subdomain – Las rutas Blueprint coincidirán en este subdominio.
url_defaults – Las rutas Blueprint utilizarán estos valores por defecto para los argumentos de la vista.
options (t.Any) – Los argumentos adicionales de la palabra clave se pasan a BlueprintSetupState. Se puede acceder a ellos en las llamadas de retorno de record().

Tipo del valor devuelto

None

Changelog

Distinto en la versión 2.0.1: La opción name se puede utilizar para cambiar el nombre (pre-punteado) con el que se registra el blueprint. Esto permite registrar el mismo plano varias veces con nombres únicos para url_for.

Nuevo en la versión 0.7.

register_error_handler(code_or_exception, f)¶

Función alternativa de adición de errores al decorador errorhandler() que es más sencilla de utilizar para el uso de no decoradores.

Changelog

Nuevo en la versión 0.7.

Parámetros

code_or_exception (type[Exception] | int) –
f (ft.ErrorHandlerCallable) –

Tipo del valor devuelto

None

request_class¶: alias of flask.wrappers.Request

request_context(environ)¶

Crea un RequestContext que represente un entorno WSGI. Utiliza un bloque with para empujar el contexto, lo que hará que request apunte a esta solicitud.

Véase El contexto de la solicitud.

Típicamente no deberías llamar a esto desde tu propio código. Un contexto de solicitud es automáticamente empujado por el wsgi_app() cuando se maneja una solicitud. Utilice test_request_context() para crear un entorno y un contexto en lugar de este método.

Parámetros: environ (dict) – un entorno WSGI
Tipo del valor devuelto: flask.ctx.RequestContext

response_class¶: alias of flask.wrappers.Response

root_path¶: Ruta absoluta del paquete en el sistema de archivos. Se utiliza para buscar los recursos contenidos en el paquete.

route(rule, **options)¶

Decora una función de la vista para registrarla con la regla de URL y las opciones dadas. Llama a add_url_rule(), que tiene más detalles sobre la implementación.

@app.route("/")
def index():
    return "Hello, World!"

Véase Registros de rutas URL.

El nombre del endpoint de la ruta es por defecto el nombre de la función de la vista si no se pasa el parámetro endpoint.

El parámetro methods es por defecto ["GET"]. Los parámetros HEAD y OPTIONS se añaden automáticamente.

Parámetros

rule (str) – La cadena de reglas URL.
options (Any) – Opciones extra pasadas al objeto Rule.

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

run(host=None, port=None, debug=None, load_dotenv=True, **options)¶

Ejecuta la aplicación en un servidor de desarrollo local.

No utilice run() en un entorno de producción. No está pensado para cumplir con los requisitos de seguridad y rendimiento de un servidor de producción. En su lugar, consulte Despliegue en producción para ver las recomendaciones sobre servidores WSGI.

Si se establece la bandera debug el servidor se recargará automáticamente para los cambios de código y mostrará un depurador en caso de que se produzca una excepción.

Si quieres ejecutar la aplicación en modo de depuración, pero deshabilitar la ejecución de código en el depurador interactivo, puedes pasar use_evalex=False como parámetro. Esto mantendrá activa la pantalla de rastreo del depurador, pero deshabilitará la ejecución de código.

No se recomienda utilizar esta función para el desarrollo con recarga automática, ya que está mal soportada. En su lugar, debería utilizar el soporte de la línea de comandos de flask de run.

Tenga en cuenta

Flask suprimirá cualquier error del servidor con una página de error genérica a menos que esté en modo de depuración. Por lo tanto, para activar sólo el depurador interactivo sin la recarga de código, tienes que invocar run() con debug=True y use_reloader=False. Si estableces use_debugger a True sin estar en modo de depuración no atraparás ninguna excepción porque no habrá ninguna que atrapar.

Parámetros

host (Optional[str]) – el nombre de host para escuchar. Establezca este valor a '0.0.0.0' para tener el servidor disponible externamente también. Por defecto es '127.0.0.1' o el host en la variable de configuración SERVER_NAME si está presente.
port (Optional[int]) – el puerto del servidor web. Por defecto es 5000 o el puerto definido en la variable de configuración SERVER_NAME si está presente.
debug (Optional[bool]) – si se da, activa o desactiva el modo de depuración. Ver debug.
load_dotenv (bool) – Carga los archivos .env y .flaskenv más cercanos para establecer las variables de entorno. También cambiará el directorio de trabajo al directorio que contenga el primer archivo encontrado.
options (Any) – las opciones que deben ser reenviadas al servidor Werkzeug subyacente. Ver werkzeug.serving.run_simple() para más información.

Tipo del valor devuelto

None

Changelog

Distinto en la versión 1.0: Si se instala, python-dotenv se utilizará para cargar las variables de entorno de los archivos .env y .flaskenv.

The FLASK_DEBUG environment variable will override debug.

El modo de hilos está activado por defecto.

Distinto en la versión 0.10: El puerto por defecto se elige ahora a partir de la variable SERVER_NAME.

secret_key¶

Si se establece una clave secreta, los componentes criptográficos pueden utilizarla para firmar cookies y otras cosas. Establece esto a un valor aleatorio complejo cuando quieras usar la cookie segura, por ejemplo.

Este atributo también se puede configurar desde la configuración con la clave de configuración SECRET_KEY. El valor predeterminado es None.

select_jinja_autoescape(filename)¶

Devuelve True si el autoescapado debe estar activo para el nombre de la plantilla dada. Si no se da ningún nombre de plantilla, devuelve True.

Changelog

Distinto en la versión 2.2: Autoescaping is now enabled by default for .svg files.

Nuevo en la versión 0.5.

Parámetros: filename (str) –
Tipo del valor devuelto: bool

send_static_file(filename)¶

La función de la vista utilizada para servir archivos desde carpeta_estática. Se registra automáticamente una ruta para esta vista en static_url_path si se establece static_folder.

Changelog

Nuevo en la versión 0.5.

Parámetros: filename (str) –
Tipo del valor devuelto: Response

session_interface: SessionInterface = <flask.sessions.SecureCookieSessionInterface object>¶: la interfaz de sesión a utilizar. Por defecto se utiliza una instancia de SecureCookieSessionInterface.

Changelog

Nuevo en la versión 0.8.

shell_context_processor(f)¶

Registra una función de procesador de contexto del shell.

Changelog

Nuevo en la versión 0.11.

Parámetros: f (flask.app.T_shell_context_processor) –
Tipo del valor devuelto: flask.app.T_shell_context_processor

shell_context_processors: list[ft.ShellContextProcessorCallable]¶: Una lista de funciones del procesador de contextos de shell que deben ejecutarse cuando se crea un contexto de shell.

Changelog

Nuevo en la versión 0.11.

should_ignore_error(error)¶

Se llama para averiguar si un error debe ser ignorado o no en lo que respecta al sistema de desmontaje. Si esta función devuelve True, los gestores de desmontaje no recibirán el error.

Changelog

Nuevo en la versión 0.10.

Parámetros: error (BaseException | None) –
Tipo del valor devuelto: bool

property static_folder: str | None¶: La ruta absoluta a la carpeta estática configurada. None si no se ha configurado ninguna carpeta estática.

property static_url_path: str | None¶

El prefijo de la URL desde la que se podrá acceder a la ruta estática.

Si no se ha configurado durante el init, se deriva de static_folder.

teardown_appcontext(f)¶

Registra una función que será llamada cuando el contexto de la aplicación sea extraído. El contexto de la aplicación se abre normalmente después del contexto de solicitud de cada petición, al final de los comandos de la CLI, o después de que un contexto empujado manualmente termine.

with app.app_context():
    ...

Cuando el bloque with sale (o se llama a ctx.pop()), las funciones de desmontaje son llamadas justo antes de que el contexto de aplicación se vuelva inactivo. Dado que un contexto de petición normalmente también gestiona un contexto de aplicación, también se llamará cuando se haga desaparecer un contexto de petición.

Cuando se llama a una función de desmontaje debido a una excepción no manejada, se le pasa un objeto de error. Si se registra un errorhandler(), éste manejará la excepción y el teardown no la recibirá.

Las funciones de desmontaje deben evitar lanzar excepciones. Si ejecutan código que puede fallar deben rodear ese código con un bloque try/except y registrar cualquier error.

Los valores de retorno de las funciones de desmontaje se ignoran.

Changelog

Nuevo en la versión 0.9.

Parámetros: f (flask.app.T_teardown) –
Tipo del valor devuelto: flask.app.T_teardown

teardown_appcontext_funcs: list[ft.TeardownCallable]¶: Una lista de funciones que son llamadas cuando el contexto de la aplicación es destruido. Dado que el contexto de la aplicación también se destruye si la solicitud termina, este es el lugar para almacenar el código que se desconecta de las bases de datos.

Changelog

Nuevo en la versión 0.9.

teardown_request(f)¶

Registra una función para ser llamada cuando el contexto de la solicitud es empujado. Normalmente, esto ocurre al final de cada solicitud, pero los contextos pueden ser empujados manualmente también durante las pruebas.

with app.test_request_context():
    ...

Cuando el bloque with sale (o se llama a ctx.pop()), las funciones de desmontaje son llamadas justo antes de que el contexto de la petición se vuelva inactivo.

Cuando se llama a una función de desmontaje debido a una excepción no manejada, se le pasa un objeto de error. Si se registra un errorhandler(), éste manejará la excepción y el teardown no la recibirá.

Las funciones de desmontaje deben evitar lanzar excepciones. Si ejecutan código que puede fallar deben rodear ese código con un bloque try/except y registrar cualquier error.

Los valores de retorno de las funciones de desmontaje se ignoran.

This is available on both app and blueprint objects. When used on an app, this executes after every request. When used on a blueprint, this executes after every request that the blueprint handles. To register with a blueprint and execute after every request, use Blueprint.teardown_app_request().

Parámetros: f (flask.scaffold.T_teardown) –
Tipo del valor devuelto: flask.scaffold.T_teardown

teardown_request_funcs: dict[ft.AppOrBlueprintKey, list[ft.TeardownCallable]]¶

Una estructura de datos de funciones para llamar al final de cada solicitud, incluso si se produce una excepción, en el formato {scope: [funciones]}. La clave scope es el nombre de un plano para el que las funciones están activas, o None para todas las peticiones.

Para registrar una función, utilice el decorador teardown_request().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

template_context_processors: dict[ft.AppOrBlueprintKey, list[ft.TemplateContextProcessorCallable]]¶

Una estructura de datos de funciones a las que llamar para pasar valores de contexto adicionales al renderizar plantillas, con el formato {scope: [funciones]}. La clave scope es el nombre de un plano para el que las funciones están activas, o None para todas las solicitudes.

Para registrar una función, utilice el decorador context_processor().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

template_filter(name=None)¶

Un decorador que se utiliza para registrar un filtro de plantilla personalizado. Puede especificar un nombre para el filtro, de lo contrario se utilizará el nombre de la función. Ejemplo:

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

Parámetros: name (str | None) – el nombre opcional del filtro, de lo contrario se utilizará el nombre de la función.
Tipo del valor devuelto: Callable[[flask.app.T_template_filter], flask.app.T_template_filter]

template_folder¶: La ruta a la carpeta de plantillas, relativa a root_path, para añadir al cargador de plantillas. None si no se deben añadir plantillas.

template_global(name=None)¶

Un decorador que se utiliza para registrar una función global de plantilla personalizada. Puede especificar un nombre para la función global, de lo contrario se utilizará el nombre de la función. Ejemplo:

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

Changelog

Nuevo en la versión 0.10.

Parámetros: name (str | None) – el nombre opcional de la función global, de lo contrario se utilizará el nombre de la función.
Tipo del valor devuelto: Callable[[flask.app.T_template_global], flask.app.T_template_global]

template_test(name=None)¶

Un decorador que se utiliza para registrar la prueba de plantilla personalizada. Puede especificar un nombre para la prueba, de lo contrario se utilizará el nombre de la función. Ejemplo:

@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

Changelog

Nuevo en la versión 0.10.

Parámetros: name (str | None) – el nombre opcional de la prueba, de lo contrario se utilizará el nombre de la función.
Tipo del valor devuelto: Callable[[flask.app.T_template_test], flask.app.T_template_test]

test_cli_runner(**kwargs)¶

Crea un runner CLI para probar los comandos CLI. Ver Ejecución de comandos con el CLI Runner.

Devuelve una instancia de test_cli_runner_class, por defecto FlaskCliRunner. El objeto de la aplicación Flask se pasa como primer argumento.

Changelog

Nuevo en la versión 1.0.

Parámetros: kwargs (t.Any) –
Tipo del valor devuelto: FlaskCliRunner

test_cli_runner_class: type[FlaskCliRunner] | None = None¶: La subclase CliRunner, por defecto FlaskCliRunner que es utilizada por test_cli_runner(). Su método __init__ debe tomar un objeto de aplicación Flask como primer argumento.

Changelog

Nuevo en la versión 1.0.

test_client(use_cookies=True, **kwargs)¶

Crea un cliente de prueba para esta aplicación. Para obtener información sobre las pruebas unitarias dirígete a Prueba de aplicaciones Flask.

Tenga en cuenta que si está probando aserciones o excepciones en el código de su aplicación, debe establecer app.testing = True para que las excepciones se propaguen al cliente de prueba. De lo contrario, la excepción será manejada por la aplicación (no visible para el cliente de prueba) y la única indicación de un AssertionError u otra excepción será una respuesta de código de estado 500 para el cliente de prueba. Véase el atributo testing. Por ejemplo:

app.testing = True
client = app.test_client()

El cliente de prueba puede utilizarse en un bloque with para aplazar el cierre del contexto hasta el final del bloque with. Esto es útil si quieres acceder a los locales del contexto para hacer pruebas:

with app.test_client() as c:
    rv = c.get('/?vodka=42')
    assert request.args['vodka'] == '42'

Además, puede pasar argumentos opcionales de palabras clave que luego se pasarán al constructor de la aplicación test_client_class. Por ejemplo:

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

Ver FlaskClient para más información.

Changelog

Distinto en la versión 0.11: Se ha añadido **kwargs para poder pasar argumentos de palabras clave adicionales al constructor de test_client_class.

Nuevo en la versión 0.7: Se ha añadido el parámetro use_cookies, así como la posibilidad de anular el cliente que se utilizará estableciendo el atributo test_client_class.

Distinto en la versión 0.4: se ha añadido soporte para el uso de bloques with para el cliente.

Parámetros

use_cookies (bool) –
kwargs (t.Any) –

Tipo del valor devuelto

FlaskClient

test_client_class: type[FlaskClient] | None = None¶: El método test_client() crea una instancia de esta clase de cliente de pruebas. Por defecto es FlaskClient.

Changelog

Nuevo en la versión 0.7.

test_request_context(*args, **kwargs)¶

Crea un RequestContext para un entorno WSGI creado a partir de los valores dados. Esto es útil sobre todo durante las pruebas, en las que se puede querer ejecutar una función que utilice datos de solicitud sin enviar una solicitud completa.

Véase El contexto de la solicitud.

Utiliza un bloque with para empujar el contexto, lo que hará que request apunte a la solicitud del entorno creado.

with app.test_request_context(...):
    generate_report()

Cuando se utiliza el intérprete de comandos, puede ser más fácil de empujar y saltar el contexto manualmente para evitar la indentación

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

Toma los mismos argumentos que el EnvironBuilder de Werkzeug, con algunos valores por defecto de la aplicación. Consulte la documentación de Werkzeug para conocer la mayoría de los argumentos disponibles. El comportamiento específico de Flask está listado aquí.

Parámetros

path – Ruta de la URL solicitada.
base_url – URL base donde se sirve la aplicación, a la que path es relativa. Si no se da, se construye a partir de PREFERRED_URL_SCHEME, subdomain, SERVER_NAME, y APPLICATION_ROOT.
subdomain – Nombre del subdominio a añadir a SERVER_NAME.
url_scheme – Esquema a utilizar en lugar de PREFERRED_URL_SCHEME.
data – El cuerpo de la solicitud, ya sea una cadena o un dictado de claves y valores del formulario.
json – Si se da, se serializa como JSON y se pasa como data. Además, el tipo de contenido por defecto es application/json.
args (Any) – otros argumentos posicionales pasados a EnvironBuilder.
kwargs (Any) – otros argumentos de palabra clave pasados a EnvironBuilder.

Tipo del valor devuelto

flask.ctx.RequestContext

testing¶

La bandera de prueba. Establece esto como True para activar el modo de prueba de las extensiones de Flask (y en el futuro probablemente también el propio Flask). Por ejemplo, esto podría activar los ayudantes de prueba que tienen un coste de tiempo de ejecución adicional que no debería estar habilitado por defecto.

Si se habilita y no se cambia PROPAGATE_EXCEPTIONS del valor por defecto, se habilita implícitamente.

Este atributo también se puede configurar desde la configuración con la clave de configuración TESTING. El valor predeterminado es False.

trap_http_exception(e)¶

Comprueba si una excepción HTTP debe ser atrapada o no. Por defecto devuelve False para todas las excepciones excepto para un error de clave de petición si TRAP_BAD_REQUEST_ERRORS se establece como True. También devuelve True si TRAP_HTTP_EXCEPTIONS es True.

Se llama para todas las excepciones HTTP lanzadas por una función de la vista. Si devuelve True para cualquier excepción, el manejador de errores para esta excepción no es llamado y se muestra como una excepción regular en el rastreo. Esto es útil para depurar excepciones HTTP implícitas.

Changelog

Distinto en la versión 1.0: Los errores de peticiones malas no se atrapan por defecto en el modo de depuración.

Nuevo en la versión 0.8.

Parámetros: e (Exception) –
Tipo del valor devuelto: bool

update_template_context(context)¶

Actualiza el contexto de la plantilla con algunas variables de uso común. Esto inyecta request, session, config y g en el contexto de la plantilla, así como todo lo que los procesadores de contexto de la plantilla quieran inyectar. Ten en cuenta que a partir de Flask 0.6, los valores originales del contexto no serán anulados si un procesador de contexto decide devolver un valor con la misma clave.

Parámetros: context (dict) – el contexto como un diccionario que se actualiza en el lugar para añadir variables adicionales.
Tipo del valor devuelto: None

url_build_error_handlers: list[t.Callable[[Exception, str, dict[str, t.Any]], str]]¶: Una lista de funciones que son llamadas por handle_url_build_error() cuando url_for() genera un BuildError. Cada función es llamada con error, endpoint y values. Si una función devuelve None o genera un BuildError, se omite. De lo contrario, su valor de retorno es devuelto por url_for.

Changelog

Nuevo en la versión 0.9.

url_default_functions: dict[ft.AppOrBlueprintKey, list[ft.URLDefaultCallable]]¶

Una estructura de datos de funciones a las que llamar para modificar los argumentos de las palabras clave al generar las URL, con el formato {scope: [funciones]}. La clave scope es el nombre de un plano para el que las funciones están activas, o None para todas las solicitudes.

Para registrar una función, utilice el decorador url_defaults().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

url_defaults(f)¶

Función de devolución de llamada para los valores predeterminados de la URL para todas las funciones de vista de la aplicación. Se llama con el endpoint y los valores y debe actualizar los valores pasados en su lugar.

This is available on both app and blueprint objects. When used on an app, this is called for every request. When used on a blueprint, this is called for requests that the blueprint handles. To register with a blueprint and affect every request, use Blueprint.app_url_defaults().

Parámetros: f (flask.scaffold.T_url_defaults) –
Tipo del valor devuelto: flask.scaffold.T_url_defaults

url_for(endpoint, *, _anchor=None, _method=None, _scheme=None, _external=None, **values)¶

Genera una URL al endpoint dado con los valores indicados.

Esto es llamado por flask.url_for(), y puede ser llamado directamente también.

Un endpoint es el nombre de una regla de URL, normalmente añadida con @app.route(), y normalmente el mismo nombre que la función de la vista. Una ruta definida en un Blueprint antepondrá el nombre del blueprint separado por un . al endpoint.

En algunos casos, como en los mensajes de correo electrónico, quieres que las URLs incluyan el esquema y el dominio, como https://example.com/hello. Cuando no está en una petición activa, las URLs serán externas por defecto, pero esto requiere configurar SERVER_NAME para que Flask sepa qué dominio usar. APPLICATION_ROOT y PREFERRED_URL_SCHEME también deben configurarse según sea necesario. Esta configuración sólo se utiliza cuando no está en una solicitud activa.

Las funciones pueden ser decoradas con url_defaults() para modificar los argumentos de las palabras clave antes de construir la URL.

Si la construcción falla por alguna razón, como un punto final desconocido o valores incorrectos, se llama al método handle_url_build_error() de la aplicación. Si devuelve una cadena, se devuelve, de lo contrario se lanza un BuildError.

Parámetros

endpoint (str) – El nombre del endpoint asociado a la URL a generar. Si empieza por ., se utilizará el nombre del plano actual (si lo hay).
_anchor (Optional[str]) – Si se proporciona, se añade como #anchor a la URL.
_method (Optional[str]) – Si se da, genera la URL asociada a este método para el punto final.
_scheme (Optional[str]) – Si se da, la URL tendrá este esquema si es externa.
_external (Optional[bool]) – Si se da, prefiere que la URL sea interna (False) o requiere que sea externa (True). Las URLs externas incluyen el esquema y el dominio. Cuando no están en una solicitud activa, las URL son externas por defecto.
values (Any) – Valores a utilizar para las partes variables de la regla URL. Las claves desconocidas se añaden como argumentos de la cadena de consulta, como ?a=b&c=d.

Tipo del valor devuelto

str

Changelog

Nuevo en la versión 2.2: Movido de flask.url_for, que llama a este método.

url_map¶

La Map para esta instancia. Se puede utilizar para cambiar los convertidores de enrutamiento después de la creación de la clase pero antes de que se conecte ninguna ruta. Ejemplo:

from werkzeug.routing import BaseConverter

class ListConverter(BaseConverter):
    def to_python(self, value):
        return value.split(',')
    def to_url(self, values):
        return ','.join(super(ListConverter, self).to_url(value)
                        for value in values)

app = Flask(__name__)
app.url_map.converters['list'] = ListConverter

url_map_class¶: alias of werkzeug.routing.map.Map

url_rule_class¶: alias of werkzeug.routing.rules.Rule

url_value_preprocessor(f)¶

Registrar una función de preprocesador de valores de URL para todas las funciones de vista en la aplicación. Estas funciones serán llamadas antes de las funciones before_request().

La función puede modificar los valores capturados de la url coincidente antes de pasarlos a la vista. Por ejemplo, se puede utilizar para hacer saltar un valor de código de lenguaje común y colocarlo en g en lugar de pasarlo a cada vista.

A la función se le pasa el nombre del endpoint y el dictado de valores. El valor de retorno se ignora.

This is available on both app and blueprint objects. When used on an app, this is called for every request. When used on a blueprint, this is called for requests that the blueprint handles. To register with a blueprint and affect every request, use Blueprint.app_url_value_preprocessor().

Parámetros: f (flask.scaffold.T_url_value_preprocessor) –
Tipo del valor devuelto: flask.scaffold.T_url_value_preprocessor

url_value_preprocessors: dict[ft.AppOrBlueprintKey, list[ft.URLValuePreprocessorCallable]]¶

Una estructura de datos de funciones a las que llamar para modificar los argumentos de palabras clave pasados a la función de vista, con el formato {scope: [functions]}. La clave scope es el nombre de un plano para el que las funciones están activas, o None para todas las solicitudes.

Para registrar una función, utilice el decorador url_value_preprocessor().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

view_functions: dict[str, t.Callable]¶

Un diccionario que asigna los nombres de los endpoints a las funciones de la vista.

Para registrar una función de vista, utilice el decorador route().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

wsgi_app(environ, start_response)¶

La aplicación WSGI real. Esto no está implementado en __call__() para que los middlewares puedan ser aplicados sin perder una referencia al objeto app. En lugar de hacer esto:

app = MyMiddleware(app)

Es mejor hacer esto en su lugar:

app.wsgi_app = MyMiddleware(app.wsgi_app)

Entonces todavía tienes el objeto original de la aplicación y puedes seguir llamando a los métodos en él.

Changelog

Distinto en la versión 0.7: Los eventos de desmontaje para los contextos de solicitud y de aplicación se llaman incluso si se produce un error no manejado. Otros eventos pueden no ser llamados dependiendo de cuándo se produzca un error durante el despacho. Véase Callbacks y errores.

Parámetros

environ (dict) – Un entorno WSGI.
start_response (Callable) – Una llamada que acepta un código de estado, una lista de cabeceras y un contexto de excepción opcional para iniciar la respuesta.

Tipo del valor devuelto

Any

Objetos Blueprint¶

class flask.Blueprint(name, import_name, static_folder=None, static_url_path=None, template_folder=None, url_prefix=None, subdomain=None, url_defaults=None, root_path=None, cli_group=<object object>)¶

Representa un blueprint, una colección de rutas y otras funciones relacionadas con la aplicación que pueden ser registradas en una aplicación real más tarde.

Un blueprint es un objeto que permite definir las funciones de la aplicación sin requerir un objeto de aplicación por adelantado. Utiliza los mismos decoradores que Flask, pero aplaza la necesidad de una aplicación registrándolos para su posterior registro.

Al decorar una función con un blueprint se crea una función diferida que se llama con BlueprintSetupState cuando el blueprint se registra en una aplicación.

Consulte Aplicaciones modulares con Blueprints para más información.

Parámetros

name (str) – El nombre del blueprint. Se antepondrá a cada nombre de endpoint.
import_name (str) – El nombre del paquete del blueprint, normalmente __name__. Esto ayuda a localizar el root_path para el blueprint.
static_folder (str | os.PathLike | None) – Una carpeta con archivos estáticos que deben ser servidos por la ruta estática del blueprint. La ruta es relativa a la ruta raíz del blueprint. Los archivos estáticos del blueprint están desactivados por defecto.
static_url_path (str | None) – La url desde la que se sirven los archivos estáticos. Por defecto es static_folder. Si el blueprint no tiene un url_prefix, la ruta estática de la aplicación tendrá prioridad, y los archivos estáticos del blueprint no serán accesibles.
template_folder (str | os.PathLike | None) – Una carpeta con plantillas que debe añadirse a la ruta de búsqueda de plantillas de la aplicación. La ruta es relativa a la ruta raíz del blueprint. Las plantillas de blueprint están desactivadas por defecto. Las plantillas de blueprint tienen una precedencia menor que las de la carpeta de plantillas de la app.
url_prefix (str | None) – Una ruta que se añade a todas las URL del blueprint, para distinguirlas del resto de las rutas de la aplicación.
subdomain (str | None) – Un subdominio en el que las rutas blueprint coincidirán por defecto.
url_defaults (dict | None) – Un diccionario de valores por defecto que las rutas de blueprint recibirán por defecto.
root_path (str | None) – Por defecto, el blueprint lo establecerá automáticamente basándose en import_name. En ciertas situaciones esta detección automática puede fallar, por lo que la ruta puede ser especificada manualmente en su lugar.
cli_group (str | None) – The name of the blueprint’s CLI group. If not set, the blueprint name will be used.

Changelog

Distinto en la versión 1.1.0: Los blueprints tienen un grupo cli para registrar los comandos CLI anidados. El parámetro cli_group controla el nombre del grupo bajo el comando flask.

Nuevo en la versión 0.7.

add_app_template_filter(f, name=None)¶

Register a template filter, available in any template rendered by the application. Works like the app_template_filter() decorator. Equivalent to Flask.add_template_filter().

Parámetros

name (str | None) – el nombre opcional del filtro, de lo contrario se utilizará el nombre de la función.
f (Callable[[...], Any]) –

Tipo del valor devuelto

None

add_app_template_global(f, name=None)¶

Register a template global, available in any template rendered by the application. Works like the app_template_global() decorator. Equivalent to Flask.add_template_global().

Changelog

Nuevo en la versión 0.10.

Parámetros

name (str | None) – el nombre opcional del global, de lo contrario se utilizará el nombre de la función.
f (Callable[[...], Any]) –

Tipo del valor devuelto

None

add_app_template_test(f, name=None)¶

Register a template test, available in any template rendered by the application. Works like the app_template_test() decorator. Equivalent to Flask.add_template_test().

Changelog

Nuevo en la versión 0.10.

Parámetros

name (str | None) – el nombre opcional de la prueba, de lo contrario se utilizará el nombre de la función.
f (Callable[[...], bool]) –

Tipo del valor devuelto

None

add_url_rule(rule, endpoint=None, view_func=None, provide_automatic_options=None, **options)¶

Register a URL rule with the blueprint. See Flask.add_url_rule() for full documentation.

The URL rule is prefixed with the blueprint’s URL prefix. The endpoint name, used with url_for(), is prefixed with the blueprint’s name.

Parámetros

rule (str) –
endpoint (str | None) –
view_func (ft.RouteCallable | None) –
provide_automatic_options (bool | None) –
options (t.Any) –

Tipo del valor devuelto

None

after_app_request(f)¶

Like after_request(), but after every request, not only those handled by the blueprint. Equivalent to Flask.after_request().

Parámetros: f (flask.blueprints.T_after_request) –
Tipo del valor devuelto: flask.blueprints.T_after_request

after_request(f)¶

Registrar una función que se ejecute después de cada petición a este objeto.

La función se llama con el objeto response, y debe devolver un objeto response. Esto permite que las funciones modifiquen o sustituyan la respuesta antes de ser enviada.

Si una función lanza una excepción, cualquier función after_request restante no será llamada. Por lo tanto, esto no debe ser utilizado para las acciones que deben ejecutarse, como para cerrar los recursos. Utilice teardown_request() para eso.

This is available on both app and blueprint objects. When used on an app, this executes after every request. When used on a blueprint, this executes after every request that the blueprint handles. To register with a blueprint and execute after every request, use Blueprint.after_app_request().

Parámetros: f (flask.scaffold.T_after_request) –
Tipo del valor devuelto: flask.scaffold.T_after_request

after_request_funcs: dict[ft.AppOrBlueprintKey, list[ft.AfterRequestCallable]]¶

Una estructura de datos de funciones a llamar al final de cada solicitud, con el formato {scope: [functions]}. La clave scope es el nombre de un blueprint para el que las funciones están activas, o None para todas las peticiones.

Para registrar una función, utilice el decorador after_request().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

app_context_processor(f)¶

Like context_processor(), but for templates rendered by every view, not only by the blueprint. Equivalent to Flask.context_processor().

Parámetros: f (flask.blueprints.T_template_context_processor) –
Tipo del valor devuelto: flask.blueprints.T_template_context_processor

app_errorhandler(code)¶

Like errorhandler(), but for every request, not only those handled by the blueprint. Equivalent to Flask.errorhandler().

Parámetros: code (type[Exception] | int) –
Tipo del valor devuelto: Callable[[flask.blueprints.T_error_handler], flask.blueprints.T_error_handler]

app_template_filter(name=None)¶

Register a template filter, available in any template rendered by the application. Equivalent to Flask.template_filter().

Parámetros: name (str | None) – el nombre opcional del filtro, de lo contrario se utilizará el nombre de la función.
Tipo del valor devuelto: Callable[[flask.blueprints.T_template_filter], flask.blueprints.T_template_filter]

app_template_global(name=None)¶

Register a template global, available in any template rendered by the application. Equivalent to Flask.template_global().

Changelog

Nuevo en la versión 0.10.

Parámetros: name (str | None) – el nombre opcional del global, de lo contrario se utilizará el nombre de la función.
Tipo del valor devuelto: Callable[[flask.blueprints.T_template_global], flask.blueprints.T_template_global]

app_template_test(name=None)¶

Register a template test, available in any template rendered by the application. Equivalent to Flask.template_test().

Changelog

Nuevo en la versión 0.10.

Parámetros: name (str | None) – el nombre opcional de la prueba, de lo contrario se utilizará el nombre de la función.
Tipo del valor devuelto: Callable[[flask.blueprints.T_template_test], flask.blueprints.T_template_test]

app_url_defaults(f)¶

Like url_defaults(), but for every request, not only those handled by the blueprint. Equivalent to Flask.url_defaults().

Parámetros: f (flask.blueprints.T_url_defaults) –
Tipo del valor devuelto: flask.blueprints.T_url_defaults

app_url_value_preprocessor(f)¶

Like url_value_preprocessor(), but for every request, not only those handled by the blueprint. Equivalent to Flask.url_value_preprocessor().

Parámetros: f (flask.blueprints.T_url_value_preprocessor) –
Tipo del valor devuelto: flask.blueprints.T_url_value_preprocessor

before_app_request(f)¶

Like before_request(), but before every request, not only those handled by the blueprint. Equivalent to Flask.before_request().

Parámetros: f (flask.blueprints.T_before_request) –
Tipo del valor devuelto: flask.blueprints.T_before_request

before_request(f)¶

Registrar una función para ejecutar antes de cada solicitud.

Por ejemplo, esto se puede utilizar para abrir una conexión a la base de datos, o para cargar el usuario conectado desde la sesión.

@app.before_request
def load_user():
    if "user_id" in session:
        g.user = db.session.get(session["user_id"])

La función será llamada sin ningún argumento. Si devuelve un valor que no sea None, el valor se maneja como si fuera el valor de retorno de la vista, y se detiene el manejo de la solicitud.

This is available on both app and blueprint objects. When used on an app, this executes before every request. When used on a blueprint, this executes before every request that the blueprint handles. To register with a blueprint and execute before every request, use Blueprint.before_app_request().

Parámetros: f (flask.scaffold.T_before_request) –
Tipo del valor devuelto: flask.scaffold.T_before_request

before_request_funcs: dict[ft.AppOrBlueprintKey, list[ft.BeforeRequestCallable]]¶

Una estructura de datos de funciones a llamar al principio de cada petición, con el formato {scope: [functions]}. La clave scope es el nombre de un plano para el que las funciones están activas, o None para todas las peticiones.

Para registrar una función, utilice el decorador before_request().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

cli¶: El grupo de comandos Click para registrar los comandos CLI para este objeto. Los comandos están disponibles desde el comando flask una vez que se ha descubierto la aplicación y se han registrado los blueprints.

context_processor(f)¶

Registers a template context processor function. These functions run before rendering a template. The keys of the returned dict are added as variables available in the template.

This is available on both app and blueprint objects. When used on an app, this is called for every rendered template. When used on a blueprint, this is called for templates rendered from the blueprint’s views. To register with a blueprint and affect every template, use Blueprint.app_context_processor().

Parámetros: f (flask.scaffold.T_template_context_processor) –
Tipo del valor devuelto: flask.scaffold.T_template_context_processor

delete(rule, **options)¶

Acceso directo a route() con methods=["DELETE"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

endpoint(endpoint)¶

Decora una función de vista para registrarla para el punto final dado. Se utiliza si se añade una regla sin una view_func con add_url_rule().

app.add_url_rule("/ex", endpoint="example")

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

Parámetros: endpoint (str) – El nombre del punto final a asociar con la función de la vista.
Tipo del valor devuelto: Callable[[flask.scaffold.F], flask.scaffold.F]

error_handler_spec: dict[ft.AppOrBlueprintKey, dict[int | None, dict[type[Exception], ft.ErrorHandlerCallable]]]¶

Una estructura de datos de los gestores de errores registrados, con el formato scope: {code: {class: handler}}. La clave scope es el nombre de un plano para el que los manejadores están activos, o None para todas las peticiones. La clave code es el código de estado HTTP para HTTPException, o None para otras excepciones. El diccionario más interno asigna las clases de excepción a las funciones de los manejadores.

Para registrar un manejador de errores, utilice el decorador errorhandler().

Esta estructura de datos es interna. No debe modificarse directamente y su formato puede cambiar en cualquier momento.

errorhandler(code_or_exception)¶

Registrar una función para manejar errores por código o clase de excepción.

Un decorador que se utiliza para registrar una función dado un código de error. Ejemplo:

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

También puedes registrar manejadores para excepciones arbitrarias:

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

This is available on both app and blueprint objects. When used on an app, this can handle errors from every request. When used on a blueprint, this can handle errors from requests that the blueprint handles. To register with a blueprint and affect every request, use Blueprint.app_errorhandler().

Changelog

Nuevo en la versión 0.7: Utilice register_error_handler() en lugar de modificar error_handler_spec directamente, para los manejadores de error de toda la aplicación.

Nuevo en la versión 0.7: Ahora también se pueden registrar tipos de excepción personalizados que no necesariamente tienen que ser una subclase de la clase HTTPException.

Parámetros: code_or_exception (type[Exception] | int) – el código como entero para el manejador, o una excepción arbitraria
Tipo del valor devuelto: Callable[[flask.scaffold.T_error_handler], flask.scaffold.T_error_handler]

get(rule, **options)¶

Acceso directo a route() con methods=["GET"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

get_send_file_max_age(filename)¶

Utilizado por send_file() para determinar el valor de la caché max_age para una ruta de archivo dada si no se ha pasado.

Por defecto, esto devuelve SEND_FILE_MAX_AGE_DEFAULT de la configuración de current_app. Este valor por defecto es None, lo que indica al navegador que utilice peticiones condicionales en lugar de una caché temporizada, lo que suele ser preferible.

Changelog

Distinto en la versión 2.0: La configuración por defecto es None en lugar de 12 horas.

Nuevo en la versión 0.9.

Parámetros: filename (str | None) –
Tipo del valor devuelto: int | None

property has_static_folder: bool¶: True si static_folder está establecido.

Changelog

Nuevo en la versión 0.5.

import_name¶: El nombre del paquete o módulo al que pertenece este objeto. No lo cambie una vez que lo haya establecido el constructor.

property jinja_loader: jinja2.loaders.FileSystemLoader | None¶: El cargador de Jinja para las plantillas de este objeto. Por defecto es una clase jinja2.loaders.FileSystemLoader a template_folder si se establece.

Changelog

Nuevo en la versión 0.5.

make_setup_state(app, options, first_registration=False)¶

Crea una instancia del objeto BlueprintSetupState() que luego se pasa a las funciones de callback de registro. Las subclases pueden anular esto para devolver una subclase del estado de configuración.

Parámetros

app (Flask) –
options (dict) –
first_registration (bool) –

Tipo del valor devuelto

BlueprintSetupState

open_resource(resource, mode='rb')¶

Abre un archivo de recursos relativo a root_path para su lectura.

Por ejemplo, si el archivo schema.sql está junto al archivo app.py donde está definida la aplicación Flask, se puede abrir con:

with app.open_resource("schema.sql") as f:
    conn.executescript(f.read())

Parámetros

resource (str) – Ruta del recurso relativa a root_path.
mode (str) – Abre el archivo en este modo. Sólo se admite la lectura, los valores válidos son «r» (o «rt») y «rb».

Tipo del valor devuelto

IO

patch(rule, **options)¶

Acceso directo a route() con methods=["PATCH"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

post(rule, **options)¶

Acceso directo a route() con methods=["POST"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

put(rule, **options)¶

Acceso directo a route() con methods=["PUT"].

Changelog

Nuevo en la versión 2.0.

Parámetros

rule (str) –
options (Any) –

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

record(func)¶

Registra una función que es llamada cuando el blueprint es registrado en la aplicación. Esta función se llama con el estado como argumento devuelto por el método make_setup_state().

Parámetros: func (Callable) –
Tipo del valor devuelto: None

record_once(func)¶

Funciona como record() pero envuelve la función en otra función que asegurará que la función sólo se llame una vez. Si el blueprint se registra una segunda vez en la aplicación, la función pasada no se llama.

Parámetros: func (Callable) –
Tipo del valor devuelto: None

register(app, options)¶

Llamado por Flask.register_blueprint() para registrar todas las vistas y callbacks registrados en el blueprint con la aplicación. Crea un BlueprintSetupState y llama a cada callback record() con él.

Parámetros

app (Flask) – La aplicación con la que se registra este blueprint.
options (dict) – Argumentos de la palabra clave reenviados desde register_blueprint().

Tipo del valor devuelto

None

Distinto en la versión 2.3: Nested blueprints now correctly apply subdomains.

Changelog

Distinto en la versión 2.1: Registering the same blueprint with the same name multiple times is an error.

Distinto en la versión 2.0.1: Los blueprints anidados se registran con su nombre punteado. Esto permite anidar diferentes blueprints con el mismo nombre en diferentes lugares.

Distinto en la versión 2.0.1: La opción name se puede utilizar para cambiar el nombre (pre-punteado) con el que se registra el blueprint. Esto permite registrar el mismo plano varias veces con nombres únicos para url_for.

register_blueprint(blueprint, **options)¶

Registra una Blueprint en este blueprint. Los argumentos de palabras clave pasados a este método anulan los valores predeterminados establecidos en el blueprint.

Changelog

Distinto en la versión 2.0.1: La opción name se puede utilizar para cambiar el nombre (pre-punteado) con el que se registra el blueprint. Esto permite registrar el mismo plano varias veces con nombres únicos para url_for.

Nuevo en la versión 2.0.

Parámetros

blueprint (flask.blueprints.Blueprint) –
options (Any) –

Tipo del valor devuelto

None

register_error_handler(code_or_exception, f)¶

Función alternativa de adición de errores al decorador errorhandler() que es más sencilla de utilizar para el uso de no decoradores.

Changelog

Nuevo en la versión 0.7.

Parámetros

code_or_exception (type[Exception] | int) –
f (ft.ErrorHandlerCallable) –

Tipo del valor devuelto

None

root_path¶: Ruta absoluta del paquete en el sistema de archivos. Se utiliza para buscar los recursos contenidos en el paquete.

route(rule, **options)¶

Decora una función de la vista para registrarla con la regla de URL y las opciones dadas. Llama a add_url_rule(), que tiene más detalles sobre la implementación.

@app.route("/")
def index():
    return "Hello, World!"

Véase Registros de rutas URL.

El nombre del endpoint de la ruta es por defecto el nombre de la función de la vista si no se pasa el parámetro endpoint.

El parámetro methods es por defecto ["GET"]. Los parámetros HEAD y OPTIONS se añaden automáticamente.

Parámetros

rule (str) – La cadena de reglas URL.
options (Any) – Opciones extra pasadas al objeto Rule.

Tipo del valor devuelto

Callable[[flask.scaffold.T_route], flask.scaffold.T_route]

send_static_file(filename)¶

La función de la vista utilizada para servir archivos desde carpeta_estática. Se registra automáticamente una ruta para esta vista en static_url_path si se establece static_folder.

Changelog

Nuevo en la versión 0.5.

Parámetros: filename (str) –
Tipo del valor devuelto: Response

property static_folder: str | None¶: La ruta absoluta a la carpeta estática configurada. None si no se ha configurado ninguna carpeta estática.

property static_url_path: str | None¶

El prefijo de la URL desde la que se podrá acceder a la ruta estática.

Si no se ha configurado durante el init, se deriva de static_folder.

teardown_app_request(f)¶

Like teardown_request(), but after every request, not only those handled by the blueprint. Equivalent to Flask.teardown_request().

Parámetros: f (flask.blueprints.T_teardown) –
Tipo del valor devuelto: flask.blueprints.T_teardown

teardown_request(f)¶

Registra una función para ser llamada cuando el contexto de la solicitud es empujado. Normalmente, esto ocurre al final de cada solicitud, pero los contextos pueden ser empujados manualmente también durante las pruebas.

with app.test_request_context():
    ...

Cuando el bloque with sale (o se llama a ctx.pop()), las funciones de desmontaje son llamadas justo antes de que el contexto de la petición se vuelva inactivo.

Cuando se llama a una función de desmontaje debido a una excepción no manejada, se le pasa un objeto de error. Si se registra un errorhandler(), éste manejará la excepción y el teardown no la recibirá.

Las funciones de desmontaje deben evitar lanzar excepciones. Si ejecutan código que puede fallar deben rodear ese código con un bloque try/except y registrar cualquier error.

Los valores de retorno de las funciones de desmontaje se ignoran.

This is available on both app and blueprint objects. When used on an app, this executes after every request. When used on a blueprint, this executes after every request that the blueprint handles. To register with a blueprint and execute after every request, use Blueprint.teardown_app_request().

Parámetros: f (flask.scaffold.T_teardown) –
Tipo del valor devuelto: flask.scaffold.T_teardown