Merge pull request #7053 from chu11/issue7030_flux_jobs_column_width

python: consider output header w/ expandable width

Author: mergify[bot]

src/bindings/python/flux/util.py

@@ -948,7 +948,7 @@ def format(self, obj):
             raise KeyError(f"Invalid format field {exc} for {typestr}")
         return retval
 
-    def filter(self, items):
+    def filter(self, items, no_header=False):
         """
         Check for format fields that are prefixed with `?:` (e.g. "?:{name}"),
         and filter them out of the current format string if they result in an
@@ -960,6 +960,10 @@ def filter(self, items):
 
         (`?+:` requests both actions: filter out field if it is empty for all
         items, if not expand to maximum width)
+
+        Args:
+            items (iterable): list of items to consider for output
+            no_header (boolean): do not use header in calculations (default: False)
         """
 
         #  Build a list of all format strings that have one of the width
@@ -1000,12 +1004,18 @@ def sentinel_keys():
 
                 #  Save the modified format, index, type, maximum width,
                 #  observed width, and broken-down spec in lst:
+                initialmaxwidth = spec.width or 0
+                if sentinels[end] in ("maxwidth", "both"):
+                    initialmaxwidth = max(
+                        initialmaxwidth,
+                        0 if no_header else len(self.headings.get(field, "")),
+                    )
                 lst.append(
                     dict(
                         fmt=fmt,
                         index=index,
                         type=sentinels[end],
-                        maxwidth=spec.width or 0,
+                        maxwidth=initialmaxwidth,
                         width=0,
                         spec=spec,
                     )
@@ -1129,7 +1139,7 @@ def print_items(self, items, no_header=False, pre=None, post=None):
             post (callable): Function to call after printing each item
         """
         #  Preprocess original format by processing with filter():
-        newfmt = self.filter(items)
+        newfmt = self.filter(items, no_header=no_header)
         #  Get the current class for creating a new formatter instance:
         cls = self.__class__
         #  Create new instance of the current class from filtered format:

src/cmd/flux-jobs.py

@@ -545,7 +545,7 @@ def main():
         formatter.set_sort_keys(args.sort)
 
     (jobs, truncated) = fetch_jobs(args, formatter.fields)
-    sformatter = JobInfoFormat(formatter.filter(jobs))
+    sformatter = JobInfoFormat(formatter.filter(jobs, no_header=args.no_header))
 
     if not args.no_header:
         print(sformatter.header())

src/cmd/flux-pgrep.py

@@ -274,7 +274,7 @@ def main():
     if PROGRAM == "flux-pkill":
         pkill(fh, args, jobs)
 
-    sformatter = JobInfoFormat(formatter.filter(jobs))
+    sformatter = JobInfoFormat(formatter.filter(jobs, no_header=args.no_header))
 
     # "default" can be overridden by environment variable, so check if
     # it's different than the builtin default

t/python/t0024-util.py

@@ -212,9 +212,15 @@ def test_filter(self):
         ).filter(items)
         self.assertEqual(fmt, "{i:>8} {f:8.2}")
 
+        # N.B. float has a width of 5 due to "FLOAT" header
         fmt = OutputFormat(
             "?+:{i:>7} ?:{s:>6} ?+:{f:.2f}", headings=self.headings
         ).filter(items)
+        self.assertEqual(fmt, "{i:>8} {f:5.2f}")
+
+        fmt = OutputFormat(
+            "?+:{i:>7} ?:{s:>6} ?+:{f:.2f}", headings=self.headings
+        ).filter(items, no_header=True)
         self.assertEqual(fmt, "{i:>8} {f:3.2f}")
 
     def test_sort(self):
@@ -261,10 +267,17 @@ def test_issue6530(self):
         b = Item("abcdefghijklmnop", 2, 13)
         c = Item("c", 4, 5.0)
 
+        # N.B. iinteger has a width of 7 due to "INTEGER" header
+        # N.B. float has a width of 5 due to "FLOAT" header
         items = [a, b, c]
         fmt = OutputFormat(
             "+:{s:5.5} +:{i:4d} +:{f:.2f}", headings=self.headings
         ).filter(items)
+        self.assertEqual(fmt, "{s:16.16} {i:7d} {f:5.2f}")
+
+        fmt = OutputFormat(
+            "+:{s:5.5} +:{i:4d} +:{f:.2f}", headings=self.headings
+        ).filter(items, no_header=True)
         self.assertEqual(fmt, "{s:16.16} {i:4d} {f:3.2f}")
 
     def test_copy(self):

t/t2800-jobs-cmd.t

@@ -209,6 +209,18 @@ test_expect_success 'flux-jobs: specified width overrides expandable field' '
 	test_debug "cat expanded2.out" &&
 	grep "^   nosuchcommand" expanded2.out
 '
+# N.B. if header was not accounted for, the job name "a" would not be
+# right aligned by three spaces (header is "NAME")
+test_expect_success 'flux-jobs: header accounted for in expandable field' '
+	echo "{\"id\":195823665152,\"state\":8,\"name\":\"a\"}" \
+		| flux jobs --from-stdin -o "+:{name:>1}" > expanded3.out &&
+	grep "^   a" expanded3.out
+'
+test_expect_success 'flux-jobs: header not accounted for in expandable field if no header output' '
+	echo "{\"id\":195823665152,\"state\":8,\"name\":\"a\"}" \
+		| flux jobs --from-stdin -no "+:{name:>1}" > expanded3.out &&
+	grep "^a" expanded3.out
+'
 test_expect_success 'flux-jobs: collapsible+expandable fields work' '
 	flux jobs -ao "{id.f58:<12} ?+:{exception.type:>1}" >both.out &&
 	flux jobs -f running,completed \