> For the complete documentation index, see [llms.txt](https://docs.macilib.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.macilib.org/docs/ini/functions/maci.iniload.md).

# maci.iniload

### loading a file

Loads ini file data, and returns a [ConfigParser](https://docs.python.org/3/library/configparser.html) object. This function can also load ".conf, .cfg" files.

{% hint style="info" %}
maci.iniload  ->  [ConfigParser](https://docs.python.org/3/library/configparser.html)
{% endhint %}

*Basic Example of loading an ini file using default positional parameter*

```python
data = maci.iniload('mydata.ini')
```

In this example, we simply load ini data from a file using the iniload function and pass a string of the filepath to the file as an argument to the function to load the ini data, and assign the returned data to a variable.<br>

*Basic Example of accessing sections and their keys to get values*

```python
data['section']['key']
```

Note: All values in a ini file are [returned as strings](https://docs.python.org/3/library/configparser.html#supported-datatypes), but can be converted with some of the [convenience methods](https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.getint) on the object.<br>

More information on using ConfigParser data:\
Youtube Video Search: <https://www.youtube.com/results?search_query=python+configparser>\
Documentation: <https://docs.python.org/3/library/configparser.html>

### parameters & arguments

Describes all parameter functionality and accepted data types

<details>

<summary>filename:  str | Path</summary>

First and only required positional argument. Accepts strings and [Path objects](https://docs.python.org/3/library/pathlib.html)

Use this parameter to point to your filepath

</details>

<details>

<summary>encoding:  str | None</summary>

Optional parameter. Accepts strings or None. Default = None

Use this parameter to load the data with the desired codec of the encoded data if needed. The default uses the default of python, so you don't have to use this, but you can if the data is using a specific codec.

</details>

*This function uses the native configparser library shipped with the python standard library for its underlying functionality. ExtendedInterpolation is enabled by default. For more information on the configparser library, visit:*[ *https://docs.python.org/3/library/configparser.html*](https://docs.python.org/3/library/configparser.html)
