sphinx-test-reports/pyproject.toml at master · useblocks/sphinx-test-reports · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
[build-system]
requires = ["flit_core >=3.4,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "sphinx-test-reports"
version = "1.3.2"
description = "Sphinx extension for showing test results and test environment information inside sphinx documentations"
readme = "README.rst"
license = { text = "MIT" }
authors = [{ name = "team useblocks", email = "info@useblocks.com" }]
classifiers = [
  "Framework :: Sphinx",
  "Framework :: Sphinx :: Extension",
  "Development Status :: 4 - Beta",
  "License :: OSI Approved :: MIT License",
  "Operating System :: OS Independent",
  "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",
  "Topic :: Documentation",
]
keywords = ["sphinx", "documentation", "test-reports"]
requires-python = ">=3.10"
dependencies = ["sphinx>4.0", "lxml", "sphinx-needs>=1.0.1", "packaging>=20.0"]

[project.optional-dependencies]
test = [
  "beautifulsoup4",
  "nox>=2025.2.9",
  "pytest-xdist",
  "pytest>=7.0",
  "pytest-cov",
  "sphinx_design",
  "sphinxcontrib-plantuml",
]
docs = [
  "pillow",
  "sphinx-design",
  "sphinx-immaterial",
  "sphinx-needs>=6",
  "sphinx",
  "sphinxcontrib-plantuml",
]

[dependency-groups]
dev = ["pre-commit~=3.0", "nox>=2025.2.9", "mypy>=1.16.0"]

[tool.flit.module]
name = "sphinxcontrib.test_reports"

[project.urls]
Homepage = "https://github.com/useblocks/sphinx-test-reports"
Repository = "https://github.com/useblocks/sphinx-test-reports.git"
Documentation = "https://sphinx-test-reports.readthedocs.io/en/latest/"
download-url = "http://pypi.python.org/pypi/sphinx-test-reports"

[tool.ruff.lint]
# TODO enable and fix commented rules
extend-select = [
  "B",    # flake8-bugbear
  "C4",   # flake8-comprehensions
  "FURB", # refurb (modernising code)
  "I",    # isort
  "ICN",  # flake8-import-conventions
  "ISC",  # flake8-implicit-str-concat
  "N",    # pep8-naming
  "PERF", # perflint (performance anti-patterns)
  "PGH",  # pygrep-hooks
  "PIE",  # flake8-pie
  # "PL",   # pylint
  # "PTH",  # flake8-use-pathlib
  # "RUF",  # Ruff-specific rules
  # "SIM",  # flake8-simplify
  "SLF", # private member access
  # "UP",   # pyupgrade
  # "T20",  # flake8-print
]

[tool.mypy]
packages = ["sphinxcontrib.test_reports"]
strict = true
show_error_codes = true
# TODO: reactivate below files and fix issues in future PRs
exclude = [
  "^sphinxcontrib/test_reports/__init__\\.py$",
  "^sphinxcontrib/test_reports/config\\.py$",
  "^sphinxcontrib/test_reports/directives/__init__\\.py$",
  "^sphinxcontrib/test_reports/directives/test_case\\.py$",
  "^sphinxcontrib/test_reports/directives/test_common\\.py$",
  "^sphinxcontrib/test_reports/directives/test_env\\.py$",
  "^sphinxcontrib/test_reports/directives/test_file\\.py$",
  "^sphinxcontrib/test_reports/directives/test_report\\.py$",
  "^sphinxcontrib/test_reports/directives/test_results\\.py$",
  "^sphinxcontrib/test_reports/directives/test_suite\\.py$",
  "^sphinxcontrib/test_reports/environment\\.py$",
  "^sphinxcontrib/test_reports/exceptions\\.py$",
  "^sphinxcontrib/test_reports/functions",
  "^sphinxcontrib/test_reports/jsonparser\\.py$",
  "^sphinxcontrib/test_reports/junitparser\\.py$",
  "^sphinxcontrib/test_reports/test_reports\\.py$",
]
# Disallow dynamic typing
disallow_any_unimported = true
disallow_any_expr = true
disallow_any_decorated = true
disallow_any_generics = true
disallow_any_explicit = true
disallow_subclassing_any = true

# Disallow untyped definitions and calls
disallow_untyped_calls = true
disallow_untyped_defs = true
# disallow_incomplete_defs = true
# check_untyped_defs = true
# disallow_untyped_decorators = true

# # None and optional handling
# no_implicit_optional = true

# # Configuring warnings
# warn_unused_ignores = true
# warn_no_return = true
# warn_return_any = true
# warn_redundant_casts = true

# # Misc things
# strict_equality = true

# # Config file
# warn_unused_configs = true