Merge pull request #256 from kellyjonbrazil/dev

v1.20.1

CHANGELOG

@@ -1,5 +1,13 @@
 jc changelog
 
+20220615 v1.20.1
+- Add `postconf -M` parser tested on linux
+- Update `asciitable` and `asciitable-m` parsers to preserve case in key
+  names when using the `-r` or `raw=True` options.
+- Add long options (e.g. `--help`, `--about`, `--pretty`, etc.)
+- Add shell completions for Bash and Zsh
+- Fix `id` parser for cases where the user or group name is not present
+
 20220531 v1.20.0
 - Add YAML output option with `-y`
 - Add `top -b` standard and streaming parsers tested on linux

EXAMPLES.md

@@ -2728,6 +2728,36 @@ pip show wrapt wheel | jc --pip-show -p          # or:  jc -p pip show wrapt whe
   }
 ]
 ```
+### postconf -M
+```bash
+postconf -M | jc --postconf -p          # or jc -p postconf -M
+```
+```json
+[
+  {
+    "service_name": "smtp",
+    "service_type": "inet",
+    "private": false,
+    "unprivileged": null,
+    "chroot": true,
+    "wake_up_time": null,
+    "process_limit": null,
+    "command": "smtpd",
+    "no_wake_up_before_first_use": null
+  },
+  {
+    "service_name": "pickup",
+    "service_type": "unix",
+    "private": false,
+    "unprivileged": null,
+    "chroot": true,
+    "wake_up_time": 60,
+    "process_limit": 1,
+    "command": "pickup",
+    "no_wake_up_before_first_use": false
+  }
+]
+```
 ### ps
 ```bash
 ps -ef | jc --ps -p          # or:  jc -p ps -ef
@@ -3465,6 +3495,105 @@ timedatectl | jc --timedatectl -p          # or: jc -p timedatectl
   "epoch_utc": 1583888001
 }
 ```
+### tob -b
+```bash
+top -b -n 1 | jc --top -p          # or jc -p tob -b -n 1
+```
+```json
+[
+  {
+    "time": "11:20:43",
+    "uptime": 118,
+    "users": 2,
+    "load_1m": 0.0,
+    "load_5m": 0.01,
+    "load_15m": 0.05,
+    "tasks_total": 108,
+    "tasks_running": 2,
+    "tasks_sleeping": 106,
+    "tasks_stopped": 0,
+    "tasks_zombie": 0,
+    "cpu_user": 5.6,
+    "cpu_sys": 11.1,
+    "cpu_nice": 0.0,
+    "cpu_idle": 83.3,
+    "cpu_wait": 0.0,
+    "cpu_hardware": 0.0,
+    "cpu_software": 0.0,
+    "cpu_steal": 0.0,
+    "mem_total": 3.7,
+    "mem_free": 3.3,
+    "mem_used": 0.2,
+    "mem_buff_cache": 0.2,
+    "swap_total": 2.0,
+    "swap_free": 2.0,
+    "swap_used": 0.0,
+    "mem_available": 3.3,
+    "processes": [
+      {
+        "pid": 2225,
+        "user": "kbrazil",
+        "priority": 20,
+        "nice": 0,
+        "virtual_mem": 158.1,
+        "resident_mem": 2.2,
+        "shared_mem": 1.6,
+        "status": "running",
+        "percent_cpu": 12.5,
+        "percent_mem": 0.1,
+        "time_hundredths": "0:00.02",
+        "command": "top",
+        "parent_pid": 1884,
+        "uid": 1000,
+        "real_uid": 1000,
+        "real_user": "kbrazil",
+        "saved_uid": 1000,
+        "saved_user": "kbrazil",
+        "gid": 1000,
+        "group": "kbrazil",
+        "pgrp": 2225,
+        "tty": "pts/0",
+        "tty_process_gid": 2225,
+        "session_id": 1884,
+        "thread_count": 1,
+        "last_used_processor": 0,
+        "time": "0:00",
+        "swap": 0.0,
+        "code": 0.1,
+        "data": 1.0,
+        "major_page_fault_count": 0,
+        "minor_page_fault_count": 736,
+        "dirty_pages_count": 0,
+        "sleeping_in_function": null,
+        "flags": "..4.2...",
+        "cgroups": "1:name=systemd:/user.slice/user-1000.+",
+        "supplementary_gids": [
+          10,
+          1000
+        ],
+        "supplementary_groups": [
+          "wheel",
+          "kbrazil"
+        ],
+        "thread_gid": 2225,
+        "environment_variables": [
+          "XDG_SESSION_ID=2",
+          "HOSTNAME=localhost"
+        ],
+        "major_page_fault_count_delta": 0,
+        "minor_page_fault_count_delta": 4,
+        "used": 2.2,
+        "ipc_namespace_inode": 4026531839,
+        "mount_namespace_inode": 4026531840,
+        "net_namespace_inode": 4026531956,
+        "pid_namespace_inode": 4026531836,
+        "user_namespace_inode": 4026531837,
+        "nts_namespace_inode": 4026531838
+      }
+    ]
+  }
+]
+```
 ### tracepath
 ```bash
 tracepath6 3ffe:2400:0:109::2 | jc --tracepath -p

README.md

@@ -210,6 +210,7 @@ option.
 | `       --ping-s` | `ping` and `ping6` command streaming parser             | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ping_s)           |
 | `     --pip-list` | `pip list` command parser                               | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_list)         |
 | `     --pip-show` | `pip show` command parser                               | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_show)         |
+| `     --postconf` | `postconf -M` command parser                            | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/postconf)         |
 | `           --ps` | `ps` command parser                                     | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ps)               |
 | `        --route` | `route` command parser                                  | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/route)            |
 | `       --rpm-qi` | `rpm -qi` command parser                                | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/rpm_qi)           |
@@ -250,22 +251,21 @@ option.
 | `      --zipinfo` | `zipinfo` command parser                                | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/zipinfo)          |
 
 ### Options
-- `-a` about `jc`. Prints information about `jc` and the parsers (in JSON or
-       YAML, of course!)
-- `-C` force color output even when using pipes (overrides `-m` and the
-       `NO_COLOR` env variable)
-- `-d` debug mode. Prints trace messages if parsing issues are encountered (use
-       `-dd` for verbose debugging)
-- `-h` help. Use `jc -h --parser_name` for parser documentation
-- `-m` monochrome JSON output
-- `-p` pretty format the JSON output
-- `-q` quiet mode. Suppresses parser warning messages (use `-qq` to ignore
-       streaming parser errors)
-- `-r` raw output. Provides a more literal JSON output, typically with string
-       values and no additional semantic processing
-- `-u` unbuffer output
-- `-v` version information
-- `-y` YAML output
+| Short | Long            | Description                                                                                                  |
+|-------|-----------------|--------------------------------------------------------------------------------------------------------------|
+| `-a`  | `--about`       | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!)                      |
+| `-C`  | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable)                    |
+| `-d`  | `--debug`       | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging)         |
+| `-h`  | `--help`        | Help. Use `jc -h --parser_name` for parser documentation                                                     |
+| `-m`  | `--monochrome`  | Monochrome output                                                                                            |
+| `-p`  | `--pretty`      | Pretty format the JSON output                                                                                |
+| `-q`  | `--quiet`       | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors)                 |
+| `-r`  | `--raw`         | Raw output. Provides more literal output, typically with string values and no additional semantic processing |
+| `-u`  | `--unbuffer`    | Unbuffer output                                                                                              |
+| `-v`  | `--version`     | Version information                                                                                          |
+| `-y`  | `--yaml-out`    | YAML output                                                                                                  |
+| `-B`  | `--bash-comp`   | Generate Bash shell completion script                                                                        |
+| `-Z`  | `--zsh-comp`    | Generate Zsh shell completion script                                                                         |
 
 ### Exit Codes
 Any fatal errors within `jc` will generate an exit code of `100`, otherwise the

docs/parsers/asciitable.md

@@ -59,6 +59,9 @@ etc...
 Headers (keys) are converted to snake-case. All values are returned as
 strings, except empty strings, which are converted to None/null.
 
+> Note: To preserve the case of the keys use the `-r` cli option or
+> `raw=True` argument in `parse()`.
+
 Usage (cli):
 
     $ cat table.txt | jc --asciitable
@@ -141,4 +144,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/asciitable_m.md

@@ -29,6 +29,9 @@ Headers (keys) are converted to snake-case and newlines between multi-line
 headers are joined with an underscore. All values are returned as strings,
 except empty strings, which are converted to None/null.
 
+> Note: To preserve the case of the keys use the `-r` cli option or
+> `raw=True` argument in `parse()`.
+
 > Note: table column separator characters (e.g. `|`) cannot be present
 > inside the cell data. If detected, a warning message will be printed to
 > `STDERR` and the line will be skipped. The warning message can be
@@ -126,4 +129,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.2 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/id.md

@@ -128,4 +128,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, aix, freebsd
 
-Version 1.4 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.5 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/ini.md

@@ -11,9 +11,10 @@ Parses standard `INI` files and files containing simple key/value pairs.
 - Comment prefix can be `#` or `;`. Comments must be on their own line.
 - If duplicate keys are found, only the last value will be used.
 
-> Note: Values starting and ending with quotation marks will have the marks
-> removed. If you would like to keep the quotation marks, use the `-r`
-> command-line argument or the `raw=True` argument in `parse()`.
+> Note: Values starting and ending with double or single quotation marks
+> will have the marks removed. If you would like to keep the quotation
+> marks, use the `-r` command-line argument or the `raw=True` argument in
+> `parse()`.
 
 Usage (cli):
 
@@ -91,4 +92,4 @@ Returns:
 ### Parser Information
 Compatibility:  linux, darwin, cygwin, win32, aix, freebsd
 
-Version 1.6 by Kelly Brazil (kellyjonbrazil@gmail.com)
+Version 1.7 by Kelly Brazil (kellyjonbrazil@gmail.com)

docs/parsers/postconf.md

@@ -0,0 +1,115 @@
+[Home](https://kellyjonbrazil.github.io/jc/)
+<a id="jc.parsers.postconf"></a>
+
+# jc.parsers.postconf
+
+jc - JSON Convert `postconf -M` command output parser
+
+Usage (cli):
+
+    $ postconf -M | jc --postconf
+
+    or
+
+    $ jc postconf -M
+
+Usage (module):
+
+    import jc
+    result = jc.parse('postconf', postconf_command_output)
+
+Schema:
+
+    [
+      {
+        "service_name":                     string,
+        "service_type":                     string,
+        "private":                          boolean/null,  # [0]
+        "unprivileged":                     boolean/null,  # [0]
+        "chroot":                           boolean/null,  # [0]
+        "wake_up_time":                     integer/null,  # [0]
+        "no_wake_up_before_first_use":      boolean/null,  # [1]
+        "process_limit":                    integer/null,  # [0]
+        "command":                          string
+      }
+    ]
+
+    [0] '-' converted to null/None
+    [1] null/None if `wake_up_time` is null/None
+
+Examples:
+
+    $ postconf -M | jc --postconf -p
+    [
+      {
+        "service_name": "smtp",
+        "service_type": "inet",
+        "private": false,
+        "unprivileged": null,
+        "chroot": true,
+        "wake_up_time": null,
+        "process_limit": null,
+        "command": "smtpd",
+        "no_wake_up_before_first_use": null
+      },
+      {
+        "service_name": "pickup",
+        "service_type": "unix",
+        "private": false,
+        "unprivileged": null,
+        "chroot": true,
+        "wake_up_time": 60,
+        "process_limit": 1,
+        "command": "pickup",
+        "no_wake_up_before_first_use": false
+      }
+    ]
+
+    $ postconf -M | jc --postconf -p -r
+    [
+      {
+        "service_name": "smtp",
+        "service_type": "inet",
+        "private": "n",
+        "unprivileged": "-",
+        "chroot": "y",
+        "wake_up_time": "-",
+        "process_limit": "-",
+        "command": "smtpd"
+      },
+      {
+        "service_name": "pickup",
+        "service_type": "unix",
+        "private": "n",
+        "unprivileged": "-",
+        "chroot": "y",
+        "wake_up_time": "60",
+        "process_limit": "1",
+        "command": "pickup"
+      }
+    ]
+
+<a id="jc.parsers.postconf.parse"></a>
+
+### parse
+
+```python
+def parse(data: str, raw: bool = False, quiet: bool = False) -> List[Dict]
+```
+
+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
+
+Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)