Python - Theme 2 Function

0. 函数

函数就是最基本的一种代码抽象方式

1. 调用函数

1.1 Python内置函数-直接调用

>>> help(abs)  ##查看函数的作用；也可在python官网查询
Help on built-in function abs in module builtins:
abs(x, /)
    Return the absolute value of the argument.

>>> abs(100)
100
>>> abs(-100)
100

>>> abs(-100,1) ##参数个数有误
Traceback (most recent call last):
  File "<input>", line 1, in <module>
TypeError: abs() takes exactly one argument (2 given)

>>> abs('a')  ##参数类型有误
Traceback (most recent call last):
  File "<input>", line 1, in <module>
TypeError: bad operand type for abs(): 'str'

1.2. 数据类型转换

>>> int(12.34)
12
>>> float(12.34)
12.34
>>> str(12.34)
'12.34'
>>> bool(1)
True
>>> bool('')
False

1.3. 函数名

函数名是指向一个函数对象的引用，因此可以重新赋值，相当于起了一个 “别名”

>>> a = abs
>>> a(-1)
1

2. 定义函数

2.1. 普通函数定义

def my_abs(x):   ##定义函数
    if x >= 0:
        return x ##返回值
    else:
        return -x

2.2. 空函数

一般用来占位，什么也不执行

def nop():
    pass

2.3. 完善函数

添加参数检查

def my_abs(x):
    if not isinstance(x,(int,float)):
        raise TypeError('bad operand type')  ##自定义抛出异常
    if x >= 0:
        return x
    else:
        return -x

2.4. 提示

• 定义函数时需要确定函数名和参数的个数
• 如果有必要需要检查传入参数的类型
• 函数体内可以用return返回函数结果，如果不加默认返回None
• 函数看起来可以返回多个值，其实是一个tuple

3. 函数的参数

Python定义函数的灵活度非常大，除了必选参数外，还可以定义默认参数、可变参数和关键字参数，使得定义出来的接口不但能实现复杂的功能而且方便调用者调用。

3.1. 位置参数

## x**2 计算，x为一个位置参数，必须传入
def power(x):
    return x * x

## x**n计算，x,n 均为位置参数，必须传入
def power(x, n):
    s = 1
    while n > 0:
        n = n - 1
        s = s * x
    return s

3.2. 默认参数

默认参数会降低函数的调用难度

• 必选参数必须放在默认参数之前
• 当函数有多个参数时，将变化大的放在前面，变化小的放在后面，变化小的可以当做默认参数

## 学生注册函数
def enroll(name, gender, age=6, city='Beijing'):
    print('name:', name)
    print('gender:', gender)
    print('age:', age)
    print('city:', city)

enroll('Bob', 'M')  ##普通调用，均使用默认值
enroll('Bob', 'M', 7)  ##按顺序提供默认值
enroll('Adam', 'M', city='Tianjin')  ##不按顺序提供默认值，需要把参数名写上

默认参数必须指向 不变对象。为什么要设计str、None这样的不变对象呢？因为不变对象一旦创建，对象内部的数据就不能修改，这样就减少了由于修改数据导致的错误。此外，由于对象不变，多任务环境下同时读取对象不需要加锁，同时读一点问题都没有。我们在编写程序时，如果可以设计一个不变对象，那就尽量设计成不变对象。

## 可变对象(list)
def add_end(L=[]):
    L.append('END')
    return L

>>> add_end()
['END']
>>> add_end() ##list发生了改变
['END', 'END']


## 不变对象None
def add_end(L=None):
    if L is None:
        L = []
    L.append('END')
    return L

>>> add_end()
['END']
>>> add_end()
['END']

3.3. 可变参数

顾名思义就是传入参数个数是可变的。（其实这些参数会在函数调用前自动组成一个tuple）

## 计算a**2 + b**2 +...
def calc(*numbers):  ## 可变参数的表达方式
    sum = 0
    for n in numbers:
        sum = sum + n * n
    return sum

>>> calc(1, 2)
5


##如果已经有一个list或者tuple，Python允许你在list或tuple前面加一个*号，把list或tuple的元素变成可变参数传进去
>>> nums = [1, 2, 3]
>>> calc(*nums)
14

3.4. 关键字参数

可以传入一个或多个含参数名的参数。（其实这些参数会在调用的时候自动组成dict）

## 用户注册功能，除了用户名和年龄是必填项外，其他都是可选项
def person(name, age, **kw):
    print('name:', name, 'age:', age, 'other:', kw)

>>> person('Adam', 45, gender='M', job='Engineer')
name: Adam age: 45 other: {'gender': 'M', 'job': 'Engineer'}

## 如果已经有一个dict，Python允许你在dict前面加**号，传入到 kw 中，kw将获得dict的一份拷贝，并不影响原先的dict
>>> extra = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, **extra)
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}

3.5. 命名关键字参数

## 只接收city，job作为关键字的参数。需要有 * 分隔，* 后面的被视为命名关键字参数
def person(name, age, *, city, job):
    print(name, age, city, job)

## 如果函数定义中已经有了一个可变参数，后面跟着的命名关键字参数就不再需要一个特殊分隔符*了
def person(name, age, *args, city, job):
    print(name, age, args, city, job)

3.6. 参数组合

参数定义的 顺序 必须是：必选参数、默认参数、可变参数、命名关键字参数和关键字参数。不要使用太多的参数组合，否则会使接口的可读性变差。

## 通用函数
func(*args, **kw)
	pass

##例1
def f1(a, b, c=0, *args, **kw):
    print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw)

>>> f1(1, 2, 3, 'a', 'b', x=99)
a = 1 b = 2 c = 3 args = ('a', 'b') kw = {'x': 99}
## 传入tuple和dict
>>> args = (1, 2, 3, 4)
>>> kw = {'d': 99, 'x': '#'}
>>> f1(*args, **kw)
a = 1 b = 2 c = 3 args = (4,) kw = {'d': 99, 'x': '#'}

##例2    
def f2(a, b, c=0, *, d, **kw):
    print('a =', a, 'b =', b, 'c =', c, 'd =', d, 'kw =', kw)

>>> f2(1, 2, d=99, ext=None)
a = 1 b = 2 c = 0 d = 99 kw = {'ext': None}

##例3    
def f3(a, b, c=0, *args, d, **kw):
    print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'd =', d, 'kw =', kw)

>>> f3(1, 2, 3, 'a', 'b', d=99, ext=None)
a = 1 b = 2 c = 3 args = ('a', 'b') d = 99 kw = {'ext': None}

##例4  
def f4(a, b, c=0, *args, d=1, **kw):
	print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'd =', d, 'kw =', kw)

>>> f4(1, 2, 3, 'a', 'b', ext=None)
a = 1 b = 2 c = 3 args = ('a', 'b') d = 1 kw = {'ext': None}

3.7. 小结

• Python的函数具有非常灵活的参数形态，既可以实现简单的调用，又可以传入非常复杂的参数。
• 默认参数一定要用不可变对象，如果是可变对象，程序运行时会有逻辑错误！
• 要注意定义可变参数和关键字参数的语法：
  • *args是可变参数，args接收的是一个tuple；
  • **kw是关键字参数，kw接收的是一个dict。
• 以及调用函数时如何传入可变参数和关键字参数的语法：
  • 可变参数既可以直接传入：func(1, 2, 3)，又可以先组装list或tuple，再通过*args传入：func(*(1, 2, 3))；
  • 关键字参数既可以直接传入：func(a=1, b=2)，又可以先组装dict，再通过*kw传入：func(*{‘a’: 1, ‘b’: 2})。
• 使用*args和**kw是Python的习惯写法，当然也可以用其他参数名，但最好使用习惯用法。
• 命名的关键字参数是为了限制调用者可以传入的参数名，同时可以提供默认值。
• 定义命名的关键字参数在没有可变参数的情况下不要忘了写分隔符*，否则定义的将是位置参数。

4. 递归函数

如果一个函数在内部调用自身函数，则为递归函数。递归函数的优点是定义简单，逻辑清晰。理论上所有的递归函数都可以写成循环的方式，但是不如递归清晰。使用递归函数时需要注意 栈溢出问题。在计算机中，函数调用是通过栈(stack)实现的，每进入一个函数调用，栈就会加一层栈帧，每当函数返回，栈帧就会减一层。栈的大小是有限的因此存在溢出问题。

##阶乘计算
def fact(n):
    if n == 1:
        return n
    return n * fact(n-1)

##验证
>>> fact(1)
1
>>> fact(5)
120
>>> fact(1000)  ##栈溢出
Traceback (most recent call last):
    ......
    ......
 RecursionError: maximum recursion depth exceeded in comparison


##计算过程
===> fact(5)
===> 5 * fact(4)
===> 5 * (4 * fact(3))
===> 5 * (4 * (3 * fact(2)))
===> 5 * (4 * (3 * (2 * fact(1))))
===> 5 * (4 * (3 * (2 * 1)))
===> 5 * (4 * (3 * 2))
===> 5 * (4 * 6)
===> 5 * 24
===> 120

栈溢出问题可以通过尾递归的方法来解决。尾递归是指函数在调用自身的时候，return不能包含表达式。这样编译器或解释器会对尾递归做优化，使得无论调用自身多少次都是用一个栈，这样就不会溢出了。把循环看成一种尾递归也是可以的。遗憾的是大部分编程语言都没有做尾递归优化，包括Python。

## return中不含表达式
def fact(num , product):
    if num == 1:
        return product
    return fact(num-1 ,num * product)

## 验证
>>> fact(5, 1)
120

##计算过程
===> fact(5, 1)
===> fact(4, 5)
===> fact(3, 20)
===> fact(2, 60)
===> fact(1, 120)
===> 120