pyproject.toml

[build-system]
requires = ["setuptools~=72.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "nvda"
description = "NonVisual Desktop Access (NVDA)"
maintainers = [
	{name = "NV Access", email = "info@nvaccess.org"},
]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: End Users/Desktop",
    "License :: OSI Approved :: GNU General Public License v2",
    "Operating System :: Microsoft :: Windows",
    "Programming Language :: Python :: 3",
    "Topic :: Accessibility",
]
readme = "readme.md"
license = {file = "copying.txt"}

[project.urls]
Homepage = "https://www.nvaccess.org/"
Repository = "https://github.com/nvaccess/nvda.git"
Issues = "https://github.com/nvaccess/nvda/issues"

[tool.ruff]
line-length = 110

builtins = [
	# translation lookup
	"_",
	# translation lookup
	"ngettext",
	# translation lookup
	"pgettext",
	# translation lookup
	"npgettext",
]

include = [
	"*.py",
	"*.pyw",
	"sconstruct",
	"*sconscript",
]

exclude = [
	".git",
	"__pycache__",
	".tox",
	"build",
	"output",
	".venv",
	# When excluding concrete paths relative to a directory,
	# not matching multiple folders by name e.g. `__pycache__`,
	# paths are relative to the configuration file.
	"./include/*",
	"./miscDeps",
	"./source/louis",
	# #10924: generated by third-party dependencies
	"./source/comInterfaces/*",
	# Code from add-ons
	"./source/userConfig/addons/*",
]

[tool.ruff.format]
indent-style = "tab"
line-ending = "lf"

[tool.ruff.lint.mccabe]
max-complexity = 15

[tool.ruff.lint]
ignore = [
	# indentation contains tabs
	"W191",
]
logger-objects = ["logHandler.log"]

[tool.ruff.lint.per-file-ignores]
# sconscripts contains many inbuilt functions not recognised by the lint,
# so ignore F821.
"sconstruct" = ["F821"]
"*sconscript" = ["F821"]

[tool.ruff.lint.flake8-tidy-imports.banned-api]
"winsound.PlaySound".msg= "PlaySound uses winmm, which is deprecated in favor of the Windows core audio APIs."

[tool.licensecheck]
using = "requirements:requirements.txt"
only_licenses = ["BSD", "MIT", "Python", "LGPLV3+", "Apache"]
ignore_packages = [
	# Incompatible Apache licenses.
	# These are current license violations and are bundled with NVDA.
	"fast-diff-match-patch",  # See also #16633
	"requests",

	# Incompatible Apache licenses.
	# Bundled with a dependency, but not bundled with NVDA.
	"importlib-metadata",
	"opencv-python",

	# Incompatible Apache licenses.
	# For building NVDA, but not included.
	"nuitka",

	# Incompatible Apache licenses.
	# System testing frameworks, not bundled with NVDA.
	"robotframework",
	"robotframework-screencaplibrary",
	"robotremoteserver",

	# Compatible licenses:
	"certifi",  # Mozilla Public License 2.0
	"markdown-link-attr-modifier",  # GPLV3 license, but not in PyPI correctly
	"pycaw",  # MIT license, but not in PyPI
	"wxPython",  # wxWindows Library License
	"pillow",  # PIL Software License
]


[tool.pyright]
venvPath = ".venv"
venv = "."
pythonPlatform = "Windows"
typeCheckingMode = "strict"

include = [
	"**/*.py",
	"**/*.pyw",
]

exclude = [
	"sconstruct",
	"*sconscript",
	".git",
	"__pycache__",
	".tox",
	"build",
	"output",
	".venv",
	# When excluding concrete paths relative to a directory,
	# not matching multiple folders by name e.g. `__pycache__`,
	# paths are relative to the configuration file.
	"./include/*",
	"./miscDeps",
	"./source/louis",
	# #10924: generated by third-party dependencies
	"./source/comInterfaces/*",
	# Code from add-ons
	"./source/userConfig/addons/*",
]

# Tell pyright where to load python code from
extraPaths = [
	"./source",
	# Used by system tests
	"./tests/system/libraries",
	# Used internally in NVDA
	"./miscDeps/python",
]

# General config
analyzeUnannotatedFunctions = true
deprecateTypingAliases = true

# Stricter typing
strictParameterNoneValue = true
strictListInference = true
strictDictionaryInference = true
strictSetInference = true

# Compliant rules
reportAssertAlwaysTrue = true
reportAssertTypeFailure = true
reportDuplicateImport = true
reportIncompleteStub = true
reportInconsistentOverload = true
reportInconsistentConstructor = true
reportInvalidStringEscapeSequence = true
reportInvalidStubStatement = true
reportInvalidTypeVarUse = true
reportMatchNotExhaustive = true
reportMissingModuleSource = true
reportMissingImports = true
reportNoOverloadImplementation = true
reportOptionalContextManager = true
reportOverlappingOverload = true
reportPrivateImportUsage = true
reportPropertyTypeMismatch = true
reportSelfClsParameterName = true
reportShadowedImports = true
reportTypeCommentUsage = true
reportTypedDictNotRequiredAccess = true
reportUndefinedVariable = true
reportUnusedExpression = true
reportUnboundVariable = true
reportUnhashable = true
reportUnnecessaryCast = true
reportUnnecessaryContains = true
reportUnnecessaryTypeIgnoreComment = true
reportUntypedClassDecorator = true
reportUntypedFunctionDecorator = true
reportUnusedClass = true
reportUnusedCoroutine = true
reportUnusedExcept = true

# Should switch to true when possible
reportDeprecated = false  # 1834 errors

# Can be enabled by generating type stubs for modules via pyright CLI
reportMissingTypeStubs = false

# Bad rules
# These are roughly sorted by compliance to make it easier for devs to focus on enabling them.
# Errors were last checked Feb 2025.
# 1-50 errors
reportUnsupportedDunderAll = false  # 2 errors
reportAbstractUsage = false  # 3 errors
reportUntypedBaseClass = false  # 4 errors
reportOptionalIterable = false  # 5 errors
reportCallInDefaultInitializer = false  # 6 errors
reportInvalidTypeArguments = false  # 7 errors
reportUntypedNamedTuple = false  # 11 errors
reportRedeclaration = false  # 12 errors
reportOptionalCall = false  # 16 errors
reportConstantRedefinition = false  # 18 errors
reportWildcardImportFromLibrary = false  # 26 errors
reportIncompatibleVariableOverride = false  # 28 errors
reportInvalidTypeForm = false  # 38 errors


# 50-100 errors
reportGeneralTypeIssues = false  # 53 errors
reportOptionalOperand = false  # 59 errors
reportUnnecessaryComparison = false  # 67 errors
reportFunctionMemberAccess = false  # 80 errors
reportUnnecessaryIsInstance = false  # 88 errors
reportUnusedFunction = false  # 97 errors
reportImportCycles = false  # 99 errors
reportUnusedImport = false  # 113 errors
reportUnusedVariable = false  # 147 errors

# 100-1000 errors
reportOperatorIssue = false  # 102 errors
reportAssignmentType = false  # 103 errors
reportReturnType = false  # 104 errors
reportPossiblyUnboundVariable = false  # 126 errors
reportMissingSuperCall = false  # 159 errors
reportUninitializedInstanceVariable = false  # 179 errors
reportUnknownLambdaType = false  # 196 errors
reportMissingTypeArgument = false  # 204 errors
reportImplicitStringConcatenation = false  # 300+ errors
reportIncompatibleMethodOverride = false  # 300+ errors
reportPrivateUsage = false  # 900+ errors

# 1000+ errors
reportUnusedCallResult = false  # 1000+ errors
reportOptionalSubscript = false  # 1000+ errors, mostly failing to recognize config setter/getter
reportCallIssue = false  # 1000+ errors, mostly failing to recognize config setter/getter
reportOptionalMemberAccess = false  # 1683 errors
reportImplicitOverride = false  # 2000+ errors
reportIndexIssue = false  # 2000+ errors, mostly failing to recognize config setter/getter
reportAttributeAccessIssue = false  # 2000+ errors
reportArgumentType = false  # 2000+ errors
reportUnknownParameterType = false  # 4000+ errors
reportMissingParameterType = false  # 4000+ errors
reportUnknownVariableType = false  # 6000+ errors
reportUnknownArgumentType = false  # 6000+ errors
reportUnknownMemberType = false  # 20000+ errors