Helper for add transitions functionality in sqlalchemy
Project description
sqlalchemy-state-machine
sqlalchemy-state-machine is a helper for add transitions functionality in sqlalchemy.
Installation
sqlalchemy-state-machine is available on PyPI. Use pip to install:
$ pip install sqlalchemy-state-machine
Basic Usage
import sqlalchemy as sa
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy_state_machine import StateConfig, StateMixin
Base = declarative_base()
NEW = "new"
SENT = "sent"
FAILED = "failed"
class Event(Base, StateMixin):
__tablename__ = "users"
state_config = StateConfig(
initial=NEW,
states=[NEW, SENT, FAILED],
transitions=[
["set_sent", NEW, SENT],
["set_failed", NEW, FAILED],
],
)
id = sa.Column(sa.Integer, primary_key=True)
name = sa.Column(sa.String)
status = sa.Column(sa.String(), nullable=False, index=True)
sa.event.listen(Event, "init", Event.init_state_machine)
sa.event.listen(Event, "load", Event.init_state_machine)
event = Event(name="Event1")
assert event.status == NEW
assert event.set_sent()
assert event.status == SENT
License
sqlalchemy-state-machine is developed and distributed under the Apache 2.0 license.
Reporting a Security Vulnerability
See our security policy.
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
Built Distribution
Close
Hashes for sqlalchemy-state-machine-1.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f7971907d699269cdbbc7e93a1f483b80bf6780d31c87bf7fa1bea5ff332e95 |
|
MD5 | aa0c3b646417d75f6adaa1e8360a6a81 |
|
BLAKE2b-256 | 95bb373f755172af805ea3d24550c7921e171415bb2408e0f2552041a0b44a93 |
Close
Hashes for sqlalchemy_state_machine-1.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73d68d77d569ae219cd9416332a82d729e55e4aaa3522d5802522adb50910745 |
|
MD5 | 449f1c171db820e7b5071bb4ff951c00 |
|
BLAKE2b-256 | 37f723d9794f22838a7dd5c9f0f54e6053ea89b52efcab59702a07f14536c5df |