PyCharm 2016.2 Help

Tutorial: Code Running Assistance

In this section:

Prerequisites

  • You are working with PyCharm version 5.0 or higher.
  • You have already created a Python project and populated it. You can use a project created in the tutorial Creating and Running Your First Python Project.
  • You have Python interpreter already configured. Note that for the current project your Python interpreter version should be 3.0 or higher.

First run

Off we go. Open the class Solver.py for editing (F4), and right-click the editor background. Then choose Run 'Solver' on the context menu:

py_run_solver

The script runs and shows its output in the Run Tool Window: :

py_run_solver_result1

Let's explore in detail what we've done and what we see.

Run/debug configuration - what is it?

Each script or test you wish to run or debug from within PyCharm, needs a special profile that specifies the script name, working directory, and other important data required for running or debugging. PyCharm comes with a number of such pre-defined profiles, or run/debug configurations, that serve patterns, against which you can create any number of run/debug configurations of your own.

Every time you click the Run or Debug buttons (or choose Run or Debug commands on the context menu), you actually launch the current run/debug configuration in the run or debug mode.

If you look at the very first image, you will notice that in the combobox there is no run/debug configuration at all; on the second image it appears, marked with the green circle. It means that the Solver run/debug configuration has been created automatically by PyCharm, when you've chosen Run 'Solver' on the context menu. Now, as this run/debug configuration is marked with the green circle, it is current.

Look at the main toolbar on the second image: the current run/debug configuration is visible in the combobox. To its right you see the buttons run, debug, runWithCoverage, profiler_icon, concurrency_visualization_icon; the run/debug configuration in the combobox is Solver.

You also see that its icon is shown semi-transparent. What does it mean? It means that the Solver run/debug configuration is temporary - PyCharm has created it automatically.

OK, now click the down arrow to reveal the available commands and, below the separator line, the list of existing run/debug configurations:

py_run_solver_menu

Should you have more run/debug configurations, the list of existing ones will become broader. If you click one of the run/debug configurations in this list, it will become current.

Save run/debug configuration

Choose this command to save the temporary run/debug configuration 'Solver' - now this configuration becomes permanent. As such, it gets the normal icon.

Edit run/debug configuration

This command is first in the list. Choose Edit configurations, and see the Run/Debug Configurations dialog box opens:

py_run_config_dialog

Here you see two nodes: Python and Defaults. Under the first node, there is a single Solver configuration, under the second node you see a whole lot of run/debug configurations.

What does it mean?

Under the Defaults node, you see only the stubs, or patterns. If you create a new run/debug configuration, it is created on the grounds of the selected pattern. If you change anything under the Defaults node, then the corresponding run/debug configuration you create will be different.

For example, you want to change the Python interpreter to use a remote or other local interpreter. OK, select the interpreter of your choice in the Python page - then any newly created run/debug configuration of the Python type will use this interpreter.

Under the Python node, you see the only run/debug configuration Solver. It belongs to the Python type, and is created against the pattern Python. It is denoted with the icon of the normal opacity - which corresponds to the permanent run/debug configuration (remember, it became permanent because you've saved it - however, any specially created run/debug configuration also becomes permanent). As an example, create a new run/debug configuration of the Python type for the same Solver script, and call it 'Solver1'.

If you change anything in one of the existing run/debug configurations, then only this particular run/debug configuration will be affected.

Regular run

You've already executed the Solver script in one of the most straight-forward ways. Let us now explore the other ways to run a script.

As you have already learnt, running a script means in fact launching the current run/debug configuration. So, to run the Solver script, follow this procedure:

  1. On the main toolbar, click the run/debug configuration combobox, and make sure that 'Solver' run/debug configuration is the current one.
  2. Do one of the following:
    • Click the Run button run, located next to the run/debug configuration combobox.
    • Press Shift+F10.
    • On the main menu, choose Run | Run.

Now you can observe results in the Run tool window.

Test run

We won't discuss here why testing is necessary - let's just assume that it is so, and discuss how PyCharm can help with it.

Selecting a test runner

First, choose the test runner. To do that, click settings on the main toolbar to open the Settings/Preferences dialog, and under the Tools node, click Python Integrated Tools page. Here is where you will select the default test runner:

py_test_runner

In this case, this is Unittests. Apply changes and close the dialog.

Creating a test

To run a test, you have to create it first. PyCharm suggests a smart way to stub a test out: click the class name and then press Ctrl+Shift+T, or on the main menu, choose Navigate | Test. If a test exists, you can jump directly to it; if it doesn't, PyCharm will create it:

py_create_test_solver

Click the suggested action, and PyCharm will show the following dialog:

py_create_test_dialog

Click OK, and see the test class opened in the editor:

py_test_class

Great! PyCharm has produced a test class for us. However, this is but a stub, and lacks the actual testing functionality. So, we’ll import the class to be tested, and add a test method. The resulting code might be as follows:

import unittest from Solver import Solver class MyTestCase(unittest.TestCase): def test_negative_discr(self): s = Solver() self.assertRaises(Exception) def test_something(self): self.assertEqual(True, False) if __name__ == '__main__': unittest.main()

Running a test

When ready with the testing code, right-click the test class name - the Run node of the context menu shows Unittests run/debug configuration.

Launch it and observe results in the Test Runner tab of the Run tool window:

py_solver_test_results

Debug run

First of all, why do we need debugging? Suppose, you hit a run-time error. How to find out its origin? This is where debugging is necessary.

With PyCharm, you can debug your applications without leaving the IDE. The only thing you need to do beforehand, is to place breakpoints in the required places. Let's explore this in details.

Breakpoint - what is it?

A breakpoint is a line of the source code, where PyCharm will suspend, when this line is reached. PyCharm discerns several types of breakpoints, each one denoted with its own icon.

Here we'll use the Python line breakpoints.

Setting breakpoints

This is definitely the easiest part of the process. Just click the left gutter on the lines you want to explore - and the breakpoints are there:

py_breakpoints_solver

Note that each breakpoint is denoted also with a red stripe over the entire line. This color corresponds to a breakpoint that has not yet been reached. Later we'll see how the line at breakpoint changes its color.

By the way, removing breakpoints is same easy - just click the left gutter again.

Hover your mouse pointer over a breakpoint. PyCharm shows a tooltip with the most essential breakpoint information - line number and script address. However, if you want to change breakpoint settings, you have to right-click a breakpoint. Try changing breakpoint settings for your own, and see how the breakpoint icon changes.

Debugging session

So, we are now ready for debugging. Let's start.

First of all, select the same Solver run/debug configuration from the run/debug configurations combobox, and click the Debug icon debug to the right.

What happens next?

  • PyCharm starts, and then suspends execution at the first breakpoint.
  • The line at breakpoint becomes blue. It means that PyCharm has reached the line with the breakpoint, but has not yet executed it.
  • Next to the executed lines in the editor, the values of the variables appear.
  • The Debug tool window appears. This tool window shows all the important information related to debugging, and allows managing the debugging process.
py_debug_solver

Refer to the product documentation for details.

Working in the Debugger tab

OK, we've paused at the first breakpoint. What's next?

Press F9 or click debug_resume. The program will resume and pause at the next breakpoint. This way you can step through all the set breakpoints, observing the variables used in the application. For more information, refer to the part Debugging of the documentation.

Refer to the section Debug Tool Window. Debugger for details.

Working in the Console tab

Why do we need it at all? For example, you'd like to see the error messages, or perform some calculations not related to the current application... With PyCharm this is not a problem.

Click the Console tab to bring it forward, and then, on the toolbar of this tab, click the button icon_showCommandLine:

py_debug_console_tab

The Python prompt appears, and the console becomes interactive. Try to execute Python commands in this interactive console:

py_debug_console_tab_interactive

Note that interactive console provides code completion (Ctrl+Space) and history (Up/Down arrow keys). Refer to the page Using Debug Console for more information.

You can always invoke the debug console by using the command Tools | Open Debug Command Line on the main menu.

REPL - Running in an interactive console

Finally, if you are used to working with an Interactive Console, you can also do that right from within PyCharm. To launch the console, choose Tools | Python Console... on the main menu:

py_console
Last modified: 10 June 2016