Pythonソースファイルの組織

Question

私は新しいPythonプロジェクトを開始しており、可能な限り標準的な規則に従いたいと考えています。私は、例えばimport文が最初に来るべきであることを読んだ。しかし、私はすべてのクラス定義の前後にすべての関数定義を置くようなことには何の慣習も見つけていません。このようなことには何らかの規則がありますか？あるいは、誰もが通常、関数やクラス定義のようなものをどのような順序で整理するのが理にかなっていますか？

Answer 1

いいえ、関数とクラスの整理のための規約はありません。しかし、あなたのソースフローがより良くなり、読者にとってより合理的になる基本的なガイドラインがいくつかあります：

• ドキュメント。あなたが何をするにしても、クラスと関数の使用方法（そして場合によっては実装方法）が平易な英語で記述されていることを確認してください。
• 同様の機能を果たす2つの機能？それらをまとめる。
• 常識を使用してください。クラスが別のクラスを継承している場合、基本クラスが最初に来るはずです。関数が定義したクラスのインスタンスを取得する場合、クラス定義が最初に来ることを確認してください。

これがどのように行われたかの例については、Python標準ライブラリをご覧ください。いくつかのモジュールからのソースファイルは、ソースがPythonでどのように整理されているかを理解するはずです。

Answer 2

PEP8は、Pythonのスタイルガイドです：メソッドレベルの輸入が許可されているもののhttp://www.python.org/dev/peps/pep-0008/

輸入は、ファイルの先頭に来ます。

クラスと関数の順序は特にありません。意味をなさないものを使う。