---
orphan: true
---

# {py:mod}`_algopy_testing.state.box`

```{py:module} _algopy_testing.state.box
```

```{autodoc2-docstring} _algopy_testing.state.box
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Box <_algopy_testing.state.box.Box>`
  - ```{autodoc2-docstring} _algopy_testing.state.box.Box
    :summary:
    ```
* - {py:obj}`BoxRef <_algopy_testing.state.box.BoxRef>`
  - ```{autodoc2-docstring} _algopy_testing.state.box.BoxRef
    :summary:
    ```
* - {py:obj}`BoxMap <_algopy_testing.state.box.BoxMap>`
  - ```{autodoc2-docstring} _algopy_testing.state.box.BoxMap
    :summary:
    ```
````

### API

````{py:class} Box(type_: type[_algopy_testing.state.box._TValue], /, *, key: bytes | str | algopy.Bytes | algopy.String = '')
:canonical: _algopy_testing.state.box.Box

Bases: {py:obj}`typing.Generic`\[{py:obj}`_algopy_testing.state.box._TValue`\]

```{autodoc2-docstring} _algopy_testing.state.box.Box
```

```{rubric} Initialization
```

```{autodoc2-docstring} _algopy_testing.state.box.Box.__init__
```

````

````{py:class} BoxRef(/, *, key: bytes | str | algopy.Bytes | algopy.String = '')
:canonical: _algopy_testing.state.box.BoxRef

```{autodoc2-docstring} _algopy_testing.state.box.BoxRef
```

```{rubric} Initialization
```

```{autodoc2-docstring} _algopy_testing.state.box.BoxRef.__init__
```

````

````{py:class} BoxMap(key_type: type[_algopy_testing.state.box._TKey], value_type: type[_algopy_testing.state.box._TValue], /, *, key_prefix: bytes | str | algopy.Bytes | algopy.String | None = None)
:canonical: _algopy_testing.state.box.BoxMap

Bases: {py:obj}`typing.Generic`\[{py:obj}`_algopy_testing.state.box._TKey`\, {py:obj}`_algopy_testing.state.box._TValue`\]

```{autodoc2-docstring} _algopy_testing.state.box.BoxMap
```

```{rubric} Initialization
```

```{autodoc2-docstring} _algopy_testing.state.box.BoxMap.__init__
```

````