add apt-get-sqq command parser

jc/parsers/apt_get_sqq.py

@@ -0,0 +1,139 @@
+"""jc - JSON Convert `apt-get -sqq` command output parser
+
+Requires the `-sqq` options in `apt-get`.
+
+Usage (cli):
+
+    $ apt-get -sqq | jc --apt-get-sqq
+
+or
+
+    $ jc apt-get -sqq
+
+Usage (module):
+
+    import jc
+    result = jc.parse('apt_get_sqq', apt_get_sqq_command_output)
+
+Schema:
+
+    [
+      {
+        "operation":            string,  # configure, remove, or unpack
+        "package":              string,
+        "broken":               string or null,
+        "proposed_pkg_ver":     string,
+        "existing_src":         string,
+        "architecture":         string
+      }
+    ]
+
+Examples:
+
+    $ foo | jc --foo -p
+    []
+
+    $ foo | jc --foo -p -r
+    []
+"""
+import re
+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 = '`apt-get -sqq` command parser'
+    author = 'Kelly Brazil'
+    author_email = 'kellyjonbrazil@gmail.com'
+    compatible = ['linux']
+    tags = ['command']
+    magic_commands = ['apt-get -sqq']
+
+
+__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] = []
+
+    if jc.utils.has_data(data):
+
+        # Inst dpkg [1.19.7] (1.19.8 Debian:10.13/oldstable, Debian-Security:10/oldstable [amd64])
+        #  |    |     |                       |                        |                    \architecture
+        #  |    |     |                       |                         \existing_src
+        #  |    |     |                        \proposed_pkg_ver
+        #  |    |      \broken (optional)
+        #  |     \package
+        #   \operation (configure, remove, or unpack)
+
+        line_re = re.compile(r'(?P<operation>Inst|Conf|Remv)\s(?P<package>\S+)(?P<broken>\s+\[\S*?\])?\s\((?P<packages_pe>.*?)\[(?P<architecture>\w*)\]\)')
+
+        for line in filter(None, data.splitlines()):
+            broken_val = None
+            packages_pe = None
+            proposed_pkg_ver = None
+            existing_src = None
+            parsed_line = line_re.match(line)
+
+            if parsed_line:
+                parsed_dict = parsed_line.groupdict()
+
+                if parsed_dict['broken']:
+                    broken_val = parsed_dict['broken'].strip()[1:-1]
+
+                if parsed_dict['packages_pe']:
+                    packages_pe = parsed_dict['packages_pe'].split(',')
+                    proposed_pkg_ver = packages_pe[0].strip()
+                    if len(packages_pe) == 2:
+                        existing_src = packages_pe[1].strip()
+
+                output_line = {
+                    'operation': parsed_dict['operation'],
+                    'package': parsed_dict['package'],
+                    'broken': broken_val,
+                    'proposed_pkg_ver': proposed_pkg_ver,
+                    'existing_src': existing_src,
+                    'architecture': parsed_dict['architecture']
+                }
+
+                raw_output.append(output_line)
+
+    return raw_output if raw else _process(raw_output)