python 函数

一、函数

1. 函数概念

函数是组织好的，可重复使用的，用来实现单一，或相关联功能的代码段。
函数能提高应用的模块性，和代码的重复利用率。你已经知道Python提供了许多内建函数，比如print()。但你也可以自己创建函数，这被叫做用户自定义函数。

2. 定义一个函数

你可以定义一个由自己想要功能的函数，以下是简单的规则：
    函数代码块以 def 关键词开头，后接函数标识符名称和圆括号 ()。
    任何传入参数和自变量必须放在圆括号中间，圆括号之间可以用于定义参数。
    函数的第一行语句可以选择性地使用文档字符串—用于存放函数说明。
    函数内容以冒号 : 起始，并且缩进。
    return [表达式] 结束函数，选择性地返回一个值给调用方，不带表达式的 return 相当于返回 None。
语法
    Python 定义函数使用 def 关键字，一般格式如下：
        def 函数名（参数列表）:
            函数体
        默认情况下，参数值和参数名称是按函数声明中定义的顺序匹配起来的。

3. 函数调用

定义一个函数：给了函数一个名称，指定了函数里包含的参数，和代码块结构。
这个函数的基本结构完成以后，你可以通过另一个函数调用执行，也可以直接从 Python 命令提示符执行。

4. 参数传递

在 python 中，类型属于对象，对象有不同类型的区分，变量是没有类型的：
    a=[1,2,3]
    a="Runoob"
以上代码中，[1,2,3] 是 List 类型，"Runoob" 是 String 类型，而变量 a 是没有类型，她仅仅是一个对象的引用（一个指针），可以是指向 List 类型对象，也可以是指向 String 类型对象。
可更改(mutable)与不可更改(immutable)对象
在 python 中，strings, tuples, 和 numbers 是不可更改的对象，而 list,dict 等则是可以修改的对象。
    不可变类型：变量赋值 a=5 后再赋值 a=10，这里实际是新生成一个 int 值对象 10，再让 a 指向它，而 5 被丢弃，不是改变 a 的值，相当于新生成了 a。
    可变类型：变量赋值 la=[1,2,3,4] 后再赋值 la[2]=5 则是将 list la 的第三个元素值更改，本身la没有动，只是其内部的一部分值被修改了。
python 函数的参数传递：
    不可变类型：类似 C++ 的值传递，如整数、字符串、元组。如 fun(a)，传递的只是 a 的值，没有影响 a 对象本身。如果在 fun(a) 内部修改 a 的值，则是新生成一个 a 的对象。
    可变类型：类似 C++ 的引用传递，如 列表，字典。如 fun(la)，则是将 la 真正的传过去，修改后 fun 外部的 la 也会受影响
python 中一切都是对象，严格意义我们不能说值传递还是引用传递，我们应该说传不可变对象和传可变对象。
python 传不可变对象实例
    通过 id() 函数来查看内存地址变化：
传可变对象实例
    可变对象在函数里修改了参数，那么在调用这个函数的函数里，原始的参数也被改变了

5. 参数

以下是调用函数时可使用的正式参数类型：
    必需参数
    关键字参数
    默认参数
    不定长参数
必需参数
    必需参数须以正确的顺序传入函数。调用时的数量必须和声明时的一样。否则会报错
关键字参数
    关键字参数和函数调用关系紧密，函数调用使用关键字参数来确定传入的参数值。
    使用关键字参数允许函数调用时参数的顺序与声明时不一致，因为 Python 解释器能够用参数名匹配参数值。
默认参数
    调用函数时，如果没有传递参数，则会使用默认参数
不定长参数
    你可能需要一个函数能处理比当初声明时更多的参数。这些参数叫做不定长参数，和上述 3 种参数不同，声明时不会命名。基本语法如下：
    def functionname([formal_args,] *var_args_tuple ):
       "函数_文档字符串"
       function_suite
       return [expression]
    加了星号 * 的参数会以元组(tuple)的形式导入，存放所有未命名的变量参数

    还有一种就是参数带两个星号 **基本语法如下：
    def functionname([formal_args,] **var_args_dict ):
       "函数_文档字符串"
       function_suite
       return [expression]
    加了两个星号 ** 的参数会以字典的形式导入。

    声明函数时，参数中星号 * 可以单独出现;如果单独出现星号 *，则星号 * 后的参数必须用关键字传入

6. 匿名函数

Python 使用 lambda 来创建匿名函数。
所谓匿名，意即不再使用 def 语句这样标准的形式定义一个函数。
    lambda 只是一个表达式，函数体比 def 简单很多。
    lambda 的主体是一个表达式，而不是一个代码块。仅仅能在 lambda 表达式中封装有限的逻辑进去。
    lambda 函数拥有自己的命名空间，且不能访问自己参数列表之外或全局命名空间里的参数。
    虽然 lambda 函数看起来只能写一行，却不等同于 C 或 C++ 的内联函数，内联函数的目的是调用小函数时不占用栈内存从而减少函数调用的开销，提高代码的执行速度。
语法
lambda 函数的语法只包含一个语句，如下：
    lambda [arg1 [,arg2,.....argn]]:expression

7. return 语句

return [表达式] 语句用于退出函数，选择性地向调用方返回一个表达式。不带参数值的 return 语句返回 None。之前的例子都没有示范如何返回数值，以下实例演示了 return 语句的用法：

8. 强制位置参数

Python3.8 新增了一个函数形参语法 / 用来指明函数形参必须使用指定位置参数，不能使用关键字参数的形式。

二、代码概述

#!/usr/bin/env python3
# -*- coding: UTF-8 -*-
# @Date : 2024/4/2 8:50
# @Author : water
# @Description : 函数模块
"""
函数
    函数是组织好的，可重复使用的，用来实现单一，或相关联功能的代码段。
    函数能提高应用的模块性，和代码的重复利用率。你已经知道Python提供了许多内建函数，比如print()。但你也可以自己创建函数，这被叫做用户自定义函数。
定义一个函数
    你可以定义一个由自己想要功能的函数，以下是简单的规则：
        函数代码块以 def 关键词开头，后接函数标识符名称和圆括号 ()。
        任何传入参数和自变量必须放在圆括号中间，圆括号之间可以用于定义参数。
        函数的第一行语句可以选择性地使用文档字符串—用于存放函数说明。
        函数内容以冒号 : 起始，并且缩进。
        return [表达式] 结束函数，选择性地返回一个值给调用方，不带表达式的 return 相当于返回 None。
    语法
        Python 定义函数使用 def 关键字，一般格式如下：
            def 函数名（参数列表）:
                函数体
            默认情况下，参数值和参数名称是按函数声明中定义的顺序匹配起来的。
函数调用
    定义一个函数：给了函数一个名称，指定了函数里包含的参数，和代码块结构。
    这个函数的基本结构完成以后，你可以通过另一个函数调用执行，也可以直接从 Python 命令提示符执行。
参数传递
    在 python 中，类型属于对象，对象有不同类型的区分，变量是没有类型的：
        a=[1,2,3]
        a="Runoob"
    以上代码中，[1,2,3] 是 List 类型，"Runoob" 是 String 类型，而变量 a 是没有类型，她仅仅是一个对象的引用（一个指针），可以是指向 List 类型对象，也可以是指向 String 类型对象。
    可更改(mutable)与不可更改(immutable)对象
    在 python 中，strings, tuples, 和 numbers 是不可更改的对象，而 list,dict 等则是可以修改的对象。
        不可变类型：变量赋值 a=5 后再赋值 a=10，这里实际是新生成一个 int 值对象 10，再让 a 指向它，而 5 被丢弃，不是改变 a 的值，相当于新生成了 a。
        可变类型：变量赋值 la=[1,2,3,4] 后再赋值 la[2]=5 则是将 list la 的第三个元素值更改，本身la没有动，只是其内部的一部分值被修改了。
    python 函数的参数传递：
        不可变类型：类似 C++ 的值传递，如整数、字符串、元组。如 fun(a)，传递的只是 a 的值，没有影响 a 对象本身。如果在 fun(a) 内部修改 a 的值，则是新生成一个 a 的对象。
        可变类型：类似 C++ 的引用传递，如 列表，字典。如 fun(la)，则是将 la 真正的传过去，修改后 fun 外部的 la 也会受影响
    python 中一切都是对象，严格意义我们不能说值传递还是引用传递，我们应该说传不可变对象和传可变对象。
    python 传不可变对象实例
        通过 id() 函数来查看内存地址变化：
    传可变对象实例
        可变对象在函数里修改了参数，那么在调用这个函数的函数里，原始的参数也被改变了
参数
    以下是调用函数时可使用的正式参数类型：
        必需参数
        关键字参数
        默认参数
        不定长参数
    必需参数
        必需参数须以正确的顺序传入函数。调用时的数量必须和声明时的一样。否则会报错
    关键字参数
        关键字参数和函数调用关系紧密，函数调用使用关键字参数来确定传入的参数值。
        使用关键字参数允许函数调用时参数的顺序与声明时不一致，因为 Python 解释器能够用参数名匹配参数值。
    默认参数
        调用函数时，如果没有传递参数，则会使用默认参数
    不定长参数
        你可能需要一个函数能处理比当初声明时更多的参数。这些参数叫做不定长参数，和上述 3 种参数不同，声明时不会命名。基本语法如下：
        def functionname([formal_args,] *var_args_tuple ):
           "函数_文档字符串"
           function_suite
           return [expression]
        加了星号 * 的参数会以元组(tuple)的形式导入，存放所有未命名的变量参数

        还有一种就是参数带两个星号 **基本语法如下：
        def functionname([formal_args,] **var_args_dict ):
           "函数_文档字符串"
           function_suite
           return [expression]
        加了两个星号 ** 的参数会以字典的形式导入。

        声明函数时，参数中星号 * 可以单独出现;如果单独出现星号 *，则星号 * 后的参数必须用关键字传入
匿名函数
    Python 使用 lambda 来创建匿名函数。
    所谓匿名，意即不再使用 def 语句这样标准的形式定义一个函数。
        lambda 只是一个表达式，函数体比 def 简单很多。
        lambda 的主体是一个表达式，而不是一个代码块。仅仅能在 lambda 表达式中封装有限的逻辑进去。
        lambda 函数拥有自己的命名空间，且不能访问自己参数列表之外或全局命名空间里的参数。
        虽然 lambda 函数看起来只能写一行，却不等同于 C 或 C++ 的内联函数，内联函数的目的是调用小函数时不占用栈内存从而减少函数调用的开销，提高代码的执行速度。
    语法
    lambda 函数的语法只包含一个语句，如下：
        lambda [arg1 [,arg2,.....argn]]:expression
return 语句
    return [表达式] 语句用于退出函数，选择性地向调用方返回一个表达式。不带参数值的 return 语句返回 None。之前的例子都没有示范如何返回数值，以下实例演示了 return 语句的用法：
强制位置参数
    Python3.8 新增了一个函数形参语法 / 用来指明函数形参必须使用指定位置参数，不能使用关键字参数的形式。
"""


# hello函数
def hello():
    """
    打印hello world

    参数：无
    返回值：无
    """
    print("hello world")


hello()


# 求两个数的最大值
def max_num(num1, num2):
    """
    求两个数的最大值

    参数：num1, num2
    返回值：最大值
    """
    if num1 > num2:
        return num1
    else:
        return num2


print(max_num(3, 5))


# 计算面积函数:
def area(width, height):
    """
    计算面积

    参数：width, height
    返回值：面积
    """
    return width * height


print(area(3, 5))


# 传不可变对象
def change(a):
    """
    可以看见在调用函数前后，形参和实参指向的是同一个对象（对象 id 相同），在函数内部修改形参后，形参指向的是不同的 id。
    参数：a
    返回值：无
    """
    print(id(a))  # 指向的是同一个对象
    a = 10
    print(id(a))  # 一个新对象


a = 1
print(id(a))
change(a)


# 传可变对象

def change_me(my_list):
    """
    传入函数的和在末尾添加新内容的对象用的是同一个引用,所以内外都改了
    参数：my_list
    返回值：无
    """
    my_list.append([1, 2, 3, 4])
    print("函数内取值: ", my_list)


# 调用change_me函数
out_list = [10, 20, 30]
change_me(out_list)
print("函数外取值: ", out_list)


# 参数：必须参数、默认参数、关键字参数、不定长参数

# 必须参数
def print_num(num1, num2):
    """
    打印两个数

    参数：num1, num2
    返回值：求和
    """
    print(num1, num2)
    return num1 + num2


print("必须参数", print_num(1, 2))

# 关键字参数
print("必须参数", print_num(num2=5, num1=6))


# 默认参数
def print_num_default(num1, num2=2):
    """
    打印两个数

    参数：num1, num2
    返回值：求和
    """
    print(num1, num2)
    return num1 + num2


print("默认参数:", print_num_default(1), "修改默认参数：", print_num_default(3, 4))


# 不定长参数
def print_num_default(*nums):
    """
    打印两个数

    参数：num1, num2
    返回值：求和
    """
    print(nums)
    return sum(nums)


print("不定长参数:", print_num_default(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))


# 如果在函数调用时没有指定参数，它就是一个空元组。我们也可以不向函数传递未命名的变量
def print_num_default(args, *nums):
    """
    打印两个数

    参数：num1, num2
    返回值：求和
    """
    print(args, nums)
    return sum([args]) + sum(nums)


print("不定长参数:", print_num_default(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))


# 加了两个星号 ** 的参数会以字典的形式导入
def print_num_default(args, **nums):
    """
    打印两个数

    参数：num1, num2
    返回值：求和
    """
    print(args, nums)
    return sum([args]) + sum(nums.values())


print(print_num_default(1, b=2, c=3, d=4, e=5, f=6, g=7, h=8, i=9, j=10))


# 声明函数时，参数中星号 * 可以单独出现

def f(a, b, *, c):
    return a + b + c


# 如果单独出现星号 *，则星号 * 后的参数必须用关键字传入

print(f(1, 2, c=3))

# 匿名函数
x = lambda a: a + 10
print(x(5))

# 实例匿名函数设置两个参数
x = lambda a, b: a + b
print(x(5, 10))

"""
我们可以将匿名函数封装在一个函数内，这样可以使用同样的代码来创建多个匿名函数。
以下实例将匿名函数封装在 myfunc 函数中，通过传入不同的参数来创建不同的匿名函数
"""


# 创建多个匿名函数
def myfunc(a, b, c):
    return lambda x: x * a + b + c


function_x = myfunc(1, 2, 3)

print(function_x(1))

print(function_x(2))


# return 语句
def return_func():
    """
    return 语句

    参数：无
    返回值：无
    """
    return "hello world"


print(return_func())


# 强制位置参数
def f(a, b, /, c, d, *, e, f):
    """
    在以下的例子中，形参 a 和 b 必须使用指定位置参数，c 或 d 可以是位置形参或关键字形参，而 e 和 f 要求为关键字形参:
    """
    print(a, b, c, d, e, f)


f(10, 20, 30, d=40, e=50, f=60)
f(10, 20, 30, 40, e=50, f=60)

# 以下使用方法会发生错误:
f(10, b=20, c=30, d=40, e=50, f=60)  # b 不能使用关键字参数的形式
f(10, 20, 30, 40, 50, f=60)  # e 必须使用关键字参数的形式