add zpool-iostat parser

jc/lib.py

@@ -200,7 +200,8 @@ parsers: List[str] = [
     'xml',
     'xrandr',
     'yaml',
-    'zipinfo'
+    'zipinfo',
+    'zpool-iostat'
 ]
 
 def _cliname_to_modname(parser_cli_name: str) -> str:

jc/parsers/zpool_iostat.py

@@ -0,0 +1,131 @@
+"""jc - JSON Convert `zpool iostat` command output parser
+
+<<Short zpool description and caveats>>
+
+Usage (cli):
+
+    $ zpool iostat | jc --zpool-iostat
+
+or
+
+    $ jc zpool iostat
+
+Usage (module):
+
+    import jc
+    result = jc.parse('zpool_iostat', zpool_iostat_command_output)
+
+Schema:
+
+    [
+      {
+        "zpool":     string,
+        "bar":     boolean,
+        "baz":     integer
+      }
+    ]
+
+Examples:
+
+    $ zpool iostat | jc --zpool-iostat -p
+    []
+
+    $ zpool iostat | jc --zpool-iostat -p -r
+    []
+"""
+from typing import List, Dict
+from jc.jc_types import JSONDictType
+import jc.utils
+
+
+class info():
+    """Provides parser metadata (version, author, etc.)"""
+    version = '1.0'
+    description = '`zpool iostat` command parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    compatible = ['linux', 'darwin', 'freebsd']
+    tags = ['command']
+    magic_commands = ['zpool iostat']
+
+
+__version__ = info.version
+
+
+def _process(proc_data: List[JSONDictType]) -> List[JSONDictType]:
+    """
+    Final processing to conform to the schema.
+
+    Parameters:
+
+        proc_data:   (List of Dictionaries) raw structured data to process
+
+    Returns:
+
+        List of Dictionaries. Structured to conform to the schema.
+    """
+    return proc_data
+
+
+def parse(
+    data: str,
+    raw: bool = False,
+    quiet: bool = False
+) -> List[JSONDictType]:
+    """
+    Main text parsing function
+
+    Parameters:
+
+        data:        (string)  text data to parse
+        raw:         (boolean) unprocessed output if True
+        quiet:       (boolean) suppress warning messages if True
+
+    Returns:
+
+        List of Dictionaries. Raw or processed structured data.
+    """
+    jc.utils.compatibility(__name__, info.compatible, quiet)
+    jc.utils.input_type_check(data)
+
+    raw_output: List[Dict] = []
+    output_line: Dict = {}
+    pool_parent = ''
+
+    if jc.utils.has_data(data):
+
+        for line in filter(None, data.splitlines()):
+
+            # skip non-data lines
+            if '---' in line or \
+                line.strip().endswith('bandwidth') or \
+                line.strip().endswith('write'):
+                continue
+
+            # data lines
+            line_list = line.strip().split()
+            if line.startswith(' '):
+                output_line = {
+                        "pool": line_list[0],
+                        "parent": pool_parent
+                }
+
+            else:
+                pool_parent = line_list[0]
+                output_line = {
+                    "pool": pool_parent
+                }
+
+            output_line.update(
+                {
+                    'cap_alloc': line_list[1],
+                    'cap_free': line_list[2],
+                    'ops_read': line_list[3],
+                    'ops_write': line_list[4],
+                    'bw_read': line_list[5],
+                    'bw_write': line_list[6]
+                }
+            )
+            raw_output.append(output_line)
+
+    return raw_output if raw else _process(raw_output)