summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Gerard DeRose <jderose@redhat.com>2008-12-10 21:14:05 -0700
committerJason Gerard DeRose <jderose@redhat.com>2008-12-10 21:14:05 -0700
commit22209a0f0333526fe953a66f6ea4dd1be18dddc6 (patch)
tree419cdba947338a16767fca991e1b5e32740cc3ce
parenta3ab787d23331cf4d060d8463ca66ff602f3629b (diff)
downloadfreeipa-22209a0f0333526fe953a66f6ea4dd1be18dddc6.tar.gz
freeipa-22209a0f0333526fe953a66f6ea4dd1be18dddc6.tar.xz
freeipa-22209a0f0333526fe953a66f6ea4dd1be18dddc6.zip
Started roughing out the consolidated type/parameter system in parameters.py; started corresponding unit tests
-rw-r--r--ipalib/constants.py6
-rw-r--r--ipalib/parameter.py188
-rw-r--r--tests/test_ipalib/test_parameter.py93
3 files changed, 286 insertions, 1 deletions
diff --git a/ipalib/constants.py b/ipalib/constants.py
index 7e562b530..06ff99d5e 100644
--- a/ipalib/constants.py
+++ b/ipalib/constants.py
@@ -19,9 +19,13 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
-All constants centralized in one file.
+All constants centralised in one file.
"""
+# The parameter system treats all these values as None:
+NULLS = (None, '', u'', tuple(), [])
+
+
# Used for a tab (or indentation level) when formatting for CLI:
CLI_TAB = ' ' # Two spaces
diff --git a/ipalib/parameter.py b/ipalib/parameter.py
new file mode 100644
index 000000000..b75b8fbe5
--- /dev/null
+++ b/ipalib/parameter.py
@@ -0,0 +1,188 @@
+# Authors:
+# Jason Gerard DeRose <jderose@redhat.com>
+#
+# Copyright (C) 2008 Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2 only
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+"""
+Parameter system for command plugins.
+"""
+
+from plugable import ReadOnly, lock, check_name
+from constants import NULLS
+
+
+def parse_param_spec(spec):
+ """
+ Parse a param spec into to (name, kw).
+
+ The ``spec`` string determines the param name, whether the param is
+ required, and whether the param is multivalue according the following
+ syntax:
+
+ ====== ===== ======== ==========
+ Spec Name Required Multivalue
+ ====== ===== ======== ==========
+ 'var' 'var' True False
+ 'var?' 'var' False False
+ 'var*' 'var' False True
+ 'var+' 'var' True True
+ ====== ===== ======== ==========
+
+ For example,
+
+ >>> parse_param_spec('login')
+ ('login', {'required': True, 'multivalue': False})
+ >>> parse_param_spec('gecos?')
+ ('gecos', {'required': False, 'multivalue': False})
+ >>> parse_param_spec('telephone_numbers*')
+ ('telephone_numbers', {'required': False, 'multivalue': True})
+ >>> parse_param_spec('group+')
+ ('group', {'required': True, 'multivalue': True})
+
+ :param spec: A spec string.
+ """
+ if type(spec) is not str:
+ raise_TypeError(spec, str, 'spec')
+ if len(spec) < 2:
+ raise ValueError(
+ 'param spec must be at least 2 characters; got %r' % spec
+ )
+ _map = {
+ '?': dict(required=False, multivalue=False),
+ '*': dict(required=False, multivalue=True),
+ '+': dict(required=True, multivalue=True),
+ }
+ end = spec[-1]
+ if end in _map:
+ return (spec[:-1], _map[end])
+ return (spec, dict(required=True, multivalue=False))
+
+
+class Param(ReadOnly):
+ """
+ Base class for all IPA types.
+ """
+
+ __kwargs = dict(
+ cli_name=(str, None),
+ doc=(str, ''),
+ required=(bool, True),
+ multivalue=(bool, False),
+ primary_key=(bool, False),
+ normalize=(callable, None),
+ default=(None, None),
+ default_from=(callable, None),
+ flags=(frozenset, frozenset()),
+ )
+
+ def __init__(self, name, **overrides):
+ self.param_spec = name
+ self.name = check_name(name)
+ lock(self)
+
+ def normalize(self, value):
+ """
+ """
+ if self.__normalize is None:
+ return value
+ if self.multivalue:
+ if type(value) in (tuple, list):
+ return tuple(
+ self.__normalize_scalar(v) for v in value
+ )
+ return (self.__normalize_scalar(value),) # Return a tuple
+ return self.__normalize_scalar(value)
+
+ def __normalize_scalar(self, value):
+ """
+ Normalize a scalar value.
+
+ This method is called once for each value in multivalue.
+ """
+ if type(value) is not unicode:
+ return value
+ try:
+ return self.__normalize(value)
+ except StandardError:
+ return value
+
+
+ def convert(self, value):
+ if value in NULLS:
+ return
+ if self.multivalue:
+ if type(value) in (tuple, list):
+ values = filter(
+ lambda val: val not in NULLS,
+ (self._convert_scalar(v, i) for (i, v) in enumerate(value))
+ )
+ if len(values) == 0:
+ return
+ return tuple(values)
+ return (scalar(value, 0),) # Return a tuple
+ return scalar(value)
+
+ def _convert_scalar(self, value, index=None):
+ """
+ Implement in subclass.
+ """
+ raise NotImplementedError(
+ '%s.%s()' % (self.__class__.__name__, '_convert_scalar')
+ )
+
+
+
+
+class Bool(Param):
+ """
+
+ """
+
+
+class Int(Param):
+ """
+
+ """
+
+
+class Float(Param):
+ """
+
+ """
+
+
+class Bytes(Param):
+ """
+
+ """
+
+
+class Str(Param):
+ """
+
+ """
+
+ def __init__(self, name, **overrides):
+ self.type = unicode
+ super(Str, self).__init__(name, **overrides)
+
+ def _convert_scalar(self, value, index=None):
+ if type(value) in (self.type, int, float, bool):
+ return self.type(value)
+ raise TypeError(
+ 'Can only implicitly convert int, float, or bool; got %r' % value
+ )
diff --git a/tests/test_ipalib/test_parameter.py b/tests/test_ipalib/test_parameter.py
new file mode 100644
index 000000000..837bdfef3
--- /dev/null
+++ b/tests/test_ipalib/test_parameter.py
@@ -0,0 +1,93 @@
+# Authors:
+# Jason Gerard DeRose <jderose@redhat.com>
+#
+# Copyright (C) 2008 Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2 only
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+"""
+Test the `ipalib.parameter` module.
+"""
+
+from tests.util import raises, ClassChecker
+from tests.data import binary_bytes, utf8_bytes, unicode_str
+from ipalib import parameter
+
+
+def test_parse_param_spec():
+ """
+ Test the `ipalib.parameter.parse_param_spec` function.
+ """
+ f = parameter.parse_param_spec
+ assert f('name') == ('name', dict(required=True, multivalue=False))
+ assert f('name?') == ('name', dict(required=False, multivalue=False))
+ assert f('name*') == ('name', dict(required=False, multivalue=True))
+ assert f('name+') == ('name', dict(required=True, multivalue=True))
+
+
+class test_Param(ClassChecker):
+ """
+ Test the `ipalib.parameter.Param` class.
+ """
+ _cls = parameter.Param
+
+ def test_init(self):
+ """
+ Test the `ipalib.parameter.Param.__init__` method.
+ """
+ name = 'my_param'
+ o = self.cls(name)
+ assert o.name is name
+ assert o.__islocked__() is True
+
+ def test_convert_scalar(self):
+ """
+ Test the `ipalib.parameter.Param._convert_scalar` method.
+ """
+ o = self.cls('my_param')
+ e = raises(NotImplementedError, o._convert_scalar, 'some value')
+ assert str(e) == 'Param._convert_scalar()'
+ class Subclass(self.cls):
+ pass
+ o = Subclass('my_param')
+ e = raises(NotImplementedError, o._convert_scalar, 'some value')
+ assert str(e) == 'Subclass._convert_scalar()'
+
+
+class test_Str(ClassChecker):
+ """
+ Test the `ipalib.parameter.Str` class.
+ """
+ _cls = parameter.Str
+
+ def test_init(self):
+ """
+ Test the `ipalib.parameter.Str.__init__` method.
+ """
+ o = self.cls('my_str')
+ assert o.type is unicode
+
+ def test_convert_scalar(self):
+ """
+ Test the `ipalib.parameter.Str._convert_scalar` method.
+ """
+ o = self.cls('my_str')
+ for value in (u'Hello', 42, 1.2, True):
+ assert o._convert_scalar(value) == unicode(value)
+ for value in ('Hello', None, [u'42', '42'], dict(hello=u'world')):
+ e = raises(TypeError, o._convert_scalar, value)
+ assert str(e) == \
+ 'Can only implicitly convert int, float, or bool; got %r' % value