Run/Debug Configuration: Flask Server

Module name/Script path/Custom

Choose one of the following methods to construct and pass the FLASK_APP variable to Flask:

• Module name – by using a Python module name and a Flask class instance.

• Script path – by using a path to a Python file.

• Custom – by using an arbitrary combination of paths, modules, and Flask class instances.

For more information about the FLASK_APP variable, refer to Flask CLI documentation.

Target

Depending on the selected Target type, you can specify the following values:

• Path to the Python file, for example, /Users/jetbrains/MyFlaskProject/app.py. You can type in the path or click the button to locate the file in the project structure.

• Name of the module in the Flask project, for example, access_management. You can type in the module name or click the button to search the target module by its name or to locate it in the project structure.

• Custom combination of modules, scripts, and Flask class instances, for example, access_management.access:app2, where:

  • access_management – the module name

  • access – the target file in the module

  • app2 – the Flask class instance in access.

Application

The target Flask class instance to be executed. This value will be put into the FLASK_APP variable during the execution. For example, you've declared the following instance of the Flask class in your application:

app = Flask(__name__);

Then you can add app into the Application field. It is typically used for the Module name target type. For Script path, the Application field is enabled only for the Flask version 0.13 and later. The field is disabled for the Custom target type, because you can specify the required instance in the combination added to the Target field.

Additional options

Parameters of the flask run command.

--host – the IP address of the web server to run your Flask application on. The default value is '127.0.0.1'. To make your web server externally visible, use the '0.0.0.0' value for this parameter.

--port – the port of the web server. The default value is 5000 or it is the port number set in the SERVER_NAME config variable.

Example: --host=127.0.0.2 --port=1234.

FLASK_ENV

An environment variable set to one of possible environments. The default value is 'development'.

FLASK_DEBUG

Select this checkbox to enable the built-in Flask debug mode. With this mode, the development server will be automatically reloaded on any code change enabling continuous debugging. For more information about Flask debugger, refer to Flask Debug Mode.

Project

Click this list to select one of the projects, opened in the same PyCharm window, where this run/debug configuration should be used. If there is only one open project, this field is not displayed.

Environment variables

This field shows the list of environment variables. If the list contains several variables, they are delimited with semicolons.

By default, the field contains the variable PYTHONUNBUFFERED set to 1. To fill in the list, click the browse button, or press Shift+Enter and specify the desired set of environment variables in the Environment Variables dialog.

To create a new variable, click , and type the desired name and value.

You might want to populate the list with the variables stored as a series of records in a text file, for example:

Just copy the list of variables from the text file and click Paste () in the Environmental Variables dialog. The variables will be added to the table. Click Ok to complete the task. At any time, you can select all variables in the Environment Variables dialog, click Copy , and paste them into a text file.

Python Interpreter

Select one of the pre-configured Python interpreters from the list.

Note that you can select a remote interpreter as well as the local one.

Interpreter options

In this field, specify the string to be passed to the interpreter. If necessary, click , and type the string in the editor.

Working directory

Specify a directory to be used by the running task.

• When a default run/debug configuration is created by the keyboard shortcut Ctrl+Shift+F10, or by choosing Run from the context menu of a script, the working directory is the one that contains the executable script. This directory may differ from the project directory.

• When this field is left blank, the bin directory of the PyCharm installation will be used.

Add content roots to PYTHONPATH

Select this checkbox to add all content roots of your project to the environment variable PYTHONPATH;

Add source roots to PYTHONPATH

Select this checkbox to add all source roots of your project to the environment variable PYTHONPATH;