# API sandbox

_Note_: this document is intended for humans and robots alike.

Sandbox environment for:
- tested snippets using our existing API
- mocks of WIP future APIs (shimmed over the existing API)
- tested snippets using the future API

## Structure


The tests in `test_current/` and `test_draft/` are intended to match such that one can directly diff the directories:

```
git diff --no-index rerun_py/tests/api_sandbox/test_current rerun_py/tests/api_sandbox/test_draft
```

Tests outside of these directories are just for illustration purposes.

The snippets can be run using:

```
pytest -c rerun_py/pyproject.toml rerun_py/tests/api_sandbox
```

The `rerun_draft` is a mock of the future API. The implementation matters little, the main point is for the draft tests to pass.


## Snapshots

This makes heavy use of [`inline_snapshots`](https://github.com/15r10nk/inline-snapshot/).

Run this command to fill and fix all snapshots:

```
pytest -c rerun_py/pyproject.toml rerun_py/tests/api_sandbox --inline-snapshot=fix,create
```


## Formatting

As per usual, the formatting is checked using:

```
pixi run py-fmt-check
```