Python源文件組織

Question

我開始一個新的Python項目，並希望儘可能遵循標準約定。例如，我已經讀過應該首先提供進口報表。但是我還沒有找到任何約定，比如在所有類定義之前或之後放置所有的函數定義。有沒有這樣的事情的約定？還是每個人通常都會按照任何有意義的順序組織函數和類定義之類的東西？

Answer 1

不，沒有關於組織功能和類的約定。但是，有一些基本指導方針可以使您的信息流更好，並使讀者更有意義：

• Document。無論你做什麼，確保類和函數的用途（在某些情況下，實現）用普通英語描述）
• 將相似的東西組合在一起。兩個執行類似功能的函數？把它們放在一起。
• 使用常識。如果一個類繼承另一個類，那麼基類應該優先。如果一個函數需要一個你定義的類的實例，請確保類定義是第一個。

有關如何完成的示例，請查看Python標準庫。一些模塊的源文件應該給你一個想法，如何在Python中組織源代碼。

Answer 2

PEP8是Python風格指南：http://www.python.org/dev/peps/pep-0008/

進口來在文件的頂部，雖然方法級別的進口是允許的。

沒有特定的類和函數的順序。使用有意義的東西。