Split sdbus.utils package

igo95862 · igo95862 · commit 87aefaabea3c · 2024-10-02T18:39:50.000+01:00
Move current parsing utilities to `sdbus.utils.parse` subpackage.

For backwards compatibility import them to the `__init__.py`.

This allows better package separation in the future.
diff --git a/docs/asyncio_api.rst b/docs/asyncio_api.rst
@@ -75,7 +75,7 @@ Classes
 
         Signal when one of the objects properties changes.
 
-        :py:func:`sdbus.utils.parse_properties_changed` can be used to transform
+        :py:func:`sdbus.utils.parse.parse_properties_changed` can be used to transform
         this signal data in to an easier to work with dictionary.
 
         Signal data is:
@@ -192,7 +192,7 @@ Classes
 
         Get the objects this object manager in managing.
 
-        :py:func:`sdbus.utils.parse_get_managed_objects` can be used
+        :py:func:`sdbus.utils.parse.parse_get_managed_objects` can be used
         to make returned data easier to work with.
 
         :return:
@@ -209,7 +209,7 @@ Classes
         Signal when a new object is added or and existing object
         gains a new interface.
 
-        :py:func:`sdbus.utils.parse_interfaces_added` can be used
+        :py:func:`sdbus.utils.parse.parse_interfaces_added` can be used
         to make signal data easier to work with.
 
         Signal data is:
@@ -226,7 +226,7 @@ Classes
         Signal when existing object or and interface of
         existing object is removed.
 
-        :py:func:`sdbus.utils.parse_interfaces_removed` can be used
+        :py:func:`sdbus.utils.parse.parse_interfaces_removed` can be used
         to make signal data easier to work with.
 
         Signal data is:
diff --git a/docs/utils.rst b/docs/utils.rst
@@ -4,7 +4,10 @@ Utilities
 Parsing utilities
 +++++++++++++++++
 
-.. py:currentmodule:: sdbus.utils
+Parse unweildy D-Bus structures in to Python native objects and names.
+Available under ``sdbus.utils.parse`` subpackage.
+
+.. py:currentmodule:: sdbus.utils.parse
 
 .. py:function:: parse_properties_changed(interface, properties_changed_data, on_unknown_member='error')
 
diff --git a/setup.py b/setup.py
@@ -118,10 +118,12 @@ def get_link_arguments() -> List[str]:
             'Programming Language :: Python :: 3 :: Only',
             'Topic :: Software Development :: Libraries :: Python Modules',
         ],
-        packages=['sdbus',
-                  # 'sdbus_async', 'sdbus_block',
-                  'sdbus_async.dbus_daemon', 'sdbus_block.dbus_daemon',
-                  ],
+        packages=[
+            'sdbus',
+            'sdbus.utils',
+            'sdbus_async.dbus_daemon',
+            'sdbus_block.dbus_daemon',
+        ],
         package_dir={
             'sdbus': 'src/sdbus',
             'sdbus_async.dbus_daemon': 'src/sdbus_async/dbus_daemon',
diff --git a/src/sdbus/utils/__init__.py b/src/sdbus/utils/__init__.py
@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+
+# Copyright (C) 2024 igo95862
+
+# This file is part of python-sdbus
+
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+from __future__ import annotations
+
+from .parse import (
+    parse_get_managed_objects,
+    parse_interfaces_added,
+    parse_interfaces_removed,
+    parse_properties_changed,
+)
+
+__all__ = (
+    "parse_get_managed_objects",
+    "parse_interfaces_added",
+    "parse_interfaces_removed",
+    "parse_properties_changed",
+)
diff --git a/src/sdbus/utils/parse.py b/src/sdbus/utils/parse.py
@@ -21,8 +21,8 @@
 
 from typing import TYPE_CHECKING
 
-from .dbus_common_funcs import _parse_properties_vardict
-from .dbus_proxy_async_interface_base import (
+from ..dbus_common_funcs import _parse_properties_vardict
+from ..dbus_proxy_async_interface_base import (
     DBUS_CLASS_TO_META,
     DBUS_INTERFACE_NAME_TO_CLASS,
     DbusInterfaceBaseAsync,
@@ -42,7 +42,7 @@
         Union,
     )
 
-    from .dbus_proxy_async_interfaces import DBUS_PROPERTIES_CHANGED_TYPING
+    from ..dbus_proxy_async_interfaces import DBUS_PROPERTIES_CHANGED_TYPING
 
     InterfacesInputElements = Union[
         DbusInterfaceBaseAsync,
diff --git a/test/test_sdbus_async.py b/test/test_sdbus_async.py
@@ -40,7 +40,7 @@
     DbusPropertyEmitsChangeFlag,
 )
 from sdbus.unittest import IsolatedDbusTestCase
-from sdbus.utils import parse_properties_changed
+from sdbus.utils.parse import parse_properties_changed
 
 from sdbus import (
     DbusInterfaceCommonAsync,

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`DbusPropertyEmitsChangeFlag,`
`41`	`41`	`)`
`42`	`42`	`from sdbus.unittest import IsolatedDbusTestCase`
`43`		`-from sdbus.utils import parse_properties_changed`
	`43`	`+from sdbus.utils.parse import parse_properties_changed`
`44`	`44`
`45`	`45`	`from sdbus import (`
`46`	`46`	`DbusInterfaceCommonAsync,`