ignis

This is primarily a bug-fix release built on top of v0.5, with commits cherry-picked from main.

New Features

• Add support for end_char in Utils.send_socket() (#282)

Fixes

• (HyprlandService) Rename method to match return type (#223)
• (TrackedList) Set attribute instead of emitting signals when notifying changes
• (HyprlandService) Parse event data correctly with multiple ">>" (#222)
• (HyprlandService) Do not convert workspace id to int if it's empty on "activespecialv2"
• (SystemTrayService) Do not init item if another task with the same bus name is already running (#224)
• (NotificationsService) Use correct key when "icon_data" in hints
• (HyprlandService) Sync HyprlandMonitor active workspace data on workspace change (closes: #231)
• (HyprlandService) Do not add object if its data is empty (#229)
• (ListBox) Correct typing for rows property: ListBoxRow -> Gtk.Widget
• (IgnisApp) Inherit parameters passed to apply_css() in reload_css() (#245)
• (ListBox) Update rows property when child list is modified via methods (#246)
• (OptionsGroup) Make to_dict() return all options instead of only modified ones
• Mark bin/ignis as executable
• Rename ignis.logging -> ignis.log_utils to avoid naming collision
• (WifiAccessPoint) Sync connections in _setup()
• (Window) Improve handling of size changes for dynamic_input_region (#274)
• (NiriService) Use end character in send_command() (#283)
• (meson) Correct the project license (closes: #265)

Other

• (workflows) Use correct name of the documentation artifact based on doc tag
• (workflows) Add release.yaml
• Specify license as text in pyproject.toml
• Bump to 0.5.1

Documentation

• Sync

Miscellaneous

• Change project license to LGPL-2.1

It took 3 months to prepare this release and here we go! This update mainly focuses on rethinking and refactoring some parts of Ignis, but it include many new features & fixes too!

Breaking Changes

Options

Options Service is removed, introducing the new OptionManager & Options API instead!

Now all options for all services of Ignis will be in one place, and one class to manage them all.

Migration guide:

• Notification Service: dnd, popup_timeout, max_popups_count are removed, use corresponding options in ignis.options.Options. E.g., replace notifications.dnd with options.notifications.dnd
• Recorder Service: bitrate, default_file_location, default_filename properties are removed. All the same like with Notification Service.
• Applications Service: public API hasn't changed
• Wallpaper Service: wallpaper property is removed. Use options.wallpaper.wallpaper_path.

If you use Options Service to define your custom options, move to the new OptionsManager API.

More info is available in the documentation.

Asyncio

asyncio integration! Some functions are asynchronous now. Use await or asyncio.create_task() to call them.

• DBusProxy
  • new_async()
  • get_dbus_property_async()
  • set_dbus_property_async()
• BluetoothDevice
  • connect_to()
  • disconnect_from()
• WifiAccessPoint
  • commit_changes_async()
  • connect_to()
  • connect_to_graphical()
  • disconnect_from()
  • forget()
• EthernetDevice
  • connect_to()
  • disconnect_from()
• VpnConnection
  • connect_to()
  • disconnect_from()
• WifiDevice
  • scan()
• Utils.exec_sh_async()
• Utils.read_file_async()
• Utils.write_file_async()
• Widget.FileDialog.open_dialog()

Plus, methods of some services are synchronous and have their explicit async versions now.

Affected methods:

• MprisPlayer

  • next()
  • previous()
  • pause()
  • play()
  • play_pause()
  • stop()
  • seek()

• SystemTrayItem

  • activate()
  • secondary_activate()
  • context_menu()
  • scroll()

• SystemdUnit

  • start()
  • stop()
  • restart()

This also affects some property setters:

BacklightDevice.brightness setter is now synchronous, you can use its asynchronous version which is available as usual method: set_brightness_async(). Same for BacklightService.brightness and MprisPlayer.position.

Explicit GObject Property type

#157 replaces GObject.Property with the new IgnisProperty class. The main difference with IgnisProperty is that it can determine the property type automatically based on the return type of the getter. This greatly reduces code repetition, as it is sufficient to specify only the return type for the getter function.

Since properties have explicit types, their value can only be of the that defined type because it is now controlled on the GObject/C side, which doesn't support dynamic types.

It means you can't set None as a value for a property which type is bool/int/str/float or GObject/GType. If you use .bind(), you have to add an additional check if the new value is None.

Otherwise, an exception like this will be raised: TypeError: could not convert None to type 'gdouble' when setting property 'IgnisScale.value'

Hyprland Service moved to GObject-based objects

#171 brings objects inherited from IgnisGObject for Hyprland Service, replacing usual python dictionaries. This approach allows to bind properties and other GObject features.

New classes:

• HyprlandWorkspace
• HyprlandWindow
• HyprlandKeyboard

Migration Guide:

1. Since these objects are not dictionaries anymore, you have to get properties like usual class attributes:

# Old
hyprland.active_workspace["id"]
# New
hyprland.active_wor

Happy New Year everyone! Bringing you a new update with many new features and fixes...

Breaking Changes

• HyprlandIPCNotFoundError doesn't raise during Hyprland Service initialization, use the new HyprlandService.is_available property instead

New Features

• feat(nix): remove submodules for nix build (#43)
• feat: add HyprlandService.is_available property
• feat: Niri Service (#54)
• feat: Hyprland keyboard layout widget in example bar (also #54)
• feat: allow passing **kwargs to Utils.exec_sh()
• feat: IgnisApp.add_icons() (#53)
• feat: Power Menu in example bar (#57)
• feat(network): support wireguard vpn connections (#63)
• feat: Bluetooth Service (#28)
• feat(fetch): add cpu_temp property (#73)
• feat: Systemd Service (#62)
• feat: Utils.DebounceTask & Utils.debounce (#76)
• feat(Widget.EventBox): add support for on scroll [right, left] events (#82)
• feat(network): refactor signal handling (#80)
• feat: Utils.listen_socket() & Utils.send_socket(): add 'errors' argument
• feat(logging): log 'Happy New Year!'

Fixes

• fix(nix): add gstreamer, gst-plugins, pipewire to buildInputs (#44)
• fix: UPower Device State always return false (#59)
• fix: display the latest notification in example bar
• fix: use the icon provided by a Spotify installation when it is unavailable in the icon theme (#67)
• fix(nix): prefix PATH instead of overwriting it (#72)
• fix: Widget.Grid: prevent from calling __apply() two times during init
• fix(nix): use librsvg pixbuf module loader cache to allow loading SVG icons (#78)
• fix(notifications): dismiss the oldest popup in the list (0), not the newest (-1)
• fix(docs): Widget.Window.monitor: move the docstring from the setter to the GObject.Property itself
• fix(network): use rsn_flags & wpa_flags to check the security protocol of an access point (#86)
• fix: remove windows gracefully by overriding destroy() and unreliaze() methods
• fix(network): WifiConnectDialog: use an unique window name based on the bssid (#89)
• fix(hyprland): use 'errors=ignore' when decoding the response from the socket (closes: https://github.com/linkfrg/ignis/issues/91)
• fix(niri): use 'errors=ignore' when decoding the response from the socket
• fix(network): Ethernet: watch for available device connections
• fix: do not remove window on close request when hide_on_close is True
• other minor typing and typos fixes

Misc

• docs: update user/installation.rst
• add ruff to dev.txt
• stubs: remove UPowerGlib.pyi (not required)
• github(workflows): run ruff & mypy on examples
• move ruff config to pyproject.toml
• specify default selection for ruff
• docs: add a note about symbolic icons in IgnisApp.add_icons()
• README.md: add note about #60
• fix(stubs/NM.pyi): typing issue with enum with zero members

PRs

• feat(nix): remove submodules for nix build by @ratson in https://github.com/linkfrg/ignis/pull/43
• fix(nix): add GStreamer & PipeWire to build inputs by @0x006E in https://github.com/linkfrg/ignis/pull/44
• feat: Niri Service by @regenman in https://github.com/linkfrg/ignis/pull/54
• feat: IgnisApp.add_icons() by @linkfrg in https://github.com/linkfrg/ignis/pull/53
• fix: UPower Device State always return false by @newor0599 in https://github.com/linkfrg/ignis/pull/59
• feat: Power Menu in example bar by @regenman in https://github.com/linkfrg/ignis/pull/57
• feat(network): support wireguard vpn connections by @regenman in https://github.com/linkfrg/ignis/pull/63
• fix: use the icon provided by a Spotify installation when it is unavailable in the icon theme by @linkfrg in https://github.com/linkfrg/ignis/pull/67
• feat: Bluetooth Service by @linkfrg in https://github.com/linkfrg/ignis/pull/28
• fix(nix): prefix PATH instead of overwriting it by @campbellcole in https://github.com/linkfrg/ignis/pull/72
• feat: add cpu_temp to fetch service by @trolljoe in https://github.com/linkfrg/ignis/pull/73
• feat: Systemd Service by @rege

Breaking Changes

• fix!(gobject): IgnisGObject.set_property: do not return when a value is None
• feat!(Utils.ThreadTask): use explicit run()
• feat!(Utils.FileMonitor): pass self as the first argument to a callback
• feat!(applications): rename search() -> search_apps(); add support for searching in a custom list of applications (new required argument)

New Features

• feat: add Utils.get_ignis_branch() and Utils.get_ignis_commit_msg()
• feat(cli): print the git branch and the git commit message in --version
• feat(cli): add systeminfo subcommand
• feat: add support for custom paths and xml in Utils.load_interface_xml()
• feat: DBusProxy: add support for system bus
• feat: DBusProxy: add support for setting dbus properties
• feat: Backlight Service (#16)
• feat: add UPower Service (#10, #26)
• feat(logging): log GTK errors
• feat: add Utils.send_socket() & Utils.listen_socket()
• feat(network): add VPN functionality (#29)
• feat: Widget.Window: add margin properties
• feat(system tray): SystemTrayItem: add activate(), secondary_activate(), context_menu() and scroll() functions (closes #36)
• feat(Utils.FileMonitor): add the prevent_gc property

Fixes

• fix(Widget.Window): wrong type hint for anchor property;
• fix(Widget.Window): unset all anchors if the anchor property is set to None
• fix(hyprland): messages from sockets is limited by the buffer size (1024/4096 bytes)
• fix(app): reload CSS only on the changes_done_hint event type (closes #18)
• fix(applications): disable python virtual env for subprocess & set cwd to home dir
• fix(cli): set prog_name explicitly
• fix(dbus menu): call AboutToShow on popup (closes #33)
• fix(notifications): popup_timeout setter function is not working (#38)
• fix(Utils.FileMonitor): "changed" signal is called only if a callback is present
• fix: use TypeAlias annotation for classes in Utils

Other

• github: add issue forms
• github(workflows): build documentation on pull requests
• Package for NixOS (and some fixes for it) (#13, #14, #21, #25)
• docs: fix incorrect import of services in examples (closes #20)
• docs: General improvements to the API Reference (#35)
• docs: refactor versioning stuff

New Contributors

• @somokill made their first contribution in https://github.com/linkfrg/ignis/pull/13
• @gauravsatish made their first contribution in https://github.com/linkfrg/ignis/pull/16
• @ratson made their first contribution in https://github.com/linkfrg/ignis/pull/21
• @tyrypyrking made their first contribution in https://github.com/linkfrg/ignis/pull/29
• @imxnasr made their first contribution in https://github.com/linkfrg/ignis/pull/38

Full Changelog: https://github.com/linkfrg/ignis/compare/v0.2...v0.3