-
-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathdbus_proxy_async_method.py
More file actions
291 lines (231 loc) · 8.94 KB
/
dbus_proxy_async_method.py
File metadata and controls
291 lines (231 loc) · 8.94 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# SPDX-License-Identifier: LGPL-2.1-or-later
# Copyright (C) 2020-2023 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 asyncio import get_running_loop
from contextvars import ContextVar, copy_context
from inspect import iscoroutinefunction
from types import FunctionType
from typing import TYPE_CHECKING, cast, overload
from weakref import ref as weak_ref
from .dbus_common_elements import (
DbusBoundAsync,
DbusLocalObjectMeta,
DbusMemberAsync,
DbusMethodCommon,
DbusMethodOverride,
DbusRemoteObjectMeta,
)
from .dbus_exceptions import DbusFailedError
from .sd_bus_internals import EXCEPTION_TO_DBUS_ERROR, DbusNoReplyFlag
if TYPE_CHECKING:
from collections.abc import Callable, Sequence
from typing import Any, Optional, TypeVar, Union
from .dbus_proxy_async_interface_base import DbusInterfaceBaseAsync
from .sd_bus_internals import SdBusMessage
T = TypeVar('T')
else:
T = None
CURRENT_MESSAGE: ContextVar[SdBusMessage] = ContextVar('CURRENT_MESSAGE')
def get_current_message() -> SdBusMessage:
return CURRENT_MESSAGE.get()
class DbusMethodAsync(DbusMethodCommon, DbusMemberAsync):
@overload
def __get__(
self,
obj: None,
obj_class: type[DbusInterfaceBaseAsync],
) -> DbusMethodAsync:
...
@overload
def __get__(
self,
obj: DbusInterfaceBaseAsync,
obj_class: type[DbusInterfaceBaseAsync],
) -> Callable[..., Any]:
...
def __get__(
self,
obj: Optional[DbusInterfaceBaseAsync],
obj_class: Optional[type[DbusInterfaceBaseAsync]] = None,
) -> Union[Callable[..., Any], DbusMethodAsync]:
if obj is not None:
dbus_meta = obj._dbus
if isinstance(dbus_meta, DbusRemoteObjectMeta):
return DbusProxyMethodAsync(self, dbus_meta)
else:
return DbusLocalMethodAsync(self, obj)
else:
return self
class DbusBoundMethodAsyncBase(DbusBoundAsync):
def __call__(self, *args: Any, **kwargs: Any) -> Any:
raise NotImplementedError
class DbusProxyMethodAsync(DbusBoundMethodAsyncBase):
def __init__(
self,
dbus_method: DbusMethodAsync,
proxy_meta: DbusRemoteObjectMeta,
):
self.dbus_method = dbus_method
self.proxy_meta = proxy_meta
self.__doc__ = dbus_method.__doc__
async def _dbus_async_call(self, call_message: SdBusMessage) -> Any:
bus = self.proxy_meta.attached_bus
reply_message = await bus.call_async(call_message)
return reply_message.get_contents()
@staticmethod
async def _no_reply() -> None:
return None
def __call__(self, *args: Any, **kwargs: Any) -> Any:
bus = self.proxy_meta.attached_bus
dbus_method = self.dbus_method
new_call_message = bus.new_method_call_message(
self.proxy_meta.service_name,
self.proxy_meta.object_path,
dbus_method.interface_name,
dbus_method.method_name,
)
if len(args) == dbus_method.num_of_args:
assert not kwargs, (
"Passed more arguments than method supports"
f"Extra args: {kwargs}")
rebuilt_args: Sequence[Any] = args
else:
rebuilt_args = dbus_method._rebuild_args(
dbus_method.original_method,
*args,
**kwargs)
if rebuilt_args:
new_call_message.append_data(
dbus_method.input_signature, *rebuilt_args)
if dbus_method.flags & DbusNoReplyFlag:
new_call_message.expect_reply = False
new_call_message.send()
return self._no_reply()
return self._dbus_async_call(new_call_message)
class DbusLocalMethodAsync(DbusBoundMethodAsyncBase):
def __init__(
self,
dbus_method: DbusMethodAsync,
local_object: DbusInterfaceBaseAsync,
):
self.dbus_method = dbus_method
self.local_object_ref = weak_ref(local_object)
self.__doc__ = dbus_method.__doc__
def __call__(self, *args: Any, **kwargs: Any) -> Any:
local_object = self.local_object_ref()
if local_object is None:
raise RuntimeError("Local object no longer exists!")
return self.dbus_method.original_method(local_object, *args, **kwargs)
async def _dbus_reply_call_method(
self,
request_message: SdBusMessage,
local_object: DbusInterfaceBaseAsync,
) -> Any:
local_method = self.dbus_method.original_method.__get__(
local_object, None)
CURRENT_MESSAGE.set(request_message)
return await local_method(*request_message.parse_to_tuple())
def _dbus_reply_call(
self,
request_message: SdBusMessage
) -> None:
local_object = self.local_object_ref()
if local_object is None:
raise RuntimeError("Local object no longer exists!")
local_meta = local_object._dbus
if not isinstance(local_meta, DbusLocalObjectMeta):
raise RuntimeError("D-Bus object is a remote proxy!")
loop = get_running_loop()
reply_task = loop.create_task(
self._dbus_reply_call_async(local_object, request_message)
)
tasks_set = local_meta.tasks
tasks_set.add(reply_task)
reply_task.add_done_callback(tasks_set.discard)
async def _dbus_reply_call_async(
self,
local_object: DbusInterfaceBaseAsync,
request_message: SdBusMessage
) -> None:
call_context = copy_context()
try:
reply_data = await call_context.run(
self._dbus_reply_call_method,
request_message,
local_object,
)
except Exception as e:
if not request_message.expect_reply:
return
dbus_error = EXCEPTION_TO_DBUS_ERROR.get(type(e))
if dbus_error is None:
dbus_error = DbusFailedError.dbus_error_name
error_message = request_message.create_error_reply(
dbus_error,
str(e.args[0]) if e.args else "",
)
error_message.send()
return
if not request_message.expect_reply:
return
reply_message = request_message.create_reply()
if isinstance(reply_data, tuple):
try:
reply_message.append_data(
self.dbus_method.result_signature, *reply_data)
except TypeError:
# In case of single struct result type
# We can't figure out if return is multiple values
# or a tuple
reply_message.append_data(
self.dbus_method.result_signature, reply_data)
elif reply_data is not None:
reply_message.append_data(
self.dbus_method.result_signature, reply_data)
reply_message.send()
def dbus_method_async(
input_signature: str = "",
result_signature: str = "",
flags: int = 0,
result_args_names: Optional[Sequence[str]] = None,
input_args_names: Optional[Sequence[str]] = None,
method_name: Optional[str] = None,
) -> Callable[[T], T]:
assert not isinstance(input_signature, FunctionType), (
"Passed function to decorator directly. "
"Did you forget () round brackets?"
)
def dbus_method_decorator(original_method: T) -> T:
assert isinstance(original_method, FunctionType)
assert iscoroutinefunction(original_method), (
"Expected coroutine function. ",
"Maybe you forgot 'async' keyword?",
)
new_wrapper = DbusMethodAsync(
original_method=original_method,
method_name=method_name,
input_signature=input_signature,
result_signature=result_signature,
result_args_names=result_args_names,
input_args_names=input_args_names,
flags=flags,
)
return cast(T, new_wrapper)
return dbus_method_decorator
def dbus_method_async_override() -> Callable[[T], T]:
def new_decorator(
new_function: T) -> T:
return cast(T, DbusMethodOverride(new_function))
return new_decorator