Skip to content

Retry

dendron.decorators.retry.Retry

Bases: DecoratorNode

A Retry node ticks its child node repeatedly as long as the child continues to return FAILURE.

Parameters:

Name Type Description Default
name `str`

The given name of this node.

 required
child `dendron.tree_node.TreeNode`

Optional child node. If None, it is the responsibility of the caller to ensure that the child_node member variable is set before the first tick() call.

 required
n_times `int`

Number of times to tick() the child node if it continues to return FAILURE.

 required
Source code in src/dendron/decorators/retry.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
45
46
47
48
49
50
51
52
53
54
class Retry(DecoratorNode):
    """
    A Retry node ticks its child node repeatedly as long as the child
    continues to return `FAILURE`.

    Args:
        name (`str`):
            The given name of this node.
        child (`dendron.tree_node.TreeNode`):
            Optional child node. If `None`, it is the responsibility of the
            caller to ensure that the `child_node` member variable is set
            before the first `tick()` call.
        n_times (`int`):
            Number of times to `tick()` the child node if it continues 
            to return `FAILURE`.
    """
    def __init__(self, name: str, child: TreeNode, n_times: int) -> None:
        super().__init__(self, child)
        self.n_times = n_times
        self.retry_ct = 0

    def reset(self) -> None:
        """
        Set the retry counter to 0 and instruct the child node to reset.
        """
        self.retry_ct = 0
        self.child_node.reset()

    def tick(self) -> NodeStatus:
        """
        Tick the child node until either it returns `SUCCESS` or the child 
        is `tick()`ed `n_times`.
        """
        should_retry = True

        while should_retry:
            child_status = self.child_node.execute_tick()
            match child_status:
                case NodeStatus.SUCCESS:
                    self.retry_ct = 0
                    self.reset_child()
                    return NodeStatus.SUCCESS
                case NodeStatus.FAILURE:
                    self.retry_ct += 1
                    should_retry = self.retry_ct < self.n_times
                case NodeStatus.RUNNING:
                    return NodeStatus.RUNNING

        self.retry_ct = 0
        return NodeStatus.FAILURE

reset()

Set the retry counter to 0 and instruct the child node to reset.

Source code in src/dendron/decorators/retry.py 
26
27
28
29
30
31
def reset(self) -> None:
    """
    Set the retry counter to 0 and instruct the child node to reset.
    """
    self.retry_ct = 0
    self.child_node.reset()

tick()

Tick the child node until either it returns SUCCESS or the child is tick()ed n_times.

Source code in src/dendron/decorators/retry.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def tick(self) -> NodeStatus:
    """
    Tick the child node until either it returns `SUCCESS` or the child 
    is `tick()`ed `n_times`.
    """
    should_retry = True

    while should_retry:
        child_status = self.child_node.execute_tick()
        match child_status:
            case NodeStatus.SUCCESS:
                self.retry_ct = 0
                self.reset_child()
                return NodeStatus.SUCCESS
            case NodeStatus.FAILURE:
                self.retry_ct += 1
                should_retry = self.retry_ct < self.n_times
            case NodeStatus.RUNNING:
                return NodeStatus.RUNNING

    self.retry_ct = 0
    return NodeStatus.FAILURE