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

nuitka/OptionParsing.py

@@ -1,4 +1,4 @@
-#     Copyright 2024, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+#     Copyright 2025, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
 
 
 """ Command line options of Nuitka.
@@ -43,10 +43,33 @@ if _nuitka_binary_name == "__main__.py":
 is_nuitka_run = _nuitka_binary_name.lower().endswith("-run")
 
 if not is_nuitka_run:
-    usage_template = "usage: %s [--module] [--run] [options] main_module.py"
+    usage_template = (
+        "usage: %s [--mode=compilation_mode] [--run] [options] main_module.py"
+    )
 else:
-    usage_template = "usage: %s [options] main_module.py"
+    usage_template = "usage: %s [--mode=compilation_mode] [options] main_module.py"
+
+
+def _handleHelpModes():
+    result = False
+    for count, arg in enumerate(sys.argv[1:], start=1):
+        if arg == "--":
+            break
+        if arg in ("--help-all", "--help-plugin", "--help-plugins"):
+            result = True
+            sys.argv[count] = "--help"
+            break
+    return result
+
 
+plugin_help_mode = _handleHelpModes()
+
+
+if not plugin_help_mode:
+    usage_template += """\n
+    Note: For general plugin help (they often have their own
+    command line options too), consider the output of
+    '--help-plugins'."""
 
 parser = makeOptionsParser(usage=usage_template % _nuitka_binary_name)
 
@@ -65,6 +88,7 @@ parser.add_option(
     action="store_true",
     dest="module_mode",
     default=False,
+    github_action=False,
     help="""\
 Create an importable binary extension module executable instead of a program. Defaults to off.""",
 )
@@ -74,13 +98,17 @@ parser.add_option(
     action="store",
     dest="compilation_mode",
     metavar="COMPILATION_MODE",
-    choices=("onefile", "standalone", "accelerated", "module"),
+    choices=("app", "onefile", "standalone", "accelerated", "module", "package"),
     default=None,
+    github_action_default="app",
     help="""\
 Mode in which to compile. Accelerated runs in your Python
 installation and depends on it. Standalone creates a folder
 with an executable contained to run it. Onefile creates a
-single executable to deploy. Default is 'accelerated'.""",
+single executable to deploy. App is onefile except on macOS
+where it's not to be used. Module makes a module, and
+package includes also all sub-modules and sub-packages.
+Default is 'accelerated'.""",
 )
 
 parser.add_option(
@@ -88,6 +116,7 @@ parser.add_option(
     action="store_true",
     dest="is_standalone",
     default=False,
+    github_action=False,
     help="""\
 Enable standalone mode for output. This allows you to transfer the created binary
 to other machines without it using an existing Python installation. This also
@@ -109,7 +138,7 @@ parser.add_option(
     action="store_true",
     dest="is_onefile",
     default=False,
-    github_action_default=True,
+    github_action=False,
     help="""\
 On top of standalone mode, enable onefile mode. This means not a folder,
 but a compressed executable is created and used. Defaults to off.""",
@@ -399,13 +428,14 @@ This will only include non-DLL, non-extension modules, i.e. actual data
 files. After a ":" optionally a filename pattern can be given as
 well, selecting only matching files. Examples:
 "--include-package-data=package_name" (all files)
-"--include-package-data=package_name=*.txt" (only certain type)
-"--include-package-data=package_name=some_filename.dat (concrete file)
+"--include-package-data=package_name:*.txt" (only certain type)
+"--include-package-data=package_name:some_filename.dat (concrete file)
 Default empty.""",
 )
 
 data_group.add_option(
     "--include-data-files",
+    "--include-data-file",
     action="append",
     dest="data_files",
     metavar="DESC",
@@ -449,6 +479,7 @@ whole directory simply use 'package_name'. Default empty.""",
 
 data_group.add_option(
     "--include-onefile-external-data",
+    "--include-data-files-external",
     action="append",
     dest="data_files_external",
     metavar="PATTERN",
@@ -530,6 +561,17 @@ dll_group.add_option(
 Output the DLLs found for a given package name. Default not done.""",
 )
 
+dll_group.add_option(
+    "--list-package-exe",
+    action="store",
+    dest="list_package_exe",
+    default="",
+    require_compiling=False,
+    help="""\
+Output the EXEs found for a given package name. Default not done.""",
+)
+
+
 del dll_group
 
 warnings_group = parser.add_option_group("Control the warnings to be given by Nuitka")
@@ -602,8 +644,9 @@ execute_group.add_option(
     dest="debugger",
     default=False,
     help="""\
-Execute inside a debugger, e.g. "gdb" or "lldb" to automatically get a stack trace.
-Defaults to off.""",
+Execute inside a debugger, e.g. "gdb" or "lldb" to automatically get a stack trace. The
+debugger is automatically chosen unless specified by name with the NUITKA_DEBUGGER_CHOICE
+environment variable. Defaults to off.""",
 )
 
 del execute_group
@@ -641,7 +684,7 @@ compilation_group.add_option(
     "--file-reference-choice",
     action="store",
     dest="file_reference_mode",
-    metavar="MODE",
+    metavar="FILE_MODE",
     choices=("original", "runtime", "frozen"),
     default=None,
     help="""\
@@ -660,7 +703,7 @@ compilation_group.add_option(
     "--module-name-choice",
     action="store",
     dest="module_name_mode",
-    metavar="MODE",
+    metavar="MODULE_NAME_MODE",
     choices=("original", "runtime"),
     default=None,
     help="""\
@@ -961,6 +1004,15 @@ Create graph of optimization process internals, do not use for whole programs, b
 for small test cases. Defaults to off.""",
 )
 
+development_group.add_option(
+    "--devel-generate-ming64-header",
+    action="store_true",
+    dest="generate_mingw64_header",
+    default=False,
+    require_compiling=False,
+    github_action=False,
+    help=SUPPRESS_HELP,
+)
 
 del development_group
 
@@ -1003,7 +1055,7 @@ c_compiler_group.add_option(
     "--mingw64",
     action="store_true",
     dest="mingw64",
-    default=False,
+    default=None,
     help="""\
 Enforce the use of MinGW64 on Windows. Defaults to off unless MSYS2 with MinGW Python is used.""",
 )
@@ -1564,7 +1616,8 @@ macos_group.add_option(
     "--macos-create-app-bundle",
     action="store_true",
     dest="macos_create_bundle",
-    default=False,
+    default=None,
+    github_action=False,
     help="""\
 When compiling for macOS, create a bundle rather than a plain binary
 application. This is the only way to unlock the disabling of console,
@@ -1622,9 +1675,9 @@ macos_group.add_option(
     "--macos-app-mode",
     action="store",
     dest="macos_app_mode",
-    metavar="MODE",
+    metavar="APP_MODE",
     choices=("gui", "background", "ui-element"),
-    default="gui",
+    default=None,
     help="""\
 Mode of application for the application bundle. When launching a Window, and appearing
 in Docker is desired, default value "gui" is a good fit. Without a Window ever, the
@@ -1638,7 +1691,7 @@ macos_group.add_option(
     action="store",
     dest="macos_sign_identity",
     metavar="MACOS_APP_VERSION",
-    default="ad-hoc",
+    default=None,
     help="""\
 When signing on macOS, by default an ad-hoc identify will be used, but with this
 option your get to specify another identity to use. The signing of code is now
@@ -1650,7 +1703,7 @@ macos_group.add_option(
     "--macos-sign-notarization",
     action="store_true",
     dest="macos_sign_notarization",
-    default=False,
+    default=None,
     help="""\
 When signing for notarization, using a proper TeamID identity from Apple, use
 the required runtime signing option, such that it can be accepted.""",
@@ -1899,7 +1952,9 @@ def _considerPluginOptions(logger):
         addUserPluginCommandLineOptions,
     )
 
-    addStandardPluginCommandLineOptions(parser=parser)
+    addStandardPluginCommandLineOptions(
+        parser=parser, plugin_help_mode=plugin_help_mode
+    )
 
     for arg in sys.argv[1:]:
         if arg.startswith(
@@ -1915,6 +1970,7 @@ def _considerPluginOptions(logger):
             addPluginCommandLineOptions(
                 parser=parser,
                 plugin_names=plugin_names.split(","),
+                plugin_help_mode=plugin_help_mode,
             )
 
         if arg.startswith("--user-plugin="):
@@ -2221,7 +2277,7 @@ def parseOptions(logger):
         if arg.startswith(("--main=", "--script-name=")):
             filename_args.append(arg.split("=", 1)[1])
 
-        if arg == "--module":
+        if arg in ("--mode=module", "--mode=module", "--module=package"):
             module_mode = True
 
         if arg[0] != "-":
@@ -2280,6 +2336,12 @@ def runSpecialCommandsFromOptions(options):
         displayDLLs(options.list_package_dlls)
         sys.exit(0)
 
+    if options.list_package_exe:
+        from nuitka.tools.scanning.DisplayPackageDLLs import displayEXEs
+
+        displayEXEs(options.list_package_exe)
+        sys.exit(0)
+
     if options.list_package_data:
         from nuitka.tools.scanning.DisplayPackageData import displayPackageData
 
@@ -2307,6 +2369,14 @@ def runSpecialCommandsFromOptions(options):
         )
         sys.exit(0)
 
+    if options.generate_mingw64_header:
+        from nuitka.tools.general.generate_header.GenerateHeader import (
+            generateHeader,
+        )
+
+        generateHeader()
+        sys.exit(0)
+
 
 #     Part of "Nuitka", an optimizing Python compiler that is compatible and
 #     integrates with CPython, but also works on its own.

nuitka/Options.py

@@ -1,4 +1,4 @@
-#     Copyright 2024, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+#     Copyright 2025, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
 
 
 """ Options module
@@ -51,12 +51,14 @@ from nuitka.PythonVersions import (
     getSupportedPythonVersions,
     isDebugPython,
     isPythonWithGil,
+    isStaticallyLinkedPython,
     python_version,
     python_version_str,
 )
 from nuitka.utils.Execution import getExecutablePath
 from nuitka.utils.FileOperations import (
     getNormalizedPath,
+    getReportPath,
     isLegalPath,
     isPathExecutable,
     openTextFile,
@@ -229,12 +231,12 @@ Absolute run time paths of '%s' can only be at the start of \
 
         if candidate == value:
             Tracing.options_logger.sysexit(
-                """Cannot use general system folder %s, may only be the \
+                """Cannot use folder %s, may only be the \
 start of '%s=%s', using that alone is not allowed."""
                 % (candidate, arg_name, value)
             )
 
-        if value.startswith(candidate):
+        if value.startswith(candidate) and candidate != "{PROGRAM_BASE}":
             if value[len(candidate)] != os.path.sep:
                 Tracing.options_logger.sysexit(
                     """Cannot use general system folder %s, without a path \
@@ -296,15 +298,13 @@ it with e.g. '{TEMP}', '{CACHE_DIR}' is recommended: '%s'"""
 
 
 def _getVersionInformationValues():
-    # TODO: Might be nice if we could delay version information computation
-    # until it's actually used.
     yield getNuitkaVersion()
     yield "Commercial: %s" % getCommercialVersion()
     yield "Python: %s" % sys.version.split("\n", 1)[0]
     yield "Flavor: %s" % getPythonFlavorName()
     if python_version >= 0x3D0:
         yield "GIL: %s" % ("yes" if isPythonWithGil() else "no")
-    yield "Executable: %s" % sys.executable
+    yield "Executable: %s" % getReportPath(sys.executable)
     yield "OS: %s" % getOS()
     yield "Arch: %s" % getArchitecture()
 
@@ -332,15 +332,15 @@ def printVersionInformation():
 
     from nuitka.build.SconsInterface import (
         asBoolStr,
+        getCommonSconsOptions,
         runScons,
-        setCommonSconsOptions,
     )
 
-    scons_options = {"compiler_version_mode": asBoolStr("true")}
-    env_values = setCommonSconsOptions(options=scons_options)
+    scons_options, env_values = getCommonSconsOptions()
+    scons_options["compiler_version_mode"] = asBoolStr("true")
 
     runScons(
-        options=scons_options,
+        scons_options=scons_options,
         env_values=env_values,
         scons_filename="CCompilerVersion.scons",
     )
@@ -348,12 +348,36 @@ def printVersionInformation():
 
 def _warnOnefileOnlyOption(option_name):
     if not options.is_onefile:
-        Tracing.options_logger.warning(
-            """\
-Using onefile specific option '%s' has no effect \
-when '--onefile' is not specified."""
-            % option_name
-        )
+        if options.github_workflow_options and isMacOS() and shallCreateAppBundle():
+            Tracing.options_logger.info(
+                """\
+Note: Using onefile mode specific option '%s' has no effect \
+with macOS app bundles."""
+                % option_name
+            )
+        else:
+            Tracing.options_logger.warning(
+                """\
+Using onefile mode specific option '%s' has no effect \
+when '--mode=onefile' is not specified."""
+                % option_name
+            )
+
+
+def _warnOSSpecificOption(option_name, *supported_os):
+    if getOS() not in supported_os:
+        if options.github_workflow_options:
+            Tracing.options_logger.info(
+                """\
+Note: Using OS specific option '%s' has no effect on %s."""
+                % (option_name, getOS())
+            )
+        else:
+            Tracing.options_logger.warning(
+                """\
+Using OS specific option '%s' has no effect on %s."""
+                % (option_name, getOS())
+            )
 
 
 def _checkDataDirOptionValue(data_dir, option_name):
@@ -494,7 +518,12 @@ Error, the Python from Windows app store is not supported.""",
     Tracing.progress_logger.is_quiet = not options.show_progress
 
     if options.compilation_mode is not None:
-        if options.is_onefile or options.is_standalone or options.module_mode:
+        if (
+            options.is_onefile
+            or options.is_standalone
+            or options.module_mode
+            or options.macos_create_bundle
+        ):
             Tracing.options_logger.sysexit(
                 "Cannot use both '--mode=' and deprecated options that specify mode."
             )
@@ -505,6 +534,13 @@ Error, the Python from Windows app store is not supported.""",
             options.is_standalone = True
         elif options.compilation_mode == "module":
             options.module_mode = True
+        elif options.compilation_mode == "package":
+            options.module_mode = True
+        elif options.compilation_mode == "app":
+            if isMacOS():
+                options.macos_create_bundle = True
+            else:
+                options.is_onefile = True
 
     # Onefile implies standalone build.
     if options.is_onefile:
@@ -1019,24 +1055,40 @@ and recommended only for use in Nuitka development and testing."""
             % default_mode_name_mode
         )
 
-    # TODO: Not all of these are usable with MSYS2 really, split those off.
-    if not isWin32OrPosixWindows():
-        # Too many Windows specific options clearly
-        if (
-            getWindowsIconExecutablePath()
-            or shallAskForWindowsAdminRights()
-            or shallAskForWindowsUIAccessRights()
-            or getWindowsSplashScreen()
-            or isWindowsServiceMode()
-        ):
-            Tracing.options_logger.warning(
-                "Using Windows specific options has no effect on other platforms."
-            )
-
-        if options.mingw64 or options.msvc_version:
-            Tracing.options_logger.warning(
-                "Requesting Windows specific compilers has no effect on other platforms."
-            )
+    # TODO: This could be done via a generic option attribute and iterating over
+    # them all, but maybe that's too inflexible long term.
+    if getWindowsIconExecutablePath():
+        _warnOSSpecificOption("--windows-icon-from-exe", "Windows")
+    if shallAskForWindowsAdminRights():
+        _warnOSSpecificOption("--windows-uac-admin", "Windows")
+    if shallAskForWindowsUIAccessRights():
+        _warnOSSpecificOption("--windows-uac-uiaccess", "Windows")
+    if getWindowsSplashScreen():
+        _warnOSSpecificOption("--onefile-windows-splash-screen-image", "Windows")
+    if isWindowsServiceMode():
+        _warnOSSpecificOption("--windows-service", "Windows")
+    if options.mingw64 is not None:
+        _warnOSSpecificOption("--mingw64", "Windows")
+    if options.msvc_version is not None:
+        _warnOSSpecificOption("--msvc", "Windows")
+    if options.macos_target_arch is not None:
+        _warnOSSpecificOption("--macos-target-arch", "Darwin")
+    if options.macos_create_bundle is not None:
+        _warnOSSpecificOption("--macos-create-app-bundle", "Darwin")
+    if options.macos_sign_identity is not None:
+        _warnOSSpecificOption("--macos-sign-identity", "Darwin")
+    if options.macos_sign_notarization is not None:
+        _warnOSSpecificOption("--macos-sign-notarization", "Darwin")
+    if getMacOSAppName():
+        _warnOSSpecificOption("--macos-app-name", "Darwin")
+    if getMacOSSignedAppName():
+        _warnOSSpecificOption("--macos-signed-app-name", "Darwin")
+    if getMacOSAppVersion():
+        _warnOSSpecificOption("--macos-app-version", "Darwin")
+    if getMacOSAppProtectedResourcesAccesses():
+        _warnOSSpecificOption("--macos-app-protected-resource", "Darwin")
+    if options.macos_app_mode is not None:
+        _warnOSSpecificOption("--macos-app-mode", "Darwin")
 
     if options.msvc_version:
         if isMSYS2MingwPython() or isPosixWindows():
@@ -1052,7 +1104,7 @@ and recommended only for use in Nuitka development and testing."""
             x.isdigit() for x in getMsvcVersion().split(".")
         ):
             Tracing.options_logger.sysexit(
-                "For --msvc only values 'latest', 'info', and 'X.Y' values are allowed, but not '%s'."
+                "For '--msvc' only values 'latest', 'info', and 'X.Y' values are allowed, but not '%s'."
                 % getMsvcVersion()
             )
 
@@ -1200,11 +1252,12 @@ and not with the non-debug version.
 """
         )
 
-    if isMacOS() and shallCreateAppBundle() and not getMacOSIconPaths():
-        Tracing.general.warning(
+    if isMacOS() and shallCreateAppBundle() and not options.macos_icon_path:
+        Tracing.options_logger.warning(
             """\
 For application bundles, you ought to specify an icon with '--macos-app-icon'.", \
-otherwise a dock icon may not be present."""
+otherwise a dock icon may not be present. Specify 'none' value to disable \
+this warning."""
         )
 
     if (
@@ -1278,6 +1331,18 @@ have any effect anymore on non-Windows."""
                 )
             )
 
+    if (
+        isWin32Windows()
+        and getWindowsVersionInfoStrings()
+        and getProductFileVersion() is None
+    ):
+        Tracing.options_logger.sysexit(
+            """\
+Error, when providing version information on Windows, you must also
+provide either '--product-version' or '--file-version' as these can
+not have good defaults, but are forced to be present by the OS."""
+        )
+
 
 def isVerbose():
     """:returns: bool derived from ``--verbose``"""
@@ -1336,10 +1401,15 @@ def getModuleNameMode():
 
 
 def shallMakeModule():
-    """:returns: bool derived from ``--module``"""
+    """:returns: bool derived from ``--mode=module|package``."""
     return options is not None and options.module_mode
 
 
+def shallMakePackage():
+    """:returns: bool derived from ``--mode=package``."""
+    return options is not None and options.compilation_mode == "package"
+
+
 def shallCreatePyiFile():
     """*bool* = **not** ``--no-pyi-file``"""
     return options.pyi_file
@@ -1407,12 +1477,14 @@ def getShallFollowExtraFilePatterns():
 
 def getMustIncludeModules():
     """*list*, items of ``--include-module=``"""
-    return sum([_splitShellPattern(x) for x in options.include_modules], [])
+    return OrderedSet(sum([_splitShellPattern(x) for x in options.include_modules], []))
 
 
 def getMustIncludePackages():
     """*list*, items of ``--include-package=``"""
-    return sum([_splitShellPattern(x) for x in options.include_packages], [])
+    return OrderedSet(
+        sum([_splitShellPattern(x) for x in options.include_packages], [])
+    )
 
 
 def getShallIncludeDistributionMetadata():
@@ -1483,7 +1555,7 @@ def getShallNotIncludeDataFilePatterns():
 
 
 def getShallIncludeExternallyDataFilePatterns():
-    """*list*, items of ``--include-onefile-external-data=``"""
+    """*list*, items of ``--include-data-files-external=``"""
 
     return options.data_files_external
 
@@ -1557,7 +1629,7 @@ def getOutputFilename():
 def getOutputPath(path):
     """Return output pathname of a given path (filename)."""
     if options.output_dir:
-        return os.path.normpath(os.path.join(options.output_dir, path))
+        return getNormalizedPath(os.path.join(options.output_dir, path))
     else:
         return path
 
@@ -1677,6 +1749,11 @@ added to provide the static link library.""",
         if isArchPackagePython():
             return True, None
 
+        # If not dynamic link library is available, the static link library will
+        # have to do it.
+        if isStaticallyLinkedPython():
+            return True, None
+
     return options.static_libpython == "yes", None
 
 
@@ -1726,13 +1803,15 @@ def shallTreatUninstalledPython():
     return isUninstalledPython()
 
 
-def shallCreateCmdFileForExecution():
+def shallCreateScriptFileForExecution():
     """*bool* = derived from Python installation and modes
 
-    Notes: Mostly for accelerated mode on Windows with uninstalled python, to
-    make sure they find their Python DLL.
+    Notes: Mostly for accelerated mode with uninstalled python, to make sure
+    they find their Python DLL and Python packages.
     """
-    return isWin32Windows() and shallTreatUninstalledPython()
+
+    # TODO: Are we having a need for both names really?
+    return shallTreatUninstalledPython()
 
 
 def isShowScons():
@@ -1779,7 +1858,7 @@ def isClang():
 def isMingw64():
     """:returns: bool derived from ``--mingw64``, available only on Windows, otherwise false"""
     if isWin32Windows():
-        return options.mingw64 or isMSYS2MingwPython()
+        return bool(options.mingw64 or isMSYS2MingwPython())
     else:
         return None
 
@@ -1938,7 +2017,7 @@ def isOnefileMode():
 
 
 def isAcceleratedMode():
-    """:returns: bool derived from ``--standalone`` and `--module`"""
+    """:returns: bool derived from ``--mode=accelerated``"""
     return not isStandaloneMode() and not shallMakeModule()
 
 
@@ -2076,7 +2155,11 @@ def getLinuxIconPaths():
 
 def getMacOSIconPaths():
     """*list of str*, values of ``--macos-app-icon``"""
-    return _checkIconPaths(options.macos_icon_path)
+    return tuple(
+        _checkIconPaths(
+            icon_path for icon_path in options.macos_icon_path if icon_path != "none"
+        )
+    )
 
 
 def getWindowsIconExecutablePath():
@@ -2250,6 +2333,9 @@ def getMacOSSigningIdentity():
     """*str* value to use as identity for codesign, derived from ``--macos-sign-identity`` value"""
     result = options.macos_sign_identity
 
+    if result is None:
+        result = "ad-hoc"
+
     if result == "ad-hoc":
         result = "-"
 
@@ -2258,7 +2344,7 @@ def getMacOSSigningIdentity():
 
 def shallUseSigningForNotarization():
     """*bool* flag to use for codesign, derived from ``--macos-sign-notarization`` value"""
-    return options.macos_sign_notarization
+    return bool(options.macos_sign_notarization)
 
 
 def getMacOSAppName():
@@ -2278,8 +2364,12 @@ def getMacOSAppVersion():
 
 def getMacOSAppProtectedResourcesAccesses():
     """*list* key, value for protected resources of the app to use for bundle"""
+    result = []
+
     for macos_protected_resource in options.macos_protected_resources:
-        yield macos_protected_resource.split(":", 1)
+        result.append(macos_protected_resource.split(":", 1))
+
+    return result
 
 
 def isMacOSBackgroundApp():
@@ -2670,6 +2760,23 @@ def getForcedRuntimeEnvironmentVariableValues():
         yield (name, value)
 
 
+def getCompilationMode():
+    """For reporting only, use shorter specific tests."""
+
+    if isAcceleratedMode():
+        return "accelerated"
+    elif shallMakeModule():
+        return "module"
+    elif shallMakePackage():
+        return "package"
+    elif shallCreateAppBundle():
+        return "app"
+    elif isOnefileMode():
+        return "onefile"
+    elif isStandaloneMode():
+        return "standalone"
+
+
 #     Part of "Nuitka", an optimizing Python compiler that is compatible and
 #     integrates with CPython, but also works on its own.
 #