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

doc update

Browse Source
This commit is contained in:
Kelly Brazil
2023-01-03 12:28:26 -08:00
parent bb65ec380b
commit b0fe96ed03
2 changed files with 20 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/parsers/ini.md
View File

@ -5,12 +5,20 @@
jc - JSON Convert `INI` file parser jc - JSON Convert `INI` file parser
Parses standard `INI` files and files containing simple key/value pairs. Parses standard `INI` files.
- 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. - If duplicate keys are found, only the last value will be used.
> Note: If there is no top-level section identifier, then this parser will
> add a key named `_top_level_section_` with the top-level key/values
> included.
> Note: The section identifier `[DEFAULT]` is special and provides default
> values for the following section keys. To disable this behavior you must
> rename the `[DEFAULT]` section identifier to something else.
> 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
> marks, use the `-r` command-line argument or the `raw=True` argument in > marks, use the `-r` command-line argument or the `raw=True` argument in
@ -27,7 +35,7 @@ Usage (module):
Schema: Schema:
ini or key/value document converted to a dictionary - see the configparser ini document converted to a dictionary - see the python configparser
standard library documentation for more details. standard library documentation for more details.
{ {

12
jc/parsers/ini.py
View File

@ -1,11 +1,19 @@
"""jc - JSON Convert `INI` file parser """jc - JSON Convert `INI` file parser
Parses standard `INI` files and files containing simple key/value pairs. Parses standard `INI` files.
- 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. - If duplicate keys are found, only the last value will be used.
> Note: If there is no top-level section identifier, then this parser will
> add a key named `_top_level_section_` with the top-level key/values
> included.
> Note: The section identifier `[DEFAULT]` is special and provides default
> values for the following section keys. To disable this behavior you must
> rename the `[DEFAULT]` section identifier to something else.
> 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
> marks, use the `-r` command-line argument or the `raw=True` argument in > marks, use the `-r` command-line argument or the `raw=True` argument in
@ -22,7 +30,7 @@ Usage (module):
Schema: Schema:
ini or key/value document converted to a dictionary - see the configparser ini document converted to a dictionary - see the python configparser
standard library documentation for more details. standard library documentation for more details.
{ {