Nuitka-winsvc 2.7.7__cp313-cp313-win_amd64.whl

nuitka/utils/Yaml.py

@@ -0,0 +1,247 @@
+#     Copyright 2025, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+
+
+""" Nuitka yaml utility functions.
+
+Because we want to work with Python2.6 or higher, we play a few tricks with
+what library to use for what Python. We have an 2 inline copy of PyYAML, one
+that still does 2.6 and one for newer Pythons.
+
+Also we put loading for specific packages in here and a few helpers to work
+with these config files.
+"""
+
+# Otherwise "Yaml" and "yaml" collide on case insensitive setups
+from __future__ import absolute_import
+
+import os
+import pkgutil
+
+from nuitka.containers.OrderedDicts import OrderedDict
+from nuitka.Options import getUserProvidedYamlFiles
+from nuitka.Tracing import general
+
+from .FileOperations import getFileContents
+from .Hashing import HashCRC32
+from .Importing import importFromInlineCopy
+from .ModuleNames import checkModuleName
+
+
+class PackageConfigYaml(object):
+    __slots__ = (
+        "name",
+        "data",
+    )
+
+    def __init__(self, name, file_data):
+        self.name = name
+
+        assert type(file_data) is bytes
+        data = parseYaml(file_data)
+
+        if not data:
+            general.sysexit(
+                """\
+Error, empty (or malformed?) user package configuration '%s' used."""
+                % name
+            )
+
+        assert type(data) is list, type(data)
+
+        self.data = OrderedDict()
+
+        for item in data:
+            module_name = item.pop("module-name")
+
+            if not module_name:
+                general.sysexit(
+                    "Error, invalid config in '%s' looks like an empty module name was given."
+                    % (self.name)
+                )
+
+            if "/" in module_name:
+                general.sysexit(
+                    "Error, invalid module name in '%s' looks like a file path '%s'."
+                    % (self.name, module_name)
+                )
+
+            if not checkModuleName(module_name):
+                general.sysexit(
+                    "Error, invalid module name in '%s' not valid '%s'."
+                    % (self.name, module_name)
+                )
+
+            if module_name in self.data:
+                general.sysexit("Duplicate module name '%s' encountered." % module_name)
+
+            self.data[module_name] = item
+
+    def __repr__(self):
+        return "<PackageConfigYaml %s>" % self.name
+
+    def get(self, name, section):
+        """Return a configs for that section."""
+        result = self.data.get(name)
+
+        if result is not None:
+            result = result.get(section, ())
+        else:
+            result = ()
+
+        # TODO: Ought to become a list universally, but data-files currently
+        # are not, and options-nanny too.
+        if type(result) in (dict, OrderedDict):
+            result = (result,)
+
+        return result
+
+    def keys(self):
+        return self.data.keys()
+
+    def items(self):
+        return self.data.items()
+
+    def update(self, other):
+        # TODO: Full blown merging, including respecting an overload flag, where a config
+        # replaces another one entirely, for now we expect to not overlap.
+        for key, value in other.items():
+            assert key not in self.data, key
+
+            self.data[key] = value
+
+
+def getYamlPackage():
+    if not hasattr(getYamlPackage, "yaml"):
+        try:
+            import yaml
+
+            getYamlPackage.yaml = yaml
+        except ImportError:
+            getYamlPackage.yaml = importFromInlineCopy(
+                "yaml", must_exist=True, delete_module=True
+            )
+
+    return getYamlPackage.yaml
+
+
+def parseYaml(data):
+    yaml = getYamlPackage()
+
+    # Make sure dictionaries are ordered even before 3.6 in the result. We use
+    # them for hashing in caching keys.
+    class OrderedLoader(yaml.SafeLoader):
+        pass
+
+    def construct_mapping(loader, node):
+        loader.flatten_mapping(node)
+
+        return OrderedDict(loader.construct_pairs(node))
+
+    OrderedLoader.add_constructor(
+        yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG, construct_mapping
+    )
+
+    return yaml.load(data, OrderedLoader)
+
+
+_yaml_cache = {}
+
+
+def getYamlDataHash(data):
+    result = HashCRC32()
+    result.updateFromValues(data)
+
+    return result.asHexDigest()
+
+
+def parsePackageYaml(package_name, filename):
+    key = package_name, filename
+
+    if key not in _yaml_cache:
+        if package_name is None:
+            file_data = getFileContents(filename, mode="rb")
+        else:
+            file_data = pkgutil.get_data(package_name, filename)
+
+        if file_data is None:
+            raise IOError("Cannot find %s.%s" % (package_name, filename))
+
+        _yaml_cache[key] = PackageConfigYaml(name=filename, file_data=file_data)
+
+    return _yaml_cache[key]
+
+
+_package_config = None
+
+
+def getYamlPackageConfiguration():
+    """Get Nuitka package configuration. Merged from multiple sources."""
+    # Singleton, pylint: disable=global-statement
+    global _package_config
+
+    if _package_config is None:
+        _package_config = parsePackageYaml(
+            "nuitka.plugins.standard",
+            "standard.nuitka-package.config.yml",
+        )
+        _package_config.update(
+            parsePackageYaml(
+                "nuitka.plugins.standard",
+                "stdlib2.nuitka-package.config.yml",
+            )
+        )
+        _package_config.update(
+            parsePackageYaml(
+                "nuitka.plugins.standard",
+                "stdlib3.nuitka-package.config.yml",
+            )
+        )
+
+        try:
+            _package_config.update(
+                parsePackageYaml(
+                    "nuitka.plugins.commercial", "commercial.nuitka-package.config.yml"
+                )
+            )
+        except IOError:
+            # No commercial configuration found.
+            pass
+
+        # User or plugin provided filenames, but we want PRs though, and will nag
+        # about it somewhat.
+        for user_yaml_filename in getUserProvidedYamlFiles():
+            _package_config.update(
+                PackageConfigYaml(
+                    name=user_yaml_filename,
+                    file_data=getFileContents(user_yaml_filename, mode="rb"),
+                )
+            )
+
+    return _package_config
+
+
+def getYamlPackageConfigurationSchemaFilename():
+    """Get the filename of the schema for Nuitka package configuration."""
+    return os.path.join(
+        os.path.dirname(__file__),
+        "..",
+        "..",
+        "misc",
+        "nuitka-package-config-schema.json",
+    )
+
+
+#     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/utils/__init__.py

@@ -0,0 +1,19 @@
+#     Copyright 2025, 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.
+#
+#     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_winsvc-2.7.7.data/scripts/nuitka-run.cmd

@@ -0,0 +1,24 @@
+@echo off
+rem     Copyright 2025, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+
+
+setlocal
+
+"%~dp0nuitka.cmd --run %*"
+
+endlocal
+
+rem     Part of "Nuitka", an optimizing Python compiler that is compatible and
+rem     integrates with CPython, but also works on its own.
+rem 
+rem     Licensed under the Apache License, Version 2.0 (the "License");
+rem     you may not use this file except in compliance with the License.
+rem     You may obtain a copy of the License at
+rem 
+rem        http://www.apache.org/licenses/LICENSE-2.0
+rem 
+rem     Unless required by applicable law or agreed to in writing, software
+rem     distributed under the License is distributed on an "AS IS" BASIS,
+rem     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+rem     See the License for the specific language governing permissions and
+rem     limitations under the License.

nuitka_winsvc-2.7.7.data/scripts/nuitka.cmd

@@ -0,0 +1,30 @@
+@echo off
+rem     Copyright 2025, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
+
+
+setlocal
+
+if exist "%~dp0..\python.exe" (
+"%~dp0..\python" -m nuitka %*
+) else if exist "%~dp0python.exe" (
+"%~dp0python" -m nuitka %*
+) else (
+"python" -m nuitka %*
+)
+
+endlocal
+
+rem     Part of "Nuitka", an optimizing Python compiler that is compatible and
+rem     integrates with CPython, but also works on its own.
+rem 
+rem     Licensed under the Apache License, Version 2.0 (the "License");
+rem     you may not use this file except in compliance with the License.
+rem     You may obtain a copy of the License at
+rem 
+rem        http://www.apache.org/licenses/LICENSE-2.0
+rem 
+rem     Unless required by applicable law or agreed to in writing, software
+rem     distributed under the License is distributed on an "AS IS" BASIS,
+rem     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+rem     See the License for the specific language governing permissions and
+rem     limitations under the License.

nuitka_winsvc-2.7.7.dist-info/METADATA

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: Nuitka-winsvc
+Version: 2.7.7
+Summary: Nuitka but support compile as Windows service
+Home-page: https://github.com/tabris17/Nuitka-winsvc
+Author: tabris17
+Author-email: tabris17.cn@gmail.com
+License: Apache License, Version 2.0
+Project-URL: Source, https://github.com/tabris17/Nuitka-winsvc
+Keywords: windows service,compiler,python,nuitka
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: System :: Software Distribution
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: C
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: POSIX :: BSD :: FreeBSD
+Classifier: Operating System :: POSIX :: BSD :: NetBSD
+Classifier: Operating System :: POSIX :: BSD :: OpenBSD
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Android
+Classifier: License :: OSI Approved :: Apache Software License
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: ordered-set>=4.1.0
+Requires-Dist: zstandard>=0.15
+Provides-Extra: build-wheel
+Requires-Dist: setuptools>=42; extra == "build-wheel"
+Requires-Dist: toml; extra == "build-wheel"
+Requires-Dist: wheel; extra == "build-wheel"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+# Nuitka-winsvc User Manual
+
+![PyPI](https://img.shields.io/pypi/v/Nuitka-winsvc) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Nuitka-winsvc) ![License](https://img.shields.io/github/license/tabris17/Nuitka-winsvc)
+
+Nuitka-winsvc is a forked version of Nuitka, it supports compiling EXE as a Windows service.
+
+## Install
+
+You can install Nuitka-winsvc by pip:
+
+```shell
+pip install nuitka-winsvc
+```
+
+## Usage
+
+In addition to supporting all the command line arguments of Nuitka, Nuitka-winsvc also provides 7 additional arguments for compiling the Windows services:
+
+- `--windows-service`
+  Enable Windows service mode, works only when compiling for Windows and **onefile** mode enabled.
+- `--windows-service-name`
+  Name of the Windows service. If not provided, the target program name will be used as the service name.
+- `--windows-service-display-name`
+  Display name of the Windows service. If not provided, the product name will be attempted to use.
+- `--windows-service-description`
+  Description of the Windows service. If not provided, the file description will be attempted to use.
+- `--windows-service-cmdline`
+  Additional command line arguments that will be passed to the service, such as `--config config.json --output output.log` .
+- `--windows-service-install`
+  Windows service installation command-line argument. Default value is `install` .
+- `--windows-service-uninstall`
+  Windows service uninstallation command-line argument. Default value is `uninstall` .
+
+Use the following command to build a Windows service:
+
+```shell
+python -m nuitka --onefile --output-dir=build --windows-service --windows-service-name=myservice --windows-service-display-name="My Service" --windows-service-description="This is the description of my service" --windows-service-cmdline="-c config.yml -o output.log" --windows-service-install=install --windows-service-uninstall=uninstall main.py
+```
+
+When the python program is compiled successfully, you can use the following command to install the service:
+
+```shell
+.\main.exe install
+```
+
+Also you can use the following command to uninstall the service:
+
+```shell
+.\main.exe uninstall
+```
+
+Note: Administrator privileges is required when installing and uninstalling the Windows services. You should run the above commands as administrator.
+
+The compiled EXE executable file can be run both as a Windows service and as a regular Windows program. However, it is important to note that the Windows service installation and uninstallation command-line arguments which specified by `--windows-service-install` and `--windows-service-uninstall` of Nuitka-winsvc compilation arguments will override the original behavior of the program. Therefore, the compiled Python program should avoid using the same command line arguments.