Merge 98469c2 into 9c5130f

LeonarddeR · web-flow · commit 3ba0bb23c6ef · 2022-11-09T17:12:51.000+10:00
diff --git a/source/addonHandler/__init__.py b/source/addonHandler/__init__.py
@@ -168,6 +168,7 @@ def initialize():
 	getAvailableAddons(refresh=True, isFirstLoad=True)
 	state.cleanupRemovedDisabledAddons()
 	state.save()
+	initializeModulePackagePaths()
 
 
 def terminate():
@@ -602,6 +603,54 @@ def _translatedManifestPaths(lang=None, forBundle=False):
 	return [sep.join(("locale", lang, MANIFEST_FILENAME)) for lang in langs]
 
 
+def initializeModulePackagePaths():
+	"""Initializes the module package paths for drivers and plugins.
+	This ensures that drivers (such as braille display drivers) or plugins (such as app modules)
+	can be discovered by NVDA.
+	"""
+	import appModules
+	import brailleDisplayDrivers
+	import globalPlugins
+	import synthDrivers
+	import visionEnhancementProviders
+	modules = [
+		appModules,
+		brailleDisplayDrivers,
+		globalPlugins,
+		synthDrivers,
+		visionEnhancementProviders,
+	]
+	for module in modules:
+		addDirsToPythonPackagePath(module)
+
+
+def addDirsToPythonPackagePath(module: ModuleType, subdir: typing.Optional[str] = None):
+	"""Add add-on and scratchpath directories for a module to the search path (__path__) of a Python package.
+	C{subdir} is added to each directory. It defaults to the name of the Python package.
+	@param module: The root module of the package.
+	@param subdir: The subdirectory to be used, C{None} for the name of C{module}.
+	"""
+	if config.isAppX or globalVars.appArgs.disableAddons:
+		return
+	for addon in getRunningAddons():
+		addon.addToPackagePath(module)
+	if globalVars.appArgs.secure or not config.conf['development']['enableScratchpadDir']:
+		return
+	if not subdir:
+		subdir = module.__name__
+	fullPath = os.path.join(config.getScratchpadDir(), subdir)
+	if fullPath in module.__path__:
+		return
+	# Ensure this directory exists otherwise pkgutil.iter_importers may emit None for missing paths.
+	if not os.path.isdir(fullPath):
+		os.makedirs(fullPath)
+	# Insert this path at the beginning  of the module's search paths.
+	# The module's search paths may not be a mutable list, so replace it with a new one
+	pathList = [fullPath]
+	pathList.extend(module.__path__)
+	module.__path__ = pathList
+
+
 class AddonBundle(AddonBase):
 	""" Represents the contents of an NVDA addon suitable for distribution.
 	The bundle is compressed using the zip file format. Manifest information
diff --git a/source/appModuleHandler.py b/source/appModuleHandler.py
@@ -361,7 +361,6 @@ def reloadAppModules():
 def initialize():
 	"""Initializes the appModule subsystem. 
 	"""
-	config.addConfigDirsToPythonPackagePath(appModules)
 	if not initialize._alreadyInitialized:
 		initialize._alreadyInitialized = True
 
diff --git a/source/braille.py b/source/braille.py
@@ -2393,7 +2393,6 @@ def func(cls):
 
 def initialize():
 	global handler
-	config.addConfigDirsToPythonPackagePath(brailleDisplayDrivers)
 	log.info("Using liblouis version %s" % louis.version())
 	import serial
 	log.info("Using pySerial version %s"%serial.VERSION)
diff --git a/source/config/__init__.py b/source/config/__init__.py
@@ -474,35 +474,6 @@ def setStartOnLogonScreen(enable: bool) -> None:
 			raise RuntimeError("Slave failed to set startOnLogonScreen")
 
 
-def addConfigDirsToPythonPackagePath(module, subdir=None):
-	"""Add the configuration directories to the module search path (__path__) of a Python package.
-	C{subdir} is added to each configuration directory. It defaults to the name of the Python package.
-	@param module: The root module of the package.
-	@type module: module
-	@param subdir: The subdirectory to be used, C{None} for the name of C{module}.
-	@type subdir: str
-	"""
-	if isAppX or globalVars.appArgs.disableAddons:
-		return
-	# FIXME: this should not be coupled to the config module....
-	import addonHandler
-	for addon in addonHandler.getRunningAddons():
-		addon.addToPackagePath(module)
-	if globalVars.appArgs.secure or not conf['development']['enableScratchpadDir']:
-		return
-	if not subdir:
-		subdir = module.__name__
-	fullPath=os.path.join(getScratchpadDir(),subdir)
-	# Ensure this directory exists otherwise pkgutil.iter_importers may emit None for missing paths.
-	if not os.path.isdir(fullPath):
-		os.makedirs(fullPath)
-	# Insert this path at the beginning  of the module's search paths.
-	# The module's search paths may not be a mutable  list, so replace it with a new one 
-	pathList=[fullPath]
-	pathList.extend(module.__path__)
-	module.__path__=pathList
-
-
 def _transformSpec(spec: ConfigObj):
 	"""To make the spec less verbose, transform the spec:
 	- Add default="default" to all featureFlag items. This is required so that the key can be read,
diff --git a/source/globalPluginHandler.py b/source/globalPluginHandler.py
@@ -27,7 +27,6 @@ def listPlugins():
 		yield plugin
 
 def initialize():
-	config.addConfigDirsToPythonPackagePath(globalPlugins)
 	for plugin in listPlugins():
 		try:
 			runningPlugins.add(plugin())
diff --git a/source/synthDriverHandler.py b/source/synthDriverHandler.py
@@ -375,7 +375,6 @@ def _get_initialSettingsRingSetting(self):
 
 
 def initialize():
-	config.addConfigDirsToPythonPackagePath(synthDrivers)
 	config.post_configProfileSwitch.register(handlePostConfigProfileSwitch)
 
 
diff --git a/source/vision/__init__.py b/source/vision/__init__.py
@@ -20,7 +20,6 @@
 
 def initialize() -> None:
 	global handler
-	config.addConfigDirsToPythonPackagePath(visionEnhancementProviders)
 	handler = VisionHandler()
 
 

Original file line number	Diff line number	Diff line change
`@@ -375,7 +375,6 @@ def _get_initialSettingsRingSetting(self):`
`375`	`375`
`376`	`376`
`377`	`377`	`def initialize():`
`378`		`- config.addConfigDirsToPythonPackagePath(synthDrivers)`
`379`	`378`	`config.post_configProfileSwitch.register(handlePostConfigProfileSwitch)`
`380`	`379`
`381`	`380`