函数内省和函数装饰器的用法

函数内省和函数装饰器是 Python 中非常重要的概念，可以帮助我们更好地理解函数的行为和功能，并丰富语言的灵活性和可扩展性。本文将从两个方面详细讲解函数内省和函数装饰器的用法和实现方法。

一、函数内省的用法

函数内省是指在运行时检查和获取函数的属性和信息的技术，可以帮助我们了解函数的参数、返回值、默认值、文档注释等属性，以及调用函数、修改函数属性等操作。下面列举了一些常用的函数内省方法和示例：

1. 使用 help() 函数获取函数文档注释

help() 函数是 Python 内置的一个函数，可以用来获取对象的帮助信息。通过在 help() 函数中传入函数名或函数对象，我们可以获取函数的文档注释，参数信息和示例代码等信息。例如：

def greet(name):
    """
    This function greets to the person passed in as parameter
    """
    print("Hello, " + name + ". How are you?")

print(help(greet))

输出结果为：

Help on function greet in module __main__:

greet(name)
    This function greets to the person passed in as parameter

2. 使用 dir() 函数获取函数属性

dir() 函数是 Python 内置的一个函数，可以用来获取对象的属性列表，包括函数的参数名、全局变量、内置属性等。例如：

def foo(x, y=1):
    z = x + y
    return z

print(dir(foo))

输出结果为：

['__annotations__', '__call__', '__class__', '__closure__', '__code__', '__defaults__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__get__', '__getattribute__', '__globals__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__kwdefaults__', '__le__', '__lt__', '__module__', '__name__', '__ne__', '__new__', '__qualname__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'func_closure', 'func_code', 'func_defaults', 'func_dict', 'func_doc', 'func_globals', 'func_name']

3. 使用 inspect 模块获取函数信息

inspect 模块是 Python 内置的一个模块，可以用于解析 Python 源代码并检查对象的属性和信息。使用 inspect 模块可以获取函数的参数、参数的默认值、函数签名、注释等信息。例如：

import inspect

def bar(a: int, b: str = 'hello') -> str:
    """
    This function returns a string with input parameters
    """
    return f"a={a}, b={b}"

print(inspect.signature(bar))
print(inspect.getdoc(bar))

输出结果为：

(a: int, b: str = 'hello') -> str
    This function returns a string with input parameters

二、函数装饰器的用法

函数装饰器是一种特殊的函数，可以为其他函数添加额外的功能和逻辑，同时又不影响原函数的执行。函数装饰器是 Python 装饰器模式的典型应用，可以极大地提高代码的复用性和可维护性。下面列举了一些常用的函数装饰器方法和示例：

1. 简单的函数装饰器

下面展示一个简单的装饰器，它可以在执行函数前和执行函数后添加一行日志：

def log(func):
    def wrapper(*args, **kwargs):
        print("Log: function {} is called.".format(func.__name__))
        result = func(*args, **kwargs)
        print("Log: function {} is finished.".format(func.__name__))
        return result
    return wrapper

@log
def myfunc(x, y):
    return x + y

print(myfunc(2, 3))

输出结果为：

Log: function myfunc is called.
Log: function myfunc is finished.
5

2. 带参数的函数装饰器

下面展示一个带参数的装饰器，它可以用于限制函数的输入参数类型：

def check_type(expected_type):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for arg in args:
                if not isinstance(arg, expected_type):
                    raise TypeError("Input parameter must be {}".format(expected_type))
            for value in kwargs.values():
                if not isinstance(value, expected_type):
                    raise TypeError("Input parameter must be {}".format(expected_type))
            return func(*args, **kwargs)
        return wrapper
    return decorator

@check_type(int)
def myfunc(x, y):
    return x + y

print(myfunc(2, 3))
print(myfunc(2, '3'))

输出结果为：

5
Traceback (most recent call last):
  File "test.py", line 17, in <module>
    print(myfunc(2, '3'))
  File "test.py", line 6, in wrapper
    raise TypeError("Input parameter must be {}".format(expected_type))
TypeError: Input parameter must be <class 'int'>

3. 类装饰器

类装饰器是一种特殊的装饰器，可以将一个类作为装饰器，实现对被装饰的函数的包装和修改。下面是一个简单的类装饰器例子，它可以添加分界线和日志信息：

class Decorator:
    def __init__(self, func):
        self.func = func
        
    def __call__(self, *args, **kwargs):
        print("*******************")
        print("Log: function {} is called.".format(self.func.__name__))
        result = self.func(*args, **kwargs)
        print("Log: function {} is finished.".format(self.func.__name__))
        print("*******************")
        return result

@Decorator
def myfunc(x, y):
    return x + y

print(myfunc(2, 3))

输出结果为：

*******************
Log: function myfunc is called.
Log: function myfunc is finished.
*******************
5

函数内省和函数装饰器是 Python 编程中非常有用的技术，可以帮助我们更好地理解函数和提高代码的复用性和可维护性。通过本文的介绍和示例，读者可以更加深入地了解和掌握这两种技术的用法和实现方法，为自己的 Python 编程带来更多的灵活性和创造力。