項目結構應該保持簡單,審慎地使用包和層次結構:過深的層次結構在目錄導航時將如同夢魘,但過平的層次結構則會讓項目變得臃腫。
一個常犯的錯誤是將單元測試放在包目錄的外面。這些測試實際上應該被包含在軟件的子包中,以便:
- 不會偶爾被**setuptools**(或者其他打包庫)作為tests頂層模塊自動安裝;
- 能夠被安裝,且被其他包用于構建自己的單元測試。
圖1-1展示了一個項目的標準文件層次結構。
`setup.py`是Python安裝腳本的標準名稱。在安裝時,它會通過Python分發工具(distutils)進行包的安裝。也可以通過`README.rst`(或者`README.txt`或其他合適的名字)為用戶提供重要信息。`requirements.txt`應該包含Python包所需要的依賴包,也就是說,所有這些包都會預先通過`pip`這樣的工具進行安裝,以保證你的包能正常工作。還可以包含`test-requirements.txt`,它只列出運行測試套件所需要的依賴包。最后,`docs`文件夾應該包括`reStructuredText`格式的文檔,以便能夠被Sphinx處理(參見5.1節)。
包中還經常需要包含一些額外的數據,如圖片、shell腳本等。不過,關于這類文件如何保存并沒有一個統一的標準。因此放到任何覺得合適的地方都可以。

圖1-1 標準的包目錄結構
下面這些頂層目錄也經常出現。
- `etc`用來存放配置文件的樣例。
- `tools`用來存放與工具有關的shell腳本。
- `bin`用來存放將被`setup.py`安裝的二進制腳本。
- `data`用來存放其他類型的文件,如媒體文件。
一個常見的設計問題是根據將要存儲的代碼的類型來創建文件或模塊。使用`functions.py`或者`exceptions.py`這樣的文件是很**糟糕的**方式。這種方式對代碼的組織毫無幫助,只能讓讀代碼的人在多個文件之間毫無理由地來回切換。
此外,應該避免創建那種只有一個`__init__.py`文件的目錄,例如,如果`hooks.py`夠用的話就不要創建`hooks/__init__.py`。如果創建目錄,那么其中就應該包含屬于這一分類/模塊的多個Python文件。
- 內容提要
- 中文版序
- 前言
- 第1章 項目開始
- 1.1 Python版本
- 1.2 項目布局
- 1.3 版本編號
- 1.4 編碼風格與自動檢查
- 1.5 Joshua Harlow訪談
- 第2章 模塊和庫
- 2.1 導入系統
- 2.2 標準庫
- 2.3 外部庫
- 2.4 框架
- 2.5 Doug Hellmann訪談
- 第3章 管理API變化
- Christophe de Vienne訪談
- 第4章 時區陷阱
- 第5章 文檔
- 5.1 Sphinx和reST入門
- 5.2 Sphinx模塊
- 5.3 擴展Sphinx
- 第6章 分發
- 6.1 簡史
- 6.2 使用pbr打包
- 6.3 Wheel格式
- 6.4 包的安裝
- 6.5 和世界分享你的成果
- 6.6 Nick Coghlan訪談
- 6.7 入口點
- 6.7.1 可視化的入口點
- 6.7.2 使用控制臺腳本
- 6.7.3 使用插件和驅動程序
- 第7章 虛擬環境
- 第8章 單元測試
- 8.1 基礎知識
- 8.2 fixture
- 8.3 模擬(mocking)
- 8.4 場景測試
- 8.5 測試序列與并行
- 8.6 測試覆蓋
- 8.7 使用虛擬環境和tox
- 8.8 測試策略
- 8.9 Robert Collins訪談
- 第9章 方法和裝飾器
- 9.1 創建裝飾器
- 9.2 Python中方法的運行機制
- 9.3 靜態方法
- 9.4 類方法
- 9.5 抽象方法
- 9.6 混合使用靜態方法、類方法和抽象方法
- 9.7 關于super的真相
- 第10章 函數式編程
- 10.1 生成器
- 10.2 列表推導
- 10.3 函數式函數的函數化
- 第11章 抽象語法樹
- 11.1 用抽象語法樹檢查來擴展flake8
- 11.2 Hy
- 11.3 Paul Tagliamonte訪談
- 第12章 性能與優化
- 12.1 數據結構
- 12.2 性能分析
- 12.3 有序列表和二分查找
- 12.4 namedtuple和slots
- 12.5 memoization
- 12.6 PyPy
- 12.7 通過緩沖區協議實現零復制
- 12.8 Victor Stinner訪談
- 第13章 擴展與架構
- 13.1 多線程的注意事項
- 13.2 多進程與多線程
- 13.3 異步和事件驅動架構
- 13.4 面向服務架構
- 第14章 RDBMS和ORM
- 14.1 用Flask和PostgreSQL流化數據
- 14.2 Dimitri Fontaine訪談
- 第15章 Python 3支持策略
- 15.1 語言和標準庫
- 15.2 外部庫
- 15.3 使用six
- 第16章 少即是多
- 16.1 單分發器
- 16.2 上下文管理器
- 第17章 延伸閱讀
- 版權信息
- 版權聲明
- 歡迎來到異步社區!
- 異步社區的來歷
- 社區里都有什么?
- 購買圖書
- 下載資源
- 與作譯者互動
- 靈活優惠的購書
- 紙電圖書組合購買
- 社區里還可以做什么?
- 提交勘誤
- 寫作
- 會議活動早知道
- 加入異步