Changeset 2652

Timestamp:

Jun 10, 2010 11:17:35 AM (11 years ago)

Author:

prsteel

Message:

Changed error checking logic for all derived classes of Component.

Before, IndexedComponent? would perform error checking to ensure that a
ctype was being passed to the Component constructor. Now that error
checking occurs in Component; this is to allow classes to derive from
Component without also deriving from IndexedComponent?.

N.B. If you inherit from Component via a 'diamond' inheritance
structure, e.g., class foo(IndexedComponent?, DerivedComponent?), you
need to pass ctype arguments to both IndexedComponent?.init and
DerivedComponent?.init to avoid Component throwing an exception. I
believe this could be avoided by using super() calls, but I haven't
looked into it.

N.B. Created an exception class DeveloperError?, which is used to
indicate an internal Pyomo error that a user *should* never see. In
this case it was used to throw an exception if Component.init does
not receive a non-None ctype argument. This exception should be thrown
due to internal Pyomo code, not user modeling.

Location:

coopr.pyomo/trunk/coopr/pyomo/base

Files:

• component.py (modified) (2 diffs)
• indexed_component.py (modified) (1 diff)

coopr.pyomo/trunk/coopr/pyomo/base/component.py

@@ -10 +10 @@
     implements(IModelComponent)
 
-    def __init__(self, ctype):
+    def __init__(self, ctype=None):
+
+        # Error check for ctype
+        if ctype is None:
+            raise DeveloperError, "Must specify a class for the component type!"
+
         self.active=True
         self._type=ctype
@@ -28 +33 @@
         pass
 
+class DeveloperError(Exception):
+    """
+    Exception class used to throw errors stemming from Pyomo programming
+    errors, rather than user modeling errors (e.g., a component not declaring
+    a 'ctype')
+    """
+
+    def __init__(self, val):
+        self.parameter = val
+
+    def __str__(self):
+        return repr(self.parameter)

coopr.pyomo/trunk/coopr/pyomo/base/indexed_component.py

@@ -7 +7 @@
 
     def __init__(self, *args, **kwds):
-        if 'ctype' not in kwds:
-            raise ValueError, "Must specify a class for the component type!"
-        Component.__init__(self, kwds['ctype'])
+
+        # Don't be afraid to pass None, correct 'ctype' can be passed via
+        # other routes. Error handling now in Component
+        component_type = kwds.get('ctype', None)
+        Component.__init__(self, component_type)
+        
         self._ndim=0
         self._index_set=None