Skip to content

climate_ref_core.executor #

Executor interface for running diagnostics

Executor #

Bases: Protocol

An executor is responsible for running a diagnostic asynchronously

The diagnostic may be run locally in the same process or in a separate process or container.

Notes

This is an extremely basic interface and will be expanded in the future, as we figure out our requirements.

Source code in packages/climate-ref-core/src/climate_ref_core/executor.py 
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@runtime_checkable
class Executor(Protocol):
    """
    An executor is responsible for running a diagnostic asynchronously

    The diagnostic may be run locally in the same process or in a separate process or container.

    Notes
    -----
    This is an extremely basic interface and will be expanded in the future, as we figure out
    our requirements.
    """

    name: str

    def __init__(self, **kwargs: Any) -> None: ...

    def run(
        self,
        definition: ExecutionDefinition,
        execution: "Execution | None" = None,
    ) -> None:
        """
        Execute a diagnostic with a given definition

        No executions are returned from this method,
        as the execution may be performed asynchronously so executions may not be immediately available.

        /// admonition | Note
        In future, we may return a `Future` object that can be used to retrieve the result,
        but that requires some additional work to implement.
        ///

        Parameters
        ----------
        definition
            Definition of the information needed to execute a diagnostic

            This definition describes which datasets are required to run the diagnostic and where
            the output should be stored.
        execution
            The execution object to update with the results of the execution.

            This is a database object that contains the executions of the execution.
            If provided, it will be updated with the executions of the execution.
            This may happen asynchronously, so the executions may not be immediately available.

        Returns
        -------
        :
            Results from running the diagnostic
        """
        ...

    def join(self, timeout: float) -> None:
        """
        Wait for all executions to finish

        If the timeout is reached, the method will return and raise an exception.

        Parameters
        ----------
        timeout
            Maximum time to wait for all executions to finish in seconds

        Raises
        ------
        TimeoutError
            If the timeout is reached
        """

join(timeout) #

Wait for all executions to finish

If the timeout is reached, the method will return and raise an exception.

Parameters:

Name Type Description Default
timeout float

Maximum time to wait for all executions to finish in seconds

 required

Raises:

Type Description
TimeoutError

If the timeout is reached
Source code in packages/climate-ref-core/src/climate_ref_core/executor.py 
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def join(self, timeout: float) -> None:
    """
    Wait for all executions to finish

    If the timeout is reached, the method will return and raise an exception.

    Parameters
    ----------
    timeout
        Maximum time to wait for all executions to finish in seconds

    Raises
    ------
    TimeoutError
        If the timeout is reached
    """

run(definition, execution=None) #

Execute a diagnostic with a given definition

No executions are returned from this method, as the execution may be performed asynchronously so executions may not be immediately available.

Note

In future, we may return a Future object that can be used to retrieve the result, but that requires some additional work to implement.

Parameters:

Name Type Description Default
definition ExecutionDefinition

Definition of the information needed to execute a diagnostic

This definition describes which datasets are required to run the diagnostic and where the output should be stored.

 required
execution Execution | None

The execution object to update with the results of the execution.

This is a database object that contains the executions of the execution. If provided, it will be updated with the executions of the execution. This may happen asynchronously, so the executions may not be immediately available.

 None

Returns:

Type Description
None

Results from running the diagnostic
Source code in packages/climate-ref-core/src/climate_ref_core/executor.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def run(
    self,
    definition: ExecutionDefinition,
    execution: "Execution | None" = None,
) -> None:
    """
    Execute a diagnostic with a given definition

    No executions are returned from this method,
    as the execution may be performed asynchronously so executions may not be immediately available.

    /// admonition | Note
    In future, we may return a `Future` object that can be used to retrieve the result,
    but that requires some additional work to implement.
    ///

    Parameters
    ----------
    definition
        Definition of the information needed to execute a diagnostic

        This definition describes which datasets are required to run the diagnostic and where
        the output should be stored.
    execution
        The execution object to update with the results of the execution.

        This is a database object that contains the executions of the execution.
        If provided, it will be updated with the executions of the execution.
        This may happen asynchronously, so the executions may not be immediately available.

    Returns
    -------
    :
        Results from running the diagnostic
    """
    ...

execute_locally(definition, log_level, raise_error=False) #

Run a diagnostic execution

This is the chunk of work that should be executed by an executor.

Parameters:

Name Type Description Default
definition ExecutionDefinition

A description of the information needed for this execution of the diagnostic

 required
log_level str

The log level to use for the execution

 required
Source code in packages/climate-ref-core/src/climate_ref_core/executor.py 
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
def execute_locally(
    definition: ExecutionDefinition,
    log_level: str,
    raise_error: bool = False,
) -> ExecutionResult:
    """
    Run a diagnostic execution

    This is the chunk of work that should be executed by an executor.

    Parameters
    ----------
    definition
        A description of the information needed for this execution of the diagnostic
    log_level
        The log level to use for the execution
    """
    logger.info(f"Executing {definition.execution_slug()!r}")

    try:
        if definition.output_directory.exists():
            logger.warning(
                f"Output directory {definition.output_directory} already exists. "
                f"Removing the existing directory."
            )
            shutil.rmtree(definition.output_directory)
        definition.output_directory.mkdir(parents=True, exist_ok=True)

        with redirect_logs(definition, log_level):
            return definition.diagnostic.run(definition=definition)
    except Exception as e:
        # If the diagnostic fails, we want to log the error and return a failure result
        logger.exception(f"Error running {definition.execution_slug()!r}")
        result = ExecutionResult.build_from_failure(definition)

        if raise_error:
            raise DiagnosticError(str(e), result) from e
        else:
            return result

import_executor_cls(fqn) #

Import an executor using a fully qualified module path

Parameters:

Name Type Description Default
fqn str

Full package and attribute name of the executor to import

For example: climate_ref_example.executor will use the executor attribute from the climate_ref_example package.

 required

Raises:

Type Description
InvalidExecutorException

If the executor cannot be imported

If the executor isn't a valid DiagnosticProvider.

Returns:

Type Description
type[Executor]

Executor instance
Source code in packages/climate-ref-core/src/climate_ref_core/executor.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def import_executor_cls(fqn: str) -> type[Executor]:
    """
    Import an executor using a fully qualified module path

    Parameters
    ----------
    fqn
        Full package and attribute name of the executor to import

        For example: `climate_ref_example.executor` will use the `executor` attribute from the
        `climate_ref_example` package.

    Raises
    ------
    InvalidExecutorException
        If the executor cannot be imported

        If the executor isn't a valid `DiagnosticProvider`.

    Returns
    -------
    :
        Executor instance
    """
    module, attribute_name = fqn.rsplit(".", 1)

    try:
        imp = importlib.import_module(module)
        executor: type[Executor] = getattr(imp, attribute_name)

        if isinstance(executor, Exception):
            raise executor

        # We can't really check if the executor is a subclass of Executor here
        # Protocols can't be used with issubclass if they have non-method members
        # We have to check this at class instantiation time

        return executor
    except (ModuleNotFoundError, ImportError):
        logger.error(f"Package '{fqn}' not found")
        raise InvalidExecutorException(fqn, f"Module '{module}' not found")
    except AttributeError:
        logger.error(f"Provider '{fqn}' not found")
        raise InvalidExecutorException(fqn, f"Executor '{attribute_name}' not found in {module}")