PyCharm 3.4.0 Web Help

Use this dialog box to create a run/debug configuration for attests.

In this section:

Configuration tab

Item Description
Type Click one of the radio-buttons to define the testing scope (all tests in a folder, all tests in a script, a test class, a single test method or function.)
Tests Specify the location of the tests. The fields in this section are enabled depending on the test type selected in the Type section.
  • All tests in folder: for this testing scope, specify the following parameters:

    Folder: type the path to the directory that contains the tests to be executed, or click the browse button and select the desired directory in the dialog that opens.

    Pattern: type the one or more patterns the file names should match for the files to be considered tests. It is important that the names are case-sensitive.

    Use comma as the delimiter. The patterns should be Python regular expressions.

    Note that by default, the names of the test files start with "test". If the option All tests in folder has been selected, only files matching the pattern are processed. Define your own pattern to override the default.

  • Tests in script: for this scope, specify the name of the script that contains the tests to be executed.
  • Tests class: for this scope, specify the name of the script and test class.
  • Tests method: for this scope, specify the name of the script, test class and test method.
  • Tests function: for this scope, specify the name of the script, and test method.
Environment variable Click the browse button, or press Shift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift+EnterShift EnterShift EnterShift Enter to specify the desired set of environment variables in the Environment Variables dialog box. To create a new variable, click add, and type the desired name and value.
Python Interpreter Select one of the pre-configured Python interpreters from the drop-down list.
Note that you can select a remote interpreter, as well as the local one. If a remote interpreter is selected, you have to specify path mappings in the corresponding field that appears.
Interpreter options In this field, specify the string to be passed to the interpreter. If necessary, click shift-enter-button.png, and type the string in the editor.
Working directory Specify a directory to be used by the running task.

Note

  • When a default run/debug configuration is created by the keyboard shortcut Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+Shift+F10Ctrl+F9Shift+Alt+F6 or Shift+F6Ctrl+Shift+F10Control Shift RControl Shift F10Control Shift R, or by choosing Run on 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.
Path mappings This field appears, if a remote interpreter has been selected in the field Python interpreter.
Click the browse button browseButton to define the required mappings between the local and remote paths. In the Edit Path Mappings dialog box, use add/delete buttons to create new mappings, or delete the selected ones.
2.7.2+Add content roots to PYTHONPATH Select this check box to add all content roots of your project to the environment variable PYTHONPATH;
Add source roots to PYTHONPATH Select this check box to add all source roots of your project to the environment variable PYTHONPATH;
3.1+

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

Item Description
Is Active Select check boxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
Log File Entry The read-only fields in this column list the log files to show. The list can contain:
  • Full paths to specific files.
  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    Note

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip Content Select this check box to have the previous content of the selected log skipped.
Save console output to file Select this check box to 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 standard out changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.out.
Show console when standard error changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.err.
add Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
edit1 Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
delete Click this button to remove the selected log entry from the list.
browseButton.png Click this button to edit the select log file entry.

Note

The button is available only when an entry is selected.

Toolbar

Item Shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertCtrl+N or Alt+InsertAlt+InsertAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this button to add new configuration to the list.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this button to remove the selected configuration from the list.
copy Ctrl+DCtrl+DCtrl+DCtrl+DMeta+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCommand DCommand DCommand D Click this button to create a copy of the selected configuration.
settings Edit defaults Click this button to edit the default configuration templates. The defaults are used for the newly created configurations.
arrowUp or arrowDown Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpControl UpControl UpControl Alt Up or Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownControl DownControl DownControl Alt Down Use these buttons to move the selected configuration or group of configurations (folder) up and down in the list.

The order of configurations or folders in the list defines the order, in which configurations appear in the Run/Debug drop-down list on the main toolbar.

folder Use this button to create a new folder.

If one or more run/debug configurations have the focus, then the selected run/debug configurations are automatically moved to the newly created folder. If only a category has the focus, then an empty folder is created.

Move run/debug configurations to a folder using drag-and-drop, or arrowUp arrowDown buttons.

Common options

Item Description
Name In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.
Defaults This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.
Share Select this check box to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

This check box is not available when editing the run/debug configuration defaults.

Single instance only If this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, PyCharm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This make sense, when usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.

Before launch Specify which tasks should be carried out before starting the run/debug configuration. The specified tasks are performed in the order that they appear in the list.
Item Keyboard shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to PyCharm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in PyCharm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to be run.
  • Generate CoffeeScript Source Maps. Select this option to have the source maps for your CoffeeScript sources generated. In the dialog that opens, specify where your CoffeeScript source files are located. For more information, see CoffeeScript Support.
  • Run Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this icon to remove the selected task from the list.
edit1 EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpControl UpControl UpControl Alt Up Click this icon to move the selected task one line up in the list.
arrowDown Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownControl DownControl DownControl Alt Down Click this icon to move the selected task one line down in the list.
Show this page Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.

See Also

Concepts:

Procedures:

External Links:

Web Resources: