PyCharm 2.7.2 Web Help

Use the remote debug configuration to launch the debug server. Refer to the Remote Debugging topic for additional information.

ItemDescription
NameIn this text box, specify the name of the current run/debug configuration.
Update your scriptThis section contains vital information required to prepare for remote debugging.
Add pycharm-debug.egg from PyCharm installation to the Python path.See procedure description in Remote Debugging.
Add the following import statementCopy the import statement from this read-only field, and paste it your local script:

from pydev import pydevd

Add the following command to connect to the debug serverCopy the command-line statement below, and paste it to your local script.

pydev.pydevd.settrace(<host name>, port=<port number>)

where
  • <host name> is taken from the Local host name field of this debug configuration.
  • <port number> is the number taken from the Port field of this debug configuration, or, if it has not been specified, some random number written to the console.

Note that the parameters of this command depend on the settings specified in this page. The command with the default settings is:

pydev.pydevd.settrace('localhost', port=$SERVER_PORT,stdoutToServer=True,stderrToServer=True)

which corresponds to the host name 'localhost', port number 0, selected check boxes Redirect output to console and Suspend after connect.

Local host nameSpecify the name of the local host, by which the IDE is accessible from the remote host. This host name will be automatically substituted to the command line. By default, localhost is used.
PortSpecify the port number, which will be automatically substituted to the command line. If the default post number (0) is used, then PyCharm substitutes an arbitrary number to the command line at each launch of this debug configuration; if you specify any other value, it will be used permanently.
Path mappingsUse this field to create mappings between the local and remote paths. Clicking the browse button browseButton results in opening Edit Path Mappings dialog box, where you can add new path mappings, and delete the selected ones.
Redirect output to consoleIf this check box is selected, the output and error streams will be redirected to the PyCharm console, and the command line is complemented with the stdoutToServer=True, stderrToServer=True
Suspend after connectIf this check box is selected, the debugger will suspend immediately after connecting to the IDE, on the next line after the settrace call.
If this check box is not selected, the debugger will only suspend upon hitting a breakpoint, or clicking stop, and the command line is complemented with suspend=False

Toolbar

ItemShortcutDescription
add InsertInsert Click this button to add new configuration to the list.
delete DeleteDelete Click this button to remove the selected configuration from the list.
copy Ctrl+DCtrl+D Click this button to create a copy of the selected configuration.
settings Edit defaultsClick this button to edit the default configuration templates. The defaults are used for the newly created configurations.
arrowUp or arrowDown Alt+UpAlt+Up or Alt+DownAlt+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 0 are automatically moved to the newly created folder. If only a category has the focus, then an empty folder is created.

Common options

ItemDescription
NameIn 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.
Temporary configurations limit Specify here the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.
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 onlyIf 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 launchIn this area, specify the actions to be performed prior to executing the current run/debug configuration.
ItemKeyboard shortcutDescription
addAlt+InsertAlt+Insert Click this button to add one of the tasks to be executed prior to launching the application. The possible tasks are:
  • Run External tool: Add this task to have PyCharm launch the specified third-party tool prior to running or debugging. To appoint a tool to launch, select it in the External Tools dialog box that opens.
deleteAlt+DeleteAlt+Delete Click this button to remove selected task from the list.
edit1EnterEnter Click this button to open the selected task for editing.
arrowUp or arrowDownAlt+UpAlt+Up or Alt+DownAlt+Down Click these buttons to move the selected task one line up or down.

Note that Before launch actions are performed in the order they are specified in the run/debug configuration dialog.

Show this pageSelect this check box to always show the Edit Run/Debug Configuration dialog prior to launching the current run/debug configuration.
If this check box is not selected, run/debug configuration will be launched silently.

See Also

Procedures:

Web Resources: