函数模块
函数的优点之一是,使用它们可将代码块与主程序分离。为了更进一步的发挥函数的优势,可以把某些通用的函数封装在被称为模块的独立文件中,再将模块导入到主程序中。import语句允许在当前运行的程序文件中使用模块中的代码。
通过将函数封装到独立的文件中,可以隐藏程序代码的细节,将重点放在程序的高层逻辑上。还可以让你在众多不同的程序中重用函数。将函数存储在独立文件中后,可与其他程序员共享这些文件而不是整个程序。自己也可以导入其他程序员编写的函数库。
导入模块的方法有多种,下面就对每种都做一下简要介绍:
1.导入整个模块
要让模块是可导入的,得先创建模块。模块的扩展名为.py的文件,包含要导入的程序中的代码。下面举个例子瞅瞅,创建一个包含函数make_jianbing()的模块。
jianbing.py
def make_jianbing(count,*toppings):
print("\nMaking a " + str(count) + "-ge jianbing with the following toppings: ")
for topping in toppings:
print("- " + topping)
make_jianbing.py
import jianbing
jianbing.make_jianbing(2,'regou')
jianbing.make_jianbing(5,'eggs','regou','weilong')
运行结果:
Making a 2-ge jianbing with the following toppings:
- regou
Making a 5-ge jianbing with the following toppings:
- eggs
- regou
- weilong
python读取这个文件时,代码行import jianbing让python打开jianbing.py,并将其中的所有函数都复制到这个程序中。我们是看不到复制的代码,因为这个程序运行时,python在幕后复制这些代码。只需知道在make_jianbing.py中,可以使用jianbing.py中定义的所有函数。
要调用被导入的模块中的函数,可指定导入的模块的名称jianbing和函数名make_jianbing(),并用句点分隔它们。
这就是导入一种方法:只需编写一条import语句并在其中指定模块名,就可以在程序中使用该模块中的所有函数。如果使用这种import语句导入了名为module_name.py的整个模块,就可使用下面的语法来使用其中任何一个函数:
module_name.function_name()
2.导入特定的函数
如果指向使用模块中某个函数,还可以导入模块中的特定函数,导入方法的语法如下:
from module_name import function_name
通过用逗号分隔函数名,可根据需要从模块中导入任意数量的函数:
from module_name import function_0, function_1,function_2
对于前面的make_jianbing.py示例,如果只想导入要使用的函数,代码将类似于下面这样:
from jianbing import make_jianbing
make_jianbing(2,'regou')
make_jianbing(5,'eggs','regou','weilong')
Making a 2-ge jianbing with the following toppings:
- regou
Making a 5-ge jianbing with the following toppings:
- eggs
- regou
- weilong
若使用这种语法,调用函数时就需使用句点。由于我们在import语句中显示地导入了函数make_jianbing(),因此调用它时只需指定其名称。
3.使用as给函数指定别名
如果要导入的函数的名称可能于与程序中现有的名称冲突,或者函数的名称太长,可指定简短而独一无二的别名-----函数的另一个名称,类似于外号。要给函数指定这种特殊的外号需要在导入它时做。
还是举个实际的例子看看吧,就拿制作煎饼吧,把函数make_jianbing()指定别名为mj()。这是在import语句中使用jianbing as mj实现的,关键字as将函数重命名为定义的别名
jianbing.py
def make_jianbing(count,*toppings):
print("\nMaking a " + str(count) + "-ge jianbing with the following toppings: ")
for topping in toppings:
print("- " + topping)
make_jianbing.py
from jianbing import make_jianbing as mj
mj(2,'regou')
mj(5,'eggs','regou','weilong')
Making a 2-ge jianbing with the following toppings:
- regou
Making a 5-ge jianbing with the following toppings:
- eggs
- regou
- weilong
每当需要调用make_jianbing()时,都可简写成mj(),而python将运行make_jianbing()中的代码,这可避免与当前使用程序中可能包含函数make_jianbing()混肴。
指定别名的语法是:
from module_name import function_name as fn
4.使用as给模块指定别名
既然可以给函数指定别名了,那是不是也可以给模块指定别名呢?嗯,这个想法很好,说明会举一反三了,当然了,我们也可以使用as给模块指定别名。
通过给模块指定简短的别名(如给模块jianbing指定别名为J),这样可以更加轻松的调用模块中的函数。
jianbing.py
def make_jianbing(count,*toppings):
print("\nMaking a " + str(count) + "-ge jianbing with the following toppings: ")
for topping in toppings:
print("- " + topping)
make_jianbing.py
import jianbing as J
J.make_jianbing(2,'regou')
J.make_jianbing(5,'eggs','regou','weilong')
Making a 2-ge jianbing with the following toppings:
- regou
Making a 5-ge jianbing with the following toppings:
- eggs
- regou
- weilong
给模块指定别名的通用语法如下:
import module_name as mn
5.导入模块中的所有函数
使用星号(*)运算符可让python导入模块中的所有函数:
jianbing.py
def make_jianbing(count,*toppings):
print("\nMaking a " + str(count) + "-ge jianbing with the following toppings: ")
for topping in toppings:
print("- " + topping)
make_jianbing.py
from jianbing import *
make_jianbing(2,'regou')
make_jianbing(5,'eggs','regou','weilong')
Making a 2-ge jianbing with the following toppings:
- regou
Making a 5-ge jianbing with the following toppings:
- eggs
- regou
- weilong
import语句中的星号让python将模块jianbing中的每个函数都复制到这个程序文件中。由于导入了每个函数,可能通过名称来调用每个函数,而无需使用句点表示法。然而,使用并非自己编写的大型模块时,最好不要采用这种导入方法:如果模块中有函数的名称与你的项目中使用的名称相同,可能导致意想不到的结果:python可能遇到多个名称相同的函数或变量,进而覆盖函数而不是分别导入所有的函数。
最佳的做法是,要么只导入许需要使用的函数,要么导入真个模块并使用句点表示法。
当然了,虽然这种导入方法不是很好,但需要了解这种导入方法,因为有可能在阅读别人代码时会遇到:
语法是:
from module_name import *
7.函数编写指南
函数在编写时,需要注意几个细节。应给函数指定描述性名称,且只在其中使用小写字母和下划线。描述性名称可帮助你和别人明白代码想要做什么。
每个函数都应包含简要地阐述其功能的注释,该注释应紧跟在函数定义后面,并采用文档字符串格式。文档良好的函数让其他程序员只需阅读文档字符串中的描述就能够使用它:他们完全可以相信代码如描述的那样运行;只要知道函数的名称、需要的实参以及返回值的类型,就能在自己的程序中使用它。
给形参指定默认值时,等号两边不要有空格:
def function_name(parameter_0, parameter_1='default value')
对函数调用中的关键字实参,也应遵循这种约定:
functon_name(value_0,parameter_1='value')
PE8(http://www.python.org/dev/peps/pep-0008/)建议代码行的长度不要超过79字符,这样编辑器窗口适中,就能看到整行代码。如果形参很多,导致函数定义的长度超过了79字符,可在函数定义中输入左括号后按回车键,并在下一行按两次Tab键,从而将形参列表和只缩进一层的函数体区分开来。
大多数编辑器都会自动对齐后续参数列表行,使其缩进成程度与你给第一个参数列表行指定的缩进程度相同:
def function(
parameter_0,parameter_1,parameter_2,
parameter_3,parameter_4,parameter_5):
function_body...
如果程序或模块包含多个函数,可使用两个空行将相邻的函数分开,这样将更容易知道前一个函数在什么地方结束,下一个函数从什么地方开始。
所有import语句都应放在文件开头,唯一例外的情形是,在文件开头使用了注释来描述整个程序。