python怎么定义未知数_码如其人，同学你能写一手漂亮的Python函数吗

原标题：码如其人，同学你能写一手漂亮的Python函数吗

选自 hackernoon

作者：Jeff Knupp

在机器学习中，我们经常需要使用类和函数定义模型的各个部分，例如定义读取数据的函数、预处理数据的函数、模型架构和训练过程的函数等等。那么什么样的函数才是漂亮的、赏心悦目的代码呢？在本文中，Jeff Knupp 从命名到代码量等六方面探讨了如何养成美妙的函数。

与多数现代编程语言一样，在 Python 中，函数是抽象和封装的基本方法之一。你在开发阶段或许已经写过数百个函数，但并非每个函数都生而平等。写出「糟糕的」函数会直接影响代码的可读性和可维护性。那么，什么样的函数是「糟糕的」函数呢？更重要的是，要怎么写出「好的」函数呢？

简单回顾

数学中充满了函数，尽管我们可能记不住它们。首先来回忆一下大家最喜欢的话题——微积分。你可能记得这个方程式： f(x) = 2x + 3. 这是一个叫做「f」的函数，含有一个未知数 x，「返回」2*x+3。这个函数可能和我们在 Python 中看到的不一样，但它的基本思想和计算机语言中的函数是一样的。

函数在数学中历史悠久，但在计算机科学中更加神通广大。尽管如此，函数还是存在一些缺陷。接下来我们将讨论一下什么是「好的」函数，以及在出现什么样的征兆时我们需要重构函数。

决定函数好坏的关键

好的 Python 函数与蹩脚 Python 函数的区别是什么？「好」函数的定义之多让人惊讶。从我们的目的出发，我会把好的 Python 函数定义为符合以下清单中大部分规则的函数(有些比较难实现)：

命名合理

具有单一功能

包含文档注释

返回一个值

代码不超过 50 行

幂等，尽可能是纯函数

对很多人来说，这个列表可能有些过于严格。但我保证，如果你的函数符合这些规则，你的代码看起来会非常漂亮。下面我将分步讲解各个规则，然后总结这些规则如何构成一个「好」函数。

命名

关于这个问题，我最喜欢的一句话(出自 Phil Karlton，总被误以为是 Donald Knuth 说的)是：

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

听起来有点匪夷所思，但整个不错的命名真的很难。下面就有一个糟糕的函数命名：

defget_knn(from_df):

我基本上在任何地方都见过糟糕的命名，但这个例子来自数据科学(或者说，机器学习)，从业者总是在 Jupyter notebook 上写代码，然后尝试将那些不同的单元变成一个可理解的程序。

该函数命名的第一个问题是使用首字母缩写/缩略词。比起缩略词和并未普及的首字母缩写，完整的英语单词会更好。使用缩写的唯一原因是为了节省打字时间，但现代的编辑器都有自动补全功能，所以你只需键入一次全名。之所以说缩写是一个问题，是因为它们通常只能用于特定领域。在上面的代码中，knn 是指「K-Nearest Neighbors」，df 指的是「DataFrame」——无处不在的 Pandas 数据结构。如果另外一个不