Python reflink

Python wrapper around the reflink system calls. Note: Python is implementing this natively upstream, cfr. https://bugs.python.org/issue37157.

• Free software: MIT license

• Documentation: https://reflink.readthedocs.io.

• Documentation for master branch: https://rubdos.gitlab.io/pyreflink/docs

Features

• Btrfs, XFS, OCFS2 reflink support. Btrfs is tested the most.

• Apple macOS APFS clonefile support. Little testing, be careful. It might eat data.

• A convenience method that checks support for reflinks within a specific directory.

Installation

This library is available on pypi:

pip install reflink

Quick start example

To use Python reflink in a project:

from reflink import reflink
# Reflink copy 'large_file.img' to 'copy_of_file.img'
reflink("large_file.img", "copy_of_file.img")

Help wanted

Someone to implement a Windows/ReFS implementation

Support

Support on the GitLab repository, feel free to file an issue.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.