PyCharm 2.7.2 Web Help

File | Settings | IDE Settings | External Tools

settings

PyCharm | Preferences | IDE Settings | External Tools

settings

The dialog box opens when you click the add, copy, or edit1 buttons in the External Tools dialog box.

Use this dialog box to enable using a specific external tool from PyCharm, specify the menus to access it from, define where to display the tool's output, and configure the filters to distinguish it from other output. Based on these filters, PyCharm displays paths to the tool's output files as links. When you click such link, the corresponding file is opened in the editor.

ItemDescription
NameIn this text box, specify the name to identify the tool in the PyCharm menus.
GroupUse this drop-down list to specify the group the current tool belong to. Type a new name or select an existing group from the list.
DescriptionIn this text box, provide an optional description of the tool.
OptionsIn this section, specify the following options:
  • Synchronize files after execution: When this check box is selected, PyCharm detects all externally changed files and reloads them from a disk on completing tool execution.
  • Open console: Select this check box to have PyCharm open a console to display output of the configured external tool.

    When this check box is selected, you can opt to display output of stderr and stdout:

2.7+Show console when standard out changesSelect this check box to activate output console and bring it forward, if associated process writes to Standard.out.
Show console when standard error changesSelect this check box to activate output console and bring it forward, if associated process writes to Standard.err.
Output FiltersClick this button to open the Output Filters dialog box where you can define the filters to distinguish the output of the external tool from other output. Based on these filters, PyCharm displays output file paths in output messages as links. When you click such link, the corresponding file is opened in the editor.
Show InIn this area, specify the menus the tool should be available from. The available options are:
  • Main menu - select this check box to have the tool command added to the Tools menu.
  • Editor menu - select this check box to have the tool command added to the context menu of the Editor.
  • Project views - select this check box to have the tool command added to the context menu of the Project tool window.
  • Search results - select this check box to have the tool command added to the context menu of the Search Results area in the Find tool window.
Tool SettingsIn this area, specify the following options:
  • Program: Use this field to specify the location of the external tool's executable file in one of the following ways:
    • Type the path explicitly in the text box.
    • Click the Browse button browseButton to open the Select Path dialog box and navigate to the desired location.
    • Click the Insert Macro button to open the Macros dialog box where you can select the desired macro from the list.
  • Parameters: Use this field to define the parameters of the external tool in one of the following ways:
    • Type the list of parameters in the text box.
    • Click the Insert Macro button to open the Macros dialog box where you can select the desired macro from the list.

    When specifying the parameters, follow these rules:

    • Use spaces to separate individual parameters.
    • If a parameter includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".
    • If a parameter includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".
  • Working directory: Use this field to define the working directory of the external tool in one of the following ways:
    • Type the path explicitly in the text box.
    • Click the Browse button browseButton to open the Select Path dialog box and navigate to the desired location.
    • Click the Insert Macro button to open the Macros dialog box, where you can select the desired macro from the list.

    Tip

    If the field is left blank, the default project directory is used.

Tip

If the specified external tool is a Python script, add -u to the Python options. Thus you will be able to get prompt and user input before the script ends.

See Also

Procedures:

Reference:

Web Resources: