組織Python模組的最佳實踐是什麼?


這是一個示例專案,展示了一種非常好的專案結構方式:https://github.com/kennethreitz/samplemod. 該專案關於建立“sample”模組。目錄結構如下所示

README.rst
LICENSE
setup.py
requirements.txt
sample/__init__.py
sample/core.py
sample/helpers.py
docs/conf.py
docs/index.rst
tests/test_basic.py
tests/test_advanced.py

README.rst檔案:此檔案用於簡要描述模組、如何設定、如何使用等。

LICENSE:包含許可證文字和任何版權宣告。

setup.py:它是Python對多平臺安裝程式和make檔案的答案。如果您熟悉命令列安裝,則make && make install轉換為python setup.py build && python setup.py install。因此,它用於在使用者機器上構建您的專案。

requirements.txt:Pip需求檔案應指定參與專案所需的依賴項:測試、構建和生成文件。如果您的專案沒有開發依賴項,或者您更喜歡透過setup.py設定開發環境,則此檔案是不必要的。

docs/:此目錄包含專案的文件。

tests/:所有測試都應位於此目錄中。最初,您將只有一個測試檔案。隨著測試數量的增長,您可以像模組目錄一樣組織測試。

sample/:此目錄包含您的實際模組程式碼。如果您的模組僅包含單個檔案,您可以將其直接放在儲存庫的根目錄中,例如sample.py。您的庫不應位於不明確的src或python子目錄中。如果要將此模組放在包中,則它將包含一個__init__.py檔案。

更新於:2019年10月1日

450 次瀏覽

啟動您的職業生涯

完成課程獲得認證

開始
廣告
© . All rights reserved.