Update add-on template

.github/workflows/build_addon.yml

@@ -24,7 +24,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: 3.11
         cache: 'pip'
 
     - name: Install dependencies

.gitignore

@@ -1,3 +1,5 @@
+.venv/
+.env/
 addon/doc/*.css
 addon/doc/en/
 *_docHandler.py

.vscode/extensions.json

@@ -6,7 +6,7 @@
 		"ms-python.python",
 		"ms-python.vscode-pylance",
 		"redhat.vscode-yaml",
-		"ms-python.flake8"
+		"charliermarsh.ruff"
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
 	"unwantedRecommendations": []

.vscode/settings.json

@@ -1,9 +1,5 @@
 {
     "editor.accessibilitySupport": "on",
-    "flake8.args": [
-        "--config=flake8.ini"
-    ],
-    "flake8.importStrategy": "fromEnvironment",
     "python.autoComplete.extraPaths": [
         "../nvda/source",
         "../nvda/miscDeps/python"

addon/globalPlugins/webAccess/config.py

@@ -25,7 +25,6 @@
 
 
 import config
-from logHandler import log
 
 from . import webModuleHandler
 

addon/globalPlugins/webAccess/gui/__init__.py

@@ -104,7 +104,7 @@ def __init__(self, *args, **kwargs):
 		super(ContextualSettingsPanel, self).__init__(*args, **kwargs)
 
 	def initData(self, context):
-		raise NotImplemented()
+		raise NotImplementedError()
 
 	# Set to True if the view depends on data that can be edited on other panels of the same dialog
 	initData.onPanelActivated = False

addon/globalPlugins/webAccess/gui/criteriaEditor.py

@@ -32,7 +32,6 @@
 
 import controlTypes
 import gui
-from logHandler import log
 
 from ..ruleHandler import ruleTypes
 from ..utils import guarded, updateOrDrop

addon/globalPlugins/webAccess/gui/menu.py

@@ -35,7 +35,6 @@
 from ... import webAccess
 from .. import ruleHandler
 from .. import webModuleHandler  
-from . import webModulesManager
 
 
 def show(context):

addon/globalPlugins/webAccess/gui/ruleEditor.py

@@ -25,7 +25,7 @@
 __author__ = "Shirley Noël <[email protected]>"
 
 
-from collections import OrderedDict, namedtuple
+from collections import OrderedDict
 import wx
 # TODO: Work-arround ExpandoTextCtrl mishandling maxHeight and vscroll
 # from wx.lib.expando import EVT_ETC_LAYOUT_NEEDED, ExpandoTextCtrl
@@ -36,7 +36,6 @@
 import inputCore
 from logHandler import log
 
-from .. import ruleHandler
 from ..ruleHandler import ruleTypes
 from ..ruleHandler.controlMutation import (
 	MUTATIONS_BY_RULE_TYPE,

addon/globalPlugins/webAccess/gui/rulesManager.py

@@ -635,7 +635,6 @@ def onTreeKeyDown(self, evt):
 		evt.Skip()
 
 	def onTreeSelChanged(self, evt):
-		from logHandler import log
 		if (
 			evt is not None
 			and (evt.EventObject is None or evt.EventObject.IsBeingDeleted())

addon/globalPlugins/webAccess/gui/webModuleEditor.py

@@ -32,10 +32,7 @@
 import os
 import wx
 
-from NVDAObjects import NVDAObject, IAccessible
 import addonHandler
-import api
-import controlTypes
 import config
 import gui
 from logHandler import log

addon/globalPlugins/webAccess/gui/webModulesManager.py

@@ -30,10 +30,7 @@
 import addonHandler
 addonHandler.initTranslation()
 import config
-import core
-import globalVars
 import gui
-import languageHandler
 from logHandler import log
 
 from gui.nvdaControls import AutoWidthColumnListCtrl

addon/globalPlugins/webAccess/overlay.py

@@ -51,7 +51,6 @@
 
 
 from six import iteritems
-from six.moves import xrange
 
 from garbageHandler import TrackedObject
 

addon/globalPlugins/webAccess/ruleHandler/ruleTypes.py

@@ -24,7 +24,6 @@
 __author__ = "Julien Cochuyt <[email protected]>"
 
 
-from collections import OrderedDict
 
 import addonHandler
 

addon/globalPlugins/webAccess/store/__init__.py

@@ -141,7 +141,7 @@ def route(self, ref=None, item=None, **kwargs):
 					if len(ref) == 1:
 						ref = ref[0]
 			else:
-				ValueError("Unexpected ref format: {ref}".format(ref))
+				ValueError("Unexpected ref format: {ref}".format())
 		else:
 			storeKey = ref
 		store = None

addon/globalPlugins/webAccess/store/addons.py

@@ -36,7 +36,7 @@
 class AddonsStore(DispatchStore):
 
 	def __init__(self, *args, **kwargs):
-		if not "name" in kwargs:
+		if "name" not in kwargs:
 			kwargs["name"] = "addons"
 		self.addonStoreFactory = kwargs["addonStoreFactory"]
 		super(AddonsStore, self).__init__(*args, **kwargs)

addon/globalPlugins/webAccess/store/webModule.py

@@ -28,19 +28,16 @@
 
 from collections import OrderedDict
 import errno
-import imp
 import os
 import os.path
-from pprint import pformat
 import re
 import sys
 
 import config
 import globalVars
 from logHandler import log
 
-from ..lib.packaging import version
-from ..webModuleHandler import InvalidApiVersion, WebModule, WebModuleDataLayer, getWebModuleFactory
+from ..webModuleHandler import WebModule, WebModuleDataLayer, getWebModuleFactory
 from . import DispatchStore
 from . import DuplicateRefError
 from . import MalformedRefError

addon/globalPlugins/webAccess/webAppLib/__init__.py

@@ -88,7 +88,6 @@ def trace (msg="trace"):
 	speech.speakMessage (msg)
 
 def beep (freq=1000, dur=50):
-	import tones
 	tones.beep (freq, dur)
 
 def reportFocus (obj):

addon/globalPlugins/webAccess/webAppScheduler.py

@@ -30,7 +30,6 @@
 import wx
 
 import api
-import textInfos
 
 from .overlay import WebAccessBmdti, WebAccessObject
 from .webAppLib import *

addon/globalPlugins/webAccess/webModuleHandler/__init__.py

@@ -215,7 +215,7 @@ def save(webModule, layerName=None, prompt=True, force=False, fromRuleEditor=Fal
 			)
 		else:
 			store.update(webModule, layerName=layer.name, force=force)
-	except DuplicateRefError as e:
+	except DuplicateRefError:
 		if not prompt or force:
 			return False
 		from ..gui import webModuleEditor
@@ -303,7 +303,7 @@ def showEditor(context, new=False):
 							force=force
 						)
 					keepShowing = keepTrying = False
-				except DuplicateRefError as e:
+				except DuplicateRefError:
 					if webModuleEditor.promptOverwrite():
 						force = True
 					else:

addon/globalPlugins/webAccess/webModuleHandler/dataRecovery.py

@@ -27,8 +27,6 @@
 from collections import OrderedDict
 import datetime
 import inspect
-import os
-from pprint import pformat
 
 import addonHandler
 addonHandler.initTranslation()

addon/globalPlugins/webAccess/webModuleHandler/webModule.py

@@ -29,18 +29,13 @@
 
 
 from collections import OrderedDict
-import datetime
-import json
-import os
 
 import addonHandler
 addonHandler.initTranslation()
 import api
 import baseObject
-import braille
 import config
 import controlTypes
-import globalVars
 from logHandler import log
 import scriptHandler
 import speech

pyproject.toml

@@ -0,0 +1,40 @@
+[tool.ruff]
+line-length = 110
+
+builtins = [
+	# translation lookup
+	"_",
+	# translation lookup
+	"ngettext",
+	# translation lookup
+	"pgettext",
+	# translation lookup
+	"npgettext",
+]
+
+include = [
+	"*.py",
+	"sconstruct",
+]
+
+exclude = [
+	".git",
+	"__pycache__",
+]
+
+[tool.ruff.format]
+indent-style = "tab"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[tool.ruff.lint]
+ignore = [
+	# indentation contains tabs
+	"W191",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# sconstruct contains many inbuilt functions not recognised by the lint,
+# so ignore F821.
+"sconstruct" = ["F821"]

requirements.txt

@@ -3,3 +3,9 @@ SCons==4.5.2
 
 # Building user documentation
 Markdown==3.5.1
+
+# Linter and code formatting tool
+ruff==0.5.5
+
+# Git hook scripts to automate tasks
+pre-commit==3.7.1