Automatically generates pretty repr of a SQLAlchemy model.
Project description
Automatically generates pretty repr of a SQLAlchemy model.
Install
pip install sqlalchemy-repr
Usage
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy_repr import RepresentableBase
Base = declarative_base(cls=RepresentableBase)
Example
sqlalchemy_repr.RepresentableBase is mixin to add simple representation of columns.
>>> from datetime import datetime
>>> from sqlalchemy import Column, DateTime, Integer, Unicode, create_engine
>>> from sqlalchemy.ext.declarative import declarative_base
>>> from sqlalchemy.orm import sessionmaker
>>> from sqlalchemy_repr import RepresentableBase
>>> Base = declarative_base(cls=RepresentableBase)
>>> class User(Base):
... __tablename__ = 'users'
... id = Column(Integer, primary_key=True)
... name = Column(Unicode(255), nullable=False, unique=True)
... created = Column(DateTime, nullable=False)
>>> engine = create_engine('sqlite://')
>>> Base.metadata.create_all(engine)
>>> Session = sessionmaker(bind=engine)
>>> session = Session()
>>> user = User(name='spam', created=datetime(2016, 6, 1))
>>> session.add(user)
>>> session.commit()
>>> print(user)
<User id=1, name='spam', created=datetime.datetime(2016, 6, 1, 0, 0)>
sqlalchemy_repr.PrettyRepresentableBase brings pretty, indented multi-line representation.
>>> from sqlalchemy_repr import PrettyRepresentableBase
>>> Base = declarative_base(cls=PrettyRepresentableBase)
>>> class User(Base):
... __tablename__ = 'users'
... id = Column(Integer, primary_key=True)
... first_name = Column(Unicode(255), nullable=False, unique=True)
... last_name = Column(Unicode(255), nullable=False, unique=True)
... email = Column(Unicode(255), nullable=False)
... created = Column(DateTime, nullable=False)
... modified = Column(DateTime, nullable=False)
>>> engine = create_engine('sqlite://')
>>> Base.metadata.create_all(engine)
>>> Session = sessionmaker(bind=engine)
>>> session = Session()
>>> user = User(first_name='spam', last_name='ham', email='spam@example.com', created=datetime(2016, 6, 1), modified=datetime(2016, 6, 1))
>>> session.add(user)
>>> session.commit()
>>> print(user)
<User
id=1,
first_name='spam',
last_name='ham',
email='spam@example.com',
created=datetime.datetime(2016, 6, 1, 0, 0),
modified=datetime.datetime(2016, 6, 1, 0, 0)>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sqlalchemy-repr-0.0.1.tar.gz
(4.5 kB
view hashes)
Built Distributions
Close
Hashes for sqlalchemy-repr-0.0.1.linux-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab0671736ffcd0aa098333ae1e2a43f97730858a611736cbe39128a074bd1af4 |
|
MD5 | 2711f523fc5d7a69855667db932537a5 |
|
BLAKE2b-256 | 6548b32d3843c3c7d7e695a71f46d6d81ff8fc8c544d96c9328e27549a6daf3c |