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.

Metadata

Release files for oaknut-filesystem 13.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oaknut-filesystem 13.1.0
File Size Uploaded
oaknut_filesystem-13.1.0.tar.gz 39.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for oaknut-filesystem 13.1.0
File Interpreter ABI Platform
oaknut_filesystem-13.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 75.1 kB

Release files / oaknut_filesystem-13.1.0.tar.gz

Download URL oaknut_filesystem-13.1.0.tar.gz
Size 39.8 kB
Tags Source
SHA-256 checksum
How to use checksums
cc33d6e1b65f977b1ddb30d354413e08e3fc7c22a0b1d910a353556b0532fa2a
BLAKE2b-256 checksum
How to use checksums
7a18a2cbc1ede523ec12dfa89dd06bf4470e4bf95f5e2308c28d49d8dc8ed829
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","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}

Release files / oaknut_filesystem-13.1.0-py3-none-any.whl

Download URL oaknut_filesystem-13.1.0-py3-none-any.whl
Size 35.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
439b1051f58895481b71c4adbda6909d611d3a29c08ca378df68bc4cc5412b9f
BLAKE2b-256 checksum
How to use checksums
d774aeaa7d53127678c37b75f2a68a4d4d50a4b88d9487ebfe8d54c3605867ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","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}

Release history Release notifications | RSS feed

13.4.0

2 release files

13.3.1

2 release files

This release

13.1.0 This release

2 release files

13.0.0

2 release files

12.9.0

2 release files

12.8.2

2 release files

12.8.1

2 release files

12.8.0

2 release files

12.7.2

2 release files

12.7.1

2 release files

12.7.0

2 release files

12.5.0

2 release files

12.4.1

2 release files

12.4.0

2 release files

12.3.0

2 release files

12.2.0

2 release files

12.1.0

2 release files

12.0.1

2 release files

12.0.0

2 release 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