PyCharm 2019.1 Help

Run/Debug Configuration: Pyramid Server

Use this dialog box to create a run/debug configuration for launching a Pyramid server.

Configuration tab

Item

Description

Config file

In this field, specify the name of the configuration file development.ini.

Additional options

In this field, type the additional options to be passed to the server.

These are the options that pserve accepts. Use pserve --help to learn more about the additonal options.

    Run browser

    Select this checkbox, if you want your Pyramid application to open in the default browser. In the text field below, enter the IP address where your application will be opened.

    Environment variables

    This field shows the list of environment variables. If the list contains several variables, they are delimited with semicolons.
    By default, the field contains the variable PYTHONUNBUFFERED set to 1. To fill in the list, click the browse button, or press Shift+Enter and specify the desired set of environment variables in the Environment Variables dialog.
    To create a new variable, click the Add button, and type the desired name and value. You might want to populate the list with the variables stored as a series of records in a text file, for example:

    Variable1 = Value1 Variable2 = Value2
    Just copy the list of variables from the text file and click Paste (Paste) in the Environmental Variables dialog. The variables will be added to the table. Click Ok to complete the task. At any time, you can select all variables in the Environment Variables dialog, click Copy (Copy), and paste them into a text file.

    Python Interpreter

    Select one of the pre-configured Python interpreters from the list.

    Interpreter options

    In this field, specify the string to be passed to the interpreter. If necessary, click Expand the field, and type the string in the editor.

    Working directory

    Specify a directory to be used by the running task.

    • When a default run/debug configuration is created by the keyboard shortcut Ctrl+Shift+F10, or by choosing Run from 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.

    Add content roots to PYTHONPATH

    Select this checkbox to add all content roots of your project to the environment variable PYTHONPATH;

    Add source roots to PYTHONPATH

    Select this checkbox to add all source roots of your project to the environment variable PYTHONPATH;

    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 checkboxes 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.

      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 checkbox to have the previous content of the selected log skipped.

    Save console output to file

    Select this checkbox 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 a message is printed to standard output stream

    Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.

    Show console when a message is printed to standard error stream

    Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.

    the Add button

    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.

    the Edit button

    Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.

    the Delete button

    Click this button to remove the selected log entry from the list.

    browseButton.png

    Click this button to edit the select log file entry. The button is available only when an entry is selected.

    Common options

    When you edit a run configuration (but not a run configuration template), you can specify the following options:

    Item

    Description

    Name

    In this field, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example, from the Run popup (Shift+Alt+F10).

    Share

    Select this checkbox 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.

    Allow running in parallel

    If this checkbox is selected, it is possible to launch a run configuration multiple times in parallel instead of rerunning it. Each runner will start in its own tab of the Run Tool Window or Debug Tool Window.

    When disabled, every time a new instance of the run/debug configuration is launched, PyCharm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog. If you click OK in the confirmation dialog, the first instance of the runner will be stopped, and the next one will take its place. This makes sense when launching two instances of run/debug configurations of the same type consumes too much of the CPU and memory resources..

    Toolbar

    The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

    Item

    Shortcut

    Description

    the Add buttonAlt+Insert

    Create a run/debug configuration.

    the Remove buttonAlt+Delete

    Delete the selected run/debug configuration. Note that you cannot delete default configurations.

    Copy

    Ctrl+D

    Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

    Save configuration

    The toolbar shows this button only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

    Edi Templates

    Edit Templates. View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.

    Method up/Method down

    Alt+Up/Alt+Down

    Move the selected run/debug configuration up and down in the list.

    The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

    Default templates of run/debug configurations are always sorted alphabetically.

    Move into new folder / Create new folder

    Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

    To create a folder, select the configurations within a category, click Folder, and specify the folder name. If only a category is in focus, an empty folder is created.

    Then, to move a configuration into a folder, between the folders or out of a folder, use drag or Move Up and Move Down buttons.

    To remove grouping, select a folder and click Remove Configuration.

    Sort configurations

    Click this button to sort configurations in the alphabetical order.

    Before Launch options

    In this area you can specify tasks that must be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

    Item

    Shortcut

    Description

    the Add buttonAlt+Insert

    Click this icon to add one of the following available tasks:

    • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in PyCharm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.

    • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

    • Launch Web Browser: select this option to have a browser started.C In the dialog that opens, select the type of the browser and provide the start Url. Also, specify if you want the browser be launched with JavaScript debugger.

    • Run File Watchers: select this option to have PyCharm apply all the currently active file watchers.

    • Run Grunt task: select this option to run a Grunt task.

      In the Grunt task dialog 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 Gulp task.

      In the Gulp task dialog 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 option to execute an npm script.

      In the NPM Script dialog that opens, specify the npm run/debug configuration settings.
    • Start React Native Bundler: select this option to run the bundler automatically, as part of a running or debugging session. by default, this is done through react-native start. If your application uses Expo, you need to run the development server via the start npm task. To do that, click Add, then in the Configure React Native dialog, choose npm script and select start from the list.

    • Compile TypeScript: select 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 generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

    • Run Remote External tool: adds a remote SSH external tool.

    the Remove buttonAlt+Delete

    Click this icon to remove the selected task from the list.

    Edit

    Enter

    Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.

    Method up/Method down

    Alt+Up/Alt+Down

    Click these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)

    Show this page

    Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.

    Activate tool window

    By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

    Otherwise, if the checkbox is cleared, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.

    Last modified: 17 May 2019

    See Also