/usr/lib/python3/dist-packages/defcon/tools/notifications.py is in python3-defcon 0.3.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 | from __future__ import print_function
from collections import OrderedDict
"""
A flexible and relatively robust implementation
of the Observer Pattern.
"""
import sys
import weakref
"""
----------------------
Internal Documentation
----------------------
Storage Structures:
registry : {
(notification, observable) : OrderedDict(
observer : method name
)
}
holds : {
(notification, observable, observer) : {
count=int,
notifications=[
(notification name, observable ref, data)
]
)
}
disabled : {
(notification, observable, observer) : count
}
"""
class NotificationCenter(object):
def __init__(self):
self._registry = {}
self._holds = {}
self._disabled = {}
# -----
# Basic
# -----
def addObserver(self, observer, methodName, notification=None, observable=None):
"""
Add an observer to this notification dispatcher.
* **observer** An object that can be referenced with weakref.
* **methodName** A string epresenting the method to be called
when the notification is posted.
* **notification** The notification that the observer should
be notified of. If this is None, all notifications for
the *observable* will be posted to *observer*.
* **observable** The object to observe. If this is None,
all notifications with the name provided as *notification*
will be posted to the *observer*.
If None is given for both *notification* and *observable*
**all** notifications posted will be sent to the method
given method of the observer.
The method that will be called as a result of the action
must accept a single *notification* argument. This will
be a :class:`Notification` object.
"""
if observable is not None:
observable = weakref.ref(observable)
observer = weakref.ref(observer)
key = (notification, observable)
if key not in self._registry:
self._registry[key] = OrderedDict()
assert observer not in self._registry[key],\
"An observer is only allowed to have one callback for a given notification + observable combination. notification={notification}, observable={observable} , observer={observer}, existing method={method1}, adding method={method2}".format(
notification=key[0], observable=key[1](), observer=observer(), method1=self._registry[key][observer], method2=methodName
)
self._registry[key][observer] = methodName
def hasObserver(self, observer, notification, observable):
"""
Returns a boolean indicating if the **observer** is registered
for **notification** posted by **observable**. Either
*observable* or *notification* may be None.
"""
if observable is not None:
observable = weakref.ref(observable)
key = (notification, observable)
if key not in self._registry:
return False
observer = weakref.ref(observer)
return observer in self._registry[key]
def removeObserver(self, observer, notification, observable=None):
"""
Remove an observer from this notification dispatcher.
* **observer** A registered object.
* **notification** The notification that the observer was registered
to be notified of.
* **observable** The object being observed.
"""
if observable is not None:
observable = weakref.ref(observable)
key = (notification, observable)
if key not in self._registry:
return
observer = weakref.ref(observer)
if observer in self._registry[key]:
del self._registry[key][observer]
if not len(self._registry[key]):
del self._registry[key]
def postNotification(self, notification, observable, data=None):
assert notification is not None
assert observable is not None
observableRef = weakref.ref(observable)
# observer independent hold/disabled
# ----------------------------------
if self._holds or self._disabled:
holdDisabledPossibilities = (
# least specific -> most specific
# suspended for all
(None, None, None),
# suspended for this notification
(notification, None, None),
# suspended for this observer
(None, observableRef, None),
# suspended for this notification + observable
(notification, observableRef, None)
)
for key in holdDisabledPossibilities:
if key in self._disabled:
return
if key in self._holds:
n = (notification, observableRef, data)
if n not in self._holds[key]["notifications"]:
self._holds[key]["notifications"].append(n)
return
# posting
# -------
notificationObj = Notification(notification, observableRef, data)
registryPossibilities = (
# least specific -> most specific
(None, None),
(None, observableRef),
(notification, None),
(notification, observableRef),
)
for key in registryPossibilities:
if key not in self._registry:
continue
for observerRef, methodName in list(self._registry[key].items()):
# observer specific hold/disabled
# -------------------------------
if self._holds or self._disabled:
holdDisabledPossibilities = (
# least specific -> most specific
# suspended for observer
(None, None, observerRef),
# suspended for notification + observer
(notification, None, observerRef),
# suspended for observable + observer
(None, observableRef, observerRef),
# suspended for notification + observable + observer
(notification, observableRef, observerRef)
)
disabled = False
if self._disabled:
for disableKey in holdDisabledPossibilities:
if disableKey in self._disabled:
disabled = True
break
if disabled:
continue
hold = False
if self._holds:
for holdKey in holdDisabledPossibilities:
if holdKey in self._holds:
hold = True
n = (notification, observableRef, data)
if n not in self._holds[key]["notifications"]:
self._holds[holdKey]["notifications"].append(n)
break
if hold:
continue
# post
# ----
observer = observerRef()
if observer is None:
# dead ref.
# XXX: delete?
continue
callback = getattr(observer, methodName)
callback(notificationObj)
# ----
# Hold
# ----
def holdNotifications(self, observable=None, notification=None, observer=None):
"""
Hold all notifications posted to all objects observing
**notification** in **observable**.
* **observable** The object that the notification belongs to. This is optional.
If no *observable* is given, *all* *notifications* will be held.
* **notification** The name of the notification. This is optional.
If no *notification* is given, *all* notifications for *observable*
will be held.
* **observer** The specific observer to not hold notifications for.
If no *observer* is given, the appropriate notifications will be
held for all observers.
Held notifications will be posted after the matching *notification*
and *observable* have been passed to :meth:`Notification.releaseHeldNotifications`.
This object will retain a count of how many times it has been told to
hold notifications for *notification* and *observable*. It will not
post the notifications until the *notification* and *observable*
have been released the same number of times.
"""
if observable is not None:
observable = weakref.ref(observable)
if observer is not None:
observer = weakref.ref(observer)
key = (notification, observable, observer)
if key not in self._holds:
self._holds[key] = dict(count=0, notifications=[])
self._holds[key]["count"] += 1
def releaseHeldNotifications(self, observable=None, notification=None, observer=None):
"""
Release all held notifications posted to all objects observing
**notification** in **observable**.
* **observable** The object that the notification belongs to. This is optional.
* **notification** The name of the notification. This is optional.
* **observer** The observer. This is optional.
"""
if observable is not None:
observable = weakref.ref(observable)
if observer is not None:
observer = weakref.ref(observer)
key = (notification, observable, observer)
self._holds[key]["count"] -= 1
if self._holds[key]["count"] == 0:
notifications = self._holds[key]["notifications"]
del self._holds[key]
for notification, observableRef, data in notifications:
self.postNotification(notification, observableRef(), data)
def areNotificationsHeld(self, observable=None, notification=None, observer=None):
"""
Returns a boolean indicating if notifications posted to all objects observing
**notification** in **observable** are being held.
* **observable** The object that the notification belongs to. This is optional.
* **notification** The name of the notification. This is optional.
* **observer** The observer. This is optional.
"""
if observable is not None:
observable = weakref.ref(observable)
if observer is not None:
observer = weakref.ref(observer)
key = (notification, observable, observer)
return key in self._holds
# -------
# Disable
# -------
def disableNotifications(self, observable=None, notification=None, observer=None):
"""
Disable all posts of **notification** from **observable** posted
to **observer** observing.
* **observable** The object that the notification belongs to. This is optional.
If no *observable* is given, *all* *notifications* will be disabled for *observer*.
* **notification** The name of the notification. This is optional.
If no *notification* is given, *all* notifications for *observable*
will be disabled for *observer*.
* **observer** The specific observer to not send posts to. If no
*observer* is given, the appropriate notifications will not
be posted to any observers.
This object will retain a count of how many times it has been told to
disable notifications for *notification* and *observable*. It will not
enable new notifications until the *notification* and *observable*
have been released the same number of times.
"""
if observable is not None:
observable = weakref.ref(observable)
if observer is not None:
observer = weakref.ref(observer)
key = (notification, observable, observer)
if key not in self._disabled:
self._disabled[key] = 0
self._disabled[key] += 1
def enableNotifications(self, observable=None, notification=None, observer=None):
"""
Enable notifications posted to all objects observing
**notification** in **observable**.
* **observable** The object that the notification belongs to. This is optional.
* **notification** The name of the notification. This is optional.
* **observer** The observer. This is optional.
"""
if observable is not None:
observable = weakref.ref(observable)
if observer is not None:
observer = weakref.ref(observer)
key = (notification, observable, observer)
self._disabled[key] -= 1
if self._disabled[key] == 0:
del self._disabled[key]
def areNotificationsDisabled(self, observable=None, notification=None, observer=None):
"""
Returns a boolean indicating if notifications posted to all objects observing
**notification** in **observable** are disabled.
* **observable** The object that the notification belongs to. This is optional.
* **notification** The name of the notification. This is optional.
* **observer** The observer. This is optional.
"""
if observable is not None:
observable = weakref.ref(observable)
if observer is not None:
observer = weakref.ref(observer)
key = (notification, observable, observer)
return key in self._disabled
class Notification(object):
"""An object that wraps notification data."""
__slots__ = ("_name", "_objRef", "_data")
def __init__(self, name, objRef, data):
self._name = name
self._objRef = objRef
self._data = data
def __repr__(self):
return "<Notification: %s %s>" % (self.name, repr(self.object))
def _get_name(self):
return self._name
name = property(_get_name, doc="The notification name. A string.")
def _get_object(self):
if self._objRef is not None:
return self._objRef()
return None
object = property(_get_object, doc="The observable object the notification belongs to.")
def _get_data(self):
return self._data
data = property(_get_data, doc="Arbitrary data passed along with the notification. There is no set format for this data and there is not requirement that any data be present. Refer to the documentation for methods that are responsible for generating notifications for information about this data.")
if __name__ == "__main__":
import doctest
doctest.testmod()
|