Outdated version of the documentation. Find the latest one here.

` `

QGIS Python コンソール

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





  • iconClearConsole Clear console to wipe the output area;
  • iconClassConsole Import class: Processing, PyQt4.QtCore or PyQt4.QtGui class;
  • iconRunConsole Run command available in the input area: same as pressing Enter;
  • iconeShowEditorConsole Show editor: toggles コードエディタ visibility;
  • iconSettingsConsole Options...;
  • iconHelpConsole Help....



  • コード補完、以下のAPIの構文とcalltipsを強調:

    • パイソン

    • PyQGIS
    • PyQt4
    • QScintilla2
    • osgeo-gdal-ogr
  • Ctrlキー+Altキー+Spaceオプション で有効にしている場合は自動補完リストを表示する;

  • キーボード入力し Enter または コマンドを実行 を押して入力領域からコードスニペットを実行します。

  • Execute code snippets from the output area using the Enter selected from the contextual menu or pressing Ctrl+E;
  • UpDown の矢印キーを使用して、入力エリアからコマンド履歴を閲覧して、必要なコマンドを実行します。

  • Ctrlキー+シフト+ Space はコマンド履歴を表示するために:行をダブルクリックしてコマンドを実行します。 コマンド履歴 ダイアログはまた、入力エリアのコンテキストメニューからアクセスできます。

  • コマンドの履歴を保存してクリア。履歴はファイル ~/.qgis2/console_history.txt に保存されます;

  • Open QGIS API documentation by typing _api;
  • Open PyQGIS Cookbook by typing _pyqgis.



Ctrlキー+ E いくつかのテキストを選択し、を押すと出力パネルからコードスニペットを実行できます。選択したテキストは、インタープリタプロンプト( >>>, ... )が含​​まれているかどうかは関係ありません。


Python コンソール


Use the iconeShowEditorConsole 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:

  • コード補完、以下のAPIの構文とcalltipsを強調:

    • パイソン

    • PyQGIS
    • PyQt4
    • QScintilla2
    • osgeo-gdal-ogr
  • Ctrlキー+Space で自動補完のリストを表示。

  • codepad.org経由でコードスニペットを共有します。

  • Ctrl+4 構文チェック。

  • Search bar (open it with the default Desktop Environement shorcut, usually Ctrl+F):
    • 次/前を検索するにはデフォルトのデスクトップ環境のショートカットを使用します( Ctrlキー+ GShiftキー+Ctrlキー+G )。

    • 検索ボックスに入力すると自動的に最初の一致を見つけます。

    • 検索を開くと選択範囲に最初の検索文字列を設定します。

    • Esc を押すと検索バーを閉じます。

  • オブジェクトインスペクタ:クラスと機能ブラウザ。

  • (オブジェクトインスペクタから)マウスでクリックすると、オブジェクトの定義に移動します。

  • Execute code snippets with the Enter selected command;
  • Execute the whole script with the Run script command (this creates a byte-compiled file with the extension .pyc).


コードエディタ は部分的または完全にからスクリプトを実行すると、コンソール出力領域に結果を出力します。




Accessible either from the Console toolbar or the contextual menu of Console output panel or Code Editor, this adds further settings to manage and control the Python console behavior:

  • Autocompletion: If checked the code completion is enabled. You can get autocompletion from current document, from installed APIs and both from APIs and current document.
  • Autocompletion threshold: Sets the threshold to display the autocompletion list (in chars typed).
  • Automatic parentheses insertion: If checked enables the autoclosing for bracket.
  • Auto-save script before running: Allows you to save automatically the script to be executed in order to avoid to save it after any modification. This action will store a temporary file into the temporary system directory that will be automatically deleted after running.
  • Using preloaded APIs file: You can choose whether use the preload APIs file or load some APIs files saved on your system.
  • Using prepared APIs file: If checked the *.pap file will be used for code completion. To generate a prepared APIs file you have to load at least an *.api file and then compile it by clicking on [Compile Apis...] button.