borg/pyproject.toml

[project]
name = "borgbackup"
dynamic = ["version", "readme"]
authors = [{name="The Borg Collective (see AUTHORS file)"}]
maintainers = [
    {name="Thomas Waldmann", email="tw@waldmann-edv.de"},
]
description = "Deduplicated, encrypted, authenticated and compressed backups"
requires-python = ">=3.9"
keywords = ["backup", "borgbackup"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Environment :: Console",
    "Intended Audience :: System Administrators",
    "License :: OSI Approved :: BSD License",
    "Operating System :: POSIX :: BSD :: FreeBSD",
    "Operating System :: POSIX :: BSD :: OpenBSD",
    "Operating System :: POSIX :: BSD :: NetBSD",
    "Operating System :: MacOS :: MacOS X",
    "Operating System :: POSIX :: Linux",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Security :: Cryptography",
    "Topic :: System :: Archiving :: Backup",
]
license = {text="BSD"}
dependencies = [
    # we are rather picky about msgpack versions, because a good working msgpack is
    # very important for borg, see: https://github.com/borgbackup/borg/issues/3753
    # Please note:
    # using any other msgpack version is not supported by borg development and
    # any feedback related to issues caused by this will be ignored.
    "msgpack >=1.0.3, <=1.1.1",
    "packaging",
]

# note for package maintainers: if you package borgbackup for distribution,
# please (if available) add pyfuse3 (preferably) or llfuse as a *requirement*.
# "borg mount" needs one of them to work.
# if neither is available, do not require it, most of borgbackup will work.
[project.optional-dependencies]
llfuse = ["llfuse >= 1.3.8"]
pyfuse3 = ["pyfuse3 >= 3.1.1"]
nofuse = []

[project.urls]
"Homepage" = "https://borgbackup.org/"
"Bug Tracker" = "https://github.com/borgbackup/borg/issues"
"Documentation" = "https://borgbackup.readthedocs.io/"
"Repository" = "https://github.com/borgbackup/borg"
"Changelog" = "https://github.com/borgbackup/borg/blob/1.4-maint/docs/changes.rst"

[project.scripts]
borg = "borg.archiver:main"
borgfs = "borg.archiver:main"

[tool.setuptools]
# See also the MANIFEST.in file.
# We want to install all the files in the package directories...
include-package-data = true

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.exclude-package-data]
# ...except the source files which have been compiled (C extensions):
"*" = ["*.c", "*.h", "*.pyx"]

[build-system]
requires = ["setuptools>=64", "setuptools_scm>=8", "wheel", "pkgconfig", "Cython>=3.0.3"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
# make sure we have the same versioning scheme with all setuptools_scm versions, to avoid different autogenerated files
# https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1015052
# https://github.com/borgbackup/borg/issues/6875
write_to = "src/borg/_version.py"
write_to_template = "__version__ = version = {version!r}\n"

[tool.ruff]
line-length = 120
target-version = "py39"

# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
select = ["E", "F"]

# for reference ...
#   E402 module level import not at top
#   E501 line too long
#   F401 import unused
#   F405 undefined or defined from star imports
#   F811 redef of unused var

# borg code style guidelines:
# Ignoring E203 due to https://github.com/PyCQA/pycodestyle/issues/373
ignore = ["E203", "F405", "E402"]

# Allow autofix for all enabled rules (when `--fix`) is provided.
fixable = ["A", "B", "C", "D", "E", "F", "G", "I", "N", "Q", "S", "T", "W", "ANN", "ARG", "BLE", "COM", "DJ", "DTZ", "EM", "ERA", "EXE", "FBT", "ICN", "INP", "ISC", "NPY", "PD", "PGH", "PIE", "PL", "PT", "PTH", "PYI", "RET", "RSE", "RUF", "SIM", "SLF", "TCH", "TID", "TRY", "UP", "YTT"]
unfixable = []

# Exclude a variety of commonly ignored directories.
exclude = [
    ".cache",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".idea",
    ".mypy_cache",
    ".ruff_cache",
    ".tox",
    "build",
    "dist",
]

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

# Code style violation exceptions:
# please note that the values are adjusted so that they do not cause failures
# with existing code. if you want to change them, you should first fix all
# ruff failures that appear with your change.
[tool.ruff.per-file-ignores]
"setup.py" = ["E501"]
"scripts/make.py" = ["E501"]
"src/borg/archive.py" = ["E501", "F401"]
"src/borg/archiver.py" = ["E501", "F401", "E722", "E741"]
"src/borg/cache.py" = ["E501", "E722"]
"src/borg/crypto/key.py" = ["E501", "F401"]
"src/borg/crypto/keymanager.py" = ["E501", "F401"]
"src/borg/crypto/nonces.py" = ["E501"]
"src/borg/fuse.py" = ["E501", "E722"]
"src/borg/fuse_impl.py" = ["F811"]
"src/borg/helpers/__init__.py" = ["F401"]
"src/borg/helpers/checks.py" = ["F401"]
"src/borg/helpers/manifest.py" = ["E501"]
"src/borg/helpers/misc.py" = ["F401", "E722"]
"src/borg/helpers/parseformat.py" = ["E501", "F401", "E741"]
"src/borg/helpers/process.py" = ["F401"]
"src/borg/locking.py" = ["E501", "E722"]
"src/borg/platform/__init__.py" = ["F401", "F811"]
"src/borg/remote.py" = ["E501"]
"src/borg/repository.py" = ["E501", "F401"]
"src/borg/shellpattern.py" = ["E501"]
"src/borg/testsuite/__init__.py" = ["E501", "F401"]
"src/borg/testsuite/archiver.py" = ["E501", "E722", "F401"]
"src/borg/testsuite/benchmark.py" = ["F811", "F401"]
"src/borg/testsuite/chunker.py" = ["E501"]
"src/borg/testsuite/crypto.py" = ["E501", "E741"]
"src/borg/testsuite/file_integrity.py" = ["F401"]
"src/borg/testsuite/hashindex.py" = ["F401"]
"src/borg/testsuite/helpers.py" = ["E501"]
"src/borg/testsuite/key.py" = ["F401"]
"src/borg/testsuite/locking.py" = ["E501", "E722", "F401"]
"src/borg/testsuite/platform.py" = ["E501", "F811", "F401"]
"src/borg/testsuite/repository.py" = ["E501", "F401"]
"src/borg/upgrader.py" = ["E501"]

[tool.pytest.ini_options]
python_files = "testsuite/*.py"
markers = [
    "allow_cache_wipe",
]

# tox configuration - if you change anything here, run this to verify:
# fakeroot -u tox --recreate
[tool.tox]
min_version = "4.19"
requires = ["tox>=4.19", "pkgconfig", "cython", "wheel", "setuptools_scm"]
env_list = ["py{39,310,311,312,313,314}-{none,fuse2,fuse3}", "ruff"]

# Base configuration for test environments
[tool.tox.env_run_base]
description = "Run tests with pytest"
package = "editable-legacy"  # without this it does not find setup_docs when running under fakeroot
deps = ["-rrequirements.d/development.txt"]
commands = [
    ["pytest", "-v", "-n", "{env:XDISTN:1}", "-rs", "--cov=borg", "--cov-config=pyproject.toml", "--benchmark-skip", "--pyargs", "{posargs:borg.testsuite}"]
]
pass_env = ["*"]  # fakeroot -u needs some env vars
labels = ["test"]

# Base configuration for package building
[tool.tox.env_pkg_base]
pass_env = ["*"]  # needed by tox4, so env vars are visible for building borg

# Test environments with different FUSE implementations
[tool.tox.env."py{39,310,311,312,313,314}-fuse2"]
description = "Run tests with llfuse (FUSE2) implementation"
set_env = {BORG_FUSE_IMPL = "llfuse"}
deps = ["-rrequirements.d/development.txt", "llfuse"]
labels = ["test", "fuse"]

[tool.tox.env."py{39,310,311,312,313,314}-fuse3"]
description = "Run tests with pyfuse3 (FUSE3) implementation"
set_env = {BORG_FUSE_IMPL = "pyfuse3"}
deps = ["-rrequirements.d/development.txt", "pyfuse3"]
labels = ["test", "fuse"]

[tool.tox.env."py{39,310,311,312,313,314}-none"]
description = "Run tests without FUSE support"
deps = ["-rrequirements.d/development.txt"]
labels = ["test", "nofuse"]

[tool.tox.env.ruff]
description = "Run ruff linter and formatter"
skip_install = true
deps = ["ruff"]
commands = [
    ["ruff", "check", "."]
]
labels = ["lint"]

[tool.coverage.run]
branch = true
disable_warnings = ["module-not-measured"]
source = ["src/borg"]
omit = [
    "*/borg/__init__.py",
    "*/borg/__main__.py",
    "*/borg/_version.py",
    "*/borg/fuse.py",
    "*/borg/support/*",
    "*/borg/testsuite/*",
    "*/borg/hash_sizes.py",
]

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "pragma: freebsd only",
    "pragma: unknown platform only",
    "def __repr__",
    "raise AssertionError",
    "raise NotImplementedError",
    "if 0:",
    "if __name__ == .__main__.:",
]
ignore_errors = true