1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2026-06-19 22:28:17 +02:00

doc update

This commit is contained in:
Kelly Brazil
2023-11-28 11:23:47 -08:00
parent 2a88f2be6b
commit 572a3207cd
6 changed files with 86 additions and 6 deletions
+71
View File
@@ -0,0 +1,71 @@
[Home](https://kellyjonbrazil.github.io/jc/)
<a id="jc.parsers.swapon"></a>
# jc.parsers.swapon
jc - JSON Convert `swapon` command output parser
> Note: Must use `swapon`
Usage (cli):
$ swapon | jc --swapon
or
$ jc swapon
Usage (module):
import jc
result = jc.parse('swapon', uname_command_output)
Schema:
[
{
"name": string,
"type": string,
"size": int,
"used": int,
"priority": int,
}
]
Example:
$ swapon | jc --swapon
[
{
"name": "/swapfile",
"type": "file",
"size": 1073741824,
"used": 0,
"priority": -2
}
]
<a id="jc.parsers.swapon.parse"></a>
### parse
```python
def parse(data: str, raw: bool = False, quiet: bool = False) -> List[_Entry]
```
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, freebsd
Version 1.0 by Roey Darwish Dror (roey.ghost@gmail.com)