8.4 传递列表

你经常会发现,向函数传递列表很有用,这种列表包含的可能是名字、数字或更复杂的对象(如字典)。将列表传递给函数后,函数就能直接访问其内容。下面使用函数来提高处理列表的效率。

假设有一个用户列表,我们要问候其中的每位用户。下面的示例将一个名字列表传递给一个名为greet_users() 的函数,这个函数问候列表中的每个人:

greet_users.py

  1. def greet_users(names):
  2. """向列表中的每位用户都发出简单的问候"""
  3. for name in names:
  4. msg = "Hello, " + name.title() + "!"
  5. print(msg)
  6. usernames = ['hannah', 'ty', 'margot']
  7. greet_users(usernames)
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  

我们将greet_users() 定义成接受一个名字列表,并将其存储在形参names 中。这个函数遍历收到的列表,并对其中的每位用户都打印一条问候语。在❶处,我们定义了一个用户列表——usernames ,然后调用greet_users() ,并将这个列表传递给它:

  1. Hello, Hannah!
  2. Hello, Ty!
  3. Hello, Margot!
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  

输出完全符合预期,每位用户都看到了一条个性化的问候语。每当你要问候一组用户时,都可调用这个函数。

8.4.1 在函数中修改列表

将列表传递给函数后,函数就可对其进行修改。在函数中对这个列表所做的任何修改都是永久性的,这让你能够高效地处理大量的数据。

来看一家为用户提交的设计制作3D打印模型的公司。需要打印的设计存储在一个列表中,打印后移到另一个列表中。下面是在不使用函数的情况下模拟这个过程的代码:

printing_models.py

  1. # 首先创建一个列表,其中包含一些要打印的设计
  2. unprinted_designs = ['iphone case', 'robot pendant', 'dodecahedron']
  3. completed_models = []
  4. # 模拟打印每个设计,直到没有未打印的设计为止
  5. # 打印每个设计后,都将其移到列表completed_models中
  6. while unprinted_designs:
  7. current_design = unprinted_designs.pop()
  8. #模拟根据设计制作3D打印模型的过程
  9. print("Printing model: " + current_design)
  10. completed_models.append(current_design)
  11. # 显示打印好的所有模型
  12. print("\nThe following models have been printed:")
  13. for completed_model in completed_models:
  14. print(completed_model)
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  

这个程序首先创建一个需要打印的设计列表,还创建一个名为completed_models 的空列表,每个设计打印都将移到这个列表中。只要列表unprinted_designs 中还有设计,while 循环就模拟打印设计的过程:从该列表末尾删除一个设计,将其存储到变量current_design 中,并显示一条消息,指出正在打印当前的设计,再将该设计加入到列表completed_models 中。循环结束后,显示已打印的所有设计:

  1. Printing model: dodecahedron
  2. Printing model: robot pendant
  3. Printing model: iphone case
  4. The following models have been printed:
  5. dodecahedron
  6. robot pendant
  7. iphone case
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  

为重新组织这些代码,我们可编写两个函数,每个都做一件具体的工作。大部分代码都与原来相同,只是效率更高。第一个函数将负责处理打印设计的工作,而第二个将概述打印了哪些设计:

  1. def print_models(unprinted_designs, completed_models):
  2. """
  3. 模拟打印每个设计,直到没有未打印的设计为止
  4. 打印每个设计后,都将其移到列表completed_models中
  5. """
  6. while unprinted_designs:
  7. current_design = unprinted_designs.pop()
  8. # 模拟根据设计制作3D打印模型的过程
  9. print("Printing model: " + current_design)
  10. completed_models.append(current_design)
  11. def show_completed_models(completed_models):
  12. """显示打印好的所有模型"""
  13. print("\nThe following models have been printed:")
  14. for completed_model in completed_models:
  15. print(completed_model)
  16. unprinted_designs = ['iphone case', 'robot pendant', 'dodecahedron']
  17. completed_models = []
  18. print_models(unprinted_designs, completed_models)
  19. show_completed_models(completed_models)
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  

在❶处,我们定义了函数print_models() ,它包含两个形参:一个需要打印的设计列表和一个打印好的模型列表。给定这两个列表,这个函数模拟打印每个设计的过程:将设计逐个地从未打印的设计列表中取出,并加入到打印好的模型列表中。在❷处,我们定义了函数show_completed_models() ,它包含一个形参:打印好的模型列表。给定这个列表,函数show_completed_models() 显示打印出来的每个模型的名称。

这个程序的输出与未使用函数的版本相同,但组织更为有序。完成大部分工作的代码都移到了两个函数中,让主程序更容易理解。只要看看主程序,你就知道这个程序的功能容易看清得多:

  1. unprinted_designs = ['iphone case', 'robot pendant', 'dodecahedron']
  2. completed_models = []
  3. print_models(unprinted_designs, completed_models)
  4. show_completed_models(completed_models)
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  

我们创建了一个未打印的设计列表,还创建了一个空列表,用于存储打印好的模型。接下来,由于我们已经定义了两个函数,因此只需调用它们并传入正确的实参即可。我们调用print_models() 并向它传递两个列表;像预期的一样,print_models() 模拟打印设计的过程。接下来,我们调用show_completed_models() ,并将打印好的模型列表传递给它,让其能够指出打印了哪些模型。描述性的函数名让别人阅读这些代码时也能明白,虽然其中没有任何注释。

相比于没有使用函数的版本,这个程序更容易扩展和维护。如果以后需要打印其他设计,只需再次调用print_models() 即可。如果我们发现需要对打印代码进行修改,只需修改这些代码一次,就能影响所有调用该函数的地方;与必须分别修改程序的多个地方相比,这种修改的效率更高。

这个程序还演示了这样一种理念,即每个函数都应只负责一项具体的工作。第一个函数打印每个设计,而第二个显示打印好的模型;这优于使用一个函数来完成两项工作。编写函数时,如果你发现它执行的任务太多,请尝试将这些代码划分到两个函数中。别忘了,总是可以在一个函数中调用另一个函数,这有助于将复杂的任务划分成一系列的步骤。

8.4.2 禁止函数修改列表

有时候,需要禁止函数修改列表。例如,假设像前一个示例那样,你有一个未打印的设计列表,并编写了一个将这些设计移到打印好的模型列表中的函数。你可能会做出这样的决定:即便打印所有设计后,也要保留原来的未打印的设计列表,以供备案。但由于你将所有的设计都移出了unprinted_designs ,这个列表变成了空的,原来的列表没有了。为解决这个问题,可向函数传递列表的副本而不是原件;这样函数所做的任何修改都只影响副本,而丝毫不影响原件。

要将列表的副本传递给函数,可以像下面这样做:

  1. function_name(list_name[:])
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  

切片表示法[:] 创建列表的副本。在print_models.py中,如果不想清空未打印的设计列表,可像下面这样调用print_models()

  1. print_models(unprinted_designs[:], completed_models)
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  

这样函数print_models() 依然能够完成其工作,因为它获得了所有未打印的设计的名称,但它使用的是列表unprinted_designs 的副本,而不是列表unprinted_designs 本身。像以前一样,列表completed_models 也将包含打印好的模型的名称,但函数所做的修改不会影响到列表unprinted_designs

虽然向函数传递列表的副本可保留原始列表的内容,但除非有充分的理由需要传递副本,否则还是应该将原始列表传递给函数,因为让函数使用现成列表可避免花时间和内存创建副本,从而提高效率,在处理大型列表时尤其如此。

动手试一试

8-9 魔术师 :创建一个包含魔术师名字的列表,并将其传递给一个名为show_magicians() 的函数,这个函数打印列表中每个魔术师的名字。

8-10 了不起的魔术师 :在你为完成练习8-9而编写的程序中,编写一个名为make_great() 的函数,对魔术师列表进行修改,在每个魔术师的名字中都加入字样“the Great”。调用函数show_magicians() ,确认魔术师列表确实变了。

8-11 不变的魔术师 :修改你为完成练习8-10而编写的程序,在调用函数make_great() 时,向它传递魔术师列表的副本。由于不想修改原始列表,请返回修改后的列表,并将其存储到另一个列表中。分别使用这两个列表来调用show_magicians() ,确认一个列表包含的是原来的魔术师名字,而另一个列表包含的是添加了字样“the Great”的魔术师名字。