1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/history.md
Kelly Brazil 1d0ad2f045 doc fixes
2021-01-04 18:01:16 -08:00

1.7 KiB

jc.parsers.history

jc - JSON CLI output utility history command output parser

This parser will output a list of dictionaries each containing line and command keys. If you would like a simple dictionary output, then use the -r command-line option or the raw=True argument in the parse() function.

Usage (cli):

$ history | jc --history

Usage (module):

import jc.parsers.history
result = jc.parsers.history.parse(history_command_output)

Compatibility:

'linux', 'darwin', 'cygwin', 'aix', 'freebsd'

Examples:

$ history | jc --history -p
[
  {
    "line": 118,
    "command": "sleep 100"
  },
  {
    "line": 119,
    "command": "ls /bin"
  },
  {
    "line": 120,
    "command": "echo "hello""
  },
  {
    "line": 121,
    "command": "docker images"
  },
  ...
]

$ history | jc --history -p -r
{
  "118": "sleep 100",
  "119": "ls /bin",
  "120": "echo "hello"",
  "121": "docker images",
  ...
}

info

info()

process

process(proc_data)

Final processing to conform to the schema.

Parameters:

proc_data:   (Dictionary) raw structured data to process

Returns:

List of Dictionaries. Structured data with the following schema:

[
  {
    "line":     integer,
    "command":  string
  }
]

parse

parse(data, raw=False, quiet=False)

Main text parsing function

Parameters:

data:        (string)  text data to parse
raw:         (boolean) output preprocessed JSON if True
quiet:       (boolean) suppress warning messages if True

Returns:

Dictionary of raw structured data or
List of Dictionaries of processed structured data