Skip to content

RunOnce

dendron.decorators.run_once.RunOnce

Bases: DecoratorNode

The RunOnce decorator tracks whether or not its child has been ticked. If it has, the next time it is ticked the decorator will return a status of SKIPPED. It will continue to return that status until it is explicitly reset.

Parameters:

Name Type Description Default
name `str`

The given name of this node.

 required
child `dendron.tree_node.TreeNode`

The child node.

 required
Source code in src/dendron/decorators/run_once.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class RunOnce(DecoratorNode):
    """
    The RunOnce decorator tracks whether or not its child has been
    ticked. If it has, the next time it is ticked the decorator will
    return a status of `SKIPPED`. It will continue to return that
    status until it is explicitly reset.

    Args:
        name (`str`):
            The given name of this node.
        child (`dendron.tree_node.TreeNode`):
            The child node.
    """
    def __init__(self, name: str, child: TreeNode) -> None:
        super().__init__(name, child)
        self.has_run = False

    def reset(self) -> None:
        """
        Reset the `has_run` tracker so that the child node can be
        `tick()`ed again.
        """
        self.has_run = False
        self.status = NodeStatus.IDLE
        self.child_node.reset_status()

    def tick(self) -> NodeStatus:
        """
        If the child node has been `tick()`ed already, return a status
        of `SKIPPED` without `tick()`ing the child again. Otherwise 
        `tick()` the child node and set `has_run` to `True` so that the
        node will not be `tick()`ed again.
        """
        self.set_status(NodeStatus.RUNNING)
        if self.has_run:
            return NodeStatus.SKIPPED

        self.has_run = True
        child_status = self.child_node.execute_tick()
        return child_status

reset()

Reset the has_run tracker so that the child node can be tick()ed again.

Source code in src/dendron/decorators/run_once.py 
22
23
24
25
26
27
28
29
def reset(self) -> None:
    """
    Reset the `has_run` tracker so that the child node can be
    `tick()`ed again.
    """
    self.has_run = False
    self.status = NodeStatus.IDLE
    self.child_node.reset_status()

tick()

If the child node has been tick()ed already, return a status of SKIPPED without tick()ing the child again. Otherwise tick() the child node and set has_run to True so that the node will not be tick()ed again.

Source code in src/dendron/decorators/run_once.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def tick(self) -> NodeStatus:
    """
    If the child node has been `tick()`ed already, return a status
    of `SKIPPED` without `tick()`ing the child again. Otherwise 
    `tick()` the child node and set `has_run` to `True` so that the
    node will not be `tick()`ed again.
    """
    self.set_status(NodeStatus.RUNNING)
    if self.has_run:
        return NodeStatus.SKIPPED

    self.has_run = True
    child_status = self.child_node.execute_tick()
    return child_status