mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-07-13 01:20:24 +02:00
doc update
This commit is contained in:
63
docs/parsers/os_prober.md
Normal file
63
docs/parsers/os_prober.md
Normal file
@ -0,0 +1,63 @@
|
|||||||
|
[Home](https://kellyjonbrazil.github.io/jc/)
|
||||||
|
<a id="jc.parsers.os_prober"></a>
|
||||||
|
|
||||||
|
# jc.parsers.os\_prober
|
||||||
|
|
||||||
|
jc - JSON Convert `os-prober` command output parser
|
||||||
|
|
||||||
|
Usage (cli):
|
||||||
|
|
||||||
|
$ os-prober | jc --os-prober
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
$ jc os-prober
|
||||||
|
|
||||||
|
Usage (module):
|
||||||
|
|
||||||
|
import jc
|
||||||
|
result = jc.parse('os_prober', os_prober_command_output)
|
||||||
|
|
||||||
|
Schema:
|
||||||
|
|
||||||
|
{
|
||||||
|
'partition': string,
|
||||||
|
'name': string,
|
||||||
|
'short_name': string,
|
||||||
|
'type': string
|
||||||
|
}
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
$ os-prober | jc --os-prober -p
|
||||||
|
{
|
||||||
|
"partition": "/dev/sda1",
|
||||||
|
"name": "Windows 10",
|
||||||
|
"short_name": "Windows",
|
||||||
|
"type": "chain"
|
||||||
|
}
|
||||||
|
|
||||||
|
<a id="jc.parsers.os_prober.parse"></a>
|
||||||
|
|
||||||
|
### parse
|
||||||
|
|
||||||
|
```python
|
||||||
|
def parse(data: str, raw: bool = False, quiet: bool = False) -> JSONDictType
|
||||||
|
```
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
Dictionary. Raw or processed structured data.
|
||||||
|
|
||||||
|
### Parser Information
|
||||||
|
Compatibility: linux
|
||||||
|
|
||||||
|
Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
|
Reference in New Issue
Block a user