如何在Python类定义阶段通过函数设置类属性？

问题描述 #

需要在Python类定义阶段通过调用函数来设置类属性，示例场景如下：

class Mammal():
    # 内部库提供的基类

class Dog(Mammal):
    set_sound("Woof")

class Cat(Mammal):
    set_sound("Meow")

要求set_sound(val)函数能为派生类设置类属性，后续无需创建实例即可直接通过类访问该属性：

print(Dog.sound)  # 预期输出 Woof
print(Cat.sound)  # 预期输出 Meow

尝试的代码无法正常工作，且希望无需创建实例就能完成属性设置，尝试代码如下：

import functools


class DirectiveMeta():
    directives_to_be_executed = []
    
    def __init__(self):
        for directive in self.directives_to_be_executed:
            directive(self)
                
    @staticmethod
    def directive():
        def decorator(decorated_function):
            @functools.wraps(decorated_function)
            def wrapper(*args, **kwargs):
                result = decorated_function(*args, **kwargs)
                values = (result,)                
                DirectiveMeta.directives_to_be_executed.extend(values)
                return result
            return wrapper
        return decorator


class Mammal(DirectiveMeta):
    def __init__(self):
        super().__init__()


directive = DirectiveMeta.directive

    
@directive()
def sound(s):
    print(f'Inside sound() s = {s}')
    return lambda pkg: _execute_version(pkg, s)
    
def _execute_version(pkg, s):
    print(f'Inside _execute_version pkg = {pkg}  sound = {s}')
    pkg.sound = s


class Dog(Mammal):
    sound("Woof")


class Cat(Mammal):    
    sound("Meow")   

    
if __name__ == '__main__':    
    d = Dog()
    #c = Cat()

    #print(Dog.sound)  

解决方案 #

要实现这个需求，核心是利用元类拦截类的创建过程，或者直接访问类定义时的命名空间，在类定义阶段完成属性设置。以下是两种可行的实现方式：

方式一：元类+指令收集（支持多指令扩展） #

这种方式可以方便扩展更多类似set_sound的指令：

import inspect

class MammalMeta(type):
    def __new__(cls, name, bases, namespace):
        # 执行当前类收集到的所有指令
        if '_directives' in namespace:
            for directive in namespace['_directives']:
                directive(namespace)
            del namespace['_directives']
        return super().__new__(cls, name, bases, namespace)

class Mammal(metaclass=MammalMeta):
    pass

def set_sound(val):
    # 定义具体的属性设置逻辑
    def directive(namespace):
        namespace['sound'] = val
    # 获取类定义时的栈帧，把指令添加到类的命名空间中
    frame = inspect.currentframe().f_back
    if '_directives' not in frame.f_locals:
        frame.f_locals['_directives'] = []
    frame.f_locals['_directives'].append(directive)

# 测试验证
class Dog(Mammal):
    set_sound("Woof")

class Cat(Mammal):
    set_sound("Meow")

print(Dog.sound)  # 输出 Woof
print(Cat.sound)  # 输出 Meow

方式二：直接修改类命名空间（简洁版） #

如果只需要实现set_sound这类单一指令，直接通过栈帧修改类的局部命名空间即可：

import inspect

class MammalMeta(type):
    pass

class Mammal(metaclass=MammalMeta):
    pass

def set_sound(val):
    # 获取类定义时的栈帧，直接给类的局部命名空间添加属性
    frame = inspect.currentframe().f_back
    frame.f_locals['sound'] = val

# 测试验证
class Dog(Mammal):
    set_sound("Woof")

class Cat(Mammal):
    set_sound("Meow")

print(Dog.sound)  # 输出 Woof
print(Cat.sound)  # 输出 Meow

核心原理说明 #

• 利用inspect.currentframe()获取函数调用时的栈帧，f_back指向类定义代码所在的栈帧，从而访问类的局部命名空间f_locals。
• 元类MammalMeta的__new__方法会在类创建前被调用，负责执行收集到的指令（方式一），确保属性在类生成时就被设置。
• 两种方式都不需要创建类实例，完全在类定义阶段完成属性设置，符合需求。

内容的提问来源于stack exchange，提问作者bflynt