diff --git a/docs/parsers/proc_net_dev_mcast.md b/docs/parsers/proc_net_dev_mcast.md new file mode 100644 index 00000000..05017451 --- /dev/null +++ b/docs/parsers/proc_net_dev_mcast.md @@ -0,0 +1,105 @@ +[Home](https://kellyjonbrazil.github.io/jc/) + + +# jc.parsers.proc\_net\_dev\_mcast + +jc - JSON Convert `/proc/net/dev_mcast` file parser + +Usage (cli): + + $ cat /proc/net/dev_mcast | jc --proc + +or + + $ jc /proc/net/dev_mcast + +or + + $ cat /proc/net/dev_mcast | jc --proc-net-dev_mcast + +Usage (module): + + import jc + result = jc.parse('proc', proc_net_dev_mcast_file) + +or + + import jc + result = jc.parse('proc_net_dev_mcast', proc_net_dev_mcast_file) + +Schema: + + [ + { + "index": integer, + "interface_name": string, + "dmi_u": integer, + "dmi_g": integer, + "dmi_address": string + } + ] + +Examples: + + $ cat /proc/net/dev_mcast | jc --proc -p + [ + { + "index": 2, + "interface_name": "ens33", + "dmi_u": 1, + "dmi_g": 0, + "dmi_address": "333300000001" + }, + { + "index": 2, + "interface_name": "ens33", + "dmi_u": 1, + "dmi_g": 0, + "dmi_address": "01005e000001" + }, + ... + ] + + $ cat /proc/net/dev_mcast | jc --proc -p -r + [ + { + "index": "2", + "interface_name": "ens33", + "dmi_u": "1", + "dmi_g": "0", + "dmi_address": "333300000001" + }, + { + "index": "2", + "interface_name": "ens33", + "dmi_u": "1", + "dmi_g": "0", + "dmi_address": "01005e000001" + }, + ... + ] + + + +### 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) diff --git a/jc/lib.py b/jc/lib.py index f4af774b..a54a0c90 100644 --- a/jc/lib.py +++ b/jc/lib.py @@ -123,6 +123,7 @@ parsers = [ 'proc-pid-status', 'proc-net-arp', 'proc-net-dev', + 'proc-net-dev-mcast', 'ps', 'route', 'rpm-qi', diff --git a/jc/parsers/proc_net_dev_mcast.py b/jc/parsers/proc_net_dev_mcast.py new file mode 100644 index 00000000..5502ef58 --- /dev/null +++ b/jc/parsers/proc_net_dev_mcast.py @@ -0,0 +1,150 @@ +"""jc - JSON Convert `/proc/net/dev_mcast` file parser + +Usage (cli): + + $ cat /proc/net/dev_mcast | jc --proc + +or + + $ jc /proc/net/dev_mcast + +or + + $ cat /proc/net/dev_mcast | jc --proc-net-dev_mcast + +Usage (module): + + import jc + result = jc.parse('proc', proc_net_dev_mcast_file) + +or + + import jc + result = jc.parse('proc_net_dev_mcast', proc_net_dev_mcast_file) + +Schema: + + [ + { + "index": integer, + "interface_name": string, + "dmi_u": integer, + "dmi_g": integer, + "dmi_address": string + } + ] + +Examples: + + $ cat /proc/net/dev_mcast | jc --proc -p + [ + { + "index": 2, + "interface_name": "ens33", + "dmi_u": 1, + "dmi_g": 0, + "dmi_address": "333300000001" + }, + { + "index": 2, + "interface_name": "ens33", + "dmi_u": 1, + "dmi_g": 0, + "dmi_address": "01005e000001" + }, + ... + ] + + $ cat /proc/net/dev_mcast | jc --proc -p -r + [ + { + "index": "2", + "interface_name": "ens33", + "dmi_u": "1", + "dmi_g": "0", + "dmi_address": "333300000001" + }, + { + "index": "2", + "interface_name": "ens33", + "dmi_u": "1", + "dmi_g": "0", + "dmi_address": "01005e000001" + }, + ... + ] +""" +from typing import List, Dict +import jc.utils +from jc.parsers.universal import simple_table_parse + + +class info(): + """Provides parser metadata (version, author, etc.)""" + version = '1.0' + description = '`/proc/net/dev_mcast` file parser' + author = 'Kelly Brazil' + author_email = 'kellyjonbrazil@gmail.com' + compatible = ['linux'] + hidden = True + + +__version__ = info.version + + +def _process(proc_data: List[Dict]) -> List[Dict]: + """ + Final processing to conform to the schema. + + Parameters: + + proc_data: (List of Dictionaries) raw structured data to process + + Returns: + + List of Dictionaries. Structured to conform to the schema. + """ + no_convert = {'interface_name', 'dmi_address'} + + for item in proc_data: + for key, val in item.items(): + if key not in no_convert: + try: + item[key] = int(val) + except Exception: + pass + + return proc_data + + +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. + """ + jc.utils.compatibility(__name__, info.compatible, quiet) + jc.utils.input_type_check(data) + + raw_output: List = [] + + if jc.utils.has_data(data): + + header = 'index interface_name dmi_u dmi_g dmi_address\n' + data = header + data + data_splitlines = data.splitlines() + raw_output = simple_table_parse(data_splitlines) + + return raw_output if raw else _process(raw_output) diff --git a/man/jc.1 b/man/jc.1 index 7f9f3170..8223559e 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -600,6 +600,11 @@ PLIST file parser \fB--proc-net-dev\fP `/proc/net/dev` file parser +.TP +.B +\fB--proc-net-dev-mcast\fP +`/proc/net/dev_mcast` file parser + .TP .B \fB--ps\fP