Python函数与模块化编程实战：从基础到模块构建

Python函数与模块化编程实战：从基础到模块构建

利用Python函数可以有效降低重复性编码的工作量，提升开发效率。

你是否曾对函数、类、方法、库和模块等专业术语感到困惑？是否在处理变量作用域时遇到过挑战？

无论是自学者还是受过正规训练的程序员，代码模块化往往是一个难点。然而，类和库的设计初衷正是为了鼓励模块化编码。模块化意味着构建一套多功能的代码块集合，使其能在多个项目中重复使用，从而显著减少编码负担。

换言之，通过深入理解本文关于Python函数的讲解，你将掌握更高效的工作方式，进而实现事半功倍的效果。

函数的基础概念与模块化优势

函数

函数是迈向模块化编程的关键一步，因为它将重复的操作形式化。如果程序中某个任务需要反复执行，你可以将相关代码封装在一个函数中，并在需要时随时调用。这样，你只需编写一次代码，即可无限次复用。

构建自定义Python模块：目录结构与导入

以下是一个简单函数的示例：

#!/usr/bin/env python3
import time
def Timer():
  print("Time is " + str(time.time() ))

创建一个名为 mymodularity 的目录，并将上述函数代码保存为该目录下的 timestamp.py 文件。

除了该函数文件，还需要在 mymodularity 目录中创建一个名为 __init__.py 的文件。你可以通过文件管理器或 bash shell 执行以下命令完成此操作：

$ touch mymodularity/__init__.py

至此，你已经创建了自己的Python库（在Python中称为“模块”），名为 mymodularity。虽然它目前的功能仅限于导入 time 模块并打印时间戳，但这只是一个良好的开端。

要使用你的函数，只需像对待其他Python模块一样操作即可。以下是一个小型应用程序，它利用你的 mymodularity 包来测试Python sleep() 函数的准确性。请将此文件保存为 sleeptest.py，并务必注意将其保存在 mymodularity 文件夹之外。如果将其保存在该文件夹内，它将成为你包中的一个模块，这显然不是我们期望的结果。

#!/usr/bin/env python3
import time
from mymodularity import timestamp
print("Testing Python sleep()...")
# modularity
timestamp.Timer()
time.sleep(3)
timestamp.Timer()

在这个简单的脚本中，我们从 mymodularity 包中调用了 timestamp 模块两次。从包中导入模块时，标准语法是从包中导入所需的模块，然后使用“模块名 + 点 + 函数名”的形式进行调用（例如 timestamp.Timer()）。

由于我们调用了两次 Timer() 函数，如果你的 timestamp 模块比这个简单示例更复杂，那么你将节省大量的重复代码编写工作。

保存文件并运行程序：

$ python3 ./sleeptest.py
Testing Python sleep()...
Time is 1560711266.1526039
Time is 1560711269.1557732

根据测试结果，Python中的 sleep 函数具有极高的准确性：在三秒等待后，时间戳成功且正确地增加了3秒，微秒级别的差异极小。

Python库的结构看似复杂，实则并无神秘之处。Python被设计为：只要包含Python代码的目录附带一个 __init__.py 文件，该目录就会被视为一个包。Python会优先在当前目录中查找可用模块。这就是为什么语句 from mymodularity import timestamp 能够生效的原因：Python在当前目录中查找名为 mymodularity 的目录，然后定位 timestamp.py 文件。

你在本例中实现的功能，与以下非模块化版本的代码效果完全一致：

#!/usr/bin/env python3
import time
from mymodularity import timestamp
print("Testing Python sleep()...")
# no modularity
print("Time is " + str(time.time() ) )
time.sleep(3)
print("Time is " + str(time.time() ) )

对于这样一个简单的示例，确实没有必要采用模块化方式编写测试代码。但在开发自己的模块时，最佳实践是确保代码具有通用性，以便将其重用于其他项目。

函数参数传递与抽象化设计

通过在调用函数时传递信息，可以使代码更加通用。例如，假设你希望使用模块测试的不是系统自带的 sleep 函数，而是用户自定义实现的 sleep 函数。我们可以修改 timestamp 代码，使其接受一个名为 msg 的传入变量，该变量为字符串类型，用于控制每次调用 timestamp 时的显示内容：

#!/usr/bin/env python3

import time

更新代码

def Timer(msg):
print(str(msg) + str(time.time() ) )

现在函数比之前更具抽象性。它仍然会打印时间戳，但用户打印的具体内容 msg 尚未定义。这意味着你需要在调用函数时指定该参数。

Timer 函数接受的 msg 参数名称是任意的，你可以将其命名为 m、message 或 text，或者任何对你有意义的名称。重要的是，当调用 timestamp.Timer 函数时，它接收一个文本作为输入，并将接收到的内容赋值给 msg 变量，随后使用该变量完成任务。

以下是一个测试用户正确感知时间流逝能力的新程序：

#!/usr/bin/env python3
from mymodularity import timestamp
print("Press the RETURN key. Count to 3, and press RETURN again.")
input()
timestamp.Timer("Started timer at ")
print("Count to 3...")
input()
timestamp.Timer("You slept until ")

将你的新程序保存为 response.py，然后运行它：

$ python3 ./response.py
Press the RETURN key. Count to 3, and press RETURN again.
Started timer at 1560714482.3772075
Count to 3...
You slept until 1560714484.1628013

变量作用域：局部与全局变量的管理

函数和所需参数

新版本的 timestamp 模块现在强制要求一个 msg 参数。这一点至关重要，因为你的第一个应用程序将无法运行，因为它没有向 timestamp.Timer 函数传递字符串参数：

$ python3 ./sleeptest.py
Testing Python sleep()...
Traceback (most recent call last):
 File "./sleeptest.py", line 8, in <module>
  timestamp.Timer()
TypeError: Timer() missing 1 required positional argument: 'msg'

你能修复你的 sleeptest.py 应用程序，使其能够与更新后的模块正确协同工作吗？

变量和函数

从设计原理上讲，函数限制了变量的作用域。换句话说，如果在函数内部创建了一个变量，那么该变量仅在函数内部有效。如果你尝试在函数外部使用函数内部定义的变量，程序将会报错。

下面是对 response.py 应用程序的修改尝试，试图从 timestamp.Timer() 函数外部打印 msg 变量：

#!/usr/bin/env python3
from mymodularity import timestamp
print("Press the RETURN key. Count to 3, and press RETURN again.")
input()
timestamp.Timer("Started timer at ")
print("Count to 3...")
input()
timestamp.Timer("You slept for ")
print(msg)

试着运行它，查看报错信息：

$ python3 ./response.py
Press the RETURN key. Count to 3, and press RETURN again.
Started timer at 1560719527.7862902
Count to 3...
You slept for 1560719528.135406
Traceback (most recent call last):
 File "./response.py", line 15, in <module>
  print(msg)
NameError: name 'msg' is not defined

应用程序返回一个 NameError 消息，提示未定义 msg。这看起来令人困惑，因为你编写的代码确实定义了 msg，但你对代码的理解比Python更深入。调用函数的代码，无论函数是出现在同一个文件中还是打包为模块，都无法知晓函数内部的具体执行情况。一个函数独立执行其计算，并返回你期望的结果。在此过程中涉及的任何变量都是局部的：它们仅存在于函数内部，且仅在函数完成其使命的期间内存在。

利用Return语句返回数据与内联函数应用

Return 语句

如果你的应用程序需要获取函数中特定的包含信息，那么使用 return 语句让函数在运行后返回有意义的数据。

时间就是金钱，因此我们修改 timestamp 函数，使其适用于一个虚构的收费系统：

#!/usr/bin/env python3
import time
def Timer(msg):
  print(str(msg) + str(time.time() ) )
  charge = .02
  return charge

现在，timestamp 模块每次调用收费2美分，但更重要的是，它返回每次调用时所收取的金额。

以下是一个如何使用 return 语句的演示：

#!/usr/bin/env python3
from mymodularity import timestamp
print("Press RETURN for the time (costs 2 cents).")
print("Press Q RETURN to quit.")
total = 0
while True:
  kbd = input()
  if kbd.lower() == "q":
    print("You owe $" + str(total) )
    exit()
  else:
    charge = timestamp.Timer("Time is ")
    total = total+charge

在这个示例代码中，变量 charge 接收 timestamp.Timer() 函数的返回值，即函数返回的任何内容。在本例中，函数返回一个数字，因此我们使用一个名为 total 的新变量来跟踪累计的更改次数。当应用程序收到退出信号时，它会打印总花费：

$ python3 ./charge.py
Press RETURN for the time (costs 2 cents).
Press Q RETURN to quit.
Time is 1560722430.345412
Time is 1560722430.933996
Time is 1560722434.6027434
Time is 1560722438.612629
Time is 1560722439.3649364
q
You owe $0.1

内联函数

函数不必在单独的文件中创建。如果你只是针对一个任务编写一个简短的脚本，那么在同一个文件中编写函数可能更为合理。唯一的区别是你无需导入自己的模块，但函数的工作方式完全相同。以下是时间测试应用程序的最新迭代版本：

#!/usr/bin/env python3
import time
total = 0
def Timer(msg):
  print(str(msg) + str(time.time() ) )
  charge = .02
  return charge
print("Press RETURN for the time (costs 2 cents).")
print("Press Q RETURN to quit.")
while True:
  kbd = input()
  if kbd.lower() == "q":
    print("You owe $" + str(total) )
    exit()
  else:
    charge = Timer("Time is ")
    total = total+charge

该版本没有外部依赖（Python发行版中已包含 time 模块），并产生与模块化版本相同的结果。其优点在于所有代码都位于一个文件中，缺点则是你无法在其他脚本中使用 Timer() 函数，除非手动复制和粘贴它。

全局变量

在函数外部创建的变量不受作用域限制，因此被视为全局变量。

全局变量的一个例子是在 charge.py 中用于跟踪当前花费的 total 变量。total 是在函数外部创建的，因此它绑定到整个应用程序而非特定函数。

应用程序中的函数可以访问全局变量，但要将变量传入导入的模块，你必须像传递 msg 变量一样将变量传入模块。

全局变量非常方便，因为它们似乎随时随地都可用，但也难以追踪，很难判断哪些变量已不再需要却仍驻留在系统内存中（尽管Python拥有优秀的垃圾收集机制）。

然而，全局变量至关重要，因为并非所有变量都可以是函数或类的局部变量。现在你已经掌握了如何向函数传入变量并获得返回值，处理这些情况就变得容易多了。

总结

你已经学到了很多关于函数的知识，现在请开始将它们放入你的脚本中——如果它们不是作为单独的模块，那么作为代码块，你不必在一个脚本中编写多次相同的代码。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。