[State Transition Systems][1] have less constraints than Finite State
Automata, and can be utilized for various use cases.
The core components include:
- State
- Event
- Transition
- System
**Events** cause a **transition** from some **state** to a new state within
a given **system**.
The API supports defining _immediate_ transitions and _long-running_
transitions. Now, for a riveting example..
```python
system = System(name='Example 1')
system.save()
# Immediate transition.. event => state
system.transition('Door Opened', event='Open Door')
# 'Long-running' transitions.. event happens
system.start_transition('Close Door Slowly')
# Time passes..
time.sleep(2)
# The resulting state..
system.end_transition('Door Closed')
```
To remove the boilerplate from the above example, use the `transition`
context manager instead:
```python
from sts.contextmanagers import transition
with transition('Example 1', 'Door Closed', event='Close Door Slowly'):
time.sleep(2)
```
A model object can be associated directly with a `System` using Django's
ContentTypes framework generic foreign keys.
```python
door = Door.objects.get(name='Door #1')
system = System(content_object=door)
# ...
```
`System` objects have a few extra conveniences:
```python
# number of transitions
len(system) == system.length
# iteration starting with the first transition
for trans in system:
...
# indexing and slices
system[:3] # first 3 transitions
system[-3:] # last 3 transitions
system[:-3] # all except the last 3 transitions
system[1:3] # arbitrary slice
system[2] # specific transition
```
This enables bringing in django-sts to an existing model to begin tracking
states of objects.
It even comes with an abstract `STSModel` that augments a model with the above
methods for seamless integration (it does not add any model fields):
```python
class Door(STSModel):
name = models.CharField(max_length=20)
door = Door()
door.save()
door.transition('Door Closed', event='Close Door')
```
The library leaves it up to the application to implement the constraints of a
finite state automata/machine.
[1]: http://en.wikipedia.org/wiki/State_transition_system
Metadata
Release files for django-sts 0.7.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-sts-0.7.3.tar.gz | 14.0 kB | Without provenance | Details for django-sts-0.7.3.tar.gz |
Release files / django-sts-0.7.3.tar.gz
| Download URL | django-sts-0.7.3.tar.gz |
|---|---|
| Size | 14.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
539c6721c377355b377b3df5bd2249b61035c8c30352cd294b3ff8895e5f3b19
|
|
BLAKE2b-256 checksum How to use checksums |
c3dd5d29c7b7e7685bebcae9cefaa90d171799bf985ca472504d54cdb0ba5a3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for django-sts 0.7.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.