-
automat
index.html
Package
Package
PUBLIC
State-machines.
-
automat._core
automat._core.html
Module
Module
PRIVATE
A core state-machine abstraction.
-
automat._discover
automat._discover.html
Module
Module
PRIVATE
No module docstring; 4/4 functions, 3/3 exceptions documented
-
automat._introspection
automat._introspection.html
Module
Module
PRIVATE
Python introspection helpers.
-
automat._methodical
automat._methodical.html
Module
Module
PRIVATE
No module docstring; 0/2 variable, 0/2 type alias, 0/2 type variable, 7/10 functions, 3/4 classes documented
-
automat._runtimeproto
automat._runtimeproto.html
Module
Module
PRIVATE
-
automat._test
automat._test.html
Package
Package
PRIVATE
No package docstring; 1/6 module documented
-
automat._test.test_core
automat._test.test_core.html
Module
Module
PUBLIC
No module docstring; 1/1 class documented
-
automat._test.test_discover
automat._test.test_discover.html
Module
Module
PUBLIC
No module docstring; 0/1 function, 5/5 classes documented
-
automat._test.test_methodical
automat._test.test_methodical.html
Module
Module
PUBLIC
Tests for the public interface of Automat.
-
automat._test.test_trace
automat._test.test_trace.html
Module
Module
PUBLIC
Undocumented
-
automat._test.test_type_based
automat._test.test_type_based.html
Module
Module
PUBLIC
No module docstring; 0/3 variable, 0/1 type variable, 1/3 function, 1/8 class, 0/1 interface documented
-
automat._test.test_visualize
automat._test.test_visualize.html
Module
Module
PUBLIC
No module docstring; 6/6 functions, 8/11 classes documented
-
automat._typed
automat._typed.html
Module
Module
PRIVATE
No module docstring; 0/3 variable, 0/2 type alias, 0/5 type variable, 0/3 constant, 1/1 function, 8/10 classes documented
-
automat._visualize
automat._visualize.html
Module
Module
PRIVATE
No module docstring; 4/7 functions documented
-
automat._typed.hasInterface
automat._typed.html#hasInterface
Attribute
Variable
PUBLIC
Undocumented
-
automat._core._NO_STATE
automat._core.html#_NO_STATE
Attribute
Constant
PRIVATE
Undocumented
-
automat._core.State
automat._core.html#State
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._core.Input
automat._core.html#Input
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._core.Output
automat._core.html#Output
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._core.Automaton
automat._core.Automaton.html
Class
Class
PUBLIC
A declaration of a finite state machine.
-
automat._core.Automaton.__init__
automat._core.Automaton.html#__init__
Function
Method
PUBLIC
Initialize the set of transitions and the initial state.
-
automat._core.Automaton._initialState
automat._core.Automaton.html#_initialState
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._core.Automaton._transitions
automat._core.Automaton.html#_transitions
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._core.Automaton._unhandledTransition
automat._core.Automaton.html#_unhandledTransition
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._core.Automaton.initialState
automat._core.Automaton.html#initialState
Attribute
Property
PUBLIC
Return this automaton's initial state.
-
automat._core.Automaton.initialState.setter
automat._core.Automaton.html#initialState.setter
Function
Method
PUBLIC
Set this automaton's initial state. Raises a ValueError if this automaton already has an initial state.
-
automat._core.Automaton.addTransition
automat._core.Automaton.html#addTransition
Function
Method
PUBLIC
Add the given transition to the outputSymbol. Raise ValueError if there is already a transition with the same inState and inputSymbol.
-
automat._core.Automaton.unhandledTransition
automat._core.Automaton.html#unhandledTransition
Function
Method
PUBLIC
All unhandled transitions will be handled by transitioning to the given error state and error-handling output symbols.
-
automat._core.Automaton.allTransitions
automat._core.Automaton.html#allTransitions
Function
Method
PUBLIC
All transitions.
-
automat._core.Automaton.inputAlphabet
automat._core.Automaton.html#inputAlphabet
Function
Method
PUBLIC
The full set of symbols acceptable to this automaton.
-
automat._core.Automaton.outputAlphabet
automat._core.Automaton.html#outputAlphabet
Function
Method
PUBLIC
The full set of symbols which can be produced by this automaton.
-
automat._core.Automaton.states
automat._core.Automaton.html#states
Function
Method
PUBLIC
All valid states; "Q" in the mathematical description of a state machine.
-
automat._core.Automaton.outputForInput
automat._core.Automaton.html#outputForInput
Function
Method
PUBLIC
A 2-tuple of (outState, outputSymbols) for inputSymbol.
-
automat._core.OutputTracer
automat._core.html#OutputTracer
Attribute
Type Alias
PUBLIC
Undocumented
-
automat._core.Tracer
automat._core.html#Tracer
Attribute
Type Alias
PUBLIC
Undocumented
-
automat._core.Transitioner
automat._core.Transitioner.html
Class
Class
PUBLIC
The combination of a current state and an
Automaton
.
-
automat._core.Transitioner.__init__
automat._core.Transitioner.html#__init__
Function
Method
PUBLIC
Undocumented
-
automat._core.Transitioner._automaton
automat._core.Transitioner.html#_automaton
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._core.Transitioner._state
automat._core.Transitioner.html#_state
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._core.Transitioner._tracer
automat._core.Transitioner.html#_tracer
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._core.Transitioner.setTrace
automat._core.Transitioner.html#setTrace
Function
Method
PUBLIC
Undocumented
-
automat._core.Transitioner.transition
automat._core.Transitioner.html#transition
Function
Method
PUBLIC
Transition between states, returning any outputs.
-
automat._runtimeproto.T
automat._runtimeproto.html#T
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._runtimeproto.ProtocolAtRuntime
automat._runtimeproto.html#ProtocolAtRuntime
Attribute
Type Alias
PUBLIC
Undocumented
-
automat._runtimeproto.runtime_name
automat._runtimeproto.html#runtime_name
Function
Function
PUBLIC
Undocumented
-
automat._runtimeproto.emptyProtocolMethods
automat._runtimeproto.html#emptyProtocolMethods
Attribute
Variable
PUBLIC
Undocumented
-
automat._runtimeproto.actuallyDefinedProtocolMethods
automat._runtimeproto.html#actuallyDefinedProtocolMethods
Function
Function
PUBLIC
Attempt to ignore implementation details, and get all the methods that the protocol actually defines.
-
automat._runtimeproto._fixAnnotation
automat._runtimeproto.html#_fixAnnotation
Function
Function
PRIVATE
Undocumented
-
automat._runtimeproto._liveSignature
automat._runtimeproto.html#_liveSignature
Function
Function
PRIVATE
Get a signature with evaluated annotations.
-
automat._typed.InputProtocol
automat._typed.html#InputProtocol
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._typed.Core
automat._typed.html#Core
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._typed.Data
automat._typed.html#Data
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._typed.P
automat._typed.html#P
Attribute
Constant
PUBLIC
Undocumented
-
automat._typed.P1
automat._typed.html#P1
Attribute
Constant
PUBLIC
Undocumented
-
automat._typed.R
automat._typed.html#R
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._typed.OtherData
automat._typed.html#OtherData
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._typed.Decorator
automat._typed.html#Decorator
Attribute
Type Alias
PUBLIC
Undocumented
-
automat._typed.FactoryParams
automat._typed.html#FactoryParams
Attribute
Variable
PUBLIC
Undocumented
-
automat._typed.OtherFactoryParams
automat._typed.html#OtherFactoryParams
Attribute
Variable
PUBLIC
Undocumented
-
automat._typed.TransitionRegistrar
automat._typed.TransitionRegistrar.html
Class
Class
PUBLIC
This is a record of a transition that need finalizing; it is the result of calling
TypeMachineBuilder.state
and then ``.upon(input).to(state)`` on the result of that.
-
automat._typed.TransitionRegistrar._signature
automat._typed.TransitionRegistrar.html#_signature
Attribute
Class Variable
PRIVATE
Undocumented
-
automat._typed.TransitionRegistrar._old
automat._typed.TransitionRegistrar.html#_old
Attribute
Class Variable
PRIVATE
Undocumented
-
automat._typed.TransitionRegistrar._new
automat._typed.TransitionRegistrar.html#_new
Attribute
Class Variable
PRIVATE
Undocumented
-
automat._typed.TransitionRegistrar._nodata
automat._typed.TransitionRegistrar.html#_nodata
Attribute
Class Variable
PRIVATE
Undocumented
-
automat._typed.TransitionRegistrar._callback
automat._typed.TransitionRegistrar.html#_callback
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._typed.TransitionRegistrar.__call__
automat._typed.TransitionRegistrar.html#__call__
Function
Method
PUBLIC
Finalize it with __call__ to indicate that there is an implementation to the transition, which can be treated as an output.
-
automat._typed.TransitionRegistrar.returns
automat._typed.TransitionRegistrar.html#returns
Function
Method
PUBLIC
Finalize it with .returns(constant) to indicate that there is no method body, and the given result can just be yielded each time after the state transition. The only output generated in this case would be the data-construction factory for the target state.
-
automat._typed.TransitionRegistrar._checkComplete
automat._typed.TransitionRegistrar.html#_checkComplete
Function
Method
PRIVATE
Raise an exception if the user forgot to decorate a method implementation or supply a return value for this transition.
-
automat._typed.UponFromNo
automat._typed.UponFromNo.html
Class
Class
PUBLIC
Type parameter P: the signature of the input method.
-
automat._typed.UponFromNo.old
automat._typed.UponFromNo.html#old
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.UponFromNo.input
automat._typed.UponFromNo.html#input
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.UponFromNo.to
automat._typed.UponFromNo.html#to
Function
Method
PUBLIC
Declare a state transition to a new state.
-
automat._typed.UponFromNo.loop
automat._typed.UponFromNo.html#loop
Function
Method
PUBLIC
Register a transition back to the same state.
-
automat._typed.UponFromData
automat._typed.UponFromData.html
Class
Class
PUBLIC
Type parameter P: the signature of the input method.
-
automat._typed.UponFromData.old
automat._typed.UponFromData.html#old
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.UponFromData.input
automat._typed.UponFromData.html#input
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.UponFromData.to
automat._typed.UponFromData.html#to
Function
Method
PUBLIC
Declare a state transition to a new state.
-
automat._typed.UponFromData.loop
automat._typed.UponFromData.html#loop
Function
Method
PUBLIC
Register a transition back to the same state.
-
automat._typed.TypedState
automat._typed.TypedState.html
Class
Class
PUBLIC
-
automat._typed.TypedState.name
automat._typed.TypedState.html#name
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.TypedState.builder
automat._typed.TypedState.html#builder
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.TypedState.upon
automat._typed.TypedState.html#upon
Function
Method
PUBLIC
.upon()
-
automat._typed.TypedState._produceOutputs
automat._typed.TypedState.html#_produceOutputs
Function
Method
PRIVATE
Undocumented
-
automat._typed.TypedDataState
automat._typed.TypedDataState.html
Class
Class
PUBLIC
Undocumented
-
automat._typed.TypedDataState.name
automat._typed.TypedDataState.html#name
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.TypedDataState.builder
automat._typed.TypedDataState.html#builder
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.TypedDataState.factory
automat._typed.TypedDataState.html#factory
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.TypedDataState.upon
automat._typed.TypedDataState.html#upon
Function
Method
PUBLIC
Undocumented
-
automat._typed.TypedDataState._produceOutputs
automat._typed.TypedDataState.html#_produceOutputs
Function
Method
PRIVATE
Undocumented
-
automat._typed.AnyState
automat._typed.html#AnyState
Attribute
Type Alias
PUBLIC
Undocumented
-
automat._typed.TypedInput
automat._typed.TypedInput.html
Class
Class
PUBLIC
Undocumented
-
automat._typed.TypedInput.name
automat._typed.TypedInput.html#name
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.SomeOutput
automat._typed.SomeOutput.html
Class
Class
PUBLIC
A state machine output.
-
automat._typed.SomeOutput.name
automat._typed.SomeOutput.html#name
Attribute
Property
PUBLIC
read-only name property
-
automat._typed.SomeOutput.__call__
automat._typed.SomeOutput.html#__call__
Function
Method
PUBLIC
Undocumented
-
automat._typed.SomeOutput.__hash__
automat._typed.SomeOutput.html#__hash__
Function
Method
PUBLIC
must be hashable
-
automat._typed.InputImplementer
automat._typed.InputImplementer.html
Class
Class
PUBLIC
-
automat._typed.InputImplementer.__automat_core__
automat._typed.InputImplementer.html#__automat_core__
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.InputImplementer.__automat_transitioner__
automat._typed.InputImplementer.html#__automat_transitioner__
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.InputImplementer.__automat_data__
automat._typed.InputImplementer.html#__automat_data__
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.InputImplementer.__automat_postponed__
automat._typed.InputImplementer.html#__automat_postponed__
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.implementMethod
automat._typed.html#implementMethod
Function
Function
PUBLIC
Construct a function for populating in the synthetic provider of the Input Protocol to a
TypeMachineBuilder
. It should have a signature matching that of the
method parameter, a function from that protocol.
-
automat._typed.MethodOutput
automat._typed.MethodOutput.html
Class
Class
PUBLIC
This is the thing that goes into the automaton's outputs list, and thus (per the implementation of
implementMethod
) takes the 'self' of the InputImplementer instance (i.e. the synthetic protocol implementation) and the previous result computed by the former output, which will be None initially.
-
automat._typed.MethodOutput.method
automat._typed.MethodOutput.html#method
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.MethodOutput.requiresData
automat._typed.MethodOutput.html#requiresData
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.MethodOutput._assertion
automat._typed.MethodOutput.html#_assertion
Attribute
Class Variable
PRIVATE
Undocumented
-
automat._typed.MethodOutput._fromImpl
automat._typed.MethodOutput.html#_fromImpl
Function
Class Method
PRIVATE
Undocumented
-
automat._typed.MethodOutput.name
automat._typed.MethodOutput.html#name
Attribute
Property
PUBLIC
Undocumented
-
automat._typed.MethodOutput.__call__
automat._typed.MethodOutput.html#__call__
Function
Method
PUBLIC
Undocumented
-
automat._typed.DataOutput
automat._typed.DataOutput.html
Class
Class
PUBLIC
Construct an output for the given data objects.
-
automat._typed.DataOutput.dataFactory
automat._typed.DataOutput.html#dataFactory
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._typed.DataOutput.name
automat._typed.DataOutput.html#name
Attribute
Property
PUBLIC
Undocumented
-
automat._typed.DataOutput.__call__
automat._typed.DataOutput.html#__call__
Function
Method
PUBLIC
Undocumented
-
automat._typed.DataOutput.__automat_data__
automat._typed.DataOutput.html#__automat_data__
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._typed.INVALID_WHILE_DESERIALIZING
automat._typed.html#INVALID_WHILE_DESERIALIZING
Attribute
Constant
PUBLIC
Undocumented
-
automat.TypeMachineBuilder
automat.TypeMachineBuilder.html
Class
Class
PUBLIC
The main entry-point into Automat, used to construct a factory for instances of InputProtocol that take an instance of Core.
-
automat.TypeMachineBuilder.inputProtocol
automat.TypeMachineBuilder.html#inputProtocol
Attribute
Class Variable
PUBLIC
Undocumented
-
automat.TypeMachineBuilder.coreType
automat.TypeMachineBuilder.html#coreType
Attribute
Class Variable
PUBLIC
Undocumented
-
automat.TypeMachineBuilder._automaton
automat.TypeMachineBuilder.html#_automaton
Attribute
Class Variable
PRIVATE
Undocumented
-
automat.TypeMachineBuilder._initial
automat.TypeMachineBuilder.html#_initial
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat.TypeMachineBuilder._registrars
automat.TypeMachineBuilder.html#_registrars
Attribute
Class Variable
PRIVATE
Undocumented
-
automat.TypeMachineBuilder._built
automat.TypeMachineBuilder.html#_built
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat.TypeMachineBuilder.state
automat.TypeMachineBuilder.html#state
Function
Method
PUBLIC
Construct a state.
-
automat.TypeMachineBuilder.build
automat.TypeMachineBuilder.html#build
Function
Method
PUBLIC
Create a
TypeMachine
, and prevent further modification to the state machine being built.
-
automat.TypeMachineBuilder._checkMembership
automat.TypeMachineBuilder.html#_checkMembership
Function
Method
PRIVATE
Ensure that ``input`` is a valid member function of the input protocol, not just a function that happens to take the right first argument.
-
automat.pep614
index.html#pep614
Function
Function
PUBLIC
-
automat.AlreadyBuiltError
automat.AlreadyBuiltError.html
Class
Exception
PUBLIC
The
TypeMachine
is already built, and thus can no longer be modified.
-
automat.TypeMachine
automat.TypeMachine.html
Class
Class
PUBLIC
A
TypeMachine
is a factory for instances of
InputProtocol.
-
automat.TypeMachine.__automat_type__
automat.TypeMachine.html#__automat_type__
Attribute
Class Variable
PUBLIC
Undocumented
-
automat.TypeMachine.__automat_automaton__
automat.TypeMachine.html#__automat_automaton__
Attribute
Class Variable
PUBLIC
Undocumented
-
automat.TypeMachine.__call__
automat.TypeMachine.html#__call__
Function
Method
PUBLIC
Construct an instance of InputProtocol from an instance of the Core protocol.
-
automat.TypeMachine.asDigraph
automat.TypeMachine.html#asDigraph
Function
Method
PUBLIC
Undocumented
-
automat.NoTransition
automat.NoTransition.html
Class
Exception
PUBLIC
A finite state machine in state has no transition for symbol.
-
automat.NoTransition.state
automat.NoTransition.html#state
Attribute
Instance Variable
PUBLIC
See state init parameter.
-
automat.NoTransition.symbol
automat.NoTransition.html#symbol
Attribute
Instance Variable
PUBLIC
See symbol init parameter.
-
automat.NoTransition.__init__
automat.NoTransition.html#__init__
Function
Method
PUBLIC
-
automat._introspection.copycode
automat._introspection.html#copycode
Function
Function
PUBLIC
Undocumented
-
automat._introspection.copyfunction
automat._introspection.html#copyfunction
Function
Function
PUBLIC
Undocumented
-
automat._introspection.preserveName
automat._introspection.html#preserveName
Function
Function
PUBLIC
Preserve the name of the given function on the decorated function.
-
automat._methodical.ArgSpec
automat._methodical.html#ArgSpec
Attribute
Variable
PUBLIC
Undocumented
-
automat._methodical._getArgSpec
automat._methodical.html#_getArgSpec
Function
Function
PRIVATE
Normalize inspect.ArgSpec across python versions and convert mutable attributes to immutable types.
-
automat._methodical._getArgNames
automat._methodical.html#_getArgNames
Function
Function
PRIVATE
Get the name of all arguments defined in a function signature.
-
automat._methodical._keywords_only
automat._methodical.html#_keywords_only
Function
Function
PRIVATE
Decorate a function so all its arguments must be passed by keyword.
-
automat._methodical.MethodicalState
automat._methodical.MethodicalState.html
Class
Class
PUBLIC
-
automat._methodical.MethodicalState.machine
automat._methodical.MethodicalState.html#machine
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalState.method
automat._methodical.MethodicalState.html#method
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalState.serialized
automat._methodical.MethodicalState.html#serialized
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalState.upon
automat._methodical.MethodicalState.html#upon
Function
Method
PUBLIC
Declare a state transition within the
MethodicalMachine
associated with this
MethodicalState
: upon the receipt of the `input`, enter the `state`, emitting each output in `outputs`.
-
automat._methodical.MethodicalState._name
automat._methodical.MethodicalState.html#_name
Function
Method
PRIVATE
Undocumented
-
automat._methodical._transitionerFromInstance
automat._methodical.html#_transitionerFromInstance
Function
Function
PRIVATE
-
automat._methodical._empty
automat._methodical.html#_empty
Function
Function
PRIVATE
Undocumented
-
automat._methodical._docstring
automat._methodical.html#_docstring
Function
Function
PRIVATE
docstring
-
automat._methodical.assertNoCode
automat._methodical.html#assertNoCode
Function
Function
PUBLIC
Undocumented
-
automat._methodical._filterArgs
automat._methodical.html#_filterArgs
Function
Function
PRIVATE
Filter out arguments that were passed to input that output won't accept.
-
automat._methodical.T
automat._methodical.html#T
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._methodical.R
automat._methodical.html#R
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalInput
automat._methodical.MethodicalInput.html
Class
Class
PUBLIC
-
automat._methodical.MethodicalInput.automaton
automat._methodical.MethodicalInput.html#automaton
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalInput.method
automat._methodical.MethodicalInput.html#method
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalInput.symbol
automat._methodical.MethodicalInput.html#symbol
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalInput.collectors
automat._methodical.MethodicalInput.html#collectors
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalInput.argSpec
automat._methodical.MethodicalInput.html#argSpec
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalInput.__get__
automat._methodical.MethodicalInput.html#__get__
Function
Method
PUBLIC
Return a function that takes no arguments and returns values returned by output functions produced by the given
MethodicalInput
in
oself's current state.
-
automat._methodical.MethodicalInput._name
automat._methodical.MethodicalInput.html#_name
Function
Method
PRIVATE
Undocumented
-
automat._methodical.MethodicalOutput
automat._methodical.MethodicalOutput.html
Class
Class
PUBLIC
-
automat._methodical.MethodicalOutput.machine
automat._methodical.MethodicalOutput.html#machine
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalOutput.method
automat._methodical.MethodicalOutput.html#method
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalOutput.argSpec
automat._methodical.MethodicalOutput.html#argSpec
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalOutput.__get__
automat._methodical.MethodicalOutput.html#__get__
Function
Method
PUBLIC
Outputs are private, so raise an exception when we attempt to get one.
-
automat._methodical.MethodicalOutput.__call__
automat._methodical.MethodicalOutput.html#__call__
Function
Method
PUBLIC
Call the underlying method.
-
automat._methodical.MethodicalOutput._name
automat._methodical.MethodicalOutput.html#_name
Function
Method
PRIVATE
Undocumented
-
automat._methodical.StringOutputTracer
automat._methodical.html#StringOutputTracer
Attribute
Type Alias
PUBLIC
Undocumented
-
automat._methodical.StringTracer
automat._methodical.html#StringTracer
Attribute
Type Alias
PUBLIC
Undocumented
-
automat._methodical.wrapTracer
automat._methodical.html#wrapTracer
Function
Function
PUBLIC
Undocumented
-
automat._methodical.MethodicalTracer
automat._methodical.MethodicalTracer.html
Class
Class
PUBLIC
Undocumented
-
automat._methodical.MethodicalTracer.automaton
automat._methodical.MethodicalTracer.html#automaton
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalTracer.symbol
automat._methodical.MethodicalTracer.html#symbol
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._methodical.MethodicalTracer.__get__
automat._methodical.MethodicalTracer.html#__get__
Function
Method
PUBLIC
Undocumented
-
automat._methodical.counter
automat._methodical.html#counter
Attribute
Variable
PUBLIC
Undocumented
-
automat._methodical.gensym
automat._methodical.html#gensym
Function
Function
PUBLIC
Create a unique Python identifier.
-
automat.MethodicalMachine
automat.MethodicalMachine.html
Class
Class
PUBLIC
-
automat.MethodicalMachine.__init__
automat.MethodicalMachine.html#__init__
Function
Method
PUBLIC
Undocumented
-
automat.MethodicalMachine._automaton
automat.MethodicalMachine.html#_automaton
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat.MethodicalMachine._reducers
automat.MethodicalMachine.html#_reducers
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat.MethodicalMachine._symbol
automat.MethodicalMachine.html#_symbol
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat.MethodicalMachine.__get__
automat.MethodicalMachine.html#__get__
Function
Method
PUBLIC
MethodicalMachine
is an implementation detail for setting up class-level state; applications should never need to access it on an instance.
-
automat.MethodicalMachine.state
automat.MethodicalMachine.html#state
Function
Method
PUBLIC
Declare a state, possibly an initial state or a terminal state.
-
automat.MethodicalMachine.input
automat.MethodicalMachine.html#input
Function
Method
PUBLIC
Declare an input.
-
automat.MethodicalMachine.output
automat.MethodicalMachine.html#output
Function
Method
PUBLIC
Declare an output.
-
automat.MethodicalMachine._oneTransition
automat.MethodicalMachine.html#_oneTransition
Function
Method
PRIVATE
-
automat.MethodicalMachine.serializer
automat.MethodicalMachine.html#serializer
Function
Method
PUBLIC
Undocumented
-
automat.MethodicalMachine.unserializer
automat.MethodicalMachine.html#unserializer
Function
Method
PUBLIC
Undocumented
-
automat.MethodicalMachine._setTrace
automat.MethodicalMachine.html#_setTrace
Attribute
Property
PRIVATE
Undocumented
-
automat.MethodicalMachine.asDigraph
automat.MethodicalMachine.html#asDigraph
Function
Method
PUBLIC
Generate a graphviz.Digraph
that represents this machine's states and transitions.
-
automat._discover.isOriginalLocation
automat._discover.html#isOriginalLocation
Function
Function
PUBLIC
Attempt to discover if this appearance of a PythonAttribute representing a class refers to the module where that class was defined.
-
automat._discover.findMachinesViaWrapper
automat._discover.html#findMachinesViaWrapper
Function
Function
PUBLIC
Recursively yield
MethodicalMachine
s and their FQPNs within a
PythonModule
or a
twisted.python.modules.PythonAttribute
wrapper object.
-
automat._discover.InvalidFQPN
automat._discover.InvalidFQPN.html
Class
Exception
PUBLIC
The given FQPN was not a dot-separated list of Python objects.
-
automat._discover.NoModule
automat._discover.NoModule.html
Class
Exception
PUBLIC
A prefix of the FQPN was not an importable module or package.
-
automat._discover.NoObject
automat._discover.NoObject.html
Class
Exception
PUBLIC
A suffix of the FQPN was not an accessible object
-
automat._discover.wrapFQPN
automat._discover.html#wrapFQPN
Function
Function
PUBLIC
Given an FQPN, retrieve the object via the global Python module namespace and wrap it with a PythonModule
or a twisted.python.modules.PythonAttribute
.
-
automat._discover.findMachines
automat._discover.html#findMachines
Function
Function
PUBLIC
Recursively yield
MethodicalMachine
s and their FQPNs in and under the a Python object specified by an FQPN.
-
automat._test.test_core.CoreTests
automat._test.test_core.CoreTests.html
Class
Class
PUBLIC
Tests for Automat's (currently private, implementation detail) core.
-
automat._test.test_core.CoreTests.test_NoTransition
automat._test.test_core.CoreTests.html#test_NoTransition
Function
Method
PUBLIC
A
NoTransition
exception describes the state and input symbol that caused it.
-
automat._test.test_core.CoreTests.test_unhandledTransition
automat._test.test_core.CoreTests.html#test_unhandledTransition
Function
Method
PUBLIC
Automaton.unhandledTransition sets the outputs and end-state to be used for all unhandled transitions.
-
automat._test.test_core.CoreTests.test_noOutputForInput
automat._test.test_core.CoreTests.html#test_noOutputForInput
Function
Method
PUBLIC
-
automat._test.test_core.CoreTests.test_oneTransition
automat._test.test_core.CoreTests.html#test_oneTransition
Function
Method
PUBLIC
-
automat._test.test_core.CoreTests.test_oneTransition_nonIterableOutputs
automat._test.test_core.CoreTests.html#test_oneTransition_nonIterableOutputs
Function
Method
PUBLIC
Automaton.addTransition
raises a TypeError when given outputs that aren't iterable and doesn't add any transitions.
-
automat._test.test_core.CoreTests.test_initialState
automat._test.test_core.CoreTests.html#test_initialState
Function
Method
PUBLIC
Automaton.initialState
is a descriptor that sets the initial state if it's not yet set, and raises
ValueError
if it is.
-
automat._test.test_discover.isTwistedInstalled
automat._test.test_discover.html#isTwistedInstalled
Function
Function
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules
automat._test.test_discover._WritesPythonModules.html
Class
Class
PRIVATE
A helper that enables generating Python module test fixtures.
-
automat._test.test_discover._WritesPythonModules.setUp
automat._test.test_discover._WritesPythonModules.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.getModule
automat._test.test_discover._WritesPythonModules.html#getModule
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.PythonPath
automat._test.test_discover._WritesPythonModules.html#PythonPath
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.FilePath
automat._test.test_discover._WritesPythonModules.html#FilePath
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.originalSysModules
automat._test.test_discover._WritesPythonModules.html#originalSysModules
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.savedSysPath
automat._test.test_discover._WritesPythonModules.html#savedSysPath
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.pathDir
automat._test.test_discover._WritesPythonModules.html#pathDir
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.tearDown
automat._test.test_discover._WritesPythonModules.html#tearDown
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.makeImportable
automat._test.test_discover._WritesPythonModules.html#makeImportable
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.writeSourceInto
automat._test.test_discover._WritesPythonModules.html#writeSourceInto
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.makeModule
automat._test.test_discover._WritesPythonModules.html#makeModule
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.attributesAsDict
automat._test.test_discover._WritesPythonModules.html#attributesAsDict
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.loadModuleAsDict
automat._test.test_discover._WritesPythonModules.html#loadModuleAsDict
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover._WritesPythonModules.makeModuleAsDict
automat._test.test_discover._WritesPythonModules.html#makeModuleAsDict
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover.OriginalLocationTests
automat._test.test_discover.OriginalLocationTests.html
Class
Class
PUBLIC
-
automat._test.test_discover.OriginalLocationTests.setUp
automat._test.test_discover.OriginalLocationTests.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover.OriginalLocationTests.isOriginalLocation
automat._test.test_discover.OriginalLocationTests.html#isOriginalLocation
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.OriginalLocationTests.test_failsWithNoModule
automat._test.test_discover.OriginalLocationTests.html#test_failsWithNoModule
Function
Method
PUBLIC
isOriginalLocation
returns False when the attribute refers to an object whose source module cannot be determined.
-
automat._test.test_discover.OriginalLocationTests.test_failsWithDifferentModule
automat._test.test_discover.OriginalLocationTests.html#test_failsWithDifferentModule
Function
Method
PUBLIC
isOriginalLocation
returns False when the attribute refers to an object outside of the module where that object was defined.
-
automat._test.test_discover.OriginalLocationTests.test_succeedsWithSameModule
automat._test.test_discover.OriginalLocationTests.html#test_succeedsWithSameModule
Function
Method
PUBLIC
isOriginalLocation
returns True when the attribute refers to an object inside the module where that object was defined.
-
automat._test.test_discover.FindMachinesViaWrapperTests
automat._test.test_discover.FindMachinesViaWrapperTests.html
Class
Class
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.setUp
automat._test.test_discover.FindMachinesViaWrapperTests.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesViaWrapperTests.findMachinesViaWrapper
automat._test.test_discover.FindMachinesViaWrapperTests.html#findMachinesViaWrapper
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_yieldsMachine
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_yieldsMachine
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_yieldsTypeMachine
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_yieldsTypeMachine
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_yieldsMachineInClass
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_yieldsMachineInClass
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_yieldsMachineInNestedClass
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_yieldsMachineInNestedClass
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_yieldsMachineInModule
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_yieldsMachineInModule
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_yieldsMachineInClassInModule
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_yieldsMachineInClassInModule
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_yieldsMachineInNestedClassInModule
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_yieldsMachineInNestedClassInModule
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_ignoresImportedClass
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_ignoresImportedClass
Function
Method
PUBLIC
When given a
twisted.python.modules.PythonAttribute
that refers to a class imported from another module, any
MethodicalMachine
s on that class are ignored.
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_descendsIntoPackages
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_descendsIntoPackages
Function
Method
PUBLIC
-
automat._test.test_discover.FindMachinesViaWrapperTests.test_infiniteLoop
automat._test.test_discover.FindMachinesViaWrapperTests.html#test_infiniteLoop
Function
Method
PUBLIC
-
automat._test.test_discover.WrapFQPNTests
automat._test.test_discover.WrapFQPNTests.html
Class
Class
PUBLIC
Tests that ensure
wrapFQPN
loads the
twisted.python.modules.PythonModule
or
twisted.python.modules.PythonAttribute
for a given FQPN.
-
automat._test.test_discover.WrapFQPNTests.setUp
automat._test.test_discover.WrapFQPNTests.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover.WrapFQPNTests.PythonModule
automat._test.test_discover.WrapFQPNTests.html#PythonModule
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.WrapFQPNTests.PythonAttribute
automat._test.test_discover.WrapFQPNTests.html#PythonAttribute
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.WrapFQPNTests.wrapFQPN
automat._test.test_discover.WrapFQPNTests.html#wrapFQPN
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.WrapFQPNTests.InvalidFQPN
automat._test.test_discover.WrapFQPNTests.html#InvalidFQPN
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.WrapFQPNTests.NoModule
automat._test.test_discover.WrapFQPNTests.html#NoModule
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.WrapFQPNTests.NoObject
automat._test.test_discover.WrapFQPNTests.html#NoObject
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.WrapFQPNTests.assertModuleWrapperRefersTo
automat._test.test_discover.WrapFQPNTests.html#assertModuleWrapperRefersTo
Function
Method
PUBLIC
Assert that a twisted.python.modules.PythonModule
refers to a particular Python module.
-
automat._test.test_discover.WrapFQPNTests.assertAttributeWrapperRefersTo
automat._test.test_discover.WrapFQPNTests.html#assertAttributeWrapperRefersTo
Function
Method
PUBLIC
Assert that a twisted.python.modules.PythonAttribute
refers to a particular Python object.
-
automat._test.test_discover.WrapFQPNTests.test_failsWithEmptyFQPN
automat._test.test_discover.WrapFQPNTests.html#test_failsWithEmptyFQPN
Function
Method
PUBLIC
-
automat._test.test_discover.WrapFQPNTests.test_failsWithBadDotting
automat._test.test_discover.WrapFQPNTests.html#test_failsWithBadDotting
Function
Method
PUBLIC
-
automat._test.test_discover.WrapFQPNTests.test_singleModule
automat._test.test_discover.WrapFQPNTests.html#test_singleModule
Function
Method
PUBLIC
wrapFQPN
returns a
twisted.python.modules.PythonModule
referring to the single module a dotless FQPN describes.
-
automat._test.test_discover.WrapFQPNTests.test_failsWithMissingSingleModuleOrPackage
automat._test.test_discover.WrapFQPNTests.html#test_failsWithMissingSingleModuleOrPackage
Function
Method
PUBLIC
wrapFQPN
raises
NoModule
when given a dotless FQPN that does not refer to a module or package.
-
automat._test.test_discover.WrapFQPNTests.test_singlePackage
automat._test.test_discover.WrapFQPNTests.html#test_singlePackage
Function
Method
PUBLIC
wrapFQPN
returns a
twisted.python.modules.PythonModule
referring to the single package a dotless FQPN describes.
-
automat._test.test_discover.WrapFQPNTests.test_multiplePackages
automat._test.test_discover.WrapFQPNTests.html#test_multiplePackages
Function
Method
PUBLIC
wrapFQPN
returns a
twisted.python.modules.PythonModule
referring to the deepest package described by dotted FQPN.
-
automat._test.test_discover.WrapFQPNTests.test_multiplePackagesFinalModule
automat._test.test_discover.WrapFQPNTests.html#test_multiplePackagesFinalModule
Function
Method
PUBLIC
wrapFQPN
returns a
twisted.python.modules.PythonModule
referring to the deepest module described by dotted FQPN.
-
automat._test.test_discover.WrapFQPNTests.test_singleModuleObject
automat._test.test_discover.WrapFQPNTests.html#test_singleModuleObject
Function
Method
PUBLIC
wrapFQPN
returns a
twisted.python.modules.PythonAttribute
referring to the deepest object an FQPN names, traversing one module.
-
automat._test.test_discover.WrapFQPNTests.test_multiplePackagesObject
automat._test.test_discover.WrapFQPNTests.html#test_multiplePackagesObject
Function
Method
PUBLIC
wrapFQPN
returns a
twisted.python.modules.PythonAttribute
referring to the deepest object described by an FQPN, descending through several packages.
-
automat._test.test_discover.WrapFQPNTests.test_failsWithMultiplePackagesMissingModuleOrPackage
automat._test.test_discover.WrapFQPNTests.html#test_failsWithMultiplePackagesMissingModuleOrPackage
Function
Method
PUBLIC
wrapFQPN
raises
NoObject
when given an FQPN that contains a missing attribute, module, or package.
-
automat._test.test_discover.FindMachinesIntegrationTests
automat._test.test_discover.FindMachinesIntegrationTests.html
Class
Class
PUBLIC
Integration tests to check that
findMachines
yields all machines discoverable at or below an FQPN.
-
automat._test.test_discover.FindMachinesIntegrationTests.SOURCE
automat._test.test_discover.FindMachinesIntegrationTests.html#SOURCE
Attribute
Constant
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesIntegrationTests.setUp
automat._test.test_discover.FindMachinesIntegrationTests.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesIntegrationTests.findMachines
automat._test.test_discover.FindMachinesIntegrationTests.html#findMachines
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesIntegrationTests.pythonPath
automat._test.test_discover.FindMachinesIntegrationTests.html#pythonPath
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesIntegrationTests.packageDict
automat._test.test_discover.FindMachinesIntegrationTests.html#packageDict
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesIntegrationTests.moduleDict
automat._test.test_discover.FindMachinesIntegrationTests.html#moduleDict
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_discover.FindMachinesIntegrationTests.test_discoverAll
automat._test.test_discover.FindMachinesIntegrationTests.html#test_discoverAll
Function
Method
PUBLIC
-
automat._test.test_methodical.MethodicalTests
automat._test.test_methodical.MethodicalTests.html
Class
Class
PUBLIC
-
automat._test.test_methodical.MethodicalTests.test_oneTransition
automat._test.test_methodical.MethodicalTests.html#test_oneTransition
Function
Method
PUBLIC
MethodicalMachine
provides a way for you to declare a state machine with inputs, outputs, and states as methods. When you have declared an input, an output, and a state, calling the input method in that state will produce the specified output.
-
automat._test.test_methodical.MethodicalTests.test_machineItselfIsPrivate
automat._test.test_methodical.MethodicalTests.html#test_machineItselfIsPrivate
Function
Method
PUBLIC
MethodicalMachine
is an implementation detail. If you attempt to access it on an instance of your class, you will get an exception. However, since tools may need to access it for the purposes of, for example, visualization, you may access it on the class itself.
-
automat._test.test_methodical.MethodicalTests.test_outputsArePrivate
automat._test.test_methodical.MethodicalTests.html#test_outputsArePrivate
Function
Method
PUBLIC
One of the benefits of using a state machine is that your output method implementations don't need to take invalid state transitions into account - the methods simply won't be called. This property would be broken if client code called output methods directly, so output methods are not directly visible under their names.
-
automat._test.test_methodical.MethodicalTests.test_multipleMachines
automat._test.test_methodical.MethodicalTests.html#test_multipleMachines
Function
Method
PUBLIC
Two machines may co-exist happily on the same instance; they don't interfere with each other.
-
automat._test.test_methodical.MethodicalTests.test_collectOutputs
automat._test.test_methodical.MethodicalTests.html#test_collectOutputs
Function
Method
PUBLIC
Outputs can be combined with the "collector" argument to "upon".
-
automat._test.test_methodical.MethodicalTests.test_methodName
automat._test.test_methodical.MethodicalTests.html#test_methodName
Function
Method
PUBLIC
Input methods preserve their declared names.
-
automat._test.test_methodical.MethodicalTests.test_inputWithArguments
automat._test.test_methodical.MethodicalTests.html#test_inputWithArguments
Function
Method
PUBLIC
If an input takes an argument, it will pass that along to its output.
-
automat._test.test_methodical.MethodicalTests.test_outputWithSubsetOfArguments
automat._test.test_methodical.MethodicalTests.html#test_outputWithSubsetOfArguments
Function
Method
PUBLIC
Inputs pass arguments that output will accept.
-
automat._test.test_methodical.MethodicalTests.test_inputFunctionsMustBeEmpty
automat._test.test_methodical.MethodicalTests.html#test_inputFunctionsMustBeEmpty
Function
Method
PUBLIC
The wrapped input function must have an empty body.
-
automat._test.test_methodical.MethodicalTests.test_inputOutputMismatch
automat._test.test_methodical.MethodicalTests.html#test_inputOutputMismatch
Function
Method
PUBLIC
All the argument lists of the outputs for a given input must match; if one does not the call to upon will raise a TypeError.
-
automat._test.test_methodical.MethodicalTests.test_stateLoop
automat._test.test_methodical.MethodicalTests.html#test_stateLoop
Function
Method
PUBLIC
It is possible to write a self-loop by omitting "enter"
-
automat._test.test_methodical.MethodicalTests.test_defaultOutputs
automat._test.test_methodical.MethodicalTests.html#test_defaultOutputs
Function
Method
PUBLIC
It is possible to write a transition with no outputs
-
automat._test.test_methodical.MethodicalTests.test_getArgNames
automat._test.test_methodical.MethodicalTests.html#test_getArgNames
Function
Method
PUBLIC
Type annotations should be included in the set of
-
automat._test.test_methodical.MethodicalTests.test_filterArgs
automat._test.test_methodical.MethodicalTests.html#test_filterArgs
Function
Method
PUBLIC
filterArgs() should not filter the `args` parameter if outputSpec accepts `*args`.
-
automat._test.test_methodical.MethodicalTests.test_multipleInitialStatesFailure
automat._test.test_methodical.MethodicalTests.html#test_multipleInitialStatesFailure
Function
Method
PUBLIC
-
automat._test.test_methodical.MethodicalTests.test_multipleTransitionsFailure
automat._test.test_methodical.MethodicalTests.html#test_multipleTransitionsFailure
Function
Method
PUBLIC
-
automat._test.test_methodical.MethodicalTests.test_badTransitionForCurrentState
automat._test.test_methodical.MethodicalTests.html#test_badTransitionForCurrentState
Function
Method
PUBLIC
Calling any input method that lacks a transition for the machine's current state raises an informative
NoTransition
.
-
automat._test.test_methodical.MethodicalTests.test_saveState
automat._test.test_methodical.MethodicalTests.html#test_saveState
Function
Method
PUBLIC
-
automat._test.test_methodical.MethodicalTests.test_restoreState
automat._test.test_methodical.MethodicalTests.html#test_restoreState
Function
Method
PUBLIC
MethodicalMachine.unserializer
decorates a function that becomes a machine-state unserializer; its return value is mapped to the
serialized parameter to
state, and the
MethodicalMachine
associated with that instance's state is updated to that state.
-
automat._test.test_trace.SampleObject
automat._test.test_trace.SampleObject.html
Class
Class
PUBLIC
No class docstring; 0/1 class variable, 7/7 methods documented
-
automat._test.test_trace.SampleObject.mm
automat._test.test_trace.SampleObject.html#mm
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._test.test_trace.SampleObject.begin
automat._test.test_trace.SampleObject.html#begin
Function
Method
PUBLIC
initial state
-
automat._test.test_trace.SampleObject.middle
automat._test.test_trace.SampleObject.html#middle
Function
Method
PUBLIC
middle state
-
automat._test.test_trace.SampleObject.end
automat._test.test_trace.SampleObject.html#end
Function
Method
PUBLIC
end state
-
automat._test.test_trace.SampleObject.go1
automat._test.test_trace.SampleObject.html#go1
Function
Method
PUBLIC
sample input
-
automat._test.test_trace.SampleObject.go2
automat._test.test_trace.SampleObject.html#go2
Function
Method
PUBLIC
sample input
-
automat._test.test_trace.SampleObject.back
automat._test.test_trace.SampleObject.html#back
Function
Method
PUBLIC
sample input
-
automat._test.test_trace.SampleObject.out
automat._test.test_trace.SampleObject.html#out
Function
Method
PUBLIC
sample output
-
automat._test.test_trace.TraceTests
automat._test.test_trace.TraceTests.html
Class
Class
PUBLIC
Undocumented
-
automat._test.test_trace.TraceTests.test_only_inputs
automat._test.test_trace.TraceTests.html#test_only_inputs
Function
Method
PUBLIC
Undocumented
-
automat._test.test_trace.TraceTests.test_inputs_and_outputs
automat._test.test_trace.TraceTests.html#test_inputs_and_outputs
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.hasInterface
automat._test.test_type_based.html#hasInterface
Attribute
Variable
PUBLIC
Undocumented
-
automat._test.test_type_based.ISomething
automat._test.test_type_based.ISomething.html
Class
Interface
PUBLIC
Undocumented
-
automat._test.test_type_based.ISomething.something
automat._test.test_type_based.ISomething.html#something
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.T
automat._test.test_type_based.html#T
Attribute
Type Variable
PUBLIC
Undocumented
-
automat._test.test_type_based.ProtocolForTesting
automat._test.test_type_based.ProtocolForTesting.html
Class
Class
PUBLIC
No class docstring; 2/2 methods documented
-
automat._test.test_type_based.ProtocolForTesting.change
automat._test.test_type_based.ProtocolForTesting.html#change
Function
Method
PUBLIC
Switch to the other state.
-
automat._test.test_type_based.ProtocolForTesting.value
automat._test.test_type_based.ProtocolForTesting.html#value
Function
Method
PUBLIC
Give a value specific to the given state.
-
automat._test.test_type_based.ArgTaker
automat._test.test_type_based.ArgTaker.html
Class
Class
PUBLIC
Undocumented
-
automat._test.test_type_based.ArgTaker.takeSomeArgs
automat._test.test_type_based.ArgTaker.html#takeSomeArgs
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.ArgTaker.value
automat._test.test_type_based.ArgTaker.html#value
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.NoOpCore
automat._test.test_type_based.NoOpCore.html
Class
Class
PUBLIC
Just an object, you know?
-
automat._test.test_type_based.Gen
automat._test.test_type_based.Gen.html
Class
Class
PUBLIC
Undocumented
-
automat._test.test_type_based.Gen.t
automat._test.test_type_based.Gen.html#t
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._test.test_type_based.buildTestBuilder
automat._test.test_type_based.html#buildTestBuilder
Function
Function
PUBLIC
Undocumented
-
automat._test.test_type_based.builder
automat._test.test_type_based.html#builder
Attribute
Variable
PUBLIC
Undocumented
-
automat._test.test_type_based.machineFactory
automat._test.test_type_based.html#machineFactory
Attribute
Variable
PUBLIC
Undocumented
-
automat._test.test_type_based.needsSomething
automat._test.test_type_based.html#needsSomething
Function
Function
PUBLIC
we need data to build this state
-
automat._test.test_type_based.needsNothing
automat._test.test_type_based.html#needsNothing
Function
Function
PUBLIC
Undocumented
-
automat._test.test_type_based.SimpleProtocol
automat._test.test_type_based.SimpleProtocol.html
Class
Class
PUBLIC
No class docstring; 1/1 method documented
-
automat._test.test_type_based.SimpleProtocol.method
automat._test.test_type_based.SimpleProtocol.html#method
Function
Method
PUBLIC
A method
-
automat._test.test_type_based.Counter
automat._test.test_type_based.Counter.html
Class
Class
PUBLIC
No class docstring; 3/3 methods documented
-
automat._test.test_type_based.Counter.start
automat._test.test_type_based.Counter.html#start
Function
Method
PUBLIC
enter the counting state
-
automat._test.test_type_based.Counter.increment
automat._test.test_type_based.Counter.html#increment
Function
Method
PUBLIC
increment the counter
-
automat._test.test_type_based.Counter.stop
automat._test.test_type_based.Counter.html#stop
Function
Method
PUBLIC
stop
-
automat._test.test_type_based.Count
automat._test.test_type_based.Count.html
Class
Class
PUBLIC
Undocumented
-
automat._test.test_type_based.Count.value
automat._test.test_type_based.Count.html#value
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._test.test_type_based.TypeMachineTests
automat._test.test_type_based.TypeMachineTests.html
Class
Class
PUBLIC
No class docstring; 11/16 methods documented
-
automat._test.test_type_based.TypeMachineTests.test_oneTransition
automat._test.test_type_based.TypeMachineTests.html#test_oneTransition
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.TypeMachineTests.test_stateSpecificData
automat._test.test_type_based.TypeMachineTests.html#test_stateSpecificData
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.TypeMachineTests.test_stateSpecificDataWithoutData
automat._test.test_type_based.TypeMachineTests.html#test_stateSpecificDataWithoutData
Function
Method
PUBLIC
To facilitate common implementations of transition behavior methods, sometimes you want to implement a transition within a data state without taking a data parameter. To do this, pass the 'nodata=True' parameter to 'upon'.
-
automat._test.test_type_based.TypeMachineTests.test_incompleteTransitionDefinition
automat._test.test_type_based.TypeMachineTests.html#test_incompleteTransitionDefinition
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.TypeMachineTests.test_dataToData
automat._test.test_type_based.TypeMachineTests.html#test_dataToData
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.TypeMachineTests.test_dataFactoryArgs
automat._test.test_type_based.TypeMachineTests.html#test_dataFactoryArgs
Function
Method
PUBLIC
Any data factory that takes arguments will constrain the allowed signature of all protocol methods that transition into that state.
-
automat._test.test_type_based.TypeMachineTests.test_dataFactoryNoArgs
automat._test.test_type_based.TypeMachineTests.html#test_dataFactoryNoArgs
Function
Method
PUBLIC
Inverse of test_dataFactoryArgs where the data factory specifically does not take arguments, but the input specified does.
-
automat._test.test_type_based.TypeMachineTests.test_invalidTransition
automat._test.test_type_based.TypeMachineTests.html#test_invalidTransition
Function
Method
PUBLIC
Invalid transitions raise a NoTransition exception.
-
automat._test.test_type_based.TypeMachineTests.test_reentrancy
automat._test.test_type_based.TypeMachineTests.html#test_reentrancy
Function
Method
PUBLIC
During the execution of a transition behavior implementation function, you may invoke other methods on your state machine. However, the execution of the behavior of those methods will be deferred until the current behavior method is done executing...
-
automat._test.test_type_based.TypeMachineTests.test_reentrancyNotNoneError
automat._test.test_type_based.TypeMachineTests.html#test_reentrancyNotNoneError
Function
Method
PUBLIC
Undocumented
-
automat._test.test_type_based.TypeMachineTests.test_buildLock
automat._test.test_type_based.TypeMachineTests.html#test_buildLock
Function
Method
PUBLIC
``.build()`` locks the builder so it can no longer be modified.
-
automat._test.test_type_based.TypeMachineTests.test_methodMembership
automat._test.test_type_based.TypeMachineTests.html#test_methodMembership
Function
Method
PUBLIC
Input methods must be members of their protocol.
-
automat._test.test_type_based.TypeMachineTests.test_startInAlternateState
automat._test.test_type_based.TypeMachineTests.html#test_startInAlternateState
Function
Method
PUBLIC
The state machine can be started in an alternate state.
-
automat._test.test_type_based.TypeMachineTests.test_genericData
automat._test.test_type_based.TypeMachineTests.html#test_genericData
Function
Method
PUBLIC
Test to cover get_origin in generic assertion.
-
automat._test.test_type_based.TypeMachineTests.test_interfaceData
automat._test.test_type_based.TypeMachineTests.html#test_interfaceData
Function
Method
PUBLIC
Test to cover providedBy assertion.
-
automat._test.test_type_based.TypeMachineTests.test_noMethodsInAltStateDataFactory
automat._test.test_type_based.TypeMachineTests.html#test_noMethodsInAltStateDataFactory
Function
Method
PUBLIC
When the state machine is received by a data factory during construction, it is in an invalid state. It may be invoked after construction is complete.
-
automat._test.test_visualize.isGraphvizModuleInstalled
automat._test.test_visualize.html#isGraphvizModuleInstalled
Function
Function
PUBLIC
Is the graphviz Python module installed?
-
automat._test.test_visualize.isGraphvizInstalled
automat._test.test_visualize.html#isGraphvizInstalled
Function
Function
PUBLIC
Are the graphviz tools installed?
-
automat._test.test_visualize.sampleMachine
automat._test.test_visualize.html#sampleMachine
Function
Function
PUBLIC
-
automat._test.test_visualize.Sample
automat._test.test_visualize.Sample.html
Class
Class
PUBLIC
Undocumented
-
automat._test.test_visualize.Sample.go
automat._test.test_visualize.Sample.html#go
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.Core
automat._test.test_visualize.Core.html
Class
Class
PUBLIC
Undocumented
-
automat._test.test_visualize.sampleTypeMachine
automat._test.test_visualize.html#sampleTypeMachine
Function
Function
PUBLIC
-
automat._test.test_visualize.ElementMakerTests
automat._test.test_visualize.ElementMakerTests.html
Class
Class
PUBLIC
elementMaker
generates HTML representing the specified element.
-
automat._test.test_visualize.ElementMakerTests.setUp
automat._test.test_visualize.ElementMakerTests.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.ElementMakerTests.elementMaker
automat._test.test_visualize.ElementMakerTests.html#elementMaker
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.ElementMakerTests.test_sortsAttrs
automat._test.test_visualize.ElementMakerTests.html#test_sortsAttrs
Function
Method
PUBLIC
-
automat._test.test_visualize.ElementMakerTests.test_quotesAttrs
automat._test.test_visualize.ElementMakerTests.html#test_quotesAttrs
Function
Method
PUBLIC
elementMaker
quotes HTML attributes according to DOT's quoting rule.
-
automat._test.test_visualize.ElementMakerTests.test_noAttrs
automat._test.test_visualize.ElementMakerTests.html#test_noAttrs
Function
Method
PUBLIC
-
automat._test.test_visualize.HTMLElement
automat._test.test_visualize.HTMLElement.html
Class
Class
PUBLIC
Holds an HTML element, as created by elementMaker.
-
automat._test.test_visualize.HTMLElement.name
automat._test.test_visualize.HTMLElement.html#name
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.HTMLElement.children
automat._test.test_visualize.HTMLElement.html#children
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.HTMLElement.attributes
automat._test.test_visualize.HTMLElement.html#attributes
Attribute
Class Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.findElements
automat._test.test_visualize.html#findElements
Function
Function
PUBLIC
Recursively collect all elements in an
HTMLElement
tree that match the optional predicate.
-
automat._test.test_visualize.isLeaf
automat._test.test_visualize.html#isLeaf
Function
Function
PUBLIC
This HTML element is actually leaf node.
-
automat._test.test_visualize.TableMakerTests
automat._test.test_visualize.TableMakerTests.html
Class
Class
PUBLIC
Tests that ensure
tableMaker
generates HTML tables usable as labels in DOT graphs.
-
automat._test.test_visualize.TableMakerTests.fakeElementMaker
automat._test.test_visualize.TableMakerTests.html#fakeElementMaker
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.TableMakerTests.setUp
automat._test.test_visualize.TableMakerTests.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.TableMakerTests.inputLabel
automat._test.test_visualize.TableMakerTests.html#inputLabel
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.TableMakerTests.port
automat._test.test_visualize.TableMakerTests.html#port
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.TableMakerTests.tableMaker
automat._test.test_visualize.TableMakerTests.html#tableMaker
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.TableMakerTests.test_inputLabelRow
automat._test.test_visualize.TableMakerTests.html#test_inputLabelRow
Function
Method
PUBLIC
The table returned by
tableMaker
always contains the input symbol label in its first row, and that row contains one cell with a port attribute set to the provided port.
-
automat._test.test_visualize.TableMakerTests.test_noOutputLabels
automat._test.test_visualize.TableMakerTests.html#test_noOutputLabels
Function
Method
PUBLIC
tableMaker
does not add a colspan attribute to the input label's cell or a second row if there no output labels.
-
automat._test.test_visualize.TableMakerTests.test_withOutputLabels
automat._test.test_visualize.TableMakerTests.html#test_withOutputLabels
Function
Method
PUBLIC
tableMaker
adds a colspan attribute to the input label's cell equal to the number of output labels and a second row that contains the output labels.
-
automat._test.test_visualize.IntegrationTests
automat._test.test_visualize.IntegrationTests.html
Class
Class
PUBLIC
Tests which make sure Graphviz can understand the output produced by Automat.
-
automat._test.test_visualize.IntegrationTests.test_validGraphviz
automat._test.test_visualize.IntegrationTests.html#test_validGraphviz
Function
Method
PUBLIC
graphviz emits valid graphviz data.
-
automat._test.test_visualize.SpotChecks
automat._test.test_visualize.SpotChecks.html
Class
Class
PUBLIC
Tests to make sure that the output contains salient features of the machine being generated.
-
automat._test.test_visualize.SpotChecks.test_containsMachineFeatures
automat._test.test_visualize.SpotChecks.html#test_containsMachineFeatures
Function
Method
PUBLIC
The output of graphviz.Digraph
should contain the names of the states, inputs, outputs in the state machine.
-
automat._test.test_visualize.SpotChecks.test_containsTypeMachineFeatures
automat._test.test_visualize.SpotChecks.html#test_containsTypeMachineFeatures
Function
Method
PUBLIC
The output of graphviz.Digraph
should contain the names of the states, inputs, outputs in the state machine.
-
automat._test.test_visualize.RecordsDigraphActions
automat._test.test_visualize.RecordsDigraphActions.html
Class
Class
PUBLIC
-
automat._test.test_visualize.RecordsDigraphActions.__init__
automat._test.test_visualize.RecordsDigraphActions.html#__init__
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.RecordsDigraphActions.reset
automat._test.test_visualize.RecordsDigraphActions.html#reset
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.RecordsDigraphActions.renderCalls
automat._test.test_visualize.RecordsDigraphActions.html#renderCalls
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.RecordsDigraphActions.saveCalls
automat._test.test_visualize.RecordsDigraphActions.html#saveCalls
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.FakeDigraph
automat._test.test_visualize.FakeDigraph.html
Class
Class
PUBLIC
-
automat._test.test_visualize.FakeDigraph.__init__
automat._test.test_visualize.FakeDigraph.html#__init__
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.FakeDigraph._recorder
automat._test.test_visualize.FakeDigraph.html#_recorder
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._test.test_visualize.FakeDigraph.render
automat._test.test_visualize.FakeDigraph.html#render
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.FakeDigraph.save
automat._test.test_visualize.FakeDigraph.html#save
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.FakeMethodicalMachine
automat._test.test_visualize.FakeMethodicalMachine.html
Class
Class
PUBLIC
-
automat._test.test_visualize.FakeMethodicalMachine.__init__
automat._test.test_visualize.FakeMethodicalMachine.html#__init__
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.FakeMethodicalMachine._digraph
automat._test.test_visualize.FakeMethodicalMachine.html#_digraph
Attribute
Instance Variable
PRIVATE
Undocumented
-
automat._test.test_visualize.FakeMethodicalMachine.asDigraph
automat._test.test_visualize.FakeMethodicalMachine.html#asDigraph
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests
automat._test.test_visualize.VisualizeToolTests.html
Class
Class
PUBLIC
No class docstring; 0/6 instance variable, 6/10 methods documented
-
automat._test.test_visualize.VisualizeToolTests.setUp
automat._test.test_visualize.VisualizeToolTests.html#setUp
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.digraphRecorder
automat._test.test_visualize.VisualizeToolTests.html#digraphRecorder
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.fakeDigraph
automat._test.test_visualize.VisualizeToolTests.html#fakeDigraph
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.fakeProgname
automat._test.test_visualize.VisualizeToolTests.html#fakeProgname
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.fakeSysPath
automat._test.test_visualize.VisualizeToolTests.html#fakeSysPath
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.collectedOutput
automat._test.test_visualize.VisualizeToolTests.html#collectedOutput
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.fakeFQPN
automat._test.test_visualize.VisualizeToolTests.html#fakeFQPN
Attribute
Instance Variable
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.collectPrints
automat._test.test_visualize.VisualizeToolTests.html#collectPrints
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.fakeFindMachines
automat._test.test_visualize.VisualizeToolTests.html#fakeFindMachines
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.tool
automat._test.test_visualize.VisualizeToolTests.html#tool
Function
Method
PUBLIC
Undocumented
-
automat._test.test_visualize.VisualizeToolTests.test_checksCurrentDirectory
automat._test.test_visualize.VisualizeToolTests.html#test_checksCurrentDirectory
Function
Method
PUBLIC
-
automat._test.test_visualize.VisualizeToolTests.test_quietHidesOutput
automat._test.test_visualize.VisualizeToolTests.html#test_quietHidesOutput
Function
Method
PUBLIC
Passing -q/--quiet hides all output.
-
automat._test.test_visualize.VisualizeToolTests.test_onlySaveDot
automat._test.test_visualize.VisualizeToolTests.html#test_onlySaveDot
Function
Method
PUBLIC
Passing an empty string for --image-directory/-i disables rendering images.
-
automat._test.test_visualize.VisualizeToolTests.test_saveOnlyImage
automat._test.test_visualize.VisualizeToolTests.html#test_saveOnlyImage
Function
Method
PUBLIC
Passing an empty string for --dot-directory/-d disables saving dot files.
-
automat._test.test_visualize.VisualizeToolTests.test_saveDotAndImagesInDifferentDirectories
automat._test.test_visualize.VisualizeToolTests.html#test_saveDotAndImagesInDifferentDirectories
Function
Method
PUBLIC
Passing different directories to --image-directory and --dot-directory writes images and dot files to those directories.
-
automat._test.test_visualize.VisualizeToolTests.test_saveDotAndImagesInSameDirectory
automat._test.test_visualize.VisualizeToolTests.html#test_saveDotAndImagesInSameDirectory
Function
Method
PUBLIC
Passing the same directory to --image-directory and --dot-directory writes images and dot files to that one directory.
-
automat._visualize._gvquote
automat._visualize.html#_gvquote
Function
Function
PRIVATE
Undocumented
-
automat._visualize._gvhtml
automat._visualize.html#_gvhtml
Function
Function
PRIVATE
Undocumented
-
automat._visualize.elementMaker
automat._visualize.html#elementMaker
Function
Function
PUBLIC
Construct a string from the HTML element description.
-
automat._visualize.tableMaker
automat._visualize.html#tableMaker
Function
Function
PUBLIC
Construct an HTML table to label a state transition.
-
automat._visualize.escapify
automat._visualize.html#escapify
Function
Function
PUBLIC
Undocumented
-
automat._visualize.makeDigraph
automat._visualize.html#makeDigraph
Function
Function
PUBLIC
Produce a graphviz.Digraph
object from an automaton.
-
automat._visualize.tool
automat._visualize.html#tool
Function
Function
PUBLIC
Entry point for command line utility.