Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Little rework of the systray applet python script #322

Merged
merged 2 commits into from
Feb 20, 2025
Merged

chore: Little rework of the systray applet python script #322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ad71b6
chore: Little rework of the systray applet python script
Antiz96 Feb 20, 2025
5c9ee3d
Add missing docstrings
Antiz96 Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 59 additions & 38 deletions src/lib/tray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,56 +17,68 @@
# Create logger
log = logging.getLogger(__name__)

# Find Icon file
ICON_FILE = None
# Find Icon statefile
ICON_STATEFILE = None

if 'XDG_STATE_HOME' in os.environ:
ICON_FILE = os.path.join(
ICON_STATEFILE = os.path.join(
os.environ['XDG_STATE_HOME'], 'arch-update', 'tray_icon')
elif 'HOME' in os.environ:
ICON_FILE = os.path.join(
ICON_STATEFILE = os.path.join(
os.environ['HOME'], '.local', 'state', 'arch-update', 'tray_icon')
if not os.path.isfile(ICON_FILE):
log.error("State icon file does not exist: %s", ICON_FILE)
if not os.path.isfile(ICON_STATEFILE):
log.error("State icon file does not exist: %s", ICON_STATEFILE)
sys.exit(1)

# Find Updates file
UPDATES_FILE = None
# Find Updates statefile
UPDATES_STATEFILE = None

if 'XDG_STATE_HOME' in os.environ:
UPDATES_FILE = os.path.join(
UPDATES_STATEFILE = os.path.join(
os.environ['XDG_STATE_HOME'], 'arch-update', 'last_updates_check')
elif 'HOME' in os.environ:
UPDATES_FILE = os.path.join(
UPDATES_STATEFILE = os.path.join(
os.environ['HOME'], '.local', 'state', 'arch-update', 'last_updates_check')
if not os.path.isfile(UPDATES_FILE):
log.error("State updates file does not exist: %s", UPDATES_FILE)
if not os.path.isfile(UPDATES_STATEFILE):
log.error("State updates file does not exist: %s", UPDATES_STATEFILE)

# Find translations paths
i18n_paths = []

# Find translations
paths = []
if 'XDG_DATA_DIRS' in os.environ:
paths.extend(os.environ['XDG_DATA_DIRS'].split(":"))
i18n_paths.extend(os.environ['XDG_DATA_DIRS'].split(":"))
if 'XDG_DATA_HOME' in os.environ:
paths.extend(os.environ['XDG_DATA_HOME'].split(":"))
i18n_paths.extend(os.environ['XDG_DATA_HOME'].split(":"))
if 'HOME' in os.environ:
paths.append(os.path.join(
i18n_paths.append(os.path.join(
os.environ['HOME'], '.local', 'share'))
paths.extend(['/usr/share', '/usr/local/share'])
i18n_paths.extend(['/usr/share', '/usr/local/share'])
_ = None
for path in paths:

# Check for transatlation paths based on system language (fallback to default english)
for path in i18n_paths:
french_translation_file = os.path.join(
path, "locale", "fr", "LC_MESSAGES", "Arch-Update.mo")
if os.path.isfile(french_translation_file):
path = os.path.join(path, 'locale')
t = gettext.translation('Arch-Update', localedir=path, fallback=True)
_ = t.gettext
break
swedish_translation_file = os.path.join(
path, "locale", "sv", "LC_MESSAGES", "Arch-Update.mo")
if os.path.isfile(swedish_translation_file):
path = os.path.join(path, 'locale')
t = gettext.translation('Arch-Update', localedir=path, fallback=True)
_ = t.gettext
break
if not _:
t = gettext.translation('Arch-Update', fallback=True)
_ = t.gettext
log.error("No translations found")


# Launch arch-update with desktop file
def arch_update():
""" Launch with desktop file """
"""Launch with desktop file"""
DESKTOP_FILE = None
if 'XDG_DATA_HOME' in os.environ:
DESKTOP_FILE = os.path.join(
Expand All @@ -85,17 +97,19 @@ def arch_update():
DESKTOP_FILE = "/usr/share/applications/arch-update.desktop"
subprocess.run(["gio", "launch", DESKTOP_FILE], check=False)


# User Interface
class ArchUpdateQt6:
""" System Tray using QT6 library """
"""System Tray using QT6 library"""

# Definition of functions to update the icon and the dropdown menu when their respective state files change
def file_changed(self):
""" Update icon and dropdown menu on state file content changes """
"""Update icon and dropdown menu"""
self.update_icon()
self.update_dropdown_menu()

# Update the icon based on the 'try_icon' statefile content
def update_icon(self):
""" Update the tray icon based on the icon state file content """
"""Update icon"""
if self.watcher and not self.iconfile in self.watcher.files():
self.watcher.addPath(self.iconfile)

Expand All @@ -110,8 +124,9 @@ def update_icon(self):
icon = QIcon.fromTheme(contents)
self.tray.setIcon(icon)

# Update the dropdown menu based on the 'last_updates_check' statefile content (including the number and the list of pending updates)
def update_dropdown_menu(self):
""" Update the dropdown with the number / list of pending updates """
"""Update dropdown menu"""
if self.watcher and not self.updatesfile in self.watcher.files():
self.watcher.addPath(self.updatesfile)

Expand All @@ -127,6 +142,7 @@ def update_dropdown_menu(self):
# Remove empty lines
updates_list = [update.strip() for update in updates_list if update.strip()]

# Count the number of pending updates (according to the number of lines of the 'last_updates_check' statefile
updates_count = len(updates_list)

if updates_count == 0:
Expand All @@ -139,32 +155,37 @@ def update_dropdown_menu(self):
self.dropdown_menu.setTitle(_("{updates} updates available").format(updates=updates_count))
self.dropdown_menu.setEnabled(True)

# Update dropdown menu accordingly
# Add the list on pending updates to the dropdown menu
self.dropdown_menu.clear()
if updates_list:
for update in updates_list:
self.dropdown_menu.addAction(update)

# Action to run the arch_update function
def run(self):
""" Start arch-update """
"""Run arch-update"""
arch_update()

# Action to run `arch-update --check`
def check(self):
""" Check for updates """
"""Run check for updates"""
subprocess.run(["arch-update", "--check"], check=False)

# Action to xxit the systray
def exit(self):
""" Close systray process """
"""Exit systray"""
sys.exit(0)

# Start the systray
def __init__(self, iconfile):
""" Start Qt6 System Tray """
"""Start Qt6 System Tray"""

# Variables definition
self.iconfile = iconfile
self.updatesfile = UPDATES_FILE
self.updatesfile = UPDATES_STATEFILE
self.watcher = None

# Application
# General application parameters
app = QApplication(["Arch-Update"])
app.setQuitOnLastWindowClosed(False)

Expand All @@ -177,16 +198,16 @@ def __init__(self, iconfile):
tooltip = _("Arch-Update")
self.tray.setToolTip(tooltip)

# Menu
# Definition of menus titles
menu = QMenu()
menu_launch = QAction(_("Run Arch-Update"))
menu_check = QAction(_("Check for updates"))
menu_exit = QAction(_("Exit"))

# Dynamic dropdown menu to show the update list
# Initialisation of the dynamic dropdown menu
self.dropdown_menu = QMenu(_("Checking for updates..."))

# Add actions to the menu
# Link actions to the menu
menu.addMenu(self.dropdown_menu)
menu.addSeparator()
menu.addAction(menu_launch)
Expand All @@ -199,7 +220,7 @@ def __init__(self, iconfile):

self.tray.setContextMenu(menu)

# File Watcher
# File Watcher (watches for statefiles content changes)
self.watcher = QFileSystemWatcher([self.iconfile, self.updatesfile])
self.watcher.fileChanged.connect(self.file_changed)

Expand All @@ -209,4 +230,4 @@ def __init__(self, iconfile):
app.exec()

if __name__ == "__main__":
ArchUpdateQt6(ICON_FILE)
ArchUpdateQt6(ICON_STATEFILE)