oaknut-filesystem
The pluggable filesystem contract for the oaknut family — the base every Acorn (and, in principle, foreign) filesystem plugs into.
A filesystem is the unit of extension: Acorn DFS, Watford DFS, Opus DDOS,
ADFS, AFS, … are peers, registered on the oaknut.filesystem entry-point axis
(built on oaknut-extension). Each one:
- probes an image region and proposes what it is — with a confidence, evidence, and a candidate geometry;
- opens a region into a mount exposing a small core (list / stat /
read / write / exists, and parsing its own path syntax) plus opt-in
capability protocols (
HierarchicalDirectories,AcornMetadata,BootOption,UserDatabase,RegionHost); - declares its geometry grammar — the physical layouts it supports.
Two concerns are kept strictly apart:
- Geometry — the physical mapping of image bytes to logical sectors
(track count, sides, interleave, density, CHS). This is the discimage
DiscFormatlayer, beneath the filesystem. - Filesystem — the logical structure that turns sectors into files and directories.
This package also hosts the identification coordinator (identify()): it
runs the registered filesystems over an image, ranks the candidates, and
recurses into reserved regions (an ADFS host's tail, where an AFS or other
filesystem may live) to produce a per-partition Identification tree.
It depends on no concrete filesystem package and imports none: filesystems are discovered purely through entry points, so any subset can be installed and the rest simply aren't handled.
See docs/dev/filesystem-extensions.md (architecture) and
docs/dev/filesystem-extensions-plan.md (implementation plan).
Part of the oaknut monorepo.
Installation
uv add oaknut-filesystem # or: pip install oaknut-filesystem
License
MIT — see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for oaknut-filesystem 13.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| oaknut_filesystem-13.3.1.tar.gz | 42.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| oaknut_filesystem-13.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 79.8 kB
Release files / oaknut_filesystem-13.3.1.tar.gz
| Download URL | oaknut_filesystem-13.3.1.tar.gz |
|---|---|
| Size | 42.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
56bfd545fc01550ed424930e11c77bea5c43a1f4e4b1903ee70e8d347c149594
|
|
BLAKE2b-256 checksum How to use checksums |
fffa5d32f6d86dde68033047570aba530f191a509f14955a79426e3090daf707
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / oaknut_filesystem-13.3.1-py3-none-any.whl
| Download URL | oaknut_filesystem-13.3.1-py3-none-any.whl |
|---|---|
| Size | 37.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2fc9055015cc786fd8b7e3bd760a1933f0782b96b9db9ee45cb95723c53ab785
|
|
BLAKE2b-256 checksum How to use checksums |
30949e76915c99b0bbce6bb054c8df0a92fccc1c42bdcd738905425da8e022bc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
