From f656e31a7ee366c57d959e4a3e4b9a935eb2cc07 Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Fri, 8 Aug 2008 16:43:24 +0000 Subject: [PATCH] 80: Cleaned up docstring for option.normalize() --- ipalib/public.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/ipalib/public.py b/ipalib/public.py index 071d905d3..07f03ef83 100644 --- a/ipalib/public.py +++ b/ipalib/public.py @@ -52,14 +52,17 @@ class option(object): )) __rules = None + # type = unicode, int, float # Set in subclass + def normalize(self, value): """ - Normalize an input value. The base class implementation only does - type coercion, but subclasses might do other normalization (e.g., a - str option might strip leading and trailing white-space). + Returns the normalized form of `value`. If `value` cannot be + normalized, NormalizationError is raised, which is a subclass of + ValidationError. - If value cannot be normalized, NormalizationError is raised, which - is a subclass of ValidationError. + The base class implementation only does type coercion, but subclasses + might do other normalization (e.g., a unicode option might strip + leading and trailing white-space). """ try: return self.type(value)