最小限の労力で例外をキャッチする

(初心者向け)



例外の処理は良い習慣ですが、すべての場合にtry-exceptツリーを記述すると、これらの構造が繰り返され始め、コードが複雑になり読みにくくなります。 また、怠のすべての処理を記述します。



そのため、例外処理に苦痛はありません。また、コードの再現性を減らすには、Pythonのパワーと柔軟性を使用する必要があります。



はじめに



一般に、予防策を講じてすべてを事前に確認しても、遅かれ早かれプログラムの例外が発生します。



たとえば、いくつかのアクション(1つのフォルダーからの取得、別のフォルダーへのコピー、3番目のフォルダーの作成、4番目のファイルへのリンク)を行うサービススクリプト。 事前にすべてをチェックするようにスマートにすることができます:ファイルがあるかどうか、それらへのアクセスがあるかどうかなど。 ただし、これはアクション自体が実行されることをまったく保証しません。チェック後、ディスクがいっぱいにならない、切断されない、またはファイルが消去されないということです。 遅かれ早かれ、このような状況が発生し、プログラムが適切に抜け出すことができた方が良いでしょう。



有効なエラーメッセージは、トレースよりも常に優れています。 見てみましょう:

  1. import os os .listdir( dir )



  2. import os os .listdir( dir )









トレースバック(最後の最後の呼び出し):
  ファイル「/tmp/test.py」、12行目、<module>
	 os.listdir(dir)
 OSError:[Errno 13]許可が拒否されました: '/ root'


ユーザーには、理解できない単語トレースバックと多くの不要な情報が表示されます(チェーンに沿ってN個の関数が呼び出された場合、トレースはN倍長くなります)。



基本的に、プログラム全体をtryでラップし、例外をキャッチして、何かを書くことができます。

  1. import osshutilsys
  2. 試してください
  3. os .listdir( '/ etc'
  4. シャティルコピー'/home/culebron/test.txt''/ etc'
  5. os .listdir( '/ root'
  6. f = open'/ etc / hosts''a'
  7. f.write( ')
  8. (OSError、IOError)を除く:
  9. print 'エラー#{1 [1] [0]}:{1 [1] [1]}'。format(dir、sys.exc_info())






	エラー#13:許可が拒否されました




(初心者向けの注意:例外を除いて、提供されたタイプのみをインターセプトし、残りを抑制しないために、例外のタイプを指定することを強くお勧めします。)



これでメッセージは読み取り可能になりましたが、何をどこで破損したかは理解できませんが、メッセージが正確である場合(たとえば、「/ rootフォルダーを読み取れません」)、有能なユーザーは問題が何であるかを理解できます。



上記の宿題:コードツリーの助けを借りて、どのアクションが機能しなかったか、どのエラーが発生したかが明確になるようにします。 たとえば、次のようになります(言語は関係ありません):



	 /ルートフォルダーを読み取れません。 間違い13:許可が拒否された




最も単純な標準ハンドラー



便利なプログラムのように見える単純なスクリプトを次に示します。 / etc / hostsファイルに新しい行を書き込み、その内容を表示します。

  1. #!/ usr / bin / python
  2. myfile = '/ etc / hosts'
  3. 試してください
  4. open (myfile、 'a' f として
  5. f.write( '127.0.0.1 anotherhost'
  6. 例外OSErrorIOError ):
  7. sys .exit( 'ファイル.format(args []、sys.exc_info()[1] .args)の操作中にエラーが発生しました)
  8. 試してください:
  9. fとして open(myfile、 ' a ')を使用:
  10. print ' ' .join(f)
  11. (OSError、IOError)を除く:
  12. sys.exit( ' .formatファイルの操作中にエラーが発生しました(args []、 sys .exc_info()[ 1 ] .args))






明らかに、コードは繰り返され、その多くは一般的なメソッドに持ち込むことができます。 自動例外処理のためのすべてのメソッドを記述するモジュールを作成しましょう。 ここでは、失敗の場合に単に停止するコンソールスクリプトの教育目的でのみ例を示します。



  1. #!/ usr / bin / python
  2. インポートシステム
  3. def fopen( * args):
  4. 試してください
  5. 戻り値* args)
  6. 例外OSErrorIOError ):
  7. sys .exit( '.formatファイルを開くときのエラー(args []、sys.exc_info()[1] .args))






ファイルを安全な名前で保存し、作業スクリプトからロードします。



  1. #!/ usr / bin / python
  2. 安全な輸入
  3. myfile = '/ etc / hosts'
  4. safe.fopen(myfile、 'a' f として
  5. a.write( '127.0.0.1 anotherhost'
  6. safe.fopen(myfile、 'r' f として
  7. 印刷 '' .join(f)






これで、sudoを使用せずにスクリプトを実行すると、スクリプトが美しく停止します。 もちろん、書き込みまたは読み取り中に既に障害が発生している場合は、インターセプトされませんが、後でそのような場合のために保護します。



幅広い用途の方法



そのため、open関数を独自のものに置き換えましたが、実際のタスクでは、さらに多くの関数を操作する必要があります-

os.listdir、os.chmod、os.chown、shutil.copy、shutil.mv、shutil.mkdir、shutil.makedirsなど。 独自の理解可能なエラーメッセージが必要です。



2つの解決策があります。



例外を処理し、指定されたメソッドを呼び出すメソッドを作成します

メソッドを置き換える(つまり、既存のメソッドを装飾する)



単純なものから複雑なものまで:最初に、最初のメソッド、指定されたメソッドを呼び出すメソッドを試してください。



safe.pyモジュールで、メソッドを作成します



  1. def catch(メソッド、引数、メッセージ、 例外 =( OSErrorIOError )):
  2. isinstanceで ない 場合 (args、( listtuple )):
  3. args = [引数]
  4. 試してください
  5. リターンメソッド( * args)
  6. 例外 除く
  7. quit(message.format( * args)+ '.format(sys.exc_info()[1] .args)、1)






これで、任意の関数を呼び出してエラーを処理し、エラーメッセージのみを表示できます。



  1. safe.catch( os .listdir、 '/ root''{0}を開けません'
  2. safe.catch( shutil。copy 、(pathA、pathB)、 '{0}を{1}にコピーできません'






この種類は適用できますが、アクション自体(os.listdir)は行の先頭ではなく括弧で囲まれているため、読みにくくなります。



2番目の方法を試してみましょう-メソッドを置き換える、つまり、装飾します。 最初のメソッドcatchが必要になります。キー引数を使用して関数を呼び出し、catchを呼び出すラッパーを実行するデコレータを作成できるように、少し書き換えます。



  1. def catch(メソッド、メッセージ、 例外* args、 ** kwargs):
  2. isinstanceで ない 場合 (メッセージ、 str ):
  3. TypeErrorを発生させます「メッセージテキストは文字列でなければなりません」
  4. 試してください
  5. リターンメソッド( * args)
  6. 例外 除く
  7. sys .exit(message.format( * args)+ '+''.join(sys.exc_info()[1] .args)、1)
  8. def wrap(メソッド、メッセージ、例外=(IOError、OSError)):
  9. def fn(*引数、** kwargs):
  10. return catch(メソッド、メッセージ、例外、* args、** kwargs)
  11. fnを返す
  12. open = wrap(open、 ' Can)






これで、safeモジュールには、標準のopenに代わるopenメソッドがあり、他のメソッドはラップでラップできます。 このメソッドは、独自の関数のデコレーターとしても使用できます。



多くの場合、ユーティリティスクリプトを記述するとき、あるスクリプトの一部を別のスクリプトで使用する必要があることがわかります。 したがって、それらをすぐにモジュールとして再利用し、少なくともすべての作業アクションをメソッドに入れ、グローバルコードにサービスアクション(たとえば、コマンドラインパラメーターの処理)を残すことを期待する方が良いです。



  1. #!/ usr / bin / python
  2. import osshutil 、safe、 sys
  3. hosts_file = '/ etc / hosts'
  4. @ safe.wrap( 'ファイルの読み取りエラー{0}'
  5. def writehost(ip、host):
  6. 安全で。 f として (hosts_file、 'a' 開きます
  7. f.write( '.format(ip、host))
  8. __name__ == ' __main__ 'の場合:
  9. writehost(sys.argv [1:])
  10. safe.open(hosts_file、 ' r ')をfとして:
  11. print f.read()






ここで、実際には、キャッチされない例外が存在する可能性があります-これはファイルを読み取り中です(最終行)。 使用可能なツールで処理するには、アクションをメソッドに入れる必要がありますが、これを行いたくないと考えて(小さなメソッドの群れもオプションではありません)、try-exceptコンストラクトを記述します。 メッセージを表示する既存のコードを繰り返さないために、別のダンプ関数で安全なモジュールに入れてください:



(safe.py)

  1. def catch(メソッド、メッセージ、 例外* args、 ** kwargs):
  2. isinstanceで ない 場合 (メッセージ、 str ):
  3. TypeErrorを発生させます「メッセージテキストは文字列でなければなりません」
  4. 試してください
  5. リターンメソッド( * args)
  6. 例外 除く
  7. 終了(メッセージ、 * args)
  8. def wrap(メソッド、メッセージ、 例外 =( IOErrorOSError )):
  9. def fn( * args、 ** kwargs):
  10. return catch(メソッド、メッセージ、 例外* args、 ** kwargs)
  11. fnを返す
  12. open = wrap( open'Can)
  13. def quit(msg、* args):
  14. sys.exit(msg.format(* args)+ ' Error: '、 '' .join(map(str、sys.exc_info()[1] .args))、1)
  15. #すべての引数が文字列ではなく、str関数によって変換される必要がある






(メインプログラム)

  1. ...
  2. 安全で。 f として (hosts_file、 'r' 開きます
  3. 試してください
  4. 印刷 '' .join(f)
  5. IOError を除く
  6. safe.quit( 「ファイル{0}は開かれましたが、読み取りに失敗しました。」 、hosts_file)
  7. ...




(注:プログラムとセーフモジュールでは、デコレータを使用してデータ型を確認しています。)



次は?



まず、例外トレースには、Pythonが出力するものよりもはるかに多くの有用な情報が含まれています。 ユーザーが開発者に送信できるように、このデータをファイルのどこかに保存するメソッドを作成すると便利です。



まとめ



多くの典型的なケースでは、例外を処理する4つの方法があります。

アクションを新しいメソッドに移動し、wrapメソッドで装飾します

インラインメソッドをラップで装飾する

catch例外ハンドラーを介してメソッドを呼び出す

try-exceptコンストラクトをコードで記述し、quitメソッドを呼び出します



...そして、人件費は最小限です。ハンドラーの名前とエラーメッセージのテキストを記述するだけです。 例外的な例外は非常にまれであり、それらについてはtry-exceptを記述します。これによりコードが複雑になることはありません。



All Articles