Local Executor
Executing tasks (electrons) directly on the local machine
Local executor class that directly invokes the input function.
Methods
cancel(task_metadata, job_handle)
Method to cancel the job identified uniquely by the job_handle (base class)
execute(function, args, kwargs, dispatch_id, …)
Execute the function with the given arguments.
from_dict (object_dict)
Rehydrate a dictionary representation
Check if the task was requested to be canceled by the user
get_dispatch_context(dispatch_info)
Start a context manager that will be used to access the dispatch info for the executor.
run(function, args, kwargs, task_metadata)
Execute the function locally
set_job_handle(handle)
Save the job_id/handle returned by the backend executing the task
setup(task_metadata)
Placeholder to run any executor-specific tasks
teardown(task_metadata)
Placeholder to run any executor-specific cleanup/teardown actions
to_dict()
Return a JSON-serializable dictionary representation of self
write_streams_to_file(stream_strings, …)
Write the contents of stdout and stderr to respective files.
cancel
Method to cancel the job identified uniquely by the job_handle (base class).
Arg(s)
task_metadata
Metadata of the task to be canceled.
job_handle
Unique ID of the job assigned by the backend
Return(s)
False by default
Return Type
Literal[False]
execute
Execute the function with the given arguments.
This calls the executor-specific run() method.
Parameters
function (Callable) – The input python function which will be executed and whose result is ultimately returned by this function.
args (List) – List of positional arguments to be used by the function.
kwargs (Dict) – Dictionary of keyword arguments to be used by the function.
dispatch_id (str) – The unique identifier of the external lattice process which is calling this function.
results_dir (str) – The location of the results directory.
node_id (int) – ID of the node in the transport graph which is using this executor (default is -1).
Returns
The result of the function execution.
Return Type
output
from_dict
Rehydrate a dictionary representation.
Parameters
object_dict (dict) – A dictionary representation returned by to_dict.
Return Type
BaseExecutor
Returns
self
Instance attributes will be overwritten.
get_cancel_requested
Check if the task was requested to be canceled by the user.
Arg(s)
None
Returns
True/False whether task cancellation was requested.
Return Type
bool
get_dispatch_context
Start a context manager that will be used to access the dispatch info for the executor.
Parameters
dispatch_info (DispatchInfo) – The dispatch info to be used inside the current context.
Return Type
AbstractContextManager[DispatchInfo]
Returns
A context manager object that handles the dispatch info.
Execute the function locally.
Arg(s)
function
Function to be executed
args
Arguments passed to the function
kwargs
Keyword arguments passed to the function
task_metadata
Metadata of the task to be executed
Returns
Task output
Return Type
Any
set_job_handle
Save the job_id/handle returned by the backend executing the task.
Arg(s)
handle
JSONable type identifying the job being executed by the backend.
Returns
Response from saving the job handle to the database.
Return Type
Any
write_streams_to_file
Write the contents of stdout and stderr to respective files.
Parameters
stream_strings (Iterable[str]) – The stream_strings to be written to files.
filepaths (Iterable[str]) – The filepaths to be used for writing the streams.
dispatch_id (str) – The ID of the dispatch which initiated the request.
results_dir (str) – The location of the results directory.
Return Type
None