Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zigrazor/pystatemachine
Python State Machine
https://github.com/zigrazor/pystatemachine
deepsource framework hacktoberfest hacktoberfest-accepted hacktoberfest2022 progess python python-3 python-state-machine python3 star state-machine state-machines
Last synced: 2 months ago
JSON representation
Python State Machine
- Host: GitHub
- URL: https://github.com/zigrazor/pystatemachine
- Owner: ZigRazor
- License: gpl-3.0
- Created: 2021-03-23T14:49:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-06T07:35:14.000Z (about 2 years ago)
- Last Synced: 2024-10-10T20:51:57.612Z (3 months ago)
- Topics: deepsource, framework, hacktoberfest, hacktoberfest-accepted, hacktoberfest2022, progess, python, python-3, python-state-machine, python3, star, state-machine, state-machines
- Language: Python
- Homepage:
- Size: 60.5 KB
- Stars: 8
- Watchers: 2
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PyStateMachine
Python State Machine
[](https://www.codefactor.io/repository/github/zigrazor/pystatemachine)
[](https://www.codacy.com/gh/ZigRazor/PyStateMachine/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ZigRazor/PyStateMachine&utm_campaign=Badge_Grade)
[](https://deepsource.io/gh/ZigRazor/PyStateMachine/?ref=repository-badge)
[](https://deepsource.io/gh/ZigRazor/PyStateMachine/?ref=repository-badge)
## Introduction
**PyStateMachine** is a Framework that support state machines in **Python**
## Requirements
- Python3
### How to Run
How do we import the framework?
1. Insure that Python3 is installed:
- https://www.python.org/downloads/
2. Install the PyStateMachines framework
- pip3 install PyStateMachines
## Example
After framework is installed, import and create a small example.
Create xml file from sample with the State machine states.
myStateMachine.xml
```
State1
ToState2
State2
State2
ToState3
State3
State3
ToState1
State1
State1
```
Create Python Script to run state machine
pyStateMachine.py
```
# importing necessary packages
from StateMachine import StateMachine
"""Test StateMachine"""
sm = StateMachine("myStateMachine.xml")
sm.LoadStateMachine()
# print initial state
print(sm.get_current_state()) # current_state == State1
sm.InjectEvent("ToState2")
print(sm.get_current_state()) # current_state == State2
sm.InjectEvent("ToState3")
print(sm.get_current_state()) # current_state == State3
sm.InjectEvent("ToState1")
print(sm.get_current_state()) # current_state == State1
```
run Python script to execute state machine
```
python pyStateMachine.py
```
pyStateMachineUnitTest.py
```
## Test Suite
# importing necessary packages
from StateMachine import StateMachine
import unittest
class TestBaseStateMachine(unittest.TestCase):
"""Test state machine using various samples"""
# test all valid state transitions
def test1(self):
"""Test Statemachine"""
sm = StateMachine("myStateMachine.xml")
sm.LoadStateMachine()
self.assertEqual(sm.get_current_state(), "State1", "Should be State1")
# OK Event
sm.InjectEvent("ToState2")
self.assertEqual(sm.get_current_state(), "State2", "Should be State2")
# OK Event
sm.InjectEvent("ToState3")
self.assertEqual(sm.get_current_state(), "State3", "Should be State3")
# OK Event
sm.InjectEvent("ToState1")
self.assertEqual(sm.get_current_state(), "State1", "Should be State1")
# test invalid State1 transitions
def test2(self):
"""Test Statemachine"""
sm = StateMachine("myStateMachine.xml")
sm.LoadStateMachine()
self.assertEqual(sm.get_current_state(), "State1", "Should be State1")
# Invalid transition
sm.InjectEvent("ToState3")
self.assertEqual(sm.get_current_state(), "State1", "Should be State1")
# test invalid State2 transitions
def test3(self):
"""Test Statemachine"""
sm = StateMachine("myStateMachine.xml")
sm.LoadStateMachine()
self.assertEqual(sm.get_current_state(), "State1", "Should be State1")
# OK Event
sm.InjectEvent("ToState2")
self.assertEqual(sm.get_current_state(), "State2", "Should be State2")
# Invalid transition
sm.InjectEvent("ToState1")
self.assertEqual(sm.get_current_state(), "State2", "Should be State2")
# test invalid State3 transitions
def test4(self):
"""Test Statemachine"""
sm = StateMachine("myStateMachine.xml")
sm.LoadStateMachine()
self.assertEqual(sm.get_current_state(), "State1", "Should be State1")
# OK Event
sm.InjectEvent("ToState2")
self.assertEqual(sm.get_current_state(), "State2", "Should be State2")
# OK Event
sm.InjectEvent("ToState3")
self.assertEqual(sm.get_current_state(), "State3", "Should be State3")
# Invalid transition
sm.InjectEvent("ToState2")
self.assertEqual(sm.get_current_state(), "State3", "Should be State3")
if __name__ == '__main__':
unittest.main()
```
run unit tests
```
python pyStateMachineUnitTest.py
```
## How to contribute [](https://GitHub.com/ZigRazor/PyStateMachine/graphs/contributors/)
Read the [CONTRIBUTING GUIDE](https://github.com/ZigRazor/PyStateMachine/blob/main/CONTRIBUTING.md)
## Hacktoberfest
We are pleased to inform you that this repository is participating in the **#Hacktoberfest**!
Happy Coding!
## Contact
E-Mail : [email protected]
[GitHub Profile](https://github.com/ZigRazor) 
## Support
To support me just add ***Star*** the project [](https://GitHub.com/ZigRazor/PyStateMachine/stargazers/) or ***follow me*** [](https://github.com/ZigRazor?tab=followers)
To get updated ***watch*** the project [](https://GitHub.com/ZigRazor/PyStateMachine/watchers/)
## Project Info
[](https://github.com/ZigRazor/PyStateMachine)