API

vbini Module

Ini Handler main Ini object

class ini_handler.vbini.Ini(filename, directory)

Representation of the ini file.

Stores all settings and sections; handles all loading and saving.

directory

The path to which the .ini file will be written to (no filename).

filename

The .ini filename (no extension).

filepath

The directory and filename combined.

get_setting_section(key)

Returns the section the setting is assigned to.

Args:
key(str): setting key
load()

Read the .ini file.

save()

Write the .ini file.

set_setting_section(key, section)

Sets the section the setting is assigned to.

Args:
key(str): setting key section(str): section name

sections module

Ini Handler Sections object

class ini_handler.sections.Sections

Handles the creation, modification, and deletion of the file sections.

remove_setting(key, value)

Removes a setting key from the given section.

Args:
key(str): the section key value(str): the setting key

utilities Module

A collection of regularly used functions

ini_handler.utilities.validate_key_type(key)

Checks if the key is of type str.

Args:
key(str): the key to validate