Opinionated utilities for working with SQLAlchemy
Project description
sqla-utils
Opinionated utilities for working with SQLAlchemy
Contents
Transaction Wrapper
FIXME
DBObjectBase
DBObjectBase is a base class for mapped classes.
Example:
from datetime import datetime
from sqlalchemy import Column, DateTime, Integer, String
from sqla_utils import DBObjectBase, Transaction
class DBAppointment(DBObjectBase):
__tablename__ = "appointments"
id = Column(Integer, primary_key=True)
date = Column(DateTime, nullable=False)
description = Column(String(1000), nullable=False, default="")
Appointment items can then be queried like this:
from sqla_utils import begin_transaction
with begin_transaction() as t:
app123 = DBAppointment.fetch_by_id(t, 123)
great_apps = DBAppointment.fetch_all(t, DBAppointment.description.like("%great%"))
It is recommended to add custom query, creation, and update methods:
class DBAppointment(DBObjectBase):
...
@classmethod
def create(cls, t: Transaction, date: datetime, description: str) -> DBAppointment:
o = cls()
o.date = date
o.description = description
t.add(o)
return o
@classmethod
def fetch_all_after(cls, t: Transaction, date: datetime) -> List[DBAppointment]:
return cls.fetch_all(t, cls.start >= dates.start)
def update_description(self, t: Transaction, new_description: str) -> None:
self.description = new_description
t.changed(self)
Database Builder
FIXME
pytest Utilities
The sqla_utils.test module contains a few utilities for working with pytest and SQLAlchemy.
FIXME
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
sqla_utils-0.4.1.tar.gz
(12.5 kB
view details)
Built Distribution
File details
Details for the file sqla_utils-0.4.1.tar.gz.
File metadata
- Download URL: sqla_utils-0.4.1.tar.gz
- Upload date:
- Size: 12.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.1 CPython/3.9.2 Linux/5.10.0-20-amd64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3621ab45f94bf5dccf150f0988daae6733f5640a3a09f39b510b41c13c339665 |
|
| MD5 | 0605bae25d147dc7417e08fa80bc317d |
|
| BLAKE2b-256 | 79fcea7903977594d67186c9bed8655cc2228e91f2aa66050fb9364ac83faa70 |
File details
Details for the file sqla_utils-0.4.1-py3-none-any.whl.
File metadata
- Download URL: sqla_utils-0.4.1-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.1 CPython/3.9.2 Linux/5.10.0-20-amd64
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 23b74918291e1d7660b48950ca8678d84090cd840b975924bd4d443100d05911 |
|
| MD5 | 040e97ed020a14fa4808a705616e0452 |
|
| BLAKE2b-256 | dea9314fc22013510528ea762be3274486e6dcaf0ccd0187d106b120f946251a |
