spiegel-keyman/linux/keyman-config/keyman_config/gnome_keyboards_util.py
Eberhard Beilharz 596371dde2
feat(linux): improve Sentry error reports
- add breadcrumbs with keyboard details
- add some more information about system
- mark files in `km_config` as to the app belonging
- some refactorings

Test-bot: skip
2025-09-16 18:23:47 +02:00

72 lines
2.4 KiB
Python

#!/usr/bin/python3
import logging
import os
from keyman_config.gsettings import GSettings
from keyman_config.sentry_handling import SentryErrorHandling
# pylint: disable=global-statement
class GnomeKeyboardsUtil():
def __init__(self):
self.input_sources = GSettings('org.gnome.desktop.input-sources')
def read_input_sources(self):
sources = self.input_sources.get('sources')
logging.debug('read sources: %s', sources)
if sources is None:
return []
return sources
def write_input_sources(self, sources):
logging.debug('Setting sources to: %s', sources)
self.input_sources.set('sources', sources, 'a(ss)')
# pylint: disable=invalid-name
__is_gnome_desktop = None
def is_gnome_desktop():
'''
Returns true if system is running Gnome shell or another Gnome desktop
that stores keyboard data under `org.gnome.desktop.input-sources`.
'''
global __is_gnome_desktop
if __is_gnome_desktop is None:
code = os.system('pidof gnome-shell >/dev/null 2>&1')
gnome_env = ('XDG_CURRENT_DESKTOP' in os.environ) and ('gnome' in os.environ['XDG_CURRENT_DESKTOP'].lower())
__is_gnome_desktop = (code == 0) or gnome_env
return __is_gnome_desktop
def _reset_gnome_shell():
# used in unit tests
global __is_gnome_desktop
__is_gnome_desktop = None
def get_ibus_keyboard_id(keyboard, packageDir, language=None, ignore_language=False):
if not keyboard:
return None
sentry = SentryErrorHandling()
kmx_file = os.path.join(packageDir, keyboard['id'] + ".kmx")
if ignore_language:
sentry.add_breadcrumb(category='keyboard', message=f'ibus_keyboard_id(1): {kmx_file}')
return kmx_file
if language is not None and language != '':
logging.debug(language)
sentry.add_breadcrumb(category='keyboard', message=f'ibus_keyboard_id(2): {language}:{kmx_file}')
return f"{language}:{kmx_file}"
if "languages" in keyboard and len(keyboard["languages"]) > 0:
firstLanguage = keyboard["languages"][0]
logging.debug(firstLanguage)
if 'id' in firstLanguage:
sentry.add_breadcrumb(category='keyboard', message=f'ibus_keyboard_id(3): {firstLanguage["id"]}:{kmx_file}')
return f"{firstLanguage['id']}:{kmx_file}"
sentry.add_breadcrumb(category='keyboard', message=f'ibus_keyboard_id(4): {kmx_file}')
return kmx_file