From e756d685565f0c667edf77b543e80845ef2bb842 Mon Sep 17 00:00:00 2001 From: Sven Sager Date: Sat, 19 Apr 2025 07:56:17 +0200 Subject: [PATCH] refactor(dbus): Move D-Bus helper functions to a dedicated file Consolidated `REVPI_DBUS_*` constants and `extend_interface` function into `dbus_helper.py` for better modularity and reusability. Updated imports across modules to reflect this change. --- .../dbus_middleware1/__init__.py | 26 ++----------------- .../{interface_helper.py => dbus_helper.py} | 23 ++++++++++++++++ .../process_image/interface_picontrol.py | 2 +- 3 files changed, 26 insertions(+), 25 deletions(-) rename src/revpi_middleware/dbus_middleware1/{interface_helper.py => dbus_helper.py} (81%) diff --git a/src/revpi_middleware/dbus_middleware1/__init__.py b/src/revpi_middleware/dbus_middleware1/__init__.py index 1c14733..7f1cc52 100644 --- a/src/revpi_middleware/dbus_middleware1/__init__.py +++ b/src/revpi_middleware/dbus_middleware1/__init__.py @@ -2,27 +2,5 @@ # SPDX-FileCopyrightText: 2025 KUNBUS GmbH # SPDX-License-Identifier: GPL-2.0-or-later """D-Bus middleware version 1 of revpi_middleware.""" -from ..__about__ import __author__, __copyright__, __license__, __version__ - -REVPI_DBUS_NAME = "com.revolutionpi.middleware1" -REVPI_DBUS_BASE_PATH = "/com/revolutionpi/middleware1" - - -def extend_interface(*args) -> str: - """ - Extends an interface name by appending additional segments to a pre-defined base name. - - This function takes multiple arguments, concatenates them with a predefined base - interface name, and returns the resulting string, effectively constructing an - extended interface name. - - Args: - *args: str - Components to be appended to the base interface name. - - Returns: - str - Fully constructed interface name by joining the base interface name with - the provided segments. - """ - return ".".join([REVPI_DBUS_NAME, *args]) +from .dbus_helper import REVPI_DBUS_BASE_PATH, REVPI_DBUS_NAME +from .dbus_helper import extend_interface diff --git a/src/revpi_middleware/dbus_middleware1/interface_helper.py b/src/revpi_middleware/dbus_middleware1/dbus_helper.py similarity index 81% rename from src/revpi_middleware/dbus_middleware1/interface_helper.py rename to src/revpi_middleware/dbus_middleware1/dbus_helper.py index 3306519..5b742c4 100644 --- a/src/revpi_middleware/dbus_middleware1/interface_helper.py +++ b/src/revpi_middleware/dbus_middleware1/dbus_helper.py @@ -15,6 +15,9 @@ from threading import Thread log = getLogger(__name__) +REVPI_DBUS_NAME = "com.revolutionpi.middleware1" +REVPI_DBUS_BASE_PATH = "/com/revolutionpi/middleware1" + class ResetDriverWatchdog(Thread): """Watchdog to catch the reset_driver action.""" @@ -101,3 +104,23 @@ class ResetDriverWatchdog(Thread): rc = self._triggered self._triggered = False return rc + + +def extend_interface(*args) -> str: + """ + Extends an interface name by appending additional segments to a pre-defined base name. + + This function takes multiple arguments, concatenates them with a predefined base + interface name, and returns the resulting string, effectively constructing an + extended interface name. + + Args: + *args: str + Components to be appended to the base interface name. + + Returns: + str + Fully constructed interface name by joining the base interface name with + the provided segments. + """ + return ".".join([REVPI_DBUS_NAME, *args]) diff --git a/src/revpi_middleware/dbus_middleware1/process_image/interface_picontrol.py b/src/revpi_middleware/dbus_middleware1/process_image/interface_picontrol.py index ada732a..24e212f 100644 --- a/src/revpi_middleware/dbus_middleware1/process_image/interface_picontrol.py +++ b/src/revpi_middleware/dbus_middleware1/process_image/interface_picontrol.py @@ -8,7 +8,7 @@ from logging import getLogger from pydbus.generic import signal -from ..interface_helper import ResetDriverWatchdog +from ..dbus_helper import ResetDriverWatchdog log = getLogger(__name__)