如何在SQLAlchemy中使用反射和描述性语法重写列名

Question

你好，我正在尝试把一个老旧的应用程序移植到Python，并使用SQLAlchemy。

这个应用程序的数据库里大约有300个表，每个表里都有一个叫做def的列，比如：

create table accnt (
    code varchar(20)
  , def varchar(50) --for accnt definition
  , ...
)

所以当我使用声明式语法和反射时，我可以很容易地创建我的类，如下：

class Accnt(Base):
    __table__ = Table('accnt', metadata, autoload = True, autoload_with=engine)

但是当我尝试访问这个def列时，最终会出现错误。例如：

q = session.query(Accnt)
for row in q:
    print q.def

因为def在Python中是一个保留字 :(

为了解决这个问题，我可以这样创建我的类：

class Accnt(Base):
    __table__ = Table('accnt', metadata, autoload = True, autoload_with=engine)
    __mapper_args__ = {'column_prefix':'_'}

但是在每个列名前加个下划线实在是太无聊了，也不够好看。

我想做的是用另一个名字来访问def列（或者说用一个键？）。

有没有什么好主意？

--- 编辑 ---

（根据TokenMacGuy的要求编辑原帖）

虽然我接受了TokenMacGuy的答案，但我之前也尝试过：

engine = create_engine('firebird://sysdba:masterkey@127.0.0.1/d:\\prj\\db2\\makki.fdb?charse‌​t=WIN1254', echo=False) 
metadata = MetaData() 
DbSession = sessionmaker(bind=engine) 
Base = declarative_base() 

class Accnt(Base):
    __table__ = Table('accnt', metadata, autoload = True, autoload_with=engine) 
    _def = Column("def", String(50))

结果我得到了 sqlalchemy.exc.ArgumentError: Can't add additional column 'def' when specifying table的错误。

我和TokenMacGuy之间的主要区别是

mine       : _table_ ....
TokenMcGuy : __tablename__ = 'accnt'
             __table_args__ = {'autoload': True}

还有元数据绑定...

那么，为什么我之前的尝试会产生错误呢？

Answer 1

这可能有点简单粗暴，但还有另一种方法，就是使用 sqlacodegen 这个库来自动生成你数据库的所有模型。生成后你可以手动修改这些模型，或者调整 sqlacodegen 让它按照你的习惯来生成模型。这个工具支持把一些保留字映射到其他符号。

可以查看一下这个链接：https://pypi.python.org/pypi/sqlacodegen。这是个不错的工具。

Answer 2

你可以这样定义你的表格：

mymetadata = MetaData()
Base = declarative_base(metadata=mymetadata)

class Accnt(Base):
    __tablename__ = 'accnt'

    code = Column(String(20))
    def_ = Column(String(50))

Answer 3

你可以两全其美。先定义你想要重命名的列；sqlalchemy会自动处理你没有提到的其他列。

>>> from sqlalchemy import *
>>> from sqlalchemy.ext.declarative import declarative_base
>>> 
>>> engine = create_engine("sqlite:///:memory:")
>>> 
>>> engine.execute("""
... create table accnt (
...     id integer primary key,
...     code varchar(20),
...     def varchar(50)
... )
... """)
<sqlalchemy.engine.base.ResultProxy object at 0x2122750>
>>> 
>>> Base = declarative_base()
>>> 
>>> Base.metadata.bind = engine
>>> 
>>> class Accnt(Base):
...     __tablename__ = 'accnt'
...     __table_args__ = {'autoload': True}
...     def_ = Column('def', String)
... 
>>> Accnt.def_
<sqlalchemy.orm.attributes.InstrumentedAttribute object at 0x2122e90>
>>> Accnt.code
<sqlalchemy.orm.attributes.InstrumentedAttribute object at 0x2127090>
>>> 

编辑：

通过提供一个 __table__ 参数，你是在告诉声明扩展，你已经有一个配置好的 Table，想要使用它。但其实并不是这样；你想在类中用另一个名字来引用 def 列。使用 __tablename__ 和 __table_args__，你可以推迟表的构建，直到你告诉声明你想如何使用这个表。如果你坚持使用 __table__，就没有优雅的解决办法。你可以提供一个 property 来给列起个别名，或者你可以这样指定列：_def = getattr(__table__.c, 'def')。

其实，你应该直接使用 __tablename__；这样更方便也更灵活，这就是一个很好的例子。

（顺便说一下，通常给替代标识符加个尾部下划线，而不是前面加下划线，应该用 def_ 而不是 _def；前面的下划线通常表示这个名字是“私有的”或“实现细节”，如果这个名字本来是公开的，但看起来像个私有名字，可能会引起不必要的混淆。）