PyCharm 3.1.0 Web Help

Some features described here are available in Professional edition only.

In this dialog box, create a configuration to be used for debugging JavaScript sources locally and remotely.

In case of Local debugging, the application files are on you machine and PyCharm runs them on the built-in Web server with the root URL http://localhost:<built-in server port>/<project root>. The built-in server port is specified on the Debugger. JavaScript page of the Settings dialog box.

A debugging session in this mode can be initiated in two ways:

  • Open the HTML file with the JavaScript injection to be tested and launch the temporary run/debug configuration that PyCharm has generated automatically. This approach it helpful when you do not need to debug the entire application but just one script.
  • Create and launch a permanent debug configuration.
For details, see Temporary and Permanent Run/Debug Configurations.

In case of Remote debugging, the application files are deployed on an external web server and you have their copies on your computer. No matter, whether the web server itself is running on a physically remote host or on your machine, application files deployed on it are treated as remote. For details, see Working with Web Servers: Copying Files.

When a remote HTML file with a JavaScript injection is opened, the debugger tells PyCharm the name of the currently processed file and the number of the line to be processed. PyCharm opens the local copy of this file and indicates the line with the provided number. This behaviour is enabled by specifying correspondence between files and folders on the server and their local copies. This correspondence is called mapping, it is set in the debug configuration.

A Remote debugging session can be initiated only through a permanent debug configuration that you have to define yourself manually.

Warning

Debugging of the JavaScript applications is supported only in Firefox and Google Chrome .

This section provides descriptions of the configuration-specific items, as well as the toolbar and options that are common for all run/debug configurations.

Item Description
Name In this text box, specify the name of the current run/debug configuration.
Share If this check box is selected, the run/debug configurations become available to the 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 field does not appear for the default run/debug configurations.

URL In this text box, specify the URL address of the HTML file that references the JavaScript to debug. For local debugging, type the URL in the format http://localhost:<built-in server port>/<project root>. The built-in server port is specified on the Debugger. JavaScript page of the Settings dialog box.
Browser From this drop down list, select the browser (Firefox or Chrome), where your JavaScript application will be debugged. The available options are Firefox and Chrome.
Remote URLs of local files PyCharm displays this area only when you create a permanent debug configuration manually. For automatically generated temporary configurations the area is not shown.

In this area, map the local files to be involved in debugging to the URL addresses of their copies on the server.

  • File/Directory - in this read-only field, select the desired local file or directory in the project tree.
  • Remote URL - in this text box, type the absolute URL address of the corresponding file or folder on the server.

These mappings are required only if the local folder structure under the project root differs from the folder structure on the server. If the structures are identical, PyCharm itself "retrieves" the paths to local files by parsing the URL addresses of their copies on the server

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 Delete or Command BackspaceCommand DeleteCommand Delete or Command Backspace 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.
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 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.
  • 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 Delete or Command BackspaceCommand DeleteCommand Delete or Command Backspace 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:

Reference:

Web Resources: