py_trees package

Subpackages

• py_trees.demos package
  • Subpackages
    • py_trees.demos.ports package
      • Submodules
      • Module contents
  • Submodules
    • py_trees.demos.action module
      • Action
      • command_line_argument_parser()
      • description()
      • epilog()
      • main()
      • planning()
    • py_trees.demos.blackboard module
      • BlackboardWriter
      • Nested
      • ParamsAndState
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
    • py_trees.demos.blackboard_namespaces module
      • command_line_argument_parser()
      • description()
      • epilog()
      • main()
    • py_trees.demos.blackboard_remappings module
      • Remap
      • command_line_argument_parser()
      • description()
      • epilog()
      • main()
    • py_trees.demos.context_switching module
      • ContextSwitch
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
    • py_trees.demos.display_modes module
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
    • py_trees.demos.dot_graphs module
      • command_line_argument_parser()
      • create_tree()
      • description()
      • epilog()
      • main()
    • py_trees.demos.either_or module
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
      • post_tick_handler()
      • pre_tick_handler()
    • py_trees.demos.eternal_guard module
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
      • post_tick_handler()
      • pre_tick_handler()
    • py_trees.demos.lifecycle module
      • Counter
      • command_line_argument_parser()
      • description()
      • epilog()
      • main()
    • py_trees.demos.logging module
      • command_line_argument_parser()
      • create_tree()
      • description()
      • epilog()
      • logger()
      • main()
    • py_trees.demos.pick_up_where_you_left_off module
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
      • post_tick_handler()
      • pre_tick_handler()
    • py_trees.demos.selector module
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
    • py_trees.demos.sequence module
      • command_line_argument_parser()
      • create_root()
      • description()
      • epilog()
      • main()
    • py_trees.demos.stewardship module
      • Finisher
      • PeriodicSuccess
      • SuccessEveryN
      • command_line_argument_parser()
      • create_tree()
      • description()
      • epilog()
      • main()
      • pre_tick_handler()
  • Module contents
• py_trees.parsers package
  • Submodules
    • py_trees.parsers.behaviour_tree_xml module
      • Overview
      • Subtree templates and instantiation
      • Parsing walkthrough
      • Key concepts
      • add_new_key_to_remapping_table()
      • build_bt_index()
      • build_port_remappings()
      • build_subtree_remapping()
      • build_tree_from_xml()
      • get_absolute_reference()
      • get_class_from_init_lookup()
      • get_key_name()
      • instantiate_ports_node()
      • is_key()
      • parse_behaviour_tree_xml()
      • resolve_direct_value_remapping()
      • resolve_key_remapping()
  • Module contents
• py_trees.programs package
  • Submodules
    • py_trees.programs.render module
      • command_line_argument_parser()
      • description()
      • epilog()
      • examples()
      • main()
  • Module contents

Submodules

• py_trees.behaviour module
  • Behaviour
    • Behaviour.attach_blackboard_client()
    • Behaviour.has_parent_with_instance_type()
    • Behaviour.has_parent_with_name()
    • Behaviour.initialise()
    • Behaviour.iterate()
    • Behaviour.setup()
    • Behaviour.setup_with_descendants()
    • Behaviour.shutdown()
    • Behaviour.stop()
    • Behaviour.terminate()
    • Behaviour.tick()
    • Behaviour.tick_once()
    • Behaviour.tip()
    • Behaviour.update()
    • Behaviour.visit()
• py_trees.behaviours module
  • BlackboardToStatus
    • BlackboardToStatus.update()
  • CheckBlackboardVariableExists
    • CheckBlackboardVariableExists.update()
  • CheckBlackboardVariableValue
    • CheckBlackboardVariableValue.update()
  • CheckBlackboardVariableValues
    • CheckBlackboardVariableValues.update()
  • CompareBlackboardVariables
    • CompareBlackboardVariables.update()
  • Dummy
    • Dummy.terminate()
    • Dummy.update()
  • Failure
    • Failure.terminate()
    • Failure.update()
  • Periodic
    • Periodic.update()
  • ProbabilisticBehaviour
    • ProbabilisticBehaviour.update()
  • Running
    • Running.terminate()
    • Running.update()
  • SetBlackboardVariable
    • SetBlackboardVariable.update()
  • StatusQueue
    • StatusQueue.terminate()
    • StatusQueue.update()
  • Success
    • Success.terminate()
    • Success.update()
  • SuccessEveryN
    • SuccessEveryN.update()
  • TickCounter
    • TickCounter.initialise()
    • TickCounter.update()
  • UnsetBlackboardVariable
    • UnsetBlackboardVariable.update()
  • WaitForBlackboardVariable
    • WaitForBlackboardVariable.update()
  • WaitForBlackboardVariableValue
    • WaitForBlackboardVariableValue.update()
  • dummy()
  • failure()
  • running()
  • success()
• py_trees.blackboard module
  • ActivityItem
  • ActivityStream
    • ActivityStream.clear()
    • ActivityStream.push()
  • ActivityType
    • ActivityType.ACCESSED
    • ActivityType.ACCESS_DENIED
    • ActivityType.INITIALISED
    • ActivityType.NO_KEY
    • ActivityType.NO_OVERWRITE
    • ActivityType.READ
    • ActivityType.UNSET
    • ActivityType.WRITE
  • Blackboard
    • Blackboard.absolute_name()
    • Blackboard.activity_stream
    • Blackboard.clear()
    • Blackboard.clients
    • Blackboard.disable_activity_stream()
    • Blackboard.enable_activity_stream()
    • Blackboard.exists()
    • Blackboard.get()
    • Blackboard.key()
    • Blackboard.key_with_attributes()
    • Blackboard.keys()
    • Blackboard.keys_filtered_by_clients()
    • Blackboard.keys_filtered_by_regex()
    • Blackboard.metadata
    • Blackboard.relative_name()
    • Blackboard.separator
    • Blackboard.set()
    • Blackboard.storage
    • Blackboard.unset()
  • Client
    • Client.absolute_name()
    • Client.exists()
    • Client.get()
    • Client.id()
    • Client.is_registered()
    • Client.register_key()
    • Client.set()
    • Client.unregister()
    • Client.unregister_all_keys()
    • Client.unregister_key()
    • Client.unset()
    • Client.verify_required_keys_exist()
  • IntermediateVariableFetcher
  • KeyMetaData
    • KeyMetaData.exclusive
    • KeyMetaData.read
    • KeyMetaData.write
• py_trees.common module
  • Access
    • Access.EXCLUSIVE_WRITE
    • Access.READ
    • Access.WRITE
  • BlackBoxLevel
    • BlackBoxLevel.BIG_PICTURE
    • BlackBoxLevel.COMPONENT
    • BlackBoxLevel.DETAIL
    • BlackBoxLevel.NOT_A_BLACKBOX
  • ClearingPolicy
    • ClearingPolicy.NEVER
    • ClearingPolicy.ON_INITIALISE
    • ClearingPolicy.ON_SUCCESS
  • ComparisonExpression
  • Duration
    • Duration.INFINITE
    • Duration.UNTIL_THE_BATTLE_OF_ALFREDO
  • Name
    • Name.AUTO_GENERATED
  • OneShotPolicy
    • OneShotPolicy.ON_COMPLETION
    • OneShotPolicy.ON_SUCCESSFUL_COMPLETION
  • ParallelPolicy
    • ParallelPolicy.Base
    • ParallelPolicy.SuccessOnAll
    • ParallelPolicy.SuccessOnOne
    • ParallelPolicy.SuccessOnSelected
  • Status
    • Status.FAILURE
    • Status.INVALID
    • Status.RUNNING
    • Status.SUCCESS
  • VisibilityLevel
    • VisibilityLevel.ALL
    • VisibilityLevel.BIG_PICTURE
    • VisibilityLevel.COMPONENT
    • VisibilityLevel.DETAIL
  • string_to_visibility_level()
  • visibility_level_strings
• py_trees.composites module
  • Composite
    • Composite.add_child()
    • Composite.add_children()
    • Composite.insert_child()
    • Composite.prepend_child()
    • Composite.remove_all_children()
    • Composite.remove_child()
    • Composite.remove_child_by_id()
    • Composite.replace_child()
    • Composite.stop()
    • Composite.tick()
    • Composite.tip()
    • Composite.update()
  • Parallel
    • Parallel.setup()
    • Parallel.stop()
    • Parallel.tick()
    • Parallel.validate_policy_configuration()
  • Selector
    • Selector.stop()
    • Selector.tick()
  • Sequence
    • Sequence.stop()
    • Sequence.tick()
• py_trees.console module
  • banner()
  • colours
  • console_has_colours()
  • debug()
  • define_symbol_or_fallback()
  • error()
  • has_colours
  • has_unicode()
  • info()
  • logdebug()
  • logerror()
  • logfatal()
  • loginfo()
  • logwarn()
  • pretty_print()
  • pretty_println()
  • read_single_keypress()
  • warning()
• py_trees.decorators module
  • Condition
    • Condition.update()
  • Count
    • Count.setup()
    • Count.terminate()
    • Count.update()
  • Decorator
    • Decorator.stop()
    • Decorator.tick()
    • Decorator.tip()
  • EternalGuard
    • EternalGuard.tick()
    • EternalGuard.update()
  • FailureIsRunning
    • FailureIsRunning.update()
  • FailureIsSuccess
    • FailureIsSuccess.update()
  • ForEach
    • ForEach.initialise()
    • ForEach.terminate()
    • ForEach.update()
  • Inverter
    • Inverter.update()
  • OneShot
    • OneShot.terminate()
    • OneShot.tick()
    • OneShot.update()
  • PassThrough
    • PassThrough.update()
  • Repeat
    • Repeat.initialise()
    • Repeat.update()
  • Retry
    • Retry.initialise()
    • Retry.update()
  • RunningIsFailure
    • RunningIsFailure.update()
  • RunningIsSuccess
    • RunningIsSuccess.update()
  • StatusToBlackboard
    • StatusToBlackboard.update()
  • SuccessIsFailure
    • SuccessIsFailure.update()
  • SuccessIsRunning
    • SuccessIsRunning.update()
  • Timeout
    • Timeout.initialise()
    • Timeout.update()
• py_trees.display module
  • ascii_blackboard()
  • ascii_symbols
  • ascii_tree()
  • dot_tree()
  • render_dot_tree()
  • unicode_blackboard()
  • unicode_blackboard_activity_stream()
  • unicode_symbols
  • unicode_tree()
  • xhtml_symbols
  • xhtml_tree()
• py_trees.idioms module
  • either_or()
  • oneshot()
  • pick_up_where_you_left_off()
• py_trees.logging module
  • Level
    • Level.DEBUG
    • Level.ERROR
    • Level.INFO
    • Level.WARN
  • Logger
    • Logger.debug()
    • Logger.error()
    • Logger.info()
    • Logger.warning()
• py_trees.meta module
  • create_behaviour_from_function()
• py_trees.ports module
  • BehaviourWithPorts
    • BehaviourWithPorts.update()
  • NoDataAvailable
  • PortInformation
    • PortInformation.data_type
    • PortInformation.description
    • PortInformation.required
  • PortsMixin
    • PortsMixin.behaviour_class_name
    • PortsMixin.blackboard_client
    • PortsMixin.get_input()
    • PortsMixin.get_last_output()
    • PortsMixin.get_logger()
    • PortsMixin.get_port_type()
    • PortsMixin.input_ports()
    • PortsMixin.is_port_required()
    • PortsMixin.log()
    • PortsMixin.log_debug()
    • PortsMixin.log_error()
    • PortsMixin.log_info()
    • PortsMixin.log_warning()
    • PortsMixin.output_ports()
    • PortsMixin.reset_all_output_ports()
    • PortsMixin.reset_port()
    • PortsMixin.setup_ports()
    • PortsMixin.subtree_namespace
• py_trees.ports_utils module
  • LogLevel
    • LogLevel.DEBUG
    • LogLevel.ERROR
    • LogLevel.INFO
    • LogLevel.WARNING
  • PortsLogger
    • PortsLogger.debug()
    • PortsLogger.error()
    • PortsLogger.info()
    • PortsLogger.warning()
  • apply_type_hints()
  • convert_str_to_type()
  • find_node_by_class()
  • find_node_by_name()
  • generate_node_name()
  • get_base_name()
  • reset_blackboard_key()
  • sanitize_name_for_blackboard_use()
  • set_feedback_and_log()
  • strip_trailing_uuid4()
  • uuid4_regex()
• py_trees.syntax_highlighting module
  • status()
  • status_colour_code()
• py_trees.tests module
  • clear_blackboard()
  • pre_tick_visitor()
  • print_assert_banner()
  • print_assert_details()
  • print_summary()
  • tick_tree()
• py_trees.timers module
  • Timer
    • Timer.initialise()
    • Timer.update()
• py_trees.trees module
  • BehaviourTree
    • BehaviourTree.add_post_tick_handler()
    • BehaviourTree.add_pre_tick_handler()
    • BehaviourTree.add_visitor()
    • BehaviourTree.insert_subtree()
    • BehaviourTree.interrupt()
    • BehaviourTree.prune_subtree()
    • BehaviourTree.replace_subtree()
    • BehaviourTree.setup()
    • BehaviourTree.shutdown()
    • BehaviourTree.tick()
    • BehaviourTree.tick_tock()
    • BehaviourTree.tip()
  • setup()
• py_trees.utilities module
  • Process
    • Process.exception
    • Process.run()
  • get_fully_qualified_name()
  • get_valid_filename()
  • is_primitive()
  • static_variables()
  • truncate()
  • which()
• py_trees.version module
• py_trees.visitors module
  • DebugVisitor
    • DebugVisitor.run()
  • DisplaySnapshotVisitor
    • DisplaySnapshotVisitor.finalise()
    • DisplaySnapshotVisitor.initialise()
    • DisplaySnapshotVisitor.run()
  • SnapshotVisitor
    • SnapshotVisitor.initialise()
    • SnapshotVisitor.run()
  • VisitorBase
    • VisitorBase.finalise()
    • VisitorBase.initialise()
    • VisitorBase.run()

Module contents

This is the top-level namespace of the py_trees package.