Nuitka-winsvc 1.8__cp311-cp311-win_amd64.whl → 2.5.1__cp311-cp311-win_amd64.whl

nuitka/freezer/Standalone.py

@@ -1,20 +1,6 @@
-#     Copyright 2023, Kay Hayen, mailto:kay.hayen@gmail.com
-#
-#     Part of "Nuitka", an optimizing Python compiler that is compatible and
-#     integrates with CPython, but also works on its own.
-#
-#     Licensed under the Apache License, Version 2.0 (the "License");
-#     you may not use this file except in compliance with the License.
-#     You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#     Unless required by applicable law or agreed to in writing, software
-#     distributed under the License is distributed on an "AS IS" BASIS,
-#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#     See the License for the specific language governing permissions and
-#     limitations under the License.
-#
+#     Copyright 2024, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+
+
 """ Pack and copy files for standalone mode.
 
 This is expected to work for macOS, Windows, and Linux. Other things like
@@ -26,7 +12,11 @@ import os
 
 from nuitka.containers.OrderedSets import OrderedSet
 from nuitka.Errors import NuitkaForbiddenDLLEncounter
-from nuitka.importing.Importing import getPythonUnpackedSearchPath
+from nuitka.importing.Importing import (
+    getPythonUnpackedSearchPath,
+    locateModule,
+)
+from nuitka.importing.StandardLibrary import isStandardLibraryPath
 from nuitka.Options import (
     isShowProgress,
     shallNotStoreDependsExeCachedResults,
@@ -38,6 +28,13 @@ from nuitka.Progress import (
     reportProgressBar,
     setupProgressBar,
 )
+from nuitka.PythonFlavors import (
+    getHomebrewInstallPath,
+    isAnacondaPython,
+    isHomebrewPython,
+    isMSYS2MingwPython,
+)
+from nuitka.PythonVersions import getSystemPrefixPath
 from nuitka.Tracing import general, inclusion_logger
 from nuitka.utils.FileOperations import areInSamePaths, isFilenameBelowPath
 from nuitka.utils.SharedLibraries import copyDllFile, setSharedLibraryRPATH
@@ -56,8 +53,12 @@ from .DllDependenciesMacOS import (
     fixupBinaryDLLPathsMacOS,
 )
 from .DllDependenciesPosix import detectBinaryPathDLLsPosix
-from .DllDependenciesWin32 import detectBinaryPathDLLsWindowsDependencyWalker
-from .IncludedEntryPoints import addIncludedEntryPoint, makeDllEntryPoint
+from .DllDependenciesWin32 import detectBinaryPathDLLsWin32
+from .IncludedEntryPoints import (
+    addIncludedEntryPoint,
+    getIncludedExtensionModule,
+    makeDllEntryPoint,
+)
 
 
 def checkFreezingModuleSet():
@@ -115,6 +116,7 @@ def _detectBinaryDLLs(
     original_filename,
     binary_filename,
     package_name,
+    use_path,
     use_cache,
     update_cache,
 ):
@@ -135,12 +137,13 @@ def _detectBinaryDLLs(
             message="Running 'depends.exe' for %s took %%.2f seconds" % binary_filename,
             decider=isShowProgress,
         ):
-            return detectBinaryPathDLLsWindowsDependencyWalker(
+            return detectBinaryPathDLLsWin32(
                 is_main_executable=is_main_executable,
                 source_dir=source_dir,
                 original_dir=os.path.dirname(original_filename),
                 binary_filename=binary_filename,
                 package_name=package_name,
+                use_path=use_path,
                 use_cache=use_cache,
                 update_cache=update_cache,
             )
@@ -227,70 +230,164 @@ def copyDllsUsed(dist_dir, standalone_entry_points):
     )
 
 
+_excluded_system_dlls = set()
+
+
+def _reduceToPythonPath(used_dll_paths):
+    """Remove DLLs outside of python path."""
+    inside_paths = getPythonUnpackedSearchPath()
+
+    if isAnacondaPython():
+        inside_paths.insert(0, getSystemPrefixPath())
+
+    if isHomebrewPython():
+        inside_paths.insert(0, getHomebrewInstallPath())
+
+    if isMSYS2MingwPython():
+        inside_paths.insert(0, os.path.join(getSystemPrefixPath(), "bin"))
+
+    def decideInside(dll_filename):
+        return any(
+            isFilenameBelowPath(path=inside_path, filename=dll_filename)
+            for inside_path in inside_paths
+        )
+
+    kept_used_dll_paths = OrderedSet()
+    removed_dll_paths = OrderedSet()
+
+    for dll_filename in used_dll_paths:
+        if decideInside(dll_filename):
+            kept_used_dll_paths.add(dll_filename)
+        else:
+            if dll_filename not in _excluded_system_dlls:
+                _excluded_system_dlls.add(dll_filename)
+                inclusion_logger.info("Not including system DLL '%s'" % dll_filename)
+
+            removed_dll_paths.add(dll_filename)
+
+    return kept_used_dll_paths, removed_dll_paths
+
+
+_removed_dll_usages = {}
+
+
+def getRemovedUsedDllsInfo():
+    return _removed_dll_usages.items()
+
+
 def _detectUsedDLLs(standalone_entry_point, source_dir):
+    # TODO: We are handling a bunch of cases here, but also some special cases,
+    # that should live elsewhere.
+    # pylint: disable=too-many-branches,too-many-locals
+
+    if standalone_entry_point.module_name is not None:
+        module_name, module_filename, _kind, finding = locateModule(
+            standalone_entry_point.module_name, parent_package=None, level=0
+        )
+
+        # TODO: How can this be None at all.
+        if module_filename is not None and isStandardLibraryPath(module_filename):
+            allow_outside_dependencies = True
+        else:
+            allow_outside_dependencies = Plugins.decideAllowOutsideDependencies(
+                standalone_entry_point.module_name
+            )
+    else:
+        allow_outside_dependencies = False
+
     binary_filename = standalone_entry_point.source_path
     try:
-        used_dlls = _detectBinaryDLLs(
+        used_dll_paths = _detectBinaryDLLs(
             is_main_executable=standalone_entry_point.kind == "executable",
             source_dir=source_dir,
             original_filename=standalone_entry_point.source_path,
-            binary_filename=standalone_entry_point.source_path,
+            binary_filename=binary_filename,
             package_name=standalone_entry_point.package_name,
+            use_path=allow_outside_dependencies,
             use_cache=not shallNotUseDependsExeCachedResults(),
             update_cache=not shallNotStoreDependsExeCachedResults(),
         )
     except NuitkaForbiddenDLLEncounter:
-        inclusion_logger.info("Not including forbidden DLL '%s'." % binary_filename)
+        inclusion_logger.info(
+            "Not including due to forbidden DLL '%s'." % binary_filename
+        )
+    except (RuntimeError, Exception) as e:
+        inclusion_logger.warning(
+            """\
+Error, cannot detect used DLLs for DLL '%s' in package '%s' due to: %s"""
+            % (binary_filename, standalone_entry_point.package_name, str(e))
+        )
+
+        raise
     else:
         # Plugins generally decide if they allow dependencies from the outside
         # based on the package name.
-        allow_outside_dependencies = Plugins.decideAllowOutsideDependencies(
-            standalone_entry_point.package_name
-        )
 
-        # TODO: Command line option maybe
-        if allow_outside_dependencies is None:
-            allow_outside_dependencies = True
+        if standalone_entry_point.module_name is not None and used_dll_paths:
+            module_name, module_filename, _kind, finding = locateModule(
+                standalone_entry_point.module_name, parent_package=None, level=0
+            )
 
-        if not allow_outside_dependencies:
-            inside_paths = getPythonUnpackedSearchPath()
+            # Make sure we are not surprised here.
+            assert (
+                module_name == standalone_entry_point.module_name
+            ), standalone_entry_point.module_name
+            assert finding == "absolute", standalone_entry_point.module_name
 
-            def decideInside(dll_filename):
-                return any(
-                    isFilenameBelowPath(path=inside_path, filename=dll_filename)
-                    for inside_path in inside_paths
-                )
+            if not allow_outside_dependencies:
+                used_dll_paths, removed_dll_paths = _reduceToPythonPath(used_dll_paths)
 
-            used_dlls = set(
-                dll_filename for dll_filename in used_dlls if decideInside(dll_filename)
-            )
+                if removed_dll_paths:
+                    _removed_dll_usages[standalone_entry_point] = (
+                        "no outside dependencies allowed for '%s'"
+                        % standalone_entry_point.module_name,
+                        removed_dll_paths,
+                    )
+
+        # Lets be sure of this
+        assert type(used_dll_paths) is OrderedSet, type(used_dll_paths)
 
-        # Allow plugins can prevent inclusion, this may discard things from used_dlls.
+        # Allow plugins can prevent inclusion, this may discard things from
+        # used_dlls through its return value.
         removed_dlls = Plugins.removeDllDependencies(
-            dll_filename=binary_filename, dll_filenames=used_dlls
+            dll_filename=binary_filename, dll_filenames=OrderedSet(used_dll_paths)
         )
-        used_dlls = tuple(OrderedSet(used_dlls) - OrderedSet(removed_dlls))
-
-        for used_dll in used_dlls:
-            # TODO: If used by a DLL from the same folder, put it there,
-            # otherwise top level, but for now this is limited to the case where
-            # it is required that way only, because it broke other things.
-            if standalone_entry_point.package_name == "openvino" and areInSamePaths(
-                standalone_entry_point.source_path, used_dll
+        used_dll_paths = used_dll_paths - removed_dlls
+
+        for used_dll_path in used_dll_paths:
+            extension_standalone_entry_point = getIncludedExtensionModule(used_dll_path)
+            if extension_standalone_entry_point is not None:
+                # Sometimes an extension module is used like a DLL, make sure to
+                # remove it as a DLL then, there is no value in keeping those. Need
+                # to keep it's destination path from that extension module then.
+                dest_path = extension_standalone_entry_point.dest_path
+            elif (
+                standalone_entry_point.package_name is not None
+                and standalone_entry_point.package_name.hasOneOfNamespaces(
+                    "openvino",
+                    "av",
+                )
+                and areInSamePaths(binary_filename, used_dll_path)
             ):
+                # TODO: If used by a DLL from the same folder, put it there,
+                # otherwise top level, but for now this is limited to a few cases
+                # where required that way (openvino) or known to be good only (av),
+                # because it broke other things. spell-checker: ignore openvino
+
                 dest_path = os.path.normpath(
                     os.path.join(
                         os.path.dirname(standalone_entry_point.dest_path),
-                        os.path.basename(used_dll),
+                        os.path.basename(used_dll_path),
                     )
                 )
             else:
-                dest_path = os.path.basename(used_dll)
+                dest_path = os.path.basename(used_dll_path)
 
             dll_entry_point = makeDllEntryPoint(
                 logger=inclusion_logger,
-                source_path=used_dll,
+                source_path=used_dll_path,
                 dest_path=dest_path,
+                module_name=standalone_entry_point.module_name,
                 package_name=standalone_entry_point.package_name,
                 reason="Used by '%s'" % standalone_entry_point.dest_path,
             )
@@ -313,3 +410,19 @@ def detectUsedDLLs(standalone_entry_points, source_dir):
         )
 
     closeProgressBar()
+
+
+#     Part of "Nuitka", an optimizing Python compiler that is compatible and
+#     integrates with CPython, but also works on its own.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.

nuitka/freezer/__init__.py

@@ -1,5 +1,8 @@
-#     Copyright 2023, Kay Hayen, mailto:kay.hayen@gmail.com
-#
+#     Copyright 2024, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+
+
+""" Dummy file to make this directory a package. """
+
 #     Part of "Nuitka", an optimizing Python compiler that is compatible and
 #     integrates with CPython, but also works on its own.
 #
@@ -14,5 +17,3 @@
 #     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #     See the License for the specific language governing permissions and
 #     limitations under the License.
-#
-""" Dummy file to make this directory a package. """

nuitka/importing/IgnoreListing.py

@@ -1,20 +1,6 @@
-#     Copyright 2023, Kay Hayen, mailto:kay.hayen@gmail.com
-#
-#     Part of "Nuitka", an optimizing Python compiler that is compatible and
-#     integrates with CPython, but also works on its own.
-#
-#     Licensed under the Apache License, Version 2.0 (the "License");
-#     you may not use this file except in compliance with the License.
-#     You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#     Unless required by applicable law or agreed to in writing, software
-#     distributed under the License is distributed on an "AS IS" BASIS,
-#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#     See the License for the specific language governing permissions and
-#     limitations under the License.
-#
+#     Copyright 2024, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+
+
 """ Ignore listing of modules that are not found, but probably that's acceptable.
 
 """
@@ -445,3 +431,19 @@ please report this as a bug."""
         )
 
     return module_name.hasOneOfNamespaces(getModuleIgnoreList())
+
+
+#     Part of "Nuitka", an optimizing Python compiler that is compatible and
+#     integrates with CPython, but also works on its own.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.

nuitka/importing/ImportCache.py

@@ -1,20 +1,6 @@
-#     Copyright 2023, Kay Hayen, mailto:kay.hayen@gmail.com
-#
-#     Part of "Nuitka", an optimizing Python compiler that is compatible and
-#     integrates with CPython, but also works on its own.
-#
-#     Licensed under the Apache License, Version 2.0 (the "License");
-#     you may not use this file except in compliance with the License.
-#     You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#     Unless required by applicable law or agreed to in writing, software
-#     distributed under the License is distributed on an "AS IS" BASIS,
-#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#     See the License for the specific language governing permissions and
-#     limitations under the License.
-#
+#     Copyright 2024, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+
+
 """ Import cache.
 
 This is not about caching the search of modules in the file system, but about
@@ -28,6 +14,7 @@ not start anew, but reuse what we already found out about it.
 import os
 
 from nuitka.plugins.Plugins import Plugins
+from nuitka.utils.Importing import hasPackageDirFilename
 
 imported_modules = {}
 imported_by_name = {}
@@ -36,7 +23,7 @@ imported_by_name = {}
 def addImportedModule(imported_module):
     module_filename = os.path.abspath(imported_module.getFilename())
 
-    if os.path.basename(module_filename) == "__init__.py":
+    if hasPackageDirFilename(module_filename):
         module_filename = os.path.dirname(module_filename)
 
     key = (module_filename, imported_module.getFullName())
@@ -69,7 +56,7 @@ def getImportedModuleByNameAndPath(full_name, module_filename):
     # For caching we use absolute paths only.
     module_filename = os.path.abspath(module_filename)
 
-    if os.path.basename(module_filename) == "__init__.py":
+    if hasPackageDirFilename(module_filename):
         module_filename = os.path.dirname(module_filename)
 
     # KeyError is valid result.
@@ -82,11 +69,27 @@ def replaceImportedModule(old, new):
             imported_by_name[key] = new
             break
     else:
-        assert False
+        assert False, (old, new)
 
     for key, value in imported_modules.items():
         if value == old:
             imported_modules[key] = new
             break
     else:
-        assert False
+        assert False, (old, new)
+
+
+#     Part of "Nuitka", an optimizing Python compiler that is compatible and
+#     integrates with CPython, but also works on its own.
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+#     you may not use this file except in compliance with the License.
+#     You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#     Unless required by applicable law or agreed to in writing, software
+#     distributed under the License is distributed on an "AS IS" BASIS,
+#     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#     See the License for the specific language governing permissions and
+#     limitations under the License.