简介
使用Python/MyPy类型的提示,可以使用.pyi存根将注释保存在实现的单独文件中。我使用这个功能来提供SQLAlchemy的ORM的基本提示(更具体地说,flask_sqlalchemy插件)。在
模型的定义如下:class MyModel(db.Model):
id = db.Column()
...
...
其中db.Model直接来自SQLAlchemy。
例如,可以通过以下方式查询:
^{pr2}$
其中filter()返回另一个Query,one_or_none()返回{}(或者{})的一个实例。在
{5}虽然上面的提示是不完整的,但是返回的提示是不完整的。在class _SQLAlchemy(sqlalchemy.orm.session.Session):
class Model:
query = ... # type: _Query
class _Query(sqlalchemy.orm.query.Query):
def filter(self, *args) -> query.Query: ...
def one_or_none(self) -> Any: ...
db = ... # type: _SQLAlchemy
问题
如何才能完整而通用地提示上述内容,并提示返回类型one_or_none()?
我的第一次尝试是使用泛型,但看起来我无法访问所讨论的子类型(在给定的示例中,MyModel)。要说明非工作方法:from typing import Generic, TypeVar
_T = TypeVar('_T')
class _SQLAlchemy(sqlalchemy.orm.session.Session):
class Model:
def __init__(self, *args, **kwargs):
self.query = ... # type: _Query[self.__class__]
class _Query(Generic[_T], sqlalchemy.orm.query.Query):
def filter(self, *args) -> _Query[_T]: ...
def one_or_none(self) -> _T: ...
db = ... # type: _SQLAlchemy
有没有办法让这个工作起来?在
很抱歉这个具体的例子,但是我试着用一个普通的例子来简洁地写这篇文章,但是它从来没有像现在这样清楚(这可能还是不多!)在
编辑
另一种非工作方法(我知道这将有一个必须调用myModelInstance.query)的限制。。。而不是静态的MyModel.query,但即使这样也不行):from typing import Generic, TypeVar
_T = TypeVar('_T')
class _SQLAlchemy(sqlalchemy.orm.session.Session):
class Model:
@property
def query(self: _T) -> _Query[_T]: ...
class _Query(Generic[_T], sqlalchemy.orm.query.Query):
def filter(self, *args) -> _Query[_T]: ...
def one_or_none(self) -> _T: ...
db = ... # type: _SQLAlchemy