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.6.0.tar.gz
(12.4 kB
view details)
Built Distribution
File details
Details for the file sqla_utils-0.6.0.tar.gz.
File metadata
- Download URL: sqla_utils-0.6.0.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.4 Linux/6.2.0-33-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 192f3a15b187239d55edc601ef08078e5c3ac2afe53c8e2589759cb21650f799 |
|
| MD5 | eafe107eb5108e8d082181c5324dcb8b |
|
| BLAKE2b-256 | f61b1e52ac952467cd2aa99a580d95cdebe3635e608ad60487d87b14d31bac75 |
File details
Details for the file sqla_utils-0.6.0-py3-none-any.whl.
File metadata
- Download URL: sqla_utils-0.6.0-py3-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.4 Linux/6.2.0-33-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4fc4a7db7286b4cbe86eba0c222b2826981d884341a9451b3e11105374cc6bd6 |
|
| MD5 | 39515c575bcab0f4478a64fd7f10b0f0 |
|
| BLAKE2b-256 | 0973f26e4992ccd86c67405f8f8150b8857a623c194be3de89400dd20a8f530f |
