Skip to main content

A safe, pure-Python finite state machine with colored terminal logging

Project description

StateLogic

StateLogic doesn’t just manage state. It protects it.

A pure, safe, and elegant finite state machine for Python — with colored terminal logging.

PyPI Tests License

StateLogic is a lightweight, dependency-free finite state machine library that enforces correctness by design.

It was born from frustration with existing FSM libraries that allow invalid states, silent failures, or require complex boilerplate. StateLogic fixes all of that — and adds beautiful colored logging as a bonus.

Design Philosophy — Why StateLogic Is Different (and Better)

"A state machine must never lie about its state."

StateLogic is built on four unbreakable principles:

1. The current state can only be changed via a valid, registered transition

Direct assignment like fsm.state("HACKED") is silently ignored if the state is not part of a defined transition.
This prevents bugs, race conditions, and security issues in critical systems.

2. You cannot set an initial state before defining transitions

fsm = StateLogic()
fsm.state("SOLID")        # → Does nothing (no transitions defined yet)
fsm.state()               # → None

Only after you define at least one transition are states considered "valid":

fsm.transition("melts", "SOLID", "LIQUID")
fsm.state("SOLID")        # → Now allowed

3. Invalid transitions are impossible — not just undetected

If you try to go from GASSOLID without defining that path, nothing happens.
No exception (unless you want one), no silent success — just correctness.

4. Hooks are first-class: before, on, and after

fsm.before("melts", lambda: input("Melt? ") == "Y")
fsm.on("melts", lambda: print("Melting started..."))
fsm.after("melts", lambda: print("Now it's water!"))

This isn't just convenience — it's enforced lifecycle safety.

These rules make StateLogic ideal for:

  • Embedded systems
  • Game logic
  • Workflow engines
  • Protocol implementations
  • Any domain where state corruption is unacceptable

Installation

pip install statelogic

Quick Example

from statelogic import StateLogic

s = StateLogic()
s.author("Wilgat").appName("WaterFSM").majorVersion(1)

# Define valid physics
s.transition("freeze",     "LIQUID", "SOLID")
s.transition("melts",      "SOLID",  "LIQUID")
s.transition("evaporate",  "LIQUID", "GAS")
s.transition("condense",   "GAS",    "LIQUID")

# Try to cheat physics
s.state("PLASMA")          # → Ignored. Still None.
print(s.state())           # → None

# Now play by the rules
s.transition("sublimate", "SOLID", "GAS")  # Define the edge case
s.state("SOLID")           # → Now allowed
s.sublimate()
print(s.state())           # → GAS

s.infoMsg("Sublimation complete!", "SCIENCE")

Output (with colors):

2025-12-02 10:30:45.123456 WaterFSM(v1.0.0)  [SCIENCE]: 
  Sublimation complete!

Features

  • Zero dependencies
  • Python 2.7 and 3.6+ compatible
  • Beautiful colored terminal logging (infoMsg, safeMsg, criticalMsg)
  • Full hook system: before, on, after
  • Dynamic attributes via Attr class
  • Signal handling (Ctrl+C → graceful exit)
  • Shell & environment utilities
  • 100% test coverage

Hook Examples

before — Guard transitions

def confirm():
    return input("Proceed? (y/n): ").lower() == "y"

s.before("launch", confirm)
s.launch()   # Only runs if user says yes

on — React immediately

s.on("error", lambda: s.criticalMsg("System failure!", "ALERT"))

after — Cleanup or notify

s.after("shutdown", lambda: s.safeMsg("System offline.", "BYE"))

Project Links

License

MIT © Wilgat


StateLogic doesn’t just manage state. It protects it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

statelogic-1.2.0.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

statelogic-1.2.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file statelogic-1.2.0.tar.gz.

File metadata

  • Download URL: statelogic-1.2.0.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for statelogic-1.2.0.tar.gz
Algorithm Hash digest
SHA256 ad13faf3a8f9ac2e4f25215fe7c1b4ca9a4ff1de9421e122aa2dc733bc03f30e
MD5 4580fafe95523b896602661274fcaccb
BLAKE2b-256 cbcf2c645fa88e0aeca7070d3073238f33ba21b8580f9e1d1b3fed9fb328798b

See more details on using hashes here.

File details

Details for the file statelogic-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: statelogic-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for statelogic-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0c5771388c8c0aa7e2c9e715204714d4e62f3ac211b11eb7c0ca1636b6bb925d
MD5 ab3fe514d5654252d741f77e52aebc24
BLAKE2b-256 31bfe9d6016e4dc72fe021cb7c3a3f3067d370a2f2da1e20b787cc97619f67ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page