Skip to main content

oaknut-filesystem

PyPI version CI Python versions License: MIT

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 DiscFormat layer, 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oaknut_filesystem-12.18.0.tar.gz (39.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oaknut_filesystem-12.18.0-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

Details for the file oaknut_filesystem-12.18.0.tar.gz.

File metadata

  • Download URL: oaknut_filesystem-12.18.0.tar.gz
  • Upload date:
  • Size: 39.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","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}

File hashes

Hashes for oaknut_filesystem-12.18.0.tar.gz
Algorithm Hash digest
SHA256 7df51ab40e4b19c50a738edfbc6a8f3f79bb41604c50fa4ef1527fc8c9a8e106
MD5 bc033063126a7286b589410243a198ba
BLAKE2b-256 81e4b66017e5843cacee502f3d32dbbea0af9665c7f45ea48849e37e90a7b3d5

See more details on using hashes here.

File details

Details for the file oaknut_filesystem-12.18.0-py3-none-any.whl.

File metadata

  • Download URL: oaknut_filesystem-12.18.0-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","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}

File hashes

Hashes for oaknut_filesystem-12.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e44810c1e7e2f149d9b2816b3fd19ba134b22aae91cb78199d7d14a705361332
MD5 9a3612a9d035ca04ee95209347eb7399
BLAKE2b-256 e135952040aa8f1e5f82e55740670b4d71fecc8ec710e9377424199e41fbba9b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

12.18.0 This release

2 files

12.17.1

2 files

12.17.0

2 files

12.16.0

2 files

12.15.1

2 files

12.15.0

2 files

12.14.1

2 files

12.14.0

2 files

12.13.1

2 files

12.12.0

2 files

12.11.0

2 files

12.10.1

2 files

12.10.0

2 files

12.9.0

2 files

12.8.2

2 files

12.8.1

2 files

12.8.0

2 files

12.7.2

2 files

12.7.1

2 files

12.7.0

2 files

12.6.2

2 files

12.6.1

2 files

12.6.0

2 files

12.5.3

2 files

12.5.2

2 files

12.5.1

2 files

12.5.0

2 files

12.4.1

2 files

12.4.0

2 files

12.3.0

2 files

12.2.0

2 files

12.1.0

2 files

12.0.1

2 files

12.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page