squash! Implement Enums for Role and State constants in controlTypes (#…

…12510) - maintain backwards compatibility with * imports
nvaccess · Jun 25, 2021 · e47d53e · e47d53e
1 parent 02785b9
commit e47d53e
Showing 1 changed file with 13 additions and 10 deletions.
diff --git a/source/controlTypes/__init__.py b/source/controlTypes/__init__.py
@@ -13,16 +13,19 @@
 from .state import State, STATES_SORTED, _negativeStateLabels, _stateLabels
 
 
-__all__ = [
-	"IsCurrent",
-	"OutputReason",
-	"processAndLabelStates",
-	"Role",
-	"silentRolesOnFocus",
-	"silentValuesForRoles",
-	"State",
-	"STATES_SORTED",
-]
+# After 2022, this will specify what is exported when performing a star import (from controlTypes import *).
+# Will break backwards compatibility.
+if version_year >= 2022:
+	__all__ = [
+		"IsCurrent",
+		"OutputReason",
+		"processAndLabelStates",
+		"Role",
+		"silentRolesOnFocus",
+		"silentValuesForRoles",
+		"State",
+		"STATES_SORTED",
+	]
 
 
 # Added to maintain backwards compatibility, marked for deprecation to be removed in 2022.1