Merge pull request SCons#4576 from mwichmann/maint/variables-export

Restore usage of "from SCons.Variables import *`

Author: bdbaddog

CHANGES.txt

@@ -29,6 +29,12 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
     - Add a timeout to test/ninja/default_targets.py - it's gotten stuck on
       the GitHub Windows action and taken the run to the full six hour timeout.
       Usually runs in a few second, so set the timeout to 3min (120).
+    - SCons 4.8.0 added an `__all__`  specifier at the top of the Variables
+      module (`Variables/__init__.py`) to control what is made available in
+      a star import. However, there was existing usage of doing
+      `from SCons.Variables import *` which expected the variable *types*
+      to be avaiable. While we never advertised this usage, there's no
+      real reason it shouldn't keep working - add to `__all__`.
     - Switch SCons build to use setuptools' supported version fetcher from
       the old homegrown one.
 

RELEASE.txt

@@ -39,7 +39,13 @@ CHANGED/ENHANCED EXISTING FUNCTIONALITY
 FIXES
 -----
 
-- List fixes of outright bugs
+- SCons 4.8.0 added an `__all__`  specifier at the top of the Variables
+  module (`Variables/__init__.py`) to control what is made available in
+  a star import. However, there was existing usage of doing
+  `from SCons.Variables import *` which expected the variable *types*
+  to be avaiable. `BoolVariable`, `EnumVariable`, `ListVariable`,
+  `PackageVariable` and `PathVariable` are added to `__all__`,
+  so this form of import should now work again.
 
 IMPROVEMENTS
 ------------

SCons/Variables/VariablesTests.py

@@ -29,6 +29,7 @@
 import SCons.Subst
 import SCons.Warnings
 from SCons.Util import cmp
+from SCons.Variables import *
 
 
 class Environment:
@@ -723,6 +724,27 @@ def test_AddOptionWithAliasUpdatesUnknown(self) -> None:
         assert len(r) == 0, r
         assert env['ADDEDLATER'] == 'added', env['ADDEDLATER']
 
+    def test_VariableTypesImportVisibility(self) -> None:
+        """Test that 'from SCons.Variables import *' will import all types of SCons defined Variables
+            """
+
+        try:
+            x = BoolVariable('test', 'test option help', False)
+            y = EnumVariable('test', 'test option help', 0,
+                                          ['one', 'two', 'three'],
+                                          {})
+            z = ListVariable('test', 'test option help', 'all',
+                                          ['one', 'two', 'three'])
+            o = PackageVariable('test', 'test build variable help', '/default/path')
+            p = PathVariable('test',
+                                          'test build variable help',
+                                          '/default/path')
+        except Exception as e:
+            self.fail(f"Could not import all known Variable types: {e}")
+
+
+
+
 
 if __name__ == "__main__":
     unittest.main()

SCons/Variables/__init__.py

@@ -43,6 +43,11 @@
 __all__ = [
     "Variable",
     "Variables",
+    "BoolVariable",
+    "EnumVariable",
+    "ListVariable",
+    "PackageVariable",
+    "PathVariable",
 ]
 
 class Variable: