configuration.rst: update example callbacks
This commit is contained in:
parent
289c090ea4
commit
2890f942f3
@ -321,12 +321,21 @@ amount of percent to add/subtract from the current volume.
|
|||||||
|
|
||||||
.. rubric:: Python callbacks
|
.. rubric:: Python callbacks
|
||||||
|
|
||||||
These refer to to any callable Python object (most likely a function).
|
These refer to to any callable Python object (most likely a
|
||||||
|
function). To external Python callbacks that are not part of the
|
||||||
|
module the ``self`` parameter is not passed by default. This allows to
|
||||||
|
use many library functions with no additional wrapper.
|
||||||
|
|
||||||
|
If ``self`` is needed to access the calling module, the
|
||||||
|
:py:func:`.get_module` decorator can be used on the callback:
|
||||||
|
|
||||||
.. code:: python
|
.. code:: python
|
||||||
|
|
||||||
|
from i3pystatus import get_module
|
||||||
|
|
||||||
# Note that the 'self' parameter is required and gives access to all
|
# Note that the 'self' parameter is required and gives access to all
|
||||||
# variables of the module.
|
# variables of the module.
|
||||||
|
@get_module
|
||||||
def change_text(self):
|
def change_text(self):
|
||||||
self.output["full_text"] = "Clicked"
|
self.output["full_text"] = "Clicked"
|
||||||
|
|
||||||
@ -341,6 +350,9 @@ You can also create callbacks with parameters.
|
|||||||
|
|
||||||
.. code:: python
|
.. code:: python
|
||||||
|
|
||||||
|
from i3pystatus import get_module
|
||||||
|
|
||||||
|
@get_module
|
||||||
def change_text(self, text="Hello world!", color="#ffffff"):
|
def change_text(self, text="Hello world!", color="#ffffff"):
|
||||||
self.output["full_text"] = text
|
self.output["full_text"] = text
|
||||||
self.output["color"] = color
|
self.output["color"] = color
|
||||||
|
@ -567,8 +567,7 @@ def get_module(function):
|
|||||||
|
|
||||||
.. code:: python
|
.. code:: python
|
||||||
|
|
||||||
from i3pystatus import Status
|
from i3pystatus import Status, get_module
|
||||||
from i3pystatus.core.util import get_module
|
|
||||||
from i3pystatus.core.command import execute
|
from i3pystatus.core.command import execute
|
||||||
status = Status(...)
|
status = Status(...)
|
||||||
# other modules etc.
|
# other modules etc.
|
||||||
|
Loading…
Reference in New Issue
Block a user