diff --git a/docs/parsers/proc_ioports.md b/docs/parsers/proc_ioports.md new file mode 100644 index 00000000..9606509c --- /dev/null +++ b/docs/parsers/proc_ioports.md @@ -0,0 +1,85 @@ +[Home](https://kellyjonbrazil.github.io/jc/) + + +# jc.parsers.proc\_ioports + +jc - JSON Convert `/proc/ioports` file parser + +Usage (cli): + + $ cat /proc/ioports | jc --proc + +or + + $ jc /proc/ioports + +or + + $ cat /proc/ioports | jc --proc-ioports + +Usage (module): + + import jc + result = jc.parse('proc', proc_ioports_file) + +or + + import jc + result = jc.parse('proc_ioports', proc_ioports_file) + +Schema: + + [ + { + "start": string, + "end": string, + "device": string + } + ] + +Examples: + + $ cat /proc/ioports | jc --proc -p + [ + { + "start": "0000", + "end": "0cf7", + "device": "PCI Bus 0000:00" + }, + { + "start": "0000", + "end": "001f", + "device": "dma1" + }, + { + "start": "0020", + "end": "0021", + "device": "PNP0001:00" + }, + ... + ] + + + +### 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 a693fb7c..dac00e19 100644 --- a/jc/lib.py +++ b/jc/lib.py @@ -95,6 +95,7 @@ parsers = [ 'proc-filesystems', 'proc-interrupts', 'proc-iomem', + 'proc-ioports', 'proc-meminfo', 'proc-modules', 'ps', diff --git a/jc/parsers/proc_ioports.py b/jc/parsers/proc_ioports.py new file mode 100644 index 00000000..0c861b0d --- /dev/null +++ b/jc/parsers/proc_ioports.py @@ -0,0 +1,113 @@ +"""jc - JSON Convert `/proc/ioports` file parser + +Usage (cli): + + $ cat /proc/ioports | jc --proc + +or + + $ jc /proc/ioports + +or + + $ cat /proc/ioports | jc --proc-ioports + +Usage (module): + + import jc + result = jc.parse('proc', proc_ioports_file) + +or + + import jc + result = jc.parse('proc_ioports', proc_ioports_file) + +Schema: + + [ + { + "start": string, + "end": string, + "device": string + } + ] + +Examples: + + $ cat /proc/ioports | jc --proc -p + [ + { + "start": "0000", + "end": "0cf7", + "device": "PCI Bus 0000:00" + }, + { + "start": "0000", + "end": "001f", + "device": "dma1" + }, + { + "start": "0020", + "end": "0021", + "device": "PNP0001:00" + }, + ... + ] +""" +from typing import List, Dict +import jc.utils +import jc.parsers.proc_iomem as proc_iomem + + +class info(): + """Provides parser metadata (version, author, etc.)""" + version = '1.0' + description = '`/proc/ioports` 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. + """ + 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 = proc_iomem.parse(data) + + return raw_output if raw else _process(raw_output) diff --git a/man/jc.1 b/man/jc.1 index db93f147..78bc4903 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -460,6 +460,11 @@ PLIST file parser \fB--proc-iomem\fP `/proc/iomem` file parser +.TP +.B +\fB--proc-ioports\fP +`/proc/ioports` file parser + .TP .B \fB--proc-meminfo\fP