1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# -*- coding: utf-8 -*-
# This is an example module to be used as a template.
# See https://github.com/ultrabug/py3status/wiki/Write-your-own-modules
# for more details.
#
# NOTE: py3status will NOT execute:
# - methods starting with '_'
# - methods decorated by @property and @staticmethod
#
# NOTE: reserved method names:
# - 'kill' method for py3status exit notification
# - 'on_click' method for click events from i3bar (read below please)
#
# Do NOT use print on your modules: py3status will catch any output and discard
# it silently because this would break your i3bar (see issue #20 for details).
# Make sure you catch any output from any external program you may call
# from your module. Any output from an external program cannot be caught and
# silenced by py3status and will break your i3bar so please, redirect any
# stdout/stderr to /dev/null for example (see issue #20 for details).
#
# Fill in the following docstring: it will beparsed py3status to document
# your module:
"""
One-line summary followed by an empty line.
Multi-line description followed by an empty line.
@author <your full name> <your email address>
@license <ancronym> (please favor BSD or GPLv3)
"""
# Any contributor to this module should add his/her name to the @author line, comma separated
# import your useful libs here
from time import time
class Py3status:
"""
The Py3status class name is mendatory.
Below you list all the available configuration parameters and their
default value for your module which can be overwritten by users
directly from their i3status config.
This examples features only one parameter which is 'cache_timeout'
and is set to 10 seconds (0 would mean no cache).
"""
# available configuration parameters
cache_timeout = 10
def __init__(self):
"""
This is the class constructor which will be executed once.
"""
pass
def kill(self, i3s_output_list, i3s_config):
"""
This method will be called upon py3status exit.
"""
pass
def on_click(self, i3s_output_list, i3s_config, event):
"""
This method should only be used for ADVANCED and very specific usages.
Read the 'Handle click events directly from your i3status config'
article from the py3status wiki:
https://github.com/ultrabug/py3status/wiki/
This method will be called when a click event occurs on this module's
output on the i3bar.
Example 'event' json object:
{'y': 13, 'x': 1737, 'button': 1, 'name': 'empty', 'instance': 'first'}
"""
pass
def empty(self, i3s_output_list, i3s_config):
"""
This method will return an empty text message
so it will NOT be displayed on your i3bar.
If you want something displayed you should write something
in the 'full_text' key of your response.
See the i3bar protocol spec for more information:
http://i3wm.org/docs/i3bar-protocol.html
"""
response = {
'cached_until': time() + self.cache_timeout,
'full_text': ''
}
return response
if __name__ == "__main__":
"""
Test this module by calling it directly.
"""
from time import sleep
x = Py3status()
config = {
'color_good': '#00FF00',
'color_bad': '#FF0000',
}
while True:
print(x.empty([], config))
sleep(1)
|
