IntelliJ IDEA 2017.3 Help

Run/Debug Configuration: Python Remote Debug Server

The following is only valid when Python Plugin is installed and enabled!

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 the debug-eggs directory under IntelliJ IDEA 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 in your local script:

import pydevd

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

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 checkboxes 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 IntelliJ IDEA 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 checkbox is selected, the output and error streams will be redirected to the IntelliJ IDEA console, and the command line is complemented with the stdoutToServer=True, stderrToServer=True
Suspend after connectIf this checkbox is selected, the debugger will suspend immediately after connecting to the IDE, on the next line after the settrace call.
If this checkbox 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 Alt+Insert Click this button to add a new configuration to the list.
delete Alt+Delete Click this button to remove the selected configuration from the list.
copy Ctrl+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 newly created configurations.
arrowUp or arrowDown Alt+Up or Alt+Down Use these buttons to move the selected configuration or 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 Move into new folder / Create new folder Use this button to create a new folder.

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

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

sortAlphabetically Sort configurations Click this button to sort configurations in alphabetical order.

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.
Share Select this check box to make the run/debug configuration available to other team members.

If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.

If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.

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, IntelliJ IDEA 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 makes sense when the 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 launchSpecify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
ItemKeyboard shortcutDescription
add Alt+Insert 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 IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools andExternal Tools.
  • Make. Select this option to have the project or module compiled. The Make Module command will be carried out if a particular module is specified in the run/debug configuration, and the Make Project command otherwise.

    If an error occurs during the compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

  • Make, no error check. The same as the Make option but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation result.
  • Build Artifacts. Select this option to have an artifact or artifacts built. In the dialog that opens, select the artifact or artifacts that should be built.

    See also, Working with Artifacts.

  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to run.

    This option is available only if you have already at least one run/debug configuration in the current project.

  • Run Ant target. Select this option to have an Ant target run. In the dialog that opens, select the target to be run. For more information, see Ant.
  • Run Grunt task. Select this option to run a Grunt task. In the Grunt task dialog box that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

  • Run Gulp task. Select this option to run a Grunt task. In the Gulp task dialog box that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

  • Run npm Script. Select this check box to execute an npm script. In the NPM Script dialog box that opens, specify the package.json file where the required script is defined, select the script to execute, choose the command to apply to it, and specify the arguments to execute the script with.

    Specify the location of the Node.js interpreter and the parameters to pass to it.

  • Compile TypeScript. Select this option to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:
    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.
    • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.
  • 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.
  • Run Maven Goal. Select this option to have a Maven goal run. In the dialog that opens, select the goal to be run.

    For more information, see Maven.

  • Run Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details.
  • Upload files to Remote Host. Select this option to have the application files automatically uploaded to the server according to the default server access configuration.

    For more information, see Configuring Synchronization with a Web Server and Uploading and Downloading Files.

  • Run Rake task:Add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button browseButton, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    runConfigRakeTask
    To learn more about Rake support, refer to Rake Support section.
  • Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
delete Alt+Delete Click this icon to remove the selected task from the list.
edit1 Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+Up Click this icon to move the selected task one line up in the list.
arrowDown 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.
Active tool windowSelect this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.
Last modified: 12 December 2017

See Also

Procedures: