scippnexus/pyproject.toml at main · scipp/scippnexus · 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
135
136
137
138
139
140
141
142
143
144
145
[build-system]
requires = [
  "setuptools>=77",
  "setuptools_scm[toml]>=8.0",
]
build-backend = "setuptools.build_meta"

[project]
name = "scippnexus"
description = "An h5py-like utility for NeXus files with seamless Scipp integration"
authors = [{ name = "Scipp contributors" }]
license = "BSD-3-Clause"
license-files = ["LICENSE"]
readme = "README.md"
classifiers = [
    "Intended Audience :: Science/Research",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering",
    "Typing :: Typed",
]
requires-python = ">=3.11"

# IMPORTANT:
# Run 'tox -e deps' after making changes here. This will update requirement files.
# Make sure to list one dependency per line.
dependencies = [
    "scipp>=24.02.0",
    "scipy>=1.10.0",
    "h5py>=3.12",
]

dynamic = ["version"]

[project.optional-dependencies]
test = [
    "graphviz",
    "pytest>=8.0",
]

[project.urls]
"Bug Tracker" = "https://github.com/scipp/scippnexus/issues"
"Documentation" = "https://scipp.github.io/scippnexus"
"Source" = "https://github.com/scipp/scippnexus"

[tool.setuptools_scm]

[tool.pytest.ini_options]
minversion = "7.0"
# The custom `externalfile` marker runs tests that require passwordless
# SSH access to login.esss.dk. We do not run it by default. Make sure to
# setup keys in your SSH agent before running `pytest -m externalfile`.
addopts = """
--strict-config
--strict-markers
--import-mode=importlib
-ra
-v
-m 'not externalfile'
"""
testpaths = "tests"
filterwarnings = [
  "error",
]
markers = [
    "externalfile",
]

[tool.ruff]
line-length = 88
extend-include = ["*.ipynb"]
extend-exclude = [
    ".*", "__pycache__", "build", "dist", "install",
]

[tool.ruff.lint]
# See https://docs.astral.sh/ruff/rules/
select = ["B", "C4", "DTZ", "E", "F", "G", "I", "PERF", "PGH", "PT", "PYI", "RUF", "S", "T20", "UP", "W"]
ignore = [
    # Conflict with ruff format, see
    # https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
    "COM812", "COM819", "D206", "D300", "E111", "E114", "E117", "ISC001", "ISC002", "Q000", "Q001", "Q002", "Q003", "W191",
]
fixable = ["B010", "I001", "PT001", "RUF022"]
isort.known-first-party = ["scippnexus"]
pydocstyle.convention = "numpy"

[tool.ruff.lint.per-file-ignores]
# those files have an increased risk of relying on import order
"tests/*" = [
    "S101",  # asserts are fine in tests
    "B018",  # 'useless expressions' are ok because some tests just check for exceptions
]
"*.ipynb" = [
    "E501",  # longer lines are sometimes more readable
    "F403",  # *-imports used with domain types
    "F405",  # linter may fail to find names because of *-imports
    "I",  # we don't collect imports at the top
    "S101",  # asserts are used for demonstration and are safe in notebooks
    "T201",  # printing is ok for demonstration purposes
]

[tool.ruff.format]
quote-style = "preserve"

[tool.mypy]
strict = true
ignore_missing_imports = true
enable_error_code = [
    "ignore-without-code",
    "redundant-expr",
    "truthy-bool",
]
warn_unreachable = true

exclude = [
    # not yet updated for type hints:
    '^tests/',
    '^src/scippnexus/nxlog',
    '^src/scippnexus/nxsample',
    '^src/scippnexus/nxoff_geometry',
    '^src/scippnexus/nxevent_data',
    '^src/scippnexus/event_field',
    '^src/scippnexus/nxcylindrical_geometry',
    '^src/scippnexus/nxdata',
    '^src/scippnexus/_load',
    '^src/scippnexus/nxmonitor',
    '^src/scippnexus/nxdetector',
    '^src/scippnexus/application_definitions/',
    '^src/scippnexus/nxtransformations',
    '^src/scippnexus/base',
]

[tool.codespell]
ignore-words-list = [
    # Codespell wants "socioeconomic" which seems to be the standard spelling.
    # But we use the word in our code of conduct which is the contributor covenant.
    # Let's not modify it if we don't have to.
    "socio-economic",
]