Python代码重用之函数入门

函数是组织好的，可重复使用的，用来实现单一，或相关联功能的代码段。

在开发程序时，使用函数可以提高编写的效率以及代码的重用。

一、函数的基本使用

函数的使用就是定义和调用两个步骤。

函数的定义

定义函数的格式如下：

def 函数名():

    函数封装的代码
    ……

说明：
1、def 是英文 define 的缩写。

2、函数名称应该能够表达函数封装代码的功能，方便后续的调用。

3、函数名称的命名应该符合标识符的命名规则。

• 可以由字母、下划线和数字组成
• 不能以数字开头
• 不能与关键字重名

函数的调用

调用函数很简单的，通过 函数名() 即可完成对函数的调用。

实例：

# 定义函数
def say_hello():
    print("hello 1")
    print("hello 2")
    print("hello 3")
    
# 只有在调用函数时，之前定义的函数才会被执行
# 调用函数
say_hello()

定义好函数之后，只表示这个函数封装了一段代码而已，如果不主动调用函数，函数是不会主动执行的。

那么能否将函数调用放在函数定义的上方呢？

答案是不能的！因为在使用函数名调用函数之前，必须要保证 Python 已经知道函数的存在，否则控制台会提示报错信息:

NameError: name 'xxx' is not defined
名称错误：xxx 这个名字没有被定义

函数的文档注释

在开发中，如果希望给函数添加注释，应该在定义函数的下方，使用连续的三对引号。

在连续的三对引号之间编写对函数的说明文字。

因为函数体相对比较独立，函数定义的上方，应该和其他代码（包括注释）保留两个空行。

二、函数的参数

在函数名的后面的小括号内部填写参数，多个参数之间使用 ',' (逗号)分隔。

实例

def sum_2_num(num1, num2):
    result = num1 + num2
    print("%d + %d = %d" % (num1, num2, result))

sum_2_num(50, 20)

形参和实参

形参：定义函数时，小括号中的参数，是用来接收参数用的，在函数内部作为变量使用。

实参：调用函数时，小括号中的参数，是用来把数据传递到函数内部用的。

1、不可变和可变的参数

无论传递的参数是可变还是不可变的，只要针对参数使用赋值语句，只会在函数内部修改局部变量的引用，不会影响到外部变量的引用。

def demo(num, num_list):

    # 赋值语句
    num = 200
    num_list = [1, 2, 3]

    print(num)  # 200
    print(num_list)  # [1,2,3]

gl_num = 99
gl_list = [4, 5, 6]
demo(gl_num, gl_list)
print(gl_num)  # 99
print(gl_list)  # [4,5,6]

但是如果传递的参数是可变类型，并且在函数内部，使用方法修改了数据的内容，同样会影响到外部的数据。

def mutable(num_list):

    num_list.extend([1, 2, 3])
    print(num_list)  # [6, 7, 8, 1, 2, 3]

gl_list = [6, 7, 8]
mutable(gl_list)
print(gl_list)  # [6, 7, 8, 1, 2, 3]

在 python 中，列表变量调用 += 本质上是在执行列表变量的 extend 方法，不会修改变量的引用。

def demo(num, num_list):

    num += num
    # 函数执行结束后，外部数据同样会发生变化
    num_list += num_list

    print(num)  # 18
    print(num_list)  # [1, 2, 3, 1, 2, 3]

gl_num = 9
gl_list = [1, 2, 3]
demo(gl_num, gl_list)
print(gl_num)  # 9
print(gl_list)  # [1, 2, 3, 1, 2, 3]

2、缺省参数

定义函数时，可以给某个参数指定一个默认值，具有默认值的参数就叫做缺省参数。

调用函数时，如果没有传入缺省参数的值，则在函数内部使用定义函数时指定的参数默认值。

函数的缺省参数，将常见的值设置为参数的缺省值，从而简化函数的调用。

例如：对列表排序的方法

gl_num_list = [6, 3, 9]

# 默认就是升序排序，因为这种应用需求更多
gl_num_list.sort()
print(gl_num_list)

# 当需要降序排序时，才需要传递 reverse 参数
gl_num_list.sort(reverse=True)
print(gl_num_list)

指定函数的缺省参数

在参数后使用赋值语句，可以指定参数的缺省值。

def print_info(name, gender=True):

    gender_text = "男生"
    if not gender:
        gender_text = "女生"

    print("%s 是 %s" % (name, gender_text))

注意事项：

1、缺省参数，需要使用最常见的值作为默认值！

2、必须保证带有默认值的缺省参数在参数列表末尾。

3、在调用函数时，如果有多个缺省参数，需要指定参数名，这样解释器才能够知道参数的对应关系！

def print_info(name, title="", gender=True):
    """
    :param title: 职位
    :param name: 班上同学的姓名
    :param gender: True 男生 False 女生
    """
    
    gender_text = "男生"

    if not gender:
        gender_text = "女生"

    print("%s%s 是 %s" % (title, name, gender_text))

print_info("小明")
print_info("老王", title="班长")
print_info("小美", gender=False)
# 小明 是 男生
# 班长老王 是 男生
# 小美 是 女生

3、多值参数

有时可能需要一个函数能够处理的参数个数是不确定的，这个时候，就可以使用多值参数。

python 中有两种多值参数：

参数名前增加一个 * 可以接收元组，参数名前增加两个 * 可以接收字典。

一般在给多值参数命名时，习惯使用以下两个名字：

*args，存放元组参数，**kwargs 存放字典参数。

args 是 arguments 的缩写，有变量的含义。

kw 是 keyword 的缩写，kwargs 可以记忆成键值对参数。

def demo(num, *args, **kwargs):

    print(num)
    print(args)
    print(kwargs)

demo(1, 2, 3, 4, 5, name="小明", age=18, gender=True)
# 1
# (2, 3, 4, 5)
# {'name': '小明', 'age': 18, 'gender': True}

多值参数实例：计算任意多个数字的和。

def sum_numbers(*args):

    num = 0
    for n in args:
        num += n

    return num

print(sum_numbers(1, 2, 3))  # 6

三、函数的返回值

在程序开发中，有时候会希望 一个函数执行结束后，告诉调用者一个结果，以便调用者针对具体的结果做后续的处理。

返回值是函数完成工作后，最后给调用者的一个结果。

在函数中使用 return 关键字可以返回结果。

调用函数一方，可以使用变量来接收函数的返回结果。

注意：return表示返回，函数内部在 return 后面的代码都不会被执行。

实例：

def sum_2_num(num1, num2):
    """对两个数字的求和"""
    return num1 + num2
# 调用函数，并使用 result 变量接收计算结果
result = sum_2_num(10, 20)
print("计算结果是 %d" % result)

那么问题来了，一个函数执行后能否返回多个结果么？

在 Python 中，可以将一个元组使用赋值语句同时赋值给多个变量。

注意：变量的数量需要和元组中的元素数量保持一致。

实例：

def measure():
    """测量温度和湿度"""

    print("测量开始...")
    temp = 39
    wetness = 50
    print("测量结束...")

    # 如果函数返回的类型是元组，小括号可以省略
    # return (temp, wetness)
    return temp, wetness

# 如果函数返回的类型是元组，同时希望单独的处理元组中的元素
# 可以使用多个变量，一次接收函数的返回结果
gl_temp, gl_wetness = measure()

print(gl_temp)
print(gl_wetness)

四、局部变量和全局变量

局部变量是在函数内部定义的变量，只能在函数内部使用。

全局变量是在函数外部定义的变量（没有定义在某一个函数内），所有函数内部都可以使用这个变量。

在其他的开发语言中，大多不推荐使用全局变量——可变范围太大，导致程序不好维护！

但是 Python 使用全局变量的地方比较多，源码作了特定的处理，可以更方便地使用全局变量。

1、局部变量

函数执行结束后，函数内部的局部变量，会被系统回收。

不同的函数，可以定义相同的名字的局部变量，但是彼此之间不会产生影响。

在函数内部使用，临时保存函数内部需要使用的数据。

局部变量的生命周期

所谓生命周期就是变量从被创建到被系统回收的过程。

局部变量在函数执行时才会被创建，函数执行结束后局部变量被系统回收。

2、全局变量

函数执行时，需要处理变量时会：

首先查找函数内部是否存在指定名称的局部变量，如果有，直接使用，如果没有，查找函数外部是否存在指定名的全局变量，如果有，直接使用，如果还没有，程序报错！

# 定义一个全局变量
num = 10

def demo1():
    print(num)

demo1()
# 10

在函数内部，可以通过全局变量的引用获取对应的数据，但是，不允许直接修改全局变量的引用，即通过普通的赋值语句不能修改全局变量的值。

# 定义一个全局变量
num = 10

def demo1():
    # 在python中，是不允许直接修改全部变量的值
    # 如果使用赋值语句，会在函数内部，定义一个局部变量
    num = 99
    print(num)

def demo2():
    print(num)

demo1()  # 99
demo2()  # 10

那如何才能在函数内部修改全局变量的值呢？

如果在函数中需要修改全局变量，需要使用 global 进行声明。

# 定义一个全局变量
num = 10

def demo1():
    # 使用 global 声明变量可以修改全局变量的值
    global num
    num = 99
    print(num)

def demo2():
    print(num)

demo1()  # 99
demo2()  # 99

为了保证所有的函数都能够正确使用到全局变量，应该将全局变量定义在其他函数的上方。

---