SQLAlchemy：混合值对象，查询元组结果

Question

我正在尝试遵循构建 custom 的文档中的示例使用混合值对象的比较器，

class CaseInsensitiveWord(Comparator):
    "Hybrid value representing a lower case representation of a word."

    def __init__(self, word):
        if isinstance(word, basestring):
            self.word = word.lower()
        elif isinstance(word, CaseInsensitiveWord):
            self.word = word.word
        else:
            self.word = func.lower(word)

    def operate(self, op, other):
        if not isinstance(other, CaseInsensitiveWord):
            other = CaseInsensitiveWord(other)
        return op(self.word, other.word)

    def __clause_element__(self):
        return self.word

    def __str__(self):
        return self.word

    key = 'word'
    "Label to apply to Query tuple results"

但是，我不明白为什么将其添加到类定义的末尾：

key = 'word'
"Label to apply to Query tuple results"

这是做什么的？

Answer 1

虽然它不是一个完全成熟的 Python 功能，但约定是以与函数和方法相同的方式注释属性，即通过在属性下方放置一个字符串。像上面这样的评论会被 Sphinx 等工具接收。您可以在 http://www.sqlalchemy.org/docs/orm/mapper_config.html#sqlalchemy.orm.mapper.Mapper.class_manager。

编辑：哦为什么它有一个实际的“.key”。当您说：

for row in session.query(MyClass.mycustomthing, MyClass.myothercustomthing):
   print row.word, row.someotherword

“word”和“someotherword”元组键是每个比较器上“.key”的值。如果你要对其调用 label() ，则会将其更改为其他内容。我不知道那是绝对必要的。