Skip to content

plpipes.action.base#

Action #

Represents an action to be performed within the plpipes framework.

Attributes:

Name Type Description
_name str

The name of the action.
_cfg dict

Configuration parameters for the action.
Source code in src\plpipes\action\base.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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
class Action:
    """
    Represents an action to be performed within the plpipes framework.

    Attributes:
        _name (str): The name of the action.
        _cfg (dict): Configuration parameters for the action.
    """

    def __init__(self, name, action_cfg):
        """
        Initializes the Action instance.

        Args:
            name (str): The name of the action.
            action_cfg (dict): Configuration parameters for the action.
        """
        self._name = name
        self._cfg = action_cfg

    def name(self):
        """
        Returns the name of the action.

        Returns:
            str: The name of the action.
        """
        return self._name

    def short_name(self):
        """
        Returns the short name of the action, derived from the full name.

        Returns:
            str: The short name of the action.
        """
        return re.split(r'[./\\]', self._name)[-1]

    def _do_it(self, indent):
        """
        Executes the action.

        Args:
            indent (int): The indentation level for logging.
        """
        self.do_it()

    def do_it(self):
        """
        The main logic of the action must be implemented in subclasses.
        This should contain the code that performs the action.
        """
        ...

    def run(self, indent=0):
        """
        Executes the action and logs its execution time.

        Args:
            indent (int): The indentation level for logging.
        """
        name = self.name()
        logging.info(f"{' '*indent}Action {name} started")
        start = time.time()
        self._do_it(indent=indent)
        lapse = int(10 * (time.time() - start) + 0.5) / 10.0
        logging.info(f"{' '*indent}Action {name} done ({lapse}s)")

    def __str__(self):
        """
        Returns a string representation of the Action instance.

        Returns:
            str: A string representation of the Action.
        """
        return f"<Action {self._name}>"

__init__(name, action_cfg) #

Initializes the Action instance.

Parameters:

Name Type Description Default
name str

The name of the action.

 required
action_cfg dict

Configuration parameters for the action.

 required
Source code in src\plpipes\action\base.py 
14
15
16
17
18
19
20
21
22
23
def __init__(self, name, action_cfg):
    """
    Initializes the Action instance.

    Args:
        name (str): The name of the action.
        action_cfg (dict): Configuration parameters for the action.
    """
    self._name = name
    self._cfg = action_cfg

__str__() #

Returns a string representation of the Action instance.

Returns:

Name Type Description
str

A string representation of the Action.
Source code in src\plpipes\action\base.py 
73
74
75
76
77
78
79
80
def __str__(self):
    """
    Returns a string representation of the Action instance.

    Returns:
        str: A string representation of the Action.
    """
    return f"<Action {self._name}>"

do_it() #

The main logic of the action must be implemented in subclasses. This should contain the code that performs the action.

Source code in src\plpipes\action\base.py 
52
53
54
55
56
57
def do_it(self):
    """
    The main logic of the action must be implemented in subclasses.
    This should contain the code that performs the action.
    """
    ...

name() #

Returns the name of the action.

Returns:

Name Type Description
str

The name of the action.
Source code in src\plpipes\action\base.py 
25
26
27
28
29
30
31
32
def name(self):
    """
    Returns the name of the action.

    Returns:
        str: The name of the action.
    """
    return self._name

run(indent=0) #

Executes the action and logs its execution time.

Parameters:

Name Type Description Default
indent int

The indentation level for logging.

 0
Source code in src\plpipes\action\base.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
def run(self, indent=0):
    """
    Executes the action and logs its execution time.

    Args:
        indent (int): The indentation level for logging.
    """
    name = self.name()
    logging.info(f"{' '*indent}Action {name} started")
    start = time.time()
    self._do_it(indent=indent)
    lapse = int(10 * (time.time() - start) + 0.5) / 10.0
    logging.info(f"{' '*indent}Action {name} done ({lapse}s)")

short_name() #

Returns the short name of the action, derived from the full name.

Returns:

Name Type Description
str

The short name of the action.
Source code in src\plpipes\action\base.py 
34
35
36
37
38
39
40
41
def short_name(self):
    """
    Returns the short name of the action, derived from the full name.

    Returns:
        str: The short name of the action.
    """
    return re.split(r'[./\\]', self._name)[-1]