pythonでの例外処理のcatchについて

Question

前提・実現したいこと

pythonにてCI/CDツールを作成しております。
コード全般にかかわる例外処理にて、catch節でどう例外をキャッチしようか悩んでおります。
catch後にstacktraceなどの情報を加工して、ユーザに表示することを考えております。
pythonとしての例外処理のベストプラクティスを知りたいです。

検討中のパターン

その1)
exceptで全例外を補足する

try:
  <例外発生>
except:
  t, v, tb = sys.exc_info()
  ms = "xxxxxに失敗しました。{0}".format(traceback.format_exception(t,v,tb))
  logger.error(ms)

その2)
exceptでException例外を補足する

try:
  <例外発生>
except Exception as e:
  logger.error(e)

Comments

[tachikoma]

どの程度エラーメッセージを加工する予定ですか（その2を応用）？またstacktraceも残しますか？

[chomechome]

stacktraceを残し、stacktraceの先頭にメッセージを付与する方針です。

Answer 1

その1でもその2でもキャッチできる例外は同じなので、構文に関する趣味のレベルでお答えします。

今回はエラーの発生元に関する詳細が必要なようなので、その1だけを使うのがいいのかなと思いました。Exeptionのメッセージを単に表示させるだけであればその2のままでいいのですが、sysモジュールを使ってstacktraceを含む例外の詳細な情報を取得すのであれば、excep Exception as eで取得したeは情報がダブるだけで必要なさそうに見えます。

また、Pythonらしい書き方について少し言及しておくと、すべての例外をキャッチする構文を使う場面としては、下記のようにより具体的な例外をキャッチしたあとで、それでも残る可能性に対して使う場合があるかなと思いました。ただ、今回は具体的な例外を想定できないので最初からすべての例外を捕まえる書き方で問題ないと思います。

try:
    ...
except IOError as e:
    # do something
except NameError as e:
    # do something
except:
    ...

Comments

[chomechome]

丁寧でわかりやすいご回答ありがとうございます！
スッキリしました！

Answer 2

その1とその2は例外処理のしたかとしては同じで、「全ての例外を捕捉して処理を継続する」のように見えます。

例外については、

• その処理で発生することが想定され、どのように対処すべきかわかっているもののみ処理する

のが普通だと思います。

try:
  <ファイル入出力処理>
except IOException as e:
  <例外発生時の対応>

Comments

[chomechome]

ご回答ありがとうございます。
>その処理で発生することが想定され、どのように対処すべきかわかっているもののみ処理する
のが普通だと思います。
全例外を補足し、メッセージを加工してユーザに表示する必要があります。
発生することが想定されるとのことですが、pythonはスクリプト言語でjavaの検査例外とは異なり、実装側で漏らさずcatchすることは難しいと考えております。
そのため、一番外側の関数で全例外を補足しようと考えております。

[TakaiY]

> 全例外を補足し、メッセージを加工してユーザに表示する必要があります

ということであれば、「その2」のように全例外を捕捉すればよいと思いますので、質問の目的がよくわかりません。

以下、本筋ではありません。

> pythonはスクリプト言語でjavaの検査例外とは異なり、実装側で漏らさずcatchすることは難しい

どのような言語であっても、自分で作った処理であれば、どのような例外が発生するかはわかるはずです。 外部のライブラリを使うとしても、よほど酷い作りのものでなければ、確認できると思います。スクリプト言語であるかどうかは関係ないでしょう。

[chomechome]

>外部のライブラリを使うとしても、よほど酷い作りのものでなければ、確認できると思います。スクリプト言語であるかどうかは関係ないでしょう。
わたしの今までの例外に対する認識が甘かったです。言語関係なく、例外をしっかり捕捉していきたいと思います。
ありがとうございます。