pyproject.toml

[build-system]
requires = ["setuptools>=82.0.1", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "construct-editor"
version = "0.2.0"
description = "GUI (based on wxPython) for 'construct', which is a powerful declarative and symmetrical parser and builder for binary data."
readme = "README.md"
license = "MIT"
license-files = ["LICENSE"]
authors = [{ name = "Tim Riddermann" }]
requires-python = ">=3.10"
keywords = [
    "gui",
    "wx",
    "wxpython",
    "widget",
    "binary",
    "editor",
    "construct",
    "kaitai",
    "declarative",
    "data structure",
    "struct",
    "symmetric",
    "parser",
    "builder",
    "parsing",
    "building",
    "pack",
    "unpack",
    "packer",
    "unpacker",
    "bitstring",
    "bytestring",
    "bitstruct",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Programming Language :: Python :: 3",
    "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",
    "Programming Language :: Python :: Implementation :: CPython",
    "Typing :: Typed",
]
dependencies = [
    "arrow>=1.0.0",
    "construct>=2.10.68",
    "construct-typing>=0.8.1,<0.9.0",
    "typing-extensions>=4.12.0",
    "wrapt>=2.2.2",
    "wxPython>=4.2.2",
]

[project.urls]
Homepage = "https://github.com/timrid/construct-editor"

[project.gui-scripts]
construct-editor = "construct_editor.main:main"

[dependency-groups]
dev = [
    "poethepoet>=0.48.0",
    "mypy>=2.3.0",
    "pyright>=1.1.411",
    "ruff>=0.15.21",
    "ty>=0.0.59",
    "pytest>=9.1.1",
    "pytest-mock>=3.15.1",
    "pytest-cov>=7.1.0",
    "cryptography",  # optional "extra" from construct that the user may or may not have installed
    "cloudpickle",  # optional "extra" from construct that the user may or may not have installed
    "lz4",  # optional "extra" from construct that the user may or may not have installed
    "numpy>=1.20.0",  # optional "extra" from construct that the user may or may not have installed
    "ruamel.yaml",  # optional "extra" from construct that the user may or may not have installed
]

[tool.setuptools.packages.find]
include = [
    "construct_editor",
    "construct_editor.core",
    "construct_editor.gallery",
    "construct_editor.wx_widgets",
]

[tool.setuptools.package-data]
construct_editor = ["py.typed"]

[tool.pytest.ini_options]
testpaths = ["tests"]
addopts = "-v --cov=construct_editor --cov-report=term-missing --cov-report=html"

# Coverage is measured purely for informational purposes, to see which code
# still needs tests. There is intentionally no `fail_under` threshold - a low
# coverage percentage should never fail the build.
[tool.coverage.run]
source = ["construct_editor"]
branch = true

[tool.coverage.report]
show_missing = true
skip_covered = false
exclude_also = [
    "if TYPE_CHECKING:",
    "raise NotImplementedError",
    "pass",
    "\\.\\.\\.",
]

[tool.coverage.html]
directory = "htmlcov"

[tool.mypy]
strict = true
# These errors should be activated in the future, but for now we don't want to refactor the entire codebase right now.
disable_error_code = [
    "arg-type",
    "attr-defined",
    "import-untyped",
    "misc",
    "no-any-return",
    "no-untyped-call",
    "no-untyped-def",
    "str-bytes-safe",
    "unused-ignore",
]

[tool.pyright]
typeCheckingMode = "strict"
exclude = [
    "**/node_modules",
    "**/__pycache__",
    "**/.*",
    ".history",
    ".venv",
    ".venv*",
    "build",
    "dist",
    "libs",
]

# These warnings should be activated as "error" in the future, but for now we don't want to refactor the entire codebase right now.
# Valid values: "error", "warning", "information", "none"
reportArgumentType = "none"  # 6 errors
reportAttributeAccessIssue = "none"  # 8 errors
reportMissingParameterType = "none"  # 130 errors
reportMissingTypeStubs = "none"  # 11 errors
reportUnknownArgumentType = "none"  # 132 errors
reportUnknownMemberType = "none"  # 242 errors
reportUnknownParameterType = "none"  # 64 errors
reportUnknownVariableType = "none"  # 61 errors
# These "unnecessary isinstance" checks often enhance readability or increase the future-proofness of the code,
# since you can then explicitly "raise" for other types. So we don't want to complain about them.
reportUnnecessaryIsInstance = "none"

[tool.ty.src]
exclude = [
    "**/node_modules",
    "**/__pycache__",
    "**/.*",
    ".history",
    ".venv",
    ".venv*",
    "build",
    "dist",
    "libs",
]

# These warnings should be activated as "error" in the future, but for now we don't want to refactor the entire codebase right now.
# Valid values: "error", "warn", "ignore"
[tool.ty.rules]
invalid-argument-type = "ignore"
unresolved-attribute = "ignore"
unused-type-ignore-comment = "ignore"

[tool.ty.terminal]
error-on-warning = true
output-format = "concise"  # "full" | "concise" | "github" | "gitlab" | "junit"

[tool.ruff]
line-length = 140
indent-width = 4
output-format = "concise"  # "full" | "concise" | "grouped" | "json" | "junit" | "github" | "gitlab" | "pylint" | "azure"

[tool.ruff.lint]
allowed-confusables = ["×", "–", "‘", "’"]
select = [
    "F",
    "I",
    "UP007",
    "UP037",
    "UP045",
]

# These warnings should be activated as "error" in the future, but for now we don't want to refactor the entire codebase right now.
ignore = [
    "F403",  # `from ... import *` used; unable to detect undefined names
    "F405",  # `...` may be undefined, or defined from star imports
]

[tool.poe.tasks.test]
cmd = "pytest $POE_EXTRA_ARGS"
executor = {type = "uv", isolated = true}

[tool.poe.tasks.lint]
cmd = "ruff check --fix --show-fixes"
executor = { type = "uv", isolated = true }

[tool.poe.tasks.lint-checkonly]
cmd = "ruff check"
executor = { type = "uv", isolated = true }

[tool.poe.tasks.ty]
cmd = "ty check"
executor = {type = "uv", isolated = true}

[tool.poe.tasks.pyright]
cmd = "pyright"
executor = {type = "uv", isolated = true}

[tool.poe.tasks.mypy]
cmd = "mypy construct_editor"
executor = {type = "uv", isolated = true}

[tool.poe.tasks.typecheck]
sequence = [
    "ty",
    "pyright",
    "mypy"
]

[tool.poe.tasks.check-all]
sequence = [
    "lint",
    "typecheck",
    "test",
]