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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b41a9dc33da529b743b086137e1c98acfa3d4adc7ddd5c6f4bfd26f40752386c |
|
MD5 | 615c67fecc30c16399336c8edfcbc440 |
|
BLAKE2b-256 | 8fd91f621be356a19bab1aea761175d2759d1c9ed025794825f32863fee3b544 |
Close
Hashes for sqlalchemy_state_machine-1.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1033ca078bbf1878adb756dcac242aca85619465f1a4fef004fcc0ebc6395955 |
|
MD5 | 98aeb9633e73401548d5a25b1c825649 |
|
BLAKE2b-256 | 62e066fc74734e5f4f12ae4095cabae51a46d7e60e283c2f94ace3d05e92dcd4 |