From 556abfaf0becbeafa5cad50b2b2866a76e587156 Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Fri, 18 Jul 2008 17:51:34 +0000 Subject: [PATCH] 1: Started roughing out ipalib package --- ipalib/__init__.py | 18 ++++++++++++++ ipalib/base.py | 45 +++++++++++++++++++++++++++++++++++ ipalib/exceptions.py | 50 +++++++++++++++++++++++++++++++++++++++ ipalib/tests/__init__.py | 22 +++++++++++++++++ ipalib/tests/test_base.py | 4 ++++ 5 files changed, 139 insertions(+) create mode 100644 ipalib/__init__.py create mode 100644 ipalib/base.py create mode 100644 ipalib/exceptions.py create mode 100644 ipalib/tests/__init__.py create mode 100644 ipalib/tests/test_base.py diff --git a/ipalib/__init__.py b/ipalib/__init__.py new file mode 100644 index 000000000..8eb39d3cb --- /dev/null +++ b/ipalib/__init__.py @@ -0,0 +1,18 @@ +# Authors: +# Jason Gerard DeRose +# +# 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 diff --git a/ipalib/base.py b/ipalib/base.py new file mode 100644 index 000000000..fabc1acf7 --- /dev/null +++ b/ipalib/base.py @@ -0,0 +1,45 @@ +class Command(object): + def normalize(self, kw): + raise NotImplementedError + + def validate(self, kw): + raise NotImplementedError + + def execute(self, kw): + raise NotImplementedError + + def __call__(self, **kw): + kw = self.normalize(kw) + invalid = self.validate(kw) + if invalid: + return invalid + return self.execute(kw) + + + +class Argument(object): + pass + + +class NameSpace(object): + def __init__(self): + pass + + + + +class API(object): + def __init__(self): + self.__c = object() + self.__o = object() + + def __get_c(self): + return self.__c + c = property(__get_c) + + def __get_o(self): + return self.__o + o = property(__get_o) + + def register_command(self, name, callback, override=False): + pass diff --git a/ipalib/exceptions.py b/ipalib/exceptions.py new file mode 100644 index 000000000..d42ab9f0e --- /dev/null +++ b/ipalib/exceptions.py @@ -0,0 +1,50 @@ +# Authors: +# Jason Gerard DeRose +# +# 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 + +""" +All custom exceptions raised by `ipalib` package. +""" + +class IPAException(Exception): + """ + Use this base class for your custom IPA exceptions unless there is a + specific reason to subclass from AttributeError, KeyError, etc. + """ + format = None + + def __init__(self, *args, **kw): + self.args = args + self.kw = kw + + def __str__(self): + """ + Returns the string representation of this exception. + """ + if self.format is None: + if len(self.args) == 1: + return unicode(self.args[0]) + return unicode(self.args) + if len(self.args) > 0: + return self.format % self.args + return self.format % self.kw + + + +class CommandOverride(IPAException): + format = 'Cannot override command %r' diff --git a/ipalib/tests/__init__.py b/ipalib/tests/__init__.py new file mode 100644 index 000000000..d3658c451 --- /dev/null +++ b/ipalib/tests/__init__.py @@ -0,0 +1,22 @@ +# Authors: +# Jason Gerard DeRose +# +# 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 + +""" +Unit tests for `ipalib` package. +""" diff --git a/ipalib/tests/test_base.py b/ipalib/tests/test_base.py new file mode 100644 index 000000000..73b85c2a3 --- /dev/null +++ b/ipalib/tests/test_base.py @@ -0,0 +1,4 @@ +from ipalib import base + +def test_stuff(): + pass