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.3.0.tar.gz
(12.0 kB
view details)
Built Distribution
File details
Details for the file sqla-utils-0.3.0.tar.gz.
File metadata
- Download URL: sqla-utils-0.3.0.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.26.0 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e093f6c2c45d58ecea302df47df7476bf38a4067eb9633a582fe376a23e803be |
|
| MD5 | fdd888d6cb055e81c5386124b5173850 |
|
| BLAKE2b-256 | 1b6bed54cb14b5637755be688e5ba5f2aff6c844ab61b7a1adf733547ede992b |
File details
Details for the file sqla_utils-0.3.0-py3-none-any.whl.
File metadata
- Download URL: sqla_utils-0.3.0-py3-none-any.whl
- Upload date:
- Size: 13.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.4.2 requests/2.26.0 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 22ce84feb5ef18efbb6ebb9c40e9cf3cedccc0977b48fd9d5d10d790f330e03e |
|
| MD5 | 7a8dc4c2eb3d810cd870a78ac0a27fd1 |
|
| BLAKE2b-256 | cda145e4beedeb25c37462d0895a39a9e7a291fac4dd8e927cacec51eaa4b7b3 |
