什么样的函数是一个好函数？
“好”的Python函数和“差”的Python函数之间有什么差别呢？每个人都有自己的理解。基于我的理解，如果一个Python函数能够符合下面的大部分条件，我会认为它是一个“好”函数：
- 命名合理
- 单一功能
- 包括文档字符串
- 返回一个值
- 不超过50行
- 是幂等函数或纯函数
对许多人来说，这些要求可能显得过于苛刻了。
不过，我保证，如果你的函数遵循这些规则，你的代码会非常漂亮，会让其他的程序员都“馋哭”的。
下面，我将一一讨论这些规则，然后总结它们是如何创造“好”函数的。
命名
在这个问题上，我最喜欢的一句话是：
计算机科学中只有两件事很让人头疼：缓存失效和命名。
尽管这听起来很莫名其妙，但给一个事情命名太难了。下面是一个反面案例：
def get knn(from_df):
原文中这个代码没有放上去，量子位根据上下文信息进行了补充。
这个函数命名的第一个问题是它使用了缩写。
对于那些并不出名的缩略词来说，使用完整的英语单词会更好。缩写单词的唯一原因是为了节省打字时间，但是每个现代编辑器都有自动填充功能，所以你只需要键入一次全名就可以了。
缩写通常是特定领域的。在上面的代码中，KNN指的是“K-Nearest Neighbors”，df指的是“DataFrame”，这是一个数据结构。如果另一个不熟悉这些首字母缩写的程序员正在阅读代码，几乎很难看懂。
关于这个函数的名字还有另外两个小瑕疵：
- “get”这个词是无关紧要的。对于大多数命名比较好的函数来说，很明显有一些东西会从函数中返回，它的名字将反映这一点。
- from_df也不是必要的。如果没有明确的参数名称，函数的文档字符串或类型注释会描述参数的类型。
那么我们如何重命名这个函数呢？很简单：
def k_nearest_neighbors(dataframe):
即使是外行，这个函数要计算的内容也很清楚，参数的名称(dataframe)也清楚地表明了参数类型。
单一功能
单一功能原则不仅适用于类和模块，也同样适用于函数。
一个函数应该只有一个功能。也就是说，它应该只做一件事。
一个重要的原因是，如果每个函数只做一件事，只有这件事发生了变化，才需要改变这个函数。
此外，如果这个函数的单个功能不再需要了，直接把它删了就行了。
还是用例子来说明吧。下面这个函数，可以做不止一件“事情”:
defcalculate_andprint_stats(list_of_numbers):
sum = sum(list_of_numbers)
mean = statistics.mean(list_of_numbers)
median = statistics.median(list_of_numbers)
mode = statistics.mode(list_of_numbers)
print('-----------------Stats-----------------')
print('SUM: {}'.format(sum) print('MEAN: {}'.format(mean)
print('MEDIAN: {}'.format(median)
print('MODE: {}'.format(mode)
这个函数做了两件事：一是计算一组关于数字列表的统计数据，二是将它们打印到STDOUT。
如果需要计算新的或不同的统计数据，或者需要改变输出的格式，就需要对这个函数进行调整。
所以，这个函数最好写成两个独立的函数：一个用来执行并返回计算结果，另一个用来获取这些结果并打印出来。
这种处理方式，不仅能让测试函数更容易，并且还允许这两个部分有了迁移性，如果合适的话，还可能一起应用到不同的模块中。
在编程中，你会发现好多函数都可以做很多很多事情。同样，为了可读性和可测试性，这些函数应该被分解成更小的函数，每个函数只有一个功能。
文档字符串（Docstrings）
虽然每个人似乎都知道PEP - 8，它定义了Python的样式指南，但是很少有人知道PEP - 257，它是关于文档字符串的。我再这里不简单地重复PEP - 257的内容了，你可以在闲暇时读一下。其中的关键内容是：
- 每个函数都需要有一个文档字符串
- 使用适当的语法和标点符号；用完整的句子写
- 首先对函数的作用进行一句话的总结
- 使用说明性语言而不是描述性语言
在编写函数时，要养成写文档字符串的习惯，并在编写函数代码之前尝试写一下。
如果你不能写一个清晰的文档字符串来描述函数做什么，就说明你需要再考虑考虑为什么要写这个函数了。
返回值
函数可以被认为是一些独立的程序。它们以参数的形式接受一些输入，并返回一些结果。
参数有没有都可以，但从Python内部的角度来看，返回值是必须要有的。你不可能创建一个没有返回值的函数。如果函数没有返回值，Python会“强制”返回None。你可以测试一下这段代码：
❯ python3
Python 3.7.0 (default, Jul 23 2018, 20:22:55)
[Clang 9.1.0 (clang-902.0.39.2)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> defadd(a, b):
... print(a + b)
...
>>> b = add(1, 2)
3
>>> b
>>> b is None
True
你会发现 b 的返回值实际上是 None。即使你写的函数没有返回语句，它仍然会返回一些东西。而且，每个函数都应该返回一个有用的值，测试起来也会更方便。毕竟，你写的代码应该能够被测试。
试想一下，测试上面的add函会有多艰难。遵循这个概念，我们应该这样写代码：
with open('foo.txt', 'r') as input_file:
for line in input_file:
if line.strip().lower().endswith('cat'):
# ... do something useful with these lines
if line.strip().lower().endswith(‘cat’):这一行能够工作，是因为每个字符串方法( strip ( )、lower ( )、end swith ( ) )都返回一个字符串作为调用函数的结果。
当给定函数没有返回值时，有一些常见的原因：
“它所做的只是[一些与I / O相关的事情，比如将一个值保存到数据库中]。我不能返回任何有用的东西。”
我不同意。如果操作顺利完成，函数可以返回True。
“我们修改了其中一个参数，将其用作参考参数。”
这里有两点需要注意。首先，尽最大努力避免这种做法。用好了令人惊讶，用不好非常危险。
其次，即使这样做不可行，复制某个参数的成本太高，你也可以回到上一条建议。
“我需要返回多个值。单独返回一个值是没有意义的。”
可以使用元组返回多个值。
总是返回一个有用的值，调用者总是可以自由地忽略它们。
