File: util.py

package info (click to toggle)
python-nbxmpp 6.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,340 kB
  • sloc: python: 19,639; makefile: 4
file content (96 lines) | stat: -rw-r--r-- 2,576 bytes parent folder | download | duplicates (2)
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
# Copyright (C) 2020 Philipp Hörist <philipp AT hoerist.com>
#
# This file is part of nbxmpp.
#
# SPDX-License-Identifier: GPL-3.0-or-later

from __future__ import annotations

from typing import Any
from typing import ParamSpec
from typing import TYPE_CHECKING
from typing import TypeVar

import functools
import inspect
import logging
from collections.abc import Callable
from urllib.parse import unquote
from urllib.parse import urlparse

from nbxmpp.errors import is_error
from nbxmpp.errors import StanzaError
from nbxmpp.protocol import Iq
from nbxmpp.simplexml import Node
from nbxmpp.structs import CommonResult

if TYPE_CHECKING:
    from nbxmpp.dispatcher import NBXMPPModuleT
    from nbxmpp.task import Task

T = TypeVar("T")
P = ParamSpec("P")


def process_response(response: Iq) -> CommonResult:
    if response.isError():
        raise StanzaError(response)

    return CommonResult(jid=response.getFrom())


def raise_if_error(result: Any) -> None:
    if is_error(result):
        raise result


def finalize(task: Task, result: Any) -> Any:
    if is_error(result):
        raise result
    if isinstance(result, Node):
        return task.set_result(result)
    return result


def parse_xmpp_uri(uri: str) -> tuple[str, str, dict[str, str]]:
    url = urlparse(uri)
    if url.scheme != "xmpp":
        raise ValueError("not a xmpp uri")

    if ";" not in url.query:
        return (url.path, url.query, {})

    action, query = url.query.split(";", 1)
    key_value_pairs = query.split(";")

    dict_: dict[str, str] = {}
    for key_value in key_value_pairs:
        key, value = key_value.split("=")
        dict_[key] = unquote(value)

    return (url.path, action, dict_)


def make_func_arguments_string(
    func: Callable[..., Any], self: Any, args: Any, kwargs: Any
) -> str:
    signature = inspect.signature(func)
    bound_arguments = signature.bind(self, *args, **kwargs)
    bound_arguments.apply_defaults()
    arg_string = ""
    for name, arg in bound_arguments.arguments.items():
        if name == "self":
            continue
        arg_string += f"{name}={arg}, "
    arg_string = arg_string[:-2]
    return f"{func.__name__}({arg_string})"


def log_calls(func: Callable[P, T]) -> Callable[P, T]:
    @functools.wraps(func)
    def func_wrapper(self: NBXMPPModuleT, *args: Any, **kwargs: Any) -> T:
        if self._log.isEnabledFor(logging.INFO):  # type: ignore
            self._log.info(make_func_arguments_string(func, self, args, kwargs))  # type: ignore
        return func(self, *args, **kwargs)

    return func_wrapper