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.0.0.tar.gz (23.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.0.0-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.0.0.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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.0.0.tar.gz
Algorithm Hash digest
SHA256 bc1c583c9c3af53276e9254f678a3963cd94447156a83b73ee8f89356959a0b9
MD5 ab72a1d7785eba699c5907062578b551
BLAKE2b-256 7079b8cbcefb6ee280086316fba9cee03f8d755308b89cd97a73b49a9b1d5f15

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b34b9a2fe173e67b3bfd21d561139fd642082ed27f5e5a25671aa1234da5dba0
MD5 25f2ef2ca9a51468f9c04d8681ccd2a7
BLAKE2b-256 17a669f057723d65b34072e2e4c389bd38fa49c36bbaa8d412b60f35b14dd4c6

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