25.3. QGIS Python console

As you will see later in this chapter, QGIS has been designed with a plugin architecture. Plugins can be written in Python, a very famous language in the geospatial world.

QGIS brings a Python API (see PyQGIS Developer Cookbook for some code sample) to let the user interact with its objects (layers, feature or interface). QGIS also has a Python console.

The QGIS Python Console is an interactive shell for the python command executions. It also has a python file editor that allows you to edit and save your python scripts. Both console and editor are based on PyQScintilla2 package. To open the console go to Plugins ► Python Console (Ctrl+Alt+P).

25.3.1. The Interactive Console

The interactive console is composed of a toolbar, an input area and an output one.

25.3.1.1. Toolbar

The toolbar proposes the following tools:

  • clearConsole Clear Console to wipe the output area;

  • runConsole Run Command available in the input area: same as pressing Enter;

  • showEditorConsole Show Editor: toggles The Code Editor visibility;

  • options Options…: opens a dialog to configure console properties (see Python Console Settings);

  • helpContents Help…: browses the current documentation.

25.3.1.2. Console

The console main features are:

  • Code completion, highlighting syntax and calltips for the following APIs:

    • Python

    • PyQGIS

    • PyQt5

    • QScintilla2

    • osgeo-gdal-ogr

  • Ctrl+Alt+Space to view the auto-completion list if enabled in the Python Console Settings;

  • Execute code snippets from the input area by typing and pressing Enter or Run Command;

  • Execute code snippets from the output area using the Enter Selected from the contextual menu or pressing Ctrl+E;

  • Browse the command history from the input area using the Up and Down arrow keys and execute the command you want;

  • Ctrl+Shift+Space to view the command history: double-clicking a row will execute the command. The Command History dialog can also be accessed from context menu of input area;

  • Save and clear the command history. The history will be saved into the console_history.txt file under the active user profile folder;

  • Open QGIS C++ API documentation by typing _api;

  • Open QGIS Python API documentation by typing _pyqgis.

  • Open PyQGIS Cookbook by typing _cookbook.

Javaslat

Reuse executed commands from the output panel

You can execute code snippets from the output panel by selecting some text and pressing Ctrl+E. No matter if selected text contains the interpreter prompt (>>>, ...).

../../../_images/python_console.png

25.19. ábra The Python Console

25.3.2. The Code Editor

Use the showEditorConsole Show Editor button to enable the editor widget. It allows editing and saving Python files and offers advanced functionalities to manage your code (comment and uncomment code, check syntax, share the code via codepad.org and much more). Main features are:

  • Code completion, highlighting syntax and calltips for the following APIs:

    • Python

    • PyQGIS

    • PyQt5

    • QScintilla2

    • osgeo-gdal-ogr

  • Ctrl+Space to view the auto-completion list.

  • Sharing code snippets via codepad.org.

  • Ctrl+4 Syntax check.

  • Search bar (open it with the default Desktop Environment shortcut, usually Ctrl+F):

    • Use the default Desktop Environment shortcut to find next/previous (Ctrl+G and Shift+Ctrl+G);

    • Automatically find first match when typing in find box;

    • Set initial find string to selection when opening find;

    • Pressing Esc closes the find bar.

  • Object inspector: a class and function browser;

  • Go to an object definition with a mouse click (from Object inspector);

  • Execute code snippets with the runConsole Run Selected command in contextual menu;

  • Execute the whole script with the start Run Script command (this creates a byte-compiled file with the extension .pyc).

Megjegyzés

Running partially or totally a script from the Code Editor outputs the result in the Console output area.

../../../_images/python_console_editor.png

25.20. ábra The Python Console editor

Javaslat

Save the options

To save the state of console’s widgets you have to close the Python Console from the close button. This allows you to save the geometry to be restored to the next start.