python3-cyberfusion-systemd-support 1.1.1.3__py3-none-any.whl

cyberfusion/SystemdSupport/__init__.py

@@ -0,0 +1,43 @@
+"""Classes for systemd."""
+
+import subprocess
+from typing import List
+
+from cyberfusion.SystemdSupport._constants import SYSTEMCTL_BIN
+from cyberfusion.SystemdSupport.units import Unit
+
+
+class Systemd:
+    """Represents systemd."""
+
+    def __init__(self) -> None:
+        """Do nothing."""
+        pass
+
+    def search_units(self, string: str) -> List[Unit]:
+        """Search units."""
+        output = []
+
+        units = subprocess.run(
+            [
+                SYSTEMCTL_BIN,
+                "list-units",
+                "--plain",
+                "--type",
+                "service",
+                "--all",
+                string,
+                "--no-pager",
+                "--no-legend",
+            ],
+            check=True,
+            stdout=subprocess.PIPE,
+            text=True,
+        ).stdout.splitlines()
+
+        for unit in units:
+            name = unit.split()[0]
+
+            output.append(Unit(name))
+
+        return output

cyberfusion/SystemdSupport/_constants.py

@@ -0,0 +1,5 @@
+"""Constants."""
+
+import os
+
+SYSTEMCTL_BIN = os.path.join(os.path.sep, "bin", "systemctl")

cyberfusion/SystemdSupport/manager.py

@@ -0,0 +1,14 @@
+"""Classes for systemd manager."""
+
+import subprocess
+
+from cyberfusion.SystemdSupport._constants import SYSTEMCTL_BIN
+
+
+class SystemdManager:
+    """Represents systemd manager."""
+
+    @staticmethod
+    def daemon_reload() -> None:
+        """Reload manager configuration."""
+        subprocess.run([SYSTEMCTL_BIN, "daemon-reload"], check=True)

cyberfusion/SystemdSupport/tmp_files.py

@@ -0,0 +1,59 @@
+"""Classes for systemd tmp files."""
+
+import os
+import subprocess
+from typing import Optional
+
+SYSTEMCTL_TMPFILES_BIN = os.path.join(os.path.sep, "bin", "systemd-tmpfiles")
+
+
+class TmpFileConfigurationFile:
+    """Represents tmp file configuration file."""
+
+    def __init__(self, path: str) -> None:
+        """Set attributes."""
+        self.path = path
+
+    def create(self) -> None:
+        """Create tmp files."""
+        subprocess.run([SYSTEMCTL_TMPFILES_BIN, "--create", self.path], check=True)
+
+
+class TmpFileConfigurationLine:
+    """Represents tmp file configuration line."""
+
+    TYPE_DIRECTORY_CREATE = "d"
+
+    def __init__(
+        self,
+        type_: str,
+        path: str,
+        *,
+        mode: str,
+        user: str,
+        group: str,
+        age: Optional[str] = None,
+    ) -> None:
+        """Set attributes."""
+        self.type = type_
+        self.path = path
+        self.mode = mode
+        self.user = user
+        self.group = group
+        self.age = age
+
+    def __str__(self) -> str:
+        """Get line for in configuration."""
+        return (
+            self.type
+            + " "
+            + self.path
+            + " "
+            + self.mode
+            + " "
+            + self.user
+            + " "
+            + self.group
+            + " "
+            + (self.age if self.age else "-")
+        )

cyberfusion/SystemdSupport/units.py

@@ -0,0 +1,137 @@
+"""Classes for systemd units."""
+
+import glob
+import os
+import subprocess
+from functools import wraps
+from typing import Callable, Optional, TypeVar, cast
+
+from cyberfusion.SystemdSupport._constants import SYSTEMCTL_BIN
+from cyberfusion.SystemdSupport.manager import SystemdManager
+
+F = TypeVar("F", bound=Callable[..., None])
+
+
+def reload_manager(f: F) -> F:
+    """Reload manager configuration if needed.."""
+
+    @wraps(f)
+    def wrapper(
+        self: "Unit",
+        *args: tuple,
+        **kwargs: dict,
+    ) -> None:
+        if self.needs_reload:
+            SystemdManager.daemon_reload()
+
+        f(self, *args, **kwargs)
+
+    return cast(F, wrapper)
+
+
+class Unit:
+    """Represents unit."""
+
+    SUFFIX_SERVICE = "service"
+
+    DIRECTORY_SYSTEMD_OVERRIDE = os.path.join(os.path.sep, "etc", "systemd", "system")
+
+    def __init__(self, name: str) -> None:
+        """Set attributes."""
+        self.name = name
+
+    def get_property(self, name: str) -> Optional[str]:
+        """Get unit property from systemd."""
+        output = subprocess.run(
+            [SYSTEMCTL_BIN, "-P", name, "show", self.name],
+            check=True,
+            stdout=subprocess.PIPE,
+            text=True,
+        ).stdout.rstrip()
+
+        if output == "":
+            return None
+
+        return output
+
+    @property
+    def drop_in_directory(self) -> str:
+        """Get path to drop-in directory."""
+        return os.path.join(os.path.sep, "etc", "systemd", "system", self.name + ".d")
+
+    @property
+    def needs_reload(self) -> bool:
+        """Get if manager needs to be reloaded for unit."""
+
+        # systemd itself decides that daemon-reload is needed
+
+        if self.get_property("NeedDaemonReload") == "yes":
+            return True
+
+        # Drop-in directory was added after the latest daemon-reload (systemd
+        # does not detect it itself in that case, see: https://github.com/systemd/systemd/issues/31752)
+
+        if (
+            os.path.isdir(self.drop_in_directory)
+            and glob.glob(os.path.join(self.drop_in_directory, "*.conf"))
+            and self.get_property("DropInPaths") is None
+        ):
+            return True
+
+        return False
+
+    def disable(self) -> None:
+        """Disable unit."""
+        if not self.is_enabled:
+            return
+
+        subprocess.run([SYSTEMCTL_BIN, "disable", self.name], check=True)
+
+    def enable(self) -> None:
+        """Enable unit."""
+        if self.is_enabled:
+            return
+
+        subprocess.run([SYSTEMCTL_BIN, "enable", self.name], check=True)
+
+    @reload_manager
+    def stop(self) -> None:
+        """Stop unit."""
+        if not self.is_active:
+            return
+
+        subprocess.run([SYSTEMCTL_BIN, "stop", self.name], check=True)
+
+    @reload_manager
+    def restart(self) -> None:
+        """Restart unit."""
+        subprocess.run([SYSTEMCTL_BIN, "restart", self.name], check=True)
+
+    @reload_manager
+    def reload(self) -> None:
+        """Reload unit."""
+        subprocess.run([SYSTEMCTL_BIN, "reload", self.name], check=True)
+
+    @property
+    def is_active(self) -> bool:
+        """Get if unit is active."""
+        try:
+            subprocess.run(
+                [SYSTEMCTL_BIN, "is-active", "--quiet", self.name], check=True
+            )
+        except subprocess.CalledProcessError:
+            return False
+
+        return True
+
+    @property
+    def is_enabled(self) -> bool:
+        """Get if unit is enabled."""
+        try:
+            subprocess.run(
+                [SYSTEMCTL_BIN, "is-enabled", "--quiet", self.name], check=True
+            )
+        except subprocess.CalledProcessError:
+            return False
+
+        return True

python3_cyberfusion_systemd_support-1.1.1.3.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.1
+Name: python3-cyberfusion-systemd-support
+Version: 1.1.1.3
+Summary: Library for systemd.
+Author-email: Cyberfusion <support@cyberfusion.io>
+Project-URL: Source, https://github.com/CyberfusionIO/python3-cyberfusion-systemd-support
+Description-Content-Type: text/markdown
+Requires-Dist: python3-cyberfusion-common ~=2.0
+
+# python3-cyberfusion-systemd-support
+
+Library for [systemd](https://systemd.io/).
+
+# Install
+
+## PyPI
+
+Run the following command to install the package from PyPI:
+
+    pip3 install python3-cyberfusion-systemd-support
+
+Next, ensure you are working on a system that ships systemd.
+
+## Debian
+
+Run the following commands to build a Debian package:
+
+    mk-build-deps -i -t 'apt -o Debug::pkgProblemResolver=yes --no-install-recommends -y'
+    dpkg-buildpackage -us -uc
+
+# Configure
+
+No configuration is supported.
+
+# Usage
+
+## Units
+
+```python
+from cyberfusion.SystemdSupport.units import Unit
+
+unit = Unit(f"example.{Unit.SUFFIX_SERVICE}")
+
+unit.disable()
+unit.stop()
+unit.enable()
+unit.restart()
+unit.reload()
+
+print(unit.is_active)
+print(unit.is_enabled)
+```
+
+## Tmp files
+
+```python
+from cyberfusion.SystemdSupport.tmp_files import TmpFileConfigurationLine, TmpFileConfigurationFile
+
+tmp_file_configuration_line = str(TmpFileConfigurationLine(type_="d", path="/tmp/example", mode="0755", user="example", group="example"))
+tmp_file_configuration_file = TmpFileConfigurationFile(path="/etc/tmpfiles.d/example.conf")
+
+tmp_file_configuration_file.create()
+```

python3_cyberfusion_systemd_support-1.1.1.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+cyberfusion/SystemdSupport/__init__.py,sha256=tFF-tVDTfOjoIE41CSx_hJeKZCnN4FukSFcjUnfEZkc,959
+cyberfusion/SystemdSupport/_constants.py,sha256=OKlVPEdUByBTc6hvVAB9SVuZlmEqTnNOwVDuH-0RkaU,91
+cyberfusion/SystemdSupport/manager.py,sha256=cWM2kqjEpmO88CCgalQsUlhbzqH0RFbmLbuVBvFGW_8,346
+cyberfusion/SystemdSupport/tmp_files.py,sha256=0EHIN6wZnPthytOCPxozwC2t0dgQfI08OuEvlERVk-A,1350
+cyberfusion/SystemdSupport/units.py,sha256=49Uu8JRILV5hkTWNlwoNNzYzYuanN7GFfYXj4p9d9VE,3671
+python3_cyberfusion_systemd_support-1.1.1.3.dist-info/METADATA,sha256=hOZYke1makSD2lEvv4Xhpvealz50nSKHVMeznR2sDNw,1499
+python3_cyberfusion_systemd_support-1.1.1.3.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+python3_cyberfusion_systemd_support-1.1.1.3.dist-info/top_level.txt,sha256=ss011q9S6SL_KIIyq7iujFmIYa0grSjlnInO7cDkeag,12
+python3_cyberfusion_systemd_support-1.1.1.3.dist-info/RECORD,,

python3_cyberfusion_systemd_support-1.1.1.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (73.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

python3_cyberfusion_systemd_support-1.1.1.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+cyberfusion