Skip to main content

Library for reading and writing Macintosh HFS volumes

Project description

This is a library for creating and inspecting HFS-format disk images. Mac-specific concepts like resource forks and type/creator codes are first-class citizens.

Python interface

The Python API is simple. The contents of a Volume or a Folder are accessed using the index operator []. While working on a filesystem, its entire high-level contents are stored in memory as a Python object.

from machfs import Volume, Folder, File

v = Volume()

v['Folder'] = Folder()

v['Folder']['File'] = File()
v['Folder']['File'].data = b'Hello from Python!\r'
v['Folder']['File'].rsrc = b'' # Use the macresources library to work with resource forks
v['Folder']['File'].type = b'TEXT'
v['Folder']['File'].creator = b'ttxt' # Teach Text/SimpleText

with open('FloppyImage.dsk', 'wb') as f:
    flat = v.write(
        size=1440*1024, # "High Density" floppy
        align=512, # Allocation block alignment modulus (2048 for CDs)
        desktopdb=True, # Create a dummy Desktop Database to prevent a rebuild on boot
        bootable=True, # This requires a folder with a ZSYS and a FNDR file
        startapp=('Folder','File'), # Path (as tuple) to an app to open at boot
    )
    f.write(flat)

with open('FloppyImage.dsk', 'rb') as f:
    flat = f.read()
    v = Volume()
    v.read(flat) # And you can read an image back!

Command-line interface

This package also installs the MakeHFS and DumpHFS utilities, for working with folders on your native filesystem. Briefly, resource forks are stored in Rez-formatted .rdump files, and type and creator codes are stored in 8-byte .idump files. Admittedly this method of storage is not pretty, but it exposes changes to resource files without requiring Mac-specific software. For example, Git can track the addition and removal of resources. Files with a TEXT type are assumed to be UTF-8 encoded with Unix-style (LF) line endings, and are converted to Mac OS Roman encoding with Mac-style (CR) line endings.

Both commands have a --help argument to display their options.

Why?

I want an automated, reproducible way to compile legacy MacOS software. Without any current operating system fully supporting HFS, libhfs/hfsutils (a C library and command-line wrapper) is the most capable implementation. The implementor chose to emulate POSIX I/O on a fake "mounted" filesystem. While this is important for machines with very limited RAM, the maintenance of consistent HFS data structures across incremental operations is a complicated task requiring a large amount of low-level code. Frequent I/O to the real filesystem also occurs. Current machines have memory and cycles to burn, so an in-memory implementation in a high-level programming language seemed like a reasonable tradeoff. As a result, machfs has nearly an order of magnitude fewer lines than libhfs, and is more maintainable, at a nearly negligible cost in performance.

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

machfs-1.2.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

machfs-1.2-py2.py3-none-any.whl (16.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file machfs-1.2.tar.gz.

File metadata

  • Download URL: machfs-1.2.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for machfs-1.2.tar.gz
Algorithm Hash digest
SHA256 e334a867e6a94af2c5540125aa76b1792a15fdf7c38dc2bb5f44a3d7c30720c9
MD5 6d6ca14bee0352b18eac86a3423799d9
BLAKE2b-256 52e2fc7b689fb67b9665f996a99f26b5bdbcbbf21f90aa8af7f7175a7ff87a61

See more details on using hashes here.

File details

Details for the file machfs-1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: machfs-1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for machfs-1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 eaca1c278c267c0de8d247fc8f304cee820d2ad91be29e80597c78aea23ea83d
MD5 d635d9ac2fb3e22128583724bfa70fbe
BLAKE2b-256 de3067ba1c8cca4e457629b6dfb82263c0b6e744afb882fd5427c29119521bf1

See more details on using hashes here.

Supported by

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