Welcome to PySS’s documentation!

Python Statechart Simulator for Python >=3.4

Overview

PySS provides a set of tools related to statechart manipulation and execution. In particular, PySS provides:

• An easy way to define and to import statecharts with YAML
• Discrete, step-by-step, fully observable statechart simulation (SCXML semantic, can be easily tuned!)
• Built-in support for statechart Python code (can be easily extended to other languages)
• A framework for statechart-based testing

PySS has a complete support for simple state, composite state, orthogonal (parallel) state, initial state, final state, history state (including shallow and deep semantics), internal transition, guarded transition, eventless transition, statechart entry action, state entry action, state exit action, transition action, internal and external events and parametrized events.

Contents

• Quickstart
  • Installation
  • Statechart in YAML
  • Statechart execution
• Defining statecharts
  • Defining statecharts in YAML
  • Defining statecharts in Python
• Executing statecharts
  • Statechart semantic
  • Using Simulator
  • Macro and micro steps
  • Advanced uses
• Code contained in statecharts
  • Code evaluator
  • Built-in Python code evaluator
  • Examples
• Testing statecharts with statecharts
  • How to write tests?
  • The testing module
  • Executing tests
  • Integrating with unittest
• Command-line interface
  • Subcommand: execute
  • Subcommand: validate
  • Subcommand: test
  • Parametrized events

Source code

The source code is available on GitHub: https://github.com/AlexandreDecan/PySS

You can use GitHub integrated services to contribute or to report bugs and suggestions.