pyproject.toml

[build-system]
requires = [
    "setuptools~=82.0",
]
build-backend = "setuptools.build_meta"

[project]
name = "cx_Freeze"
version = "8.6.2"
description = "Create standalone executables from Python scripts"
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "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 :: Software Development :: Build Tools",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: System :: Software Distribution",
    "Topic :: Utilities",
]
dependencies = [
    "freeze-core>=0.6.1",
    "packaging>=25.0",
    "setuptools>=78.1.1,<83.0",
    "tomli>=2.0.1 ;python_version == '3.10'",
    # Linux
    "filelock>=3.20.3 ;sys_platform == 'linux'",
    "patchelf>=0.16.1,<0.18 ;sys_platform == 'linux' and platform_machine == 'x86_64'",
    "patchelf>=0.16.1,<0.18 ;sys_platform == 'linux' and platform_machine == 'i686'",
    "patchelf>=0.16.1,<0.18 ;sys_platform == 'linux' and platform_machine == 'aarch64'",
    "patchelf>=0.16.1,<0.18 ;sys_platform == 'linux' and platform_machine == 'armv7l'",
    "patchelf>=0.16.1,<0.18 ;sys_platform == 'linux' and platform_machine == 'ppc64le'",
    "patchelf>=0.16.1,<0.18 ;sys_platform == 'linux' and platform_machine == 's390x'",
    # macOS
    "dmgbuild>=1.6.1 ;sys_platform == 'darwin'",
    # Windows
    "lief>=0.15.1,<0.18 ;sys_platform == 'win32'",
    "python-msilib>=0.4.1 ;sys_platform == 'win32' and python_version >= '3.13'",
]
keywords = ["cx-freeze cxfreeze cx_Freeze freeze python"]
license = "PSF-2.0"
license-files = ["LICENSE.md"]
readme = "README.md"
requires-python = ">=3.10"

[[project.authors]]
name = "Marcelo Duarte"
email = "marcelotduarte@users.noreply.github.com"

[[project.authors]]
name = "Anthony Tuininga"
email = "anthony.tuininga@gmail.com"

[project.entry-points."distutils.setup_keywords"]
executables = "cx_Freeze.executable:validate_executables"

[project.entry-points."setuptools.finalize_distribution_options"]
cxfreeze-plugin = "cx_Freeze:plugin_install"

[project.scripts]
cxfreeze = "cx_Freeze.cli:main"
cxfreeze-quickstart = "cx_Freeze.setupwriter:main"

[project.urls]
Home = "https://marcelotduarte.github.io/cx_Freeze"
Changelog = "https://github.com/marcelotduarte/cx_Freeze/blob/main/CHANGELOG.md"
Documentation = "https://cx-freeze.readthedocs.io"
Source = "https://github.com/marcelotduarte/cx_Freeze"
Tracker = "https://github.com/marcelotduarte/cx_Freeze/issues"
Workflows = "https://github.com/marcelotduarte/cx_Freeze/actions?query=branch:main"

[dependency-groups]
dev = [
    "prek==0.3.6",
]
doc = [
    "sphinx==9.1.0",
    "sphinx-inline-tabs==2025.12.21.14",
    "sphinx-issues==6.0.0",
    "sphinx-new-tab-link==0.8.1",
    "furo==2025.12.19",
    "myst-parser==5.0.0",
]
tests = [
    "coverage==7.13.5",
    "filelock>=3.20.3",
    "pytest==9.0.2",
        "pluggy==1.6.0",
    "pytest-mock==3.15.1",
    "pytest-timeout==2.4.0",
    "pytest-xdist==3.8.0",
]

[tool.uv.dependency-groups]
doc = {requires-python = ">=3.12"}

[tool.setuptools]
include-package-data = true
zip-safe = true

[tool.setuptools.packages.find]
exclude = ["samples", "tests*"]
namespaces = false

[tool.black]
line-length = 79
target-version = ["py310"]

[tool.coverage.html]
directory = "build/coverage_html_report"

[tool.coverage.report]
# Regexes for lines to exclude from consideration
exclude_also = [
    # Don't complain about missing debug-only code:
    "def __repr__",

    # Don't complain about abstract methods, they aren't run:
    "@(abc\\.)?abstractmethod",

    # TYPE_CHECKING block is never executed during pytest run
    "if TYPE_CHECKING:",
]
ignore_errors = true
omit = [
    "*/cx_Freeze/hooks/*",
    "*/cx_Freeze/_typing.py",
]
precision = 2

[tool.coverage.paths]
source = [
    "cx_Freeze/",
    "*/cx_Freeze/",
]

[tool.coverage.run]
command_line = "-m pytest --dist=loadfile --durations=20 -nauto -rpfEsXx tests"
source = ["cx_Freeze"]
parallel = true
patch = ["subprocess"]
relative_files = true

[tool.pylint.format]
max-line-length = 79

[tool.pylint.main]
disable = [
    "attribute-defined-outside-init",
    "c-extension-no-member",
    "broad-exception-caught",       # checked by ruff BLE001
    "duplicate-code",
    "exec-used",
    "fixme",                         # also ignored in ruff
    "global-statement",              # checked by ruff PLW0603
    "import-error",
    "missing-class-docstring",       # checked by ruff D101
    "missing-function-docstring",    # checked by ruff D103
    "missing-module-docstring",      # checked by ruff D100
    "no-member",                     # not handled by ruff yet E1101
    "protected-access",              # checked by ruff SLF001
    "redefined-builtin",             # checked by ruff A
    "too-few-public-methods",
    "too-many-arguments",            # also ignored in ruff
    "too-many-branches",             # also ignored in ruff
    "too-many-instance-attributes",
    "too-many-lines",
    "too-many-locals",
    "too-many-nested-blocks",
    "too-many-return-statements",    # checked by ruff PLR0911
    "too-many-statements",           # also ignored in ruff
    "unbalanced-tuple-unpacking",    # not handled by ruff yet W0632
    "ungrouped-imports",             # checked by ruff C0412 (I001)
    "unused-argument",               # checked by ruff ARG
    "useless-parent-delegation",     # not handled by ruff yet W0246
]
ignore-paths = [
    "cx_Freeze/__init__.py",
    "cx_Freeze/darwintools.py",
    "cx_Freeze/hooks/__init__.py",
    "cx_Freeze/hooks/_pyqt5_/_resource.py",
    "cx_Freeze/hooks/_pyside2_/_resource.py",
    "cx_Freeze/hooks/_pyside6_/_resource.py",
    "^samples/.*.py$",
    "^tests/.*.py$",
]
jobs = 0
output-format = "colorized"
py-version = [3, 10]

[tool.pytest]
minversion = "9.0"
addopts = ["-rpfEsXx"]
testpaths = ["tests"]
filterwarnings = [
    "ignore::DeprecationWarning:distutils.*",
    "ignore::DeprecationWarning:pkg_resources.*",
    "ignore::DeprecationWarning:setuptools.*",
]

[tool.ruff]
extend-exclude = [
    "cx_Freeze/importshed/*.pyi",
    "cx_Freeze/darwintools.py",
]
line-length = 79

[tool.ruff.lint]
select = [
    "A",    # flake8-builtins
    "ANN2", # flake8-annotations - missing return type
    "ARG",  # flake8-unused-arguments
    "B",    # flake8-bugbear
    "BLE",  # flake8-blind-except
    "C4",   # flake8-comprehensions
    "D",    # pydocstyle
    "DTZ",  # flake8-datetimez
    "E", "W",  # pycodestyle
    "EXE",  # flake8-executable
    "EM",   # flake8-errmsg
    "ERA",  # eradicate
    "F",    # flake8
    "FA",   # flake8-future-annotations
    "FLY",  # flynt
    "G",    # flake8-logging-format
    "I",    # isort
    "ICN",  # flake8-import-conventions
    "INT",  # flake8-gettext
    "ISC003",  # flake8-implicit-str-concat - explicit-string-concatenation
    "LOG",  # flake8-logging
    "PERF", # Perflint
    "PGH",  # pygrep-hooks
    "PIE",  # flake8-pie
    "PLC", "PLE", "PLR", "PLW",  # pylint
    "PT",   # flake8-pytest-style
    "PYI",  # flake8-pyi
    "Q004", # flake8-quotes - unnecessary-escaped-quote
    "RET",  # flake8-return
    "RSE",  # flake8-raise
    "RUF",  # Ruff-specific
    "S",    # flake8-bandit
    "SIM",  # flake8-simplify
    "SLF",  # flake8-self
    "SLOT", # flake8-slots
    "T10",  # flake8-debugger
    "TC",   # flake8-type-checking
    "TID",  # flake8-tidy-imports
    "TRY",  # tryceratops
    "UP",   # pyupgrade
    "YTT",  # flake8-2020
]
ignore = [
    "D105",     # Missing docstring in magic method
    "D107",     # Missing docstring in `__init__`
    "D203",     # conflict with D211
    "D213",     # conflict with D212
    # should be revised in future - last revised using ruff 0.14.0
    "D102",     # Missing docstring in public method
    "D205",     # 1 blank line required between summary line and description
    "D401",     # First line of docstring should be in imperative mood
    "PLR2004",  # magic-value-comparison
    "PLR0912",  # too-many-branches
    "PLR0913",  # too-many-arguments
    "PLR0915",  # too-many-statements
    # prone to false positives: https://github.com/astral-sh/ruff/issues/4045
    "S603",
]
typing-modules = ["cx_Freeze._typing"]

[tool.ruff.lint.per-file-ignores]
"cx_Freeze/command/_pydialog.py" = ["ERA001"]
"cx_Freeze/command/bdist_msi.py" = ["ERA001"]
"samples/*" = ["D1"]
"tests/*" = ["S101"]

[tool.ruff.lint.flake8-builtins]
strict-checking = true

[tool.ruff.lint.flake8-unused-arguments]
ignore-variadic-names = true

[tool.ruff.format]
docstring-code-format = true
docstring-code-line-length = 50