Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Unreleased
templates this behavior can be changed with the ``autoescape`` tag.
:issue:`4831`
- Fix the type of ``template_folder`` to accept ``pathlib.Path``. :issue:`4892`
- Add ``--debug`` option to the ``flask run`` command. :issue:`4777`


Version 2.2.2
Expand Down
Binary file modified docs/_static/pycharm-run-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ the ``--debug`` option.

.. code-block:: console

$ flask --app hello --debug run
$ flask --app hello run --debug
* Serving Flask app "hello"
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
Expand Down Expand Up @@ -550,7 +550,7 @@ a name such as "flask run".
Click the *Script path* dropdown and change it to *Module name*, then input ``flask``.

The *Parameters* field is set to the CLI command to execute along with any arguments.
This example uses ``--app hello --debug run``, which will run the development server in
This example uses ``--app hello run --debug``, which will run the development server in
debug mode. ``--app hello`` should be the import or file with your Flask app.

If you installed your project as a package in your virtualenv, you may uncheck the
Expand Down
6 changes: 3 additions & 3 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ Debug Mode

The :data:`DEBUG` config value is special because it may behave inconsistently if
changed after the app has begun setting up. In order to set debug mode reliably, use the
``--debug`` option on the ``flask`` command. ``flask run`` will use the interactive
``--debug`` option on the ``flask run`` command. ``flask run`` will use the interactive
debugger and reloader by default in debug mode.

.. code-block:: text

$ flask --app hello --debug run
$ flask --app hello run --debug

Using the option is recommended. While it is possible to set :data:`DEBUG` in your
config or code, this is strongly discouraged. It can't be read early by the ``flask``
config or code, this is strongly discouraged. It can't be read early by the ``flask run``
command, and some systems or extensions may have already configured themselves based on
a previous value.

Expand Down
4 changes: 2 additions & 2 deletions docs/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The debugger is enabled by default when the development server is run in debug m

.. code-block:: text

$ flask --app hello --debug run
$ flask --app hello run --debug

When running from Python code, passing ``debug=True`` enables debug mode, which is
mostly equivalent.
Expand Down Expand Up @@ -72,7 +72,7 @@ which can interfere.

.. code-block:: text

$ flask --app hello --debug run --no-debugger --no-reload
$ flask --app hello run --debug --no-debugger --no-reload

When running from Python:

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ To enable debug mode, use the ``--debug`` option.

.. code-block:: text

$ flask --app hello --debug run
$ flask --app hello run --debug
* Serving Flask app 'hello'
* Debug mode: on
* Running on http://127.0.0.1:5000 (Press CTRL+C to quit)
Expand Down
2 changes: 1 addition & 1 deletion docs/server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ debug mode.

.. code-block:: text

$ flask --app hello --debug run
$ flask --app hello run --debug

This enables debug mode, including the interactive debugger and reloader, and then
starts the server on http://localhost:5000/. Use ``flask run --help`` to see the
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/factory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ follow the tutorial.

.. code-block:: text

$ flask --app flaskr --debug run
$ flask --app flaskr run --debug

You'll see output similar to this:

Expand Down
2 changes: 1 addition & 1 deletion examples/tutorial/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Run
.. code-block:: text

$ flask --app flaskr init-db
$ flask --app flaskr --debug run
$ flask --app flaskr run --debug

Open http://127.0.0.1:5000 in a browser.

Expand Down
3 changes: 3 additions & 0 deletions src/flask/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -933,6 +933,9 @@ def app(environ, start_response):
)


run_command.params.insert(0, _debug_option)


@click.command("shell", short_help="Run a shell in the app context.")
@with_appcontext
def shell_command() -> None:
Expand Down