mirror of
https://github.com/kellyjonbrazil/jc.git
synced 2025-07-17 01:32:37 +02:00
doc update
This commit is contained in:
117
docs/parsers/ini_dup.md
Normal file
117
docs/parsers/ini_dup.md
Normal file
@ -0,0 +1,117 @@
|
|||||||
|
[Home](https://kellyjonbrazil.github.io/jc/)
|
||||||
|
<a id="jc.parsers.ini_dup"></a>
|
||||||
|
|
||||||
|
# jc.parsers.ini\_dup
|
||||||
|
|
||||||
|
jc - JSON Convert INI with duplicate key file parser
|
||||||
|
|
||||||
|
Parses standard INI files and preserves duplicate values. All values are
|
||||||
|
contained in lists/arrays. Multi-line values are not supported.
|
||||||
|
|
||||||
|
- Delimiter can be `=` or `:`. Missing values are supported.
|
||||||
|
- Comment prefix can be `#` or `;`. Comments must be on their own line.
|
||||||
|
|
||||||
|
> Note: Values starting and ending with double or single 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.ini | jc --ini
|
||||||
|
|
||||||
|
Usage (module):
|
||||||
|
|
||||||
|
import jc
|
||||||
|
result = jc.parse('ini', ini_file_output)
|
||||||
|
|
||||||
|
Schema:
|
||||||
|
|
||||||
|
INI document converted to a dictionary - see the python configparser
|
||||||
|
standard library documentation for more details.
|
||||||
|
|
||||||
|
{
|
||||||
|
"<key1>": [
|
||||||
|
string
|
||||||
|
],
|
||||||
|
"<key2>": [
|
||||||
|
string
|
||||||
|
],
|
||||||
|
"<section1>": {
|
||||||
|
"<key1>": [
|
||||||
|
string
|
||||||
|
],
|
||||||
|
"<key2>": [
|
||||||
|
string
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
$ cat example.ini
|
||||||
|
foo = fiz
|
||||||
|
bar = buz
|
||||||
|
|
||||||
|
[section1]
|
||||||
|
fruit = apple
|
||||||
|
color = blue
|
||||||
|
color = red
|
||||||
|
|
||||||
|
[section2]
|
||||||
|
fruit = pear
|
||||||
|
fruit = peach
|
||||||
|
color = green
|
||||||
|
|
||||||
|
$ cat example.ini | jc --ini -p
|
||||||
|
{
|
||||||
|
"foo": [
|
||||||
|
"fiz"
|
||||||
|
],
|
||||||
|
"bar": [
|
||||||
|
"buz"
|
||||||
|
],
|
||||||
|
"section1": {
|
||||||
|
"fruit": [
|
||||||
|
"apple"
|
||||||
|
],
|
||||||
|
"color": [
|
||||||
|
"blue",
|
||||||
|
"red"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"section2": {
|
||||||
|
"fruit": [
|
||||||
|
"pear",
|
||||||
|
"peach"
|
||||||
|
],
|
||||||
|
"color": [
|
||||||
|
"green"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
<a id="jc.parsers.ini_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 the INI file.
|
||||||
|
|
||||||
|
### Parser Information
|
||||||
|
Compatibility: linux, darwin, cygwin, win32, aix, freebsd
|
||||||
|
|
||||||
|
Version 1.0 by Kelly Brazil (kellyjonbrazil@gmail.com)
|
@ -5,7 +5,6 @@ contained in lists/arrays. Multi-line values are not supported.
|
|||||||
|
|
||||||
- Delimiter can be `=` or `:`. Missing values are supported.
|
- Delimiter can be `=` or `:`. Missing values are supported.
|
||||||
- Comment prefix can be `#` or `;`. Comments must be on their own line.
|
- Comment prefix can be `#` or `;`. Comments must be on their own line.
|
||||||
- If duplicate keys are found, only the last value will be used.
|
|
||||||
|
|
||||||
> Note: Values starting and ending with double or single quotation marks
|
> Note: Values starting and ending with double or single quotation marks
|
||||||
> will have the marks removed. If you would like to keep the quotation
|
> will have the marks removed. If you would like to keep the quotation
|
||||||
|
Reference in New Issue
Block a user