如何使用自定义装饰器避免Pylance类型检测错误？-Python教程-PHP中文网

如何使用自定义装饰器避免Pylance类型检测错误？

碧海醫心

发布： 2025-03-19 08:46:15

原创

1003人浏览过

如何使用自定义装饰器避免pylance类型检测错误？

巧妙运用自定义装饰器，规避Pylance类型检查警告

Python开发中，类型检查工具（例如Pylance）常会发出警告，尤其是在使用自定义装饰器时。如果装饰器修改了函数的返回类型，类型检查器可能无法准确识别，导致误报。本文将讲解如何解决这类类型检查错误，确保类型注解的准确性。

问题剖析

假设我们有一个Python代码片段，使用了自定义装饰器execute，它包装了名为query_data_source的函数。未经装饰的query_data_source函数返回类型为select，但经过execute装饰后，实际返回类型变为Result[Any]。然而，Pylance仍然认为query_data_source返回select，从而发出警告。

原始代码如下：

def execute(func):
    def inner_wrapper(*args, **kwargs) -> result[any]:
        with session.begin() as session:
            result = session.execute(func(*args, **kwargs))
            return result

    return inner_wrapper


@execute
def query_data_source(
    start_id: int = 1, max_results_amount: int = 10
) -> select:  # Pylance警告在此处产生
    stmt = (
        select(
            datasource.id,
            datasource.name,
            datasource.source_url,
            datasource.author,
            datasource.description,
            datasource.cover_image_url,
            datasource.start_date,
            datasource.end_date,
        )
        .where(datasource.id >= start_id)
        .limit(max_results_amount)
        .order_by(datasource.id)
    )
    return stmt

登录后复制

解决方案

为了消除Pylance警告并准确表达装饰后函数的返回类型，我们需要修改execute装饰器。关键在于明确指定装饰后函数的返回类型。我们可以利用typing模块中的Callable来实现。

修改后的execute装饰器代码：

from typing import Callable, Any

def execute(func) -> Callable[..., Result]:
    def inner_wrapper(*args, **kwargs) -> Result[Any]:
        with Session.begin() as session:
            result = session.execute(func(*args, **kwargs))
            return result

    return inner_wrapper

登录后复制

通过在execute装饰器中使用Callable[..., Result]注解返回类型，我们明确告知类型检查器，装饰后的函数将返回Result类型。这样，Pylance就能正确识别query_data_source函数的返回类型，从而消除警告。

此方法不仅能解决类型检查错误，还能提升代码的可读性和可维护性，方便其他开发者理解代码逻辑。

以上就是如何使用自定义装饰器避免Pylance类型检测错误？的详细内容，更多请关注php中文网其它相关文章！