Question

我不知道sqlalchemy查询返回哪种对象。

entries = session.query(Foo.id, Foo.date).all()

条目中每个对象的类型似乎是sqlalchemy.util._collections.result，但是python解释器中的快速from sqlalchemy.util._collections import result会引发ImportError。

我最终想要做的是键入提示此功能：

def my_super_function(session: Session) -> ???:
    entries = session.query(Foo.id, Foo.date).all()
    return entries

我应该用什么来代替???？ mypy（在这种情况下）似乎可以与List[Tuple[int, str]]一起使用，因为是的，确实可以访问我的条目，就像它们是元组一样，但是例如，我也可以使用entry.date访问它们。

Answer 1

我也很好奇无法导入该类。答案是相当长的，只要我向您介绍了我的工作方式，请忍受。

Query.all()在list()对象本身上调用Query：

def all(self):
    """Return the results represented by this ``Query`` as a list.
    This results in an execution of the underlying query.
    """
    return list(self)

... list将遍历该对象，因此Query.__iter__()：

def __iter__(self):
    context = self._compile_context()
    context.statement.use_labels = True
    if self._autoflush and not self._populate_existing:
        self.session._autoflush()
    return self._execute_and_instances(context)

...返回Query._execute_and_instances()方法的结果：

def _execute_and_instances(self, querycontext):
    conn = self._get_bind_args(
        querycontext, self._connection_from_session, close_with_result=True
    )

    result = conn.execute(querycontext.statement, self._params)
    return loading.instances(querycontext.query, result, querycontext)

执行查询并返回sqlalchemy.loading.instances()函数的结果。在该函数中，有this line适用于非单实体查询：

keyed_tuple = util.lightweight_named_tuple("result", labels)

...，如果我在该行之后插入print(keyed_tuple)，它会打印<class 'sqlalchemy.util._collections.result'>，这就是您上面提到的类型。因此，无论该对象是什么，它都来自sqlalchemy.util._collections.lightweight_named_tuple()函数：

def lightweight_named_tuple(name, fields):
    hash_ = (name,) + tuple(fields)
    tp_cls = _lw_tuples.get(hash_)
    if tp_cls:
        return tp_cls

    tp_cls = type(
        name,
        (_LW,),
        dict(
            [
                (field, _property_getters[idx])
                for idx, field in enumerate(fields)
                if field is not None
            ]
            + [("__slots__", ())]
        ),
    )

    tp_cls._real_fields = fields
    tp_cls._fields = tuple([f for f in fields if f is not None])

    _lw_tuples[hash_] = tp_cls
    return tp_cls

所以关键部分是this statement：

tp_cls = type(
    name,
    (_LW,),
    dict(
        [
            (field, _property_getters[idx])
            for idx, field in enumerate(fields)
            if field is not None
        ]
        + [("__slots__", ())]
    ),
)

...会根据文档调用内置的type()类：

带有三个参数，返回一个新的类型对象。这本质上是类语句的动态形式。

这就是为什么您不能导入类sqlalchemy.util._collections.result的原因-因为该类仅在查询时构造。我想说这是因为直到执行查询才知道列名（即命名的元组属性）。

从python docs到type的签名是：type(name, bases, dict)其中：

名称字符串是类名称，并成为__name__属性；基元组逐项列出基类，并成为__bases__ 属性;字典字典是包含以下内容的名称空间类主体的定义，并复制到标准字典中以成为__dict__属性。

如您所见，在bases中传递给type()的{{1}}自变量是lightweight_named_tuple()。因此，任何动态创建的命名元组类型都继承自sqlalchemy.util._collections._LW，这是您可以导入的类：

(_LW,)

...因此，我不确定将函数键入带有下划线的内部类是否是一种好形式，但是from sqlalchemy.util._collections import _LW entries = session.query(Foo.id, Foo.date).all() for entry in entries: assert isinstance(entry, _LW) # True继承自_LW，而sqlalchemy.util._collections.AbstractKeyedTuple本身继承自{{1 }}。这就是为什么您当前输入tuple的原因，因为它是元组列表。因此，选择List[Tuple[int, str]]，_LW，AbstractKeyedTuple都是对函数返回值的正确表示。

键入提示sqlalchemy查询结果

1 个答案: