Support action receiving and add ability to name them

[C0rn3j]

Currently, actions are only defined but unimplemented in the async block.

python-sdbus-notifications/sdbus_async/notifications/__init__.py

Lines 112 to 121 in 7932225

	@dbus_signal_async()
	def action_invoked(self) -> Tuple[int, int]:
	"""Signal when user invokes one of the actions specified.
	First element of tuple is notification id.
	Second element is the index of the action invoked. \
	Matches the index of passed list of actions.
	"""
	raise NotImplementedError

They are also named automatically by index, it would be nicer if they were able to be named properly via a string.

The blocking version for action receiving could simply block and return a tuple with both the ID and the actions upon expiry of the notification.
It would perhaps be best if this was made optional in the notify() function, as I imagine not everyone would want to block.

[igo95862]

Hello @C0rn3j

Currently, actions are only defined but unimplemented in the async block.

It has raise NotImplementedError because the function is only used for its type hints and doc string. The dbus_signal_async decorator creates a signal object which has methods like .catch(). See python-sdbus documentation: https://python-sdbus.readthedocs.io/en/latest/asyncio_quick.html#signals

They are also named automatically by index, it would be nicer if they were able to be named properly via a string.

It uses integers because this is what D-Bus API uses: https://specifications.freedesktop.org/notification-spec/latest/protocol.html You can always create your own dictionary that can map the integers to strings.

[C0rn3j]

It uses integers because this is what D-Bus API uses

You've misread the documentation a little it seems(I have too at first when you sent it), and implemented it a bit wrong - in the typehints and docstrings only though, so no big issue there. It uses strings for action keys.

I fixed it in the PR I sent earlier and set it to close this issue.

The actions use tuple[int, str] for receiving:

And [str, str] list pairs for sending:

Dbus never uses ints for action keys.
I presume the confusion comes from this sentence: Each even element in the list (starting at index 0) represents the identifier for the action.
this just refers to the list indexes, it does not assign an int by index.

I presume this will be probably wrong somewhere else too in some other docs.

It has raise NotImplementedError because the function is only used for its type hints and doc string. The dbus_signal_async decorator creates a signal object which has methods like .catch(). See python-sdbus documentation: https://python-sdbus.readthedocs.io/en/latest/asyncio_quick.html#signals

Thanks, that was not obvious to me, got async working.

[igo95862]

action_invoked type hints should be fixed in da3cf67. Thank you for reporting the issue.