doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
do_teardown_request(exc=<object object>)
Called after the request is dispatched and the response is returned, right before the request context is popped. This calls all functions decorated with teardown_request(), and Blueprint.teardown_request() if a blueprint handled the request. Finally, the request_tearing_down s... | flask.api.index#flask.Flask.do_teardown_request |
endpoint(endpoint)
Decorate a view function to register it for the given endpoint. Used if a rule is added without a view_func with add_url_rule(). app.add_url_rule("/ex", endpoint="example")
@app.endpoint("example")
def example():
...
Parameters
endpoint (str) – The endpoint name to associate with the view f... | flask.api.index#flask.Flask.endpoint |
ensure_sync(func)
Ensure that the function is synchronous for WSGI workers. Plain def functions are returned as-is. async def functions are wrapped to run and wait for the response. Override this method to change how the app runs async views. New in version 2.0. Parameters
func (Callable) – Return type
Callabl... | flask.api.index#flask.Flask.ensure_sync |
env
What environment the app is running in. Flask and extensions may enable behaviors based on the environment, such as enabling debug mode. This maps to the ENV config key. This is set by the FLASK_ENV environment variable and may not behave as expected if set in code. Do not enable development when deploying in pro... | flask.api.index#flask.Flask.env |
errorhandler(code_or_exception)
Register a function to handle errors by code or exception class. A decorator that is used to register a function given an error code. Example: @app.errorhandler(404)
def page_not_found(error):
return 'This page does not exist', 404
You can also register handlers for arbitrary exce... | flask.api.index#flask.Flask.errorhandler |
error_handler_spec: t.Dict[AppOrBlueprintKey, t.Dict[t.Optional[int], t.Dict[t.Type[Exception], ErrorHandlerCallable]]]
A data structure of registered error handlers, in the format {scope: {code: {class: handler}}}`. The scope key is the name of a blueprint the handlers are active for, or None for all requests. The c... | flask.api.index#flask.Flask.error_handler_spec |
extensions: dict
a place where extensions can store application specific state. For example this is where an extension could store database engines and similar things. The key must match the name of the extension module. For example in case of a “Flask-Foo” extension in flask_foo, the key would be 'foo'. Changelog N... | flask.api.index#flask.Flask.extensions |
full_dispatch_request()
Dispatches the request and on top of that performs request pre and postprocessing as well as HTTP exception catching and error handling. Changelog New in version 0.7. Return type
flask.wrappers.Response | flask.api.index#flask.Flask.full_dispatch_request |
flask.g
A namespace object that can store data during an application context. This is an instance of Flask.app_ctx_globals_class, which defaults to ctx._AppCtxGlobals. This is a good place to store resources during a request. During testing, you can use the Faking Resources and Context pattern to pre-configure such r... | flask.api.index#flask.g |
get(rule, **options)
Shortcut for route() with methods=["GET"]. New in version 2.0. Parameters
rule (str) –
options (Any) – Return type
Callable | flask.api.index#flask.Flask.get |
get_send_file_max_age(filename)
Used by send_file() to determine the max_age cache value for a given file path if it wasn’t passed. By default, this returns SEND_FILE_MAX_AGE_DEFAULT from the configuration of current_app. This defaults to None, which tells the browser to use conditional requests instead of a timed ca... | flask.api.index#flask.Flask.get_send_file_max_age |
flask.got_request_exception
This signal is sent when an unhandled exception happens during request processing, including when debugging. The exception is passed to the subscriber as exception. This signal is not sent for HTTPException, or other exceptions that have error handlers registered, unless the exception was ... | flask.api.index#flask.got_request_exception |
handle_exception(e)
Handle an exception that did not have an error handler associated with it, or that was raised from an error handler. This always causes a 500 InternalServerError. Always sends the got_request_exception signal. If propagate_exceptions is True, such as in debug mode, the error will be re-raised so t... | flask.api.index#flask.Flask.handle_exception |
handle_http_exception(e)
Handles an HTTP exception. By default this will invoke the registered error handlers and fall back to returning the exception as response. Changelog Changed in version 1.0.3: RoutingException, used internally for actions such as slash redirects during routing, is not passed to error handlers... | flask.api.index#flask.Flask.handle_http_exception |
handle_url_build_error(error, endpoint, values)
Handle BuildError on url_for(). Parameters
error (Exception) –
endpoint (str) –
values (dict) – Return type
str | flask.api.index#flask.Flask.handle_url_build_error |
handle_user_exception(e)
This method is called whenever an exception occurs that should be handled. A special case is HTTPException which is forwarded to the handle_http_exception() method. This function will either return a response value or reraise the exception with the same traceback. Changelog Changed in versio... | flask.api.index#flask.Flask.handle_user_exception |
import_name
The name of the package or module that this object belongs to. Do not change this once it is set by the constructor. | flask.api.index#flask.Flask.import_name |
inject_url_defaults(endpoint, values)
Injects the URL defaults for the given endpoint directly into the values dictionary passed. This is used internally and automatically called on URL building. Changelog New in version 0.7. Parameters
endpoint (str) –
values (dict) – Return type
None | flask.api.index#flask.Flask.inject_url_defaults |
instance_path
Holds the path to the instance folder. Changelog New in version 0.8. | flask.api.index#flask.Flask.instance_path |
iter_blueprints()
Iterates over all blueprints by the order they were registered. Changelog New in version 0.11. Return type
ValuesView[Blueprint] | flask.api.index#flask.Flask.iter_blueprints |
jinja_environment
alias of flask.templating.Environment | flask.api.index#flask.Flask.jinja_environment |
jinja_options: dict = {}
Options that are passed to the Jinja environment in create_jinja_environment(). Changing these options after the environment is created (accessing jinja_env) will have no effect. Changelog Changed in version 1.1.0: This is a dict instead of an ImmutableDict to allow easier configuration. | flask.api.index#flask.Flask.jinja_options |
json_decoder
alias of flask.json.JSONDecoder | flask.api.index#flask.Flask.json_decoder |
json_encoder
alias of flask.json.JSONEncoder | flask.api.index#flask.Flask.json_encoder |
log_exception(exc_info)
Logs an exception. This is called by handle_exception() if debugging is disabled and right before the handler is called. The default implementation logs the exception as error on the logger. Changelog New in version 0.8. Parameters
exc_info (Union[Tuple[type, BaseException, types.Traceback... | flask.api.index#flask.Flask.log_exception |
make_config(instance_relative=False)
Used to create the config attribute by the Flask constructor. The instance_relative parameter is passed in from the constructor of Flask (there named instance_relative_config) and indicates if the config should be relative to the instance path or the root path of the application. ... | flask.api.index#flask.Flask.make_config |
make_default_options_response()
This method is called to create the default OPTIONS response. This can be changed through subclassing to change the default behavior of OPTIONS responses. Changelog New in version 0.7. Return type
flask.wrappers.Response | flask.api.index#flask.Flask.make_default_options_response |
make_response(rv)
Convert the return value from a view function to an instance of response_class. Parameters
rv (Union[Response, AnyStr, Dict[str, Any], Generator[AnyStr, None, None], Tuple[Union[Response, AnyStr, Dict[str, Any], Generator[AnyStr, None, None]], Union[Headers, Dict[str, Union[str, List[str], Tuple[s... | flask.api.index#flask.Flask.make_response |
make_shell_context()
Returns the shell context for an interactive shell for this application. This runs all the registered shell context processors. Changelog New in version 0.11. Return type
dict | flask.api.index#flask.Flask.make_shell_context |
flask.message_flashed
This signal is sent when the application is flashing a message. The messages is sent as message keyword argument and the category as category. Example subscriber: recorded = []
def record(sender, message, category, **extra):
recorded.append((message, category))
from flask import message_fla... | flask.api.index#flask.message_flashed |
open_instance_resource(resource, mode='rb')
Opens a resource from the application’s instance folder (instance_path). Otherwise works like open_resource(). Instance resources can also be opened for writing. Parameters
resource (str) – the name of the resource. To access resources within subfolders use forward slas... | flask.api.index#flask.Flask.open_instance_resource |
open_resource(resource, mode='rb')
Open a resource file relative to root_path for reading. For example, if the file schema.sql is next to the file app.py where the Flask app is defined, it can be opened with: with app.open_resource("schema.sql") as f:
conn.executescript(f.read())
Parameters
resource (str) – ... | flask.api.index#flask.Flask.open_resource |
patch(rule, **options)
Shortcut for route() with methods=["PATCH"]. New in version 2.0. Parameters
rule (str) –
options (Any) – Return type
Callable | flask.api.index#flask.Flask.patch |
permanent_session_lifetime
A timedelta which is used to set the expiration date of a permanent session. The default is 31 days which makes a permanent session survive for roughly one month. This attribute can also be configured from the config with the PERMANENT_SESSION_LIFETIME configuration key. Defaults to timedel... | flask.api.index#flask.Flask.permanent_session_lifetime |
post(rule, **options)
Shortcut for route() with methods=["POST"]. New in version 2.0. Parameters
rule (str) –
options (Any) – Return type
Callable | flask.api.index#flask.Flask.post |
preprocess_request()
Called before the request is dispatched. Calls url_value_preprocessors registered with the app and the current blueprint (if any). Then calls before_request_funcs registered with the app and the blueprint. If any before_request() handler returns a non-None value, the value is handled as if it was... | flask.api.index#flask.Flask.preprocess_request |
process_response(response)
Can be overridden in order to modify the response object before it’s sent to the WSGI server. By default this will call all the after_request() decorated functions. Changelog Changed in version 0.5: As of Flask 0.5 the functions registered for after request execution are called in reverse ... | flask.api.index#flask.Flask.process_response |
put(rule, **options)
Shortcut for route() with methods=["PUT"]. New in version 2.0. Parameters
rule (str) –
options (Any) – Return type
Callable | flask.api.index#flask.Flask.put |
register_blueprint(blueprint, **options)
Register a Blueprint on the application. Keyword arguments passed to this method will override the defaults set on the blueprint. Calls the blueprint’s register() method after recording the blueprint in the application’s blueprints. Parameters
blueprint (Blueprint) – The b... | flask.api.index#flask.Flask.register_blueprint |
register_error_handler(code_or_exception, f)
Alternative error attach function to the errorhandler() decorator that is more straightforward to use for non decorator usage. Changelog New in version 0.7. Parameters
code_or_exception (Union[Type[Exception], int]) –
f (Callable[[Exception], Union[Response, AnyStr... | flask.api.index#flask.Flask.register_error_handler |
flask.request
To access incoming request data, you can use the global request object. Flask parses incoming request data for you and gives you access to it through that global object. Internally Flask makes sure that you always get the correct data for the active thread if you are in a multithreaded environment. This... | flask.api.index#flask.request |
request_class
alias of flask.wrappers.Request | flask.api.index#flask.Flask.request_class |
request_context(environ)
Create a RequestContext representing a WSGI environment. Use a with block to push the context, which will make request point at this request. See The Request Context. Typically you should not call this from your own code. A request context is automatically pushed by the wsgi_app() when handli... | flask.api.index#flask.Flask.request_context |
flask.request_finished
This signal is sent right before the response is sent to the client. It is passed the response to be sent named response. Example subscriber: def log_response(sender, response, **extra):
sender.logger.debug('Request context is about to close down. '
'Response: %s', ... | flask.api.index#flask.request_finished |
flask.request_started
This signal is sent when the request context is set up, before any request processing happens. Because the request context is already bound, the subscriber can access the request with the standard global proxies such as request. Example subscriber: def log_request(sender, **extra):
sender.lo... | flask.api.index#flask.request_started |
flask.request_tearing_down
This signal is sent when the request is tearing down. This is always called, even if an exception is caused. Currently functions listening to this signal are called after the regular teardown handlers, but this is not something you can rely on. Example subscriber: def close_db_connection(se... | flask.api.index#flask.request_tearing_down |
response_class
alias of flask.wrappers.Response | flask.api.index#flask.Flask.response_class |
root_path
Absolute path to the package on the filesystem. Used to look up resources contained in the package. | flask.api.index#flask.Flask.root_path |
route(rule, **options)
Decorate a view function to register it with the given URL rule and options. Calls add_url_rule(), which has more details about the implementation. @app.route("/")
def index():
return "Hello, World!"
See URL Route Registrations. The endpoint name for the route defaults to the name of the v... | flask.api.index#flask.Flask.route |
run(host=None, port=None, debug=None, load_dotenv=True, **options)
Runs the application on a local development server. Do not use run() in a production setting. It is not intended to meet security and performance requirements for a production server. Instead, see Deployment Options for WSGI server recommendations. If... | flask.api.index#flask.Flask.run |
secret_key
If a secret key is set, cryptographic components can use this to sign cookies and other things. Set this to a complex random value when you want to use the secure cookie for instance. This attribute can also be configured from the config with the SECRET_KEY configuration key. Defaults to None. | flask.api.index#flask.Flask.secret_key |
select_jinja_autoescape(filename)
Returns True if autoescaping should be active for the given template name. If no template name is given, returns True. Changelog New in version 0.5. Parameters
filename (str) – Return type
bool | flask.api.index#flask.Flask.select_jinja_autoescape |
send_file_max_age_default
A timedelta or number of seconds which is used as the default max_age for send_file(). The default is None, which tells the browser to use conditional requests instead of a timed cache. Configured with the SEND_FILE_MAX_AGE_DEFAULT configuration key. Changed in version 2.0: Defaults to None... | flask.api.index#flask.Flask.send_file_max_age_default |
send_static_file(filename)
The view function used to serve files from static_folder. A route is automatically registered for this view at static_url_path if static_folder is set. Changelog New in version 0.5. Parameters
filename (str) – Return type
Response | flask.api.index#flask.Flask.send_static_file |
session_cookie_name
The secure cookie uses this for the name of the session cookie. This attribute can also be configured from the config with the SESSION_COOKIE_NAME configuration key. Defaults to 'session' | flask.api.index#flask.Flask.session_cookie_name |
session_interface = <flask.sessions.SecureCookieSessionInterface object>
the session interface to use. By default an instance of SecureCookieSessionInterface is used here. Changelog New in version 0.8. | flask.api.index#flask.Flask.session_interface |
shell_context_processor(f)
Registers a shell context processor function. Changelog New in version 0.11. Parameters
f (Callable) – Return type
Callable | flask.api.index#flask.Flask.shell_context_processor |
shell_context_processors: t.List[t.Callable[], t.Dict[str, t.Any]]]
A list of shell context processor functions that should be run when a shell context is created. Changelog New in version 0.11. | flask.api.index#flask.Flask.shell_context_processors |
should_ignore_error(error)
This is called to figure out if an error should be ignored or not as far as the teardown system is concerned. If this function returns True then the teardown handlers will not be passed the error. Changelog New in version 0.10. Parameters
error (Optional[BaseException]) – Return type ... | flask.api.index#flask.Flask.should_ignore_error |
signals.signals_available
True if the signaling system is available. This is the case when blinker is installed. | flask.api.index#flask.signals.signals_available |
teardown_appcontext(f)
Registers a function to be called when the application context ends. These functions are typically also called when the request context is popped. Example: ctx = app.app_context()
ctx.push()
...
ctx.pop()
When ctx.pop() is executed in the above example, the teardown functions are called just b... | flask.api.index#flask.Flask.teardown_appcontext |
teardown_appcontext_funcs: t.List[TeardownCallable]
A list of functions that are called when the application context is destroyed. Since the application context is also torn down if the request ends this is the place to store code that disconnects from databases. Changelog New in version 0.9. | flask.api.index#flask.Flask.teardown_appcontext_funcs |
teardown_request(f)
Register a function to be run at the end of each request, regardless of whether there was an exception or not. These functions are executed when the request context is popped, even if not an actual request was performed. Example: ctx = app.test_request_context()
ctx.push()
...
ctx.pop()
When ctx.... | flask.api.index#flask.Flask.teardown_request |
teardown_request_funcs: t.Dict[AppOrBlueprintKey, t.List[TeardownCallable]]
A data structure of functions to call at the end of each request even if an exception is raised, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests. To register ... | flask.api.index#flask.Flask.teardown_request_funcs |
template_context_processors: t.Dict[AppOrBlueprintKey, t.List[TemplateContextProcessorCallable]]
A data structure of functions to call to pass extra context values when rendering templates, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all reque... | flask.api.index#flask.Flask.template_context_processors |
template_filter(name=None)
A decorator that is used to register custom template filter. You can specify a name for the filter, otherwise the function name will be used. Example: @app.template_filter()
def reverse(s):
return s[::-1]
Parameters
name (Optional[str]) – the optional name of the filter, otherwise th... | flask.api.index#flask.Flask.template_filter |
template_folder
The path to the templates folder, relative to root_path, to add to the template loader. None if templates should not be added. | flask.api.index#flask.Flask.template_folder |
template_global(name=None)
A decorator that is used to register a custom template global function. You can specify a name for the global function, otherwise the function name will be used. Example: @app.template_global()
def double(n):
return 2 * n
Changelog New in version 0.10. Parameters
name (Optional[str... | flask.api.index#flask.Flask.template_global |
flask.template_rendered
This signal is sent when a template was successfully rendered. The signal is invoked with the instance of the template as template and the context as dictionary (named context). Example subscriber: def log_template_renders(sender, template, context, **extra):
sender.logger.debug('Rendering... | flask.api.index#flask.template_rendered |
template_test(name=None)
A decorator that is used to register custom template test. You can specify a name for the test, otherwise the function name will be used. Example: @app.template_test()
def is_prime(n):
if n == 2:
return True
for i in range(2, int(math.ceil(math.sqrt(n))) + 1):
if n % i... | flask.api.index#flask.Flask.template_test |
testing
The testing flag. Set this to True to enable the test mode of Flask extensions (and in the future probably also Flask itself). For example this might activate test helpers that have an additional runtime cost which should not be enabled by default. If this is enabled and PROPAGATE_EXCEPTIONS is not changed fr... | flask.api.index#flask.Flask.testing |
test_client(use_cookies=True, **kwargs)
Creates a test client for this application. For information about unit testing head over to Testing Flask Applications. Note that if you are testing for assertions or exceptions in your application code, you must set app.testing = True in order for the exceptions to propagate t... | flask.api.index#flask.Flask.test_client |
test_client_class: Optional[Type[FlaskClient]] = None
the test client that is used with when test_client is used. Changelog New in version 0.7. | flask.api.index#flask.Flask.test_client_class |
test_cli_runner(**kwargs)
Create a CLI runner for testing CLI commands. See Testing CLI Commands. Returns an instance of test_cli_runner_class, by default FlaskCliRunner. The Flask app object is passed as the first argument. Changelog New in version 1.0. Parameters
kwargs (Any) – Return type
FlaskCliRunner | flask.api.index#flask.Flask.test_cli_runner |
test_cli_runner_class: Optional[Type[FlaskCliRunner]] = None
The CliRunner subclass, by default FlaskCliRunner that is used by test_cli_runner(). Its __init__ method should take a Flask app object as the first argument. Changelog New in version 1.0. | flask.api.index#flask.Flask.test_cli_runner_class |
test_request_context(*args, **kwargs)
Create a RequestContext for a WSGI environment created from the given values. This is mostly useful during testing, where you may want to run a function that uses request data without dispatching a full request. See The Request Context. Use a with block to push the context, which... | flask.api.index#flask.Flask.test_request_context |
trap_http_exception(e)
Checks if an HTTP exception should be trapped or not. By default this will return False for all exceptions except for a bad request key error if TRAP_BAD_REQUEST_ERRORS is set to True. It also returns True if TRAP_HTTP_EXCEPTIONS is set to True. This is called for all HTTP exceptions raised by ... | flask.api.index#flask.Flask.trap_http_exception |
update_template_context(context)
Update the template context with some commonly used variables. This injects request, session, config and g into the template context as well as everything template context processors want to inject. Note that the as of Flask 0.6, the original values in the context will not be overridd... | flask.api.index#flask.Flask.update_template_context |
url_build_error_handlers: t.List[t.Callable[[Exception, str, dict], str]]
A list of functions that are called when url_for() raises a BuildError. Each function registered here is called with error, endpoint and values. If a function returns None or raises a BuildError the next function is tried. Changelog New in ver... | flask.api.index#flask.Flask.url_build_error_handlers |
url_defaults(f)
Callback function for URL defaults for all view functions of the application. It’s called with the endpoint and values and should update the values passed in place. Parameters
f (Callable[[str, dict], None]) – Return type
Callable[[str, dict], None] | flask.api.index#flask.Flask.url_defaults |
url_default_functions: t.Dict[AppOrBlueprintKey, t.List[URLDefaultCallable]]
A data structure of functions to call to modify the keyword arguments when generating URLs, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all requests. To register a fu... | flask.api.index#flask.Flask.url_default_functions |
url_map
The Map for this instance. You can use this to change the routing converters after the class was created but before any routes are connected. Example: from werkzeug.routing import BaseConverter
class ListConverter(BaseConverter):
def to_python(self, value):
return value.split(',')
def to_url(... | flask.api.index#flask.Flask.url_map |
url_map_class
alias of werkzeug.routing.Map | flask.api.index#flask.Flask.url_map_class |
url_rule_class
alias of werkzeug.routing.Rule | flask.api.index#flask.Flask.url_rule_class |
url_value_preprocessor(f)
Register a URL value preprocessor function for all view functions in the application. These functions will be called before the before_request() functions. The function can modify the values captured from the matched url before they are passed to the view. For example, this can be used to po... | flask.api.index#flask.Flask.url_value_preprocessor |
url_value_preprocessors: t.Dict[AppOrBlueprintKey, t.List[URLValuePreprocessorCallable]]
A data structure of functions to call to modify the keyword arguments passed to the view function, in the format {scope: [functions]}. The scope key is the name of a blueprint the functions are active for, or None for all request... | flask.api.index#flask.Flask.url_value_preprocessors |
use_x_sendfile
Enable this if you want to use the X-Sendfile feature. Keep in mind that the server has to support this. This only affects files sent with the send_file() method. Changelog New in version 0.2. This attribute can also be configured from the config with the USE_X_SENDFILE configuration key. Defaults to... | flask.api.index#flask.Flask.use_x_sendfile |
view_functions: t.Dict[str, t.Callable]
A dictionary mapping endpoint names to view functions. To register a view function, use the route() decorator. This data structure is internal. It should not be modified directly and its format may change at any time. | flask.api.index#flask.Flask.view_functions |
wsgi_app(environ, start_response)
The actual WSGI application. This is not implemented in __call__() so that middlewares can be applied without losing a reference to the app object. Instead of doing this: app = MyMiddleware(app)
It’s a better idea to do this instead: app.wsgi_app = MyMiddleware(app.wsgi_app)
Then y... | flask.api.index#flask.Flask.wsgi_app |
flask._app_ctx_stack
The internal LocalStack that holds AppContext instances. Typically, the current_app and g proxies should be accessed instead of the stack. Extensions can access the contexts on the stack as a namespace to store data. Changelog New in version 0.9. | flask.api.index#flask._app_ctx_stack |
flask._request_ctx_stack
The internal LocalStack that holds RequestContext instances. Typically, the request and session proxies should be accessed instead of the stack. It may be useful to access the stack in extension code. The following attributes are always present on each layer of the stack:
app
the active F... | flask.api.index#flask._request_ctx_stack |
class flask.testing.FlaskClient(*args, **kwargs)
Works like a regular Werkzeug test client but has some knowledge about how Flask works to defer the cleanup of the request context stack to the end of a with body when used in a with statement. For general information about how to use this class refer to werkzeug.test.... | flask.api.index#flask.testing.FlaskClient |
open(*args, as_tuple=False, buffered=False, follow_redirects=False, **kwargs)
Generate an environ dict from the given arguments, make a request to the application using it, and return the response. Parameters
args (Any) – Passed to EnvironBuilder to create the environ for the request. If a single arg is passed, i... | flask.api.index#flask.testing.FlaskClient.open |
session_transaction(*args, **kwargs)
When used in combination with a with statement this opens a session transaction. This can be used to modify the session that the test client uses. Once the with block is left the session is stored back. with client.session_transaction() as session:
session['value'] = 42
Inter... | flask.api.index#flask.testing.FlaskClient.session_transaction |
class flask.testing.FlaskCliRunner(app, **kwargs)
A CliRunner for testing a Flask app’s CLI commands. Typically created using test_cli_runner(). See Testing CLI Commands. Parameters
app (Flask) –
kwargs (Any) – Return type
None
invoke(cli=None, args=None, **kwargs)
Invokes a CLI command in an isolated... | flask.api.index#flask.testing.FlaskCliRunner |
invoke(cli=None, args=None, **kwargs)
Invokes a CLI command in an isolated environment. See CliRunner.invoke for full method documentation. See Testing CLI Commands for examples. If the obj argument is not given, passes an instance of ScriptInfo that knows how to load the Flask app being tested. Parameters
cli (O... | flask.api.index#flask.testing.FlaskCliRunner.invoke |
class flask.cli.FlaskGroup(add_default_commands=True, create_app=None, add_version_option=True, load_dotenv=True, set_debug_flag=True, **extra)
Special subclass of the AppGroup group that supports loading more commands from the configured Flask app. Normally a developer does not have to interface with this class but ... | flask.api.index#flask.cli.FlaskGroup |
get_command(ctx, name)
Given a context and a command name, this returns a Command object if it exists or returns None. | flask.api.index#flask.cli.FlaskGroup.get_command |
list_commands(ctx)
Returns a list of subcommand names in the order they should appear. | flask.api.index#flask.cli.FlaskGroup.list_commands |
main(*args, **kwargs)
This is the way to invoke a script with all the bells and whistles as a command line application. This will always terminate the application after a call. If this is not wanted, SystemExit needs to be caught. This method is also available by directly calling the instance of a Command. Parameter... | flask.api.index#flask.cli.FlaskGroup.main |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.