pyproject.toml

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

[tool.xcookie]
tags = [ "erotemic", "github", "purepy", "mypy"]
mod_name = "xdoctest"
repo_name = "xdoctest"
rel_mod_parent_dpath = "./src"
os = [ "all", "win", "linux", "osx",]
min_python = '3.8'
author = "Jon Crall"
author_email = "erotemic@gmail.com"
description = "A rewrite of the builtin doctest module"
url = "https://github.com/Erotemic/xdoctest"
license = "Apache 2"
dev_status = "stable"
typed = true
skip_autogen = ["MANIFEST.in"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Software Development :: Testing",
    "Topic :: Utilities",
    "Framework :: Pytest",
    # This should be interpreted as Apache License v2.0
    "License :: OSI Approved :: Apache Software License",
    # Supported Python versions
    "Programming Language :: Python :: 3",
    "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",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: Implementation :: PyPy",
    "Programming Language :: Python :: Implementation :: CPython",
]

[tool.xcookie.setuptools]
keywords = 'xdoctest,doctest,test,docstr,pytest'

[tool.xcookie.entry_points]
# the console_scripts entry point creates the xdoctest executable
console_scripts = [
    "xdoctest = xdoctest.__main__:main",
]
# the pytest11 entry point makes the plugin available to pytest
pytest11 = [
    "xdoctest = xdoctest.plugin",
]


[tool.pytest.ini_options]
addopts = "-p no:doctest --xdoctest --xdoctest-style=google --ignore-glob=setup.py --ignore-glob=dev --ignore-glob=docs"
norecursedirs = ".git ignore build __pycache__ dev _skbuild docs"
filterwarnings = [ "default", "ignore:.*No cfgstr given in Cacher constructor or call.*:Warning", "ignore:.*Define the __nice__ method for.*:Warning", "ignore:.*private pytest class or function.*:Warning",]

[tool.coverage.run]
branch = true
source = ["src/xdoctest"]

[tool.coverage.report]
exclude_lines = [ 
    "pragma: no cover",
     ".*  # pragma: no cover",
     ".*  # nocover",
     "def __repr__",
     "raise AssertionError",
     "raise NotImplementedError",
     "if 0:",
     "if trace is not None",
     "verbose = .*",
     "^ *raise",
     "^ *pass *$",
     "if _debug:",
     "if __name__ == .__main__.:",
]
omit = [
    "*/setup.py",
]

[tool.xdoctest]
options = ''

[tool.codespell]
skip = ['./docs/build', './*.egg-info', './build', './htmlcov']
count = true
quiet-level = 3
ignore-words-list = ['wont', 'cant', 'ANS', 'doesnt', 'arent', 'ans', 'thats', 'datas', 'isnt', 'didnt', 'wasnt']


[tool.mypy]
ignore_missing_imports = true

[tool.ty.rules]
unused-type-ignore-comment = "ignore"
unresolved-import = "ignore"

[[tool.ty.overrides]]
include = ["src/xdoctest/_tokenize.py"]
[tool.ty.overrides.rules]
unsupported-operator = "ignore"
invalid-assignment = "ignore"

[tool.ruff]
line-length = 80
target-version = "py38"
extend-exclude = ["src/xdoctest/_tokenize.py"]


[tool.ruff.lint]
# Enable Flake8 (E, F) and isort (I) rules.
select = ["E", "F", "I"]
# Ignore specific rules, for example, E501 (line too long) as it's handled by the formatter.
ignore = [
    "E501",  # line too long
    "E402",  # Module level import not at top of file
]

[tool.ruff.format]
quote-style = "single"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"
docstring-code-format = false