Automat API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • automat._test.test_type_based.Count - Undocumented
  • automat._test.test_type_based.NoOpCore - Just an object, you know?
  • automat._test.test_visualize.Core - Undocumented
  • automat._typed.TypedInput - Undocumented
  • Exception
    • automat._discover.InvalidFQPN - The given FQPN was not a dot-separated list of Python objects.
      • automat._discover.NoModule - A prefix of the FQPN was not an importable module or package.
      • automat._discover.NoObject - A suffix of the FQPN was not an accessible object
    • automat.AlreadyBuiltError - The TypeMachine is already built, and thus can no longer be modified.
    • automat.NoTransition - A finite state machine in state has no transition for symbol.
  • object
    • automat._methodical.MethodicalInput - An input for a MethodicalMachine.
    • automat._methodical.MethodicalOutput - An output for a MethodicalMachine.
    • automat._methodical.MethodicalState - A state for a MethodicalMachine.
    • automat._methodical.MethodicalTracer - Undocumented
    • automat._test.test_trace.SampleObject - No class docstring; 0/1 class variable, 7/7 methods documented
    • automat._test.test_visualize.FakeDigraph - A fake graphviz.Digraph. Instantiate it with a RecordsDigraphActions.
    • automat._test.test_visualize.FakeMethodicalMachine - A fake MethodicalMachine. Instantiate it with a FakeDigraph
    • automat._test.test_visualize.HTMLElement - Holds an HTML element, as created by elementMaker.
    • automat._test.test_visualize.RecordsDigraphActions - Records calls made to FakeDigraph.
    • automat.MethodicalMachine - A MethodicalMachine is an interface to an Automaton that uses methods on a class.
  • typing.Generic
    • automat._core.Automaton - A declaration of a finite state machine.
    • automat._core.Transitioner - The combination of a current state and an Automaton.
    • automat._test.test_type_based.Gen - Undocumented
    • automat._typed.DataOutput - Construct an output for the given data objects.
    • automat._typed.InputImplementer - An InputImplementer implements an input protocol in terms of a state machine.
    • automat._typed.MethodOutput - 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.TransitionRegistrar - 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.TypedDataState - Undocumented
    • automat._typed.TypedState - The result of .state().
    • automat._typed.UponFromData - Type parameter P: the signature of the input method.
    • automat._typed.UponFromNo - Type parameter P: the signature of the input method.
    • automat.NoTransition - A finite state machine in state has no transition for symbol.
    • automat.TypeMachine - A TypeMachine is a factory for instances of InputProtocol.
    • automat.TypeMachineBuilder - The main entry-point into Automat, used to construct a factory for instances of InputProtocol that take an instance of Core.
  • typing.Protocol
    • automat._test.test_type_based.ArgTaker - Undocumented
    • automat._test.test_type_based.Counter - No class docstring; 3/3 methods documented
    • automat._test.test_type_based.ProtocolForTesting - No class docstring; 2/2 methods documented
    • automat._test.test_type_based.SimpleProtocol - No class docstring; 1/1 method documented
    • automat._test.test_visualize.Sample - Undocumented
    • automat._typed.SomeOutput - A state machine output.
  • unittest.TestCase
    • automat._test.test_core.CoreTests - Tests for Automat's (currently private, implementation detail) core.
    • automat._test.test_discover._WritesPythonModules - A helper that enables generating Python module test fixtures.
      • automat._test.test_discover.FindMachinesIntegrationTests - Integration tests to check that findMachines yields all machines discoverable at or below an FQPN.
      • automat._test.test_discover.FindMachinesViaWrapperTests - findMachinesViaWrapper recursively yields FQPN, MethodicalMachine pairs in and under a given twisted.python.modules.PythonModule or twisted.python.modules.PythonAttribute.
      • automat._test.test_discover.OriginalLocationTests - Tests that isOriginalLocation detects when a PythonAttribute's FQPN refers to an object inside the module where it was defined.
    • automat._test.test_discover.WrapFQPNTests - Tests that ensure wrapFQPN loads the twisted.python.modules.PythonModule or twisted.python.modules.PythonAttribute for a given FQPN.
    • automat._test.test_methodical.MethodicalTests - Tests for MethodicalMachine.
    • automat._test.test_trace.TraceTests - Undocumented
    • automat._test.test_type_based.TypeMachineTests - No class docstring; 11/16 methods documented
    • automat._test.test_visualize.ElementMakerTests - elementMaker generates HTML representing the specified element.
    • automat._test.test_visualize.IntegrationTests - Tests which make sure Graphviz can understand the output produced by Automat.
    • automat._test.test_visualize.SpotChecks - Tests to make sure that the output contains salient features of the machine being generated.
    • automat._test.test_visualize.TableMakerTests - Tests that ensure tableMaker generates HTML tables usable as labels in DOT graphs.
    • automat._test.test_visualize.VisualizeToolTests - No class docstring; 0/6 instance variable, 6/10 methods documented
  • zope.interface.Interface
    • automat._test.test_type_based.ISomething - Undocumented

API Documentation for Automat, generated by pydoctor 24.11.1 at 2025-03-17 00:00:00.