Module Gnumed.pycommon.gmNull
null.py
This is a sample implementation of the 'Null Object' design pattern.
Roughly, the goal with Null objects is to provide an 'intelligent' replacement for the often used primitive data type None in Python or Null (or Null pointers) in other languages. These are used for many purposes including the important case where one member of some group of otherwise similar elements is special for whatever reason. Most often this results in conditional statements to distinguish between ordinary elements and the primitive Null value.
Among the advantages of using Null objects are the following:
-
Superfluous conditional statements can be avoided by providing a first class object alternative for the primitive value None.
-
Code readability is improved.
-
Null objects can act as a placeholder for objects with behaviour that is not yet implemented.
-
Null objects can be replaced for any other class.
-
Null objects are very predictable at what they do.
To cope with the disadvantage of creating large numbers of passive objects that do nothing but occupy memory space Null objects are often combined with the Singleton pattern.
For more information use any internet search engine and look for combinations of these words: Null, object, design and pattern.
Dinu C. Gherman, August 2001
Karsten Hilbert July 2004
Expand source code
"""null.py
This is a sample implementation of the 'Null Object' design pattern.
Roughly, the goal with Null objects is to provide an 'intelligent'
replacement for the often used primitive data type None in Python or
Null (or Null pointers) in other languages. These are used for many
purposes including the important case where one member of some group
of otherwise similar elements is special for whatever reason. Most
often this results in conditional statements to distinguish between
ordinary elements and the primitive Null value.
Among the advantages of using Null objects are the following:
- Superfluous conditional statements can be avoided
by providing a first class object alternative for
the primitive value None.
- Code readability is improved.
- Null objects can act as a placeholder for objects
with behaviour that is not yet implemented.
- Null objects can be replaced for any other class.
- Null objects are very predictable at what they do.
To cope with the disadvantage of creating large numbers of passive
objects that do nothing but occupy memory space Null objects are
often combined with the Singleton pattern.
For more information use any internet search engine and look for
combinations of these words: Null, object, design and pattern.
Dinu C. Gherman,
August 2001
Karsten Hilbert
July 2004
"""
#==============================================================
__author__ = "Dinu C. Gherman, Karsten Hilbert"
__license__ = "GPL v2 or later (details at https://www.gnu.org)"
import logging
_log = logging.getLogger('cNull')
#==============================================================
class cNull(object):
"""A class for implementing Null objects.
This class ignores all parameters passed when constructing or
calling instances and traps all attribute and method requests.
Instances of it always (and reliably) do 'nothing'.
The code might benefit from implementing some further special
Python methods depending on the context in which its instances
are used. Especially when comparing and coercing Null objects
the respective methods' implementation will depend very much
on the environment and, hence, these special methods are not
provided here.
"""
# object constructing
def __init__(self, *args, **kwargs):
"Ignore parameters."
_log.debug('args: %s', args)
_log.debug('kwargs: %s', kwargs)
# object calling
def __call__(self, *args, **kwargs):
"Ignore method calls."
_log.debug('args: %s', args)
_log.debug('kwargs: %s', kwargs)
return self
# attribute handling
def __getattr__(self, attribute):
"Ignore attribute requests."
_log.debug('%s.%s', self, attribute)
return self
def __setattr__(self, attribute, value):
"Ignore attribute setting."
_log.debug('%s.%s = %s', self, attribute, value)
return self
def __delattr__(self, attribute):
"Ignore deleting attributes."
_log.debug('%s.%s', self, attribute)
return self
# item handling
def __getitem__(self, item):
"Ignore item requests."
_log.debug('%s[%s]', self, item)
return self
def __setitem__(self, item, value):
"Ignore item setting."
_log.debug('%s[%s] = %s', self, item, value)
return self
def __delitem__(self, item):
"Ignore deleting items."
_log.debug('%s[%s]', self, item)
return self
# misc.
def __repr__(self):
"Return a string representation."
return "<cNull instance @ %s>" % id(self)
def __str__(self):
"Convert to a string and return it."
return '<cNull instance>'
def __nonzero__(self):
_log.debug('returns 0')
return 0
def __len__(self):
_log.debug('0')
return 0
#==============================================================
def test():
"Perform some decent tests, or rather: demos."
# pylint: disable=no-member
# constructing and calling
n = cNull()
n = cNull('value')
n = cNull('value', param='value')
n()
n('value')
n('value', param='value')
# attribute handling
n.attr1
n.attr1.attr2
n.method1()
n.method1().method2()
n.method('value')
n.method(param='value')
n.method('value', param='value')
n.attr1.method1()
n.method1().attr1
n.attr1 = 'value'
n.attr1.attr2 = 'value'
n['1']
n['2'] = '123'
del n['3']
del n.attr1
del n.attr1.attr2.attr3
# representation and conversion to a string
tmp = '<cNull instance @ %s>' % id(n)
assert repr(n) == tmp
assert str(n) == '<cNull instance>'
# comparing
if n == 1:
print("Null object == 1")
else:
print("Null object != 1")
#--------------------------------------------------------------
if __name__ == '__main__':
import sys
if len(sys.argv) < 2:
sys.exit()
if sys.argv[1] != 'test':
sys.exit()
test()Functions
def test()-
Perform some decent tests, or rather: demos.
Expand source code
def test(): "Perform some decent tests, or rather: demos." # pylint: disable=no-member # constructing and calling n = cNull() n = cNull('value') n = cNull('value', param='value') n() n('value') n('value', param='value') # attribute handling n.attr1 n.attr1.attr2 n.method1() n.method1().method2() n.method('value') n.method(param='value') n.method('value', param='value') n.attr1.method1() n.method1().attr1 n.attr1 = 'value' n.attr1.attr2 = 'value' n['1'] n['2'] = '123' del n['3'] del n.attr1 del n.attr1.attr2.attr3 # representation and conversion to a string tmp = '<cNull instance @ %s>' % id(n) assert repr(n) == tmp assert str(n) == '<cNull instance>' # comparing if n == 1: print("Null object == 1") else: print("Null object != 1")
Classes
class cNull (*args, **kwargs)-
A class for implementing Null objects.
This class ignores all parameters passed when constructing or calling instances and traps all attribute and method requests. Instances of it always (and reliably) do 'nothing'.
The code might benefit from implementing some further special Python methods depending on the context in which its instances are used. Especially when comparing and coercing Null objects the respective methods' implementation will depend very much on the environment and, hence, these special methods are not provided here.
Ignore parameters.
Expand source code
class cNull(object): """A class for implementing Null objects. This class ignores all parameters passed when constructing or calling instances and traps all attribute and method requests. Instances of it always (and reliably) do 'nothing'. The code might benefit from implementing some further special Python methods depending on the context in which its instances are used. Especially when comparing and coercing Null objects the respective methods' implementation will depend very much on the environment and, hence, these special methods are not provided here. """ # object constructing def __init__(self, *args, **kwargs): "Ignore parameters." _log.debug('args: %s', args) _log.debug('kwargs: %s', kwargs) # object calling def __call__(self, *args, **kwargs): "Ignore method calls." _log.debug('args: %s', args) _log.debug('kwargs: %s', kwargs) return self # attribute handling def __getattr__(self, attribute): "Ignore attribute requests." _log.debug('%s.%s', self, attribute) return self def __setattr__(self, attribute, value): "Ignore attribute setting." _log.debug('%s.%s = %s', self, attribute, value) return self def __delattr__(self, attribute): "Ignore deleting attributes." _log.debug('%s.%s', self, attribute) return self # item handling def __getitem__(self, item): "Ignore item requests." _log.debug('%s[%s]', self, item) return self def __setitem__(self, item, value): "Ignore item setting." _log.debug('%s[%s] = %s', self, item, value) return self def __delitem__(self, item): "Ignore deleting items." _log.debug('%s[%s]', self, item) return self # misc. def __repr__(self): "Return a string representation." return "<cNull instance @ %s>" % id(self) def __str__(self): "Convert to a string and return it." return '<cNull instance>' def __nonzero__(self): _log.debug('returns 0') return 0 def __len__(self): _log.debug('0') return 0