diff options
author | Jason Gerard DeRose <jderose@redhat.com> | 2008-07-21 01:44:59 +0000 |
---|---|---|
committer | Jason Gerard DeRose <jderose@redhat.com> | 2008-07-21 01:44:59 +0000 |
commit | 7273d48169a6c0dabc1bfb0f42bafb06515fdac9 (patch) | |
tree | 024a1ecf671d046a5330ba98b2f7e7327fd956e3 /ipalib/base.py | |
parent | 48c7da47c78c5b5f97dc01a7593313943aef7b6e (diff) | |
download | freeipa-7273d48169a6c0dabc1bfb0f42bafb06515fdac9.tar.gz freeipa-7273d48169a6c0dabc1bfb0f42bafb06515fdac9.tar.xz freeipa-7273d48169a6c0dabc1bfb0f42bafb06515fdac9.zip |
26: Added AbstractCommand.get_doc() method to return the gettext translated summary of command; added get_doc() method to all example
Diffstat (limited to 'ipalib/base.py')
-rw-r--r-- | ipalib/base.py | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/ipalib/base.py b/ipalib/base.py index a62d5812..522b13b1 100644 --- a/ipalib/base.py +++ b/ipalib/base.py @@ -95,7 +95,7 @@ class NameSpace(object): """ Returns True if namespace has an item named `key`. """ - return key.replace('-', '_') in self.__kw + return bool(key in self.__kw) def __iter__(self): """ @@ -135,17 +135,44 @@ class Named(object): def _get_name(self): return self.__class__.__name__ + def __get_loc(self): + cls = self.__class__ + return '%s.%s' % (cls.__module__, cls.__name__) + loc = property(__get_loc) + def __get_name(self): if self.__name is None: self.__name = self._get_name() return self.__name name = property(__get_name) + def __get_cli_name(self): + return self.name.replace('_', '-') + cli_name = property(__get_cli_name) + class AbstractCommand(object): def __call__(self): print 'You called %s()' % self.name + def get_doc(self, _): + """ + This should return a gettext translated summarary of the command. + + For example, if you were documenting the 'add-user' command, you're + method would look something like this. + + >>> def get_doc(self, _): + >>> return _('add new user') + """ + raise NotImplementedError('%s.%s.%s()' % ( + self.__class__.__module__, + self.__class__.__name__, + 'get_doc', + ) + ) + + class Attribute(Named): __locked = False __obj = None |