Commits

commits@gajim.org

17632 discussions

[Git][gajim/python-nbxmpp][master] ci: Use nbxmpp-master image for build-linux stage
by Philipp Hörist (＠lovetox) 11 Dec '22

11 Dec '22

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: 18389912 by Philipp Hörist at 2022-12-11T13:44:25+01:00 ci: Use nbxmpp-master image for build-linux stage - - - - - 1 changed file: - .gitlab-ci.yml Changes: ===================================== .gitlab-ci.yml ===================================== @@ -6,7 +6,6 @@ stages: - deploy test-pylint: - stage: test script: - python3 .ci/pylint-test.py @@ -22,7 +21,6 @@ test-pylint: path: coverage.xml build-linux: - image: nbxmpp-deb-build:latest stage: build dependencies: [] script: View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/1838991275cb67464a411a28… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/1838991275cb67464a411a28… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][soup3] change: Port to libsoup3
by Philipp Hörist (＠lovetox) 11 Dec '22

11 Dec '22

Philipp Hörist pushed to branch soup3 at gajim / python-nbxmpp Commits: 3b6cd299 by Philipp Hörist at 2022-12-11T10:06:05+01:00 change: Port to libsoup3 - - - - - 14 changed files: - README.md - debian/control - nbxmpp/__init__.py - nbxmpp/addresses.py - nbxmpp/client.py - nbxmpp/const.py - nbxmpp/examples/client.py - + nbxmpp/http.py - nbxmpp/modules/muclumbus.py - nbxmpp/structs.py - nbxmpp/task.py - nbxmpp/websocket.py - + test/unit/test_http.py - + test/unit/test_muclumbus.py Changes: ===================================== README.md ===================================== @@ -7,7 +7,7 @@ - python >= 3.9.0 - PyGObject - GLib >= 2.60 -- libsoup +- libsoup3 - precis-i18n - packaging - idna ===================================== debian/control ===================================== @@ -6,7 +6,7 @@ Build-Depends: debhelper-compat (= 13), dh-python, libglib2.0-0 (>= 2.60), - gir1.2-soup-2.4, + gir1.2-soup-3.0, python3-all, python3-gi, python3-idna, @@ -24,7 +24,7 @@ Architecture: all Depends: ${misc:Depends}, ${python3:Depends}, libglib2.0-0 (>= 2.60), - gir1.2-soup-2.4, + gir1.2-soup-3.0, python3-gi, python3-idna, python3-packaging, ===================================== nbxmpp/__init__.py ===================================== @@ -2,6 +2,6 @@ import gi from .protocol import * -gi.require_version('Soup', '2.4') +gi.require_version('Soup', '3.0') __version__: str = '3.2.5' ===================================== nbxmpp/addresses.py ===================================== @@ -18,11 +18,11 @@ import logging from collections import namedtuple -from gi.repository import Soup - -import nbxmpp +from nbxmpp.http import HTTPRequest +from nbxmpp.http import HTTPSession from nbxmpp.util import Observable from nbxmpp.const import ConnectionType +from nbxmpp.const import HTTPRequestError from nbxmpp.const import ConnectionProtocol from nbxmpp.util import parse_websocket_uri @@ -63,6 +63,7 @@ class ServerAddresses(Observable): Observable.__init__(self, log) self._domain = domain + self._http_session = None self._custom_host = None self._proxy = None self._is_resolved = False @@ -136,32 +137,41 @@ class ServerAddresses(Observable): self._resolve_alternatives() def _resolve_alternatives(self) -> None: - session = Soup.Session() - session.props.timeout = 5 - session.props.user_agent = f'nbxmpp/{nbxmpp.__version__}' - message = Soup.Message.new( - 'GET', f'https://{self._domain}/.well-known/host-meta') - session.queue_message(message, self._on_alternatives_result) + if self._http_session is None: + self._on_request_resolved() + return + + request = self._http_session.create_request() + request.get(f'https://{self._domain}/.well-known/host-meta', + timeout=5, + callback=self._on_alternatives_result) def _on_alternatives_result(self, - _session: Soup.Session, - message: Soup.Message) -> None: + request: HTTPRequest, + _signal_name: str + ) -> None: + + if not request.is_complete(): + error = request.get_error() + if error == HTTPRequestError.STATUS_NOT_OK: + message = request.get_message() + phrase = message.get_reason_phrase() + log.info('Failed to retrieve host-meta file: %s %s', + request.get_status(), phrase) + else: + log.error('Failed to read response: %s', error) - status = message.props.status_code - if status != Soup.Status.OK: - error = message.props.reason_phrase - log.info('Failed to retrieve host-meta file: %s %s', status, error) self._on_request_resolved() return - response_body = message.props.response_body - if response_body is None or not response_body.data: + response_body = request.get_data() + if not response_body: log.info('No response body data found') self._on_request_resolved() return try: - uri = parse_websocket_uri(response_body.data) + uri = parse_websocket_uri(response_body.decode()) except Exception as error: log.info('Error parsing websocket uri: %s', error) self._on_request_resolved() @@ -215,6 +225,9 @@ class ServerAddresses(Observable): def set_proxy(self, proxy): self._proxy = proxy + def set_http_session(self, session: HTTPSession) -> None: + self._http_session = session + def _on_request_resolved(self): self._is_resolved = True self.notify('resolved') ===================================== nbxmpp/client.py ===================================== @@ -22,6 +22,7 @@ from typing import Optional from gi.repository import GLib from nbxmpp.namespaces import Namespace +from nbxmpp.http import HTTPSession from nbxmpp.protocol import Features from nbxmpp.protocol import StanzaMalformed from nbxmpp.protocol import SessionRequest @@ -93,6 +94,7 @@ class Client(Observable): self._client_cert = None self._client_cert_pass = None self._proxy = None + self._http_session = None self._allowed_con_types = None self._allowed_protocols = None @@ -329,12 +331,18 @@ class Client(Observable): def set_proxy(self, proxy): self._proxy = proxy - self._dispatcher.get_module('Muclumbus').set_proxy(proxy) @property def proxy(self): return self._proxy + def set_http_session(self, session: HTTPSession) -> None: + self._http_session = session + + @property + def http_session(self) -> Optional[HTTPSession]: + return self._http_session + def get_bound_jid(self): return self._jid @@ -402,6 +410,7 @@ class Client(Observable): self.state = StreamState.RESOLVE self._addresses = ServerAddresses(self._domain) + self._addresses.set_http_session(self._http_session) self._addresses.set_custom_host(self._custom_host) self._addresses.set_proxy(self._proxy) self._addresses.subscribe('resolved', self._on_addresses_resolved) ===================================== nbxmpp/const.py ===================================== @@ -453,6 +453,16 @@ class Mode(IntEnum): return self == Mode.ANONYMOUS_TEST +class HTTPRequestError(IntEnum): + UNKNOWN = 0 + MISSING_CONTENT_LENGTH = 1 + INCOMPLETE = 2 + STATUS_NOT_OK = 3 + CANCELLED = 4 + CONTENT_OVERFLOW = 5 + TIMEOUT = 6 + + MOODS = [ 'afraid', 'amazed', ===================================== nbxmpp/examples/client.py ===================================== @@ -6,6 +6,7 @@ import json from pathlib import Path import gi + gi.require_version('Gtk', '3.0') gi.require_version('GLib', '2.0') from gi.repository import Gtk @@ -14,6 +15,7 @@ from gi.repository import GLib import nbxmpp from nbxmpp.protocol import JID from nbxmpp.client import Client +from nbxmpp.http import HTTPSession from nbxmpp.structs import ProxyData from nbxmpp.structs import StanzaHandler from nbxmpp.const import ConnectionType @@ -83,6 +85,7 @@ class TestClient(Gtk.Window): self._client.set_domain(self.address.domain) self._client.set_username(self.address.localpart) self._client.set_resource('test') + self._client.set_http_session(HTTPSession()) proxy_ip = self._builder.proxy_ip.get_text() if proxy_ip: ===================================== nbxmpp/http.py ===================================== @@ -0,0 +1,459 @@ +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +from __future__ import annotations + +from pathlib import Path + +from typing import Any +from typing import Literal +from typing import Callable +from typing import Optional + +import logging +from threading import Thread + +from gi.repository import Soup +from gi.repository import Gio +from gi.repository import GLib + +import nbxmpp +from nbxmpp.const import HTTPRequestError +from nbxmpp.util import Observable + + +log = logging.getLogger('nbxmpp.http') + + +HTTP_METHODS_T = Literal['GET', 'POST'] +CHUNK_SIZE = 32768 +DEFAULT_USER_AGENT = f'nbxmpp/{nbxmpp.__version__}' + + +class HTTPLogAdapter(logging.LoggerAdapter): + def process(self, msg: str, kwargs: Any) -> tuple[str, Any]: + return f'{self.extra["request"]}: {msg}', kwargs + + +class HTTPSession: + def __init__(self, user_agent: str = DEFAULT_USER_AGENT) -> None: + self._session = Soup.Session() + self._session.set_user_agent(user_agent) + + self._requests: list[HTTPRequest] = [] + + def get_soup_session(self) -> Soup.Session: + return self._session + + def set_proxy_resolver(self, + resolver: Optional[Gio.SimpleProxyResolver] + ) -> None: + + self._session.set_proxy_resolver(resolver) + + def create_request(self) -> HTTPRequest: + request = HTTPRequest(self) + request.subscribe('destroyed', self._on_request_destroyed) + self._requests.append(request) + return request + + def _on_request_destroyed(self, + request: HTTPRequest, + _signal_name: str + ) -> None: + + self._requests.remove(request) + + +class HTTPRequest(Observable): + + ''' + Signals + - started + - complete + - failed + - cancelled + - destroyed + ''' + + def __init__(self, session: HTTPSession) -> None: + Observable.__init__(self, HTTPLogAdapter(log, extra={'request': self})) + self._session = session + + self._received_size = 0 + self._sent_size = 0 + + self._uri: Optional[GLib.Uri] = None + + self._cancellable = Gio.Cancellable() + self._input_stream: Optional[Gio.InputStream] = None + self._output_stream: Optional[Gio.OutputStream] = None + self._file: Optional[Path] = None + self._is_finished = False + self._error: Optional[HTTPRequestError] = None + self._is_complete = False + self._timeout_reached = False + self._timeout_id = None + + self._response_body_file: Optional[Gio.File] = None + self._response_body_data = b'' + + self._request_body_file: Optional[Gio.File] = None + self._request_body_data: Optional[bytes] = None + + self._request_content_type = '' + self._request_content_length = 0 + + self._response_content_type = '' + self._response_content_length = 0 + + self._message = None + self._method = '' + self._progress_callback: Optional[Callable[..., None]] = None + + self._log.info('Created') + + def is_finished(self) -> bool: + return self._is_finished + + def is_complete(self) -> bool: + return self._is_complete + + def get_error(self) -> Optional[HTTPRequestError]: + return self._error + + def get_response_headers(self) -> int: + return self._message.get_response_headers() + + def get_request_headers(self) -> int: + return self._message.get_request_headers() + + def get_data(self) -> bytes: + if not self._is_finished: + raise ValueError('Process not finished, data not available') + return self._response_body_data + + def get_uri(self) -> Optional[GLib.Uri]: + return self._uri + + def get_file_path(self) -> Optional[Gio.File]: + return self._file + + def get_status(self) -> Soup.Status: + return self._message.get_status() + + def get_message(self) -> Soup.Message: + return self._message + + def _get_response_progress(self) -> float: + if self._received_size == 0: + return 0 + + return self._received_size / self._response_content_length + + def _get_request_progress(self) -> float: + if self._sent_size == 0: + return 0 + return self._sent_size / self._request_content_length + + def cancel(self) -> None: + if self._is_finished: + raise ValueError('Session already finished') + + self._cancellable.cancel() + + def set_progress_callback(self, func: Any) -> None: + self._progress_callback = func + + def set_request_body_from_path(self, content_type: str, path: Path) -> None: + if not path.exists(): + raise ValueError('%s does not exist' % path) + + if not path.is_file(): + raise ValueError('%s is not a file' % path) + + self._request_body_file = Gio.File.new_for_path(str(path)) + self._request_content_type = content_type + self._request_content_length = path.stat().st_size + + def set_request_body(self, content_type: str, data: bytes) -> None: + self._request_body_data = data + self._request_content_type = content_type + self._request_content_length = len(data) + + def set_response_body_path(self, path: Path) -> None: + self._response_body_file = Gio.File.new_for_path(str(path)) + + def post(self, + uri_string: str, + timeout: Optional[int] = None, + callback: Optional[Callable[[], Any]] = None + ) -> None: + + if callback is not None: + self.subscribe('finished', callback) + + self._send('POST', uri_string, timeout=timeout) + + def get(self, + uri_string: str, + timeout: Optional[int] = None, + callback: Optional[Callable[[], Any]] = None + ) -> None: + + if callback is not None: + self.subscribe('finished', callback) + + self._send('GET', uri_string, timeout=timeout) + + def _send(self, + method: HTTP_METHODS_T, + uri_string: str, + timeout: Optional[int] = None + ) -> None: + + if self._is_finished: + raise ValueError('Session already finished') + + self._method = method + + if self._response_body_file is not None: + self._output_stream = self._response_body_file.replace( + None, + False, + Gio.FileCreateFlags.REPLACE_DESTINATION, + self._cancellable) + + self._uri = GLib.Uri.parse(uri_string, GLib.UriFlags.HAS_PASSWORD) + self._message = Soup.Message.new_from_uri(method, self._uri) + + if self._request_body_data is not None: + self._message.set_request_body_from_bytes( + self._request_content_type, + GLib.Bytes.new(self._request_body_data) + ) + if self._progress_callback is not None: + self._message.connect('wrote-body-data', + self._on_request_body_progress) + + if self._request_body_file is not None: + request_input_stream = self._request_body_file.read( + self._cancellable) + self._message.set_request_body(self._request_content_type, + request_input_stream, + self._request_content_length) + if self._progress_callback is not None: + self._message.connect('wrote-body-data', + self._on_request_body_progress) + + self._message.connect('finished', self._on_finished) + + soup_session = self._session.get_soup_session() + soup_session.send_async(self._message, + GLib.PRIORITY_DEFAULT, + self._cancellable, + self._on_response) + + if timeout is not None: + self._timeout_id = GLib.timeout_add_seconds( + timeout, self._on_timeout) + + self._log.info('Request sent') + + def _on_request_body_progress(self, + _message: Soup.Message, + chunk: int) -> None: + self._sent_size =+ chunk + if self._progress_callback is not None: + self._progress_callback(self, self._get_request_progress()) + + def _on_timeout(self) -> None: + self._timeout_reached = True + self.cancel() + + def _on_response(self, + session: Soup.Session, + result: Gio.AsyncResult + ) -> None: + + self._log.info('Request response received') + try: + self._input_stream = session.send_finish(result) + except Exception as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + self._set_failed(HTTPRequestError.CANCELLED) + else: + self._set_failed(HTTPRequestError.UNKNOWN) + return + + if self._message.get_status() != Soup.Status.OK: + self._set_failed(HTTPRequestError.STATUS_NOT_OK) + return + + headers = self.get_response_headers() + self._response_content_length = headers.get_content_length() + self._response_content_type = headers.get_content_type() + if self._response_content_length == 0: + self._set_failed(HTTPRequestError.MISSING_CONTENT_LENGTH) + return + + self.notify('started') + + thread = Thread(target=self._process_response_thread, + args=(self._response_content_length,)) + thread.start() + + def _process_response_thread(self, content_length: int) -> None: + received_size = 0 + + while True: + try: + data = self._input_stream.read_bytes(CHUNK_SIZE, + self._cancellable) + except GLib.Error as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + result = HTTPRequestError.CANCELLED + else: + result = HTTPRequestError.UNKNOWN + + GLib.idle_add(self._set_thread_result, result) + return + + bytes_ = data.get_data() + if not bytes_: + self._received_size = received_size + GLib.idle_add(self._set_thread_result) + return + + length = len(bytes_) + received_size += length + if received_size > content_length: + GLib.idle_add(self._set_thread_result, + HTTPRequestError.CONTENT_OVERFLOW) + return + + if self._output_stream is None: + self._response_body_data += bytes_ + + else: + + try: + self._output_stream.write_all(bytes_, self._cancellable) + except Exception as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + result = HTTPRequestError.CANCELLED + else: + result = HTTPRequestError.UNKNOWN + + GLib.idle_add(self._set_thread_result, result) + return + + if self._progress_callback is not None and self._method == 'GET': + GLib.idle_add(self._set_thread_progress, received_size) + + def _set_thread_progress(self, received_size: int) -> None: + self._received_size = received_size + self._progress_callback(self, self._get_response_progress()) + + def _set_thread_result(self, + error: Optional[HTTPRequestError] = None + ) -> None: + + if error is None: + self._close_all_streams() + return + + self._set_failed(error) + + def _on_finished(self, _message: Soup.Message) -> None: + self._set_finished() + + def _set_finished(self) -> None: + status = self._message.get_status() + if status == Soup.Status.NONE: + # Message has not been sent, can happen when we cancel the message + # before it is sent. The finished signal triggers before the + # cancelled exception. + return + + if self._is_finished: + return + + headers = self._message.get_response_headers() + content_length = headers.get_content_length() + if self._received_size != content_length: + self._set_failed(HTTPRequestError.INCOMPLETE) + return + + if status != Soup.Status.OK: + self._set_failed(HTTPRequestError.STATUS_NOT_OK) + return + + self._set_complete() + + def _set_failed(self, error: HTTPRequestError) -> None: + self._is_finished = True + if self._timeout_reached: + self._timeout_id = None + self._error = HTTPRequestError.TIMEOUT + else: + self._error = error + self._close_all_streams() + self.notify('finished') + self._cleanup() + + def _set_complete(self) -> None: + self._is_finished = True + self._is_complete = True + self._close_all_streams() + self.notify('finished') + self._cleanup() + + def _close_all_streams(self) -> None: + if self._input_stream is not None: + if not self._input_stream.is_closed(): + self._input_stream.close(None) + + if self._output_stream is not None: + if not self._output_stream.is_closed(): + self._output_stream.close(None) + + def _cleanup(self) -> None: + self._log.info('Run cleanup') + + self._response_body_data = b'' + self._message.run_dispose() + + self._cancellable = None + self._session = None + self._progress_callback = None + self._input_stream = None + self._output_stream = None + self._file = None + + if self._timeout_id is not None: + GLib.source_remove(self._timeout_id) + + self.notify('destroyed') + self.remove_subscriptions() + + def __repr__(self) -> str: + return f'Request({id(self)})' ===================================== nbxmpp/modules/muclumbus.py ===================================== @@ -17,8 +17,6 @@ import json -from gi.repository import Soup - from nbxmpp.namespaces import Namespace from nbxmpp.protocol import Node from nbxmpp.protocol import Iq @@ -44,15 +42,6 @@ class Muclumbus(BaseModule): self._client = client self.handlers = [] - self._proxy_resolver = None - self._soup_session = Soup.Session() - - def set_proxy(self, proxy): - if proxy is None: - return - self._proxy_resolver = proxy.get_resolver() - self._soup_session.props.proxy_resolver = self._proxy_resolver - @iq_request_task def request_parameters(self, jid): task = yield @@ -141,24 +130,25 @@ class Muclumbus(BaseModule): if after is not None: search['after'] = after - message = Soup.Message.new('POST', uri) - message.set_request('application/json', - Soup.MemoryUse.COPY, - json.dumps(search).encode()) + body = json.dumps(search).encode() - response_message = yield message + session = self._client.http_session + request = session.create_request() + request.set_request_body('application/json', body) + request.post(uri) - soup_body = response_message.get_property('response-body') + request = yield request - if response_message.status_code != 200: - self._log.warning(soup_body.data) + if not request.is_complete(): + self._log.warning(f'{request.get_error()} {request.get_status()}') yield MuclumbusResult(first=None, last=None, max=None, end=True, items=[]) - response = json.loads(soup_body.data) + response_body = request.get_data() + response = json.loads(response_body) result = response['result'] items = result.get('items') ===================================== nbxmpp/structs.py ===================================== @@ -30,8 +30,8 @@ from dataclasses import dataclass from dataclasses import field from datetime import datetime -from gi.repository import Soup from gi.repository import Gio +from gi.repository import GLib from nbxmpp.simplexml import Node from nbxmpp.namespaces import Namespace @@ -708,8 +708,9 @@ class ProxyData(NamedTuple): def get_uri(self) -> str: if self.username is not None: - user_pass = Soup.uri_encode('%s:%s' % (self.username, - self.password)) + username = GLib.uri_escape_string(self.username, None, False) + password = GLib.uri_escape_string(self.password, None, False) + user_pass = f'{username}:{password}' return '%s://%s@%s' % (self.type, user_pass, self.host) ===================================== nbxmpp/task.py ===================================== @@ -27,14 +27,14 @@ import logging from enum import IntEnum from functools import wraps -from gi.repository import Soup from gi.repository import GLib -from nbxmpp.modules.base import BaseModule from nbxmpp.simplexml import Node from nbxmpp.errors import is_error from nbxmpp.errors import CancelledError from nbxmpp.errors import TimeoutStanzaError +from nbxmpp.http import HTTPRequest +from nbxmpp.modules.base import BaseModule from nbxmpp.modules.util import make_func_arguments_string @@ -109,8 +109,7 @@ def http_request_task(func): @wraps(func) def func_wrapper(self, *args, callback=None, user_data=None, **kwargs): task = HTTPRequestTask(func(self, *args, **kwargs), - self._log, - self._soup_session) + self._log) return _setup_task(task, self._client, callback, user_data) return func_wrapper @@ -251,7 +250,7 @@ class Task: def _invoke_callbacks(self): for callback in self._done_callbacks: - if isinstance(callback, weakref.WeakMethod): + if isinstance(callback, (weakref.WeakMethod, weakref.ref)): callback = callback() if callback is None: return @@ -377,19 +376,23 @@ class HTTPRequestTask(Task): ''' - _process_types = (Soup.Message,) + _process_types = (HTTPRequest,) - def __init__(self, gen, logger, session): + def __init__(self, gen, logger): super().__init__(gen, logger) - self._session = session - def _run_async(self, message): + def _run_async(self, request: HTTPRequest): # pylint: disable=arguments-renamed - self._session.queue_message(message, self._async_finished, None) + request.subscribe('finished', self._async_finished) + + def _async_finished(self, + request: HTTPRequest, + _signal_name: str): + + if self._state == TaskState.CANCELLED: + return - def _async_finished(self, _session, message, _user_data): - if self._state != TaskState.CANCELLED: - self._next_step(message) + self._next_step(request) def _finalize(self): self._session = None ===================================== nbxmpp/websocket.py ===================================== @@ -22,7 +22,6 @@ from gi.repository import GLib from gi.repository import Gio from nbxmpp.const import TCPState -from nbxmpp.const import ConnectionType from nbxmpp.util import get_websocket_close_string from nbxmpp.util import convert_tls_error_flags from nbxmpp.connection import Connection @@ -35,11 +34,10 @@ class WebsocketConnection(Connection): Connection.__init__(self, *args, **kwargs) self._session = Soup.Session() - self._session.props.ssl_strict = False if self._log.getEffectiveLevel() == logging.INFO: self._session.add_feature( - Soup.Logger.new(Soup.LoggerLogLevel.BODY, -1)) + Soup.Logger.new(Soup.LoggerLogLevel.BODY)) self._websocket = None self._cancellable = Gio.Cancellable() @@ -53,11 +51,12 @@ class WebsocketConnection(Connection): self.state = TCPState.CONNECTING message = Soup.Message.new('GET', self._address.uri) - message.connect('starting', self._check_certificate) + message.connect('accept-certificate', self._check_certificate) message.set_flags(Soup.MessageFlags.NO_REDIRECT) self._session.websocket_connect_async(message, None, ['xmpp'], + GLib.PRIORITY_DEFAULT, self._cancellable, self._on_connect, None) @@ -91,19 +90,20 @@ class WebsocketConnection(Connection): # Soup.Session does this automatically raise NotImplementedError - def _check_certificate(self, message): - https_used, certificate, errors = message.get_https_status() - if not https_used and self._address.type == ConnectionType.PLAIN: - return + def _check_certificate(self, + _message, + certificate, + errors): self._peer_certificate = certificate self._peer_certificate_errors = convert_tls_error_flags(errors) if self._accept_certificate(): - return + return True self.notify('bad-certificate') self._cancellable.cancel() + return False def _on_websocket_message(self, _websocket, _type, message): data = message.get_data().decode() ===================================== test/unit/test_http.py ===================================== @@ -0,0 +1,194 @@ +from time import time +import unittest +from unittest.mock import call +from unittest.mock import Mock +from unittest.mock import patch +import os +from pathlib import Path + +from gi.repository import GLib +from gi.repository import Soup + +from nbxmpp.const import HTTPRequestError +from nbxmpp.http import HTTPSession + + +SMALL_FILE_URL = 'https://gajim.org/downloads/ci/unittest_small_file' +BIG_FILE_URL = 'https://gajim.org/downloads/ci/unittest_big_file' +NO_FILE_URL = 'https://gajim.org/downloads/ci/no-file' + + +# import logging +# consoleloghandler = logging.StreamHandler() +# log = logging.getLogger('nbxmpp.http') +# log.setLevel(logging.DEBUG) +# log.addHandler(consoleloghandler) + + +(a)unittest.skipUnless(os.environ.get('NBXMPP_EXTERNAL_UNIT_TESTS'), + 'ENV var for external tests not set') +class HTTP(unittest.TestCase): + + @classmethod + def setUpClass(cls): + pass + + @classmethod + def tearDownClass(cls): + pass + + def test_in_memory_download_to_file(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.set_response_body_path( + Path('/home/lovetox/Downloads/test123')) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + mainloop.run() + + self.assertTrue(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertIsNone(request.get_error()) + + progress_func.assert_called() + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + def test_in_memory_download(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + mainloop.run() + + self.assertTrue(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertIsNone(request.get_error()) + + progress_func.assert_called() + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + def test_download_cancelled_before_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + GLib.timeout_add(10, request.cancel) + + mainloop.run() + + self.assertFalse(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertEqual(request.get_error(), HTTPRequestError.CANCELLED) + + progress_func.assert_not_called() + n_mock.assert_has_calls([call('finished'), + call('destroyed')]) + + def test_download_cancelled_after_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + def _on_progress(req, progress): + req.cancel() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + request.set_progress_callback(_on_progress) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + mainloop.run() + + self.assertFalse(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertEqual(request.get_error(), HTTPRequestError.CANCELLED) + + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + def test_download_failed_404(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(NO_FILE_URL, timeout=5) + + mainloop.run() + + progress_func.assert_not_called() + n_mock.assert_has_calls([call('finished'), + call('destroyed')]) + + self.assertFalse(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertEqual(request.get_error(), HTTPRequestError.STATUS_NOT_OK) + self.assertEqual(request.get_status(), Soup.Status.NOT_FOUND) + + def test_cancel_with_timeout(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(BIG_FILE_URL, timeout=1) + + mainloop.run() + + self.assertTrue(request.is_finished()) + self.assertFalse(request.is_complete()) + self.assertEqual(request.get_error(), HTTPRequestError.TIMEOUT) + + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + + +if __name__ == '__main__': + unittest.main() ===================================== test/unit/test_muclumbus.py ===================================== @@ -0,0 +1,46 @@ +from __future__ import annotations + +from typing import Any + +from gi.repository import GLib + +import os +import unittest +from unittest.mock import Mock +from nbxmpp.client import Client +from nbxmpp.http import HTTPSession +from nbxmpp.structs import MuclumbusResult +from nbxmpp.modules.muclumbus import Muclumbus + +from nbxmpp.sasl import SCRAM_SHA_1 +from nbxmpp.util import b64encode + +# Test vector from https://wiki.xmpp.org/web/SASL_and_SCRAM-SHA-1 + +API_URL = 'https://search.jabber.network/api/1.0/search' + + +(a)unittest.skipUnless(os.environ.get('NBXMPP_EXTERNAL_UNIT_TESTS'), + 'ENV var for external tests not set') +class TestMuclumbus(unittest.TestCase): + def setUp(self): + self._client = Client() + self._client.set_http_session(HTTPSession()) + self._module = Muclumbus(self._client) + + def test_http_request(self): + + mainloop = GLib.MainLoop() + + def _result(task: Any) -> None: + result = task.finish() + assert isinstance(result, MuclumbusResult) + assert len(result.items) > 0 + mainloop.quit() + + self._module.set_http_search(API_URL, 'gajim', callback=_result) + + mainloop.run() + +if __name__ == '__main__': + unittest.main() View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/3b6cd299eb18cd6e8f6e95af… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/3b6cd299eb18cd6e8f6e95af… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][soup3] change: Port to libsoup3
by Philipp Hörist (＠lovetox) 11 Dec '22

11 Dec '22

Philipp Hörist pushed to branch soup3 at gajim / python-nbxmpp Commits: 73922880 by Philipp Hörist at 2022-12-11T10:00:49+01:00 change: Port to libsoup3 - - - - - 14 changed files: - README.md - debian/control - nbxmpp/__init__.py - nbxmpp/addresses.py - nbxmpp/client.py - nbxmpp/const.py - nbxmpp/examples/client.py - + nbxmpp/http.py - nbxmpp/modules/muclumbus.py - nbxmpp/structs.py - nbxmpp/task.py - nbxmpp/websocket.py - + test/unit/test_http.py - + test/unit/test_muclumbus.py Changes: ===================================== README.md ===================================== @@ -7,7 +7,7 @@ - python >= 3.9.0 - PyGObject - GLib >= 2.60 -- libsoup +- libsoup3 - precis-i18n - packaging - idna ===================================== debian/control ===================================== @@ -6,7 +6,7 @@ Build-Depends: debhelper-compat (= 13), dh-python, libglib2.0-0 (>= 2.60), - gir1.2-soup-2.4, + gir1.2-soup-3.0, python3-all, python3-gi, python3-idna, @@ -24,7 +24,7 @@ Architecture: all Depends: ${misc:Depends}, ${python3:Depends}, libglib2.0-0 (>= 2.60), - gir1.2-soup-2.4, + gir1.2-soup-3.0, python3-gi, python3-idna, python3-packaging, ===================================== nbxmpp/__init__.py ===================================== @@ -2,6 +2,6 @@ import gi from .protocol import * -gi.require_version('Soup', '2.4') +gi.require_version('Soup', '3.0') __version__: str = '3.2.5' ===================================== nbxmpp/addresses.py ===================================== @@ -18,11 +18,13 @@ import logging from collections import namedtuple -from gi.repository import Soup +from gi.repository import GLib +from gi.repository import Gio import nbxmpp +from nbxmpp.http import HTTPRequest, HTTPSession from nbxmpp.util import Observable -from nbxmpp.const import ConnectionType +from nbxmpp.const import ConnectionType, HTTPRequestError from nbxmpp.const import ConnectionProtocol from nbxmpp.util import parse_websocket_uri @@ -63,6 +65,7 @@ class ServerAddresses(Observable): Observable.__init__(self, log) self._domain = domain + self._http_session = None self._custom_host = None self._proxy = None self._is_resolved = False @@ -136,32 +139,41 @@ class ServerAddresses(Observable): self._resolve_alternatives() def _resolve_alternatives(self) -> None: - session = Soup.Session() - session.props.timeout = 5 - session.props.user_agent = f'nbxmpp/{nbxmpp.__version__}' - message = Soup.Message.new( - 'GET', f'https://{self._domain}/.well-known/host-meta') - session.queue_message(message, self._on_alternatives_result) + if self._http_session is None: + self._on_request_resolved() + return + + request = self._http_session.create_request() + request.get(f'https://{self._domain}/.well-known/host-meta', + timeout=5, + callback=self._on_alternatives_result) def _on_alternatives_result(self, - _session: Soup.Session, - message: Soup.Message) -> None: + request: HTTPRequest, + _signal_name: str + ) -> None: + + if not request.is_complete(): + error = request.get_error() + if error == HTTPRequestError.STATUS_NOT_OK: + message = request.get_message() + phrase = message.get_reason_phrase() + log.info('Failed to retrieve host-meta file: %s %s', + request.get_status(), phrase) + else: + log.error('Failed to read response: %s', error) - status = message.props.status_code - if status != Soup.Status.OK: - error = message.props.reason_phrase - log.info('Failed to retrieve host-meta file: %s %s', status, error) self._on_request_resolved() return - response_body = message.props.response_body - if response_body is None or not response_body.data: + response_body = request.get_data() + if not response_body: log.info('No response body data found') self._on_request_resolved() return try: - uri = parse_websocket_uri(response_body.data) + uri = parse_websocket_uri(response_body.decode()) except Exception as error: log.info('Error parsing websocket uri: %s', error) self._on_request_resolved() @@ -215,6 +227,9 @@ class ServerAddresses(Observable): def set_proxy(self, proxy): self._proxy = proxy + def set_http_session(self, session: HTTPSession) -> None: + self._http_session = session + def _on_request_resolved(self): self._is_resolved = True self.notify('resolved') ===================================== nbxmpp/client.py ===================================== @@ -22,6 +22,7 @@ from typing import Optional from gi.repository import GLib from nbxmpp.namespaces import Namespace +from nbxmpp.http import HTTPSession from nbxmpp.protocol import Features from nbxmpp.protocol import StanzaMalformed from nbxmpp.protocol import SessionRequest @@ -93,6 +94,7 @@ class Client(Observable): self._client_cert = None self._client_cert_pass = None self._proxy = None + self._http_session = None self._allowed_con_types = None self._allowed_protocols = None @@ -329,12 +331,18 @@ class Client(Observable): def set_proxy(self, proxy): self._proxy = proxy - self._dispatcher.get_module('Muclumbus').set_proxy(proxy) @property def proxy(self): return self._proxy + def set_http_session(self, session: HTTPSession) -> None: + self._http_session = session + + @property + def http_session(self) -> Optional[HTTPSession]: + return self._http_session + def get_bound_jid(self): return self._jid @@ -402,6 +410,7 @@ class Client(Observable): self.state = StreamState.RESOLVE self._addresses = ServerAddresses(self._domain) + self._addresses.set_http_session(self._http_session) self._addresses.set_custom_host(self._custom_host) self._addresses.set_proxy(self._proxy) self._addresses.subscribe('resolved', self._on_addresses_resolved) ===================================== nbxmpp/const.py ===================================== @@ -453,6 +453,16 @@ class Mode(IntEnum): return self == Mode.ANONYMOUS_TEST +class HTTPRequestError(IntEnum): + UNKNOWN = 0 + MISSING_CONTENT_LENGTH = 1 + INCOMPLETE = 2 + STATUS_NOT_OK = 3 + CANCELLED = 4 + CONTENT_OVERFLOW = 5 + TIMEOUT = 6 + + MOODS = [ 'afraid', 'amazed', ===================================== nbxmpp/examples/client.py ===================================== @@ -6,6 +6,7 @@ import json from pathlib import Path import gi + gi.require_version('Gtk', '3.0') gi.require_version('GLib', '2.0') from gi.repository import Gtk @@ -14,6 +15,7 @@ from gi.repository import GLib import nbxmpp from nbxmpp.protocol import JID from nbxmpp.client import Client +from nbxmpp.http import HTTPSession from nbxmpp.structs import ProxyData from nbxmpp.structs import StanzaHandler from nbxmpp.const import ConnectionType @@ -83,6 +85,7 @@ class TestClient(Gtk.Window): self._client.set_domain(self.address.domain) self._client.set_username(self.address.localpart) self._client.set_resource('test') + self._client.set_http_session(HTTPSession()) proxy_ip = self._builder.proxy_ip.get_text() if proxy_ip: ===================================== nbxmpp/http.py ===================================== @@ -0,0 +1,460 @@ +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +from __future__ import annotations + +from pathlib import Path + +from typing import Any +from typing import Literal +from typing import Callable +from typing import Optional + +import logging +from threading import Thread + +from gi.repository import Soup +from gi.repository import Gio +from gi.repository import GLib +from gi.repository.GObject import Value + +import nbxmpp +from nbxmpp.const import HTTPRequestError +from nbxmpp.util import Observable + + +log = logging.getLogger('nbxmpp.http') + + +HTTP_METHODS_T = Literal['GET', 'POST'] +CHUNK_SIZE = 32768 +DEFAULT_USER_AGENT = f'nbxmpp/{nbxmpp.__version__}' + + +class HTTPLogAdapter(logging.LoggerAdapter): + def process(self, msg: str, kwargs: Any) -> tuple[str, Any]: + return f'{self.extra["request"]}: {msg}', kwargs + + +class HTTPSession: + def __init__(self, user_agent: str = DEFAULT_USER_AGENT) -> None: + self._session = Soup.Session() + self._session.set_user_agent(user_agent) + + self._requests: list[HTTPRequest] = [] + + def get_soup_session(self) -> Soup.Session: + return self._session + + def set_proxy_resolver(self, + resolver: Optional[Gio.SimpleProxyResolver] + ) -> None: + + self._session.set_proxy_resolver(resolver) + + def create_request(self) -> HTTPRequest: + request = HTTPRequest(self) + request.subscribe('destroyed', self._on_request_destroyed) + self._requests.append(request) + return request + + def _on_request_destroyed(self, + request: HTTPRequest, + _signal_name: str + ) -> None: + + self._requests.remove(request) + + +class HTTPRequest(Observable): + + ''' + Signals + - started + - complete + - failed + - cancelled + - destroyed + ''' + + def __init__(self, session: HTTPSession) -> None: + Observable.__init__(self, HTTPLogAdapter(log, extra={'request': self})) + self._session = session + + self._received_size = 0 + self._sent_size = 0 + + self._uri: Optional[GLib.Uri] = None + + self._cancellable = Gio.Cancellable() + self._input_stream: Optional[Gio.InputStream] = None + self._output_stream: Optional[Gio.OutputStream] = None + self._file: Optional[Path] = None + self._is_finished = False + self._error: Optional[HTTPRequestError] = None + self._is_complete = False + self._timeout_reached = False + self._timeout_id = None + + self._response_body_file: Optional[Gio.File] = None + self._response_body_data = b'' + + self._request_body_file: Optional[Gio.File] = None + self._request_body_data: Optional[bytes] = None + + self._request_content_type = '' + self._request_content_length = 0 + + self._response_content_type = '' + self._response_content_length = 0 + + self._message = None + self._method = '' + self._progress_callback: Optional[Callable[..., None]] = None + + self._log.info('Created') + + def is_finished(self) -> bool: + return self._is_finished + + def is_complete(self) -> bool: + return self._is_complete + + def get_error(self) -> Optional[HTTPRequestError]: + return self._error + + def get_response_headers(self) -> int: + return self._message.get_response_headers() + + def get_request_headers(self) -> int: + return self._message.get_request_headers() + + def get_data(self) -> bytes: + if not self._is_finished: + raise ValueError('Process not finished, data not available') + return self._response_body_data + + def get_uri(self) -> Optional[GLib.Uri]: + return self._uri + + def get_file_path(self) -> Optional[Gio.File]: + return self._file + + def get_status(self) -> Soup.Status: + return self._message.get_status() + + def get_message(self) -> Soup.Message: + return self._message + + def _get_response_progress(self) -> float: + if self._received_size == 0: + return 0 + + return self._received_size / self._response_content_length + + def _get_request_progress(self) -> float: + if self._sent_size == 0: + return 0 + return self._sent_size / self._request_content_length + + def cancel(self) -> None: + if self._is_finished: + raise ValueError('Session already finished') + + self._cancellable.cancel() + + def set_progress_callback(self, func: Any) -> None: + self._progress_callback = func + + def set_request_body_from_path(self, content_type: str, path: Path) -> None: + if not path.exists(): + raise ValueError('%s does not exist', path) + + if not path.is_file(): + raise ValueError('%s is not a file', path) + + self._request_body_file = Gio.File.new_for_path(str(path)) + self._request_content_type = content_type + self._request_content_length = path.stat().st_size + + def set_request_body(self, content_type: str, data: bytes) -> None: + self._request_body_data = data + self._request_content_type = content_type + self._request_content_length = len(data) + + def set_response_body_path(self, path: Path) -> None: + self._response_body_file = Gio.File.new_for_path(str(path)) + + def post(self, + uri_string: str, + timeout: Optional[int] = None, + callback: Optional[Callable[[], Any]] = None + ) -> None: + + if callback is not None: + self.subscribe('finished', callback) + + self._send('POST', uri_string, timeout=timeout) + + def get(self, + uri_string: str, + timeout: Optional[int] = None, + callback: Optional[Callable[[], Any]] = None + ) -> None: + + if callback is not None: + self.subscribe('finished', callback) + + self._send('GET', uri_string, timeout=timeout) + + def _send(self, + method: HTTP_METHODS_T, + uri_string: str, + timeout: Optional[int] = None + ) -> None: + + if self._is_finished: + raise ValueError('Session already finished') + + self._method = method + + if self._response_body_file is not None: + self._output_stream = self._response_body_file.replace( + None, + False, + Gio.FileCreateFlags.REPLACE_DESTINATION, + self._cancellable) + + self._uri = GLib.Uri.parse(uri_string, GLib.UriFlags.HAS_PASSWORD) + self._message = Soup.Message.new_from_uri(method, self._uri) + + if self._request_body_data is not None: + self._message.set_request_body_from_bytes( + self._request_content_type, + GLib.Bytes.new(self._request_body_data) + ) + if self._progress_callback is not None: + self._message.connect('wrote-body-data', + self._on_request_body_progress) + + if self._request_body_file is not None: + request_input_stream = self._request_body_file.read( + self._cancellable) + self._message.set_request_body(self._request_content_type, + request_input_stream, + self._request_content_length) + if self._progress_callback is not None: + self._message.connect('wrote-body-data', + self._on_request_body_progress) + + self._message.connect('finished', self._on_finished) + + soup_session = self._session.get_soup_session() + soup_session.send_async(self._message, + GLib.PRIORITY_DEFAULT, + self._cancellable, + self._on_response) + + if timeout is not None: + self._timeout_id = GLib.timeout_add_seconds( + timeout, self._on_timeout) + + self._log.info('Request sent') + + def _on_request_body_progress(self, + message: Soup.Message, + chunk: int) -> None: + self._sent_size =+ chunk + if self._progress_callback is not None: + self._progress_callback(self, self._get_request_progress()) + + def _on_timeout(self) -> None: + self._timeout_reached = True + self.cancel() + + def _on_response(self, + session: Soup.Session, + result: Gio.AsyncResult + ) -> None: + + self._log.info('Request response received') + try: + self._input_stream = session.send_finish(result) + except Exception as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + self._set_failed(HTTPRequestError.CANCELLED) + else: + self._set_failed(HTTPRequestError.UNKNOWN) + return + + if self._message.get_status() != Soup.Status.OK: + self._set_failed(HTTPRequestError.STATUS_NOT_OK) + return + + headers = self.get_response_headers() + self._response_content_length = headers.get_content_length() + self._response_content_type = headers.get_content_type() + if self._response_content_length == 0: + self._set_failed(HTTPRequestError.MISSING_CONTENT_LENGTH) + return + + self.notify('started') + + thread = Thread(target=self._process_response_thread, + args=(self._response_content_length,)) + thread.start() + + def _process_response_thread(self, content_length: int) -> None: + received_size = 0 + + while True: + try: + data = self._input_stream.read_bytes(CHUNK_SIZE, + self._cancellable) + except GLib.Error as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + result = HTTPRequestError.CANCELLED + else: + result = HTTPRequestError.UNKNOWN + + GLib.idle_add(self._set_thread_result, result) + return + + bytes_ = data.get_data() + if not bytes_: + self._received_size = received_size + GLib.idle_add(self._set_thread_result) + return + + length = len(bytes_) + received_size += length + if received_size > content_length: + GLib.idle_add(self._set_thread_result, + HTTPRequestError.CONTENT_OVERFLOW) + return + + if self._output_stream is None: + self._response_body_data += bytes_ + + else: + + try: + self._output_stream.write_all(bytes_, self._cancellable) + except Exception as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + result = HTTPRequestError.CANCELLED + else: + result = HTTPRequestError.UNKNOWN + + GLib.idle_add(self._set_thread_result, result) + return + + if self._progress_callback is not None and self._method == 'GET': + GLib.idle_add(self._set_thread_progress, received_size) + + def _set_thread_progress(self, received_size: int) -> None: + self._received_size = received_size + self._progress_callback(self, self._get_response_progress()) + + def _set_thread_result(self, + error: Optional[HTTPRequestError] = None + ) -> None: + + if error is None: + self._close_all_streams() + return + + self._set_failed(error) + + def _on_finished(self, message: Soup.Message) -> None: + self._set_finished() + + def _set_finished(self) -> None: + status = self._message.get_status() + if status == Soup.Status.NONE: + # Message has not been sent, can happen when we cancel the message + # before it is sent. The finished signal triggers before the + # cancelled exception. + return + + if self._is_finished: + return + + headers = self._message.get_response_headers() + content_length = headers.get_content_length() + if self._received_size != content_length: + self._set_failed(HTTPRequestError.INCOMPLETE) + return + + if status != Soup.Status.OK: + self._set_failed(HTTPRequestError.STATUS_NOT_OK) + return + + self._set_complete() + + def _set_failed(self, error: HTTPRequestError) -> None: + self._is_finished = True + if self._timeout_reached: + self._timeout_id = None + self._error = HTTPRequestError.TIMEOUT + else: + self._error = error + self._close_all_streams() + self.notify('finished') + self._cleanup() + + def _set_complete(self) -> None: + self._is_finished = True + self._is_complete = True + self._close_all_streams() + self.notify('finished') + self._cleanup() + + def _close_all_streams(self) -> None: + if self._input_stream is not None: + if not self._input_stream.is_closed(): + self._input_stream.close(None) + + if self._output_stream is not None: + if not self._output_stream.is_closed(): + self._output_stream.close(None) + + def _cleanup(self) -> None: + self._log.info('Run cleanup') + + self._response_body_data = b'' + self._message.run_dispose() + + self._cancellable = None + self._session = None + self._progress_callback = None + self._input_stream = None + self._output_stream = None + self._file = None + + if self._timeout_id is not None: + GLib.source_remove(self._timeout_id) + + self.notify('destroyed') + self.remove_subscriptions() + + def __repr__(self) -> str: + return f'Request({id(self)})' ===================================== nbxmpp/modules/muclumbus.py ===================================== @@ -17,14 +17,12 @@ import json -from gi.repository import Soup - from nbxmpp.namespaces import Namespace from nbxmpp.protocol import Node from nbxmpp.protocol import Iq from nbxmpp.structs import MuclumbusItem from nbxmpp.structs import MuclumbusResult -from nbxmpp.const import AnonymityMode +from nbxmpp.const import AnonymityMode, HTTPRequestError from nbxmpp.modules.dataforms import extend_form from nbxmpp.errors import StanzaError from nbxmpp.errors import MalformedStanzaError @@ -44,15 +42,6 @@ class Muclumbus(BaseModule): self._client = client self.handlers = [] - self._proxy_resolver = None - self._soup_session = Soup.Session() - - def set_proxy(self, proxy): - if proxy is None: - return - self._proxy_resolver = proxy.get_resolver() - self._soup_session.props.proxy_resolver = self._proxy_resolver - @iq_request_task def request_parameters(self, jid): task = yield @@ -141,24 +130,25 @@ class Muclumbus(BaseModule): if after is not None: search['after'] = after - message = Soup.Message.new('POST', uri) - message.set_request('application/json', - Soup.MemoryUse.COPY, - json.dumps(search).encode()) + body = json.dumps(search).encode() - response_message = yield message + session = self._client.http_session + request = session.create_request() + request.set_request_body('application/json', body) + request.post(uri) - soup_body = response_message.get_property('response-body') + request = yield request - if response_message.status_code != 200: - self._log.warning(soup_body.data) + if not request.is_complete(): + self._log.warning(f'{request.get_error()} {request.get_status()}') yield MuclumbusResult(first=None, last=None, max=None, end=True, items=[]) - response = json.loads(soup_body.data) + response_body = request.get_data() + response = json.loads(response_body) result = response['result'] items = result.get('items') ===================================== nbxmpp/structs.py ===================================== @@ -30,8 +30,8 @@ from dataclasses import dataclass from dataclasses import field from datetime import datetime -from gi.repository import Soup from gi.repository import Gio +from gi.repository import GLib from nbxmpp.simplexml import Node from nbxmpp.namespaces import Namespace @@ -708,8 +708,9 @@ class ProxyData(NamedTuple): def get_uri(self) -> str: if self.username is not None: - user_pass = Soup.uri_encode('%s:%s' % (self.username, - self.password)) + username = GLib.uri_escape_string(self.username, None, False) + password = GLib.uri_escape_string(self.password, None, False) + user_pass = f'{username}:{password}' return '%s://%s@%s' % (self.type, user_pass, self.host) ===================================== nbxmpp/task.py ===================================== @@ -27,14 +27,15 @@ import logging from enum import IntEnum from functools import wraps -from gi.repository import Soup from gi.repository import GLib -from nbxmpp.modules.base import BaseModule +from gi.repository import Gio from nbxmpp.simplexml import Node from nbxmpp.errors import is_error from nbxmpp.errors import CancelledError from nbxmpp.errors import TimeoutStanzaError +from nbxmpp.http import HTTPRequest +from nbxmpp.modules.base import BaseModule from nbxmpp.modules.util import make_func_arguments_string @@ -109,8 +110,7 @@ def http_request_task(func): @wraps(func) def func_wrapper(self, *args, callback=None, user_data=None, **kwargs): task = HTTPRequestTask(func(self, *args, **kwargs), - self._log, - self._soup_session) + self._log) return _setup_task(task, self._client, callback, user_data) return func_wrapper @@ -251,7 +251,7 @@ class Task: def _invoke_callbacks(self): for callback in self._done_callbacks: - if isinstance(callback, weakref.WeakMethod): + if isinstance(callback, (weakref.WeakMethod, weakref.ref)): callback = callback() if callback is None: return @@ -377,19 +377,23 @@ class HTTPRequestTask(Task): ''' - _process_types = (Soup.Message,) + _process_types = (HTTPRequest,) - def __init__(self, gen, logger, session): + def __init__(self, gen, logger): super().__init__(gen, logger) - self._session = session - def _run_async(self, message): + def _run_async(self, request: HTTPRequest): # pylint: disable=arguments-renamed - self._session.queue_message(message, self._async_finished, None) + request.subscribe('finished', self._async_finished) + + def _async_finished(self, + request: HTTPRequest, + signal_name: str): + + if self._state == TaskState.CANCELLED: + return - def _async_finished(self, _session, message, _user_data): - if self._state != TaskState.CANCELLED: - self._next_step(message) + self._next_step(request) def _finalize(self): self._session = None ===================================== nbxmpp/websocket.py ===================================== @@ -22,7 +22,6 @@ from gi.repository import GLib from gi.repository import Gio from nbxmpp.const import TCPState -from nbxmpp.const import ConnectionType from nbxmpp.util import get_websocket_close_string from nbxmpp.util import convert_tls_error_flags from nbxmpp.connection import Connection @@ -35,11 +34,10 @@ class WebsocketConnection(Connection): Connection.__init__(self, *args, **kwargs) self._session = Soup.Session() - self._session.props.ssl_strict = False if self._log.getEffectiveLevel() == logging.INFO: self._session.add_feature( - Soup.Logger.new(Soup.LoggerLogLevel.BODY, -1)) + Soup.Logger.new(Soup.LoggerLogLevel.BODY)) self._websocket = None self._cancellable = Gio.Cancellable() @@ -53,11 +51,12 @@ class WebsocketConnection(Connection): self.state = TCPState.CONNECTING message = Soup.Message.new('GET', self._address.uri) - message.connect('starting', self._check_certificate) + message.connect('accept-certificate', self._check_certificate) message.set_flags(Soup.MessageFlags.NO_REDIRECT) self._session.websocket_connect_async(message, None, ['xmpp'], + GLib.PRIORITY_DEFAULT, self._cancellable, self._on_connect, None) @@ -91,19 +90,20 @@ class WebsocketConnection(Connection): # Soup.Session does this automatically raise NotImplementedError - def _check_certificate(self, message): - https_used, certificate, errors = message.get_https_status() - if not https_used and self._address.type == ConnectionType.PLAIN: - return + def _check_certificate(self, + _message, + certificate, + errors): self._peer_certificate = certificate self._peer_certificate_errors = convert_tls_error_flags(errors) if self._accept_certificate(): - return + return True self.notify('bad-certificate') self._cancellable.cancel() + return False def _on_websocket_message(self, _websocket, _type, message): data = message.get_data().decode() ===================================== test/unit/test_http.py ===================================== @@ -0,0 +1,194 @@ +from time import time +import unittest +from unittest.mock import call +from unittest.mock import Mock +from unittest.mock import patch +import os +from pathlib import Path + +from gi.repository import GLib +from gi.repository import Soup + +from nbxmpp.const import HTTPRequestError +from nbxmpp.http import HTTPSession + + +SMALL_FILE_URL = 'https://gajim.org/downloads/ci/unittest_small_file' +BIG_FILE_URL = 'https://gajim.org/downloads/ci/unittest_big_file' +NO_FILE_URL = 'https://gajim.org/downloads/ci/no-file' + + +# import logging +# consoleloghandler = logging.StreamHandler() +# log = logging.getLogger('nbxmpp.http') +# log.setLevel(logging.DEBUG) +# log.addHandler(consoleloghandler) + + +(a)unittest.skipUnless(os.environ.get('NBXMPP_EXTERNAL_UNIT_TESTS'), + 'ENV var for external tests not set') +class HTTP(unittest.TestCase): + + @classmethod + def setUpClass(cls): + pass + + @classmethod + def tearDownClass(cls): + pass + + def test_in_memory_download_to_file(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.set_response_body_path( + Path('/home/lovetox/Downloads/test123')) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + mainloop.run() + + self.assertTrue(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertIsNone(request.get_error()) + + progress_func.assert_called() + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + def test_in_memory_download(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + mainloop.run() + + self.assertTrue(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertIsNone(request.get_error()) + + progress_func.assert_called() + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + def test_download_cancelled_before_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + GLib.timeout_add(10, request.cancel) + + mainloop.run() + + self.assertFalse(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertEqual(request.get_error(), HTTPRequestError.CANCELLED) + + progress_func.assert_not_called() + n_mock.assert_has_calls([call('finished'), + call('destroyed')]) + + def test_download_cancelled_after_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + def _on_progress(req, progress): + req.cancel() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + request.set_progress_callback(_on_progress) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(SMALL_FILE_URL, timeout=10) + + mainloop.run() + + self.assertFalse(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertEqual(request.get_error(), HTTPRequestError.CANCELLED) + + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + def test_download_failed_404(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(NO_FILE_URL, timeout=5) + + mainloop.run() + + progress_func.assert_not_called() + n_mock.assert_has_calls([call('finished'), + call('destroyed')]) + + self.assertFalse(request.is_complete()) + self.assertTrue(request.is_finished()) + self.assertEqual(request.get_error(), HTTPRequestError.STATUS_NOT_OK) + self.assertEqual(request.get_status(), Soup.Status.NOT_FOUND) + + def test_cancel_with_timeout(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.get(BIG_FILE_URL, timeout=1) + + mainloop.run() + + self.assertTrue(request.is_finished()) + self.assertFalse(request.is_complete()) + self.assertEqual(request.get_error(), HTTPRequestError.TIMEOUT) + + n_mock.assert_has_calls([call('started'), + call('finished'), + call('destroyed')]) + + + +if __name__ == '__main__': + unittest.main() ===================================== test/unit/test_muclumbus.py ===================================== @@ -0,0 +1,46 @@ +from __future__ import annotations + +from typing import Any + +from gi.repository import GLib + +import os +import unittest +from unittest.mock import Mock +from nbxmpp.client import Client +from nbxmpp.http import HTTPSession +from nbxmpp.structs import MuclumbusResult +from nbxmpp.modules.muclumbus import Muclumbus + +from nbxmpp.sasl import SCRAM_SHA_1 +from nbxmpp.util import b64encode + +# Test vector from https://wiki.xmpp.org/web/SASL_and_SCRAM-SHA-1 + +API_URL = 'https://search.jabber.network/api/1.0/search' + + +(a)unittest.skipUnless(os.environ.get('NBXMPP_EXTERNAL_UNIT_TESTS'), + 'ENV var for external tests not set') +class TestMuclumbus(unittest.TestCase): + def setUp(self): + self._client = Client() + self._client.set_http_session(HTTPSession()) + self._module = Muclumbus(self._client) + + def test_http_request(self): + + mainloop = GLib.MainLoop() + + def _result(task: Any) -> None: + result = task.finish() + assert isinstance(result, MuclumbusResult) + assert len(result.items) > 0 + mainloop.quit() + + self._module.set_http_search(API_URL, 'gajim', callback=_result) + + mainloop.run() + +if __name__ == '__main__': + unittest.main() View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/739228806c9eb7caa49fceb7… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/739228806c9eb7caa49fceb7… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] cq: Fix ruff errors
by Daniel Brötzmann (＠wurstsalat) 10 Dec '22

10 Dec '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: 1945cf94 by wurstsalat at 2022-12-10T17:50:41+01:00 cq: Fix ruff errors - - - - - 2 changed files: - gajim/gtk/filechoosers.py - gajim/plugins/pluginmanager.py Changes: ===================================== gajim/gtk/filechoosers.py ===================================== @@ -51,10 +51,10 @@ class BaseFileChooser: _preview_size: tuple[int, int] - def add_filter(self, filter: Gtk.FileFilter) -> None: + def add_filter(self, filter: Gtk.FileFilter) -> None: # noqa pass - def set_filter(self, filter: Gtk.FileFilter) -> None: + def set_filter(self, filter: Gtk.FileFilter) -> None: # noqa pass def _on_response(self, ===================================== gajim/plugins/pluginmanager.py ===================================== @@ -52,6 +52,7 @@ log = logging.getLogger('gajim.p.manager') +RmErrorT = tuple[type[BaseException], BaseException, TracebackType] BLOCKED_PLUGINS = [ 'appindicator_integration', @@ -714,11 +715,9 @@ def install_from_zip(self, return self.add_plugin(manifest) def delete_plugin_files(self, plugin_path: Path) -> None: - ErrorT = tuple[type[BaseException], BaseException, TracebackType] - def _on_error(func: Callable[..., Any], path: Path, - error: ErrorT + error: RmErrorT ) -> None: if func is os.path.islink: View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/1945cf9456dbb96673295e80422be4be… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/1945cf9456dbb96673295e80422be4be… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] cq: Add stubs for css_parser
by Daniel Brötzmann (＠wurstsalat) 10 Dec '22

10 Dec '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: f187e303 by wurstsalat at 2022-12-10T17:41:38+01:00 cq: Add stubs for css_parser - - - - - 6 changed files: - gajim/gtk/css_config.py - pyproject.toml - + typings/css_parser/__init__.pyi - + typings/css_parser/css.pyi - + typings/css_parser/serialize.pyi - + typings/css_parser/stylesheets.pyi Changes: ===================================== gajim/gtk/css_config.py ===================================== @@ -25,14 +25,18 @@ from pathlib import Path import sys +import css_parser +from css_parser.css import CSSStyleSheet +from css_parser.css import CSSStyleRule + from gi.repository import Gtk from gi.repository import Gdk from gi.repository import Pango -import css_parser from gajim.common import app from gajim.common import configpaths -from gajim.common.const import StyleAttr, CSSPriority +from gajim.common.const import StyleAttr +from gajim.common.const import CSSPriority from gajim.common.dbus.system_style import SystemStyleListener from .const import Theme @@ -77,16 +81,16 @@ def __init__(self) -> None: css_parser.ser.prefs.keepEmptyRules = False # Holds the currently selected theme in the Theme Editor - self._pre_css: Optional[css_parser.css.CSSStyleSheet] = None + self._pre_css: Optional[CSSStyleSheet] = None self._pre_css_path: Optional[Path] = None # Holds the default theme, its used if values are not found # in the selected theme - self._default_css: Optional[css_parser.css.CSSStyleSheet] = None + self._default_css: Optional[CSSStyleSheet] = None self._default_css_path: Optional[Path] = None # Holds the currently selected theme - self._css: Optional[css_parser.css.CSSStyleSheet] = None + self._css: Optional[CSSStyleSheet] = None self._css_path: Optional[Path] = None # User Theme CSS Provider @@ -97,8 +101,10 @@ def __init__(self) -> None: self._dynamic_dict: dict[str, str] = {} self.refresh() + screen = Gdk.Screen.get_default() + assert screen is not None Gtk.StyleContext.add_provider_for_screen( - Gdk.Screen.get_default(), + screen, self._dynamic_provider, CSSPriority.APPLICATION) @@ -118,7 +124,7 @@ def __init__(self) -> None: self._activate_theme() Gtk.StyleContext.add_provider_for_screen( - Gdk.Screen.get_default(), + screen, self._provider, CSSPriority.USER_THEME) @@ -180,7 +186,9 @@ def _activate_css(self, css: str, priority: CSSPriority) -> None: try: provider = Gtk.CssProvider() provider.load_from_data(bytes(css.encode('utf-8'))) - Gtk.StyleContext.add_provider_for_screen(Gdk.Screen.get_default(), + screen = Gdk.Screen.get_default() + assert screen is not None + Gtk.StyleContext.add_provider_for_screen(screen, provider, priority) self._load_selected() @@ -198,7 +206,9 @@ def _apply_windows_font_size() -> None: ''' provider = Gtk.CssProvider() provider.load_from_data(bytes(css.encode('utf-8'))) - Gtk.StyleContext.add_provider_for_screen(Gdk.Screen.get_default(), + screen = Gdk.Screen.get_default() + assert screen is not None + Gtk.StyleContext.add_provider_for_screen(screen, provider, CSSPriority.PRE_APPLICATION) @@ -265,6 +275,9 @@ def _write(self, pre: bool) -> None: if pre: path = self._pre_css_path css = self._pre_css + + assert path is not None + assert css is not None with open(path, 'w', encoding='utf-8') as file: file.write(css.cssText.decode('utf-8')) @@ -275,12 +288,14 @@ def _write(self, pre: bool) -> None: def set_value(self, selector: str, - attr: StyleAttr, + attr: Union[str, StyleAttr], value: Union[str, Pango.FontDescription], pre: bool = False ) -> None: + if attr == StyleAttr.FONT: # forward to set_font() for convenience + assert isinstance(value, Pango.FontDescription) self.set_font(selector, value, pre) return @@ -290,6 +305,8 @@ def set_value(self, css = self._css if pre: css = self._pre_css + + assert css is not None for rule in css: if rule.type != rule.STYLE_RULE: continue @@ -303,7 +320,7 @@ def set_value(self, # The rule was not found, so we add it to this theme log.info('Set %s %s %s', selector, attr, value) - rule = css_parser.css.CSSStyleRule(selectorText=selector) + rule = CSSStyleRule(selectorText=selector) rule.style[attr] = value css.add(rule) self._write(pre) @@ -318,6 +335,7 @@ def set_font(self, css = self._pre_css family, size, style, weight = self._get_attr_from_description( description) + assert css is not None for rule in css: if rule.type != rule.STYLE_RULE: continue @@ -338,7 +356,7 @@ def set_font(self, # The rule was not found, so we add it to this theme log.info('Set Font for: %s %s %s %s %s', selector, family, size, style, weight) - rule = css_parser.css.CSSStyleRule(selectorText=selector) + rule = CSSStyleRule(selectorText=selector) rule.style['font-family'] = family rule.style['font-style'] = style rule.style['font-size'] = f'{size}pt' @@ -349,6 +367,7 @@ def set_font(self, def _get_attr_from_description(self, description: Pango.FontDescription ) -> tuple[Optional[str], float, str, int]: + size = description.get_size() / Pango.SCALE style = self._get_string_from_pango_style(description.get_style()) weight = self._pango_to_css_weight(int(description.get_weight())) @@ -357,8 +376,10 @@ def _get_attr_from_description(self, def _get_default_rule(self, selector: str, - _attr: StyleAttr - ) -> Optional[css_parser.css.CSSStyleRule]: + _attr: str + ) -> Optional[CSSStyleRule]: + + assert self._default_css is not None for rule in self._default_css: if rule.type != rule.STYLE_RULE: continue @@ -376,7 +397,9 @@ def get_font(self, else: css = self._css try: - return self._get_from_cache(selector, 'fontdescription') + font_desc = self._get_from_cache(selector, 'fontdescription') + if isinstance(font_desc, Pango.FontDescription): + return font_desc except KeyError: pass @@ -408,6 +431,7 @@ def _get_description_from_css(self, style: Optional[str], weight: Optional[str] ) -> Optional[Pango.FontDescription]: + if family is None: return None desc = Pango.FontDescription() @@ -440,9 +464,10 @@ def _get_string_from_pango_style(style: Pango.Style) -> str: def get_value(self, selector: str, - attr: StyleAttr, + attr: Union[str, StyleAttr], pre: bool = False ) -> Union[str, Pango.FontDescription, None]: + if attr == StyleAttr.FONT: # forward to get_font() for convenience return self.get_font(selector, pre) @@ -482,9 +507,10 @@ def get_value(self, def remove_value(self, selector: str, - attr: StyleAttr, + attr: Union[str, StyleAttr], pre: bool = False ) -> None: + if attr == StyleAttr.FONT: # forward to remove_font() for convenience self.remove_font(selector, pre) @@ -496,6 +522,8 @@ def remove_value(self, css = self._css if pre: css = self._pre_css + + assert css is not None for rule in css: if rule.type != rule.STYLE_RULE: continue @@ -510,6 +538,7 @@ def remove_font(self, selector: str, pre: bool = False) -> None: if pre: css = self._pre_css + assert css is not None for rule in css: if rule.type != rule.STYLE_RULE: continue @@ -566,6 +595,7 @@ def rename_theme(self, old_theme: str, new_theme: str) -> bool: def _activate_theme(self) -> None: log.info('Activate theme') self._invalidate_cache() + assert self._css is not None self._provider.load_from_data(self._css.cssText) def add_new_theme(self, theme: str) -> bool: @@ -588,15 +618,17 @@ def remove_theme(self, theme: str) -> None: def _add_to_cache(self, selector: str, - attr: StyleAttr, + attr: str, value: Union[str, Pango.FontDescription, None] ) -> None: + self._cache[selector + attr] = value def _get_from_cache(self, selector: str, - attr: StyleAttr + attr: str ) -> Union[str, Pango.FontDescription, None]: + return self._cache[selector + attr] def _invalidate_cache(self) -> None: ===================================== pyproject.toml ===================================== @@ -91,6 +91,7 @@ include = [ "gajim/gtk/contacts_flowbox.py", "gajim/gtk/control.py", "gajim/gtk/conversation/*", + "gajim/gtk/css_config.py", "gajim/gtk/dialogs.py", "gajim/gtk/emoji_data_gtk.py", "gajim/gtk/exception.py", ===================================== typings/css_parser/__init__.pyi ===================================== @@ -0,0 +1,18 @@ +from __future__ import annotations + +from typing import Optional +from typing import Union + +from pathlib import Path + +from . import css as css +from . import serialize as serialize +from . import stylesheets as stylesheets +from .stylesheets import MediaList +from .serialize import CSSSerializer + + +ser: CSSSerializer + + +def parseFile(filename: Union[str, Path], href: Optional[str] = ..., media: Union[MediaList, list[str], str, None] = ..., title: Optional[str] = ..., validate: Optional[bool] = ...) -> None: ... ===================================== typings/css_parser/css.pyi ===================================== @@ -0,0 +1,34 @@ +from __future__ import annotations + +from typing import Any + + +class CSSRule: + + STYLE_RULE: int + + +class CSSStyleSheet: + + cssText: bytes + + def __iter__(self) -> CSSStyleRule: ... + def add(self, rule: CSSStyleRule) -> None: ... + + +class CSSStyleRule(CSSRule): + + style: CSSStyleDeclaration + type: int + selectorText: str + + def __init__(self, selectorText: str) -> None: ... + def __next__(self) -> CSSStyleRule: ... + + +class CSSStyleDeclaration: + + def __getitem__(self, cssname: str) -> str: ... + def __setitem__(self, cssname: str, value: Any) -> None: ... + def getPropertyValue(self, property: str) -> Any: ... + def removeProperty(self, property: str) -> None: ... ===================================== typings/css_parser/serialize.pyi ===================================== @@ -0,0 +1,11 @@ +from __future__ import annotations + + +class CSSSerializer: + + prefs: Preferences + + +class Preferences: + + keepEmptyRules: bool ===================================== typings/css_parser/stylesheets.pyi ===================================== @@ -0,0 +1,10 @@ +from __future__ import annotations + + +class MediaList: + ... + + +class StyleSheet: + + cssText: bytes View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/f187e3034a12006ed1d47f360fb4021b… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/f187e3034a12006ed1d47f360fb4021b… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] 10 commits: cq: Plugins: Improve type annotations
by Daniel Brötzmann (＠wurstsalat) 10 Dec '22

10 Dec '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: 73db9f99 by wurstsalat at 2022-12-10T11:24:07+01:00 cq: Plugins: Improve type annotations - - - - - 7ee6b8b9 by wurstsalat at 2022-12-10T11:24:33+01:00 cq: Preferences: Ignore type error - - - - - a9894439 by wurstsalat at 2022-12-10T11:25:05+01:00 cq: Styling: Type annotations - - - - - ba5ef575 by wurstsalat at 2022-12-10T13:12:05+01:00 cq: SynchronizeAccounts: Use better ListStore set method - - - - - 8e7dbb69 by wurstsalat at 2022-12-10T13:12:19+01:00 cq: RosterItemExchange: Use better ListStore set method - - - - - a82b744d by wurstsalat at 2022-12-10T13:15:55+01:00 cq: FileChoosers: Improve type annotations - - - - - 5131ebf8 by wurstsalat at 2022-12-10T13:15:55+01:00 cq: Control: Fix indentation warning - - - - - 7272cc30 by wurstsalat at 2022-12-10T13:15:55+01:00 cq: ComponentSearch: Fix type annotations - - - - - 93e4ed5f by wurstsalat at 2022-12-10T13:15:55+01:00 cq: Assistant: Fix type annotations - - - - - 896be5ed by wurstsalat at 2022-12-10T13:15:55+01:00 cq: Update pyrightconfig - - - - - 11 changed files: - gajim/common/styling.py - gajim/gtk/assistant.py - gajim/gtk/component_search.py - gajim/gtk/control.py - gajim/gtk/filechoosers.py - gajim/gtk/preferences.py - gajim/gtk/roster_item_exchange.py - gajim/gtk/synchronize_accounts.py - gajim/plugins/gajimplugin.py - gajim/plugins/pluginmanager.py - pyproject.toml Changes: ===================================== gajim/common/styling.py ===================================== @@ -14,6 +14,7 @@ from __future__ import annotations +from typing import Any from typing import Union from typing import Match from typing import Optional @@ -100,7 +101,7 @@ class MailAddress(BaseHyperlink): class Block(StyleObject): @classmethod - def from_match(cls, match: Match[str]) -> Block: + def from_match(cls: Any, match: Match[str]) -> Block: return cls(start=match.start(), end=match.end(), text=match.group(cls.name)) ===================================== gajim/gtk/assistant.py ===================================== @@ -23,9 +23,10 @@ from gi.repository import Gdk from gi.repository import Gtk -from gi.repository import Gio from gi.repository import GObject +from gajim.common import app + from .builder import get_builder from .util import EventHelper @@ -51,7 +52,7 @@ def __init__(self, transition_duration: int = 200) -> None: Gtk.ApplicationWindow.__init__(self) EventHelper.__init__(self) - self.set_application(Gio.Application.get_default()) + self.set_application(app.app) self.set_position(Gtk.WindowPosition.CENTER) self.set_show_menubar(False) self.set_name('Assistant') ===================================== gajim/gtk/component_search.py ===================================== @@ -144,8 +144,8 @@ def _search_result_received(self, event: SearchResultReceivedEvent ) -> None: if event.data is None: - error_page = cast(Error, self.get_page('error')) - error_page.set_text(_('Error while receiving search results.')) + self.get_page('error').set_text( + _('Error while receiving search results.')) self.show_page('error') return @@ -320,7 +320,7 @@ def _on_button_press(self, assert store is not None assert path is not None iter_ = store.get_iter(path) - column_values = store[iter_] + column_values = cast(str, store[iter_]) text = ' '.join(column_values) jid = None ===================================== gajim/gtk/control.py ===================================== @@ -496,7 +496,7 @@ def _on_jump_to_end(self, _button: Gtk.Button) -> None: def drag_data_file_transfer(self, selection: Gtk.SelectionData) -> None: app.window.activate_action('send-file', - GLib.Variant('as', selection.get_uris())) + GLib.Variant('as', selection.get_uris())) def get_our_nick(self) -> str: if isinstance(self.contact, GroupchatParticipant): ===================================== gajim/gtk/filechoosers.py ===================================== @@ -48,6 +48,15 @@ def _require_native() -> bool: # Notes: Adding mime types to Gtk.FileFilter forces non-native dialogs class BaseFileChooser: + + _preview_size: tuple[int, int] + + def add_filter(self, filter: Gtk.FileFilter) -> None: + pass + + def set_filter(self, filter: Gtk.FileFilter) -> None: + pass + def _on_response(self, dialog: Union[Gtk.FileChooser, Gtk.FileChooserNative], response: Gtk.ResponseType, ===================================== gajim/gtk/preferences.py ===================================== @@ -13,6 +13,7 @@ # along with Gajim. If not, see <http://www.gnu.org/licenses/>. from __future__ import annotations + from typing import Any from typing import Optional from typing import cast @@ -118,7 +119,7 @@ def get_ui(self): def _add_prefs(self, prefs: list[tuple[str, type[PreferenceBox]]]): for ui_name, klass in prefs: pref_box = getattr(self._ui, ui_name) - pref = klass(self) + pref = klass(self) # pyright: ignore pref_box.add(pref) self._prefs[ui_name] = pref ===================================== gajim/gtk/roster_item_exchange.py ===================================== @@ -142,7 +142,11 @@ def _add(self) -> None: self.show_all() assert isinstance(self._model, Gtk.ListStore) iter_ = self._model.append() - self._model.set(iter_, 0, True, 1, jid, 2, name, 3, groups) + self._model.set(iter_, + {0: True, + 1: jid, + 2: name, + 3: groups}) self._ui.accept_button.set_label(_('Add')) @@ -169,7 +173,11 @@ def _modify(self) -> None: self.show_all() assert isinstance(self._model, Gtk.ListStore) iter_ = self._model.append() - self._model.set(iter_, 0, True, 1, jid, 2, name, 3, groups) + self._model.set(iter_, + {0: True, + 1: jid, + 2: name, + 3: groups}) self._ui.accept_button.set_label(_('Modify')) @@ -190,7 +198,11 @@ def _delete(self) -> None: self.show_all() assert isinstance(self._model, Gtk.ListStore) iter_ = self._model.append() - self._model.set(iter_, 0, True, 1, jid, 2, name, 3, groups) + self._model.set(iter_, + {0: True, + 1: jid, + 2: name, + 3: groups}) self._ui.accept_button.set_label(_('Delete')) ===================================== gajim/gtk/synchronize_accounts.py ===================================== @@ -100,10 +100,8 @@ def _init_accounts(self) -> None: iter_ = model.append() model.set( iter_, - 0, - remote_account, - 1, - app.get_hostname_from_account(remote_account)) + {0: remote_account, + 1: app.get_hostname_from_account(remote_account)}) def _on_next_clicked(self, _button: Gtk.Button) -> None: selection = self._ui.accounts_treeview.get_selection() @@ -146,7 +144,10 @@ def _init_contacts(self): for remote_jid in remote_jid_list: if remote_jid not in local_jid_list: iter_ = model.append() - model.set(iter_, 0, True, 1, remote_jid) + model.set( + iter_, + {0: True, + 1: remote_jid}) def _on_sync_toggled(self, cell: Gtk.CellRendererToggle, path: str) -> None: model = self._ui.contacts_treeview.get_model() ===================================== gajim/plugins/gajimplugin.py ===================================== @@ -23,6 +23,7 @@ from gajim.common import configpaths from gajim.common.events import ApplicationEvent from gajim.common.ged import HandlerFuncT +from gajim.common.modules.base import BaseModule from gajim.common.types import PluginExtensionPoints @@ -77,8 +78,8 @@ class GajimPlugin: events: list[ApplicationEvent] = [] ''' New network event classes to be registered in Network Events Controller. - ''' + modules: list[BaseModule] = [] def __init__(self) -> None: self.config = GajimPluginConfig(self) ===================================== gajim/plugins/pluginmanager.py ===================================== @@ -15,7 +15,9 @@ from __future__ import annotations from typing import Any +from typing import Callable from typing import Optional +from types import TracebackType import os import sys @@ -712,7 +714,13 @@ def install_from_zip(self, return self.add_plugin(manifest) def delete_plugin_files(self, plugin_path: Path) -> None: - def on_error(func, path, error): + ErrorT = tuple[type[BaseException], BaseException, TracebackType] + + def _on_error(func: Callable[..., Any], + path: Path, + error: ErrorT + ) -> None: + if func is os.path.islink: # if symlink os.unlink(path) @@ -720,7 +728,7 @@ def on_error(func, path, error): # access is denied or other raise PluginsystemError(str(error[1])) - rmtree(plugin_path, False, on_error) + rmtree(plugin_path, False, _on_error) def uninstall_plugin(self, plugin: GajimPlugin) -> None: ''' ===================================== pyproject.toml ===================================== @@ -54,6 +54,7 @@ include = [ "gajim/common/setting_values.py", "gajim/common/sound.py", "gajim/common/storage/*", + "gajim/common/styling.py", "gajim/common/task_manager.py", "gajim/common/text_helpers.py", "gajim/gajim.py", @@ -66,6 +67,7 @@ include = [ "gajim/gtk/app_side_bar.py", "gajim/gtk/application.py", "gajim/gtk/apply_button_box.py", + "gajim/gtk/assistant.py", "gajim/gtk/avatar.py", "gajim/gtk/avatar_selector.py", "gajim/gtk/blocking.py", @@ -93,6 +95,7 @@ include = [ "gajim/gtk/emoji_data_gtk.py", "gajim/gtk/exception.py", "gajim/gtk/features.py", + "gajim/gtk/filechoosers.py", "gajim/gtk/file_transfer_selector.py", "gajim/gtk/groupchat_affiliation.py", "gajim/gtk/groupchat_config.py", @@ -123,6 +126,7 @@ include = [ "gajim/gtk/password_dialog.py", "gajim/gtk/pep_config.py", "gajim/gtk/plugins.py", + "gajim/gtk/preferences.py", "gajim/gtk/preview.py", "gajim/gtk/preview_audio.py", "gajim/gtk/preview_audio_analyzer.py", @@ -131,6 +135,7 @@ include = [ "gajim/gtk/remove_account.py", "gajim/gtk/resource_selector.py", "gajim/gtk/roster.py", + "gajim/gtk/roster_item_exchange.py", "gajim/gtk/search_view.py", "gajim/gtk/service_registration.py", "gajim/gtk/sidebar_switcher.py", @@ -139,6 +144,7 @@ include = [ "gajim/gtk/status_message_selector.py", "gajim/gtk/status_selector.py", "gajim/gtk/structs.py", + "gajim/gtk/synchronize_accounts.py", "gajim/gtk/themes.py", "gajim/gtk/tooltips.py", "gajim/gtk/util.py", View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/a6550805a2e7b46c62fff8ac867569f… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/a6550805a2e7b46c62fff8ac867569f… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] cq: Types: Remove obsolete types
by Daniel Brötzmann (＠wurstsalat) 09 Dec '22

09 Dec '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: a6550805 by wurstsalat at 2022-12-09T23:59:07+01:00 cq: Types: Remove obsolete types - - - - - 1 changed file: - gajim/gtk/types.py Changes: ===================================== gajim/gtk/types.py ===================================== @@ -14,7 +14,8 @@ # Types for typechecking -from typing import Union +from __future__ import annotations + from typing import TYPE_CHECKING from typing import TypeVar @@ -22,7 +23,7 @@ if TYPE_CHECKING: - from .control import ChatControl + from .control import ChatControl # noqa: F401 from .conversation.message_widget import MessageWidget # noqa: F401 from .conversation.view import ConversationView # noqa: F401 from .conversation.rows.call import CallRow # noqa: F401 @@ -39,8 +40,4 @@ from .conversation.rows.scroll_hint import ScrollHintRow # noqa: F401 -ControlT = Union['ChatControl'] - -ConversationViewT = Union['ConversationView'] - SomeSurface = TypeVar('SomeSurface', bound=cairo.Surface) View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/a6550805a2e7b46c62fff8ac867569f1… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/a6550805a2e7b46c62fff8ac867569f1… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] cq: Generate ui types without linting errors
by Daniel Brötzmann (＠wurstsalat) 09 Dec '22

09 Dec '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: 9337eeaa by wurstsalat at 2022-12-09T23:51:25+01:00 cq: Generate ui types without linting errors - - - - - 2 changed files: - gajim/gtk/builder.pyi - scripts/generate_ui_types.py Changes: ===================================== gajim/gtk/builder.pyi ===================================== @@ -7,7 +7,9 @@ from gi.repository import Gtk from gi.repository import GtkSource -class Builder(Gtk.Builder): ... +class Builder(Gtk.Builder): + ... + class AccountPageBuilder(Builder): paned: Gtk.Paned @@ -936,131 +938,133 @@ class XmlConsoleBuilder(Builder): @overload -def get_builder(file_name: Literal['account_page.ui'], widgets: list[str] = ...) -> AccountPageBuilder: ... +def get_builder(file_name: Literal['account_page.ui'], widgets: list[str] = ...) -> AccountPageBuilder: ... # noqa @overload -def get_builder(file_name: Literal['account_wizard.ui'], widgets: list[str] = ...) -> AccountWizardBuilder: ... +def get_builder(file_name: Literal['account_wizard.ui'], widgets: list[str] = ...) -> AccountWizardBuilder: ... # noqa @overload -def get_builder(file_name: Literal['add_contact.ui'], widgets: list[str] = ...) -> AddContactBuilder: ... +def get_builder(file_name: Literal['add_contact.ui'], widgets: list[str] = ...) -> AddContactBuilder: ... # noqa @overload -def get_builder(file_name: Literal['advanced_configuration.ui'], widgets: list[str] = ...) -> AdvancedConfigurationBuilder: ... +def get_builder(file_name: Literal['advanced_configuration.ui'], widgets: list[str] = ...) -> AdvancedConfigurationBuilder: ... # noqa @overload -def get_builder(file_name: Literal['app_page.ui'], widgets: list[str] = ...) -> AppPageBuilder: ... +def get_builder(file_name: Literal['app_page.ui'], widgets: list[str] = ...) -> AppPageBuilder: ... # noqa @overload -def get_builder(file_name: Literal['application_menu.ui'], widgets: list[str] = ...) -> ApplicationMenuBuilder: ... +def get_builder(file_name: Literal['application_menu.ui'], widgets: list[str] = ...) -> ApplicationMenuBuilder: ... # noqa @overload -def get_builder(file_name: Literal['assistant.ui'], widgets: list[str] = ...) -> AssistantBuilder: ... +def get_builder(file_name: Literal['assistant.ui'], widgets: list[str] = ...) -> AssistantBuilder: ... # noqa @overload -def get_builder(file_name: Literal['blocking_list.ui'], widgets: list[str] = ...) -> BlockingListBuilder: ... +def get_builder(file_name: Literal['blocking_list.ui'], widgets: list[str] = ...) -> BlockingListBuilder: ... # noqa @overload -def get_builder(file_name: Literal['bookmarks.ui'], widgets: list[str] = ...) -> BookmarksBuilder: ... +def get_builder(file_name: Literal['bookmarks.ui'], widgets: list[str] = ...) -> BookmarksBuilder: ... # noqa @overload -def get_builder(file_name: Literal['call_window.ui'], widgets: list[str] = ...) -> CallWindowBuilder: ... +def get_builder(file_name: Literal['call_window.ui'], widgets: list[str] = ...) -> CallWindowBuilder: ... # noqa @overload -def get_builder(file_name: Literal['certificate.ui'], widgets: list[str] = ...) -> CertificateBuilder: ... +def get_builder(file_name: Literal['certificate.ui'], widgets: list[str] = ...) -> CertificateBuilder: ... # noqa @overload -def get_builder(file_name: Literal['chat_banner.ui'], widgets: list[str] = ...) -> ChatBannerBuilder: ... +def get_builder(file_name: Literal['chat_banner.ui'], widgets: list[str] = ...) -> ChatBannerBuilder: ... # noqa @overload -def get_builder(file_name: Literal['chat_control.ui'], widgets: list[str] = ...) -> ChatControlBuilder: ... +def get_builder(file_name: Literal['chat_control.ui'], widgets: list[str] = ...) -> ChatControlBuilder: ... # noqa @overload -def get_builder(file_name: Literal['chat_list_row.ui'], widgets: list[str] = ...) -> ChatListRowBuilder: ... +def get_builder(file_name: Literal['chat_list_row.ui'], widgets: list[str] = ...) -> ChatListRowBuilder: ... # noqa @overload -def get_builder(file_name: Literal['chat_paned.ui'], widgets: list[str] = ...) -> ChatPanedBuilder: ... +def get_builder(file_name: Literal['chat_paned.ui'], widgets: list[str] = ...) -> ChatPanedBuilder: ... # noqa @overload -def get_builder(file_name: Literal['contact_info.ui'], widgets: list[str] = ...) -> ContactInfoBuilder: ... +def get_builder(file_name: Literal['contact_info.ui'], widgets: list[str] = ...) -> ContactInfoBuilder: ... # noqa @overload -def get_builder(file_name: Literal['emoji_chooser.ui'], widgets: list[str] = ...) -> EmojiChooserBuilder: ... +def get_builder(file_name: Literal['emoji_chooser.ui'], widgets: list[str] = ...) -> EmojiChooserBuilder: ... # noqa @overload -def get_builder(file_name: Literal['exception_dialog.ui'], widgets: list[str] = ...) -> ExceptionDialogBuilder: ... +def get_builder(file_name: Literal['exception_dialog.ui'], widgets: list[str] = ...) -> ExceptionDialogBuilder: ... # noqa @overload -def get_builder(file_name: Literal['file_transfer.ui'], widgets: list[str] = ...) -> FileTransferBuilder: ... +def get_builder(file_name: Literal['file_transfer.ui'], widgets: list[str] = ...) -> FileTransferBuilder: ... # noqa @overload -def get_builder(file_name: Literal['file_transfer_jingle.ui'], widgets: list[str] = ...) -> FileTransferJingleBuilder: ... +def get_builder(file_name: Literal['file_transfer_jingle.ui'], widgets: list[str] = ...) -> FileTransferJingleBuilder: ... # noqa @overload -def get_builder(file_name: Literal['file_transfer_selector.ui'], widgets: list[str] = ...) -> FileTransferSelectorBuilder: ... +def get_builder(file_name: Literal['file_transfer_selector.ui'], widgets: list[str] = ...) -> FileTransferSelectorBuilder: ... # noqa @overload -def get_builder(file_name: Literal['filetransfers.ui'], widgets: list[str] = ...) -> FiletransfersBuilder: ... +def get_builder(file_name: Literal['filetransfers.ui'], widgets: list[str] = ...) -> FiletransfersBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_affiliation.ui'], widgets: list[str] = ...) -> GroupchatAffiliationBuilder: ... +def get_builder(file_name: Literal['groupchat_affiliation.ui'], widgets: list[str] = ...) -> GroupchatAffiliationBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_config.ui'], widgets: list[str] = ...) -> GroupchatConfigBuilder: ... +def get_builder(file_name: Literal['groupchat_config.ui'], widgets: list[str] = ...) -> GroupchatConfigBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_creation.ui'], widgets: list[str] = ...) -> GroupchatCreationBuilder: ... +def get_builder(file_name: Literal['groupchat_creation.ui'], widgets: list[str] = ...) -> GroupchatCreationBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_details.ui'], widgets: list[str] = ...) -> GroupchatDetailsBuilder: ... +def get_builder(file_name: Literal['groupchat_details.ui'], widgets: list[str] = ...) -> GroupchatDetailsBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_info_scrolled.ui'], widgets: list[str] = ...) -> GroupchatInfoScrolledBuilder: ... +def get_builder(file_name: Literal['groupchat_info_scrolled.ui'], widgets: list[str] = ...) -> GroupchatInfoScrolledBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_inviter.ui'], widgets: list[str] = ...) -> GroupchatInviterBuilder: ... +def get_builder(file_name: Literal['groupchat_inviter.ui'], widgets: list[str] = ...) -> GroupchatInviterBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_manage.ui'], widgets: list[str] = ...) -> GroupchatManageBuilder: ... +def get_builder(file_name: Literal['groupchat_manage.ui'], widgets: list[str] = ...) -> GroupchatManageBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_nick_chooser.ui'], widgets: list[str] = ...) -> GroupchatNickChooserBuilder: ... +def get_builder(file_name: Literal['groupchat_nick_chooser.ui'], widgets: list[str] = ...) -> GroupchatNickChooserBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_outcast.ui'], widgets: list[str] = ...) -> GroupchatOutcastBuilder: ... +def get_builder(file_name: Literal['groupchat_outcast.ui'], widgets: list[str] = ...) -> GroupchatOutcastBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_roster.ui'], widgets: list[str] = ...) -> GroupchatRosterBuilder: ... +def get_builder(file_name: Literal['groupchat_roster.ui'], widgets: list[str] = ...) -> GroupchatRosterBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_roster_tooltip.ui'], widgets: list[str] = ...) -> GroupchatRosterTooltipBuilder: ... +def get_builder(file_name: Literal['groupchat_roster_tooltip.ui'], widgets: list[str] = ...) -> GroupchatRosterTooltipBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groupchat_state.ui'], widgets: list[str] = ...) -> GroupchatStateBuilder: ... +def get_builder(file_name: Literal['groupchat_state.ui'], widgets: list[str] = ...) -> GroupchatStateBuilder: ... # noqa @overload -def get_builder(file_name: Literal['groups_post_window.ui'], widgets: list[str] = ...) -> GroupsPostWindowBuilder: ... +def get_builder(file_name: Literal['groups_post_window.ui'], widgets: list[str] = ...) -> GroupsPostWindowBuilder: ... # noqa @overload -def get_builder(file_name: Literal['history_export.ui'], widgets: list[str] = ...) -> HistoryExportBuilder: ... +def get_builder(file_name: Literal['history_export.ui'], widgets: list[str] = ...) -> HistoryExportBuilder: ... # noqa @overload -def get_builder(file_name: Literal['main.ui'], widgets: list[str] = ...) -> MainBuilder: ... +def get_builder(file_name: Literal['main.ui'], widgets: list[str] = ...) -> MainBuilder: ... # noqa @overload -def get_builder(file_name: Literal['mam_preferences.ui'], widgets: list[str] = ...) -> MamPreferencesBuilder: ... +def get_builder(file_name: Literal['mam_preferences.ui'], widgets: list[str] = ...) -> MamPreferencesBuilder: ... # noqa @overload -def get_builder(file_name: Literal['manage_proxies.ui'], widgets: list[str] = ...) -> ManageProxiesBuilder: ... +def get_builder(file_name: Literal['manage_proxies.ui'], widgets: list[str] = ...) -> ManageProxiesBuilder: ... # noqa @overload -def get_builder(file_name: Literal['manage_sounds.ui'], widgets: list[str] = ...) -> ManageSoundsBuilder: ... +def get_builder(file_name: Literal['manage_sounds.ui'], widgets: list[str] = ...) -> ManageSoundsBuilder: ... # noqa @overload -def get_builder(file_name: Literal['message_actions_box.ui'], widgets: list[str] = ...) -> MessageActionsBoxBuilder: ... +def get_builder(file_name: Literal['message_actions_box.ui'], widgets: list[str] = ...) -> MessageActionsBoxBuilder: ... # noqa @overload -def get_builder(file_name: Literal['password_dialog.ui'], widgets: list[str] = ...) -> PasswordDialogBuilder: ... +def get_builder(file_name: Literal['password_dialog.ui'], widgets: list[str] = ...) -> PasswordDialogBuilder: ... # noqa @overload -def get_builder(file_name: Literal['pep_config.ui'], widgets: list[str] = ...) -> PepConfigBuilder: ... +def get_builder(file_name: Literal['pep_config.ui'], widgets: list[str] = ...) -> PepConfigBuilder: ... # noqa @overload -def get_builder(file_name: Literal['plugins.ui'], widgets: list[str] = ...) -> PluginsBuilder: ... +def get_builder(file_name: Literal['plugins.ui'], widgets: list[str] = ...) -> PluginsBuilder: ... # noqa @overload -def get_builder(file_name: Literal['popup_notification_window.ui'], widgets: list[str] = ...) -> PopupNotificationWindowBuilder: ... +def get_builder(file_name: Literal['popup_notification_window.ui'], widgets: list[str] = ...) -> PopupNotificationWindowBuilder: ... # noqa @overload -def get_builder(file_name: Literal['preferences.ui'], widgets: list[str] = ...) -> PreferencesBuilder: ... +def get_builder(file_name: Literal['preferences.ui'], widgets: list[str] = ...) -> PreferencesBuilder: ... # noqa @overload -def get_builder(file_name: Literal['preview.ui'], widgets: list[str] = ...) -> PreviewBuilder: ... +def get_builder(file_name: Literal['preview.ui'], widgets: list[str] = ...) -> PreviewBuilder: ... # noqa @overload -def get_builder(file_name: Literal['preview_audio.ui'], widgets: list[str] = ...) -> PreviewAudioBuilder: ... +def get_builder(file_name: Literal['preview_audio.ui'], widgets: list[str] = ...) -> PreviewAudioBuilder: ... # noqa @overload -def get_builder(file_name: Literal['profile.ui'], widgets: list[str] = ...) -> ProfileBuilder: ... +def get_builder(file_name: Literal['profile.ui'], widgets: list[str] = ...) -> ProfileBuilder: ... # noqa @overload -def get_builder(file_name: Literal['roster.ui'], widgets: list[str] = ...) -> RosterBuilder: ... +def get_builder(file_name: Literal['roster.ui'], widgets: list[str] = ...) -> RosterBuilder: ... # noqa @overload -def get_builder(file_name: Literal['roster_item_exchange.ui'], widgets: list[str] = ...) -> RosterItemExchangeBuilder: ... +def get_builder(file_name: Literal['roster_item_exchange.ui'], widgets: list[str] = ...) -> RosterItemExchangeBuilder: ... # noqa @overload -def get_builder(file_name: Literal['roster_tooltip.ui'], widgets: list[str] = ...) -> RosterTooltipBuilder: ... +def get_builder(file_name: Literal['roster_tooltip.ui'], widgets: list[str] = ...) -> RosterTooltipBuilder: ... # noqa @overload -def get_builder(file_name: Literal['search_view.ui'], widgets: list[str] = ...) -> SearchViewBuilder: ... +def get_builder(file_name: Literal['search_view.ui'], widgets: list[str] = ...) -> SearchViewBuilder: ... # noqa @overload -def get_builder(file_name: Literal['server_info.ui'], widgets: list[str] = ...) -> ServerInfoBuilder: ... +def get_builder(file_name: Literal['server_info.ui'], widgets: list[str] = ...) -> ServerInfoBuilder: ... # noqa @overload -def get_builder(file_name: Literal['service_discovery_window.ui'], widgets: list[str] = ...) -> ServiceDiscoveryWindowBuilder: ... +def get_builder(file_name: Literal['service_discovery_window.ui'], widgets: list[str] = ...) -> ServiceDiscoveryWindowBuilder: ... # noqa @overload -def get_builder(file_name: Literal['shortcuts_window.ui'], widgets: list[str] = ...) -> ShortcutsWindowBuilder: ... +def get_builder(file_name: Literal['shortcuts_window.ui'], widgets: list[str] = ...) -> ShortcutsWindowBuilder: ... # noqa @overload -def get_builder(file_name: Literal['ssl_error_dialog.ui'], widgets: list[str] = ...) -> SslErrorDialogBuilder: ... +def get_builder(file_name: Literal['ssl_error_dialog.ui'], widgets: list[str] = ...) -> SslErrorDialogBuilder: ... # noqa @overload -def get_builder(file_name: Literal['start_chat_dialog.ui'], widgets: list[str] = ...) -> StartChatDialogBuilder: ... +def get_builder(file_name: Literal['start_chat_dialog.ui'], widgets: list[str] = ...) -> StartChatDialogBuilder: ... # noqa @overload -def get_builder(file_name: Literal['synchronize_accounts.ui'], widgets: list[str] = ...) -> SynchronizeAccountsBuilder: ... +def get_builder(file_name: Literal['synchronize_accounts.ui'], widgets: list[str] = ...) -> SynchronizeAccountsBuilder: ... # noqa @overload -def get_builder(file_name: Literal['systray_context_menu.ui'], widgets: list[str] = ...) -> SystrayContextMenuBuilder: ... +def get_builder(file_name: Literal['systray_context_menu.ui'], widgets: list[str] = ...) -> SystrayContextMenuBuilder: ... # noqa @overload -def get_builder(file_name: Literal['themes_window.ui'], widgets: list[str] = ...) -> ThemesWindowBuilder: ... +def get_builder(file_name: Literal['themes_window.ui'], widgets: list[str] = ...) -> ThemesWindowBuilder: ... # noqa @overload -def get_builder(file_name: Literal['video_preview.ui'], widgets: list[str] = ...) -> VideoPreviewBuilder: ... +def get_builder(file_name: Literal['video_preview.ui'], widgets: list[str] = ...) -> VideoPreviewBuilder: ... # noqa @overload -def get_builder(file_name: Literal['workspace_dialog.ui'], widgets: list[str] = ...) -> WorkspaceDialogBuilder: ... +def get_builder(file_name: Literal['workspace_dialog.ui'], widgets: list[str] = ...) -> WorkspaceDialogBuilder: ... # noqa @overload -def get_builder(file_name: Literal['xml_console.ui'], widgets: list[str] = ...) -> XmlConsoleBuilder: ... +def get_builder(file_name: Literal['xml_console.ui'], widgets: list[str] = ...) -> XmlConsoleBuilder: ... # noqa + + def get_builder(file_name: str, widgets: list[str] = ...) -> Builder: ... ===================================== scripts/generate_ui_types.py ===================================== @@ -34,7 +34,9 @@ from gi.repository import GtkSource -class Builder(Gtk.Builder): ... +class Builder(Gtk.Builder): + ... + ''' CLASS_DEF = '\nclass %s(Builder):' @@ -42,9 +44,9 @@ class Builder(Gtk.Builder): ... GET_BUILDER_OVERLOAD = ''' @overload -def get_builder(file_name: Literal['%s'], widgets: list[str] = ...) -> %s: ...''' # noqa +def get_builder(file_name: Literal['%s'], widgets: list[str] = ...) -> %s: ... # noqa''' # noqa -GET_BUILDER = ''' +GET_BUILDER = '''\n\n def get_builder(file_name: str, widgets: list[str] = ...) -> Builder: ...''' View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/9337eeaa77add6b77bfc240477ed4112… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/9337eeaa77add6b77bfc240477ed4112… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] 3 commits: cq: Assistant: Add overloads for add_default_page
by Daniel Brötzmann (＠wurstsalat) 09 Dec '22

09 Dec '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: e726baf5 by wurstsalat at 2022-12-09T23:06:57+01:00 cq: Assistant: Add overloads for add_default_page - - - - - d409b47b by wurstsalat at 2022-12-09T23:34:18+01:00 cq: Assistant: Add overloads for get_page - - - - - 60cf91b8 by wurstsalat at 2022-12-09T23:36:17+01:00 cq: GUI tests: Code formatting and simplifications - - - - - 16 changed files: - gajim/gtk/add_contact.py - gajim/gtk/assistant.py - gajim/gtk/change_password.py - gajim/gtk/component_search.py - gajim/gtk/history_export.py - gajim/gtk/history_sync.py - gajim/gtk/remove_account.py - + test/gtk/__init__.py - test/gtk/assistant.py - test/gtk/certificate_dialog.py - test/gtk/change_password.py - test/gtk/dataform.py - test/gtk/fake_dataform.py - test/gtk/groupchat_info.py - test/gtk/ssl_error_dialog.py - test/no_gui/__init__.py Changes: ===================================== gajim/gtk/add_contact.py ===================================== @@ -40,7 +40,6 @@ from .assistant import Assistant from .assistant import Page from .assistant import ErrorPage -from .assistant import ProgressPage from .groupchat_info import GroupChatInfoScrolled from .builder import get_builder from .util import open_window @@ -76,7 +75,7 @@ def __init__(self, 'gateway': Gateway(), }) - progress = cast(ProgressPage, self.add_default_page('progress')) + progress = self.add_default_page('progress') progress.set_title(_('Gathering information…')) progress.set_text(_('Trying to gather information on this address…')) ===================================== gajim/gtk/assistant.py ===================================== @@ -16,8 +16,10 @@ from typing import Any from typing import Callable -from typing import Optional from typing import cast +from typing import Literal +from typing import Optional +from typing import overload from gi.repository import Gdk from gi.repository import Gtk @@ -149,6 +151,15 @@ def add_pages(self, pages: dict[str, Page]): widget.connect('update-page-complete', self._update_page_complete) self._ui.stack.add_named(widget, name) + @overload + def add_default_page(self, name: Literal['success']) -> SuccessPage: ... + + @overload + def add_default_page(self, name: Literal['error']) -> ErrorPage: ... + + @overload + def add_default_page(self, name: Literal['progress']) -> ProgressPage: ... + def add_default_page(self, name: str) -> Page: if name == 'success': page = SuccessPage() ===================================== gajim/gtk/change_password.py ===================================== @@ -12,8 +12,12 @@ # You should have received a copy of the GNU General Public License # along with Gajim. If not, see <http://www.gnu.org/licenses/>. +from __future__ import annotations + from typing import Any from typing import cast +from typing import Literal +from typing import overload import logging @@ -32,7 +36,6 @@ from .assistant import Assistant from .assistant import Page from .assistant import ErrorPage -from .assistant import ProgressPage from .assistant import SuccessPage from .dataform import DataFormWidget from .util import ensure_not_destroyed @@ -58,7 +61,7 @@ def __init__(self, account: str) -> None: 'error': Error(), 'success': Success()}) - progress = cast(ProgressPage, self.add_default_page('progress')) + progress = self.add_default_page('progress') progress.set_title(_('Changing Password...')) progress.set_text(_('Trying to change password...')) @@ -67,6 +70,21 @@ def __init__(self, account: str) -> None: self.show_all() + @overload + def get_page(self, name: Literal['password']) -> EnterPassword: ... + + @overload + def get_page(self, name: Literal['next_stage']) -> NextStage: ... + + @overload + def get_page(self, name: Literal['error']) -> Error: ... + + @overload + def get_page(self, name: Literal['success']) -> Success: ... + + def get_page(self, name: str) -> Page: + return self._pages[name] + def _on_button_clicked(self, _assistant: Assistant, button_name: str @@ -84,13 +102,11 @@ def _on_button_clicked(self, def _on_apply(self, next_stage: bool = False) -> None: if next_stage: - next_stage_page = cast(NextStage, self.get_page('next_stage')) - form = next_stage_page.get_submit_form() + form = self.get_page('next_stage').get_submit_form() self._client.get_module('Register').change_password_with_form( form, callback=self._on_change_password) else: - password_page = cast(EnterPassword, self.get_page('password')) - password = password_page.get_password() + password = self.get_page('password').get_password() self._client.get_module('Register').change_password( password, callback=self._on_change_password) @@ -99,20 +115,17 @@ def _on_change_password(self, task: Task) -> None: try: task.finish() except ChangePasswordStanzaError as error: - next_stage_page = cast(NextStage, self.get_page('next_stage')) form = cast(SimpleDataForm, error.get_form()) - next_stage_page.set_form(form) + self.get_page('next_stage').set_form(form) self.show_page('next_stage', Gtk.StackTransitionType.SLIDE_LEFT) except StanzaError as error: error_text = to_user_string(error) - error_page = cast(Error, self.get_page('error')) - error_page.set_text(error_text) + self.get_page('error').set_text(error_text) self.show_page('error', Gtk.StackTransitionType.SLIDE_LEFT) else: - password_page = cast(EnterPassword, self.get_page('password')) - password = password_page.get_password() + password = self.get_page('password').get_password() passwords.save_password(self.account, password) self.show_page('success') ===================================== gajim/gtk/component_search.py ===================================== @@ -14,9 +14,13 @@ # You should have received a copy of the GNU General Public License # along with Gajim. If not, see <http://www.gnu.org/licenses/>. +from __future__ import annotations + from typing import cast from typing import Any +from typing import Literal from typing import Optional +from typing import overload from typing import Union import logging @@ -75,7 +79,7 @@ def __init__(self, 'error': Error() }) - progress = cast(ProgressPage, self.add_default_page('progress')) + progress = self.add_default_page('progress') progress.set_title(_('Searching')) progress.set_text(_('Searching…')) @@ -91,13 +95,28 @@ def __init__(self, self.show_all() + @overload + def get_page(self, name: Literal['prepare']) -> RequestForm: ... + + @overload + def get_page(self, name: Literal['form']) -> SearchForm: ... + + @overload + def get_page(self, name: Literal['result']) -> Result: ... + + @overload + def get_page(self, name: Literal['error']) -> Error: ... + + def get_page(self, name: str) -> Page: + return self._pages[name] + def _on_button_clicked(self, _assistant: Assistant, button_name: str ) -> None: if button_name == 'search': self.show_page('progress', Gtk.StackTransitionType.SLIDE_LEFT) - form = cast(SearchForm, self.get_page('form')).get_submit_form() + form = self.get_page('form').get_submit_form() self._client.get_module('Search').send_search_form( self._jid, form, True) return @@ -112,13 +131,12 @@ def _on_button_clicked(self, @ensure_not_destroyed def _search_form_received(self, event: SearchFormReceivedEvent) -> None: if not event.is_dataform: - error_page = cast(Error, self.get_page('error')) - error_page.set_text(_('Error while retrieving search form.')) + self.get_page('error').set_text( + _('Error while retrieving search form.')) self.show_page('error') return - form_page = cast(SearchForm, self.get_page('form')) - form_page.process_search_form(event.data) + self.get_page('form').process_search_form(event.data) self.show_page('form') @ensure_not_destroyed @@ -131,8 +149,7 @@ def _search_result_received(self, self.show_page('error') return - result_page = cast(Result, self.get_page('result')) - result_page.process_result(event.data) + self.get_page('result').process_result(event.data) self.show_page('result') def _on_destroy(self, *args: Any) -> None: ===================================== gajim/gtk/history_export.py ===================================== @@ -15,7 +15,9 @@ from __future__ import annotations from typing import cast +from typing import Literal from typing import Optional +from typing import overload import logging import time @@ -33,10 +35,8 @@ from gajim.common.storage.archive import MessageExportRow from .assistant import Assistant -from .assistant import Page from .assistant import ErrorPage -from .assistant import SuccessPage -from .assistant import ProgressPage +from .assistant import Page from .builder import get_builder log = logging.getLogger('gajim.gui.history_export') @@ -58,16 +58,16 @@ def __init__(self, account: Optional[str] = None) -> None: self.add_pages({'start': SelectAccountDir(account)}) - progress_page = cast(ProgressPage, self.add_default_page('progress')) + progress_page = self.add_default_page('progress') progress_page.set_title(_('Exporting History...')) progress_page.set_text(_('Exporting your messages...')) - success_page = cast(SuccessPage, self.add_default_page('success')) + success_page = self.add_default_page('success') success_page.set_title(_('Export Finished')) success_page.set_text( _('Your messages have been exported successfully')) - error_page = cast(ErrorPage, self.add_default_page('error')) + error_page = self.add_default_page('error') error_page.set_title(_('Error while Exporting')) error_page.set_text( _('An error occurred while exporting your messages')) @@ -75,6 +75,15 @@ def __init__(self, account: Optional[str] = None) -> None: self.connect('button-clicked', self._on_button_clicked) self.show_all() + @overload + def get_page(self, name: Literal['error']) -> ErrorPage: ... + + @overload + def get_page(self, name: Literal['start']) -> SelectAccountDir: ... + + def get_page(self, name: str) -> Page: + return self._pages[name] + @staticmethod def _visible_func(_assistant: Assistant, page_name: str) -> list[str]: if page_name == 'start': @@ -105,7 +114,7 @@ def _on_button_clicked(self, self.destroy() def _on_export(self) -> None: - start_page = cast(SelectAccountDir, self.get_page('start')) + start_page = self.get_page('start') account, directory = start_page.get_account_and_directory() current_time = datetime.now() @@ -123,8 +132,7 @@ def _on_export(self) -> None: try: file_path.mkdir(parents=True, exist_ok=True) except OSError as err: - error_page = cast(ErrorPage, self.get_page('error')) - error_page.set_text( + self.get_page('error').set_text( _('An error occurred while trying to create a ' 'file at %(path)s: %(error)s') % { 'path': file_path, ===================================== gajim/gtk/history_sync.py ===================================== @@ -15,7 +15,9 @@ from __future__ import annotations from typing import cast +from typing import Literal from typing import Optional +from typing import overload import logging from datetime import datetime @@ -85,7 +87,7 @@ def __init__(self, account: str) -> None: }) self.add_default_page('success') - success_page = cast(SuccessPage, self.get_page('success')) + success_page = self.get_page('success') success_page.set_title(_('Synchronize Chat History')) success_page.set_heading(_('Finished')) @@ -108,6 +110,18 @@ def __init__(self, account: str) -> None: self.show_all() + @overload + def get_page(self, name: Literal['select']) -> SelectTime: ... + + @overload + def get_page(self, name: Literal['progress']) -> Progress: ... + + @overload + def get_page(self, name: Literal['success']) -> SuccessPage: ... + + def get_page(self, name: str) -> Page: + return self._pages[name] + @staticmethod def _visible_func(_assistant: Assistant, page_name: str) -> list[str]: if page_name == 'select': @@ -134,7 +148,7 @@ def _on_button_clicked(self, self.destroy() def _prepare_query(self) -> None: - select_time_page = cast(SelectTime, self.get_page('select')) + select_time_page = self.get_page('select') self._timedelta = select_time_page.get_timedelta() if self._timedelta is not None: self._start = self._now - self._timedelta @@ -159,8 +173,7 @@ def _received_count(self, task: Task) -> None: return if result.rsm.count is not None: - progress_page = cast(Progress, self.get_page('progress')) - progress_page.set_count(int(result.rsm.count)) + self.get_page('progress').set_count(int(result.rsm.count)) mam_module = self._client.get_module('MAM') self._query_id = mam_module.request_archive_interval( self._start, self._end) @@ -171,10 +184,10 @@ def _received_finished(self, event: ArchivingIntervalFinished) -> None: return self._query_id = None log.info('Query finished') - progress_page = cast(Progress, self.get_page('progress')) + progress_page = self.get_page('progress') GLib.idle_add(progress_page.set_finished) received_count = progress_page.get_received_count() - success_page = cast(SuccessPage, self.get_page('success')) + success_page = self.get_page('success') success_page.set_text(_('Finished synchronising chat history:\n' '%s messages downloaded') % received_count) self.show_page('success') @@ -185,7 +198,7 @@ def _mam_message_received(self, event: RawMamMessageReceived) -> None: return log.debug('Received message') - progress_page = cast(Progress, self.get_page('progress')) + progress_page = self.get_page('progress') GLib.idle_add(progress_page.set_fraction) ===================================== gajim/gtk/remove_account.py ===================================== @@ -12,8 +12,11 @@ # You should have received a copy of the GNU General Public License # along with Gajim. If not, see <http://www.gnu.org/licenses/>. +from __future__ import annotations + from typing import Any -from typing import cast +from typing import Literal +from typing import overload import logging @@ -32,7 +35,6 @@ from .assistant import Assistant from .assistant import Page -from .assistant import ProgressPage from .assistant import ErrorPage from .assistant import SuccessPage @@ -61,7 +63,7 @@ def __init__(self, account: str) -> None: 'error': Error(), 'success': Success()}) - progress = cast(ProgressPage, self.add_default_page('progress')) + progress = self.add_default_page('progress') progress.set_title(_('Removing Account...')) progress.set_text(_('Trying to remove account...')) @@ -78,6 +80,18 @@ def __init__(self, account: str) -> None: self.show_all() + @overload + def get_page(self, name: Literal['remove_choice']) -> RemoveChoice: ... + + @overload + def get_page(self, name: Literal['error']) -> Error: ... + + @overload + def get_page(self, name: Literal['success']) -> Success: ... + + def get_page(self, name: str) -> Page: + return self._pages[name] + @event_filter(['account']) def _on_account_connected(self, _event: AccountConnected) -> None: self._client = app.get_client(self.account) @@ -93,8 +107,7 @@ def _on_account_disconnected(self, _event: AccountDisconnected) -> None: def _set_remove_from_server_checkbox(self) -> None: enabled = self._client is not None and self._client.state.is_available - remove_choice_page = cast(RemoveChoice, self.get_page('remove_choice')) - remove_choice_page.set_remove_from_server(enabled) + self.get_page('remove_choice').set_remove_from_server(enabled) def _on_button_clicked(self, _assistant: Assistant, @@ -117,7 +130,7 @@ def _on_button_clicked(self, self.destroy() def _on_remove(self, *args: Any) -> None: - remove_choice_page = cast(RemoveChoice, self.get_page('remove_choice')) + remove_choice_page = self.get_page('remove_choice') if remove_choice_page.remove_from_server: assert self._client is not None self._client.set_remove_account(True) @@ -141,8 +154,7 @@ def _on_remove_response(self, task: Task) -> None: self._client.set_remove_account(False) error_text = to_user_string(error) - error_page = cast(Error, self.get_page('error')) - error_page.set_text(error_text) + self.get_page('error').set_text(error_text) self.show_page('error') return ===================================== test/gtk/__init__.py ===================================== @@ -0,0 +1,14 @@ +import gi + + +def require_versions(): + gi.require_versions({'Gdk': '3.0', + 'GLib': '2.0', + 'Gio': '2.0', + 'Gtk': '3.0', + 'GtkSource': '4', + 'GObject': '2.0', + 'Pango': '1.0'}) + + +require_versions() ===================================== test/gtk/assistant.py ===================================== @@ -1,5 +1,3 @@ -import gi -gi.require_version('Gtk', '3.0') from gi.repository import Gtk from gajim.common.const import CSSPriority @@ -10,7 +8,8 @@ from gajim.gui.assistant import Assistant from gajim.gui.assistant import Page -from test.gtk import util +from . import util + util.load_style('gajim.css', CSSPriority.APPLICATION) @@ -46,7 +45,7 @@ def __init__(self): self.show_all() @staticmethod - def _visible_func(_assistant, page_name): + def _visible_func(_assistant: Assistant, page_name: str) -> list[str]: if page_name == 'start': return ['forward'] @@ -60,7 +59,11 @@ def _visible_func(_assistant, page_name): return ['back', 'close'] raise ValueError('page %s unknown' % page_name) - def _on_button_clicked(self, _assistant, button_name): + def _on_button_clicked(self, + _assistant: Assistant, + button_name: str + ) -> None: + page = self.get_current_page() if button_name == 'forward': if page == 'start': @@ -83,7 +86,7 @@ def _on_button_clicked(self, _assistant, button_name): if button_name == 'close': self.destroy() - def _on_page_changed(self, _assistant, page_name): + def _on_page_changed(self, _assistant: Assistant, page_name: str) -> None: if page_name == 'start': self.set_default_button('forward') @@ -114,7 +117,8 @@ def __init__(self): label1.set_justify(Gtk.Justification.CENTER) label1.set_margin_bottom(24) - entry = Gtk.Entry(activates_default=True) + entry = Gtk.Entry() + entry.set_activates_default(True) entry.connect('changed', self._on_changed) self._server = Gtk.CheckButton.new_with_mnemonic('A fancy checkbox') @@ -126,7 +130,7 @@ def __init__(self): self.pack_start(self._server, False, True, 0) self.show_all() - def _on_changed(self, entry): + def _on_changed(self, entry: Gtk.Entry) -> None: self.complete = bool(entry.get_text()) self.update_page_complete() ===================================== test/gtk/certificate_dialog.py ===================================== @@ -1,16 +1,15 @@ -import gi -gi.require_version('Gio', '2.0') -gi.require_version('Gtk', '3.0') from gi.repository import Gio from gi.repository import Gtk +from gajim.common.const import CSSPriority + from gajim import gui gui.init('gtk') -from test.gtk import util -from gajim.common.const import CSSPriority from gajim.gui.certificate_dialog import CertificateDialog +from . import util + util.load_style('gajim.css', CSSPriority.APPLICATION) cert = ''' ===================================== test/gtk/change_password.py ===================================== @@ -2,23 +2,21 @@ from functools import partial -import gi -gi.require_version('Gtk', '3.0') -from gi.repository import Gtk - from nbxmpp.modules.dataforms import create_field from nbxmpp.modules.dataforms import SimpleDataForm +from gi.repository import Gtk + +from gajim.common import app from gajim.common.const import CSSPriority from gajim import gui gui.init('gtk') -from gajim.common import app - from gajim.gui.change_password import ChangePassword -from test.gtk import util +from . import util + util.load_style('gajim.css', CSSPriority.APPLICATION) app.get_client = MagicMock() @@ -32,14 +30,16 @@ form = SimpleDataForm(type_='form', fields=fields) -def _apply(self, next_stage=False): + +def _apply(self: ChangePassword, next_stage: bool = False) -> None: if next_stage: self.get_page('next_stage').get_submit_form() else: self.get_page('next_stage').set_form(form) self.show_page('next_stage', Gtk.StackTransitionType.SLIDE_LEFT) -win = ChangePassword(None) + +win = ChangePassword('') win._on_apply = partial(_apply, win) win.connect('destroy', Gtk.main_quit) ===================================== test/gtk/dataform.py ===================================== @@ -2,21 +2,21 @@ from base64 import b64decode -import gi -gi.require_version('Gtk', '3.0') +from nbxmpp.modules.dataforms import extend_form +from nbxmpp.simplexml import Node + from gi.repository import Gtk -import nbxmpp -from nbxmpp.modules.dataforms import extend_form +from gajim.common import app +from gajim.common.const import CSSPriority from gajim import gui gui.init('gtk') from gajim.gui.dataform import DataFormWidget -from gajim.common.const import CSSPriority -from gajim.common import app -from test.gtk import util +from . import util + util.load_style('gajim.css', CSSPriority.APPLICATION) image = '''iVBORw0KGgoAAAANSUhEUgAAAIwAAAA8CAAAAACRYQ2XAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfiCwQXMiypK @@ -130,10 +130,11 @@ def __init__(self): 'form-width': 435, } self._widget = DataFormWidget( - extend_form(node=nbxmpp.Node(node=FORM)), options) + extend_form(node=Node(node=FORM)), options) self.add(self._widget) self.show() + win = DataFormWindow() win.connect('destroy', Gtk.main_quit) win.show_all() ===================================== test/gtk/fake_dataform.py ===================================== @@ -1,5 +1,3 @@ -import gi -gi.require_version('Gtk', '3.0') from gi.repository import Gtk from gajim import gui @@ -9,7 +7,8 @@ from gajim.gui.dataform import FakeDataFormWidget -from test.gtk import util +from . import util + util.load_style('gajim.css', CSSPriority.APPLICATION) @@ -40,6 +39,7 @@ 'redirect-url': 'https://jabber.at/account/register/' } + class DataFormWindow(Gtk.Window): def __init__(self): Gtk.Window.__init__(self, title='Data Form Test') @@ -48,6 +48,7 @@ def __init__(self): self.add(self._widget) self.show() + win = DataFormWindow() win.connect('destroy', Gtk.main_quit) win.show_all() ===================================== test/gtk/groupchat_info.py ===================================== @@ -1,22 +1,21 @@ from unittest.mock import MagicMock -import gi -gi.require_version('Gtk', '3.0') -from gi.repository import Gtk - from nbxmpp.protocol import Iq from nbxmpp.modules.discovery import parse_disco_info from nbxmpp.structs import MucSubject +from gi.repository import Gtk + from gajim.common import app from gajim.common.const import CSSPriority from gajim import gui gui.init('gtk') -from test.gtk import util from gajim.gui.groupchat_info import GroupChatInfoScrolled +from . import util + util.load_style('gajim.css', CSSPriority.APPLICATION) stanza = Iq(node=''' @@ -97,6 +96,7 @@ app.css_config = MagicMock() app.css_config.get_value = MagicMock(return_value='rgb(100, 100, 255)') + class GroupchatInfo(Gtk.ApplicationWindow): def __init__(self): Gtk.ApplicationWindow.__init__(self) ===================================== test/gtk/ssl_error_dialog.py ===================================== @@ -1,20 +1,17 @@ from unittest.mock import MagicMock -import gi -gi.require_version('Gio', '2.0') -gi.require_version('Gtk', '3.0') from gi.repository import Gio from gi.repository import Gtk from gajim import gui gui.init('gtk') - -from test.gtk import util - from gajim.common import app from gajim.common.const import CSSPriority + from gajim.gui.ssl_error_dialog import SSLErrorDialog +from . import util + util.load_style('gajim.css', CSSPriority.APPLICATION) cert = ''' ===================================== test/no_gui/__init__.py ===================================== @@ -1,5 +1,6 @@ import gi + def require_versions(): gi.require_versions({'Gdk': '3.0', 'GLib': '2.0', @@ -9,4 +10,5 @@ def require_versions(): 'GObject': '2.0', 'Pango': '1.0'}) + require_versions() View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/83f2386574ca78f586b4544ca269bf0… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/83f2386574ca78f586b4544ca269bf0… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] 2 commits: cq: Move remove_invalid_xml_chars method and add test
by Daniel Brötzmann (＠wurstsalat) 09 Dec '22

09 Dec '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: 6b9cb548 by wurstsalat at 2022-12-09T22:10:57+01:00 cq: Move remove_invalid_xml_chars method and add test - - - - - 83f23865 by wurstsalat at 2022-12-09T22:25:05+01:00 cq: Tests: Code formatting, simplifications - - - - - 10 changed files: - gajim/common/helpers.py - gajim/common/text_helpers.py - gajim/gtk/chat_stack.py - test/no_gui/test_contacts.py - test/no_gui/test_gtk_menus.py - test/no_gui/test_gtk_util.py - test/no_gui/test_nick_completion.py - test/no_gui/test_regex.py - test/no_gui/test_styling.py - test/no_gui/test_text_helpers.py Changes: ===================================== gajim/common/helpers.py ===================================== @@ -100,7 +100,6 @@ from gajim.common.const import SHOW_LIST from gajim.common.const import CONSONANTS from gajim.common.const import VOWELS -from gajim.common.regex import INVALID_XML_CHARS_REGEX from gajim.common.structs import URI from gajim.common import types if TYPE_CHECKING: @@ -555,12 +554,6 @@ def get_auth_sha(sid: str, initiator: str, target: str) -> str: (f'{sid}{initiator}{target}').encode()).hexdigest() -def remove_invalid_xml_chars(string_: str) -> str: - if string_: - return re.sub(INVALID_XML_CHARS_REGEX, '', string_) - return string_ - - def get_random_string(count: int = 16) -> str: ''' Create random string of count length ===================================== gajim/common/text_helpers.py ===================================== @@ -12,13 +12,24 @@ # You should have received a copy of the GNU General Public License # along with Gajim. If not, see <http://www.gnu.org/licenses/>. +from __future__ import annotations + +import re + from gi.repository import GLib + from gajim.common import regex # from RFC 3986, 3.3. Path (pchar without unreserved and pct-encoded): _reserved_chars_allowed_in_path_segment = regex.sub_delims + ':@' +def remove_invalid_xml_chars(input_string: str) -> str: + if input_string: + return re.sub(regex.INVALID_XML_CHARS_REGEX, '', input_string) + return input_string + + def escape_iri_path_segment(s: str) -> str: return GLib.Uri.escape_string( s, _reserved_chars_allowed_in_path_segment, True) ===================================== gajim/gtk/chat_stack.py ===================================== @@ -44,14 +44,15 @@ from gajim.common.preview_helpers import split_geo_uri from gajim.common.preview_helpers import format_geo_coords from gajim.common.structs import OutgoingMessage +from gajim.common.text_helpers import remove_invalid_xml_chars from gajim.common.types import ChatContactT -from gajim.gui.dialogs import ErrorDialog from .chat_banner import ChatBanner from .chat_function_page import ChatFunctionPage from .chat_function_page import FunctionMode from .const import TARGET_TYPE_URI_LIST from .control import ChatControl +from .dialogs import ErrorDialog from .message_actions_box import MessageActionsBox from .message_input import MessageInputTextView from .util import EventHelper @@ -736,8 +737,8 @@ def _on_send_message(self) -> None: client = app.get_client(contact.account) - message = helpers.remove_invalid_xml_chars(message) - if message in ('', None, '\n'): + message = remove_invalid_xml_chars(message) + if message in ('', '\n'): return label = self._message_action_box.get_seclabel() ===================================== test/no_gui/test_contacts.py ===================================== @@ -5,7 +5,6 @@ from nbxmpp.protocol import JID from gajim.common import app -from gajim.common.modules.contacts import Contacts from gajim.common.modules.contacts import BareContact from gajim.common.storage.cache import CacheStorage @@ -14,13 +13,12 @@ class ContactTest(unittest.TestCase): def test_contact_object(self): account = 'testacc' jid = JID.from_string('user(a)example.org') - module = Contacts(MagicMock()) app.storage.cache = CacheStorage(in_memory=True) app.storage.cache.init() - contact = BareContact(module._log, jid, account) - contact2 = BareContact(module._log, jid, account) + contact = BareContact(MagicMock(), jid, account) + contact2 = BareContact(MagicMock(), jid, account) self.assertEqual(contact, contact2) self.assertEqual(hash(contact), hash(contact2)) ===================================== test/no_gui/test_gtk_menus.py ===================================== @@ -1,10 +1,11 @@ import unittest +from gajim.common.const import URIType +from gajim.common.const import XmppUriQuery + from gajim import gui gui.init('gtk') -from gajim.common.const import URIType -from gajim.common.const import XmppUriQuery from gajim.gtk.menus import _uri_context_menus from gajim.gtk.menus import _xmpp_uri_context_menus ===================================== test/no_gui/test_gtk_util.py ===================================== @@ -3,7 +3,7 @@ from gajim import gui gui.init('gtk') -from gajim.gtk.util import get_first_grapheme +from gajim.gtk.util import get_first_grapheme # noqa class Test(unittest.TestCase): @@ -20,8 +20,8 @@ def test_get_first_grapheme(self): get_first_grapheme(über), 'u\u0308', über + ' -> ü') woman = '\U0001F469' - zwj = '\u200D' - vs16 = '\uFE0F' + zwj = '\u200D' + vs16 = '\uFE0F' fitz4 = '\U0001F3FD' farmeress = f'{woman}{zwj}\U0001F33E{vs16}' @@ -44,8 +44,8 @@ def test_get_first_grapheme(self): get_first_grapheme(tamil_ni), tamil_ni, 'நி') # Fails 🤷 (returns the first char) - #thai_kam = '\u0E01\u0E33' - #self.assertEqual( + # thai_kam = '\u0E01\u0E33' + # self.assertEqual( # get_first_grapheme(thai_kam), thai_kam, 'กำ') devanagari_ssi = '\u0937\u093F' @@ -53,7 +53,7 @@ def test_get_first_grapheme(self): get_first_grapheme(devanagari_ssi), devanagari_ssi, 'षि') # Only in some locales (e.g., Slovak): - #self.assertEqual( + # self.assertEqual( # get_first_grapheme('ch'), 'ch', 'ch -> ch') # Actually, Gtk.TextIter.forward_cursor_position() doesn't seem to use # tailored algorithms anyway, so even with LANG=sk_SK.UTF-8 this ===================================== test/no_gui/test_nick_completion.py ===================================== @@ -1,11 +1,12 @@ import unittest from unittest.mock import MagicMock +from gajim.common import app + from gajim import gui gui.init('gtk') -from gajim.common import app -from gajim.gui.groupchat_nick_completion import GroupChatNickCompletion +from gajim.gui.groupchat_nick_completion import GroupChatNickCompletion # noqa class Test(unittest.TestCase): ===================================== test/no_gui/test_regex.py ===================================== @@ -26,7 +26,7 @@ 'example-node(a)example.com', 'me@[::1]', 'myself(a)127.13.42.69', - #'myself(a)127.13.42.69/localhost', TODO + # 'myself(a)127.13.42.69/localhost', TODO '#room%irc.example(a)biboumi.xmpp.example', r'here\27s_a_wild_\26_\2fcr%zy\2f_address_for\3a\3cwv\3e(\22IMPS\22)(a)example.com', r'CN=D\27Artagnan\20Saint-Andr\E9,O=Example\20\26\20Company,\20Inc.,DC=example,DC=com(a)st.example.com', ===================================== test/no_gui/test_styling.py ===================================== @@ -19,8 +19,8 @@ app.settings = MagicMock() -app.settings.get.return_value = 'a a- a. scheme' # additional_uri_schemes - +# additional_uri_schemes +app.settings.get = MagicMock(return_value='a a- a. scheme') STYLING = { 'pre cannot have children': { @@ -425,7 +425,7 @@ 'geo:1,', 'geo:,2', - #'geo:1,2,', FIXME: wrongly parsed as valid + # 'geo:1,2,', FIXME: wrongly parsed as valid 'geo:1,,3', 'geo:,2,3', 'geo:1,,', @@ -492,7 +492,7 @@ '我買(a)xn--hoqu73a.xn--j6w193g', '二ノ宮(a)xn--5rtw95l.xn--wgv71a', 'медведь(a)xn----8sbaac5cahfb0b0a.xn--p1ai', - #'संपर्क(a)xn--c2bd4bq1db8d.xn--h2brj9c', fails because of the 2 combining chars in localpart + # 'संपर्क(a)xn--c2bd4bq1db8d.xn--h2brj9c', fails because of the 2 combining chars in localpart ] NONJIDS = [ ===================================== test/no_gui/test_text_helpers.py ===================================== @@ -3,56 +3,73 @@ from gajim.common.text_helpers import escape_iri_path_segment from gajim.common.text_helpers import jid_to_iri from gajim.common.text_helpers import format_duration +from gajim.common.text_helpers import remove_invalid_xml_chars class Test(unittest.TestCase): - def test_escape_iri_path_segment(self): + + def test_remove_invalid_xml_chars(self) -> None: + invalid_chars = [ + '\x0b', + '\udfff', + '\x08' + ] + for char in invalid_chars: + self.assertEqual(remove_invalid_xml_chars(char), '') + + self.assertEqual(remove_invalid_xml_chars(''), '') + self.assertEqual(remove_invalid_xml_chars('ä'), 'ä') + + def test_escape_iri_path_segment(self) -> None: self.assertEqual(escape_iri_path_segment(''), '', '<empty string>') über = 'u\u0308ber' self.assertEqual(escape_iri_path_segment(über), über) + segment = ''.join(chr(c) for c in range(0x20, 0x7F)) self.assertEqual( - escape_iri_path_segment(''.join(chr(c) for c in range(0x20,0x7F))), + escape_iri_path_segment(segment), "%20!%22%23$%25&'()*+,-.%2F0123456789:;%3C=%3E%3F@ABCDEFGHIJKLMN" 'OPQRSTUVWXYZ%5B%5C%5D%5E_%60abcdefghijklmnopqrstuvwxyz%7B%7C%7D~', 'ASCII printable') self.assertEqual(escape_iri_path_segment( - ''.join(chr(c) for c in range(0x01,0x20)) + chr(0x7F)), - ''.join('%%%02X'%c for c in range(0x01,0x20)) + '%7F', + ''.join(chr(c) for c in range(0x01, 0x20)) + chr(0x7F)), + ''.join('%%%02X' % c for c in range(0x01, 0x20)) + '%7F', 'ASCII control (no null)') - - def test_jid_to_iri(self): + def test_jid_to_iri(self) -> None: jid = r'foo@bar' self.assertEqual(jid_to_iri(jid), fr'xmpp:{jid}', jid) jid = r'my\20self@[::1]/home' - self.assertEqual(jid_to_iri(jid), + self.assertEqual( + jid_to_iri(jid), r'xmpp:my%5C20self@%5B::1%5D/home', jid) - def test_format_duration_width(self): - def do(total_seconds, expected): + def test_format_duration_width(self) -> None: + def do(total_seconds: float, expected: str) -> None: self.assertEqual(format_duration(0.0, total_seconds*1e9), expected) - do( 0, '0:00') - do( 60, '0:00') - do( 10*60, '00:00') - do( 60*60, '0:00:00') - do( 10*60*60, '00:00:00') - do(100*60*60, '000:00:00') - - def test_format_duration(self): - def do(duration, expected): - self.assertEqual(format_duration(duration, 100*60*60*1e9), expected) - - do( 1.0, '000:00:00') - do( 999999999.0, '000:00:00') - do( 1000000000.0, '000:00:01') - do( 59999999999.0, '000:00:59') - do( 60000000000.0, '000:01:00') - do( 3599999999999.0, '000:59:59') - do( 3600000000000.0, '001:00:00') + do(0, '0:00') + do(60, '0:00') + do(10 * 60, '00:00') + do(60 * 60, '0:00:00') + do(10 * 60 * 60, '00:00:00') + do(100 * 60 * 60, '000:00:00') + + def test_format_duration(self) -> None: + def do(duration: float, expected: str) -> None: + self.assertEqual( + format_duration(duration, 100 * 60 * 60 * 1e9), + expected) + + do(1.0, '000:00:00') + do(999999999.0, '000:00:00') + do(1000000000.0, '000:00:01') + do(59999999999.0, '000:00:59') + do(60000000000.0, '000:01:00') + do(3599999999999.0, '000:59:59') + do(3600000000000.0, '001:00:00') do(3599999999999999.0, '999:59:59') View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/38ed76210f509541ba970e51bed28d1… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/38ed76210f509541ba970e51bed28d1… You're receiving this email because of your account on dev.gajim.org.

1 0

Jump to page:

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

Commits