Add parameter filtering to RecipeOrganizer.show.

Allow filtering of recipe parameters with a regular expression pattern.
Sort constraints and restraints according to numeric values within names.
Add optional `show` argument `textwidth` to adjust output trimming.

Author: pavoljuhas

diffpy/srfit/fitbase/recipeorganizer.py

@@ -40,6 +40,7 @@
 from diffpy.srfit.util.nameutils import validateName
 from diffpy.srfit.interface import _recipeorganizer_interface
 from diffpy.srfit.util import _DASHEDLINE
+from diffpy.srfit.util import sortKeyForNumericString as numstr
 
 
 class RecipeContainer(Observable, Configurable, Validatable):
@@ -878,13 +879,10 @@ def _formatManaged(self, prefix=""):
         Returns
         -------
         list
-            List of formatted lines per each Parameter together with
-            a leading header and separator lines.  Return empty list
-            when no parameters were defined.
+            List of formatted lines, one per each Parameter.
         """
         lines = []
         formatstr = "{:<W}{}"
-        toplevel = not prefix
         # Format own parameters.
         if self._parameters:
             w0 = max(len(n) for n in self._parameters)
@@ -899,9 +897,6 @@ def _formatManaged(self, prefix=""):
                 tlines = obj._formatManaged(prefix=oprefix)
                 lines.extend([""] if lines and tlines else [])
                 lines.extend(tlines)
-        # Insert header lines if there are defined parameters.
-        if toplevel and lines:
-            lines[:0] = ["Parameters", _DASHEDLINE]
         return lines
 
 
@@ -914,9 +909,8 @@ def _formatConstraints(self):
         Returns
         -------
         list
-            List of formatted lines displaying the defined constraints
-            together with a leading header.  Return empty list when no
-            constraints were defined.
+            List of formatted lines displaying the defined constraints.
+            Return empty list when no constraints were defined.
         """
         cdict = self._getConstraints()
         # Find each constraint and format the equation
@@ -928,10 +922,7 @@ def _formatConstraints(self):
                 clines.append("%s <-- %s" % (locstr, con.eqstr))
             else:
                 clines.append("%s <-- %s" % (par.name, con.eqstr))
-        if clines:
-            # FIXME try to reuse constraints ordering as in FitRecipe._prepare
-            clines.sort()
-            clines[:0] = ["Constraints", _DASHEDLINE]
+        clines.sort(key=numstr)
         return clines
 
 
@@ -944,48 +935,66 @@ def _formatRestraints(self):
         Returns
         -------
         list
-            List of formatted lines displaying the defined restraints
-            together with a leading header.  Return empty list when no
-            restraints were defined.
+            List of formatted lines displaying the defined restraints.
+            Return empty list when no restraints were defined.
         """
         rset = self._getRestraints()
         rlines = []
         for res in rset:
             line = "%s: lb = %f, ub = %f, sig = %f, scaled = %s"%\
                     (res.eqstr, res.lb, res.ub, res.sig, res.scaled)
             rlines.append(line)
-        if rlines:
-            rlines.sort()
-            rlines[:0] = ["Restraints", _DASHEDLINE]
+        rlines.sort(key=numstr)
         return rlines
 
 
-    def show(self):
-        """Show the configuration on screen.
+    def show(self, pattern="", textwidth=78):
+        """Show the configuration hierarchy on the screen.
 
-        This will print a summary of all contained objects.
+        This will print out a summary of all contained objects.
+
+        Parameters
+        ----------
+        pattern : str, optional
+            Limit output to only those parameters that match this regular
+            expression (match all by default).
+        textwidth : int, optional
+            Trim formatted lines at this text width to avoid folding at
+            the screen width.  Do not trim when negative or 0.
         """
+        regexp = re.compile(pattern)
+        pmatch = lambda s : (len(s.split(None, 1)) < 2 or
+                             regexp.search(s.split(None, 1)[0]))
         # Show sub objects and their parameters
         lines = []
         tlines = self._formatManaged()
-        lines.extend(tlines)
+        if tlines:
+            lines.extend(["Parameters", _DASHEDLINE])
+            lines.extend(filter(pmatch, tlines))
 
         # FIXME - parameter names in equations not particularly informative
         # Show constraints
         tlines = self._formatConstraints()
-        if lines and tlines:
-            lines.append("")
-        lines.extend(tlines)
+        if tlines:
+            if lines:
+                lines.append("")
+            lines.extend(["Constraints", _DASHEDLINE])
+            lines.extend(filter(pmatch, tlines))
 
         # FIXME - parameter names in equations not particularly informative
         # Show restraints
         tlines = self._formatRestraints()
-        if lines and tlines:
-            lines.append("")
-        lines.extend(tlines)
-
-        print "\n".join(lines)
-
+        if tlines:
+            if lines:
+                lines.append("")
+            lines.extend(["Restraints", _DASHEDLINE])
+            lines.extend(filter(pmatch, tlines))
+
+        # Determine effective text width tw.
+        tw = textwidth if (textwidth is not None and textwidth > 0) else None
+        # Avoid outputting "\n" when there is no output.
+        if lines:
+            print("\n".join(s[:tw] for s in lines))
         return
 
 # End RecipeOrganizer