terminator/terminatorlib/borg.py

45 lines
1.5 KiB
Python
Raw Normal View History

#!/usr/bin/python
# Terminator by Chris Jones <cmsj@tenshu.net>
# GPL v2 only
"""borg.py - We are the borg. Resistance is futile.
http://code.activestate.com/recipes/66531/"""
2009-08-11 22:23:34 +00:00
# pylint: disable-msg=R0903
2009-12-09 13:22:34 +00:00
# pylint: disable-msg=R0921
class Borg:
2009-10-09 11:25:06 +00:00
"""Definition of a class that can never be duplicated. Correct usage is
thus:
from borg import Borg
class foo(Borg):
# All attributes on a borg class *must* = None
attribute = None
def __init__(self):
Borg.__init__(self)
def prepare_attributes(self):
if not self.attribute:
self.attribute = []
bar = foo()
bar.prepare_attributes()
The important thing to note is that all attributes of borg classes *must* be
declared as being None. If you attempt to use static class attributes you
will get unpredicted behaviour. Instead, prepare_attributes() must be called
which will then see the attributes in the shared state, and initialise them
if necessary."""
__shared_state = {}
2009-10-09 11:25:06 +00:00
def __init__(self):
2009-10-09 11:25:06 +00:00
"""Class initialiser. Overwrite our class dictionary with the shared
state. This makes us identical to every other instance of this class
type."""
2009-08-11 22:23:34 +00:00
self.__dict__ = self.__shared_state
2009-10-09 11:25:06 +00:00
def prepare_attributes(self):
"""This should be used to prepare any attributes of the borg class."""
raise NotImplementedError('prepare_attributes')