# {py:mod}`labthings_fastapi.server`

```{py:module} labthings_fastapi.server
```

```{autodoc2-docstring} labthings_fastapi.server
:allowtitles:
```

## Submodules

```{toctree}
:titlesonly:
:maxdepth: 1

labthings_fastapi.server.cli
labthings_fastapi.server.fallback
```

## Package Contents

### Classes

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

* - {py:obj}`ThingServer <labthings_fastapi.server.ThingServer>`
  - ```{autodoc2-docstring} labthings_fastapi.server.ThingServer
    :summary:
    ```
````

### Functions

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

* - {py:obj}`server_from_config <labthings_fastapi.server.server_from_config>`
  - ```{autodoc2-docstring} labthings_fastapi.server.server_from_config
    :summary:
    ```
````

### Data

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

* - {py:obj}`PATH_REGEX <labthings_fastapi.server.PATH_REGEX>`
  - ```{autodoc2-docstring} labthings_fastapi.server.PATH_REGEX
    :summary:
    ```
````

### API

````{py:data} PATH_REGEX
:canonical: labthings_fastapi.server.PATH_REGEX
:value: >
   'compile(...)'

```{autodoc2-docstring} labthings_fastapi.server.PATH_REGEX
```

````

`````{py:class} ThingServer(settings_folder: typing.Optional[str] = None)
:canonical: labthings_fastapi.server.ThingServer

```{autodoc2-docstring} labthings_fastapi.server.ThingServer
```

````{py:method} __init__(settings_folder: typing.Optional[str] = None)
:canonical: labthings_fastapi.server.ThingServer.__init__

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.__init__
```

````

````{py:attribute} app
:canonical: labthings_fastapi.server.ThingServer.app
:type: fastapi.FastAPI
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.app
```

````

````{py:attribute} action_manager
:canonical: labthings_fastapi.server.ThingServer.action_manager
:type: labthings_fastapi.actions.ActionManager
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.action_manager
```

````

````{py:attribute} blob_data_manager
:canonical: labthings_fastapi.server.ThingServer.blob_data_manager
:type: labthings_fastapi.outputs.blob.BlobDataManager
:value: >
   None

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.blob_data_manager
```

````

````{py:method} set_cors_middleware() -> None
:canonical: labthings_fastapi.server.ThingServer.set_cors_middleware

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.set_cors_middleware
```

````

````{py:property} things
:canonical: labthings_fastapi.server.ThingServer.things
:type: collections.abc.Mapping[str, labthings_fastapi.thing.Thing]

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.things
```

````

````{py:attribute} ThingInstance
:canonical: labthings_fastapi.server.ThingServer.ThingInstance
:value: >
   'TypeVar(...)'

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.ThingInstance
```

````

````{py:method} things_by_class(cls: type[ThingInstance]) -> typing.Sequence[ThingInstance]
:canonical: labthings_fastapi.server.ThingServer.things_by_class

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.things_by_class
```

````

````{py:method} thing_by_class(cls: type[ThingInstance]) -> ThingInstance
:canonical: labthings_fastapi.server.ThingServer.thing_by_class

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.thing_by_class
```

````

````{py:method} add_thing(thing: labthings_fastapi.thing.Thing, path: str)
:canonical: labthings_fastapi.server.ThingServer.add_thing

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.add_thing
```

````

````{py:method} lifespan(app: fastapi.FastAPI)
:canonical: labthings_fastapi.server.ThingServer.lifespan
:async:

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.lifespan
```

````

````{py:method} add_things_view_to_app()
:canonical: labthings_fastapi.server.ThingServer.add_things_view_to_app

```{autodoc2-docstring} labthings_fastapi.server.ThingServer.add_things_view_to_app
```

````

`````

````{py:function} server_from_config(config: dict) -> labthings_fastapi.server.ThingServer
:canonical: labthings_fastapi.server.server_from_config

```{autodoc2-docstring} labthings_fastapi.server.server_from_config
```
````