Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,28 @@ explains why "schema-valid" and "correct" are two different checks. The code liv
`src/acoustic_dataset/validate.py` and `compare.py`, dispatched from
[`cli.py`](src/acoustic_dataset/cli.py).

### Adventure 2 — Explore a typed Python data class in the REPL
### Adventure 2 — Explore a typed Python data class

The pipeline never carries data in a loose `dict`; it builds **one typed object that
meets the schema**. Feel the difference yourself:
meets the schema**. Feel the difference yourself.

**First, experience editor autocomplete.** Open
[`examples/explore_platform.py`](examples/explore_platform.py) in VS Code (the Codespace
ships Pylance). Find the `# platform.` line, delete the `#`, put your cursor right after the
dot, and type: VS Code pops up the object's *declared* attributes (`radiated_noise`,
`sensors`, …) — statically, before the code has even run. Keep drilling
(`platform.radiated_noise.band[0].`) and it completes all the way down. That instant,
schema-shaped autocomplete is the real payoff of declared fields. Run the file any time with:

```bash
python examples/explore_platform.py
```

> If autocomplete doesn't appear, give Pylance a moment to index, and make sure VS Code's
> Python interpreter is set to the Codespace's 3.9 (bottom-right status bar / *Python: Select
> Interpreter*).

**Then poke at it in the REPL:**

```bash
python
Expand All @@ -75,9 +93,13 @@ python
>>> Sector(bering=1, level=2) # a typo is a TypeError, not a silent new key
```

Tab-completion works on every attribute because the fields are *declared*. Read
[`docs/concepts/typed-vs-dicts.md`](docs/concepts/typed-vs-dicts.md) for what this buys
you over a dictionary, then look at how the builder rejects out-of-range values in
The REPL can also complete attributes, but that's a separate `readline`/`rlcompleter`
feature that introspects the live object at runtime — not the static, declared-field
completion you saw in the editor. If `<TAB>` doesn't complete, enable it for the session
with `import readline, rlcompleter; readline.parse_and_bind("tab: complete")`.

Read [`docs/concepts/typed-vs-dicts.md`](docs/concepts/typed-vs-dicts.md) for what declared
fields buy you over a dictionary, then look at how the builder rejects out-of-range values in
`src/acoustic_dataset/build.py`.

### Adventure 3 — Reverse-engineer the data classes from the schema
Expand Down
22 changes: 22 additions & 0 deletions examples/explore_platform.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
"""Scratch file for Adventure 2 — experience editor autocomplete on a typed object.

Open this file in VS Code (the Codespace has Pylance), then follow the TODO below.
It is safe to edit freely; nothing else imports it. Run it any time with:

python examples/explore_platform.py
"""

from acoustic_dataset import build

# `platform` is a fully-typed `Platform` built from the example input. Pylance knows
# its type from the function's return annotation — no need to run anything first.
platform = build.build_platform_from_file("examples/calculation_input.xml")

# TODO: put your cursor at the end of the next line, after the dot, and type.
# VS Code should pop up the declared attributes (radiated_noise, sensors, ...).
# Keep drilling — `platform.radiated_noise.band[0].` completes too, all the way down.
# platform.

# A couple of fully-typed accesses to confirm it ran (delete or extend these freely):
print("type:", type(platform).__name__)
print("first band centre frequency:", platform.radiated_noise.band[0].centre_frequency)
Loading