mirror of
https://github.com/loot/libloot.git
synced 2026-07-27 14:16:01 -07:00
Oliver Hamlet
11bd321861
The error scenario represented by PluginNotLoadedError is distinguished from all other esplugin errors by LOOT, so it's worth handling separately.
51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
# libloot-python
|
|
|
|
An **experimental** Python wrapper around the libloot Rust implementation, built using [PyO3](https://pyo3.rs).
|
|
|
|
## Build
|
|
|
|
To build, first set up a Python virtual environment and install [maturin](https://github.com/PyO3/maturin):
|
|
|
|
```
|
|
# pipx
|
|
pipx install maturin
|
|
# uv
|
|
uv tool install maturin
|
|
```
|
|
|
|
or using pip on Windows:
|
|
|
|
```powershell
|
|
python -m venv .venv
|
|
.\.venv\Scripts\activate
|
|
pip install maturin
|
|
```
|
|
|
|
or using pip on Linux:
|
|
|
|
```sh
|
|
python -m venv .venv
|
|
. .venv/bin/activate
|
|
pip install maturin
|
|
```
|
|
|
|
Then build the library in the virtual environment:
|
|
|
|
```
|
|
maturin develop
|
|
```
|
|
|
|
The library can then be imported in Python:
|
|
|
|
```
|
|
python
|
|
> import loot
|
|
```
|
|
|
|
## Usage notes
|
|
|
|
- The Python exceptions that errors are mapped to are not the same as in the Rust or C++ interfaces:
|
|
- The API provides the custom `CyclicInteractionError`, `UndefinedGroupError`, `PluginNotLoadedError` exception types.
|
|
- All other errors are raised as `ValueError` exceptions.
|
|
- The `LogLevel` enum and `set_logging_callback()` and `set_log_level()` functions are not exposed because the logging is integrated with Python's `logging` module instead.
|