Merge pull request #3810 from bdbaddog/remove_pywin32_from_platform_win32

Final PR to remove last vestiges of pywin32 from SCons.

Author: bdbaddog

.appveyor/install.bat

@@ -3,7 +3,7 @@ for /F "tokens=*" %%g in ('C:\\%WINPYTHON%\\python.exe -c "import sys; print(sys
 REM use mingw 32 bit until #3291 is resolved
 set PATH=C:\\%WINPYTHON%;C:\\%WINPYTHON%\\Scripts;C:\\ProgramData\\chocolatey\\bin;C:\\MinGW\\bin;C:\\MinGW\\msys\\1.0\\bin;C:\\cygwin\\bin;C:\\msys64\\usr\\bin;C:\\msys64\\mingw64\\bin;%PATH%
 C:\\%WINPYTHON%\\python.exe -m pip install -U --progress-bar off pip setuptools wheel
-C:\\%WINPYTHON%\\python.exe -m pip install -U --progress-bar off pypiwin32 coverage codecov
+C:\\%WINPYTHON%\\python.exe -m pip install -U --progress-bar off coverage codecov
 set STATIC_DEPS=true & C:\\%WINPYTHON%\\python.exe -m pip install -U --progress-bar off lxml
 REM install 3rd party tools to test with
 choco install --allow-empty-checksums dmd ldc swig vswhere xsltproc winflexbison

CHANGES.txt

@@ -17,9 +17,12 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
   From William Deegan:
     - Fix yacc tool, not respecting YACC set at time of tool initialization.
     - Refactor SCons.Tool to move all common shared and loadable module linking logic to SCons.Tool.linkCommon
-    - Remove pywin32 usage from SCons.Util where it was used for accessing the registry. Python native winreg
-      library already includes this functionality.
-    - Remove using pywin32 to retrieve peak memory usage on Win32 for `--debug=memory`
+    - Remove pywin32 imports from SCons.Script.Main. No longer needed.
+    - Switch to use ctypes instead of pywin32 (requiring an extra pip install) - Fixes Github Issue #2291
+       - pywin32 no longer necessary for SCons install. (pip install SCons will no longer also require pywin32 on win32)
+       - Remove pywin32 usage from SCons.Util where it was used for accessing the registry. Python native winreg
+         library already includes this functionality.
+       - Remove using pywin32 to retrieve peak memory usage on Win32 for `--debug=memory`
 
   From Michał Górny:
     - Fix dvipdf test failure due to passing incorrect flag to dvipdf.

README-SF.rst

@@ -48,8 +48,7 @@ Execution Requirements
 ======================
 
 Running SCons requires Python 3.5 or higher. There should be no other
-dependencies or requirements to run scons, although the pywin32 Python
-package is strongly recommended if running on Windows systems.
+dependencies or requirements to run scons.
 
 The default SCons configuration assumes use of the Microsoft Visual C++
 compiler suite on Win32 systems, and assumes a C compiler named 'cc', a C++

README-package.rst

@@ -45,8 +45,7 @@ Requirements
 ------------
 
 Running SCons requires Python 3.5 or higher. There should be no other
-dependencies or requirements to run SCons, although the pywin32 Python
-package is strongly recommended if running on Windows systems.
+dependencies or requirements to run SCons.
 
 
 By default, SCons knows how to search for available programming tools on

README.rst

@@ -73,8 +73,7 @@ Execution Requirements
 ======================
 
 Running SCons requires Python 3.5 or higher. There should be no other
-dependencies or requirements to run scons, although the pywin32 Python
-package is strongly recommended if running on Windows systems.
+dependencies or requirements to run scons
 
 The default SCons configuration assumes use of the Microsoft Visual C++
 compiler suite on Win32 systems, and assumes a C compiler named 'cc', a C++

SCons/Platform/win32.py

@@ -43,22 +43,6 @@
     r'C:\ProgramData\chocolatey\bin'
 ]
 
-try:
-    import msvcrt
-    import win32api
-    import win32con
-except ImportError:
-    parallel_msg = \
-        "you do not seem to have the pywin32 extensions installed;\n" + \
-        "\tparallel (-j) builds may not work reliably with open Python files."
-except AttributeError:
-    parallel_msg = \
-        "your pywin32 extensions do not support file handle operations;\n" + \
-        "\tparallel (-j) builds may not work reliably with open Python files."
-else:
-    parallel_msg = None
-
-
 if False:
     # Now swap out shutil.filecopy and filecopy2 for win32 api native CopyFile
     try:

SCons/Script/Main.py

@@ -46,6 +46,7 @@
 import traceback
 import sysconfig
 import platform
+import threading
 
 import SCons.CacheDir
 import SCons.Debug
@@ -80,17 +81,6 @@
 delayed_warnings = []
 
 
-def fetch_win32_parallel_msg():
-    # A subsidiary function that exists solely to isolate this import
-    # so we don't have to pull it in on all platforms, and so that an
-    # in-line "import" statement in the _main() function below doesn't
-    # cause warnings about local names shadowing use of the 'SCons'
-    # global in nest scopes and UnboundLocalErrors and the like in some
-    # versions (2.1) of Python.
-    import SCons.Platform.win32
-    return SCons.Platform.win32.parallel_msg
-
-
 def revert_io():
     # This call is added to revert stderr and stdout to the original
     # ones just in case some build rule or something else in the system
@@ -1281,16 +1271,19 @@ def tmtrace_cleanup(tfile):
     # As of 3.7, python removed support for threadless platforms.
     # See https://www.python.org/dev/peps/pep-0011/
     is_37_or_later = sys.version_info >= (3, 7)
-    python_has_threads = sysconfig.get_config_var('WITH_THREAD') or is_pypy or is_37_or_later
+    # python_has_threads = sysconfig.get_config_var('WITH_THREAD') or is_pypy or is_37_or_later
+
+    # As of python 3.4 threading has a dummy_threading module for use when there is no threading
+    # it's get_ident() will allways return -1, while real threading modules get_ident() will
+    # always return a positive integer
+    python_has_threads = threading.get_ident() != -1
     # to check if python configured with threads.
     global num_jobs
     num_jobs = options.num_jobs
     jobs = SCons.Job.Jobs(num_jobs, taskmaster)
     if num_jobs > 1:
         msg = None
-        if sys.platform == 'win32':
-            msg = fetch_win32_parallel_msg()
-        elif jobs.num_jobs == 1 or not python_has_threads:
+        if jobs.num_jobs == 1 or not python_has_threads:
             msg = "parallel builds are unsupported by this version of Python;\n" + \
                   "\tignoring -j or num_jobs option.\n"
         if msg:

doc/man/scons.xml

@@ -515,9 +515,7 @@ by appropriate setting of &consvars;.</para>
 
 <para>&scons;
 requires Python 3.5 or higher.
-There should be no other dependencies or requirements to run &scons;,
-although the <package>pywin32</package> Python package is
-strongly recommended if running on Windows systems.
+There should be no other dependencies or requirements to run &scons;.
 </para>
 
 </refsect1>

setup.cfg

@@ -42,7 +42,6 @@ zip_safe = False
 python_requires = >=3.5
 install_requires =
     setuptools
-    pywin32 >= 1.0;platform_system=="Windows"
 
 setup_requires = setuptools
 include_package_data = True

test/option/debug-memory.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
+# MIT License
 #
-# __COPYRIGHT__
+# Copyright The SCons Foundation
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -22,30 +23,25 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
-
 """
 Test that the --debug=memory option works.
 """
 
 import re
 
 import TestSCons
+from TestCmd import IS_WINDOWS
 
 test = TestSCons.TestSCons()
 
-try:
-    import resource
-except ImportError:
+if not IS_WINDOWS:
     try:
-        import win32process
-        import win32api
+        import resource  # noqa: F401
     except ImportError:
-        x = "Python version has no 'resource' or 'win32api/win32process' module; skipping tests.\n"
+        x = "Python version has no 'resource' skipping tests.\n"
         test.skip_test(x)
 
 
-
 test.write('SConstruct', """
 DefaultEnvironment(tools=[])
 def cat(target, source, env):