`labthings_fastapi.actions`

Submodules

labthings_fastapi.actions.invocation_model

Package Contents

Classes

`Invocation`	A Thread subclass that retains output values and tracks progress
`DequeLogHandler`
`ActionManager`	A class to manage a collection of actions

Data

ACTION_INVOCATIONS_PATH

API

labthings_fastapi.actions.ACTION_INVOCATIONS_PATH: ‘/action_invocations’

class labthings_fastapi.actions.Invocation(action: labthings_fastapi.descriptors.ActionDescriptor, thing: labthings_fastapi.thing.Thing, input: Optional[pydantic.BaseModel] = None, dependencies: Optional[dict[str, Any]] = None, default_stop_timeout: float = 5, log_len: int = 1000, id: Optional[uuid.UUID] = None, cancel_hook: Optional[labthings_fastapi.dependencies.invocation.CancelHook] = None)

Bases: threading.Thread

A Thread subclass that retains output values and tracks progress

TODO: In the future this should probably not be a Thread subclass, but might run in a thread anyway.

Initialization

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is a list or tuple of arguments for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.init()) before doing anything else to the thread.

property id: uuid.UUID: UUID for the thread. Note this not the same as the native thread ident.

property output: Any: Return value of the Action. If the Action is still running, returns None.

property log: A list of log items generated by the Action.

property status: labthings_fastapi.actions.invocation_model.InvocationStatus

Current running status of the thread.

============== ============================================= Status Meaning ============== ============================================= pending Not yet started running Currently in-progress completed Finished without error cancelled Thread stopped after a cancel request error Exception occurred in thread ============== =============================================

property action

property thing

cancel()

Cancel the task by requesting the code to stop

This is very much not guaranteed to work: the action must use a CancelHook dependency and periodically check it.

response(request: Optional[fastapi.Request] = None)

run(): Overrides default threading.Thread run() method

class labthings_fastapi.actions.DequeLogHandler(dest: MutableSequence, level=logging.INFO)

Bases: logging.Handler

emit(record): Save a log record to the destination deque

class labthings_fastapi.actions.ActionManager

A class to manage a collection of actions