ra2ce.common.configuration package

Submodules

ra2ce.common.configuration.config_data_protocol module

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE). Copyright (C) 2023 Stichting Deltares

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class ConfigDataProtocol

Bases: dict

IniConfigProtocol, for now it’s a dictionary until we start mapping its entries to real properties. Then we will transform it into a protocol.

to_dict()

Returns all defined properties as a raw dictionary, converting all custom classes and types.

Return type:

dict

Returns:

dict: Dictionary representing the ConfigDataProtocol instance.

ra2ce.common.configuration.config_wrapper_protocol module

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE). Copyright (C) 2023 Stichting Deltares

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class ConfigWrapperProtocol(*args, **kwargs)

Bases: Protocol

config_data: Optional[ConfigDataProtocol] = None

configure()

Return type:

None

classmethod from_data(ini_file, config_data)

Initializes a ConfigWrapperProtocol with the given parameters.

Return type:

ConfigWrapperProtocol

Parameters:

• ini_file (Path)

• config_data (ConfigDataProtocol)

Args:

ini_file (Path): Path to the ini file containing the analysis data. config_data (IniConfigDataProtocol): Ini data representation.

Returns:

ConfigWrapperProtocol: Initialized instance.

graph_files: Optional[GraphFilesCollection] = None

ini_file: Path

is_valid()

Return type:

bool

ra2ce.common.configuration.ini_configuration_reader_protocol module

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE). Copyright (C) 2023 Stichting Deltares

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

class ConfigDataReaderProtocol(*args, **kwargs)

Bases: FileReaderProtocol, Protocol

read(ini_file)

Reads the given *.ini file and if possible converts it into a IniConfigDataProtocol object.

Return type:

ConfigDataProtocol

Parameters:

ini_file (Path)

Args:

ini_file (Path): Ini file to be mapped into a IniConfigDataProtocol.

Returns:

ConfigWrapperProtocol: Resulting mapped object from the configuration data in the given file.

Module contents