第 1章簡介、代碼格式設置和工具 1

1.1簡介 1

1.1.1整潔代碼的含義 2

1.1.2整潔代碼的重要性 2

1.1.3一些例外情況 4

1.2設置代碼的格式 4

1.3文檔 7

1.3.1代碼注釋 7

1.3.2文檔字符串 8

1.3.3注解 10

1.3.4注解是否會取代文檔字符串 13

1.4配置和使用工具 15

1.4.1類型一致性檢查 15

1.4.2一般性代碼驗證 17

1.4.3自動設置格式 18

1.4.4自動檢查設置 20

1.5小結 21

1.6參考資料 22



第 2章符合Python語言習慣的代碼 23

2.1索引和切片 24

2.2上下文管理器 26

2.3推導式和賦值表達式 31

2.4對像的特性、屬性及各種方法 34

2.4.1Python中的下劃線 34

2.4.2特性 36

2.4.3使用更緊湊的語法創建類 38

2.4.4可迭代對像 41

2.4.5容器對像 46

2.4.6對像的動態屬性 47

2.4.7可調用對像 49

2.4.8魔法方法小結 50

2.5Python注意事項 51

2.5.1可變的默認參數 51

2.5.2擴展內置類型 52

2.6異步代碼簡介 54

2.7小結 56

2.8參考資料 56



第3章優質代碼的通用特征 57

3.1契約式設計 58

3.1.1前置條件 59

3.1.2後置條件 60

3.1.3Python契約 60

3.1.4契約式設計小結 60

3.2防御式編程 61

3.2.1錯誤處理 61

3.2.2在Python中使用斷言 69

3.3關注點分離 70

3.4常見縮略語 71

3.4.1DRY/OAOO 72

3.4.2YAGNI 73

3.4.3KIS 74

3.4.4EAFP/LBYL 76

3.5Python中的繼承 77

3.5.1什麼情況下使用繼承是個好主意 77

3.5.2反模式的繼承 78

3.5.3Python中的多繼承 81

3.6函數和方法中的參數 83

3.6.1Python中函數參數的工作原理 84

3.6.2函數的參數數量 91

3.7有關軟件設計實踐的後說明 94

3.7.1軟件中的正交性 94

3.7.2結構化代碼 95

3.8小結 96

3.9參考資料 97



第4章SOLID原則 98

4.1單一職責原則 98

4.1.1一個職責過多的類 99

4.1.2分配職責 100

4.2開/閉原則 101

4.2.1因未遵循OCP而帶來可維護性問題的示例 102

4.2.2重構事件繫統以提高可擴展性 104

4.2.3擴展事件繫統 106

4.2.4OCP小結 107

4.3裡氏替換原則 108

4.3.1使用工具找出LSP問題 109

4.3.2更微妙的LSP違反情形 111

4.3.3LSP小結 113

4.4接口分離 114

4.4.1一個提供了太多功能的接口 115

4.4.2接口越小越好 115

4.4.3接口應多小 117

4.5依賴倒置 117

4.5.1一個剛性依賴案例 118

4.5.2倒置依賴 118

4.5.3依賴注入 119

4.6小結 121

4.7參考資料 122



第5章使用裝飾器改善代碼 123

5.1Python裝飾器是什麼 123

5.1.1函數裝飾器 124

5.1.2類裝飾器 125

5.1.3其他類型的裝飾器 129

5.2高級裝飾器 129

5.2.1向裝飾器傳遞參數 129

5.2.2指定了參數默認值的裝飾器 133

5.2.3協程裝飾器 135

5.2.4擴展的裝飾器語法 137

5.3充分利用裝飾器 138

5.3.1調整函數的簽名 139

5.3.2驗證參數 140

5.3.3跟蹤代碼 140

5.4有效的裝飾器：避免常見錯誤 140

5.4.1保留被包裝的原始對像的數據 140

5.4.2在裝飾器中處理副作用 143

5.4.3創建在任何情況下都管用的裝飾器 146

5.5裝飾器與整潔的代碼 149

5.5.1組合勝過繼承 149

5.5.2DRY原則與裝飾器 152

5.5.3裝飾器與關注點分離 153

5.5.4分析優良的裝飾器 154

5.6小結 155

5.7參考資料 156



第6章使用描述符更充分地利用對像 157

6.1初識描述符 157

6.1.1描述符背後的機制 157

6.1.2探討描述符協議中的各個方法 160

6.2描述符類型 167

6.2.1非數據描述符 167

6.2.2數據描述符 169

6.3使用描述符 171

6.3.1描述符的一種用途 171

6.3.2各種描述符實現方式 175

6.3.3使用描述符時需要考慮的其他方面 178

6.4分析描述符 182

6.4.1Python如何在內部使用描述符 182

6.4.2在裝飾器中實現描述符 187

6.5描述符結語 188

6.5.1描述符的接口 188

6.5.2描述符的面向對像設計 188

6.5.3描述符中的類型注解 188

6.6小結 189

6.7參考資料 189



第7章生成器、迭代器和異步編程 190

7.1技術要求 190

7.2創建生成器 190

7.2.1初識生成器 191

7.2.2生成器表達式 193

7.3以慣用法迭代 195

7.4協程 205

7.4.1生成器接口中的方法 205

7.4.2高級協程 210

7.5異步編程 216

7.5.1異步魔法方法 217

7.5.2異步迭代 219

7.5.3異步生成器 221

7.6小結 222

7.7參考資料 223



第8測試和重構 224

8.1設計原測試 224

8.1.1其他形式的自動測試 225

8.1.測試與敏捷軟件開發 226

8.1.測試與軟件設計 227

8.1.4確定測試範圍 230

8.2測試工具 230

8.3重構 248

8.3.1代碼演進 249

8.3.2需要演進的並非隻有生產代碼 251

8.4再談測試 252

8.4.1基於屬性的測試 252

8.4.2變異測試 253

8.4.3常見的測試概念 255

8.4.4測試驅動開發簡介 256

8.5小結 257

8.6參考資料 257



第9章常見設計模式 259

9.1在Python中使用設計模式時需要注意的事項 260

9.2設計模式實戰 261

9.2.1創建型模式 261

9.2.2結構型模式 267

9.2.3行為型模式 273

9.3空對像模式 283

9.4設計模式結語 284

9.4.1模式對設計的影響 285

9.4.2作為理論的設計模式 286

9.4.3模型中的名稱 286

9.5 小結 286

9.6參考資料 287



第 10章整潔的架構 288

10.1從整潔代碼到整潔架構 288

10.1.1關注點分離 289

10.1.2大一統的應用程序和微服務 290

10.1.3抽像 291

10.2軟件組件 292

10.2.1包 292

10.2.2Docker容器 298

10.2.3用例 299

10.2.4服務 303

10.3小結 308

10.4參考資料 309



結語 310