同样的功能，你可以使用不同的代码方式来实现，它们，都可以跑的起来，而在背后的那些「跳动」着的代码，有的美如诗，有的丑如屎...如果说，代码是有生命的，那么你希望它是温柔的天仙，还是抠脚的大汉？

你在 Python 环境中， import 一下 this，浮现出来的是一首诗，前部分是：

Beautiful is better than ugly.

Explicit is better than implicit.

Simple is better than complex.

Complex is better than complicated.

Flat is better than nested.

Sparse is better than dense.

Readability counts.

你看这 Python 的思想，要的就是简洁，漂亮，可读性好...

为了让你团队之间合作得愉快，为了让你我心情好一点，为了你的幸福，我想还是有必要跟你说说：

如何避免把 Python 代码写得跟屎一样。。。

那么接下来就是

学习 Python 的正确姿势

关于名称

在写代码的时候，我们有很多地方需要定义名称，比如常用到就有变量的名称，类的名称，方法的名称，参数的名称等等...如何才能写好它们呢？

类名

有一种命名法叫「大驼峰式命名法」：

每一个单字的首字母都采用大写字母，例如：FirstName、LastName、CamelCase，也被称为Pascal命名法（英语：Pascal Case）。

在 Python 中起类名最好就是使用这种方式，比如：MyClass，FxxkPython。

还有一点要注意的是，有些单词本身就是缩写的，比如：

HTML = HyperText Markup Language

HTTP = HyperText Transfer Protocol

那么在写含有这些单词的类名时，也是需要大写的：

HTTPServerError

而不是：

HttpServerError

方法名和变量名

方法名和变量名尽量全使用小写字母，如果名称中的单词多，可以使用「_」来分割，比如：

firstname，lastname，extract_data，file，age，name....

模块名称

模块名称也是全使用小写字母，使用「_」来分割，比如：

fxxk.py，fxxk_python.py

包名

包名使用小写字母，但不建议使用「_」来分割，比如：

package，mypackage

常量

常量名称使用全大写字母，使用「_」来分割，比如：

MAXNUM，MYCONSTANT，CONSTANT

关于注释

在 Python 代码中写注释有几种，比如在代码块注释，在行内注释，写文档的注释。

几个写注释的好习惯：

代码注释使用 # 开头，并在后面空一格才开始写

每一行不要超过 72 个字符，适当使用 # 分行

注释要和代码对齐

每一段应该空一行出来

行内注释

注意空格：

代码块多行注释

注意对齐：

注意换行：

文档字符串

除了解释代码的行为，我们有时候还需要写代码的「功能使用文档」，有了文档别人才能更好的使用你写的功能，通常我们会在代码里面写 DocStrings。

写 DocStrings 的习惯方式是这样的：

Docstrings 应该是在「类」或「函数定义下」的第一行开始声明

Docstrings 应该是用 """ 开头， """ 结尾

Docstrings 第一行的描述尽量简短并且能让人一下子就知道说的是什么

第二行起需要空格

每一段描述之间需要有空格

和代码对齐

每一行不要超过 72 个字符

像这样：