例外コンテキスト¶

When raising a new exception while another exceptionis already being handled, the new exception's__context__ attribute is automatically set to the handledexception. An exception may be handled when anexcept orfinally clause, or awith statement, is used.

This implicit exception context can besupplemented with an explicit cause by usingfrom withraise:

raisenew_excfromoriginal_exc

from に続く式は例外かNone でなくてはなりません。式は送出される例外の__cause__ として設定されます。__cause__ を設定することは、__suppress_context__ 属性を暗黙的にTrue に設定することにもなるので、raisenew_excfromNone を使うことで効率的に古い例外を新しいもので置き換えて表示する (例えば、KeyError をAttributeError に置き換え)、古い例外はデバッグ時の調査で使えるよう__context__ に残すことができます。

デフォルトの traceback 表示コードは、例外自体の traceback に加え、これらの連鎖された例外を表示します。__cause__ で明示的に連鎖させた例外は、存在するならば常に表示されます。__context__ で暗黙に連鎖させた例外は、__cause__ がNone かつ__suppress_context__ が false の場合にのみ表示されます。

いずれにせよ、連鎖された例外に続いて、その例外自体は常に表示されます。そのため、traceback の最終行には、常に送出された最後の例外が表示されます。

組み込み例外から継承する¶

User code can create subclasses that inherit from an exception type.It's recommended to only subclass one exception type at a time to avoidany possible conflicts between how the bases handle theargsattribute, as well as due to possible memory layout incompatibilities.

基底クラス¶

以下の例外は、主に他の例外の基底クラスとして使われます。

exceptionBaseException¶

全ての組み込み例外の基底クラスです。ユーザ定義の例外に直接継承されることは意図されていません (継承にはException を使ってください)。このクラスのインスタンスにstr() が呼ばれた場合、インスタンスへの引数の表現か、引数が無い場合には空文字列が返されます。

args¶

例外コンストラクタに与えられた引数のタプルです。組み込み例外は普通、エラーメッセージを与える一つの文字列だけを引数として呼ばれますが、中には (OSError など) いくつかの引数を必要とし、このタプルの要素に特別な意味を込めるものもあります。

with_traceback(tb)¶

This method setstb as the new traceback for the exception and returnsthe exception object. It was more commonly used before the exceptionchaining features ofPEP 3134 became available. The following exampleshows how we can convert an instance ofSomeException into aninstance ofOtherException while preserving the traceback. Onceraised, the current frame is pushed onto the traceback of theOtherException, as would have happened to the traceback of theoriginalSomeException had we allowed it to propagate to the caller.

try:...exceptSomeException:tb=sys.exc_info()[2]raiseOtherException(...).with_traceback(tb)

exceptionException¶

システム終了以外の全ての組み込み例外はこのクラスから派生しています。全てのユーザ定義例外もこのクラスから派生させるべきです。

exceptionArithmeticError¶

算術上の様々なエラーに対して送出される組み込み例外OverflowError,ZeroDivisionError,FloatingPointError の基底クラスです。

exceptionBufferError¶

バッファ に関連する操作が行えなかったときに送出されます。

exceptionLookupError¶

マッピングまたはシーケンスで使われたキーやインデクスが無効な場合に送出される例外IndexError およびKeyError の基底クラスです。codecs.lookup() によって直接送出されることもあります。

具象例外¶

以下の例外は、通常送出される例外です。

exceptionAssertionError¶

assert 文が失敗した場合に送出されます。

exceptionAttributeError¶

属性参照 (属性参照 を参照) や代入が失敗した場合に送出されます (オブジェクトが属性の参照や属性の代入をまったくサポートしていない場合にはTypeError が送出されます)。

コンストラクタのキーワード専用引数を使ってname およびobj 属性を設定できます。設定された場合、アクセスが試みられた属性の名前と、その属性にアクセスしたオブジェクトを、それぞれ表します。

バージョン 3.10 で変更:name およびobj 属性が追加されました。

exceptionEOFError¶

input() が何もデータを読まずに end-of-file (EOF) に達した場合に送出されます。(注意:io.IOBase.read() とio.IOBase.readline() メソッドは、EOF に達すると空文字列を返します。)

exceptionFloatingPointError¶

現在は使われていません。

exceptionGeneratorExit¶

ジェネレータ やコルーチン が閉じられたときに送出されます。generator.close() とcoroutine.close() を参照してください。この例外は厳密に言えばエラーではないので、Exception ではなくBaseException を直接継承しています。

exceptionImportError¶

import 文でモジュールをロードしようとして問題が発生すると送出されます。from...import の中の"from list" (訳注：... の部分)の名前が見つからないときにも送出されます。

コンストラクタのキーワード専用引数を使ってname およびpath 属性を設定できます。設定された場合、インポートを試みられたモジュールの名前と、例外を引き起こしたファイルへのパスとを、それぞれ表します。

バージョン 3.3 で変更:name およびpath 属性が追加されました。

exceptionModuleNotFoundError¶

ImportError のサブクラスで、import 文でモジュールが見つからない場合に送出されます。また、sys.modules にNone が含まれる場合にも送出されます。

バージョン 3.6 で追加.

exceptionIndexError¶

シーケンスの添字が範囲外の場合に送出されます。 (スライスのインデクスはシーケンスの範囲に収まるように暗黙のうちに調整されます; インデクスが整数でない場合、TypeError が送出されます。)

exceptionKeyError¶

マッピング (辞書) のキーが、既存のキーの集合内に見つからなかった場合に送出されます。

exceptionKeyboardInterrupt¶

ユーザが割り込みキー (通常はControl-C またはDelete) を押した場合に送出されます。実行中、割り込みは定期的に監視されます。Exception を捕捉するコードに誤って捕捉されてインタプリタの終了が阻害されないように、この例外はBaseException を継承しています。

注釈

Catching aKeyboardInterrupt requires special consideration.Because it can be raised at unpredictable points, it may, in somecircumstances, leave the running program in an inconsistent state. It isgenerally best to allowKeyboardInterrupt to end the program asquickly as possible or avoid raising it entirely. (SeeNote on Signal Handlers and Exceptions.)

exceptionMemoryError¶

ある操作中にメモリが不足したが、その状況は (オブジェクトをいくつか消去することで) まだ復旧可能かもしれない場合に送出されます。この例外の関連値は、メモリ不足になった (内部) 操作の種類を示す文字列です。下層のメモリ管理アーキテクチャ (C のmalloc() 関数) のために、インタプリタが現状から完璧に復旧できるとはかぎらないので注意してください。それでも、プログラムの暴走が原因の場合に備えて実行スタックのトレースバックを出力できるように、例外が送出されます。

exceptionNameError¶

ローカルまたはグローバルの名前が見つからなかった場合に送出されます。これは非修飾の (訳注:spam.egg ではなく単にegg のような) 名前のみに適用されます。関連値は見つからなかった名前を含むエラーメッセージです。

コンストラクタのキーワード専用引数を使ってname 属性を設定できます。設定された場合、アクセスが試みられた変数の名前を表します。

バージョン 3.10 で変更:name 属性が追加されました。

exceptionNotImplementedError¶

この例外はRuntimeError から派生しています。ユーザ定義の基底クラスにおいて、抽象メソッドが派生クラスでオーバライドされることを要求する場合にこの例外を送出しなくてはなりません。またはクラスは実装中であり本来の実装を追加する必要があることを示します。

注釈

演算子やメソッドがサポートされていないことを示す目的でこの例外を使用するべきではありません。そのようなケースではオペレータやメソッドを未定義のままとするか、サブクラスの場合はNone を設定してください。

注釈

NotImplementedError とNotImplemented は、似たような名前と目的を持っていますが、相互に変換できません。 利用する際には、NotImplemented を参照してください。

exceptionOSError([arg])¶

exceptionOSError(errno,strerror[,filename[,winerror[,filename2]]])

この例外はシステム関数がシステム関連のエラーを返した場合に送出されます。例えば "file not found" や "disk full" のような I/O の失敗が発生したときです (引数の型が不正な場合や、他の偶発的なエラーは除きます)。

コンストラクタの2番目の形式は下記の対応する属性を設定します。指定されなかった場合属性はデフォルトでNone です。後方互換性のために、引数が3つ渡された場合、args 属性は最初の2つの要素のみからなるタプルを持ちます。

コンストラクタは実際には、OS exceptions で述べられているOSError のサブクラスを返すことがよくあります。特定のサブクラスは最終的なerrno 値によります。この挙動はOSError を直接またはエイリアスで構築し、サブクラス化時に継承されなかった場合にのみ発生します。

errno¶

C 変数errno に由来する数値エラーコードです。

winerror¶

Windows において、ネイティブ Windows エラーコードを与えます。そしてerrno 属性は POSIX でいうネイティブエラーコードへのおよその翻訳です。

Windows では、winerror コンストラクタ引数が整数の場合errno 属性は Windows エラーコードから決定され、errno 引数は無視されます。他のプラットフォームではwinerror 引数は無視され、winerror 属性は存在しません。

strerror¶

OS が提供するような、対応するエラーメッセージです。POSIX ではperror() で、Windows ではFormatMessage() で体裁化されます。

filename¶

filename2¶

ファイルシステムパスが1つ関与する例外 (例えばopen() やos.unlink()) の場合、filename は関数に渡されたファイル名です。ファイルシステムパスが2つ関与する関数 (例えばos.rename()) の場合、filename2 は関数に渡された2つ目のファイル名です。

バージョン 3.3 で変更:EnvironmentError,IOError,WindowsError,socket.error,select.error,mmap.error がOSError に統合されました。コンストラクタはサブクラスを返すかもしれません。

バージョン 3.4 で変更:filename 属性がfilesystem encoding and error handler のエンコーディングでエンコードやデコードされた名前から、関数に渡された元々のファイル名になりました。また、filename2 コンストラクタ引数が追加されました。

exceptionOverflowError¶

算術演算の結果が表現できない大きな値になった場合に送出されます。これは整数では起こりません (むしろMemoryError が送出されることになるでしょう)。しかし、歴史的な理由のため、要求された範囲の外の整数に対して OverflowError が送出されることがあります。C の浮動小数点演算の例外処理は標準化されていないので、ほとんどの浮動小数点演算もチェックされません。

exceptionRecursionError¶

この例外はRuntimeError を継承しています。インタープリタが最大再帰深度 (sys.getrecursionlimit() を参照) の超過を検出すると送出されます。

バージョン 3.5 で追加:以前はRuntimeError をそのまま送出していました。

exceptionReferenceError¶

weakref.proxy() によって生成された弱参照 (weak reference) プロキシを使って、ガーベジコレクションによって回収された後の参照対象オブジェクトの属性にアクセスした場合に送出されます。弱参照についてはweakref モジュールを参照してください。

exceptionRuntimeError¶

他のカテゴリに分類できないエラーが検出された場合に送出されます。関連値は、何が問題だったのかをより詳細に示す文字列です。

exceptionStopIteration¶

組込み関数next() とiterator の__next__() メソッドによって、そのイテレータが生成するアイテムがこれ以上ないことを伝えるために送出されます。

この例外オブジェクトには一つの属性value があり、例外を構成する際に引数として与えられ、デフォルトはNone です。

generator やcoroutine 関数が返るとき、新しいStopIteration インスタンスが送出されます。関数の返り値は例外のコンストラクタのvalue 引数として使われます。

ジェネレータのコードが直接的あるいは間接的にStopIteration を送出する場合は、RuntimeError に変換されます (StopIteration は変換後の例外の原因として保持されます)。

バージョン 3.3 で変更:value 属性とジェネレータ関数が値を返すためにそれを使う機能が追加されました。

バージョン 3.5 で変更:from__future__importgenerator_stop による RuntimeError への変換が導入されました。PEP 479 を参照してください。

バージョン 3.7 で変更:PEP 479 が全てのコードでデフォルトで有効化されました: ジェネレータから送出されたStopIteration はRuntimeError に変換されます。

exceptionStopAsyncIteration¶

イテレーションを停止するために、asynchronous iterator オブジェクトの__anext__() メソッドによって返される必要があります。

バージョン 3.5 で追加.

exceptionSyntaxError(message,details)¶

パーザが構文エラーに遭遇した場合に送出されます。この例外はimport 文、組み込み関数compile()、exec() やeval() 、初期化スクリプトの読み込みや標準入力で (対話的な実行時にも) 起こる可能性があります。

例外インスタンスのstr() はエラーメッセージのみを返します。詳細はタプルで、個々の属性としても利用できます。

filename¶

構文エラーが発生したファイルの名前。

lineno¶

ファイルのエラーが発生した行番号。1から数えはじめるため、ファイルの最初の行のlineno は1です。

offset¶

行のエラーが発生した列番号。1から数えはじめるため、行の最初の文字のoffset は1です。

text¶

エラーを含むソースコードのテキスト。

end_lineno¶

ファイルのエラーが発生した最後の行番号。1から数えはじめるため、ファイルの最初の行のlineno は1です。

end_offset¶

行のエラーが発生した最後の列番号。1から数えはじめるため、行の最初の文字のoffset は1です。

For errors in f-string fields, the message is prefixed by "f-string: "and the offsets are offsets in a text constructed from the replacementexpression. For example, compiling f'Bad {a b} field' results in thisargs attribute: ('f-string: ...', ('', 1, 2, '(a b)n', 1, 5)).

バージョン 3.10 で変更:end_lineno およびend_offset 属性が追加されました。

exceptionIndentationError¶

正しくないインデントに関する構文エラーの基底クラスです。これはSyntaxError のサブクラスです。

exceptionTabError¶

タブとスペースを一貫しない方法でインデントに使っているときに送出されます。これはIndentationError のサブクラスです。

exceptionSystemError¶

インタプリタが内部エラーを発見したが、状況は全ての望みを棄てさせるほど深刻ではないと思われる場合に送出されます。関連値は (下位層で) どの動作が失敗したかを示す文字列です。

使用中の Python インタプリタの作者または保守担当者にこのエラーを報告してください。このとき、Python インタプリタのバージョン (sys.version 。Python の対話的セッションを開始した際にも出力されます)、正確なエラーメッセージ (例外の関連値) を忘れずに報告してください。可能な場合にはエラーを引き起こしたプログラムのソースコードも報告してください。

exceptionSystemExit¶

この例外はsys.exit() 関数から送出されます。Exception をキャッチするコードに誤ってキャッチされないように、Exception ではなくBaseException を継承しています。これにより例外は上の階層に適切に伝わり、インタープリタを終了させます。この例外が処理されなかった場合はスタックのトレースバックを表示せずに Python インタープリタは終了します。コンストラクタはsys.exit() に渡されるオプション引数と同じものを受け取ります。値が整数の場合、システムの終了ステータス (C 言語のexit() 関数に渡すもの)を指定します。値がNone の場合、終了ステータスは 0 です。それ以外の型の場合 (例えば str)、 オブジェクトの値が表示され、終了ステータスは 1 です。

sys.exit() は、クリーンアップのための処理 (try 文のfinally 節) が実行されるようにするため、またデバッガが制御不能になるリスクを冒さずにスクリプトを実行できるようにするために例外に変換されます。即座に終了することが真に強く必要であるとき (例えば、os.fork() を呼んだ後の子プロセス内) にはos._exit() 関数を使うことができます。

code¶

コンストラクタに渡された終了ステータス又はエラーメッセージ。(デフォルトはNone)

exceptionTypeError¶

組み込み演算または関数が適切でない型のオブジェクトに対して適用された際に送出されます。関連値は型の不整合に関して詳細を述べた文字列です。

この例外は、そのオブジェクトで実行しようとした操作がサポートされておらず、その予定もない場合にユーザーコードから送出されるかもしれません。オブジェクトでその操作をサポートするつもりだが、まだ実装を提供していないのであれば、送出する適切な例外はNotImplementedError です。

誤った型の引数が渡された場合は (例えば、int が期待されるのに、list が渡された)TypeError となるべきです。しかし、誤った値(例えば、期待する範囲外の数)が引数として渡された場合は、ValueError となるべきです。

exceptionUnboundLocalError¶

関数やメソッド内のローカルな変数に対して参照を行ったが、その変数には値が代入されていなかった場合に送出されます。NameError のサブクラスです。

exceptionUnicodeError¶

Unicode に関するエンコードまたはデコードのエラーが発生した際に送出されます。ValueError のサブクラスです。

UnicodeError はエンコードまたはデコードのエラーの説明を属性として持っています。例えば、err.object[err.start:err.end] は、無効な入力のうちコーデックが処理に失敗した箇所を表します。

encoding¶

エラーを送出したエンコーディングの名前です。

reason¶

そのコーデックエラーを説明する文字列です。

object¶

コーデックがエンコードまたはデコードしようとしたオブジェクトです。

start¶

object の最初の無効なデータのインデクスです。

end¶

object の最後の無効なデータの次のインデクスです。

exceptionUnicodeEncodeError¶

Unicode 関連のエラーがエンコード中に発生した際に送出されます。UnicodeError のサブクラスです。

exceptionUnicodeDecodeError¶

Unicode 関連のエラーがデコード中に発生した際に送出されます。UnicodeError のサブクラスです。

exceptionUnicodeTranslateError¶

Unicode 関連のエラーが変換中に発生した際に送出されます。UnicodeError のサブクラスです。

exceptionValueError¶

演算子や関数が、正しい型だが適切でない値を持つ引数を受け取ったときや、IndexError のようなより詳細な例外では記述できない状況で送出されます。

exceptionZeroDivisionError¶

除算や剰余演算の第二引数が 0 であった場合に送出されます。関連値は文字列で、その演算における被演算子と演算子の型を示します。

以下の例外は、過去のバージョンとの後方互換性のために残されています; Python 3.3 より、これらはOSError のエイリアスです。

exceptionEnvironmentError¶

exceptionIOError¶

exceptionWindowsError¶

Windows でのみ利用できます。

警告¶

次の例外は警告カテゴリとして使われます。詳細については警告カテゴリ のドキュメントを参照してください。

exceptionWarning¶

警告カテゴリの基底クラスです。

exceptionUserWarning¶

ユーザコードによって生成される警告の基底クラスです。

exceptionDeprecationWarning¶

他の Python 開発者へ向けて警告を発するときの、廃止予定の機能についての警告の基底クラスです。

__main__ モジュールを除いて(PEP 565)、デフォルトの警告フィルターで無効化されています。Python Development Mode を有効にするとこの警告が表示されます。

The deprecation policy is described inPEP 387.

exceptionPendingDeprecationWarning¶

古くなって将来的に廃止される予定だが、今のところは廃止されていない機能についての警告の基底クラスです。

近々起こる可能性のある機能廃止について警告を発することはまれなので、このクラスはめったに使われず、既に決まっている廃止についてはDeprecationWarning が望ましいです。

デフォルトの警告フィルターで無効化されています。Python Development Mode を有効にするとこの警告が表示されます。

The deprecation policy is described inPEP 387.

exceptionSyntaxWarning¶

曖昧な構文に対する警告の基底クラスです。

exceptionRuntimeWarning¶

あいまいなランタイム挙動に対する警告の基底クラスです。

exceptionFutureWarning¶

Python で書かれたアプリケーションのエンドユーザーへ向けて警告を発するときの、廃止予定の機能についての警告の基底クラスです。

exceptionImportWarning¶

モジュールインポートの誤りと思われるものに対する警告の基底クラスです。

デフォルトの警告フィルターで無効化されています。Python Development Mode を有効にするとこの警告が表示されます。

exceptionUnicodeWarning¶

Unicode に関連した警告の基底クラスです。

exceptionEncodingWarning¶

エンコーディングに関連した警告の基底クラスです。

詳細はOpt-in EncodingWarning を参照してください。

バージョン 3.10 で追加.

exceptionBytesWarning¶

bytes やbytearray に関連した警告の基底クラスです。

exceptionResourceWarning¶

リソースの使用に関連した警告の基底クラスです。

デフォルトの警告フィルターで無効化されています。Python Development Mode を有効にするとこの警告が表示されます。

バージョン 3.2 で追加.

例外のクラス階層¶

組み込み例外のクラス階層は以下のとおりです:

BaseException+--SystemExit+--KeyboardInterrupt+--GeneratorExit+--Exception+--StopIteration+--StopAsyncIteration+--ArithmeticError|+--FloatingPointError|+--OverflowError|+--ZeroDivisionError+--AssertionError+--AttributeError+--BufferError+--EOFError+--ImportError|+--ModuleNotFoundError+--LookupError|+--IndexError|+--KeyError+--MemoryError+--NameError|+--UnboundLocalError+--OSError|+--BlockingIOError|+--ChildProcessError|+--ConnectionError||+--BrokenPipeError||+--ConnectionAbortedError||+--ConnectionRefusedError||+--ConnectionResetError|+--FileExistsError|+--FileNotFoundError|+--InterruptedError|+--IsADirectoryError|+--NotADirectoryError|+--PermissionError|+--ProcessLookupError|+--TimeoutError+--ReferenceError+--RuntimeError|+--NotImplementedError|+--RecursionError+--SyntaxError|+--IndentationError|+--TabError+--SystemError+--TypeError+--ValueError|+--UnicodeError|+--UnicodeDecodeError|+--UnicodeEncodeError|+--UnicodeTranslateError+--Warning+--DeprecationWarning+--PendingDeprecationWarning+--RuntimeWarning+--SyntaxWarning+--UserWarning+--FutureWarning+--ImportWarning+--UnicodeWarning+--BytesWarning+--EncodingWarning+--ResourceWarning