fastoad.io.variable_io module
- class fastoad.io.variable_io.VariableIO(data_source: Union[str, IO], formatter: Optional[fastoad.io.formatter.IVariableIOFormatter] = None)[source]
Bases:
object
Class for reading and writing variable values from/to file.
The file format is defined by the class provided as formatter argument.
- Parameters
data_source – the I/O stream, or a file path, used for reading or writing data
formatter – a class that determines the file format to be used. Defaults to a VariableBasicXmlFormatter instance.
- read(only: Optional[List[str]] = None, ignore: Optional[List[str]] = None) fastoad.openmdao.variables.variable_list.VariableList [source]
Reads variables from provided data source.
Elements of only and ignore can be real variable names or Unix-shell-style patterns. In any case, comparison is case-sensitive.
- Parameters
only – List of variable names that should be read. Other names will be ignored. If None, all variables will be read.
ignore – List of variable names that should be ignored when reading.
- Returns
an VariableList instance where outputs have been defined using provided source
- write(variables: fastoad.openmdao.variables.variable_list.VariableList, only: Optional[List[str]] = None, ignore: Optional[List[str]] = None)[source]
Writes variables from provided VariableList instance.
Elements of only and ignore can be real variable names or Unix-shell-style patterns. In any case, comparison is case-sensitive.
- Parameters
variables – a VariableList instance
only – List of variable names that should be written. Other names will be ignored. If None, all variables will be written.
ignore – List of variable names that should be ignored when writing
- class fastoad.io.variable_io.DataFile(data_source: Optional[Union[str, IO, list]] = None, formatter: Optional[fastoad.io.formatter.IVariableIOFormatter] = None, load_data=True)[source]
Bases:
fastoad.openmdao.variables.variable_list.VariableList
Class for managing FAST-OAD data files.
Behaves like
VariableList
class but hasload()
andsave()
methods.If variable list is specified for data_source,
file_path
will have to be set before using :method:`save`.- Parameters
data_source – Can be the file path where data will be loaded and saved, or a list of
Variable
instances that will be used for initialization (or aVariableList
instance).formatter – (ignored if data_source is not an I/O stream nor a file path) a class that determines the file format to be used. Defaults to FAST-OAD native format. See
VariableIO
for more information.load_data – (ignored if data_source is not an I/O stream nor a file path) if True, file is expected to exist and its content will be loaded at instantiation.
- property formatter: fastoad.io.formatter.IVariableIOFormatter
Class that defines the file format.
- save_as(file_path: str, overwrite=False, formatter: Optional[fastoad.io.formatter.IVariableIOFormatter] = None)[source]
Sets the associated file path as specified and saves current state of variables.
- Parameters
file_path –
overwrite – if specified file already exists and overwrite is False, an error is triggered.
formatter – a class that determines the file format to be used. Defaults to FAST-OAD native format. See
VariableIO
for more information.