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.5.0.tar.gz (31.3 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.5.0-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.5.0.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","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.5.0.tar.gz
Algorithm Hash digest
SHA256 31fda565477b2983b9c2f52fdddf8433c87e0878fce342a52d46e043df4c53e5
MD5 a0ee42b90e5a2a193f7c784e15dc8e70
BLAKE2b-256 f0c49e49746e14882e6a49c7b012e711fb085856204b085879bb9ede3a5d5188

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oaknut_filesystem-12.5.0-py3-none-any.whl
  • Upload date:
  • Size: 28.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 051de08939ea75087e4d9524f4dad503ffc22586365c249f41f2e09b017dbb41
MD5 123667c6408935f4f6f74f0c9c2ab14e
BLAKE2b-256 73d49a88df41a97bd1ce1579baddca7186fbc891f08a5355813a3a5e36a67f69

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