Debian Codegraph @

tests/pyportaltest/templates/__init__.py

raw
1 # SPDX-License-Identifier: LGPL-3.0-only
2 #
3 # This file is formatted with Python Black
4
5 from dbusmock import DBusMockObject
6 from typing import Dict, Any, NamedTuple, Optional
7 from itertools import count
8 from gi.repository import GLib
9
10 import dbus
11 import logging
12
13
14 ASVType = Dict[str, Any]
15
16 logging.basicConfig(format="%(levelname).1s|%(name)s: %(message)s", level=logging.DEBUG)
17 logger = logging.getLogger("templates")
18
19
20 class MockParams:
21 """
22 Helper class for storing template parameters. The Mock object passed into
23 ``load()`` is shared between all templates. This makes it easy to have
24 per-template parameters by calling:
25
26 >>> params = MockParams.get(mock, MAIN_IFACE)
27 >>> params.version = 1
28
29 and later, inside a DBus method:
30 >>> params = MockParams.get(self, MAIN_IFACE)
31 >>> return params.version
32 """
33
34 @classmethod
35 def get(cls, mock, interface_name):
36 params = getattr(mock, "params", {})
37 try:
38 return params[interface_name]
39 except KeyError:
40 c = cls()
41 params[interface_name] = c
42 mock.params = params
43 return c
44
45
46 class Response(NamedTuple):
47 response: int
48 results: ASVType
49
50
51 class Request:
52 _token_counter = count()
53
54 def __init__(
55 self, bus_name: dbus.service.BusName, sender: str, options: Optional[ASVType]
56 ):
57 options = options or {}
58 sender_token = sender.removeprefix(":").replace(".", "_")
59 handle_token = options.get("handle_token", next(self._token_counter))
60 self.sender = sender
61 self.handle = (
62 f"/org/freedesktop/portal/desktop/request/{sender_token}/{handle_token}"
63 )
64 self.mock = DBusMockObject(
65 bus_name=bus_name,
66 path=self.handle,
67 interface="org.freedesktop.portal.Request",
68 props={},
69 )
70 self.mock.AddMethod("", "Close", "", "", "self.RemoveObject(self.path)")
71 logger.debug(f"Request created at {self.handle}")
72
73 def respond(self, response: Response, delay: int = 0):
74 def respond():
75 logger.debug(f"Request.Response on {self.handle}: {response}")
76 self.mock.EmitSignalDetailed(
77 "",
78 "Response",
79 "ua{sv}",
80 [dbus.UInt32(response.response), response.results],
81 details={"destination": self.sender},
82 )
83
84 if delay > 0:
85 GLib.timeout_add(delay, respond)
86 else:
87 respond()
88
89
90 class Session:
91 _token_counter = count()
92
93 def __init__(
94 self, bus_name: dbus.service.BusName, sender: str, options: Optional[ASVType]
95 ):
96 options = options or {}
97 sender_token = sender.removeprefix(":").replace(".", "_")
98 handle_token = options.get("session_handle_token", next(self._token_counter))
99 self.sender = sender
100 self.handle = (
101 f"/org/freedesktop/portal/desktop/session/{sender_token}/{handle_token}"
102 )
103 self.mock = DBusMockObject(
104 bus_name=bus_name,
105 path=self.handle,
106 interface="org.freedesktop.portal.Session",
107 props={},
108 )
109 self.mock.AddMethod("", "Close", "", "", "self.RemoveObject(self.path)")
110 logger.debug(f"Session created at {self.handle}")
111
112 def close(self, details: ASVType, delay: int = 0):
113 def respond():
114 logger.debug(f"Session.Closed on {self.handle}: {details}")
115 self.mock.EmitSignalDetailed(
116 "", "Closed", "a{sv}", [details], details={"destination": self.sender}
117 )
118
119 if delay > 0:
120 GLib.timeout_add(delay, respond)
121 else:
122 respond()