add host parser

2026-06-19 22:28:17 +02:00 · 2023-09-30 15:32:27 -07:00
parent 36fa08d711
commit d3c7cec333
7 changed files with 132 additions and 16 deletions
@@ -0,0 +1,113 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.host"></a>
+
+# jc.parsers.host
+
+jc - JSON Convert `host` command output parser
+
+Supports parsing of the most commonly used RR types (A, AAAA, MX, TXT)
+
+Usage (cli):
+
+    $ host google.com | jc --host
+
+or
+
+    $ jc host google.com
+
+Usage (module):
+
+    import jc
+    result = jc.parse('host', host_command_output)
+
+Schema:
+
+    [
+      {
+        "hostname":     string,
+        "address": [
+                        string
+        ],
+        "v6-address": [
+                        string
+        ],
+        "mail": [
+                        string
+        ]
+      }
+    ]
+
+    [
+      {
+        "nameserver":   string,
+        "zone":         string,
+        "mname":        string,
+        "rname":        string,
+        "serial":       integer,
+        "refresh":      integer,
+        "retry":        integer,
+        "expire":       integer,
+        "minimum":      integer
+      }
+    ]
+
+Examples:
+
+    $ host google.com | jc --host
+    [
+      {
+        "hostname": "google.com",
+        "address": [
+          "142.251.39.110"
+        ],
+        "v6-address": [
+          "2a00:1450:400e:811::200e"
+        ],
+        "mail": [
+          "smtp.google.com."
+        ]
+      }
+    ]
+
+    $ jc host -C sunet.se
+    [
+      {
+        "nameserver": "2001:6b0:7::2",
+        "zone": "sunet.se",
+        "mname": "sunic.sunet.se.",
+        "rname": "hostmaster.sunet.se.",
+        "serial": "2023090401",
+        "refresh": "28800",
+        "retry": "7200",
+        "expire": "604800",
+        "minimum": "300"
+      },
+      {
+        ...
+      }
+    ]
+
+<a id="jc.parsers.host.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False)
+```
+
+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.
+
+### Parser Information
+Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
+
+Version 1.0 by Pettai (pettai@sunet.se)