Fix cyclic import context help

source/NVDAObjects/window/excel.py

@@ -25,6 +25,7 @@
 import api
 from logHandler import log
 import gui
+import gui.contextHelp
 import winUser
 import mouseHandler
 from displayModel import DisplayModelTextInfo
@@ -597,7 +598,7 @@ class ElementsListDialog(browseMode.ElementsListDialog):
 
 
 class EditCommentDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.TextEntryDialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	helpId = "ExcelReportingComments"

source/cursorManager.py

@@ -15,6 +15,7 @@
 import documentBase
 import gui
 from gui import guiHelper
+import gui.contextHelp
 import sayAllHandler
 import review
 from scriptHandler import willSayAllResume, script
@@ -31,7 +32,7 @@
 
 
 class FindDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	"""A dialog used to specify text to find in a cursor manager.

source/gui/__init__.py

@@ -1,9 +1,15 @@
 # -*- coding: UTF-8 -*-
-#gui/__init__.py
-#A part of NonVisual Desktop Access (NVDA)
-#Copyright (C) 2006-2018 NV Access Limited, Peter Vágner, Aleksey Sadovoy, Mesar Hameed, Joseph Lee, Thomas Stivers, Babbage B.V.
-#This file is covered by the GNU General Public License.
-#See the file COPYING for more details.
+# A part of NonVisual Desktop Access (NVDA)
+# Copyright (C) 2006-2020 NV Access Limited, Peter Vágner, Aleksey Sadovoy, Mesar Hameed, Joseph Lee,
+# Thomas Stivers, Babbage B.V.
+# This file is covered by the GNU General Public License.
+# See the file COPYING for more details.
+
+from .contextHelp import (
+	# several other submodules depend on ContextHelpMixin
+	# ensure early that it can be imported successfully.
+	ContextHelpMixin as _ContextHelpMixin,  # don't expose from gui, import submodule directly.
+)
 
 import time
 import os
@@ -25,7 +31,6 @@
 import queueHandler
 import core
 from . import guiHelper
-from .contextHelp import ContextHelpMixin
 from .settingsDialogs import *
 from .inputGestures import InputGesturesDialog
 import speechDictHandler
@@ -671,7 +676,7 @@ def run():
 
 
 class WelcomeDialog(
-		ContextHelpMixin,
+		_ContextHelpMixin,
 		wx.Dialog   # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	"""The NVDA welcome dialog.
@@ -774,7 +779,7 @@ def run(cls):
 
 
 class LauncherDialog(
-		ContextHelpMixin,
+		_ContextHelpMixin,
 		wx.Dialog   # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	"""The dialog that is displayed when NVDA is started from the launcher.
@@ -1068,7 +1073,7 @@ def _isDebug():
 
 
 class AskAllowUsageStatsDialog(
-		ContextHelpMixin,
+		_ContextHelpMixin,
 		wx.Dialog   # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	"""A dialog asking if the user wishes to allow NVDA usage stats to be collected by NV Access."""

source/gui/addonGui.py

@@ -22,6 +22,8 @@
 from . import nvdaControls
 from .dpiScalingHelper import DpiScalingHelperMixin, DpiScalingHelperMixinWithoutInit
 import gui.contextHelp
+
+
 def promptUserForRestart():
 	restartMessage = _(
 		# Translators: A message asking the user if they wish to restart NVDA
@@ -138,7 +140,7 @@ def _showAddonInfo(addon):
 
 class AddonsDialog(
 		DpiScalingHelperMixinWithoutInit,
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	@classmethod
@@ -664,7 +666,7 @@ def _showConfirmAddonInstallDialog(parent, bundle):
 
 class IncompatibleAddonsDialog(
 		DpiScalingHelperMixinWithoutInit,
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	"""A dialog that lists incompatible addons, and why they are not compatible"""

source/gui/configProfiles.py

@@ -15,7 +15,7 @@
 
 
 class ProfilesDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog   # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	shouldSuspendConfigProfileTriggers = True
@@ -310,7 +310,7 @@ def __init__(self, spec, display, profile):
 
 
 class TriggersDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	helpId = "ConfigProfileTriggers"
@@ -401,7 +401,7 @@ def onClose(self, evt):
 
 
 class NewProfileDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog   # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	helpId = "ProfilesCreating"
@@ -537,7 +537,7 @@ def onTriggerChoice(self, evt):
 
 
 class RenameProfileDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.TextEntryDialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	helpId = "ProfilesBasicManagement"

source/gui/contextHelp.py

@@ -6,10 +6,7 @@
 import os
 import tempfile
 import typing
-import queueHandler
 
-import gui
-import ui
 import wx
 from logHandler import log
 
@@ -29,11 +26,16 @@ def showHelp(helpId: str):
 	button in an NVDA dialog is pressed or the F1 key is pressed on a
 	recognized control.
 	"""
+
+	import ui
+	import queueHandler
 	if not helpId:
 		# Translators: Message indicating no context sensitive help is available for the control or dialog.
 		noHelpMessage = _("No help available here.")
 		queueHandler.queueFunction(queueHandler.eventQueue, ui.message, noHelpMessage)
 		return
+
+	import gui
 	helpFile = gui.getDocFilePath("userGuide.html")
 	if helpFile is None:
 		# Translators: Message shown when trying to display context sensitive help,

source/gui/installerGui.py

@@ -18,8 +18,8 @@
 from logHandler import log
 import gui
 from gui import guiHelper
+import gui.contextHelp
 from gui.dpiScalingHelper import DpiScalingHelperMixinWithoutInit
-from .contextHelp import ContextHelpMixin
 import tones
 import systemUtils
 
@@ -125,7 +125,7 @@ def doSilentInstall(
 
 class InstallerDialog(
 		DpiScalingHelperMixinWithoutInit,
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 
@@ -268,7 +268,7 @@ def onReviewAddons(self, evt):
 
 class InstallingOverNewerVersionDialog(
 		DpiScalingHelperMixinWithoutInit,
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 
@@ -330,7 +330,7 @@ def showInstallGui():
 
 
 class PortableCreaterDialog(
-		ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 

source/gui/settingsDialogs.py

@@ -23,6 +23,7 @@
 import languageHandler
 import speech
 import gui
+import gui.contextHelp
 import globalVars
 from logHandler import log
 import nvwave
@@ -55,10 +56,9 @@
 import keyLabels
 from .dpiScalingHelper import DpiScalingHelperMixinWithoutInit
 
-
 class SettingsDialog(
 		DpiScalingHelperMixinWithoutInit,
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 		metaclass=guiHelper.SIPABCMeta
 ):
@@ -252,7 +252,7 @@ def _onWindowDestroy(self, evt):
 
 class SettingsPanel(
 		DpiScalingHelperMixinWithoutInit,
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Panel,  # wxPython does not seem to call base class initializer, put last in MRO
 		metaclass=guiHelper.SIPABCMeta
 ):
@@ -864,7 +864,7 @@ def postSave(self):
 
 
 class LanguageRestartDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 
@@ -2472,7 +2472,7 @@ def onSave(self):
 
 
 class AdvancedPanelControls(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Panel,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	"""Holds the actual controls for the Advanced Settings panel, this allows the state of the controls to
@@ -2820,7 +2820,7 @@ def onEnableControlsCheckBox(self, evt):
 
 
 class DictionaryEntryDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	helpId = "SpeechDictionaries"
@@ -3943,7 +3943,7 @@ def Destroy(self):
 
 
 class AddSymbolDialog(
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 

source/updateCheck.py

@@ -20,7 +20,7 @@
 	raise RuntimeError("No update version type, update checking not supported")
 import addonAPIVersion
 # Avoid a E402 'module level import not at top of file' warning, because several checks are performed above.
-from gui.contextHelp import ContextHelpMixin  # noqa: E402
+import gui.contextHelp  # noqa: E402
 from gui.dpiScalingHelper import DpiScalingHelperMixin, DpiScalingHelperMixinWithoutInit  # noqa: E402
 import winVersion
 import os
@@ -320,7 +320,7 @@ def _result(self, info):
 
 class UpdateResultDialog(
 		DpiScalingHelperMixinWithoutInit,
-		ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog  # wxPython does not seem to call base class initializer, put last in MRO
 ):
 	helpId = "GeneralSettingsCheckForUpdates"
@@ -452,7 +452,7 @@ def onReviewAddonsButton(self, evt):
 
 class UpdateAskInstallDialog(
 		DpiScalingHelperMixinWithoutInit,
-		gui.ContextHelpMixin,
+		gui.contextHelp.ContextHelpMixin,
 		wx.Dialog,  # wxPython does not seem to call base class initializer, put last in MRO
 ):