タグ

ブックマーク / qiita.com/hasoya (1)

  • Pythonで例外を投げるときのベストプラクティス - Qiita

    目的 ライブラリ開発やデータ分析ツールの作成の際に適切に例外処理を行うことで、頑健かつバグの発見をしやすいシステムを作れるようになる。Pythonは他言語と比べて例外処理のオーバーヘッドが軽いので積極的に利用することで、高速かつ安全なコードを書くことができます。 推奨行為 例外処理を定義する際に従うべき項目についてまとめました。 投げる例外は適切に文書化する 最も重要なことです。定義した例外がどういうものなのかを適切にドキュメント化しましょう。毎度毎度書くのは面倒なので、名前だけで伝わるような命名にする、__str__ に詳細な説明を書く、もしくはSphinxなどのドキュメント自動生成ツールを使うのがオススメです。ドキュメント生成の自動化については、マスターブランチのマージと同時にドキュメントをS3に公開する。が参考になります。 ライブラリ共通の例外を作成し、全てそれを継承させる これをす

    Pythonで例外を投げるときのベストプラクティス - Qiita
  • 1