我想很好地显示/打印我的sqlalchemy类。
在Is there a way to auto generate a __str__()
implementation in python?
中,答案You can iterate instance attributes using vars, dir, ...:...对于简单的类很有帮助。
当我尝试将其应用于Sqlalchemy
类(如
Introductory Tutorial of Python’s SQLAlchemy中的类-见下文)时,除成员变量之外,我还获得了以下条目作为成员变量:< / p>
_sa_instance_state=<sqlalchemy.orm.state.InstanceState object at 0x000000004CEBCC0>
如何避免该条目出现在__str__
表示形式中?
出于完整性考虑,我也将链接堆栈溢出问题的解决方案也放在下面。
import os
import sys
from sqlalchemy import Column, ForeignKey, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship
from sqlalchemy import create_engine
Base = declarative_base()
class Person(Base):
__tablename__ = 'person'
# Here we define columns for the table person
# Notice that each column is also a normal Python instance attribute.
id = Column(Integer, primary_key=True)
name = Column(String(250), nullable=False)
如上所述,这是Is there a way to auto generate a __str__
() implementation in python?的解决方案:
def auto_str(cls):
def __str__(self):
return '%s(%s)' % (
type(self).__name__,
', '.join('%s=%s' % item for item in vars(self).items())
)
cls.__str__ = __str__
return cls
@auto_str
class Foo(object):
def __init__(self, value_1, value_2):
self.attribute_1 = value_1
self.attribute_2 = value_2
已应用:
>>> str(Foo('bar', 'ping'))
'Foo(attribute_2=ping, attribute_1=bar)'
答案 0 :(得分:3)
这是我使用的:
def todict(obj):
""" Return the object's dict excluding private attributes,
sqlalchemy state and relationship attributes.
"""
excl = ('_sa_adapter', '_sa_instance_state')
return {k: v for k, v in vars(obj).items() if not k.startswith('_') and
not any(hasattr(v, a) for a in excl)}
class Base:
def __repr__(self):
params = ', '.join(f'{k}={v}' for k, v in todict(self).items())
return f"{self.__class__.__name__}({params})"
Base = declarative_base(cls=Base)
任何从Base
继承的模型都将定义默认的__repr__()
方法,如果我需要做不同的事情,我可以重写该特定类上的方法。
它从字符串中排除以下划线表示的任何私有属性,SQLAlchemy实例状态对象以及任何关系属性的值。我排除了关系属性,因为我通常不希望repr导致与延迟加载的关系,并且在关系是双向的情况下,包括关系属性可能导致无限递归。
结果如下:ClassName(attr=val, ...)
。
-编辑-
我上面提到的todict()
函数是一个帮助程序,我经常调用它来从SQLA对象构造一个dict
,主要用于序列化。我在这种情况下懒洋洋地使用它,但是它效率不高,因为它正在构造dict
(在todict()
中)来构造dict
(在__repr__()
中)。此后,我修改了模式以调用生成器:
def keyvalgen(obj):
""" Generate attr name/val pairs, filtering out SQLA attrs."""
excl = ('_sa_adapter', '_sa_instance_state')
for k, v in vars(obj).items():
if not k.startswith('_') and not any(hasattr(v, a) for a in excl):
yield k, v
然后,基本Base看起来像这样:
class Base:
def __repr__(self):
params = ', '.join(f'{k}={v}' for k, v in keyvalgen(self))
return f"{self.__class__.__name__}({params})"
todict()
函数也利用了keyvalgen()
生成器,但不再需要构造repr。
答案 1 :(得分:2)
我在基本模型上定义了此__repr__
方法:
def __repr__(self):
fmt = '{}.{}({})'
package = self.__class__.__module__
class_ = self.__class__.__name__
attrs = sorted((col.name, getattr(self, col.name)) for col in self.__table__.columns)
sattrs = ', '.join('{}={!r}'.format(*x) for x in attrs)
return fmt.format(package, class_, sattrs)
该方法以字母顺序显示表的所有列的名称(但不显示关系),以及其值的repr
。我通常不定义__str__
,除非我需要特定的格式-也许str(User(name='Alice'))
只是Alice
-因此str(model_instance)
将调用__repr__
方法。
import datetime
import sqlalchemy as sa
from sqlalchemy.ext import declarative
class BaseModel(object):
__abstract__ = True
def __repr__(self):
fmt = u'{}.{}({})'
package = self.__class__.__module__
class_ = self.__class__.__name__
attrs = sorted((c.name, getattr(self, c.name)) for c in self.__table__.columns)
sattrs = u', '.join('{}={!r}'.format(*x) for x in attrs)
return fmt.format(package, class_, sattrs)
Base = declarative.declarative_base(cls=BaseModel)
class MyModel(Base):
__tablename__ = 'mytable'
foo = sa.Column(sa.Unicode(32))
bar = sa.Column(sa.Integer, primary_key=True)
baz = sa.Column(sa.DateTime)
>>> mm = models.MyModel(foo='Foo', bar=42, baz=datetime.datetime.now())
>>> mm
models.MyModel(bar=42, baz=datetime.datetime(2019, 1, 4, 7, 37, 59, 350432), foo='Foo')