Merge pull request #3547 from vkarak/feat/table-format-delim

[feat] Add new `--table-format-delim` option

Author: vkarak

docs/config_reference.rst

@@ -2118,6 +2118,14 @@ General Configuration
    - ``pretty``: (default) Generate a pretty table
 
 
+.. py:attribute:: general.table_format_delim
+
+   :required: No
+   :default: ``","``
+
+   Delimiter to use when emitting tables in CSV format.
+
+
 .. py:attribute:: general.timestamp_dirs
 
    :required: No

docs/manpage.rst

@@ -1204,6 +1204,14 @@ Miscellaneous options
 
    .. versionadded:: 4.7
 
+.. option:: --table-format-delim[=DELIM]
+
+   Delimiter to use when emitting tables in CSV format using the :option:`--table-format=csv` option.
+
+   The default delimiter is ``,``.
+
+   .. versionadded:: 4.9
+
 .. option:: --upgrade-config-file=OLD[:NEW]
 
    Convert the old-style configuration file ``OLD``, place it into the new file ``NEW`` and exit.
@@ -2316,6 +2324,21 @@ Whenever an environment variable is associated with a configuration option, its
 
    .. versionadded:: 4.7
 
+.. envvar:: RFM_TABLE_FORMAT_DELIM
+
+   Delimiter for CSV tables.
+
+
+   .. table::
+      :align: left
+
+      ================================== ==================
+      Associated command line option     :option:`--table-format-delim`
+      Associated configuration parameter :attr:`~config.general.table_format_delim`
+      ================================== ==================
+
+   .. versionadded:: 4.9
+
 
 .. envvar:: RFM_TIMESTAMP_DIRS
 

reframe/frontend/cli.py

@@ -697,6 +697,11 @@ def main():
         help='Table formatting',
         envvar='RFM_TABLE_FORMAT', configvar='general/table_format'
     )
+    misc_options.add_argument(
+        '--table-format-delim', action='store',
+        help='The delimiter to use when using `--table-format=csv`',
+        envvar='RFM_TABLE_FORMAT_DELIM', configvar='general/table_format_delim'
+    )
     misc_options.add_argument(
         '-v', '--verbose', action='count',
         help='Increase verbosity level of output',

reframe/frontend/printer.py

@@ -277,8 +277,9 @@ def performance_report(self, data, **kwargs):
         self.info('')
 
     def _table_as_csv(self, data):
+        delim = rt.runtime().get_option('general/0/table_format_delim')
         for line in data:
-            self.info(','.join(str(x) for x in line))
+            self.info(delim.join(str(x) for x in line))
 
     def table(self, data, **kwargs):
         '''Print tabular data'''

reframe/schemas/config.json

@@ -538,6 +538,7 @@
                     "save_log_files": {"type": "boolean"},
                     "target_systems": {"$ref": "#/defs/system_ref"},
                     "table_format": {"enum": ["csv", "plain", "pretty"]},
+                    "table_format_delim": {"type": "string"},
                     "timestamp_dirs": {"type": "string"},
                     "topology_prefix": {"type": "string"},
                     "trap_job_errors": {"type": "boolean"},
@@ -609,6 +610,7 @@
         "general/resolve_module_conflicts": true,
         "general/save_log_files": false,
         "general/table_format": "pretty",
+        "general/table_format_delim": ",",
         "general/target_systems": ["*"],
         "general/topology_prefix": "${HOME}/.reframe/topology",
         "general/timestamp_dirs": "%Y%m%dT%H%M%S%z",