async_example_program.async_example_ini_core.AsyncExampleProgIni

class documentation

class AsyncExampleProgIni(AsyncIniFileParser): (source)

Constructor: AsyncExampleProgIni(name)

View In Hierarchy

This class handles the ini file parameters for the AsyncExampleProgram.

Method __init__ The class constructor.
Async Method validate_ini_file Read ini file and check the existence of required parameters and sometimes validate content of complex types.
Async Method validate_ini_file_parameters Extract and validate ini file parameters.
Instance Variable initial_validation Need to handle initial validation correctly when post-validation is done.
Property changed_document_types Return document_types change status.
Property changed_log_level Return log_level change status.
Method _verify_config_section_parameters Verify that all config section parameters exist.
Method _verify_platform_parameters Verify platform-specific section parameters.
def __init__(self, name: str): (source)

The class constructor.

Parameters
name:strName of ini file.
async def validate_ini_file(self, validation_model: Callable, sections: Optional[list] = None, read_ini: bool = False): (source)

Read ini file and check the existence of required parameters and sometimes validate content of complex types.

Specifically, handle verification of non-DEFAULT section(s).

The superclass handles verification of DEFAULT parameters and validation of all parameters (except special cases for complex types).

Parameters
validation_model:CallableThe validation model that pydantic should use.
sections:Optional[list]List of used section names (except DEFAULT).
read_ini:boolRead ini file status.
async def validate_ini_file_parameters(self): (source)

Extract and validate ini file parameters.

initial_validation: bool = (source)

Need to handle initial validation correctly when post-validation is done.

@property
changed_document_types: bool = (source)

Return document_types change status.

@property
changed_log_level: bool = (source)

Return log_level change status.

def _verify_config_section_parameters(self) -> List[str]: (source)

Verify that all config section parameters exist.

Returns
List[str]Verified section(s).
def _verify_platform_parameters(self): (source)

Verify platform-specific section parameters.

The verification checks that all parameters exist and that specified path exists.