async_example_program.tools.async_ini_file_parser.AsyncIniFileParser

This class handles a program ini file.

It keeps track of changed parameter values during program execution, if needed. Environment variables and secrets are expanded. Parameter values are accessed using dot notation.

If INI file validation fails during program startup, the program stops.

If an INI file change is detected when the program is running and the validation fails, the content is rejected and the old file content is restored, whilst the program keeps running.

Expanded parameter ini file parameter syntax:

• @{<secrets-name>}
• &{<environment-variable-name>}
• ${<extended-interpolation-reference>}

There are three methods that are designed to be overridden when needed:

• _add_default_parameters()
• _add_platform_parameters()
• _add_section_parameters()

That can be useful when you are referencing external values (in relation to the INI file content) in the ini file.

The way to do that is to use vars like this:

# In a *_ini_core.py file
class AsyncDeployIni(AsyncIniFileParser):
    def __init__(self, name: str, dest_server: str):
        self.var_params = {'server': dest_server}

    def _add_platform_parameters(self) -> dict:
        # Add external parameter(s) to the parameter interpolation.
        return dict(self.items(PLATFORM, vars=self.var_params))

And the INI file can look something like this:

[DEFAULT]
passwd: @{environment_prod_pwd}

[win32]
root_path: /export
local_path: ${root_path}/Prod/Pgm
dest_path: //${server}/Prod/Pgm