Classes inherit parent's docstring

optlang/cplex_interface.py

@@ -35,6 +35,7 @@
 from sympy.core.singleton import S
 import cplex
 from optlang import interface
+from optlang.util import inheritdocstring
 Zero = S.Zero
 One = S.One
 
@@ -146,8 +147,8 @@ def _constraint_lb_and_ub_to_cplex_sense_rhs_and_range_value(lb, ub):
     return sense, rhs, range_value
 
 
+@six.add_metaclass(inheritdocstring)
 class Variable(interface.Variable):
-    """CPLEX variable interface."""
 
     def __init__(self, name, *args, **kwargs):
         super(Variable, self).__init__(name, **kwargs)
@@ -195,8 +196,8 @@ def dual(self):
             return None
 
 
+@six.add_metaclass(inheritdocstring)
 class Constraint(interface.Constraint):
-    """CPLEX solver interface"""
 
     _INDICATOR_CONSTRAINT_SUPPORT = True
 
@@ -308,6 +309,7 @@ def __iadd__(self, other):
         return self
 
 
+@six.add_metaclass(inheritdocstring)
 class Objective(interface.Objective):
     def __init__(self, *args, **kwargs):
         super(Objective, self).__init__(*args, **kwargs)
@@ -327,6 +329,7 @@ def __setattr__(self, name, value):
             super(Objective, self).__setattr__(name, value)
 
 
+@six.add_metaclass(inheritdocstring)
 class Configuration(interface.MathematicalProgrammingConfiguration):
 
     def __init__(self, lp_method='primal', tolerance=1e-9, presolve=False, verbosity=0, timeout=None,
@@ -500,6 +503,7 @@ def qp_method(self, value):
         self._qp_method = value
 
 
+@six.add_metaclass(inheritdocstring)
 class Model(interface.Model):
     def __init__(self, problem=None, *args, **kwargs):
 

optlang/glpk_interface.py

@@ -28,6 +28,8 @@
 from sympy.core.add import _unevaluated_Add
 from sympy.core.mul import _unevaluated_Mul
 
+from optlang.util import inheritdocstring
+
 import logging
 log = logging.getLogger(__name__)
 
@@ -67,8 +69,8 @@
 )
 
 
+@six.add_metaclass(inheritdocstring)
 class Variable(interface.Variable):
-    """..."""
 
     def __init__(self, name, index=None, *args, **kwargs):
         super(Variable, self).__init__(name, **kwargs)
@@ -137,8 +139,8 @@ def __setattr__(self, name, value):
                 glp_set_col_name(self.problem.problem, glp_find_col(self.problem.problem, old_name), str(value))
 
 
+@six.add_metaclass(inheritdocstring)
 class Constraint(interface.Constraint):
-    """GLPK solver interface"""
 
     _INDICATOR_CONSTRAINT_SUPPORT = False
 
@@ -284,6 +286,7 @@ def __idiv__(self, other):
         return self
 
 
+@six.add_metaclass(inheritdocstring)
 class Objective(interface.Objective):
     def __init__(self, *args, **kwargs):
         super(Objective, self).__init__(*args, **kwargs)
@@ -349,8 +352,8 @@ def __idiv__(self, other):
         return self
 
 
+@six.add_metaclass(inheritdocstring)
 class Configuration(interface.MathematicalProgrammingConfiguration):
-    """docstring for Configuration"""
 
     def __init__(self, presolve=False, verbosity=0, timeout=None, *args, **kwargs):
         super(Configuration, self).__init__(*args, **kwargs)
@@ -433,8 +436,9 @@ def timeout(self, value):
         self._set_timeout(value)
         self._timeout = value
 
+
+@six.add_metaclass(inheritdocstring)
 class Model(interface.Model):
-    """GLPK solver interface"""
 
     def __init__(self, problem=None, *args, **kwargs):
 

optlang/util.py

@@ -23,6 +23,7 @@
 
 log = logging.getLogger(__name__)
 import tempfile
+import inspect
 from subprocess import check_output
 
 
@@ -134,6 +135,20 @@ def list_available_solvers():
     return solvers
 
 
+def inheritdocstring(name, bases, attrs):
+    """Use as metaclass to inherit parent class' docstring.
+    From http://stackoverflow.com/questions/13937500/inherit-a-parent-class-docstring-as-doc-attribute"""
+    if '__doc__' not in attrs or not attrs["__doc__"]:
+        # create a temporary 'parent' to (greatly) simplify the MRO search
+        temp = type('temporaryclass', bases, {})
+        for cls in inspect.getmro(temp):
+            if cls.__doc__ is not None:
+                attrs['__doc__'] = cls.__doc__
+                break
+
+    return type(name, bases, attrs)
+
+
 if __name__ == '__main__':
     from swiglpk import glp_create_prob, glp_read_lp, glp_get_num_rows