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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9428ad582664bf545070d531ebe82f97d6f866a32c5a7284c20eef09eadde4e6 |
|
MD5 | 3664bc4dd653d089066448e59cb67cff |
|
BLAKE2b-256 | adb18eb2a1641a08af84fa79f2e2585e226336d4958ec923dda3be3d4149fa45 |
Close
Hashes for sqlalchemy_state_machine-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b05f5ec0f863e4295a6a768f12c8850910a3b9c94432e4741064fb85ceffff5f |
|
MD5 | 63aa6470d60e201aa1360ee14f2d1d74 |
|
BLAKE2b-256 | 7174b88f984f758d2abc32cf561596491b0697b7fefa908e263d5038ed0698c9 |