Changed method names to lowerCamelCase (#6)

The PR changes all of the names of methods in MathCAT.py, MathCATPreferences.py, and MathCATgui.py to lowerCamelCase

Author: RyanMcCleary

addon/globalPlugins/MathCAT/MathCAT.py

@@ -110,7 +110,7 @@ def getLanguageToUse(mathMl: str = "") -> str:
 	return language
 
 
-def ConvertSSMLTextForNVDA(text: str) -> list:
+def convertSSMLTextForNVDA(text: str) -> list:
 	"""Change the SSML in the text into NVDA's command structure.
 	The environment is examined to determine whether a language switch is needed"""
 	# MathCAT's default rate is 180 wpm.
@@ -231,7 +231,7 @@ def reportFocus(self):
 			getSynth()._set_rate(_synthesizerRate)
 		try:
 			text = libmathcat.DoNavigateCommand("ZoomIn")
-			speech.speak(ConvertSSMLTextForNVDA(text))
+			speech.speak(convertSSMLTextForNVDA(text))
 		except Exception as e:
 			log.exception(e)
 			# Translators: this message directs users to look in the log file
@@ -307,7 +307,7 @@ def script_navigate(self, gesture: KeyboardInputGesture):
 					False,
 				)
 				# log.info(f"Navigate speech for {gesture.vkCode}/(s={'shift' in modNames}, c={'control' in modNames}): '{text}'")
-				speech.speak(ConvertSSMLTextForNVDA(text))
+				speech.speak(convertSSMLTextForNVDA(text))
 		except Exception as e:
 			log.exception(e)
 			# Translators: this message directs users to look in the log file
@@ -515,11 +515,11 @@ def getSpeechForMathMl(self, mathml: str):
 			if self._addSounds():
 				return (
 					[BeepCommand(800, 25)]
-					+ ConvertSSMLTextForNVDA(libmathcat.GetSpokenText())
+					+ convertSSMLTextForNVDA(libmathcat.GetSpokenText())
 					+ [BeepCommand(600, 15)]
 				)
 			else:
-				return ConvertSSMLTextForNVDA(libmathcat.GetSpokenText())
+				return convertSSMLTextForNVDA(libmathcat.GetSpokenText())
 
 		except Exception as e:
 			log.exception(e)

addon/globalPlugins/MathCAT/MathCATPreferences.py

@@ -11,7 +11,7 @@
 import addonHandler
 from logHandler import log  # logging
 from typing import List, Dict, Union, Callable
-from .MathCAT import ConvertSSMLTextForNVDA
+from .MathCAT import convertSSMLTextForNVDA
 from speech import speak
 from zipfile import ZipFile
 
@@ -72,8 +72,8 @@ def __init__(self, parent):
 			self._listBoxPreferencesTopic.SetSelection(0)
 			userPreferences["NVDAAddOn"] = {"LastCategory": "0"}
 		# populate the languages and braille codes
-		UserInterface.GetLanguages(self)
-		UserInterface.GetBrailleCodes(self)
+		UserInterface.getLanguages(self)
+		UserInterface.getBrailleCodes(self)
 		# set the ui items to match the preferences
 		UserInterface.setUIValues(self)
 
@@ -88,7 +88,7 @@ def pathToBrailleFolder():
 		return os.path.join(os.path.dirname(os.path.abspath(__file__)), "Rules", "Braille")
 
 	@staticmethod
-	def LanguagesDict() -> Dict[str, str]:
+	def languagesDict() -> Dict[str, str]:
 		languages = {
 			"aa": "Afar",
 			"ab": "Аҧсуа",
@@ -291,13 +291,13 @@ def getRulesFiles(
 
 		return ruleFiles
 
-	def GetLanguages(self):
+	def getLanguages(self):
 		def addRegionalLanguages(subDir: str, language: str) -> List[str]:
 			# the language variants are in folders named using ISO 3166-1 alpha-2
 			# codes https://en.wikipedia.org/wiki/ISO_3166-2
 			# check if there are language variants in the language folder
 			if subDir != "SharedRules":
-				languagesDict = UserInterface.LanguagesDict()
+				languagesDict = UserInterface.languagesDict()
 				# add to the listbox the text for this language variant together with the code
 				regionalCode = language + "-" + subDir.upper()
 				if languagesDict.get(regionalCode, "missing") != "missing":
@@ -310,7 +310,7 @@ def addRegionalLanguages(subDir: str, language: str) -> List[str]:
 			return []
 
 		# initialise the language list
-		languagesDict = UserInterface.LanguagesDict()
+		languagesDict = UserInterface.languagesDict()
 		# clear the language names in the dialog
 		self._choiceLanguage.Clear()
 		# Translators: menu item -- use the language of the voice chosen in the NVDA speech settings dialog
@@ -331,12 +331,12 @@ def addRegionalLanguages(subDir: str, language: str) -> List[str]:
 					else:
 						self._choiceLanguage.Append(language + " (" + language + ")")
 
-	def GetLanguageCode(self):
+	def getLanguageCode(self):
 		lang_selection = self._choiceLanguage.GetStringSelection()
 		lang_code = lang_selection[lang_selection.find("(") + 1 : lang_selection.find(")")]
 		return lang_code
 
-	def GetSpeechStyles(self, thisSpeechStyle: str):
+	def getSpeechStyles(self, thisSpeechStyle: str):
 		"""Get all the speech styles for the current language.
 		This sets the SpeechStyles dialog entry"""
 		from speech import getCurrentLanguage
@@ -370,7 +370,7 @@ def getSpeechStyleFromDirectory(dir: str, lang: str) -> list[str]:
 		# clear the SpeechStyle choices
 		self._choiceSpeechStyle.Clear()
 		# get the currently selected language code
-		languageCode = UserInterface.GetLanguageCode(self)
+		languageCode = UserInterface.getLanguageCode(self)
 
 		if languageCode == "Auto":
 			# list the speech styles for the current voice rather than have none listed
@@ -402,7 +402,7 @@ def getSpeechStyleFromDirectory(dir: str, lang: str) -> list[str]:
 			# that didn't work, choose the first in the list
 			self._choiceSpeechStyle.SetSelection(0)
 
-	def GetBrailleCodes(self):
+	def getBrailleCodes(self):
 		# initialise the braille code list
 		self._choiceBrailleMathCode.Clear()
 		# populate the available braille codes in the dialog
@@ -438,7 +438,7 @@ def setUIValues(self):
 				self._choiceLanguage.SetSelection(0)
 			try:
 				# now get the available SpeechStyles from the folder structure and set to the preference setting is possible
-				self.GetSpeechStyles(str(userPreferences["Speech"]["SpeechStyle"]))
+				self.getSpeechStyles(str(userPreferences["Speech"]["SpeechStyle"]))
 			except Exception as e:
 				log.exception(f"MathCAT: An exception occurred in set_ui_values (getting SpeechStyle): {e}")
 				self._choiceSpeechStyle.Append(
@@ -511,7 +511,7 @@ def getUIValues(self):
 		global userPreferences
 		# read the values from the UI and update the user preferences dictionary
 		userPreferences["Speech"]["Impairment"] = Speech_Impairment[self._choiceImpairment.GetSelection()]
-		userPreferences["Speech"]["Language"] = self.GetLanguageCode()
+		userPreferences["Speech"]["Language"] = self.getLanguageCode()
 		userPreferences["Other"]["DecimalSeparator"] = Speech_DecimalSeparator[
 			self._choiceDecimalSeparator.GetSelection()
 		]
@@ -695,17 +695,17 @@ def writeUserPreferences():
 			# write values to the user preferences file, NOT the default
 			yaml.dump(userPreferences, stream=f, allow_unicode=True)
 
-	def OnRelativeSpeedChanged(self, event):
+	def onRelativeSpeedChanged(self, event):
 		rate = self._sliderRelativeSpeed.GetValue()
 		# Translators: this is a test string that is spoken. Only translate "the square root of x squared plus y squared"
 		text = _("<prosody rate='XXX%'>the square root of x squared plus y squared</prosody>").replace(
 			"XXX",
 			str(rate),
 			1,
 		)
-		speak(ConvertSSMLTextForNVDA(text))
+		speak(convertSSMLTextForNVDA(text))
 
-	def OnPauseFactorChanged(self, event):
+	def onPauseFactorChanged(self, event):
 		rate = self._sliderRelativeSpeed.GetValue()
 		pfSlider = self._sliderPauseFactor.GetValue()
 		pauseFactor = (
@@ -730,44 +730,44 @@ def OnPauseFactorChanged(self, event):
 			pause_factor_300=300 * pauseFactor // 100,
 			pause_factor_600=600 * pauseFactor // 100,
 		)
-		speak(ConvertSSMLTextForNVDA(text))
+		speak(convertSSMLTextForNVDA(text))
 
-	def OnClickOK(self, event):
+	def onClickOK(self, event):
 		UserInterface.getUIValues(self)
 		UserInterface.writeUserPreferences()
 		self.Destroy()
 
-	def OnClickCancel(self, event):
+	def onClickCancel(self, event):
 		self.Destroy()
 
-	def OnClickApply(self, event):
+	def onClickApply(self, event):
 		UserInterface.getUIValues(self)
 		UserInterface.writeUserPreferences()
 
-	def OnClickReset(self, event):
+	def onClickReset(self, event):
 		UserInterface.loadDefaultPreferences()
 		UserInterface.validateUserPreferences()
 		UserInterface.setUIValues(self)
 
-	def OnClickHelp(self, event):
+	def onClickHelp(self, event):
 		webbrowser.open("https://nsoiffer.github.io/MathCAT/users.html")
 
-	def OnListBoxCategories(self, event):
+	def onListBoxCategories(self, event):
 		# the category changed, now show the appropriate dialogue page
 		self._simplebookPanelsCategories.SetSelection(self._listBoxPreferencesTopic.GetSelection())
 
-	def OnLanguage(self, event):
+	def onLanguage(self, event):
 		# the language changed, get the SpeechStyles for the new language
-		UserInterface.GetSpeechStyles(self, self._choiceSpeechStyle.GetStringSelection())
+		UserInterface.getSpeechStyles(self, self._choiceSpeechStyle.GetStringSelection())
 
-	def MathCATPreferencesDialogOnCharHook(self, event: wx.KeyEvent):
+	def mathCATPreferencesDialogOnCharHook(self, event: wx.KeyEvent):
 		# designed choice is that Enter is the same as clicking OK, and Escape is the same as clicking Cancel
 		keyCode = event.GetKeyCode()
 		if keyCode == wx.WXK_ESCAPE:
-			UserInterface.OnClickCancel(self, event)
+			UserInterface.onClickCancel(self, event)
 			return
 		if keyCode == wx.WXK_RETURN:
-			UserInterface.OnClickOK(self, event)
+			UserInterface.onClickOK(self, event)
 		if keyCode == wx.WXK_TAB:
 			if event.GetModifiers() == wx.MOD_CONTROL:
 				# cycle the category forward
@@ -776,7 +776,7 @@ def MathCATPreferencesDialogOnCharHook(self, event: wx.KeyEvent):
 					newCategory = 0
 				self._listBoxPreferencesTopic.SetSelection(newCategory)
 				# update the ui to show the new page
-				UserInterface.OnListBoxCategories(self, event)
+				UserInterface.onListBoxCategories(self, event)
 				# set the focus into the category list box
 				self._listBoxPreferencesTopic.SetFocus()
 				# jump out so the tab key is not processed
@@ -788,7 +788,7 @@ def MathCATPreferencesDialogOnCharHook(self, event: wx.KeyEvent):
 					newCategory = 2
 				self._listBoxPreferencesTopic.SetSelection(newCategory)
 				# update the ui to show the new page
-				UserInterface.OnListBoxCategories(self, event)
+				UserInterface.onListBoxCategories(self, event)
 				# update the ui to show the new page
 				self._listBoxPreferencesTopic.SetFocus()
 				# jump out so the tab key is not processed

addon/globalPlugins/MathCAT/MathCATgui.py

@@ -809,54 +809,54 @@ def __init__(self, parent):
 		self.Centre(wx.BOTH)
 
 		# Connect Events
-		self.Bind(wx.EVT_CHAR_HOOK, self.MathCATPreferencesDialogOnCharHook)
-		self.Bind(wx.EVT_KEY_UP, self.MathCATPreferencesDialogOnKeyUp)
-		self._listBoxPreferencesTopic.Bind(wx.EVT_LISTBOX, self.OnListBoxCategories)
-		self._choiceLanguage.Bind(wx.EVT_CHOICE, self.OnLanguage)
+		self.Bind(wx.EVT_CHAR_HOOK, self.mathCATPreferencesDialogOnCharHook)
+		self.Bind(wx.EVT_KEY_UP, self.mathCATPreferencesDialogOnKeyUp)
+		self._listBoxPreferencesTopic.Bind(wx.EVT_LISTBOX, self.onListBoxCategories)
+		self._choiceLanguage.Bind(wx.EVT_CHOICE, self.onLanguage)
 		self._sliderRelativeSpeed.Bind(
 			wx.EVT_SCROLL_CHANGED,
-			self.OnRelativeSpeedChanged,
+			self.onRelativeSpeedChanged,
 		)
-		self._sliderPauseFactor.Bind(wx.EVT_SCROLL_CHANGED, self.OnPauseFactorChanged)
-		self._buttonOK.Bind(wx.EVT_BUTTON, self.OnClickOK)
-		self._buttonCancel.Bind(wx.EVT_BUTTON, self.OnClickCancel)
-		self._buttonApply.Bind(wx.EVT_BUTTON, self.OnClickApply)
-		self._buttonReset.Bind(wx.EVT_BUTTON, self.OnClickReset)
-		self._buttonHelp.Bind(wx.EVT_BUTTON, self.OnClickHelp)
+		self._sliderPauseFactor.Bind(wx.EVT_SCROLL_CHANGED, self.onPauseFactorChanged)
+		self._buttonOK.Bind(wx.EVT_BUTTON, self.onClickOK)
+		self._buttonCancel.Bind(wx.EVT_BUTTON, self.onClickCancel)
+		self._buttonApply.Bind(wx.EVT_BUTTON, self.onClickApply)
+		self._buttonReset.Bind(wx.EVT_BUTTON, self.onClickReset)
+		self._buttonHelp.Bind(wx.EVT_BUTTON, self.onClickHelp)
 
 	def __del__(self):
 		pass
 
 	# Virtual event handlers, override them in your derived class
-	def MathCATPreferencesDialogOnCharHook(self, event):
+	def mathCATPreferencesDialogOnCharHook(self, event):
 		event.Skip()
 
-	def MathCATPreferencesDialogOnKeyUp(self, event):
+	def mathCATPreferencesDialogOnKeyUp(self, event):
 		event.Skip()
 
-	def OnListBoxCategories(self, event):
+	def onListBoxCategories(self, event):
 		event.Skip()
 
-	def OnLanguage(self, event):
+	def onLanguage(self, event):
 		event.Skip()
 
-	def OnRelativeSpeedChanged(self, event):
+	def onRelativeSpeedChanged(self, event):
 		event.Skip()
 
-	def OnPauseFactorChanged(self, event):
+	def onPauseFactorChanged(self, event):
 		event.Skip()
 
-	def OnClickOK(self, event):
+	def onClickOK(self, event):
 		event.Skip()
 
-	def OnClickCancel(self, event):
+	def onClickCancel(self, event):
 		event.Skip()
 
-	def OnClickApply(self, event):
+	def onClickApply(self, event):
 		event.Skip()
 
-	def OnClickReset(self, event):
+	def onClickReset(self, event):
 		event.Skip()
 
-	def OnClickHelp(self, event):
+	def onClickHelp(self, event):
 		event.Skip()