Skip to main content

Base with a `model_id` property for SQLAlchemy models

Project description

SQLAlchemy-ModelID provides a base for SQLAlchemy models with a model_id property. This conveniently distinguishes between models with the same primary key but from different tables.

Installation

$ pip install sqlalchemy-modelid

Quickstart

from sqlalchemy_modelid import ModelIdBase

# standard session creation
from sqlalchemy import create_engine, Column, Integer
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker, scoped_session

engine = create_engine('sqlite:///:memory:')
session_factory = sessionmaker(bind=engine)
Session = scoped_session(session_factory)
session = Session()
Base = declarative_base()

# subclass `ModelIdBase` to add a `model_id` property to any model
class Model(ModelIdBase, Base):
    __tablename__ = 'model'
    id = Column(Integer, primary_key=True)

# create the database
Base.metadata.create_all(engine)

# example
my_model = Model()
session.add(my_model)
session.commit()
my_model.model_id

Out:

model-1

Citation

@software{bowen2020sqlalchemy-modelid,
  author = {Dillon Bowen},
  title = {SQLAlchemy-ModelID},
  url = {https://dsbowen.github.io/sqlalchemy-modelid/},
  date = {2020-06-05},
}

License

Users must cite this package in any publications which use it.

It is licensed with the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlalchemy-modelid-0.0.3.tar.gz (2.1 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page