Skip to content

Commit fe874a5

Browse files
committed
Fix markdown syntax error
1 parent d146757 commit fe874a5

14 files changed

Lines changed: 413 additions & 394 deletions

‎zh_CN/1-using-variables-well.md‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,29 @@
1818

1919
### 内容目录
2020

21-
* [如何为变量起名](#如何为变量起名)
22-
* [1. 变量名要有描述性,不能太宽泛](#1-变量名要有描述性不能太宽泛)
23-
* [2. 变量名最好让人能猜出类型](#2-变量名最好让人能猜出类型)
24-
* [『什么样的名字会被当成 bool 类型?』](#什么样的名字会被当成-bool-类型)
25-
* [『什么样的名字会被当成 int/float 类型?』](#什么样的名字会被当成-intfloat-类型)
26-
* [其他类型](#其他类型)
27-
* [3. 适当使用『匈牙利命名法』](#3-适当使用匈牙利命名法)
28-
* [4. 变量名尽量短,但是绝对不要太短](#4-变量名尽量短但是绝对不要太短)
29-
* [使用短名字的例外情况](#使用短名字的例外情况)
30-
* [5. 其他注意事项](#5-其他注意事项)
31-
* [更好的使用变量](#更好的使用变量)
32-
* [1. 保持一致性](#1-保持一致性)
33-
* [2. 尽量不要用 globals()/locals()](#2-尽量不要用-globalslocals)
34-
* [3. 变量定义尽量靠近使用](#3-变量定义尽量靠近使用)
35-
* [4. 合理使用 namedtuple/dict 来让函数返回多个值](#4-合理使用-namedtupledict-来让函数返回多个值)
36-
* [5. 控制单个函数内的变量数量](#5-控制单个函数内的变量数量)
37-
* [6. 及时删掉那些没用的变量](#6-及时删掉那些没用的变量)
38-
* [7. 能不定义变量就不定义](#7-能不定义变量就不定义)
39-
* [结语](#结语)
21+
- [Python 工匠:善用变量来改善代码质量](#python-工匠善用变量来改善代码质量)
22+
- [『Python 工匠』是什么?](#python-工匠是什么)
23+
- [变量和代码质量](#变量和代码质量)
24+
- [内容目录](#内容目录)
25+
- [如何为变量起名](#如何为变量起名)
26+
- [1. 变量名要有描述性,不能太宽泛](#1-变量名要有描述性不能太宽泛)
27+
- [2. 变量名最好让人能猜出类型](#2-变量名最好让人能猜出类型)
28+
- [『什么样的名字会被当成 bool 类型?』](#什么样的名字会被当成-bool-类型)
29+
- [『什么样的名字会被当成 int/float 类型?』](#什么样的名字会被当成-intfloat-类型)
30+
- [其他类型](#其他类型)
31+
- [3. 适当使用『匈牙利命名法』](#3-适当使用匈牙利命名法)
32+
- [4. 变量名尽量短,但是绝对不要太短](#4-变量名尽量短但是绝对不要太短)
33+
- [使用短名字的例外情况](#使用短名字的例外情况)
34+
- [5. 其他注意事项](#5-其他注意事项)
35+
- [更好的使用变量](#更好的使用变量)
36+
- [1. 保持一致性](#1-保持一致性)
37+
- [2. 尽量不要用 globals()/locals()](#2-尽量不要用-globalslocals)
38+
- [3. 变量定义尽量靠近使用](#3-变量定义尽量靠近使用)
39+
- [4. 合理使用 namedtuple/dict 来让函数返回多个值](#4-合理使用-namedtupledict-来让函数返回多个值)
40+
- [5. 控制单个函数内的变量数量](#5-控制单个函数内的变量数量)
41+
- [6. 及时删掉那些没用的变量](#6-及时删掉那些没用的变量)
42+
- [7. 定义临时变量提升可读性](#7-定义临时变量提升可读性)
43+
- [结语](#结语)
4044

4145
## 如何为变量起名
4246

‎zh_CN/10-a-good-player-know-the-rules.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ users_visited_nz = [
5050
]
5151
```
5252

53-
每份数据里面都有着`姓`、`名`、`手机号码`、`旅游时间` 四个字段。基于这份数据,商务同学提出了一个*(听上去毫无道理)*的假设:“去过普吉岛的人,应该对去新西兰旅游也很有兴趣。我们需要从这份数据里,找出那些**去过普吉岛但没有去过新西兰的人**,针对性的卖产品给他们。
53+
每份数据里面都有着`姓`、`名`、`手机号码`、`旅游时间` 四个字段。基于这份数据,商务同学提出了一个 *(听上去毫无道理)* 的假设:“去过普吉岛的人,应该对去新西兰旅游也很有兴趣。我们需要从这份数据里,找出那些**去过普吉岛但没有去过新西兰的人**,针对性的卖产品给他们。
5454

5555
### 第一次蛮力尝试
5656

@@ -73,11 +73,11 @@ def find_potential_customers_v1():
7373
yield phuket_record
7474
```
7575

76-
因为原始数据里没有*“用户 ID”*之类的唯一标示,所以我们只能把“姓名和电话号码完全相同”作为判断是不是同一个人的标准。
76+
因为原始数据里没有 *“用户 ID”* 之类的唯一标示,所以我们只能把“姓名和电话号码完全相同”作为判断是不是同一个人的标准。
7777

7878
`find_potential_customers_v1` 函数通过循环的方式,先遍历所有去过普吉岛的人,然后再遍历新西兰的人,如果在新西兰的记录中找不到完全匹配的记录,就把它当做“潜在客户”返回。
7979

80-
这个函数虽然可以完成任务,但是相信不用我说你也能发现。**它有着非常严重的性能问题。**对于每一条去过普吉岛的记录,我们都需要遍历所有新西兰访问记录,尝试找到匹配。整个算法的时间复杂度是可怕的 `O(n*m)`,如果新西兰的访问条目数很多的话,那么执行它将耗费非常长的时间。
80+
这个函数虽然可以完成任务,但是相信不用我说你也能发现。**它有着非常严重的性能问题**。对于每一条去过普吉岛的记录,我们都需要遍历所有新西兰访问记录,尝试找到匹配。整个算法的时间复杂度是可怕的 `O(n*m)`,如果新西兰的访问条目数很多的话,那么执行它将耗费非常长的时间。
8181

8282
为了优化内层循环性能,我们需要减少线性查找匹配部分的开销。
8383

@@ -109,7 +109,7 @@ def find_potential_customers_v2():
109109

110110
### 对问题的重新思考
111111

112-
让我们来尝试重新抽象思考一下问题的本质。首先,我们有一份装了很多东西的容器 A*(普吉岛访问记录)*,然后给我们另一个装了很多东西的容器 B*(新西兰访问记录)*,之后定义相等规则:“姓名与电话一致”。最后基于这个相等规则,求 A 和 B 之间的**“差集”**。
112+
让我们来尝试重新抽象思考一下问题的本质。首先,我们有一份装了很多东西的容器 A*(普吉岛访问记录)*,然后给我们另一个装了很多东西的容器 B*(新西兰访问记录)*,之后定义相等规则:“姓名与电话一致”。最后基于这个相等规则,求 A 和 B 之间的 **“差集”**。
113113

114114
如果你对 Python 里的集合不是特别熟悉,我就稍微多介绍一点。假如我们拥有两个集合 A 和 B,那么我们可以直接使用 `A - B` 这样的数学运算表达式来计算二者之间的 **差集**。
115115

@@ -307,7 +307,7 @@ if not events.is_empty():
307307
print(events.list_events_by_range(1, 3))
308308
```
309309

310-
但是,这样并非最好的做法。因为 Python 已经为我们提供了一套对象规则,所以我们不需要像写其他语言的 OO*(面向对象)* 代码那样去自己定义额外方法。我们有更好的选择:
310+
但是,这样并非最好的做法。因为 Python 已经为我们提供了一套对象规则,所以我们不需要像写其他语言的 OO *(面向对象)* 代码那样去自己定义额外方法。我们有更好的选择:
311311

312312
```python
313313

‎zh_CN/11-three-tips-on-writing-file-related-codes.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ print(count_vowels('small_file.txt'))
258258
2. 为了准备测试用例,我要么提供几个样板文件,要么写一些临时文件
259259
3. 而文件是否能被正常打开、读取,也成了我们需要测试的边界情况
260260

261-
**如果,你发现你的函数难以编写单元测试,那通常意味着你应该改进它的设计。**上面的函数应该如何改进呢?答案是:*让函数依赖“文件对象”而不是文件路径*。
261+
**如果,你发现你的函数难以编写单元测试,那通常意味着你应该改进它的设计**。上面的函数应该如何改进呢?答案是:*让函数依赖“文件对象”而不是文件路径*。
262262

263263
修改后的函数代码如下:
264264

@@ -280,7 +280,7 @@ with open('small_file.txt') as fp:
280280
print(count_vowels_v2(fp))
281281
```
282282

283-
**这个改动带来的主要变化,在于它提升了函数的适用面。**因为 Python 是“鸭子类型”的,虽然函数需要接受文件对象,但其实我们可以把任何实现了文件协议的 “类文件对象(file-like object)” 传入 `count_vowels_v2` 函数中。
283+
**这个改动带来的主要变化,在于它提升了函数的适用面**。因为 Python 是“鸭子类型”的,虽然函数需要接受文件对象,但其实我们可以把任何实现了文件协议的 “类文件对象(file-like object)” 传入 `count_vowels_v2` 函数中。
284284

285285
而 Python 中有着非常多“类文件对象”。比如 io 模块内的 [StringIO](https://docs.python.org/3/library/io.html#io.StringIO) 对象就是其中之一。它是一种基于内存的特殊对象,拥有和文件对象几乎一致的接口设计。
286286

‎zh_CN/12-write-solid-python-codes-part-1.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ if __name__ == '__main__':
167167

168168
## S:单一职责原则
169169

170-
SOLID 设计原则里的第一个字母 S 来自于 “Single responsibility principle(单一职责原则)” 的首字母。这个原则认为:**“一个类应该仅仅只有一个被修改的理由。”**换句话说,每个类都应该只有一种职责。
170+
SOLID 设计原则里的第一个字母 S 来自于 “Single responsibility principle(单一职责原则)” 的首字母。这个原则认为:**“一个类应该仅仅只有一个被修改的理由。”** 换句话说,每个类都应该只有一种职责。
171171

172172
而在上面的代码中,`HNTopPostsSpider` 这个类违反了这个原则。因为我们可以很容易的找到两个不同的修改它的理由:
173173

@@ -272,7 +272,7 @@ def main():
272272
write_posts_to_file(posts, sys.stdout, file_title)
273273
```
274274

275-
将“文件写入”职责拆分为新函数是一个 Python 特色的解决方案,它虽然没有那么 OO*(面向对象)*,但是同样满足“单一职责原则”,而且在很多场景下更灵活与高效。
275+
将“文件写入”职责拆分为新函数是一个 Python 特色的解决方案,它虽然没有那么 OO *(面向对象)*,但是同样满足“单一职责原则”,而且在很多场景下更灵活与高效。
276276

277277
## O:开放-关闭原则
278278

@@ -558,7 +558,7 @@ def main():
558558

559559
在这篇文章中,我通过一个具体的 Python 代码案例,向你描述了 “SOLID” 设计原则中的前两位成员:**“单一职责原则”** 与 **“开放-关闭原则”**。
560560

561-
这两个原则虽然看上去很简单,但是它们背后蕴藏了许多从好代码中提炼而来的智慧。它们的适用范围也不仅仅局限在 OOP 中。一旦你深入理解它们后,你可能会惊奇的在许多设计模式和框架中发现它们的影子*(比如这篇文章就出现了至少 3 种设计模式,你知道是哪些吗?)*。
561+
这两个原则虽然看上去很简单,但是它们背后蕴藏了许多从好代码中提炼而来的智慧。它们的适用范围也不仅仅局限在 OOP 中。一旦你深入理解它们后,你可能会惊奇的在许多设计模式和框架中发现它们的影子 *(比如这篇文章就出现了至少 3 种设计模式,你知道是哪些吗?)*。
562562

563563
让我们最后再总结一下吧:
564564

‎zh_CN/13-write-solid-python-codes-part-2.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<img src="https://www.zlovezl.cn/static/uploaded/2019/11/neonbrand-CXDw96Oy-Yw-unsplash_w1280.jpg" width="100%" />
99
</div>
1010

11-
在 [上一篇文章](https://www.zlovezl.cn/articles/write-solid-python-codes-part-1/) 里,我用一个虚拟小项目作为例子,讲解了“SOLID”设计原则中的前两位成员:S*(单一职责原则)*与 O*(开放-关闭原则)*。
11+
在 [上一篇文章](https://www.zlovezl.cn/articles/write-solid-python-codes-part-1/) 里,我用一个虚拟小项目作为例子,讲解了“SOLID”设计原则中的前两位成员:S *(单一职责原则)* 与 O *(开放-关闭原则)*。
1212

1313
在这篇文章中,我将继续介绍 SOLID 原则的第三位成员:**L(里氏替换原则)**。
1414

@@ -26,7 +26,7 @@
2626

2727
## L:里氏替换原则
2828

29-
同前面的 S 与 O 两个原则的命名方式不同,里氏替换原则*(Liskov Substitution Principle)*是直接用它的发明者 [Barbara Liskov](https://en.wikipedia.org/wiki/Barbara_Liskov) 命名的,原文看起来像一个复杂的数学公式:
29+
同前面的 S 与 O 两个原则的命名方式不同,里氏替换原则 *(Liskov Substitution Principle)* 是直接用它的发明者 [Barbara Liskov](https://en.wikipedia.org/wiki/Barbara_Liskov) 命名的,原文看起来像一个复杂的数学公式:
3030

3131
> Let q(x) be a property provable about objects of x of type T. Then q(y) should be provable for objects y of type S where S is a subtype of T.
3232
> - 出处: [Liskov substitution principle - Wikipedia](https://en.wikipedia.org/wiki/Liskov_substitution_principle)
@@ -127,11 +127,11 @@ def deactivate_users(users: Iterable[User]):
127127

128128
既然为函数增加类型判断无法让代码变得更好,那我们就应该从别的方面入手。
129129

130-
“里氏替换原则”提到,**子类*(Admin)*应该可以随意替换它的父类*(User)*,而不破坏程序*(deactivate_users)*本身的功能。**我们试过直接修改类的使用者来遵守这条原则,但是失败了。所以这次,让我们试着从源头上解决问题:重新设计类之间的继承关系。
130+
“里氏替换原则”提到,**子类 *(Admin)* 应该可以随意替换它的父类 *(User)*,而不破坏程序 *(deactivate_users)* 本身的功能**。 我们试过直接修改类的使用者来遵守这条原则,但是失败了。所以这次,让我们试着从源头上解决问题:重新设计类之间的继承关系。
131131

132132
具体点来说,子类不能只是简单通过抛出异常的方式对某个类方法进行“退化”。如果 *“对象不能支持某种操作”* 本身就是这个类型的 **核心特征** 之一,那我们在进行父类设计时,就应该把这个 **核心特征** 设计进去。
133133

134-
拿用户类型举例,*“用户可能无法被停用”* 就是 `User` 类的核心特征之一,所以在设计父类时,我们就应该把它作为类方法*(或属性)*写进去。
134+
拿用户类型举例,*“用户可能无法被停用”* 就是 `User` 类的核心特征之一,所以在设计父类时,我们就应该把它作为类方法 *(或属性)* 写进去。
135135

136136
让我们看看调整后的代码:
137137

@@ -214,7 +214,7 @@ def list_user_post_titles(user: User) -> Iterable[str]:
214214
yield session.query(Post).get(post_id).title
215215
```
216216

217-
对于上面的 `list_user_post_titles` 函数来说,无论传入的 `user` 参数是 `User` 还是 `Admin` 类型,它都能正常工作。因为,虽然普通用户和管理员类型的 `list_related_posts` 方法返回结果略有区别,但它们都是**“可迭代的帖子 ID”**,所以函数里的循环在碰到不同的用户类型时都能正常进行。
217+
对于上面的 `list_user_post_titles` 函数来说,无论传入的 `user` 参数是 `User` 还是 `Admin` 类型,它都能正常工作。因为,虽然普通用户和管理员类型的 `list_related_posts` 方法返回结果略有区别,但它们都是 **“可迭代的帖子 ID”**,所以函数里的循环在碰到不同的用户类型时都能正常进行。
218218

219219
既然如此,那上面的代码符合“里氏替换原则”吗?答案是否定的。因为虽然在当前 `list_user_post_titles` 函数的视角看来,子类 `Admin` 可以任意替代父类 `User` 使用,但这只是特殊用例下的一个巧合,并没有通用性。请看看下面这个场景。
220220

@@ -246,7 +246,7 @@ def get_user_posts_count(user: User) -> int:
246246

247247
而现在的设计没做到这点,现在的子类返回值所支持的操作,只是父类的一个子集。`Admin` 子类的 `list_related_posts` 方法所返回的生成器,只支持父类 `User` 返回列表里的“迭代操作”,而不支持其他行为(比如 `len()`)。所以我们没办法随意的用子类替换父类,自然也就无法符合里氏替换原则。
248248

249-
> **注意:**此处说“生成器”支持的操作是“列表”的子集其实不是特别严谨,因为生成器还支持 `.send()` 等其他操作。不过在这里,我们可以只关注它的可迭代特性。
249+
> 注意:此处说“生成器”支持的操作是“列表”的子集其实不是特别严谨,因为生成器还支持 `.send()` 等其他操作。不过在这里,我们可以只关注它的可迭代特性。
250250
251251
### 如何修改代码
252252

@@ -328,7 +328,7 @@ class Admin(User):
328328

329329
让我们最后再总结一下吧:
330330

331-
- **“L:里氏替换原则”**认为子类应该可以任意替换父类被使用
331+
- **“L:里氏替换原则”** 认为子类应该可以任意替换父类被使用
332332
- 在类的使用方增加具体的类型判断(*isinstance*),通常不是最佳解决方案
333333
- 违反里氏替换原则,通常也会导致违反“开放-关闭”原则
334334
- 考虑什么是类的核心特征,然后为父类增加新的方法和属性可以帮到你

0 commit comments

Comments
 (0)