GitLab

at 2022-02-01T16:43:47+01:00

Update man pages

Helpers: Typing

 Please submit bugs at https://dev.gajim.org/gajim/gajim/issues

 .Sh SEE ALSO

 .Xr gajim 1
-.Xr gajim-history-manager 1
 .Os UNIX

 .Sh NAME

 .Nm gajim

-.Nd a Jabber/XMPP client

+.Nd A fully-featured XMPP chat client

 .Sh SYNOPSIS

 .Nm

 .Fl h

 .Op Fl c Ar directory

 .Sh DESCRIPTION

 .Nm

-is a Jabber/XMPP client written in Python and GTK+.

+aims to be an easy to use and fully-featured XMPP client.

+Just chat with your friends or family, easily share pictures and thoughts or

+discuss the news with your groups.

+Chat securely with End-to-End encryption via OMEMO or OpenPGP.

 .Nm

-works nicely with GNOME, yet it does not require it to run.

-.Nm

-is designed for novice and advanced users as one, as well for XMPP

-server admins.

+integrates well with your other devices:

+simply continue conversations on your mobile device.

 .Pp

 XMPP is the Extensible Messaging and Presence Protocol, a set of open

 technologies for instant messaging, presence, multi-party chat, voice

 and video calls, collaboration, lightweight middleware, content

 syndication, and generalized routing of XML data. For more information

-on the XMPP protocol see <https://xmpp.org/about-xmpp/>.

+on the XMPP protocol see <https://xmpp.org/about/>.

 .Sh OPTIONS

 .Bl -tag -width Ds

 .It Fl h Fl Fl help

 .It Fl l Fl Fl loglevel Em subsystem=level Bq , Em subsystem=level Bq Em ...

 Configure logging system.

 Subsystem can be

-.Em gajim.interface ,

-.Em gajim.c.connection ,

-.Em .nbxmpp.client_nb ,

+.Em gajim.c.preview ,

+.Em gajim.gui.preview ,

+.Em .nbxmpp.stream ,

 etc.

+.Pp

 Level can be

 .Em DEBUG ,

 .Em INFO ,

 Cache database file of transports, caps, roster entry, and roster group.

 .It $XDG_CACHE_HOME/gajim/avatars/

 Cache directory of avatars.

-.It $XDG_CACHE_HOME/gajim/vcards/

-Cache directory of vCards (virtual cards).

 .It $XDG_CONFIG_HOME/gajim/

 The config-path used when

 .Op Fl c

 Please submit bugs at

 .Bd -literal -offset indent

 https://dev.gajim.org/gajim/gajim/issues

-https://dev.gajim.org/gajim/gajim-plugins

-https://dev.gajim.org/gajim/python-nbxmpp

+https://dev.gajim.org/gajim/gajim-plugins/issues

+https://dev.gajim.org/gajim/python-nbxmpp/issues

 .Ed

 .Sh SEE ALSO

 .Xr gajim-remote 1
-.Xr gajim-history-manager 1

 from typing import Any

 from typing import Callable

-from typing import Dict

 from typing import Optional

-from typing import List

-from typing import Tuple

 from typing import Union

 import sys

 from nbxmpp.structs import ProxyData

 from nbxmpp.protocol import JID

 from nbxmpp.protocol import InvalidJid

+from nbxmpp.protocol import Iq

+

 from OpenSSL.crypto import X509, load_certificate

 from OpenSSL.crypto import FILETYPE_PEM

+

 from gi.repository import Gio

 from gi.repository import GLib

+

 import precis_i18n.codec  # pylint: disable=unused-import

 from gajim.common import app

         return ngettext('%i min ago',

                         '%i mins ago',

                         minutes,

-                        minutes,

-                        minutes)

+                        str(minutes),

+                        str(minutes))

     return _('Just now')

 def get_sorted_keys(adict):

             app.settings.get_soundevent_settings(sound_event)['path'], loop)

-def check_soundfile_path(file_, dirs=None):

+def check_soundfile_path(file_: str,

+                         dirs: Optional[list[Path]] = None

+                         ) -> Optional[Path]:

     """

     Check if the sound file exists

             return name

     return file_

-def play_sound_file(path_to_soundfile: str, loop: bool = False) -> None:

-    path_to_soundfile = check_soundfile_path(path_to_soundfile)

+def play_sound_file(str_path_to_soundfile: str, loop: bool = False) -> None:

+    path_to_soundfile = check_soundfile_path(str_path_to_soundfile)

     if path_to_soundfile is None:

         return

     return True

-def get_full_jid_from_iq(iq_obj):

+def get_full_jid_from_iq(iq_obj: Iq) -> Optional[str]:

     """

     Return the full jid (with resource) from an iq

     """

         return None

     return parse_jid(str(iq_obj.getFrom()))

-def get_jid_from_iq(iq_obj):

+def get_jid_from_iq(iq_obj: Iq) -> Optional[str]:

     """

     Return the jid (without resource) from an iq

     """

     jid = get_full_jid_from_iq(iq_obj)

+    if jid is None:

+        return None

     return app.get_jid_without_resource(jid)

 def get_auth_sha(sid: str, initiator: str, target: str) -> str:

     return False

-def get_optional_features(account: str) -> List[Namespace]:

-    features = []

+def get_optional_features(account: str) -> list[Namespace]:

+    features: list[str] = []

     if app.settings.get_account_setting(account, 'request_user_data'):

         features.append(Namespace.TUNE + '+notify')

         username, password = settings['user'], settings['pass']

     return ProxyData(type=settings['type'],

-                     host='%s:%s' % (settings['host'], settings['port']),

+                     host=f"{settings['host']}:{settings['port']}",

                      username=username,

                      password=password)

         return False

     return True

-def get_available_emoticon_themes() -> List[str]:

-    files = []

+def get_available_emoticon_themes() -> list[str]:

+    files: list[Path] = []

     for folder in configpaths.get('EMOTICONS').iterdir():

         if not folder.is_dir():

             continue

 class Singleton(type):

-    _instances = {}  # type: Dict[Any, Any]

-    def __call__(cls, *args, **kwargs):

+

+    _instances: dict[Any, Any] = {}

+

+    def __call__(cls, *args: Any, **kwargs: Any):

         if cls not in cls._instances:

             cls._instances[cls] = super(Singleton, cls).__call__(

                 *args, **kwargs)

     return func_wrapper

-def parse_uri_actions(uri: str) -> Tuple[str, Dict[str, str]]:

+def parse_uri_actions(uri: str) -> tuple[str, dict[str, str]]:

     uri = uri[5:]

     if '?' not in uri:

         return 'message', {'jid': uri}

         Gio.AppInfo.launch_default_for_uri(path)

-def file_is_locked(path_to_file):

+def file_is_locked(path_to_file: str) -> bool:

     """

     Return True if file is locked

     NOTE: Windows only.

     return resource

-def get_default_muc_config() -> Dict[str, Union[bool, str]]:

+def get_default_muc_config() -> dict[str, Union[bool, str]]:

     return {

         # XEP-0045 options

         'muc#roomconfig_allowinvites': True,

     if type_ == 'domain' and jid.is_domain:

         return jid

-    raise ValueError('Not a %s JID' % type_)

+    raise ValueError(f'Not a {type_} JID')

 def to_user_string(error: StanzaError) -> str:

     return condition

-def get_groupchat_name(client: types.Client, jid: Union[str, JID]) -> str:

+def get_groupchat_name(client: types.Client, jid: JID) -> str:

     name = client.get_module('Bookmarks').get_name_from_bookmark(jid)

     if name:

         return name

     return load_certificate(FILETYPE_PEM, cert.props.certificate_pem.encode())

-def get_custom_host(account: str) -> Optional[Tuple[str,

+def get_custom_host(account: str) -> Optional[tuple[str,

                                                     ConnectionProtocol,

                                                     ConnectionType]]:

     if not app.settings.get_account_setting(account, 'use_custom_host'):

 def warn_about_plain_connection(account: str,

-                                connection_types: List[ConnectionType]

+                                connection_types: list[ConnectionType]

                                 ) -> bool:

     warn = app.settings.get_account_setting(

         account, 'confirm_unencrypted_connection')

     def update_name(self) -> None:

         if self.type == 'pm':

             client = app.get_client(self.account)

-            muc_name = get_groupchat_name(client, self.jid.bare)

+            muc_name = get_groupchat_name(client, self.jid.new_as_bare())

             self._ui.name_label.set_text(f'{self.contact.name} ({muc_name})')

             return

Daniel Brötzmann pushed to branch master at gajim / gajim

Commits:

4 changed files:

Changes: