Skip to main content

The pluggable filesystem contract for the oaknut family: detection, capabilities, geometry, partitions, and the identification coordinator.

Project description

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 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).

Project details


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.6.0.tar.gz (31.6 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.6.0-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.6.0.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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.6.0.tar.gz
Algorithm Hash digest
SHA256 c46f34c4655299b26e744cc3470d030ef406c955ec0bc0cae8e7405f08e72715
MD5 c641e74034a9a2261f9edc7453e772f9
BLAKE2b-256 d43a84284b6b13d1849f365bef31ab5ad55748b0ae5756ed7cbaf3f57d3cd0cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.6.0-py3-none-any.whl
  • Upload date:
  • Size: 28.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e2e83b2a2419c5ef7071fc9e48e4bff1c7e05d012c5bc078145f0608e304b43
MD5 fd2578b011ac8de3f302c010b184ae1c
BLAKE2b-256 2ccb0e3ce2a7559796dea63c1de99917b8f946530c4ac821e811c4807da5002d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page