# {py:mod}`simvx.core.assets.handle`

```{py:module} simvx.core.assets.handle
```

```{autodoc2-docstring} simvx.core.assets.handle
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Handle <simvx.core.assets.handle.Handle>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.Handle
    :summary:
    ```
* - {py:obj}`BatchHandle <simvx.core.assets.handle.BatchHandle>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.assets.handle.__all__>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.__all__
    :summary:
    ```
* - {py:obj}`PENDING <simvx.core.assets.handle.PENDING>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.PENDING
    :summary:
    ```
* - {py:obj}`LOADING <simvx.core.assets.handle.LOADING>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.LOADING
    :summary:
    ```
* - {py:obj}`LOADED <simvx.core.assets.handle.LOADED>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.LOADED
    :summary:
    ```
* - {py:obj}`FAILED <simvx.core.assets.handle.FAILED>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.FAILED
    :summary:
    ```
* - {py:obj}`CANCELLED <simvx.core.assets.handle.CANCELLED>`
  - ```{autodoc2-docstring} simvx.core.assets.handle.CANCELLED
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.assets.handle.__all__
:value: >
   ['Handle', 'BatchHandle', 'PENDING', 'LOADING', 'LOADED', 'FAILED', 'CANCELLED']

```{autodoc2-docstring} simvx.core.assets.handle.__all__
```

````

````{py:data} PENDING
:canonical: simvx.core.assets.handle.PENDING
:type: typing.Final
:value: >
   'pending'

```{autodoc2-docstring} simvx.core.assets.handle.PENDING
```

````

````{py:data} LOADING
:canonical: simvx.core.assets.handle.LOADING
:type: typing.Final
:value: >
   'loading'

```{autodoc2-docstring} simvx.core.assets.handle.LOADING
```

````

````{py:data} LOADED
:canonical: simvx.core.assets.handle.LOADED
:type: typing.Final
:value: >
   'loaded'

```{autodoc2-docstring} simvx.core.assets.handle.LOADED
```

````

````{py:data} FAILED
:canonical: simvx.core.assets.handle.FAILED
:type: typing.Final
:value: >
   'failed'

```{autodoc2-docstring} simvx.core.assets.handle.FAILED
```

````

````{py:data} CANCELLED
:canonical: simvx.core.assets.handle.CANCELLED
:type: typing.Final
:value: >
   'cancelled'

```{autodoc2-docstring} simvx.core.assets.handle.CANCELLED
```

````

`````{py:class} Handle(uri: str)
:canonical: simvx.core.assets.handle.Handle

```{autodoc2-docstring} simvx.core.assets.handle.Handle
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.assets.handle.Handle.__init__
```

````{py:property} state
:canonical: simvx.core.assets.handle.Handle.state
:type: str

```{autodoc2-docstring} simvx.core.assets.handle.Handle.state
```

````

````{py:property} progress
:canonical: simvx.core.assets.handle.Handle.progress
:type: float

```{autodoc2-docstring} simvx.core.assets.handle.Handle.progress
```

````

````{py:property} error
:canonical: simvx.core.assets.handle.Handle.error
:type: BaseException | None

```{autodoc2-docstring} simvx.core.assets.handle.Handle.error
```

````

````{py:property} is_done
:canonical: simvx.core.assets.handle.Handle.is_done
:type: bool

```{autodoc2-docstring} simvx.core.assets.handle.Handle.is_done
```

````

````{py:method} cancel() -> None
:canonical: simvx.core.assets.handle.Handle.cancel

```{autodoc2-docstring} simvx.core.assets.handle.Handle.cancel
```

````

````{py:method} result(timeout: float | None = None) -> typing.Any
:canonical: simvx.core.assets.handle.Handle.result

```{autodoc2-docstring} simvx.core.assets.handle.Handle.result
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.assets.handle.Handle.__repr__

````

`````

`````{py:class} BatchHandle(handles: list[simvx.core.assets.handle.Handle])
:canonical: simvx.core.assets.handle.BatchHandle

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.__init__
```

````{py:property} total
:canonical: simvx.core.assets.handle.BatchHandle.total
:type: int

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.total
```

````

````{py:property} completed_count
:canonical: simvx.core.assets.handle.BatchHandle.completed_count
:type: int

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.completed_count
```

````

````{py:property} failed_count
:canonical: simvx.core.assets.handle.BatchHandle.failed_count
:type: int

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.failed_count
```

````

````{py:property} cancelled_count
:canonical: simvx.core.assets.handle.BatchHandle.cancelled_count
:type: int

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.cancelled_count
```

````

````{py:property} progress
:canonical: simvx.core.assets.handle.BatchHandle.progress
:type: float

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.progress
```

````

````{py:property} is_done
:canonical: simvx.core.assets.handle.BatchHandle.is_done
:type: bool

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.is_done
```

````

````{py:method} cancel() -> None
:canonical: simvx.core.assets.handle.BatchHandle.cancel

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.cancel
```

````

````{py:method} results(timeout: float | None = None) -> dict[str, typing.Any]
:canonical: simvx.core.assets.handle.BatchHandle.results

```{autodoc2-docstring} simvx.core.assets.handle.BatchHandle.results
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.assets.handle.BatchHandle.__repr__

````

`````