Import pywin32 in compat and only use it from there.

This eliminates the "early pywin32 import" warning/error.
- This allows using pywin32ctypes without confusing import requirements
- Removes code that assumes win32api might not be present (which can never be true now anyways)

See c901c42 and 3e14224.

Author: virtuald

PyInstaller/__init__.py

@@ -38,8 +38,7 @@
         # Do conversion to ShortPathName really only in case HOMEPATH is not
         # ascii only - conversion to unicode type cause this unicode error.
         try:
-            import win32api
-            HOMEPATH = win32api.GetShortPathName(HOMEPATH)
+            HOMEPATH = compat.win32api.GetShortPathName(HOMEPATH)
         except ImportError:
             pass
 

PyInstaller/compat.py

@@ -198,6 +198,30 @@
     modname_tkinter = 'tkinter'
 
 
+# On Windows we require pypiwin32 or pywin32-ctypes
+# -> all pyinstaller modules should use win32api from PyInstaller.compat to
+#    ensure that it can work on MSYS2 (which requires pywin32-ctypes)
+if is_win:
+    try:
+        from PyInstaller.utils.win32 import winutils
+        try:
+            pywintypes = winutils.import_pywin32_module('pywintypes', _is_venv=is_venv)
+            win32api = winutils.import_pywin32_module('win32api', _is_venv=is_venv)
+        except ImportError:
+            try:
+                from win32ctypes.pywin32 import pywintypes
+                from win32ctypes.pywin32 import win32api
+            except ImportError:
+                raise
+    except ImportError:
+        # This environment variable is set by seutp.py
+        # - It's not an error for pywin32 to not be installed at that point
+        if not os.environ.get('PYINSTALLER_NO_PYWIN32_FAILURE'):
+            raise SystemExit('PyInstaller cannot check for assembly dependencies.\n'
+                             'Please install PyWin32 or pywin32-ctypes.\n\n'
+                             'pip install pypiwin32\n')
+
+
 def architecture():
     """
     Returns the bit depth of the python interpreter's architecture as
@@ -578,7 +602,6 @@ def getcwd():
             # Do conversion to ShortPathName really only in case 'cwd' is not
             # ascii only - conversion to unicode type cause this unicode error.
             try:
-                import win32api
                 cwd = win32api.GetShortPathName(cwd)
             except ImportError:
                 pass
@@ -833,37 +856,10 @@ class FileNotFoundError(OSError):
 
 def check_requirements():
     """
-    Verify that all requirements to run PyInstaller are met. Especially
-    PyWin32 is installed on Windows.
+    Verify that all requirements to run PyInstaller are met.
 
     Fail hard if any requirement is not met.
     """
     # Fail hard if Python does not have minimum required version
     if sys.version_info < (3, 3) and sys.version_info[:2] != (2, 7):
         raise SystemExit('PyInstaller requires at least Python 2.7 or 3.3+.')
-
-    if is_win:
-        if 'win32api' in sys.modules or 'pywintypes' in sys.modules:
-            # Users should never see this error; if it occurs, it means someone
-            # wasn't careful and added an import where it shouldn't be
-            # Unfortunately this error is triggered when running under pytest
-            # since all PyInstaller runs are done in the same process
-            logger.warning("Internal error: early pywin32 import was introduced")
-            return
-
-        try:
-            from PyInstaller.utils.win32 import winutils
-            try:
-                pywintypes = winutils.import_pywin32_module('pywintypes')
-            except ImportError:
-                from win32ctypes.pywin32 import pywintypes
-                from win32ctypes.pywin32 import win32api
-                
-                # if this succeeded, then install pywin32-ctypes into sys.modules
-                sys.modules['win32api'] = win32api
-                sys.modules['pywintypes'] = pywintypes
-
-        except ImportError:
-            raise SystemExit('PyInstaller cannot check for assembly dependencies.\n'
-                             'Please install PyWin32 or pywin32-ctypes.\n\n'
-                             'pip install pypiwin32\n')

PyInstaller/utils/win32/icon.py

@@ -21,6 +21,8 @@
 except AttributeError:
     StringTypes = [ type("") ]
 
+from ...compat import win32api
+
 import PyInstaller.log as logging
 logger = logging.getLogger(__name__)
 
@@ -112,7 +114,6 @@ def grp_icondir_entries(self, id=1):
 
 
 def CopyIcons_FromIco(dstpath, srcpath, id=1):
-    import win32api #, win32con
     icons = map(IconFile, srcpath)
     logger.info("Updating icons from %s to %s", srcpath, dstpath)
 
@@ -167,7 +168,7 @@ def splitter(s):
         logger.info("Updating icons from %s, %d to %s", srcpath, index, dstpath)
     else:
         logger.info("Updating icons from %s to %s", srcpath, dstpath)
-    import win32api #, win32con
+
     hdst = win32api.BeginUpdateResource(dstpath, 0)
     hsrc = win32api.LoadLibraryEx(srcpath, 0, LOAD_LIBRARY_AS_DATAFILE)
     if index is None:

PyInstaller/utils/win32/versioninfo.py

@@ -12,9 +12,8 @@
 import codecs
 import struct
 
-from ...compat import is_py3
+from ...compat import is_py3, win32api
 
-import win32api
 # ::TODO:: #1920 revert to using pypi version
 import pefile
 

PyInstaller/utils/win32/winresource.py

@@ -16,10 +16,7 @@
 Updates or adds resources from file <srcpath> in file <dstpath>.
 """
 
-
-import pywintypes
-import win32api
-
+from ...compat import pywintypes, win32api
 
 import PyInstaller.log as logging
 logger = logging.getLogger(__name__)

PyInstaller/utils/win32/winutils.py

@@ -17,8 +17,9 @@
 import os
 import sys
 
-from PyInstaller import compat
-from PyInstaller.compat import is_py3
+# Do not import 'compat' globally to avoid circual import:
+# import_pywin32_module() is used by compat
+#from ... import compat
 
 import PyInstaller.log as logging
 logger = logging.getLogger(__name__)
@@ -28,12 +29,9 @@ def get_windows_dir():
     """
     Return the Windows directory e.g. C:\\Windows.
     """
-    try:
-        import win32api
-    except ImportError:
-        windir = compat.getenv('SystemRoot', compat.getenv('WINDIR'))
-    else:
-        windir = win32api.GetWindowsDirectory()
+    # imported here to avoid circular import
+    from ... import compat
+    windir = compat.win32api.GetWindowsDirectory()
     if not windir:
         raise SystemExit("Error: Can not determine your Windows directory")
     return windir
@@ -43,12 +41,10 @@ def get_system_path():
     """
     Return the path that Windows will search for dlls.
     """
+    # imported here to avoid circular import
+    from ... import compat
     _bpath = []
-    try:
-        import win32api
-        sys_dir = win32api.GetSystemDirectory()
-    except ImportError:
-        sys_dir = os.path.normpath(os.path.join(get_windows_dir(), 'system32'))
+    sys_dir = compat.win32api.GetSystemDirectory()
     # Ensure C:\Windows\system32  and C:\Windows directories are
     # always present in PATH variable.
     # C:\Windows\system32 is valid even for 64bit Windows. Access do DLLs are
@@ -65,13 +61,15 @@ def extend_system_path(paths):
 
     Some hooks might extend PATH where PyInstaller should look for dlls.
     """
+    # imported here to avoid circular import
+    from ... import compat
     old_PATH = compat.getenv('PATH', '')
     paths.append(old_PATH)
     new_PATH = os.pathsep.join(paths)
     compat.setenv('PATH', new_PATH)
 
 
-def import_pywin32_module(module_name):
+def import_pywin32_module(module_name, _is_venv=None):
     """
     Import and return the PyWin32 module with the passed name.
 
@@ -87,6 +85,11 @@ def import_pywin32_module(module_name):
     ----------
     module_name : str
         Fully-qualified name of this module.
+    _is_venv: bool
+        Internal paramter used by compat.py, to prevent circular import. If None
+        (the default), compat is imported and comapt.is_venv ist used. If not
+        None, it is assumed to be called from compat and the value to be the same
+        as compat.is_venv.
 
     Returns
     ----------
@@ -112,9 +115,13 @@ def import_pywin32_module(module_name):
             # an ugly hack, but there is no other way.
             sys.frozen = '|_|GLYH@CK'
 
+            if _is_venv is None:  # not called from within compat
+                # imported here to avoid circular import
+                from ... import compat
+                _is_venv = compat.is_venv
             # If isolated to a venv, the preferred site.getsitepackages()
             # function is unreliable. Fallback to searching "sys.path" instead.
-            if compat.is_venv:
+            if _is_venv:
                 sys_paths = sys.path
             else:
                 import site
@@ -154,7 +161,9 @@ def convert_dll_name_to_str(dll_name):
     :param dll_name:
     :return:
     """
+    # imported here to avoid circular import
+    from ...compat import is_py3
     if is_py3 and isinstance(dll_name, bytes):
         return str(dll_name, encoding='UTF-8')
     else:
-        return dll_name
+        return dll_name

setup.py

@@ -13,6 +13,9 @@
 import codecs
 import sys, os
 from setuptools import setup
+
+# Hack required to allow compat to not fail when pypiwin32 isn't found
+os.environ["PYINSTALLER_NO_PYWIN32_FAILURE"] = "1"
 from PyInstaller import (__version__ as version, is_linux, is_win, is_cygwin,
                          HOMEPATH, PLATFORM, compat)