开源项目 `typecheck-decorator` 使用教程

开源项目 typecheck-decorator 使用教程

typecheck-decoratorFor Python3, e.g. @typecheck add_count(count: int, when: any(datetime, timedelta) = datetime.now)项目地址:https://gitcode.com/gh_mirrors/ty/typecheck-decorator

1. 项目的目录结构及介绍

typecheck-decorator/
├── LICENSE
├── README.md
├── setup.py
├── typecheck_decorator/
│   ├── __init__.py
│   ├── typecheck.py
│   └── tests/
│       ├── __init__.py
│       └── test_typecheck.py
└── docs/
    └── ...

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• setup.py: 项目安装脚本。
• typecheck_decorator/: 项目主代码目录。
  • __init__.py: 模块初始化文件。
  • typecheck.py: 类型检查装饰器实现文件。
  • tests/: 测试代码目录。
    • __init__.py: 测试模块初始化文件。
    • test_typecheck.py: 类型检查装饰器的测试文件。
• docs/: 项目文档目录。

2. 项目的启动文件介绍

项目的启动文件是 typecheck_decorator/typecheck.py。该文件包含了类型检查装饰器的实现，主要功能是对函数参数进行运行时类型检查。

# typecheck_decorator/typecheck.py

import inspect
from functools import wraps

def typecheck(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        sig = inspect.signature(func)
        bound_args = sig.bind(*args, **kwargs)
        bound_args.apply_defaults()
        for name, value in bound_args.arguments.items():
            param = sig.parameters[name]
            if param.annotation != param.empty:
                if not isinstance(value, param.annotation):
                    raise TypeError(f"Argument '{name}' must be of type {param.annotation}")
        return func(*args, **kwargs)
    return wrapper

3. 项目的配置文件介绍

项目没有专门的配置文件，所有的配置和功能实现都在代码中完成。如果需要自定义配置，可以通过修改 typecheck_decorator/typecheck.py 文件中的装饰器实现来实现。

例如，可以添加自定义的类型检查逻辑：

# typecheck_decorator/typecheck.py

def typecheck(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        sig = inspect.signature(func)
        bound_args = sig.bind(*args, **kwargs)
        bound_args.apply_defaults()
        for name, value in bound_args.arguments.items():
            param = sig.parameters[name]
            if param.annotation != param.empty:
                if not isinstance(value, param.annotation):
                    raise TypeError(f"Argument '{name}' must be of type {param.annotation}")
                # 自定义类型检查逻辑
                if name == 'custom_arg' and value < 0:
                    raise ValueError("Custom argument must be non-negative")
        return func(*args, **kwargs)
    return wrapper

通过这种方式，可以根据具体需求添加自定义的类型检查逻辑。

typecheck-decoratorFor Python3, e.g. @typecheck add_count(count: int, when: any(datetime, timedelta) = datetime.now)项目地址:https://gitcode.com/gh_mirrors/ty/typecheck-decorator