python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

add language hints

Browse Source
This commit is contained in:
Kelly Brazil
2021-09-23 08:59:26 -07:00
parent df9835a3e6
commit f9be5651da
2 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -235,7 +235,7 @@ Most parsers load all of the data from STDIN, parse it, then output the entire J
You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the `-q` cli option or the `quiet=True` argument with the `parse()` function. This will add a `_meta` object to the JSON output with a `success` attribute. If `success` is `true`, then there were no issues parsing the line. If `success` is `false`, then a parsing issue was found and `error` and `line` fields will be added to include a short error description and the contents of the unparsable line, respectively:
Successfully parsed line with `-q` option:
```
```json
{
"command_data": "data",
"_meta": {
@ -244,7 +244,7 @@ Successfully parsed line with `-q` option:
}
```
Unsuccessfully parsed line with `-q` option:
```
```json
{
"_meta": {
"success": false,
@ -275,7 +275,6 @@ $ ping 1.1.1.1 | jc --ping-s -u | jq
Streaming parsers accept any iterable object and return a generator iterator object allowing lazy processing of the data. The input data should iterate on lines of string data. Examples of good input data are `sys.stdin` or `str.splitlines()`.
To use the generator object in your code, simply loop through it:
```python
import jc.parsers.ls_s

5
templates/readme_template
View File

@ -158,7 +158,7 @@ Most parsers load all of the data from STDIN, parse it, then output the entire J
You may want to ignore parsing errors when using streaming parsers since these may be used in long-lived processing pipelines and errors can break the pipe. To ignore parsing errors, use the `-q` cli option or the `quiet=True` argument with the `parse()` function. This will add a `_meta` object to the JSON output with a `success` attribute. If `success` is `true`, then there were no issues parsing the line. If `success` is `false`, then a parsing issue was found and `error` and `line` fields will be added to include a short error description and the contents of the unparsable line, respectively:
Successfully parsed line with `-q` option:
```
```json
{
"command_data": "data",
"_meta": {
@ -167,7 +167,7 @@ Successfully parsed line with `-q` option:
}
```
Unsuccessfully parsed line with `-q` option:
```
```json
{
"_meta": {
"success": false,
@ -198,7 +198,6 @@ $ ping 1.1.1.1 | jc --ping-s -u | jq
Streaming parsers accept any iterable object and return a generator iterator object allowing lazy processing of the data. The input data should iterate on lines of string data. Examples of good input data are `sys.stdin` or `str.splitlines()`.
To use the generator object in your code, simply loop through it:
```python
import jc.parsers.ls_s