labthings_fastapi.dependencies.invocation

FastAPI dependency for an invocation ID

Module Contents

Classes

CancelEvent

Functions

invocation_id	Return a UUID for an action invocation
invocation_logger	Retrieve a logger object for an action invocation
invocation_cancel_hook	Get a cancel hook belonging to a particular invocation

Data

InvocationID
InvocationLogger
CancelHook

API

labthings_fastapi.dependencies.invocation.invocation_id() → uuid.UUID

Return a UUID for an action invocation

This is for use as a FastAPI dependency, to allow other dependencies to access the invocation ID. Useful for e.g. file management.

labthings_fastapi.dependencies.invocation.InvocationID

None

labthings_fastapi.dependencies.invocation.invocation_logger(id: labthings_fastapi.dependencies.invocation.InvocationID) → logging.Logger

Retrieve a logger object for an action invocation

This will have a level of at least INFO.

labthings_fastapi.dependencies.invocation.InvocationLogger

None

exception labthings_fastapi.dependencies.invocation.InvocationCancelledError

Bases: SystemExit

class labthings_fastapi.dependencies.invocation.CancelEvent(id: labthings_fastapi.dependencies.invocation.InvocationID)

Bases: threading.Event

raise_if_set()

Raise a CancelledError if the event is set

sleep(timeout: float)

Sleep for a given time in seconds, but raise an exception if cancelled

labthings_fastapi.dependencies.invocation.invocation_cancel_hook(id: labthings_fastapi.dependencies.invocation.InvocationID) → CancelHook

Get a cancel hook belonging to a particular invocation

labthings_fastapi.dependencies.invocation.CancelHook

None