25.5. IDLE

ソースコード: Lib/idlelib/


IDLE は Python の統合開発環境で、学習用環境です。

IDLE は次のような特徴があります:

  • tkinter GUIツールキットを使って、100% ピュア Python でコーディングされています
  • クロスプラットホーム: Windows, Unix, Mac OS X で動作します
  • コード入力、出力、エラーメッセージの色付け機能を持った Python shell (対話的インタプリタ) ウィンドウ
  • 多段 Undo、 Python 対応の色づけ、自動的な字下げ、呼び出し情報の表示、自動補完、他たくさんの機能をもつマルチウィンドウ・テキストエディタ
  • 任意のウィンドウ内での検索、エディタウィンドウ内での置換、複数ファイルを跨いだ検索 (grep)
  • 永続的なブレイクポイント、ステップ実行、グローバルとローカル名前空間の視覚化機能を持ったデバッガ
  • 設定、ブラウザ群、ほかダイアログ群

25.5.2. 編集とナビゲーション

ここでの説明で 『C』 は、Windows と Unix の場合は Control キー、Mac OSX では Command キーを示します。

  • Backspace は左側を削除し、 Del は右側を削除します。

  • C-Backspace は語単位で左側を削除、 C-Del は語単位で右側を削除します。

  • 矢印キーと Page Up/Page Down はそれぞれその通りに移動します。

  • C-LeftArrowC-RightArrow は語単位で移動します。

  • Home/End は行の始め/終わりへ移動します。

  • C-Home/C-End はファイルの始め/終わりへ移動します。

  • いくつかの有用な Emacs バインディングが Tcl/Tk から継承されています:

    • C-a で行頭へ移動。
    • C-e で行末へ移動。
    • C-k で行を削除 (ただしクリップボードには入りません)。
    • C-l で挿入ポイントをウィンドウの中心にする。
    • C-b go backward one character without deleting (usually you can also use the cursor key for this)
    • C-f で一文字分文字削除なしで進む (通常、これはカーソルキーでもできます)。
    • C-p で一行上へ移動 (通常、これはカーソルキーでもできます)。
    • C-d で次の文字を削除。

標準的なキーバインディング (C-c がコピーで C-v がペースト、など) は機能するかもしれません。キーバインディングは Configure IDLE ダイアログで選択します。

25.5.2.1. 自動的な字下げ

After a block-opening statement, the next line is indented by 4 spaces (in the Python Shell window by one tab). After certain keywords (break, return etc.) the next line is dedented. In leading indentation, Backspace deletes up to 4 spaces if they are there. Tab inserts spaces (in the Python Shell window one tab), number depends on Indent width. Currently, tabs are restricted to four spaces due to Tcl/Tk limitations.

edit メニューの indent/dedent region コマンドも参照してください。

25.5.2.2. 補完 (Completions)

補完は、関数、クラス、クラスの属性について、組み込み型でもユーザ定義でも効きます。ファイル名でも使えます。

『.』 や (文字列内で) os.sep 文字をタイプすると、定義済の遅延 (デフォルトでは 2 秒) の後 AutoCompleteWindow (ACW) が開きます。それらの文字をタイプ (あるいはそれに続けて数文字タイプ) して Tab キーを押すと、入力に続けられる候補が見つかれば ACW はすぐに開きます。

入力についての補完候補がただ一つであれば、 Tab は ACW を開かずに補完します。

『Show Completions』 will force open a completions window, by default the C-space will open a completions window. In an empty string, this will contain the files in the current directory. On a blank line, it will contain the built-in and user-defined functions and classes in the current namespaces, plus any modules imported. If some characters have been entered, the ACW will attempt to be more specific.

文字列がタイプされると ACW の選択が、それら入力に一番近いものにジャンプします。Editor ウィンドウや Shell ウィンドウでは、 tab をタイプすれば、 曖昧でない最長マッチするものを拾ってきます。現在の ACW 内の選択を確定するには、リターンキーやダブルクリックを使用してもいいですし、 tab を 2 回タイプしてもいいです。ACW 内ではカーソルキーや PgUp/PgDn 、マウス操作やスクロールバー操作も使用できます。

「隠し」 属性には 『.』 のあとで例えば 『_』 のような隠し属性名の開始文字を入力すればアクセスできます。これによって、モジュールの __all__ やクラスプライベートな属性にアクセスできます。

Completion と 『Expand Word』 機能を活用して猛烈タイピングから卒業しましょう!

補完は現在のところ、名前空間内のものに制限されています。 __main__ を介さない Editor ウィンドウ内や sys.modules 内の名前は見つけられません。あなたのインポートとともにモジュールを一度実行すれば、この状況は正せます。なお、IDLE 自身は sys.modules 内のモジュールのかなりの数を使う (re モジュールなど) ため、デフォルトでかなりの数が見つかります (訳注: 動かしてみるとこの表現がわかりにくかったりします。 import とタイプしたときに候補モジュールに re が出てくるわけではないので)。

ACW の招かれざるポップアップ表示がイヤならば、設定で delay を長くするか、拡張自体を無効にしてしまいましょう。

25.5.2.3. 呼び出しヒント (Calltips)

calltip は、 アクセス可能な 関数名に続けて ( をタイプすると表示されます。名前の式ではドットや添え字を含んでいても構いません。calltip は、それをクリックするか、カーソルが引数のエリアから外れるか、 ) をタイプするまでは表示されたままとなります。カーソルが引数部分にあれば、メニューやショートカットで calltip を表示できます。

calltip では関数シグニチャとドキュメンテーション文字列の最初の行を表示します。アクセスできるシグニチャがない組み込み関数の場合は、ドキュメンテーション文字列から、5 行目までの全行か最初の空行までの全行を表示します。いまのところは上記の通りですが、この詳細は変更される場合があります。

アクセス可能な 関数の集合は IDLE 自身がインポートしたものも含め、最後に IDLE を再スタートしてから既にユーザプロセス内で何がインポートされたのか、どの定義が実行されたのかに拠ります。

たとえば Shell を再スタートして (訳注: itertools をインポートせずに) itertools.count( とタイプしてみてください。 IDLE が itertools を自身の使用のためにユーザプロセス内にインポートするので、calltip が表示されます。 (これは変更されるかもしれません)。 turtle.write( と入力しても、何も表示されないでしょう。これは、IDLE は turtle をインポートしないためです。メニューやショートカットを使用しても、何も起こりません。 import turtle と入力した後なら、 turtle.write( で calltip が表示されるようになります。

Editor 内では import 文そのものだけでは、一度でもそのファイルを実行しない限り calltip に影響しません。ファイルの上の方でインポート文を書いたら実行するとか、あるいは既存のものは編集前に実行してしまえ、というのも良いかもしれませんね。

25.5.2.4. Python Shell ウィンドウ

  • C-c で実行中のコマンドを中断します。

  • C-d でファイル終端 (end-of-file) を送り、 >>> プロンプトでタイプしていた場合はウィンドウを閉じます。

  • Alt-/ (語を展開します) もタイピングを減らすのに便利です。

    コマンド履歴

    • Alt-p は、以前のコマンドから検索します。OS X では C-p を使ってください。
    • Alt-n は、次を取り出します。OS X では C-n を使ってください。
    • Return は、以前のコマンドを取り出しているときは、そのコマンドを取り出します。

25.5.2.5. テキストの色

IDLE の表示はデフォルトで白背景に黒字ですが、以下のような特別な意味を持ったテキストには色が付きす。Shell では shell 出力、 shell エラー、ユーザエラー。Python コードでは Shell プロンプト内や Editor でのキーワード、組み込みクラスや組み込み関数の名前、 classdef に続く名前、文字列、そしてコメント。どんなテキストウィンドウでも、カーソル (あれば)、検索で合致したテキスト (あれば)、そして選択されているテキストには色が付きます。

このテキストの色付けはバックグラウンドで行われるため、たまに色が付いてない状態が見えてしまいます。カラースキームは、 Configure IDLE [IDLE の設定] ダイアログの Highlighting タブで変更できます。ただし、エディタ内のデバッガブレークポイント行のマーキングと、ポップアップとダイアログないのテキストの色は、ユーザーにより変更することはできません。

25.5.3. スタートアップとコードの実行

-s オプションとともに起動すると、IDLE は環境変数 IDLESTARTUPPYTHONSTARTUP で参照されているファイルを実行します。 IDLE はまず IDLESTARTUP をチェックし、あれば参照しているファイルを実行します。 IDLESTARTUP が無ければ、IDLE は PYTHONSTARTUP をチェックします。これらの環境変数で参照されているファイルは、IDLE シェルでよく使う関数を置いたり、一般的なモジュールの import 文を実行するのに便利です。

加えて、Tk もスタートアップファイルがあればそれをロードします。その Tk のファイルは無条件にロードされることに注意してください。このファイルは .Idle.py で、ユーザーのホームディレクトリから探されます。このファイルの中の文は Tk の名前空間で実行されるので、IDLE の Python シェルで使う関数を import するのには便利ではありません。

25.5.3.1. コマンドラインの使い方

idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...

-c command  run command in the shell window
-d          enable debugger and open shell window
-e          open editor window
-h          print help message with legal combinations and exit
-i          open shell window
-r file     run file in shell window
-s          run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window
-t title    set title of shell window
-           run stdin in shell (- must be last option before args)

引数がある場合 (訳注: 以下の説明、たぶん実情に反してますが一応訳しています):

  • -, -c, -r のどれかを使う場合、全ての引数は sys.argv[1:...] に入り、 sys.argv[0] には '', '-c', '-r' の、与えたものが入ります。 Options ダイアログでデフォルトだったとしても Editor ウィンドウが開くことはありません。
  • これ以外の場合は引数は編集対象のファイルとして開かれて、 sys.argv には IDLE そのものに渡された引数が反映されます。

25.5.3.2. Startup failure

IDLE uses a socket to communicate between the IDLE GUI process and the user code execution process. A connection must be established whenever the Shell starts or restarts. (The latter is indicated by a divider line that says 『RESTART』). If the user process fails to connect to the GUI process, it displays a Tk error box with a 『cannot connect』 message that directs the user here. It then exits.

A common cause of failure is a user-written file with the same name as a standard library module, such as random.py and tkinter.py. When such a file is located in the same directory as a file that is about to be run, IDLE cannot import the stdlib file. The current fix is to rename the user file.

Though less common than in the past, an antivirus or firewall program may stop the connection. If the program cannot be taught to allow the connection, then it must be turned off for IDLE to work. It is safe to allow this internal connection because no data is visible on external ports. A similar problem is a network mis-configuration that blocks connections.

Python installation issues occasionally stop IDLE: multiple versions can clash, or a single installation might need admin access. If one undo the clash, or cannot or does not want to run as admin, it might be easiest to completely remove Python and start over.

A zombie pythonw.exe process could be a problem. On Windows, use Task Manager to detect and stop one. Sometimes a restart initiated by a program crash or Keyboard Interrupt (control-C) may fail to connect. Dismissing the error box or Restart Shell on the Shell menu may fix a temporary problem.

When IDLE first starts, it attempts to read user configuration files in ~/.idlerc/ (~ is one’s home directory). If there is a problem, an error message should be displayed. Leaving aside random disk glitches, this can be prevented by never editing the files by hand, using the configuration dialog, under Options, instead Options. Once it happens, the solution may be to delete one or more of the configuration files.

If IDLE quits with no message, and it was not started from a console, try starting from a console (python -m idlelib) and see if a message appears.

25.5.3.3. IDLE とコンソールの違い

With rare exceptions, the result of executing Python code with IDLE is intended to be the same as executing the same code in a console window. However, the different interface and operation occasionally affect visible results. For instance, sys.modules starts with more entries.

IDLE also replaces sys.stdin, sys.stdout, and sys.stderr with objects that get input from and send output to the Shell window. When Shell has the focus, it controls the keyboard and screen. This is normally transparent, but functions that directly access the keyboard and screen will not work. If sys is reset with importlib.reload(sys), IDLE’s changes are lost and things like input, raw_input, and print will not work correctly.

IDLE の Shell では、ユーザーは完全な文を入力し、編集し、呼び戻すことができます。一度に一つきりの物理行でしか動作しないコンソールもありますが、IDLE は、 exec を使用してそれぞれの文 (statement) を実行します。その結果、それぞれの文に対して毎回 '__builtins__' が定義されます。

25.5.3.4. Developing tkinter applications

IDLE is intentionally different from standard Python in order to facilitate development of tkinter programs. Enter import tkinter as tk; root = tk.Tk() in standard Python and nothing appears. Enter the same in IDLE and a tk window appears. In standard Python, one must also enter root.update() to see the window. IDLE does the equivalent in the background, about 20 times a second, which is about every 50 milleseconds. Next enter b = tk.Button(root, text='button'); b.pack(). Again, nothing visibly changes in standard Python until one enters root.update().

Most tkinter programs run root.mainloop(), which usually does not return until the tk app is destroyed. If the program is run with python -i or from an IDLE editor, a >>> shell prompt does not appear until mainloop() returns, at which time there is nothing left to interact with.

When running a tkinter program from an IDLE editor, one can comment out the mainloop call. One then gets a shell prompt immediately and can interact with the live application. One just has to remember to re-enable the mainloop call when running in standard Python.

25.5.3.5. サブプロセスを起こさずに起動する

デフォルトでは、IDLE でのユーザコードの実行は、内部的なループバックインターフェイスを使用する、ソケット経由の分離されたサブプロセスで行われます。この接続は外部からは見えませんし、インターネットとのデータの送受信は行われません。ファイアウォールソフトウェアの警告が発生しても、無視して構いません。

If the attempt to make the socket connection fails, Idle will notify you. Such failures are sometimes transient, but if persistent, the problem may be either a firewall blocking the connection or misconfiguration of a particular system. Until the problem is fixed, one can run Idle with the -n command line switch.

IDLE を -n コマンドラインスイッチを使って開始した場合、IDLE は単一のプロセス内で動作し、RPC Python 実行サーバを走らせるサブプロセスを作りません。これは、プラットフォーム上で Python がサブプロセスや RPC ソケットインターフェイスを作れない場合に有用かもしれません。ただし、このモードではユーザコードが IDLE 自身から隔離されませんし、Run/Run Module (F5) 選択時に環境が再起動されてまっさらな状態になることもありません。コードを変更した場合、影響するモジュールを reload() しないといけませんし、変更を反映するには、すべての特定の項目 (from foo import baz など) を再インポートしないといけません。これらの理由から、可能なら常にデフォルトのサブプロセスを起こすモードで IDLE を起動するのが吉です。

バージョン 3.4 で撤廃.

25.5.4. ヘルプとお好み設定

25.5.4.1. Additional help sources [ヘルプ参照先の追加]

IDLE には 「Python Docs」 なるメニューエントリがあります。これを選択すると、https://docs.python.org にある、チュートリアルを含む大掛かりなヘルプが開きます。Configure IDLE [IDLE の設定] ダイアログでいつでもヘルプメニューにヘルプ参照先の URL を追加したり削除したりできます。詳しくは Help メニューの IDLE ヘルプオプションを参照してください。

25.5.4.2. Setting preferences [お好み設定]

The font preferences, highlighting, keys, and general preferences can be changed via Configure IDLE on the Option menu. Keys can be user defined; IDLE ships with four built-in key sets. In addition, a user can create a custom key set in the Configure IDLE dialog under the keys tab.

25.5.4.3. Extensions [拡張]

IDLE contains an extension facility. Preferences for extensions can be changed with the Extensions tab of the preferences dialog. See the beginning of config-extensions.def in the idlelib directory for further information. The only current default extension is zzdummy, an example also used for testing.