rss
当前位置 :首页 > 客户案例

干货 如何写一个更好的Python函数?

  “好”的Python函数和“差”的Python函数之间有什么差别呢?每个人都有自己的理解。基于我的理解,如果一个Python函数能够符合下面的大部分条件,我会认为它是一个“好”函数:

  不过,我保证,如果你的函数遵循这些规则,你的代码会非常漂亮,会让其他的程序员都“馋哭”的。

  对于那些并不出名的缩略词来说,使用完整的英语单词会更好。缩写单词的唯一原因是为了节省打字时间,但是每个现代编辑器都有自动填充功能,所以你只需要键入一次全名就可以了。

  缩写通常是特定领域的。在上面的代码中,KNN指的是“K-Nearest Neighbors”,df指的是“DataFrame”,这是一个数据结构。如果另一个不熟悉这些首字母缩写的程序员正在阅读代码,几乎很难看懂。

  即使是外行,这个函数要计算的内容也很清楚,参数的名称(dataframe)也清楚地表明了参数类型。

  一个重要的原因是,如果每个函数只做一件事,只有这件事发生了变化,才需要改变这个函数。

  这个函数做了两件事:一是计算一组关于数字列表的统计数据,二是将它们打印到STDOUT。

  如果需要计算新的或不同的统计数据,或者需要改变输出的格式,就需要对这个函数进行调整。

  所以,这个函数最好写成两个独立的函数:一个用来执行并返回计算结果,另一个用来获取这些结果并打印出来。

  这种处理方式,不仅能让测试函数更容易,并且还允许这两个部分有了迁移性,如果合适的话,还可能一起应用到不同的模块中。

  在编程中,你会发现好多函数都可以做很多很多事情。同样,为了可读性和可测试性,这些函数应该被分解成更小的函数,每个函数只有一个功能。

  虽然每个人似乎都知道PEP - 8,它定义了Python的样式指南,但是很少有人知道PEP - 257,它是关于文档字符串的。我再这里不简单地重复PEP - 257的内容了,你可以在闲暇时读一下。其中的关键内容是:

  在编写函数时,要养成写文档字符串的习惯,并在编写函数代码之前尝试写一下。

  如果你不能写一个清晰的文档字符串来描述函数做什么,就说明你需要再考虑考虑为什么要写这个函数了。

  函数可以被认为是一些独立的程序。它们以参数的形式接受一些输入,并返回一些结果。

  参数有没有都可以,但从Python内部的角度来看,返回值是必须要有的。你不可能创建一个没有返回值的函数。如果函数没有返回值,Python会“强制”返回None。你可以测试一下这段代码:

  你会发现 b 的返回值实际上是 None。 即使你写的函数没有返回语句,它仍然会返回一些东西。而且,每个函数都应该返回一个有用的值,测试起来也会更方便。毕竟,你写的代码应该能够被测试。

  试想一下,测试上面的add函会有多艰难。遵循这个概念,我们应该这样写代码:

  “它所做的只是[一些与I / O相关的事情,比如将一个值保存到数据库中]。我不能返回任何有用的东西。”

  这里有两点需要注意。首先,尽最大努力避免这种做法。用好了令人惊讶,用不好非常危险。

  其次,即使这样做不可行,复制某个参数的成本太高,你也可以回到上一条建议。

  函数的长度直接影响可读性,从而影响可维护性。所以要保持你的函数简短。50行是一个随意的数字,在我看来是合理的。你编写的大多数函数应该要短一些。

  如果一个函数遵循单一功能原则,它很可能是相当短的。 如果它是纯函数或是幂等的(下面讨论) ,它也可能是短的。

  那么,如果函数太长,应该怎么做?重构。这会改变程序的结构而不改变其行为。

  从一个长函数中提取几行代码,并把它们变成自己的函数。这是缩短长函数的最快、也是最常见的方式。

  结果不依赖于非局部变量、参数的可变性或来自任何I / O流的数据。下面的这个add_three(number)函数是幂等函数:

  不管一个人调用add_three(7)多少次,答案总是10。以下是一个非幂等函数:

  这个函数的返回值取决于I / O,即用户输入的数字。对add_three()的每次调用都会返回不同的值。

  如果它被调用两次,用户可以第一次输入3,第二次输入7,分别调用add_three()返回6和10。

  幂等性的一个现实中例子是在电梯前点击“向上”按钮。第一次按时,电梯会被“通知”你要上去。因为按按钮是幂等的,所以反复按它都没有什么影响。结果是一样的。

  可维护性和可维护性。幂等函数很容易测试,因为在使用相同的参数时,它们总是返回相同的结果。

  测试仅仅是检查通过不同调用返回值的预期值。更重要的是,这些测试很快,这是单元测试中一个重要且经常被忽视的问题。

  而在处理幂等函数时,重构是轻而易举的事情。 无论如何在函数之外更改代码,使用相同的参数调用它的结果总是一样的。

  在函数编程中,如果一个函数既幂等又没有可观察到的副作用,它就被认为是纯函数。函数外部的任何东西都不会影响这个值。

  然而,这并不意味着函数不能影响非局部变量或I / O流之类的事情。例如,如果上面add_three(number)的幂等版本在返回结果之前打印了结果,那么它仍然被认为是幂等的,因为当它访问I / O流时,这个访问与从函数返回的值无关。

  调用print ( )只是一个副作用:除了返回值之外,还与程序的其他部分或系统本身进行了一些交互。

  让我们把我们的add_three(number)示例再向前推进一步。我们可以编写下面的代码片段来确定调用add_three(number)的次数:

  我们现在正在打印到控制台(一个副作用)并修改一个非局部变量(另一个副作用),但是由于这两者都不影响函数返回的值,它仍然是幂等的。

  纯函数没有副作用。它不仅不使用任何“外部数据”来计算值,除了计算和返回所述值之外,它与系统/程序的其余部分都没有交互。因此,虽然我们新的add_three(number)定义仍然是幂等的,但它不再是纯的。

  纯函数没有日志语句或print ( )调用。它们不使用数据库或互联网连接。它们不访问或修改非局部变量。它们不调用任何其他非纯函数。

  简而言之,它们无法做到爱因斯坦所说的“远距离幽灵般的行动”(在计算机科学环境中)。它们不会以任何方式修改程序或系统的其余部分。

  在命令式编程(编写Python代码时所做的那种)中,它们是所有函数中最安全的函数。

  它们也很容易被测试和维护,甚至比只是幂等函数更重要的是,测试它们基本上可以和执行它们一样快。

  测试本身很简单:没有数据库连接或其他外部资源进行模拟,也不需要安装代码,之后也没有什么需要清理的。

  明确地说,幂等性和纯函数只是一种期望,不是必需的。也就是说,由于好处很多,我们可能会希望只编写纯函数或幂等函数,但这不现实。

  重要的是,我们要有意识开始写代码来隔离副作用和外部依赖性。这会使得我们编写的每一行代码都更容易被测试。

上一篇: 网信办:搜索引擎提供付费搜索服务应查验客户资质     下一篇: 小语种APP推广案例:nemo 德语ASO优化分析