doc(revpiconfig): Docstrings for get_rfkill_index and simple_systemd

The new docstrings provide detailed explanations of the purpose, parameters, and return values for both functions, improving code readability and maintainability. This ensures better understanding for future contributors and reduces ambiguity.
doc(revpiconfig): Add docstrings to enums in revpi_config.py
2025-04-21 14:44:50 +02:00 · 2025-04-21 14:44:04 +02:00 · 2025-04-21 14:42:14 +02:00 · 2025-04-21 14:38:32 +02:00
2 changed files with 6 additions and 14 deletions
--- a/data/dbus-policy/com.revolutionpi.middleware1.conf
+++ b/data/dbus-policy/com.revolutionpi.middleware1.conf
@@ -1,4 +1,4 @@
-<!-- /usr/share/dbus-1/system.d/com.revolutionpi.middleware1.conf -->
+<!-- /etc/dbus-1/system.d/revpi-middleware.conf -->
 <busconfig>
    <!-- Allow full access to root as the bus owner -->
    <policy user="root">
@@ -12,7 +12,7 @@
        <allow send_destination="com.revolutionpi.middleware1"
               send_interface="org.freedesktop.DBus.Introspectable"/>
        <allow send_destination="com.revolutionpi.middleware1"
-               send_interface="com.revolutionpi.middleware1.PiControl"/>
+               send_interface="com.revolutionpi.middleware1.picontrol"/>
    </policy>

    <!-- Standard-Policy -->
--- a/src/revpi_middleware/dbus_middleware1/system_config/revpi_config.py
+++ b/src/revpi_middleware/dbus_middleware1/system_config/revpi_config.py
@@ -554,11 +554,7 @@ def configure_gui(action: ConfigActions):
        return gui_available

    bus = SystemBus()
-    systemd = bus.get(
-        "org.freedesktop.systemd1",
-        "/org/freedesktop/systemd1",
-    )
-    systemd_manager = systemd["org.freedesktop.systemd1.Manager"]
+    systemd_manager = bus.get(".systemd1")

    if action is ConfigActions.ENABLE:
        systemd_manager.SetDefaultTarget("graphical.target", True)
@@ -658,11 +654,7 @@ def simple_systemd(action: ConfigActions, unit: str):
        ValueError: If the specified action is not supported.
    """
    bus = SystemBus()
-    systemd = bus.get(
-        "org.freedesktop.systemd1",
-        "/org/freedesktop/systemd1",
-    )
-    systemd_manager = systemd["org.freedesktop.systemd1.Manager"]
+    systemd_manager = bus.get(".systemd1")

    if action is ConfigActions.ENABLE:
        systemd_manager.UnmaskUnitFiles([unit], False)
@@ -676,7 +668,7 @@ def simple_systemd(action: ConfigActions, unit: str):
    elif action is ConfigActions.STATUS:
        try:
            unit_path = systemd_manager.LoadUnit(unit)
-            properties = bus.get("org.freedesktop.systemd1", unit_path)
+            properties = bus.get(".systemd1", unit_path)
        except Exception:
            log.warning(f"could not get systemd unit {unit}")
            return False
@@ -686,7 +678,7 @@ def simple_systemd(action: ConfigActions, unit: str):
    elif action is ConfigActions.AVAILABLE:
        try:
            unit_path = systemd_manager.LoadUnit(unit)
-            properties = bus.get("org.freedesktop.systemd1", unit_path)
+            properties = bus.get(".systemd1", unit_path)
        except Exception:
            log.warning(f"could not get systemd unit {unit}")
            return False
Author	SHA1	Message	Date
Sven Sager	acdb814007	doc(revpiconfig): Docstrings for `get_rfkill_index` and `simple_systemd` The new docstrings provide detailed explanations of the purpose, parameters, and return values for both functions, improving code readability and maintainability. This ensures better understanding for future contributors and reduces ambiguity.	2025-04-21 14:44:50 +02:00
Sven Sager	8451b5401b	doc(revpiconfig): Add docstrings to enums in `revpi_config.py` This update introduces detailed docstrings for the `ComputeModuleTypes` and `ConfigActions` enumeration classes. The docstrings provide descriptions for each class and their attributes, improving code readability and maintainability.	2025-04-21 14:44:04 +02:00
Sven Sager	0fe8be6515	doc(revpiconfig): Add docstrings to `RevPiConfig` class and methods Enhance documentation for the `RevPiConfig` class, its methods, and properties to improve code readability and ease of use. The added docstrings provide clear explanations of the class's purpose, attributes, and functionality for developers and users. This update supports better maintainability and understanding of the codebase.	2025-04-21 14:42:14 +02:00
Sven Sager	5d376acf49	doc(revpiconfig): Add detailed docstrings to ConfigTxt methods Enhance the `ConfigTxt` class with comprehensive docstrings for all methods, providing clear explanations of their functionality, parameters, and return values. This improves code readability and facilitates easier maintenance and understanding for future developers.	2025-04-21 14:38:32 +02:00