mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-06-17 00:07:37 +02:00
92 lines
2.3 KiB
Markdown
92 lines
2.3 KiB
Markdown
[Home](https://kellyjonbrazil.github.io/jc/)
|
|
<a id="jc.parsers.kv_dup"></a>
|
|
|
|
# jc.parsers.kv_dup
|
|
|
|
jc - JSON Convert `Key/Value` with duplicate key file and string parser
|
|
|
|
Supports files containing simple key/value pairs and preserves duplicate
|
|
values. All values are contained in lists/arrays.
|
|
|
|
- Delimiter can be `=` or `:`. Missing values are supported.
|
|
- Comment prefix can be `#` or `;`. Comments must be on their own line.
|
|
- If multi-line values are used, each line will be a separate item in the
|
|
value list. Blank lines in multi-line values are not supported.
|
|
|
|
> Note: Values starting and ending with quotation marks will have the marks
|
|
> removed. If you would like to keep the quotation marks, use the `-r`
|
|
> command-line argument or the `raw=True` argument in `parse()`.
|
|
|
|
Usage (cli):
|
|
|
|
$ cat foo.txt | jc --kv-dup
|
|
|
|
Usage (module):
|
|
|
|
import jc
|
|
result = jc.parse('kv_dup', kv_file_output)
|
|
|
|
Schema:
|
|
|
|
Key/Value document converted to a dictionary - see the python configparser
|
|
standard library documentation for more details.
|
|
|
|
{
|
|
"<key1>": [
|
|
string
|
|
],
|
|
"<key2>": [
|
|
string
|
|
]
|
|
}
|
|
|
|
Examples:
|
|
|
|
$ cat keyvalue.txt
|
|
# this file contains key/value pairs
|
|
name = John Doe
|
|
address=555 California Drive
|
|
age: 34
|
|
|
|
; comments can include # or ;
|
|
# delimiter can be = or :
|
|
# quoted values have quotation marks stripped by default
|
|
# but can be preserved with the -r argument
|
|
occupation:"Engineer"
|
|
occupation = "Pilot"
|
|
|
|
$ cat keyvalue.txt | jc --kv-dup -p
|
|
{
|
|
"name": ["John Doe"],
|
|
"address": ["555 California Drive"],
|
|
"age": ["34"],
|
|
"occupation": ["Engineer", "Pilot"]
|
|
}
|
|
|
|
<a id="jc.parsers.kv_dup.parse"></a>
|
|
|
|
### parse
|
|
|
|
```python
|
|
def parse(data, raw=False, quiet=False)
|
|
```
|
|
|
|
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 representing a Key/Value pair document.
|
|
|
|
### Parser Information
|
|
Compatibility: linux, darwin, cygwin, win32, aix, freebsd
|
|
|
|
Source: [`jc/parsers/kv_dup.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/kv_dup.py)
|
|
|
|
Version 1.1 by Kelly Brazil (kellyjonbrazil@gmail.com)
|