Breaking Changes Tracker

[linkfrg]

This is a meta issue to track breaking changes in -git

If something is not working after an Ignis update, please read through the comments below first

[linkfrg]

After 756ee85 Utils.DebounceTask.__call__() was removed, use the new Utils.DebounceTask.run() method instead

[linkfrg]

#98 removes Options Service and brings the new OptionManager & Options API.
Migration guide is included in the first message.

[linkfrg]

#103 removes Binding.target_property, use Binding.target_properties (list) instead

[linkfrg]

After #146 logs are stored at $XDG_STATE_HOME/ignis/ignis.log (~/.local/state/ignis/ignis.log) instead of ~/.ignis/ignis.log

[linkfrg]

#150: Utils.download_image() is no longer used by MprisPlayer and because of this it was removed.
Use Utils.read_file() & Utils.write_file() (or their async versions) as the replacement, Utils.read_file() supports loading from a URI too.
#150 is reverted

[linkfrg]

#152 makes some functions asynchronous:

• 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()

Use await or asyncio.create_task() to call them. More info in docs.
Plus, the minimal required version of PyGObject is now 3.50.0

[linkfrg]

#157

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.

For example, it affects Widget.Scale.value and your transform function should include that check:
stream.bind("volume", transform=lambda vol: vol or 0)

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

[linkfrg]

#171

#171 affects Hyprland Service.

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_workspace.id

2. HyprlandService.kb_layout is removed, use HyprlandService.main_keyboard.active_keymap instead.
3. HyprlandService.switch_kb_layout() is removed, use HyprlandService.main_keyboard.switch_layout() instead (to restore the old functionality pass "next" as an argument to it).
4. HyprlandService.workspaces will not be notified on the active workspace change anymore.
   If you want to restore the old functionality, use bind_many():

# Old
hyprland.bind(
    "workspaces",
     transform=lambda value: [WorkspaceButton(i) for i in value],
)
# New
hyprland.bind_many(
    ["workspaces", "active_workspace"],
    transform=lambda workspaces, *_: [
        WorkspaceButton(i) for i in workspaces
    ],
)

[linkfrg]

#184

Methods of some services now are synchronous and have their explicit async versions.

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.

[linkfrg]

45a27f4

Now Utils.FileMonitor.flags uses Gio.FileMonitorFlags, not str