8.6 将函数存储在模块中

函数的优点之一是,使用它们可将代码块与主程序分离。通过给函数指定描述性名称,可让主程序容易理解得多。你还可以更进一步,将函数存储在被称为模块 的独立文件中,再将模块导入 到主程序中。import 语句允许在当前运行的程序文件中使用模块中的代码。

通过将函数存储在独立的文件中,可隐藏程序代码的细节,将重点放在程序的高层逻辑上。这还能让你在众多不同的程序中重用函数。将函数存储在独立文件中后,可与其他程序员共享这些文件而不是整个程序。知道如何导入函数还能让你使用其他程序员编写的函数库。

导入模块的方法有多种,下面对每种都作简要的介绍。

8.6.1 导入整个模块

要让函数是可导入的,得先创建模块。模块 是扩展名为.py的文件,包含要导入到程序中的代码。下面来创建一个包含函数make_pizza() 的模块。为此,我们将文件pizza.py中除函数make_pizza() 之外的其他代码都删除:

pizza.py

  1. def make_pizza(size, *toppings):
  2. """概述要制作的比萨"""
  3. print("\nMaking a " + str(size) +
  4. "-inch pizza with the following toppings:")
  5. for topping in toppings:
  6. print("- " + topping)
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  

接下来,我们在pizza.py所在的目录中创建另一个名为making_pizzas.py的文件,这个文件导入刚创建的模块,再调用make_pizza() 两次:

making_pizzas.py

  1. import pizza
  2. pizza.make_pizza(16, 'pepperoni')
  3. pizza.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  

Python读取这个文件时,代码行import pizza 让Python打开文件pizza.py,并将其中的所有函数都复制到这个程序中。你看不到复制的代码,因为这个程序运行时,Python在幕后复制这些代码。你只需知道,在making_pizzas.py中,可以使用pizza.py中定义的所有函数。

要调用被导入的模块中的函数,可指定导入的模块的名称pizza 和函数名make_pizza() ,并用句点分隔它们(见❶)。这些代码的输出与没有导入模块的原始程序相同:

  1. Making a 16-inch pizza with the following toppings:
  2. - pepperoni
  3. Making a 12-inch pizza with the following toppings:
  4. - mushrooms
  5. - green peppers
  6. - extra cheese
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  

这就是一种导入方法:只需编写一条import 语句并在其中指定模块名,就可在程序中使用该模块中的所有函数。如果你使用这种import 语句导入了名为module_name.py 的整个模块,就可使用下面的语法来使用其中任何一个函数:

  1. module_name.function_name()
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  

8.6.2 导入特定的函数

你还可以导入模块中的特定函数,这种导入方法的语法如下:

  1. from module_name import function_name
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  

通过用逗号分隔函数名,可根据需要从模块中导入任意数量的函数:

  1. from module_name import function_0, function_1, function_2
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  

对于前面的making_pizzas.py示例,如果只想导入要使用的函数,代码将类似于下面这样:

  1. from pizza import make_pizza
  2. make_pizza(16, 'pepperoni')
  3. make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  

若使用这种语法,调用函数时就无需使用句点。由于我们在import 语句中显式地导入了函数make_pizza() ,因此调用它时只需指定其名称。

8.6.3 使用as 给函数指定别名

如果要导入的函数的名称可能与程序中现有的名称冲突,或者函数的名称太长,可指定简短而独一无二的别名 ——函数的另一个名称,类似于外号。要给函数指定这种特殊外号,需要在导入它时这样做。

下面给函数make_pizza() 指定了别名mp() 。这是在import 语句中使用make_pizza as mp 实现的,关键字as 将函数重命名为你提供的别名:

  1. from pizza import make_pizza as mp
  2. mp(16, 'pepperoni')
  3. mp(12, 'mushrooms', 'green peppers', 'extra cheese')
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  

上面的import 语句将函数make_pizza() 重命名为mp() ;在这个程序中,每当需要调用make_pizza() 时,都可简写成mp() ,而Python将运行make_pizza() 中的代码,这可避免与这个程序可能包含的函数make_pizza() 混淆。

指定别名的通用语法如下:

  1. from module_name import function_name as fn
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  

8.6.4 使用as 给模块指定别名

你还可以给模块指定别名。通过给模块指定简短的别名(如给模块pizza 指定别名p ),让你能够更轻松地调用模块中的函数。相比于pizza.make_pizza()p.make_pizza() 更为简洁:

  1. import pizza as p
  2. p.make_pizza(16, 'pepperoni')
  3. p.make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  

上述import 语句给模块pizza 指定了别名p ,但该模块中所有函数的名称都没变。调用函数make_pizza() 时,可编写代码p.make_pizza() 而不是pizza.make_pizza() ,这样不仅能使代码更简洁,还可以让你不再关注模块名,而专注于描述性的函数名。这些函数名明确地指出了函数的功能,对理解代码而言,它们比模块名更重要。

给模块指定别名的通用语法如下:

  1. import module_name as mn
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  

8.6.5 导入模块中的所有函数

使用星号(* )运算符可让Python导入模块中的所有函数:

  1. from pizza import *
  2. make_pizza(16, 'pepperoni')
  3. make_pizza(12, 'mushrooms', 'green peppers', 'extra cheese')
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  

import 语句中的星号让Python将模块pizza 中的每个函数都复制到这个程序文件中。由于导入了每个函数,可通过名称来调用每个函数,而无需使用句点表示法。然而,使用并非自己编写的大型模块时,最好不要采用这种导入方法:如果模块中有函数的名称与你的项目中使用的名称相同,可能导致意想不到的结果:Python可能遇到多个名称相同的函数或变量,进而覆盖函数,而不是分别导入所有的函数。

最佳的做法是,要么只导入你需要使用的函数,要么导入整个模块并使用句点表示法。这能让代码更清晰,更容易阅读和理解。这里之所以介绍这种导入方法,只是想让你在阅读别人编写的代码时,如果遇到类似于下面的import 语句,能够理解它们:

  1. from module_name import *
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.