pyproject.toml

# pyproject.toml
[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

# https://peps.python.org/pep-0621/
[project]
name = "magicgui"
description = " build GUIs from python types"
keywords = ["gui", "widgets", "type annotations"]
readme = "README.md"
requires-python = ">=3.8"
license = { text = "MIT" }
authors = [{ email = "talley.lambert@gmail.com", name = "Talley Lambert" }]
classifiers = [
    "Development Status :: 4 - Beta",
    "Environment :: X11 Applications :: Qt",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: Desktop Environment",
    "Topic :: Software Development",
    "Topic :: Software Development :: User Interfaces",
    "Topic :: Software Development :: Widget Sets",
    "Topic :: Utilities",
]
dynamic = ["version"]
dependencies = [
    "docstring_parser>=0.7",
    "psygnal>=0.5.0",
    "qtpy>=1.7.0",
    "superqt[iconify]>=0.6.1",
    "typing_extensions",
]

# extras
# https://peps.python.org/pep-0621/#dependencies-optional-dependencies
[project.optional-dependencies]
min-req = [
    "docstring_parser==0.7",
    "psygnal==0.5.0",
    "qtpy==1.7.0",
    "superqt==0.6.1",
    "typing_extensions",
]

pyqt5 = ["pyqt5>=5.12.0"]
pyqt6 = ["pyqt6"]
pyside2 = [
    "pyside2>=5.14 ; python_version=='3.8'",
    "pyside2>=5.15 ; python_version>='3.9'",
]
pyside6 = ["pyside6"]
tqdm = ["tqdm>=4.30.0"]
jupyter = ["ipywidgets>=8.0.0"]
image = ["pillow>=4.0"]
quantity = ["pint>=0.13.0"]
testing = [
    "pytest",
    "pytest-qt",
    "pytest-cov",
    "pytest-mypy-plugins",
    "numpy",
    "pandas",
    "tqdm>=4.30.0",
    "pillow>=4.0",
    "pint>=0.13.0",
    "matplotlib",
    "toolz",
    "ipywidgets",
    "ipykernel",
    "pydantic",
    "attrs",
    "annotated_types",
]
dev = [
    "annotated_types",
    "attrs",
    "black",
    "ruff",
    "ipython",
    "ipywidgets",
    "isort",
    "matplotlib",
    "mypy",
    "numpy",
    "pandas",
    "pdbpp",
    "pillow>=4.0",
    "pint>=0.13.0",
    "pre-commit",
    "pydantic",
    "pydocstyle",
    "pyqt6",
    "pytest-cov",
    "pytest-cov",
    "pytest-mypy-plugins",
    "pytest-qt",
    "pytest",
    "pytest",
    "rich",
    "toolz",
    "tqdm>=4.30.0",
]
docs = [
    "mkdocs",
    "mkdocs-material ~=9.4",
    "mkdocstrings ==0.22.0",
    "mkdocstrings-python ==1.6.2",
    "mkdocs-gen-files",
    "mkdocs-literate-nav",
    "mkdocs-spellcheck[all]",
    "mkdocs-gallery",
    "qtgallery",
    # extras for all the widgets
    "napari ==0.4.18",
    "pyside6 ==6.4.2",    # 6.4.3 gives segfault for some reason
    "pint",
    "matplotlib",
    "ipywidgets >=8.0.0",
    "ipykernel",
]

[project.urls]
homepage = "https://github.com/pyapp-kit/magicgui"
repository = "https://github.com/pyapp-kit/magicgui"
changelog = "https://github.com/pyapp-kit/magicgui/blob/main/CHANGELOG.md"
issues = "https://github.com/pyapp-kit/magicgui/issues"
documentation = "https://pyapp-kit.github.io/magicgui/"

[tool.hatch.version]
source = "vcs"

[tool.hatch.envs.test]
features = ["testing"]
[tool.hatch.envs.test.scripts]
run = "pytest  -v --color=yes --cov-config=pyproject.toml --cov --cov-report=xml --cov-report=term-missing"
[[tool.hatch.envs.test.matrix]]
backend = ["pyqt5", "pyside2", "pyqt6", "pyside6"]
[tool.hatch.envs.test.overrides]
# matrix.deps.features = [
#     { value = "min-req", if = ["min-req"] },
# ]
matrix.backend.features = [
    { value = "pyqt5", if = [
        "pyqt5",
    ] },
    { value = "pyside2", if = [
        "pyside2",
    ] },
    { value = "pyqt6", if = [
        "pyqt6",
    ] },
    { value = "pyside6", if = [
        "pyside6",
    ] },
]


# https://github.com/charliermarsh/ruff
[tool.ruff]
line-length = 88
target-version = "py38"
src = ["src", "tests"]
select = [
    "E",    # style errors
    "F",    # flakes
    "W",    # warnings
    "D",    # pydocstyle
    "I",    # isort
    "UP",   # pyupgrade
    "C",    # flake8-comprehensions
    "B",    # flake8-bugbear
    "A001", # flake8-builtins
    "TCH",  # type checking
    "TID",  # tidy imports
    "RUF",  # ruff-specific rules
]
ignore = [
    "D100", # Missing docstring in public module
    "D107", # Missing docstring in __init__
    "D203", # 1 blank line required before class docstring
    "D212", # Multi-line docstring summary should start at the first line
    "D213", # Multi-line docstring summary should start at the second line
    "D401", # First line should be in imperative mood
    "D413", # Missing blank line after last section
    "D416", # Section name should end with a colon
    "C901", # Function is too complex
]

[tool.ruff.per-file-ignores]
"tests/*.py" = ["D", "E501"]
"docs/examples/*.py" = ["D", "B"]
"docs/examples/napari/*" = ["E501"]
"docs/examples/notebooks/*" = ["E501"]
"src/magicgui/widgets/_image/*.py" = ["D"]
"setup.py" = ["F821"]
"docs/*.py" = ["B"]

# https://docs.pytest.org/en/6.2.x/customize.html
[tool.pytest.ini_options]
minversion = "6.0"
testpaths = ["tests"]
filterwarnings = [
    "error",
    "ignore::DeprecationWarning:tqdm",
    "ignore::DeprecationWarning:docstring_parser",
]

# https://mypy.readthedocs.io/en/stable/config_file.html
[tool.mypy]
files = "src/**/*.py"
strict = true
disallow_any_generics = false
disallow_subclassing_any = false
show_error_codes = true
pretty = true
enable_incomplete_feature = ['Unpack']

[[tool.mypy.overrides]]
module = [
    "_pytest.*",
    ".docs/",
    "magicgui.widgets._image.*",
    "magicgui.backends.*",
]
ignore_errors = true

[[tool.mypy.overrides]]
module = ["ipywidgets.*", "toolz.*"]
ignore_missing_imports = true


# https://coverage.readthedocs.io/en/6.4/config.html
[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "if TYPE_CHECKING:",
    "@overload",
    "except ImportError",
    "except ImportError*",
    "raise NotImplementedError()",
    "pass",
    "\\.\\.\\.",
]
omit = [
    "src/magicgui/events.py",
    "src/magicgui/widgets/_image/_mpl_image.py",
    "src/magicgui/widgets/_bases/*",
    "tests/*",
    "docs/*",
]


# https://github.com/mgedmin/check-manifest#configuration
[tool.check-manifest]
ignore = [
    ".pre-commit-config.yaml",
    "tests/**/*",
    ".github_changelog_generator",
    "codecov.yml",
    ".ruff_cache/**/*",
]