test: Add type hints tests

These new functions are not intended to be called but instead
the type checker in CI will verify that the types are properly
hinted.

test/test_typing.py

@@ -0,0 +1,147 @@
+# 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 typing import TYPE_CHECKING
+
+from sdbus import (
+    DbusInterfaceCommon,
+    DbusInterfaceCommonAsync,
+    dbus_method,
+    dbus_method_async,
+    dbus_property,
+    dbus_property_async,
+    dbus_signal_async,
+)
+
+if TYPE_CHECKING:
+    from typing import List
+
+
+class TestTypingBlocking(
+    DbusInterfaceCommon,
+    interface_name="example.com",
+):
+
+    @dbus_method(result_signature="as")
+    def get_str_list_method(self) -> List[str]:
+        raise NotImplementedError
+
+    @dbus_property("as")
+    def str_list_property(self) -> List[str]:
+        raise NotImplementedError
+
+
+# These functions are not meant to be executed
+# but exist to be type checked.
+
+def check_blocking_interface_method_typing(
+    test_interface: TestTypingBlocking,
+) -> None:
+
+    should_be_list = test_interface.get_str_list_method()
+    should_be_list.append("test")
+
+    for x in should_be_list:
+        x.capitalize()
+
+
+def check_blocking_interface_property_typing(
+    test_interface: TestTypingBlocking,
+) -> None:
+
+    should_be_list = test_interface.str_list_property
+    should_be_list.append("test")
+
+    for x in should_be_list:
+        x.capitalize()
+
+    test_interface.str_list_property = ["test", "foobar"]
+
+
+class TestTypingAsync(
+    DbusInterfaceCommonAsync,
+    interface_name="example.com",
+):
+
+    @dbus_method_async(result_signature="as")
+    async def get_str_list_method(self) -> List[str]:
+        raise NotImplementedError
+
+    @dbus_property_async("as")
+    def str_list_property(self) -> List[str]:
+        raise NotImplementedError
+
+    @dbus_signal_async("as")
+    def str_list_signal(self) -> List[str]:
+        raise NotImplementedError
+
+
+async def check_async_interface_method_typing(
+    test_interface: TestTypingAsync,
+) -> None:
+
+    should_be_list = await test_interface.get_str_list_method()
+    should_be_list.append("test")
+
+    for x in should_be_list:
+        x.capitalize()
+
+
+async def check_async_interface_property_typing(
+    test_interface: TestTypingAsync,
+) -> None:
+
+    should_be_list = await test_interface.str_list_property
+    should_be_list.append("test")
+
+    for x in should_be_list:
+        x.capitalize()
+
+    should_be_list2 = await test_interface.str_list_property.get_async()
+    should_be_list2.append("test")
+
+    for x in should_be_list2:
+        x.capitalize()
+
+    await test_interface.str_list_property.set_async(["test", "foobar"])
+
+
+async def check_async_interface_signal_typing(
+    test_interface: TestTypingAsync,
+) -> None:
+
+    async for ls in test_interface.str_list_signal:
+        ls.append("test")
+        for x in ls:
+            x.capitalize()
+
+    async for ls2 in test_interface.str_list_signal.catch():
+        ls2.append("test")
+        for x2 in ls2:
+            x2.capitalize()
+
+    async for p, ls3 in test_interface.str_list_signal.catch_anywhere():
+        p.capitalize()
+        ls3.append("test")
+        for x3 in ls3:
+            x3.capitalize()
+
+    test_interface.str_list_signal.emit(["test", "foobar"])