1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/wc.md
2022-01-25 17:07:47 -08:00

1.4 KiB

Home

jc.parsers.wc

jc - JSON CLI output utility wc command output parser

Usage (cli):

$ wc file.txt | jc --wc

or

$ jc wc file.txt

Usage (module):

import jc result = jc.parse('wc', wc_command_output)

or

import jc.parsers.wc result = jc.parsers.wc.parse(wc_command_output)

Schema:

[ { "filename": string, "lines": integer, "words": integer, "characters": integer } ]

Examples:

$ wc * | jc --wc -p [ {

  • "filename" - "airport-I.json",
  • "lines" - 1,
  • "words" - 30,
  • "characters" - 307 }, {
  • "filename" - "airport-I.out",
  • "lines" - 15,
  • "words" - 33,
  • "characters" - 348 }, {
  • "filename" - "airport-s.json",
  • "lines" - 1,
  • "words" - 202,
  • "characters" - 2152 }, ... ]

info Objects

class info()

Provides parser metadata (version, author, etc.)

parse

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

Main text parsing function

Arguments:

  • 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, aix, freebsd

Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)