ra2ce.common.io.readers package

Submodules

ra2ce.common.io.readers.file_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 FileReaderProtocol(*args, **kwargs)

Bases: Protocol

read(file_path)

Reads from a given file and converts the data into Any type.

Return type:

Any

Parameters:

file_path (Path)

Args:

file_path (Path): Path to a file containing data to be read.

Returns:

Any: Object mapped from the data in the file.

ra2ce.common.io.readers.graph_pickle_reader 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 GraphPickleReader(*args, **kwargs)

Bases: FileReaderProtocol

read(pickle_path)

Reads from a given file and converts the data into Any type.

Return type:

Any

Parameters:

pickle_path (Path)

Args:

file_path (Path): Path to a file containing data to be read.

Returns:

Any: Object mapped from the data in the file.

Module contents