# {py:mod}`labthings_fastapi.dependencies.invocation`

```{py:module} labthings_fastapi.dependencies.invocation
```

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`CancelEvent <labthings_fastapi.dependencies.invocation.CancelEvent>`
  -
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`invocation_id <labthings_fastapi.dependencies.invocation.invocation_id>`
  - ```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.invocation_id
    :summary:
    ```
* - {py:obj}`invocation_logger <labthings_fastapi.dependencies.invocation.invocation_logger>`
  - ```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.invocation_logger
    :summary:
    ```
* - {py:obj}`invocation_cancel_hook <labthings_fastapi.dependencies.invocation.invocation_cancel_hook>`
  - ```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.invocation_cancel_hook
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`InvocationID <labthings_fastapi.dependencies.invocation.InvocationID>`
  - ```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.InvocationID
    :summary:
    ```
* - {py:obj}`InvocationLogger <labthings_fastapi.dependencies.invocation.InvocationLogger>`
  - ```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.InvocationLogger
    :summary:
    ```
* - {py:obj}`CancelHook <labthings_fastapi.dependencies.invocation.CancelHook>`
  - ```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.CancelHook
    :summary:
    ```
````

### API

````{py:function} invocation_id() -> uuid.UUID
:canonical: labthings_fastapi.dependencies.invocation.invocation_id

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.invocation_id
```
````

````{py:data} InvocationID
:canonical: labthings_fastapi.dependencies.invocation.InvocationID
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.InvocationID
```

````

````{py:function} invocation_logger(id: labthings_fastapi.dependencies.invocation.InvocationID) -> logging.Logger
:canonical: labthings_fastapi.dependencies.invocation.invocation_logger

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.invocation_logger
```
````

````{py:data} InvocationLogger
:canonical: labthings_fastapi.dependencies.invocation.InvocationLogger
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.InvocationLogger
```

````

```{py:exception} InvocationCancelledError()
:canonical: labthings_fastapi.dependencies.invocation.InvocationCancelledError

Bases: {py:obj}`SystemExit`

```

`````{py:class} CancelEvent(id: labthings_fastapi.dependencies.invocation.InvocationID)
:canonical: labthings_fastapi.dependencies.invocation.CancelEvent

Bases: {py:obj}`threading.Event`

````{py:method} raise_if_set()
:canonical: labthings_fastapi.dependencies.invocation.CancelEvent.raise_if_set

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.CancelEvent.raise_if_set
```

````

````{py:method} sleep(timeout: float)
:canonical: labthings_fastapi.dependencies.invocation.CancelEvent.sleep

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.CancelEvent.sleep
```

````

`````

````{py:function} invocation_cancel_hook(id: labthings_fastapi.dependencies.invocation.InvocationID) -> CancelHook
:canonical: labthings_fastapi.dependencies.invocation.invocation_cancel_hook

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.invocation_cancel_hook
```
````

````{py:data} CancelHook
:canonical: labthings_fastapi.dependencies.invocation.CancelHook
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.dependencies.invocation.CancelHook
```

````