add shell output formatter for single items

1 files changed, 31 insertions, 0 deletions

diff --git a/cliff/formatters/shell.py b/cliff/formatters/shell.py
new file mode 100644
index 0000000..a490550
--- /dev/null
+++ b/cliff/formatters/shell.py
@@ -0,0 +1,31 @@
+"""Output formatters using shell syntax.
+"""
+
+from .base import SingleFormatter
+
+
+class ShellFormatter(SingleFormatter):
+
+    def add_argument_group(self, parser):
+        group = parser.add_argument_group(
+            title='shell formatter',
+            description='Print values in a format a UNIX shell can parse (variable="value")',
+            )
+        group.add_argument(
+            '--variable',
+            action='append',
+            default=[],
+            dest='variables',
+            metavar='VARIABLE',
+            help='specify the variable(s) to include, can be repeated',
+            )
+
+    def emit_one(self, column_names, data, stdout, parsed_args):
+        variable_names = [c.lower().replace(' ', '_')
+                          for c in column_names
+                          ]
+        desired_columns = parsed_args.variables
+        for name, value in zip(variable_names, data):
+            if name in desired_columns or not desired_columns:
+                stdout.write('%s="%s"\n' % (name, value))
+        return