Export map_exception_to_dbus_error and document it

python-sdbus · Jun 13, 2022 · 0b107e0 · 0b107e0
1 parent bafd7f6
commit 0b107e0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -34,6 +34,20 @@ If ``dbus_error_name`` is not unique the :py:exc:`ValueError` will be raised.
 Defining an exception will automatically bind incoming error message to this
 new exception.
 
+Existing exceptions can be manually binded using :py:func:`map_exception_to_dbus_error`
+function.
+
+Functions
++++++++++
+
+.. py:function:: map_exception_to_dbus_error(exception, dbus_error_name)
+
+    Map exception to a D-bus error. Error name must be unique.
+
+    :param Type[Exception] exception: Exception to bind.
+    :param str dbus_error_name: D-Bus error name to bind to.
+
+
 Other exceptions
 +++++++++++++++++++++++++
 

diff --git a/src/sdbus/__init__.py b/src/sdbus/__init__.py
@@ -92,6 +92,7 @@
     SdBusUnmappedMessageError,
     decode_object_path,
     encode_object_path,
+    map_exception_to_dbus_error,
     sd_bus_open,
     sd_bus_open_system,
     sd_bus_open_system_machine,
@@ -158,6 +159,7 @@
     'SdBusUnmappedMessageError',
     'decode_object_path',
     'encode_object_path',
+    'map_exception_to_dbus_error',
     'sd_bus_open',
     'sd_bus_open_system',
     'sd_bus_open_system_machine',