1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Files
jc/docs/parsers/wc.md

100 lines
1.4 KiB
Markdown
Raw Normal View History

[Home](https://kellyjonbrazil.github.io/jc/)
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.wc"></a>
2021-01-01 12:01:56 -08:00
# jc.parsers.wc
2022-01-25 17:07:47 -08:00
2021-01-01 12:01:56 -08:00
jc - JSON CLI output utility `wc` command output parser
Usage (cli):
2022-01-25 17:07:47 -08:00
$ wc file.txt | jc --wc
2021-01-01 12:01:56 -08:00
2022-01-25 17:07:47 -08:00
or
2021-01-01 12:01:56 -08:00
2022-01-25 17:07:47 -08:00
$ jc wc file.txt
2021-01-01 12:01:56 -08:00
Usage (module):
2022-01-25 17:07:47 -08:00
import jc
result = jc.parse('wc', wc_command_output)
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
or
2022-01-18 15:38:03 -08:00
2022-01-25 17:07:47 -08:00
import jc.parsers.wc
result = jc.parsers.wc.parse(wc_command_output)
2021-01-01 12:01:56 -08:00
2021-04-08 16:14:11 -07:00
Schema:
2022-01-25 17:07:47 -08:00
[
{
"filename": string,
"lines": integer,
"words": integer,
"characters": integer
}
]
**Examples**:
$ wc * | jc --wc -p
[
{
- `"filename"` - "airport-I.json",
- `"lines"` - 1,
- `"words"` - 30,
- `"characters"` - 307
},
{
- `"filename"` - "airport-I.out",
- `"lines"` - 15,
- `"words"` - 33,
- `"characters"` - 348
},
{
- `"filename"` - "airport-s.json",
- `"lines"` - 1,
- `"words"` - 202,
- `"characters"` - 2152
},
...
]
<a id="jc.parsers.wc.info"></a>
## info Objects
2021-01-01 12:01:56 -08:00
```python
2022-01-25 17:07:47 -08:00
class info()
2021-01-01 12:01:56 -08:00
```
2022-01-25 17:07:47 -08:00
2021-04-08 16:14:11 -07:00
Provides parser metadata (version, author, etc.)
2021-01-01 12:01:56 -08:00
2022-01-25 17:07:47 -08:00
<a id="jc.parsers.wc.parse"></a>
#### parse
2021-01-01 12:01:56 -08:00
```python
2022-01-25 17:07:47 -08:00
def parse(data, raw=False, quiet=False)
2021-01-01 12:01:56 -08:00
```
Main text parsing function
2022-01-25 17:07:47 -08:00
**Arguments**:
2021-01-01 12:01:56 -08:00
2022-01-25 17:07:47 -08:00
- `data` - (string) text data to parse
- `raw` - (boolean) unprocessed output if True
- `quiet` - (boolean) suppress warning messages if True
2021-01-01 12:01:56 -08:00
2022-01-25 17:07:47 -08:00
**Returns**:
2021-01-01 12:01:56 -08:00
2022-01-25 17:07:47 -08:00
List of Dictionaries. Raw or processed structured data.
2021-01-01 12:01:56 -08:00
## Parser Information
Compatibility: linux, darwin, cygwin, aix, freebsd
2021-12-01 16:12:51 -08:00
Version 1.3 by Kelly Brazil (kellyjonbrazil@gmail.com)