21cmFAST/pyproject.toml at main · 21cmfast/21cmFAST · 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
[build-system]
requires = ["setuptools>=78.1.0", "setuptools_scm>=8", "cython"]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]

[tool.ruff]
line-length = 88
target-version = "py311"
exclude = [
  "*.ipynb",  # include these later
  "devel/filter_valgrind.py",
]

[tool.ruff.lint]
extend-select = [
  "UP",   # pyupgrade
  "E",    # pycodestyle
  "W",    # pycodestyle warning
  "F",    # pyflakes
  "C90",  # mccabe complexity
  "I",    # isort
  "N",    # pep8-naming
  "D",    # docstyle
  # "ANN"   # type annotations
  "B",    # bugbear
  "A",    # builtins
  "C4",   # comprehensions
  "DTZ",  # datetime
  "FA",   # future annotations
  "PIE",  # flake8-pie
  "T",    # print statements
  "PT",   # pytest-style
  "Q",    # quotes
  "SIM",  # simplify
  "PTH",  # use Pathlib
  "ERA",  # kill commented code
  "NPY",  # numpy-specific rules
  "PERF", # performance
  # "FURB", # refurb
  "RUF",  # ruff-specific rules
]
ignore = [
    "DTZ007",   # use %z in strptime
    "DTZ005",
    "E203",
    "E266",
    "E501",
    "F403",
    #"F401",
    "E231",
    # Naming upper/lowercase -- too hard right now.
    "N803",
    # Naming upper/lowercase -- too hard right now.
    "N806",
    # Naming upper/lowercase -- too hard right now.
    "N802",
    # Naming mixed case
    "N815",
    # Docstring in imperative mood. This should *not* be the case for @property's, but can't ignore them atm.
#    "D401",
    # Module shadowing a builtin
    "A005",
    "RUF009",
    "B008",
]

[tool.ruff.lint.per-file-ignores]
"tests/*.py" = [
    "D103",  # ignore missing docstring in tests
    "DTZ",   # ignore datetime in tests
    "T",     # print statements
]
"devel/*.py" = [
  "T",
]
"docs/conf.py" = [
    "A",  # conf.py can shadow builtins
    "ERA",
]
"src/py21cmfast/cli.py" = [
    "D103",  # ignore missing docstrings
    "T",     # print statements
]
"build_cffi.py" = [
    "T",     # print statements
]


[tool.ruff.lint.pydocstyle]
convention = 'numpy'
property-decorators = [
    "property",
    "functools.cached_property",
    "pytest.fixture"
]
[tool.ruff.lint.mccabe]
max-complexity = 20