Tox
Create:
The tox run/debug configuration enables you running test with different Python versions and interpreters.
Toolbar
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Item | Shortcut | Description |
|---|---|---|
Alt+Insert | Create a run/debug configuration. | |
Alt+Delete | Delete the selected run/debug configuration. Note that you cannot delete default configurations. | |
Ctrl+D | Create a copy of the selected run/debug configuration. Note that you create copies of default configurations. | |
The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent. | ||
Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders. To create a folder, select the configurations within a category, click Then, to move a configuration into a folder, between the folders or out of a folder, use drag or To remove grouping, select a folder and click | ||
Click this button to sort configurations in the alphabetical order. |
Common options
Item | Description |
|---|---|
Name | Specify a name for the run configuration to quickly identify it among others when editing or running. |
Allow multiple instances | Allow running multiple instances of this run configuration in parallel. By default, it is disabled, and when you start this configuration while another instance is still running, CLion suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances. |
Store as project file | Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project. By default, it is disabled, and CLion stores run configuration settings in .idea/workspace.xml. |
Tox-specific configuration options
Item | Description |
|---|---|
tox | |
Arguments | Specify the arguments that are passed to the tox.ini script. The arguments are delimited with spaces, for example, |
Environments to run | Specify here the Python environments/interpreters, where your project will be executed. The environments are delimited with commas, for example, |
Environment variables | This field shows the list of environment variables. If the list contains several variables, they are delimited with semicolons. 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 You might want to populate the list with the variables stored as a series of records in a text file, for example:
Variable1 = Value1
Variable2 = Value2
Just copy the list of variables from the text file and click Paste ( |
Python Interpreter | Select one of the pre-configured Python interpreters. |
Interpreter options | In this field, specify the command-line options to be passed to the interpreter. If necessary, click |
Working directory | Specify a directory to be used by the running task.
You can use path variables in this field. |
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. |
Docker container settings Click | |
Options |
Click |
Logs
The following options are related to logging the execution of this configuration. For more information, refer to .
Item | Description |
|---|---|
Specify logs to be shown in the console | Specify which log files to display while running the application. Click
For logs in the table, you can configure the following options:
|
Save console output to file | Save the console output to the specified location. Type the path manually or click the browse button and point to the desired location in the dialog that opens. |
Show console when a message is printed to stdout | Activate the console when the application writes to the standard output stream. |
Show console when a message is printed to stderr | Activate the console when the application writes to the standard error stream. |
Before launch
In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Item | Shortcut | Description |
|---|---|---|
Alt+Insert | Click this icon to add one of the following available tasks:
| |
Alt+Delete | Click this icon to remove the selected task from the list. | |
Enter | Click this icon to edit the selected task. Make the necessary changes in the dialog that opens. | |
Alt+Up Alt+Down | Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list. | |
Show this page | Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration. | |
Activate tool window | By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5. | |
Focus tool window | Select this checkbox to automatically move focus to the Run or the Debug tool window when you start the run/debug configuration. |