Skip to main content

Transparent filesystem interception via monkey-patching.

Project description

monkeyfs 🐒

Filesystem interception via monkey-patching.

Patches open(), os.listdir(), os.stat(), and 30+ other stdlib functions to route through a virtual or isolated filesystem. Patches are applied lazily on first patch() call and are inert outside the context. Uses contextvars for async-safe isolation between concurrent tasks. Zero dependencies.

Install

pip install monkeyfs

Quick example

from monkeyfs import VirtualFS, patch

vfs = VirtualFS({})

with patch(vfs):
    with open("data.csv", "w") as f:
        f.write("name,score\nalice,98\nbob,87\n")

    import os
    print(os.listdir("/"))        # ['data.csv']
    print(os.path.getsize("data.csv"))  # 30

    with open("data.csv") as f:
        print(f.read())           # name,score\nalice,98\nbob,87\n

IsolatedFS

Restricts file operations to a root directory on the real filesystem:

from monkeyfs import IsolatedFS, patch

isolated = IsolatedFS(root="/tmp/sandbox")

with patch(isolated):
    with open("notes.txt", "w") as f:
        f.write("hello")          # Written to /tmp/sandbox/notes.txt

    open("/etc/passwd")           # PermissionError -- outside root

Documentation

  • API Reference -- public API, FileSystem protocol, patched functions

Development

uv sync --extra dev
uv run pytest

License

MIT

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

monkeyfs-0.1.0.tar.gz (50.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

monkeyfs-0.1.0-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

Details for the file monkeyfs-0.1.0.tar.gz.

File metadata

  • Download URL: monkeyfs-0.1.0.tar.gz
  • Upload date:
  • Size: 50.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for monkeyfs-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0a1b5053e00de0a9f90c5158280f6959b13c2f08718ded2c5f0cefb1de7e279d
MD5 393465b25d5f4f75033a0f8b261a8443
BLAKE2b-256 cfe2ca3f9ea08968c324a627faa8a2d7d921363ac5be5dce0a930728d4994f55

See more details on using hashes here.

File details

Details for the file monkeyfs-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: monkeyfs-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 32.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for monkeyfs-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0af91ffbf8da384a3dd7a2a1376c0b192052170db454d9097a015497d58bf275
MD5 70679102dade8e81c12dc18487460145
BLAKE2b-256 ad774d92e8f5cbc192c8bb9ed22a45f74901c270ae93f309b1145b8bf6aa53d3

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