kaitai_struct_python_runtime/pyproject.toml at master · kaitai-io/kaitai_struct_python_runtime · 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
[build-system]
requires = ["setuptools >= 38.6.0"]
build-backend = "setuptools.build_meta"

[tool.ruff]
# The minimum Python version to target (should match `python_requires` in setup.cfg)
target-version = "py38"

[tool.ruff.lint]
select = ["ALL"]
ignore = [
    # Missing type annotations
    "ANN",
    # Trailing commas (the formatter handles this)
    "COM",
    # Missing docstrings
    "D1",
    # incorrect-blank-line-before-class (that's ugly)
    "D203",
    # incorrect-blank-line-after-class (the formatter handles this)
    "D204",
    # docstring-tab-indentation (the formatter handles this)
    "D206",
    # under-indentation (the formatter handles this)
    "D207",
    # over-indentation (the formatter handles this)
    "D208",
    # surrounding-whitespace (the formatter handles this)
    "D210",
    # blank-line-before-class (the formatter handles this)
    "D211",
    # triple-single-quotes (the formatter handles this)
    "D300",
    # Indentation (the formatter handles this)
    "E1",
    # Whitespace (the formatter handles this)
    "E2",
    # # line-too-long
    # "E501",
    # pycodestyle warnings (the formatter handles this)
    "W",
    # flake8-quotes
    "Q",
    # raise-vanilla-args (not considered beneficial)
    "TRY003",
]
extend-select = [
    # multi-line-summary-first-line (not included in
    # `tool.ruff.lint.pydocstyle.convention = "pep257"`)
    "D212",
]

[tool.ruff.lint.pydocstyle]
convention = "pep257"

[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"

[tool.pylint.main]
# Minimum Python version to use for version dependent checks (should match
# `python_requires` in setup.cfg)
py-version = "3.8"

[tool.pylint."messages control"]
# We only use Pylint because it still contains a number of lints that Ruff doesn't have.
# That's why we globally suppress Pylint checks that Ruff already implements here. If we
# didn't do this, we'd have to duplicate Ruff and Pylint suppression comments in the
# code (since they have different syntax), which doesn't make sense.
#
# https://github.com/astral-sh/ruff/issues/970 tracks the current progress of
# implementing Pylint rules in Ruff.
disable = [
    "missing-docstring",
    # Not considered beneficial (see
    # https://pylint.readthedocs.io/en/stable/user_guide/checkers/features.html#design-checker
    # for what this includes)
    "design",
    # Not considered beneficial
    "too-many-lines",
    # Checked by Ruff
    "line-too-long",
    # Checked by Ruff
    "consider-using-with",
    # Checked by Ruff
    "broad-exception-raised"
]