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.14.0.tar.gz (32.7 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.14.0-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.14.0.tar.gz
  • Upload date:
  • Size: 32.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","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.14.0.tar.gz
Algorithm Hash digest
SHA256 bfa85cd05f29794fa5fe08298e9606f5bd10201f8977db2e06fccbf32f870e66
MD5 4e3b942233276c28a426f7479cfa3d9b
BLAKE2b-256 eab6bb0bbef742299a9d73a87afa321004fea133819fd4a016ee8562af42a93c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.14.0-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","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.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f346c46cea92be457a66efc800cd189ae011e6e52b1501c65a9070d8cd35330
MD5 8b2d5b464b30c1ae9d08a5b57cd2253f
BLAKE2b-256 e17574156104dd26f264a602924a0205f994a2bfa87c29aeef7b7cbfc574b8db

See more details on using hashes here.

Release history Release notifications | RSS feed

12.18.0

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

This release

12.14.0 This release

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