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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
# coding=utf-8
"""
Represents common constants and classes for all platforms.
@group Power Source Type: POWER_TYPE_AC, POWER_TYPE_BATTERY, POWER_TYPE_UPS
@var POWER_TYPE_AC: The system is connected to the external power source.
@var POWER_TYPE_BATTERY: The system is connected to the battery.
@var POWER_TYPE_UPS: The system is connected to UPS.
@type POWER_TYPE_BATTERY: int
@type POWER_TYPE_AC: int
@type POWER_TYPE_UPS: int
@group Low Battery Warning Levels: LOW_BATTERY_WARNING_NONE, LOW_BATTERY_WARNING_EARLY, LOW_BATTERY_WARNING_FINAL
@var LOW_BATTERY_WARNING_NONE: The system is connected to the unlimited power source.
@var LOW_BATTERY_WARNING_EARLY: The battery has dropped below 22% remaining power.
@var LOW_BATTERY_WARNING_FINAL: The battery can provide no more than 10 minutes of runtime.
@type LOW_BATTERY_WARNING_EARLY: int
@type LOW_BATTERY_WARNING_NONE: int
@type LOW_BATTERY_WARNING_FINAL: int
@group Special Values For Time Remaining: TIME_REMAINING_UNKNOWN, TIME_REMAINING_UNLIMITED
@var TIME_REMAINING_UNKNOWN: Indicates the system is connected to a limited power source, but system is still
calculating a time remaining estimate.
@var TIME_REMAINING_UNLIMITED: Indicates that the system is connected to an external power source, without time limit.
@type TIME_REMAINING_UNKNOWN: float
@type TIME_REMAINING_UNLIMITED: float
"""
__author__ = 'kulakov.ilya@gmail.com'
from abc import ABCMeta, abstractmethod
import weakref
__all__ = [
'POWER_TYPE_AC',
'POWER_TYPE_BATTERY',
'POWER_TYPE_UPS',
'LOW_BATTERY_WARNING_NONE',
'LOW_BATTERY_WARNING_EARLY',
'LOW_BATTERY_WARNING_FINAL',
'TIME_REMAINING_UNKNOWN',
'TIME_REMAINING_UNLIMITED',
'PowerManagementObserver'
]
POWER_TYPE_AC = 0
POWER_TYPE_BATTERY = 1
POWER_TYPE_UPS = 2
LOW_BATTERY_WARNING_NONE = 1
LOW_BATTERY_WARNING_EARLY = 2
LOW_BATTERY_WARNING_FINAL = 3
TIME_REMAINING_UNKNOWN = -1.0
TIME_REMAINING_UNLIMITED = -2.0
class PowerManagementBase(object):
"""
Base class for platform dependent PowerManagement functions.
@ivar _weak_observers: List of weak reference to added observers
@note: Platform's implementation may provide additional parameters for initialization
"""
__metaclass__ = ABCMeta
def __init__(self):
self._weak_observers = []
@abstractmethod
def get_providing_power_source_type(self):
"""
Returns type of the providing power source.
@return: Possible values:
- POWER_TYPE_AC
- POWER_TYPE_BATTERY
- POWER_TYPE_UPS
@rtype: int
"""
pass
@abstractmethod
def get_low_battery_warning_level(self):
"""
Returns the system battery warning level.
@return: Possible values:
- LOW_BATTERY_WARNING_NONE
- LOW_BATTERY_WARNING_EARLY
- LOW_BATTERY_WARNING_FINAL
@rtype: int
"""
pass
@abstractmethod
def get_time_remaining_estimate(self):
"""
Returns the estimated minutes remaining until all power sources (battery and/or UPS) are empty.
@return: Special values:
- TIME_REMAINING_UNKNOWN
- TIME_REMAINING_UNLIMITED
@rtype: float
"""
pass
@abstractmethod
def add_observer(self, observer):
"""
Adds weak ref to an observer.
@param observer: Instance of class registered with PowerManagementObserver
@raise TypeError: If observer is not registered with PowerManagementObserver abstract class
"""
if not isinstance(observer, PowerManagementObserver):
raise TypeError("observer MUST conform to power.PowerManagementObserver")
self._weak_observers.append(weakref.ref(observer))
@abstractmethod
def remove_observer(self, observer):
"""
Removes an observer.
@param observer: Previously added observer
"""
self._weak_observers.remove(weakref.ref(observer))
def remove_all_observers(self):
"""
Removes all registered observers.
"""
for weak_observer in self._weak_observers:
observer = weak_observer()
if observer:
self.remove_observer(observer)
class PowerManagementObserver:
"""
Base class for PowerManagement observers.
Do not make assumptions in what thread or event loop these methods are called.
"""
__metaclass__ = ABCMeta
@abstractmethod
def on_power_sources_change(self, power_management):
"""
@param power_management: Instance of PowerManagement posted notification
"""
pass
@abstractmethod
def on_time_remaining_change(self, power_management):
"""
@param power_management: Instance of PowerManagement posted notification
"""
pass
class PowerManagementNoop(PowerManagementBase):
"""
No-op subclass of PowerManagement.
It operates like AC is always attached and power sources are never changed.
"""
def get_providing_power_source_type(self):
"""
@return: Always POWER_TYPE_AC
"""
return POWER_TYPE_AC
def get_low_battery_warning_level(self):
"""
@return: Always LOW_BATTERY_WARNING_NONE
"""
return LOW_BATTERY_WARNING_NONE
def get_time_remaining_estimate(self):
"""
@return: Always TIME_REMAINING_UNLIMITED
"""
return TIME_REMAINING_UNLIMITED
def add_observer(self, observer):
"""
Does nothing.
"""
pass
def remove_observer(self, observer):
"""
Does nothing.
"""
pass
def remove_all_observers(self):
"""
Does nothing.
"""
pass
|
