一、前置说明
1、本节目标
- 了解元类
metaclass
的使用。 - 了解
__new__
方法的使用。 - 了解如何使用元类隐式装饰类中的所有方法。
2、相关回顾
二、操作步骤
1、项目目录
atme
:@me
用于存放临时的代码片断或其它内容。pyparamvalidate
: 新建一个与项目名称同名的package,为了方便发布至pypi
。core
: 用于存放核心代码。tests
: 用于存放测试代码。utils
: 用于存放一些工具类或方法。
2、代码实现
atme/demo/validator_v3/validator.py
import functools import inspect def _error_prompt(value, exception_msg=None, rule_des=None, field=None): """ 优先使用校验方法中的错误提示, 如果方法中没有错误提示,则使用"字段规则描述"代替错误提示 拼接出:name error: "123" is invalid. due to: name must be string. """ default = f'"{value}" is invalid.' prompt = exception_msg or rule_des prompt = f'{default} due to: {prompt}' if prompt else default prompt = f'{field} error: {prompt}' if field else prompt return prompt def raise_exception(func): @functools.wraps(func) def wrapper(self, *args, **kwargs): bound_args = inspect.signature(func).bind(self, *args, **kwargs).arguments exception_msg = kwargs.get('exception_msg', None) or bound_args.get('exception_msg', None) error_prompt = _error_prompt(self.value, exception_msg, self._rule_des, self._field) result = func(self, *args, **kwargs) if not result: raise ValueError(error_prompt) return self return wrapper class RaiseExceptionMeta(type): def __new__(cls, name, bases, dct): for key, value in dct.items(): # 如果是静态方法,则将它替换为一个新的静态方法,新的静态方法调用 raise_exception 函数,将原静态方法作为参数传递给raise_exception if isinstance(value, staticmethod): dct[key] = staticmethod(raise_exception(value.__func__)) # 如果是类方法,则将它替换为一个新的类方法,新的类方法调用 raise_exception 函数,将原类方法作为参数传递给raise_exception if isinstance(value, classmethod): dct[key] = classmethod(raise_exception(value.__func__)) # 如果是普通的成员方法,则将它替换为一个新的函数,新函数调用 raise_exception 函数,将原函数作为参数传递给 raise_exception # 排除掉以双下划线 __ 开头的方法, 如 __init__,__new__等 if inspect.isfunction(value) and not key.startswith("__"): dct[key] = raise_exception(value) return super().__new__(cls, name, bases, dct) class Validator(metaclass=RaiseExceptionMeta): def __init__(self, value, field=None, rule_des=None): """ :param value: 待校验的值 :param field: 校验字段 - 用于提示具体哪个字段错误 - 如 'name error: name must be string' - error 前面的 `name` 即为 field :param rule_des: 校验规则描述 """ self.value = value self._field = field self._rule_des = rule_des def is_string(self, exception_msg=None): return isinstance(self.value, str) def is_not_empty(self, exception_msg=None): return bool(self.value)
3、测试代码
atme/demo/validator_v3/test_validator.py
import pytest from atme.demo.validator_v3.validator import Validator def test_validator_01(): """ 在 Validator 实例化时,不给 field、rule_des 传值; 在校验方法中,不给 exception_msg 传值 """ validator = Validator('Jane') assert validator.is_string().is_not_empty() with pytest.raises(ValueError) as exc_info: validator = Validator(123) validator.is_string().is_not_empty() assert 'invalid' in str(exc_info.value) print(exc_info.value) # 输出: "123" is invalid. def test_validator_02(): """ 在 Validator 实例化时,给 field、rule_des 传值 """ validator = Validator('Jane', field='name', rule_des='name must be string from rule des.') assert validator.is_string().is_not_empty() with pytest.raises(ValueError) as exc_info: validator = Validator(123, field='name', rule_des='name must be string from rule des.') validator.is_string().is_not_empty() assert 'name must be string from rule des.' in str(exc_info.value) print(exc_info.value) # 输出: name error: "123" is invalid. due to: name must be string from rule des. def test_validator_03(): """ 在 Validator 实例化时,给 field、rule_des 传值; 在校验方法中,给 exception_msg 传值 """ validator = Validator('Jane', field='name', rule_des='name must be string from rule des.') assert validator.is_string().is_not_empty() with pytest.raises(ValueError) as exc_info: validator = Validator(123, field='name', rule_des='name must be string from rule des.') validator.is_string('name must be string from method exception msg.').is_not_empty() assert 'name must be string from method exception msg.' in str(exc_info.value) print(exc_info.value) # 输出: "123" is invalid due to "name error: name must be string from method exception msg." def test_validator_04(): """ field_name 为空 """ validator = Validator('Jane', rule_des='name must be string from rule des.') assert validator.is_string().is_not_empty() with pytest.raises(ValueError) as exc_info: validator = Validator(123, rule_des='name must be string from rule des.') validator.is_string('name must be string from method exception msg.').is_not_empty() assert 'name must be string from method exception msg.' in str(exc_info.value) print(exc_info.value) # 输出: "123" is invalid due to "name must be string from method exception msg."
4、日志输出
执行 test
的日志如下,验证通过:
============================= test session starts ============================= collecting ... collected 4 items test_validator.py::test_validator_01 PASSED [ 25%]"123" is invalid. test_validator.py::test_validator_02 PASSED [ 50%]name error: "123" is invalid. due to: name must be string from rule des. test_validator.py::test_validator_03 PASSED [ 75%]name error: "123" is invalid. due to: name must be string from method exception msg. test_validator.py::test_validator_04 PASSED [100%]"123" is invalid. due to: name must be string from method exception msg. ============================== 4 passed in 0.01s ==============================
三、后置说明
1、要点小结
- 元类
metaclass
可以控制类的创建过程,可以动态的修改类的属性、方法和其他行为; __new__
用于创建实例,__init__
用于初始化实例。- 在
RaiseExceptionMeta
类中,它会遍历类的字典(包括属性和方法),并对其中的静态方法、类方法和普通成员方法进行修改。 - 经过优化后,虽然从功能上实现了链式调用的效果,但由于校验方法没有
return self
, 编辑器如pycharm
不能智能识别可链式调用的方法(如下图),对用户很不友好,需要继续优化。
2、下节准备
- 使用
TypeVar
创建Self
类变量,方便用户在pycharm
编辑器中进行链式调用