Início / coding / Perguntas / 79562882
Accepted
Alice Yu
Asked: 2025-04-09 03:12:21 +0800 CST

Como digitar corretamente um decorador Python com ParamSpec e Concatenate que permite posicionamento arbitrário de argumentos?

  • 772

Tenho um decorador Python que garante que um método receba uma instância de AsyncConnection do psycopg. Estou tentando atualizar a tipagem para usar ParamSpece, Concatenatecomo a implementação atual não é segura para tipagem, estou travando.

Aqui está a implementação atual:

def ensure_conn(func: Callable[..., Coroutine[Any, Any, R]]) -> Callable[..., Coroutine[Any, Any, R]]:
    """Ensure the function has a conn argument. If conn is not provided, generate a new connection and pass it to the function."""

    async def wrapper(*args: Any, **kwargs: Any) -> R:
        # Get named keyword argument conn, or find an AsyncConnection in the args
        kwargs_conn = kwargs.get("conn")
        conn_arg: AsyncConnection[Any] | None = None
        if isinstance(kwargs_conn, AsyncConnection):
            conn_arg = kwargs_conn
        elif not conn_arg:
            for arg in args:
                if isinstance(arg, AsyncConnection):
                    conn_arg = arg
                    break
        if conn_arg:
            # If conn is provided, call the method as is
            return await func(*args, **kwargs)
        else:
            # If conn is not provided, generate a new connection and pass it to the method
            db_driver = DbDriver()
            async with db_driver.connection() as conn:
                return await func(*args, **kwargs, conn=conn)

    return wrapper

Uso atual:

@ensure_conn
async def get_user(user_id: UUID, conn: AsyncConnection):
    async with conn.cursor() as cursor:
    // do stuff

...mas posso chamar isso e não falhará na verificação de tipos:

get_user('519766c5-af86-47ea-9fa9-cee0c0de66b1', conn, arg_that_should_fail_typing)

Aqui está a implementação atual mais próxima que cheguei com ParamSpecand Concatenate:

def ensure_conn_decorator[**P, R](func: Callable[Concatenate[AsyncConnection[Any], P], R]) -> Coroutine[Any, Any, R]:
    """Ensure the function has a conn argument. If conn is not provided, generate a new connection and pass it to the function."""
    async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
        # Get named keyword argument conn, or find an AsyncConnection in the args
        kwargs_conn = kwargs.get("conn")
        conn_arg: AsyncConnection[Any] | None = None
        if isinstance(kwargs_conn, AsyncConnection):
            conn_arg = kwargs_conn
        elif not conn_arg:
            for arg in args:
                if isinstance(arg, AsyncConnection):
                    conn_arg = arg
                    break
        if conn_arg:
            # If conn is provided, call the method as is
            return await func(*args, **kwargs)
        else:
            # If conn is not provided, generate a new connection and pass it to the method
            db_driver = DbDriver()
            async with db_driver.connection() as conn:
                return await func(*args, **kwargs, conn=conn)

    return wrapper

Os problemas são

  • Conn deve ser o primeiro argumento do método em vez de ter uma posição arbitrária - geralmente é o último argumento após um número X arbitrário de argumentos
  • Não consigo descobrir o tipo de retorno adequado
Expression of type "(**P@ensure_conn_decorator) -> Coroutine[Any, Any, R@ensure_conn_decorator]" is incompatible with return type "Coroutine[Any, Any, R@ensure_conn_decorator]"
  "function" is incompatible with "Coroutine[Any, Any, R@ensure_conn_decorator]"
python

1 respostas

  1. Best Answer

    Primeiramente, algumas notas sobre as limitações de ParamSpece Concatenate:

    • Concatenateexige que você sempre coloque o argumento que deve ser usado primeiro na lista, e o argumento final deve ser o ParamSpec.

    • Uma boa maneira de pensar sobre isso é que o wrapper "consome" o primeiro argumento e sempre espera uma função que tenha uma determinada estrutura.

    O exemplo abaixo verifica bem o tipo para mim em Pyright/Pylance, mas notavelmente não em MyPy. Notei que alguns dos recursos mais recentes são mais confiáveis ​​em Pyright, como o ParamSpec. Introduzi algumas classes para verificar todas as verificações de tipo — e o tipo de retorno "out" Userparece estar correto:

    import asyncio
from typing import Any, Callable, Concatenate, Coroutine, cast
import contextlib
from uuid import UUID

@contextlib.asynccontextmanager
async def aclosing():
    try:
        yield AsyncConnection()
    finally:
        pass

class AsyncConnection[T]:
    def cursor(self):
        return aclosing()

class DbDriver:
    def connection(self):
        return aclosing()

def ensure_conn[R, **P](func: Callable[Concatenate[AsyncConnection[Any], P], Coroutine[Any, Any, R]]) -> Callable[P, Coroutine[Any, Any, R]]:
    """Ensure the function has a conn argument. If conn is not provided, generate a new connection and pass it to the function."""

    async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
        # Get named keyword argument conn, or find an AsyncConnection in the args
        kwargs_conn = kwargs.get("conn")
        conn_arg: AsyncConnection[Any] | None = None
        if isinstance(kwargs_conn, AsyncConnection):
            conn_arg = kwargs_conn
        elif not conn_arg:
            for arg in args:
                if isinstance(arg, AsyncConnection):
                    conn_arg = arg
                    break
        if conn_arg:
            # If conn is provided, call the method as is
            return await func(conn_arg, *args, **kwargs)
        else:
            # If conn is not provided, generate a new connection and pass it to the method
            db_driver = DbDriver()
            async with db_driver.connection() as conn:
                return await func(conn, *args, **kwargs)

    return wrapper

class User:
    def __init__(self, uuid: UUID) -> None:
        self.uuid=uuid

@ensure_conn
async def get_user(conn: AsyncConnection, user_id: UUID):
    async with conn.cursor() as cursor:
        return User(user_id)

async def main():
    uuid: UUID = cast(UUID, '519766c5-af86-47ea-9fa9-cee0c0de66b1')
    out = await get_user(uuid)

asyncio.run(main())

    Espero que isso ajude!

    • 1

relate perguntas