[decorators] finally-style decorators and idioms

stonier · stonier · commit 15d3060e034e · 2023-09-06T02:21:29.000Z
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -12,10 +12,15 @@
         "behaviours",
         "bierner",
         "bungcip",
+        "epilog",
+        "graphviz",
+        "literalinclude",
+        "noodly",
         "omnilib",
         "py_trees",
         "pydot",
         "pypi",
+        "seealso",
         "ufmt",
         "usort"
     ]
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,7 +3,7 @@ Release Notes
 
 Forthcoming
 -----------
-* ...
+* [decorators] finally-style decorators and idioms, `#427 <https://github.com/splintered-reality/py_trees/pull/427>`_
 
 2.2.3 (2023-02-08)
 ------------------
diff --git a/docs/demos.rst b/docs/demos.rst
@@ -147,6 +147,22 @@ py-trees-demo-eternal-guard
    :linenos:
    :caption: py_trees/demos/eternal_guard.py
 
+.. _py-trees-demo-eventually-program:
+
+py-trees-demo-eventually
+------------------------
+
+.. automodule:: py_trees.demos.eventually
+    :members:
+    :special-members:
+    :show-inheritance:
+    :synopsis: demo the finally-like decorator
+
+.. literalinclude:: ../py_trees/demos/eventually.py
+   :language: python
+   :linenos:
+   :caption: py_trees/demos/eventually.py
+
 .. _py-trees-demo-logging-program:
 
 py-trees-demo-logging
diff --git a/docs/dot/demo-eventually.dot b/docs/dot/demo-eventually.dot
@@ -0,0 +1,17 @@
+digraph pastafarianism {
+ordering=out;
+graph [fontname="times-roman"];
+node [fontname="times-roman"];
+edge [fontname="times-roman"];
+root [fillcolor=orange, fontcolor=black, fontsize=9, label="Ⓜ root", shape=box, style=filled];
+SetFlagFalse [fillcolor=gray, fontcolor=black, fontsize=9, label=SetFlagFalse, shape=ellipse, style=filled];
+root -> SetFlagFalse;
+Parallel [fillcolor=gold, fontcolor=black, fontsize=9, label="Parallel\nSuccessOnOne", shape=parallelogram, style=filled];
+root -> Parallel;
+Counter [fillcolor=gray, fontcolor=black, fontsize=9, label=Counter, shape=ellipse, style=filled];
+Parallel -> Counter;
+Eventually [fillcolor=ghostwhite, fontcolor=black, fontsize=9, label=Eventually, shape=ellipse, style=filled];
+Parallel -> Eventually;
+SetFlagTrue [fillcolor=gray, fontcolor=black, fontsize=9, label=SetFlagTrue, shape=ellipse, style=filled];
+Eventually -> SetFlagTrue;
+}
diff --git a/docs/dot/demo-finally-single-tick.dot b/docs/dot/demo-finally-single-tick.dot
@@ -0,0 +1,17 @@
+digraph pastafarianism {
+ordering=out;
+graph [fontname="times-roman"];
+node [fontname="times-roman"];
+edge [fontname="times-roman"];
+root [fillcolor=orange, fontcolor=black, fontsize=9, label="Ⓜ root", shape=box, style=filled];
+SetFlagFalse [fillcolor=gray, fontcolor=black, fontsize=9, label=SetFlagFalse, shape=ellipse, style=filled];
+root -> SetFlagFalse;
+Parallel [fillcolor=gold, fontcolor=black, fontsize=9, label="Parallel\nSuccessOnOne", shape=parallelogram, style=filled];
+root -> Parallel;
+Counter [fillcolor=gray, fontcolor=black, fontsize=9, label=Counter, shape=ellipse, style=filled];
+Parallel -> Counter;
+Finally [fillcolor=ghostwhite, fontcolor=black, fontsize=9, label=Finally, shape=ellipse, style=filled];
+Parallel -> Finally;
+SetFlagTrue [fillcolor=gray, fontcolor=black, fontsize=9, label=SetFlagTrue, shape=ellipse, style=filled];
+Finally -> SetFlagTrue;
+}
diff --git a/docs/dot/eventually.dot b/docs/dot/eventually.dot
@@ -0,0 +1,17 @@
+digraph pastafarianism {
+ordering=out;
+graph [fontname="times-roman"];
+node [fontname="times-roman"];
+edge [fontname="times-roman"];
+Parallel [fillcolor=gold, fontcolor=black, fontsize=9, label="Parallel\nSuccessOnOne", shape=parallelogram, style=filled];
+Worker [fillcolor=orange, fontcolor=black, fontsize=9, label="Ⓜ Worker", shape=box, style=filled];
+Parallel -> Worker;
+Glory [fillcolor=gray, fontcolor=black, fontsize=9, label=Glory, shape=ellipse, style=filled];
+Worker -> Glory;
+Infamy [fillcolor=gray, fontcolor=black, fontsize=9, label=Infamy, shape=ellipse, style=filled];
+Worker -> Infamy;
+Eventually [fillcolor=ghostwhite, fontcolor=black, fontsize=9, label=Eventually, shape=ellipse, style=filled];
+Parallel -> Eventually;
+Colander [fillcolor=gray, fontcolor=black, fontsize=9, label=Colander, shape=ellipse, style=filled];
+Eventually -> Colander;
+}
diff --git a/docs/examples/eventually.py b/docs/examples/eventually.py
@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import py_trees
+
+if __name__ == "__main__":
+    root = py_trees
+    task_one = py_trees.behaviours.StatusQueue(
+        name="Glory",
+        queue=[
+            py_trees.common.Status.RUNNING,
+        ],
+        eventually=py_trees.common.Status.SUCCESS,
+    )
+    task_two = py_trees.behaviours.Success(name="Infamy")
+    worker = py_trees.composites.Sequence(
+        name="Worker", memory=True, children=[task_one, task_two]
+    )
+    root = py_trees.idioms.eventually(
+        name="Parallel",
+        worker=worker,
+        eventually=py_trees.behaviours.Success("Colander"),
+    )
+    py_trees.display.render_dot_tree(
+        root, py_trees.common.string_to_visibility_level("all")
+    )
diff --git a/docs/images/finally_single_tick.png b/docs/images/finally_single_tick.png
diff --git a/py_trees/behaviour.py b/py_trees/behaviour.py
@@ -344,7 +344,7 @@ def iterate(self, direct_descendants: bool = False) -> typing.Iterator[Behaviour
                 yield child
         yield self
 
-    # TODO: better type refinement of 'viso=itor'
+    # TODO: better type refinement of 'visitor'
     def visit(self, visitor: typing.Any) -> None:
         """
         Introspect on this behaviour with a visitor.
diff --git a/py_trees/behaviours.py b/py_trees/behaviours.py
@@ -280,6 +280,7 @@ def update(self) -> common.Status:
             :data:`~py_trees.common.Status.RUNNING` while not expired, the given completion status otherwise
         """
         self.counter += 1
+        self.feedback_message = f"count: {self.counter}"
         if self.counter <= self.duration:
             return common.Status.RUNNING
         else:
diff --git a/py_trees/decorators.py b/py_trees/decorators.py
@@ -38,6 +38,7 @@
 * :class:`py_trees.decorators.EternalGuard`
 * :class:`py_trees.decorators.Inverter`
 * :class:`py_trees.decorators.OneShot`
+* :class:`py_trees.decorators.OnTerminate`
 * :class:`py_trees.decorators.Repeat`
 * :class:`py_trees.decorators.Retry`
 * :class:`py_trees.decorators.StatusToBlackboard`
@@ -920,3 +921,64 @@ def update(self) -> common.Status:
             the behaviour's new status :class:`~py_trees.common.Status`
         """
         return self.decorated.status
+
+
+class OnTerminate(Decorator):
+    """
+    Trigger the child for a single tick on :meth:`terminate`.
+
+    Always return :data:`~py_trees.common.Status.RUNNING` and on
+    on :meth:`terminate`, call the child's
+    :meth:`~py_trees.behaviour.Behaviour.update` method, once.
+
+    This is useful to cleanup, restore a context switch or to
+    implement a finally-like behaviour.
+
+    .. seealso:: :meth:`py_trees.idioms.eventually`
+    """
+
+    def __init__(self, name: str, child: behaviour.Behaviour):
+        """
+        Initialise with the standard decorator arguments.
+
+        Args:
+            name: the decorator name
+            child: the child to be decorated
+        """
+        super(OnTerminate, self).__init__(name=name, child=child)
+
+    def tick(self) -> typing.Iterator[behaviour.Behaviour]:
+        """
+        Bypass the child when ticking.
+
+        Yields:
+            a reference to itself
+        """
+        self.logger.debug(f"{self.__class__.__name__}.tick()")
+        self.status = self.update()
+        yield self
+
+    def update(self):
+        """
+        Return with :data:`~py_trees.common.Status.RUNNING`.
+
+        Returns:
+            the behaviour's new status :class:`~py_trees.common.Status`
+        """
+        return common.Status.RUNNING
+
+    def terminate(self, new_status: common.Status) -> None:
+        """Tick the child behaviour once."""
+        self.logger.debug(
+            "{}.terminate({})".format(
+                self.__class__.__name__,
+                "{}->{}".format(self.status, new_status)
+                if self.status != new_status
+                else f"{new_status}",
+            )
+        )
+        if new_status == common.Status.INVALID:
+            self.decorated.tick_once()
+            # Do not need to stop the child here - this method
+            # is only called by Decorator.stop() which will handle
+            # that responsibility immediately after this method returns.
diff --git a/py_trees/demos/__init__.py b/py_trees/demos/__init__.py
@@ -21,6 +21,7 @@
 from . import display_modes  # usort:skip  # noqa: F401
 from . import dot_graphs  # usort:skip  # noqa: F401
 from . import either_or  # usort:skip  # noqa: F401
+from . import eventually  # usort:skip  # noqa: F401
 from . import lifecycle  # usort:skip  # noqa: F401
 from . import selector  # usort:skip  # noqa: F401
 from . import sequence  # usort:skip  # noqa: F401
diff --git a/py_trees/demos/eventually.py b/py_trees/demos/eventually.py
@@ -0,0 +1,172 @@
+#!/usr/bin/env python
+#
+# License: BSD
+#   https://raw.githubusercontent.com/splintered-reality/py_trees/devel/LICENSE
+#
+##############################################################################
+# Documentation
+##############################################################################
+
+"""
+Trigger 'finally'-like behaviour with :meth:`py_trees.idioms.eventually`.
+
+.. argparse::
+   :module: py_trees.demos.eventually
+   :func: command_line_argument_parser
+   :prog: py-trees-demo-eventually
+
+.. graphviz:: dot/demo-eventually.dot
+
+.. image:: images/finally_single_tick.png
+
+"""
+
+##############################################################################
+# Imports
+##############################################################################
+
+import argparse
+import sys
+import typing
+
+import py_trees
+import py_trees.console as console
+
+##############################################################################
+# Classes
+##############################################################################
+
+
+def description(root: py_trees.behaviour.Behaviour) -> str:
+    """
+    Print description and usage information about the program.
+
+    Returns:
+       the program description string
+    """
+    content = "Trigger python-like 'finally' behaviour with the 'Eventually' idiom.\n\n"
+    content += "A blackboard flag is set to false prior to commencing work. \n"
+    content += "Once the work terminates, the decorator and it's child\n"
+    content += "child will also terminate and toggle the flag to true.\n"
+    content += "\n"
+    content += "The demonstration is run twice - on the first occasion\n"
+    content += "the work terminates with SUCCESS and on the second, it\n"
+    content += "terminates with FAILURE.\n"
+    content += "\n"
+    content += "EVENTS\n"
+    content += "\n"
+    content += " -  1 : flag is set to false, worker is running\n"
+    content += " -  2 : worker completes (with SUCCESS||FAILURE)\n"
+    content += " -  2 : eventually is triggered, flag is set to true\n"
+    content += "\n"
+    if py_trees.console.has_colours:
+        banner_line = console.green + "*" * 79 + "\n" + console.reset
+        s = banner_line
+        s += console.bold_white + "Finally".center(79) + "\n" + console.reset
+        s += banner_line
+        s += "\n"
+        s += content
+        s += "\n"
+        s += banner_line
+    else:
+        s = content
+    return s
+
+
+def epilog() -> typing.Optional[str]:
+    """
+    Print a noodly epilog for --help.
+
+    Returns:
+       the noodly message
+    """
+    if py_trees.console.has_colours:
+        return (
+            console.cyan
+            + "And his noodly appendage reached forth to tickle the blessed...\n"
+            + console.reset
+        )
+    else:
+        return None
+
+
+def command_line_argument_parser() -> argparse.ArgumentParser:
+    """
+    Process command line arguments.
+
+    Returns:
+        the argument parser
+    """
+    parser = argparse.ArgumentParser(
+        description=description(create_root(py_trees.common.Status.SUCCESS)),
+        epilog=epilog(),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    group = parser.add_mutually_exclusive_group()
+    group.add_argument(
+        "-r", "--render", action="store_true", help="render dot tree to file"
+    )
+    return parser
+
+
+def create_root(
+    expected_work_termination_result: py_trees.common.Status,
+) -> py_trees.behaviour.Behaviour:
+    """
+    Create the root behaviour and it's subtree.
+
+    Returns:
+        the root behaviour
+    """
+    root = py_trees.composites.Sequence(name="Root", memory=True)
+    set_flag_to_false = py_trees.behaviours.SetBlackboardVariable(
+        name="SetFlagFalse",
+        variable_name="flag",
+        variable_value=False,
+        overwrite=True,
+    )
+    set_flag_to_true = py_trees.behaviours.SetBlackboardVariable(
+        name="SetFlagTrue", variable_name="flag", variable_value=True, overwrite=True
+    )
+    worker = py_trees.behaviours.TickCounter(
+        name="Counter", duration=1, completion_status=expected_work_termination_result
+    )
+    parallel = py_trees.idioms.eventually(
+        name="Parallel",
+        worker=worker,
+        eventually=set_flag_to_true,
+    )
+    root.add_children([set_flag_to_false, parallel])
+    return root
+
+
+##############################################################################
+# Main
+##############################################################################
+
+
+def main() -> None:
+    """Entry point for the demo script."""
+    args = command_line_argument_parser().parse_args()
+    # py_trees.logging.level = py_trees.logging.Level.DEBUG
+    print(description(create_root(py_trees.common.Status.SUCCESS)))
+
+    ####################
+    # Rendering
+    ####################
+    if args.render:
+        py_trees.display.render_dot_tree(create_root(py_trees.common.Status.SUCCESS))
+        sys.exit()
+
+    for status in (py_trees.common.Status.SUCCESS, py_trees.common.Status.FAILURE):
+        py_trees.blackboard.Blackboard.clear()
+        console.banner(f"Experiment - Terminate with {status}")
+        root = create_root(status)
+        root.tick_once()
+        print(py_trees.display.unicode_tree(root=root, show_status=True))
+        print(py_trees.display.unicode_blackboard())
+        root.tick_once()
+        print(py_trees.display.unicode_tree(root=root, show_status=True))
+        print(py_trees.display.unicode_blackboard())
+
+    print("\n")
diff --git a/py_trees/idioms.py b/py_trees/idioms.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/tests/test_decorators.py b/tests/test_decorators.py
