jc/docs/parsers/group.md

jc.parsers.group

jc - JSON CLI output utility /etc/group file Parser

Usage:

specify --group as the first argument if the piped input is coming from /etc/group

Compatibility:

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

Examples:

$ cat /etc/group | jc --group -p
[
  {
    "group_name": "nobody",
    "password": "*",
    "gid": -2,
    "members": []
  },
  {
    "group_name": "nogroup",
    "password": "*",
    "gid": -1,
    "members": []
  },
  {
    "group_name": "wheel",
    "password": "*",
    "gid": 0,
    "members": [
      "root"
    ]
  },
  {
    "group_name": "certusers",
    "password": "*",
    "gid": 29,
    "members": [
      "root",
      "_jabber",
      "_postfix",
      "_cyrus",
      "_calendar",
      "_dovecot"
    ]
  },
  ...
]

$ cat /etc/group | jc --group -p -r
[
  {
    "group_name": "nobody",
    "password": "*",
    "gid": "-2",
    "members": [
      ""
    ]
  },
  {
    "group_name": "nogroup",
    "password": "*",
    "gid": "-1",
    "members": [
      ""
    ]
  },
  {
    "group_name": "wheel",
    "password": "*",
    "gid": "0",
    "members": [
      "root"
    ]
  },
  {
    "group_name": "certusers",
    "password": "*",
    "gid": "29",
    "members": [
      "root",
      "_jabber",
      "_postfix",
      "_cyrus",
      "_calendar",
      "_dovecot"
    ]
  },
  ...
]

info

info(self, /, *args, **kwargs)

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:

[
  {
    "group_name":    string,
    "password":      string,
    "gid":           integer,
    "members": [
                     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:

List of dictionaries. Raw or processed structured data.