# {py:mod}`labthings_fastapi.example_things`

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

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

## Package Contents

### Classes

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

* - {py:obj}`MyThing <labthings_fastapi.example_things.MyThing>`
  - ```{autodoc2-docstring} labthings_fastapi.example_things.MyThing
    :summary:
    ```
* - {py:obj}`ThingWithBrokenAffordances <labthings_fastapi.example_things.ThingWithBrokenAffordances>`
  - ```{autodoc2-docstring} labthings_fastapi.example_things.ThingWithBrokenAffordances
    :summary:
    ```
* - {py:obj}`ThingThatCantInstantiate <labthings_fastapi.example_things.ThingThatCantInstantiate>`
  - ```{autodoc2-docstring} labthings_fastapi.example_things.ThingThatCantInstantiate
    :summary:
    ```
* - {py:obj}`ThingThatCantStart <labthings_fastapi.example_things.ThingThatCantStart>`
  - ```{autodoc2-docstring} labthings_fastapi.example_things.ThingThatCantStart
    :summary:
    ```
````

### API

`````{py:class} MyThing
:canonical: labthings_fastapi.example_things.MyThing

Bases: {py:obj}`labthings_fastapi.thing.Thing`

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing
```

````{py:method} anaction(repeats: typing.Annotated[int, Field(description='The number of times to try the action')], undocumented: int, title: typing.Annotated[str, Field(description='the title of the invocation')] = 'Untitled', attempts: typing.Annotated[typing.Optional[list[str]], Field(description='Names for each attempt - I suggest final, Final, FINAL.')] = None) -> dict[str, str]
:canonical: labthings_fastapi.example_things.MyThing.anaction

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.anaction
```

````

````{py:method} make_a_dict(extra_key: typing.Optional[str] = None, extra_value: typing.Optional[str] = None) -> dict[str, typing.Optional[str]]
:canonical: labthings_fastapi.example_things.MyThing.make_a_dict

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.make_a_dict
```

````

````{py:method} increment_counter()
:canonical: labthings_fastapi.example_things.MyThing.increment_counter

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.increment_counter
```

````

````{py:method} slowly_increase_counter(increments: int = 60, delay: float = 1)
:canonical: labthings_fastapi.example_things.MyThing.slowly_increase_counter

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.slowly_increase_counter
```

````

````{py:attribute} counter
:canonical: labthings_fastapi.example_things.MyThing.counter
:value: >
   'PropertyDescriptor(...)'

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.counter
```

````

````{py:attribute} foo
:canonical: labthings_fastapi.example_things.MyThing.foo
:value: >
   'PropertyDescriptor(...)'

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.foo
```

````

````{py:method} action_without_arguments() -> None
:canonical: labthings_fastapi.example_things.MyThing.action_without_arguments

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.action_without_arguments
```

````

````{py:method} action_with_only_kwargs(**kwargs) -> None
:canonical: labthings_fastapi.example_things.MyThing.action_with_only_kwargs

```{autodoc2-docstring} labthings_fastapi.example_things.MyThing.action_with_only_kwargs
```

````

`````

`````{py:class} ThingWithBrokenAffordances
:canonical: labthings_fastapi.example_things.ThingWithBrokenAffordances

Bases: {py:obj}`labthings_fastapi.thing.Thing`

```{autodoc2-docstring} labthings_fastapi.example_things.ThingWithBrokenAffordances
```

````{py:method} broken_action()
:canonical: labthings_fastapi.example_things.ThingWithBrokenAffordances.broken_action

```{autodoc2-docstring} labthings_fastapi.example_things.ThingWithBrokenAffordances.broken_action
```

````

````{py:method} broken_property()
:canonical: labthings_fastapi.example_things.ThingWithBrokenAffordances.broken_property

```{autodoc2-docstring} labthings_fastapi.example_things.ThingWithBrokenAffordances.broken_property
```

````

`````

````{py:class} ThingThatCantInstantiate()
:canonical: labthings_fastapi.example_things.ThingThatCantInstantiate

Bases: {py:obj}`labthings_fastapi.thing.Thing`

```{autodoc2-docstring} labthings_fastapi.example_things.ThingThatCantInstantiate
```

```{rubric} Initialization
```

```{autodoc2-docstring} labthings_fastapi.example_things.ThingThatCantInstantiate.__init__
```

````

`````{py:class} ThingThatCantStart
:canonical: labthings_fastapi.example_things.ThingThatCantStart

Bases: {py:obj}`labthings_fastapi.thing.Thing`

```{autodoc2-docstring} labthings_fastapi.example_things.ThingThatCantStart
```

````{py:method} __enter__()
:canonical: labthings_fastapi.example_things.ThingThatCantStart.__enter__

```{autodoc2-docstring} labthings_fastapi.example_things.ThingThatCantStart.__enter__
```

````

````{py:method} __exit__(exc_t, exc_v, exc_tb)
:canonical: labthings_fastapi.example_things.ThingThatCantStart.__exit__

```{autodoc2-docstring} labthings_fastapi.example_things.ThingThatCantStart.__exit__
```

````

`````