openstack/automaton
Code Issues Proposed changes
Friendly state machines for python.
239 Commits 8 Branches 68 Tags 1.6 MiB
Python 100%
45e5452482
Go to file
Stephen Finucane 45e5452482 doc: Avoid duplicate entry warning 
Both the 'FiniteMachine' and 'HierarchicalFiniteMachine' in
'automaton.machines' define an 'Effect' attribute. It seems recent
versions of autodoc can't handle this since we're seeing the following
warning:

  automaton/machines.py:docstring of
  automaton.machines.Effect:1:duplicate object description of
  automaton.machines.Effect, other instance in reference/index, use
  :noindex: for one of them

Do as it says and configure 'noindex' for the latter. This means we lose
the ability to link to other members of this class but that's a
necessary compromise since there's no way to exclude an individual
member.

Change-Id: Ic9e50f6b56a278032463357552960e40c2ddf6a7
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-09-21 15:32:39 +01:00
automaton Remove six dependency 2020-12-12 08:08:06 +01:00
doc doc: Avoid duplicate entry warning 2021-09-21 15:32:39 +01:00
releasenotes Update master for stable/wallaby 2021-03-18 11:10:43 +00:00
.coveragerc Added code coverage section to tox 2015-10-05 17:10:31 -04:00
.gitignore Ignore releasenote artifacts files. 2020-02-04 10:13:23 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:55 +00:00
.pre-commit-config.yaml Move flake8 as a pre-commit local target. 2021-04-16 12:07:10 +01:00
.stestr.conf Switch to stestr 2018-07-11 09:48:53 +07:00
.zuul.yaml Add Python3 xena unit tests 2021-03-18 11:10:57 +00:00
bindep.txt Add local bindep.txt 2019-06-26 18:30:20 +02:00
CONTRIBUTING.rst Moving to OFTC 2021-06-07 21:08:51 +00:00
HACKING.rst Sync Sphinx requirement 2019-06-19 00:57:49 +08:00
LICENSE Initial commit 2014-12-02 22:38:57 -08:00
README.rst Update to opendev 2019-04-23 13:53:38 +08:00
requirements.txt Uncap PrettyTable 2021-02-11 12:27:12 +00:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-12 09:18:00 +08:00
setup.py Small cleanup 2020-05-26 09:00:31 +02:00
test-requirements.txt Remove six dependency 2020-12-12 08:08:06 +01:00
tox.ini Merge "Remove lower-constraints remnants" 2021-04-16 12:48:49 +00:00

README.rst

Automaton

Latest Version

Downloads

Friendly state machines for python. The goal of this library is to provide well documented state machine classes and associated utilities. The state machine pattern (or the implemented variation there-of) is a commonly used pattern and has a multitude of various usages. Some of the usages for this library include providing state & transition validation and running/scheduling/analyzing the execution of tasks.