什么样的函数才叫复合函数,什么叫做函数

python视频教程栏目介绍Pythonic。

　　在机器学习中，我们经常需要使用类和函数来定义模型的各个部分，例如用于读取数据、预处理数据、模型架构和训练过程的函数。那么什么样的函数才是一个漂亮又赏心悦目的代码呢？在本教程中，我们将从命名到代码量这六个方面来讨论如何开发精彩的函数。文末有给大家录的视频教程，大家可以按需学习，不清楚的地方也可以留言！

　　像大多数现代编程语言一样，在Python中，函数是抽象和封装的基本方法之一。在开发阶段，您可能已经编写了数百个函数，但并不是所有的函数都是一样的。写“坏”的函数会直接影响代码的可读性和可维护性。那么，什么样的函数是“坏”函数呢？更重要的是，如何写出一个* *的“好”* *函数？

　　简单回顾

　　数学充满了函数，尽管我们可能不记得它们。先回忆一下大家最喜欢的话题，——微积分。你可能还记得这个等式：f(x)=2x 3。这是一个名为“f”的函数，它包含一个未知数x，并“返回”2*x 3。这个函数可能和我们在Python中看到的不一样，但是它的基本思想和计算机语言中的函数是一样的。

　　它在函数数学中有很长的历史，但在计算机科学中更强大。尽管如此，该功能仍然存在一些缺陷。接下来，我们将讨论什么是“好”的函数，以及我们需要重构什么样的症状。

　　决定函数好坏的关键

　　好的Python函数和不好的Python函数有什么区别？令人惊讶的是，“好”功能有这么多的定义。出于我们的目的，我将把一个好的Python函数定义为符合下面列表中大多数规则的函数(有些很难实现):

　　合理命名具有单一功能，包括文档注释，返回不超过50个幂等行的值代码。这是一个尽可能纯粹的函数。对于很多人来说，这个列表可能有点太严格了。但是我保证，如果你的函数符合这些规则，你的代码看起来会非常漂亮。我会一步步解释每一个规则，然后总结这些规则是如何形成一个“好”的功能的。

　　命名

　　关于这个问题，我最喜欢的一句话(来自菲尔卡尔顿，总是被误认为唐纳德克努特)是：

　　计算机科学只有两个问题：缓存失效和命名。

　　听起来很奇怪，但是整个好的命名真的很难。这里有一个不好的函数命名：

　　DEF _ KNN (from _ DF) :复制代码我基本上到处都见过不好的命名，但是这个例子来自数据科学(或者机器学习)。实践者总是在Jupyter笔记本上写代码，然后试图把那些不同的单元变成一个可以理解的程序。

　　命名这个函数的第一个问题是首字母缩略词的使用。比起不流行的缩写和首字母缩写，完整的英文单词会更好。使用缩写的唯一原因是为了节省打字时间，但所有现代编辑器都有自动补全功能，所以你只需要输入一次全名。缩写是一个问题，因为它们只能用于特定的领域。在上面的代码中，knn指的是“K-最近邻”，df指的是“data frame”——这种无处不在的Pandas数据结构。如果是另一个不熟悉这些缩写的程序员在看代码，TA会很困惑。

　　这个函数名还有另外两个小问题：单词“get”是不相关的。对于大多数命名良好的函数来说，很明显，函数将返回一些东西，它的名字将反映这一点。From_df也没必要。如果参数的名称描述不够清楚，函数的文档注释或类型注释将描述参数类型。

　　那么我们如何重命名这个函数呢？例如：

　　def _ nearest _ neighbors(data frame):现在复制代码，连外行都知道这个函数在计算什么。参数的名称(dataframe)也清楚地告诉我们应该传递什么类型的参数。

　　单一功能原则

　　“单一功能原则”来自鲍伯马丁叔叔的一本书，它不仅适用于类和模块，也适用于功能(马丁的最初目标)。这个原则强调函数应该具有“单一功能”。也就是说，一个函数应该只做一件事。一个很大的原因是，如果每个功能只做一件事，那么只有当它做那件事的方式必须改变时，才需要改变这个功能。当一个功能可以删除的时候，事情就好办了：如果其他地方发生了变化，不再需要该功能的单一功能，那么删除就好了。

　　举个例子来说明。下面是一个做不止一件“事情”的函数：

　　定义计算

　　ulate_and print_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。该函数违反了只有一个原因能让函数改变的原则。显然有两个原因可以让该函数做出改变：新的或不同的数据需要计算或输出的格式需要改变。最好将该函数写成两个独立的函数：一个用来执行并返回计算结果；另一个用来接收结果并将其打印出来。函数有多重功能的一个致命漏洞是函数名称中含有单词「and」

　　这种分离还可以简化针对函数行为的测试，而且它们不仅被分离成一个模块中的两个函数，还可能在适当情况下存在于不同的模块中。这使得测试更加清洁、维护更加简单。

　　只做两件事的函数其实非常罕见。更常见的情况是一个函数负责许多许多任务。再次强调一下，为可读性、可测试性起见，我们应该将这些「多面手」函数分成一个一个的小函数，每个小函数只负责一项任务。

　　文档注释

　　很多 Python 开发者都知道 PEP-8，它定义了 Python 编程的风格指南，但很少有人了解定义了文档注释风格的 PEP-257。在这里并不会详细介绍 PEP-257，读者可详细阅读该指南所约定的文档注释风格。

• PEP-8：https://www.python.org/dev/peps/pep-0008/
• PEP-257：https://www.python.org/dev/peps/pep-0257/

• 每一个函数都需要一个文档描述；
• 使用合适的语法和标点，书写完整的句子；
• 最开始需要用一句话总结函数的主要作用；
• 使用规定性的语言而不是描述性的语言。

　　返回值

　　函数可以且应该被视为一个独立的小程序。它们以参数的形式获取一些输入，并返回一些输出值。当然，参数是可选的，但是从 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.
　　>>> def add(a, b):
　　... print(a + b)
　　...
　　>>> b = add(1, 2)
　　3
　　>>> b
　　>>> b is None
　　True复制代码

　　我甚至希望发表以下声明：每一个函数都应该返回一个有用的值，即使这个值仅可用来测试。我们写的代码应该需要得到测试，而不带返回值的函数很难测试它的正确性，上面的函数可能需要重定向 I/O 才能得到测试。此外，返回值能改变方法的调用，如下代码展示了这种概念：

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复制代码

　　以下是人们在被问及为什么他们写的函数没有返回值时给出的一些常见原因：

「函数所做的就是类似 I/O 的操作，例如将一个值保存到数据库中，这种函数不能返回有用的输出。」

　　

「我需要返回多个值，因为只返回一个值并不能代表什么。」

　　

　　函数长度

　　函数的长度直接影响了可读性，因而会影响可维护性。因此要保证你的函数长度足够短。50 行的函数对我而言是个合理的长度。

　　如果函数遵循单一功能原则，一般而言其长度会非常短。如果函数是纯函数或幂等函数（下面会讨论），它的长度也会较短。这些想法对于构造简洁的代码很有帮助。

　　那么如果一个函数太长该怎么办？代码重构（refactor）！代码重构很可能是你写代码时一直在做的事情，即使你对这个术语并不熟悉。它的含义是：在不改变程序行为的前提下改变程序的结构。因此从一个长函数提取几行代码并转换为属于该函数的函数也是一种代码重构。这也是将长函数缩短最快和最常用的方法。只要适当给这些新函数命名，代码的阅读将变得更加容易。

　　幂等性和函数纯度

　　幂等函数（idempotent function）在给定相同变量参数集时会返回相同的值，无论它被调用多少次。函数的结果不依赖于非局部变量、参数的易变性或来自任何 I/O 流的数据。以下的 add_three(number) 函数是幂等的：

def add_three(number):
　　 """Return *number* + 3."""
　　 return number + 3复制代码

def add_three():
　　 """Return 3 + the number entered by the user."""
　　 number = int(input('Enter a number: '))
　　 return number + 3复制代码

　　为什么幂等很重要？

　　可测试性和可维护性。幂等函数易于测试，因为它们在使用相同参数的情况下会返回同样的结果。测试就是检查对函数的不同调用所返回的值是否符合预期。此外，对幂等函数的测试很快，这在单元测试（Unit Testing）中非常重要，但经常被忽视。重构幂等函数也很简单。不管你如何改变函数以外的代码，使用同样的参数调用函数所返回的值都是一样的。

　　什么是「纯」函数？

　　在函数编程中，如果函数是幂等函数且没有明显的副作用（side effect），则它就是纯函数。记住，幂等函数表示在给定参数集的情况下该函数总是返回相同的结果，不能使用任何外部因素来计算结果。但是，这并不意味着幂等函数无法影响非局部变量（non-local variable）或 I/O stream 等。例如，如果上文中 add_three(number) 的幂等版本在返回结果之前先输出了结果，它仍然是幂等的，因为它访问了 I/O stream，这不会影响函数的返回值。调用 print() 是副作用：除返回值以外，与程序或系统中其余部分的交互。

　　我们来扩展一下 add_three(number) 这个例子。我们可以用以下代码片段来查看 add_three(number) 函数被调用的次数：

add_three_calls = 0
　　def add_three(number):
　　 """Return *number* + 3."""
　　 global add_three_calls
　　 print(f'Returning {number + 3}')
　　 add_three_calls += 1
　　 return number + 3
　　def num_calls():
　　 """Return the number of times *add_three* was called."""
　　 return add_three_calls复制代码

　　纯函数没有副作用。它不仅不使用任何「外来数据」来计算值，也不与系统／程序的其它部分进行交互，除了计算和返回值。因此，尽管我们新定义的 add_three(number) 仍是幂等函数，但它不再是纯函数。

　　纯函数不记录语句或 print() 调用，不使用数据库或互联网连接，不访问或修改非局部变量。它们不调用任何其它的非纯函数。

　　总之，纯函数无法（在计算机科学背景中）做到爱因斯坦所说的「幽灵般的远距效应」（spooky action at a distance）。它们不以任何形式修改程序或系统的其余部分。在命令式编程中（写 Python 代码就是命令式编程），它们是最安全的函数。它们非常好测试和维护，甚至在这方面优于纯粹的幂等函数。测试纯函数的速度与执行速度几乎一样快。而且测试很简单：没有数据库连接或其它外部资源，不要求设置代码，测试结束后也不需要清理什么。

　　显然，幂等和纯函数是锦上添花，但并非必需。即，由于上述优点，我们喜欢写纯函数或幂等函数，但并不是所有时候都可以写出它们。关键在于，我们本能地在开始部署代码的时候就想着剔除副作用和外部依赖。这使得我们所写的每一行代码都更容易测试，即使并没有写纯函数或幂等函数。

　　总结

　　写出好的函数的奥秘不再是秘密。只需按照一些完备的最佳实践和经验法则。希望本期教程能够帮助到大家。

相关免费学习推荐：python视频教程

　　

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。