jc/docs/parsers/ini.md

[Home](https://kellyjonbrazil.github.io/jc/)
<a id="jc.parsers.ini"></a>

# jc.parsers.ini

jc - JSON CLI output utility `INI` file parser

Parses standard `INI` files and files containing simple key/value pairs.
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 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)

or

import jc.parsers.ini
result = jc.parsers.ini.parse(ini_file_output)

Schema:

ini or key/value document converted to a dictionary - see the
configparser standard library documentation for more details.

{
"key1":       string,
"key2":       string
}

**Examples**:

  
  $ cat example.ini
  [DEFAULT]
  ServerAliveInterval = 45
  Compression = yes
  CompressionLevel = 9
  ForwardX11 = yes
  
  [bitbucket.org]
  User = hg
  
  [topsecret.server.com]
  Port = 50022
  ForwardX11 = no
  
  $ cat example.ini | jc --ini -p
  {
- `"bitbucket.org"` - {
- `"serveraliveinterval"` - "45",
- `"compression"` - "yes",
- `"compressionlevel"` - "9",
- `"forwardx11"` - "yes",
- `"user"` - "hg"
  },
- `"topsecret.server.com"` - {
- `"serveraliveinterval"` - "45",
- `"compression"` - "yes",
- `"compressionlevel"` - "9",
- `"forwardx11"` - "no",
- `"port"` - "50022"
  }
  }

<a id="jc.parsers.ini.info"></a>

## info Objects

```python
class info()
```

Provides parser metadata (version, author, etc.)

<a id="jc.parsers.ini.parse"></a>

#### parse

```python
def parse(data, raw=False, quiet=False)
```

Main text parsing function

**Arguments**:

  
- `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.5 by Kelly Brazil (kellyjonbrazil@gmail.com)