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
146
147
|
# Ruff linter.
#
# Repository: https://github.com/astral-sh/ruff
#
# Documentation: https://beta.ruff.rs/docs/
[tool.ruff]
line-length = 100 # same as rustfmt
target-version = "py310"
lint.select = [
"A", # flake8-builtins: don't shadow builtins
"B", # flake8-bugbear: common bug sources
"C4", # flake8-comprehensions: unnecessary list/dict/set calls
"COM", # flake8-commas: trailing commas
"DTZ", # flake8-datetimez: naive datetime usage
"E", # pycodestyle errors
"F", # pyflakes
"FA", # flake8-future-annotations: enforce from __future__ import annotations
"FLY", # flynt: use f-strings instead of .join()
"FURB", # refurb: modernize and simplify code
"G", # flake8-logging-format: logging string formatting
"I", # isort: import sorting
"ICN", # flake8-import-conventions
"INP", # flake8-no-pep420: implicit namespace packages
"INT", # flake8-gettext
"ISC", # flake8-implicit-str-concat
"N", # pep8-naming
"PERF", # perflint: performance anti-patterns
"PIE", # flake8-pie: misc lints
"PL", # pylint
"PYI", # flake8-pyi: type stub and annotation best practices
"Q", # flake8-quotes: consistent quote style
"RET", # flake8-return: return statement checks
"RUF", # ruff-specific rules
"SIM", # flake8-simplify: simplifiable code patterns
"T20", # flake8-print: no stray print statements
"TC", # flake8-type-checking: move imports behind TYPE_CHECKING
"TID", # flake8-tidy-imports
"UP", # pyupgrade: catch deprecated syntax for Python 3.10+
"W", # pycodestyle warnings
"YTT", # flake8-2020: sys.version checks
]
lint.ignore = [
"E402", # Module level import not at top of file
"N802", # PascalCase D-Bus method names are required by the interface
"N812", # Uppercase import aliases for optional libraries (BRLAPI, LOUIS)
"N816", # camelCase debugLevel/debugFile preserved for orca-customizations.py compat
"PLC0415",# Import outside toplevel — used for circular import workarounds
"PLR0911",# Too many return statements
"PLR0912",# Too many branches
"PLR0913",# Too many arguments
"PLR0915",# Too many statements
"PLR2004",# Magic value used in comparison
"RET501", # Explicit return None — often intentional for clarity
"RET504", # Assignment before return — aids debugging and readability
"RUF001", # Ambiguous unicode in strings — intentional in mathsymbols.py
"RUF003", # Ambiguous unicode in comments — intentional in mathsymbols.py
"SIM102", # Collapsible if — often split deliberately for readability
"COM812", # Trailing comma — handled by ruff format; conflicts with formatter
"SIM108", # Ternary operator — can harm readability for complex conditions
]
[tool.ruff.lint.isort]
known-first-party = ["orca", "generate_gsettings_schemas"]
[tool.ruff.lint.per-file-ignores]
"src/orca/dbus_service.py" = ["FA100", "TC002"] # dasbus needs runtime type hints; future annotations breaks it
"tests/*" = ["T201"] # print used for test output
"tools/*" = ["T201", "PERF203"] # print used for CLI output; try-except in loops is fine
[tool.pylint.master]
#extension-pkg-allow-list = ["brlapi"] # this makes cli pylint crash.
init-hook = "import sys, os, warnings; sys.path.insert(0, os.path.join(os.getcwd(), 'src')); warnings.filterwarnings('ignore', message=r'.*(gobject|GstBus|g_param_spec|validate_pspec).*')"
[tool.pylint.typecheck]
ignored-classes = ["AXUtilities"]
[tool.pylint.messages_control]
disable = [
"fixme",
"duplicate-code",
"cyclic-import",
"c-extension-no-member",
"wrong-import-position",
"too-few-public-methods",
]
[tool.mypy]
mypy_path = "src"
exclude = [
"gnome-shell", # mypy doesn't like the name
"notification-daemon", # mypy doesn't like the name
"smuxi-frontend-gnome", # mypy doesn't like the name
"subprojects", # beyond our control
]
[[tool.mypy.overrides]]
module = [
"orca.settings",
"orca.braille",
"orca.spiel",
"orca.speechdispatcherfactory",
]
disable_error_code = ["var-annotated"]
[[tool.mypy.overrides]]
module = "brlapi.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "cairo.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "dbus.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "gi.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "louis.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "orca.orca_i18n"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "orca.orca_platform"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "speechd.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "dasbus.*"
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = "tests.*"
disable_error_code = ["method-assign", "attr-defined"]
[tool.codespell]
skip = "po,help,_build,subprojects,*.svg,*.doap,src/orca/braille_rolenames.py"
ignore-words-list = "punctuations,implementor,implementors,doubleclick,re-use,te,outloud"
|
