output_file_settings

Module for OutputFileSettings class

!!! classes OutputFileSettings

OutputFileSettings

settings class used to store information about how to write the output file

Source code in api/output_file_settings.py

class OutputFileSettings:
    """settings class used to store information about how to write the
    output file"""

    def __init__(self, application_name: str, application_version: str) -> None:
        """Creates an instance of OutputFileSettings

        Args:
            application_version (str) : version of the application
            application_name (str) : name of the application
        """
        self._application_name: str = application_name
        self._application_version: str = application_version
        self._variables_to_save: Optional[List[str]] = None

    @property
    def application_name(self) -> str:
        """name of the application"""
        return self._application_name

    @property
    def application_version(self) -> str:
        """version of the application"""
        return self._application_version

    @property
    def variables_to_save(self) -> Optional[List[str]]:
        """variables to save to the output"""
        return self._variables_to_save

    @variables_to_save.setter
    def variables_to_save(self, variables_to_save: Optional[List[str]]):
        self._variables_to_save = variables_to_save

application_name: str property readonly

name of the application

application_version: str property readonly

version of the application

variables_to_save: Optional[List[str]] property writable

variables to save to the output

__init__(self, application_name, application_version) special

Creates an instance of OutputFileSettings

Parameters:

Name	Type	Description	Default
application_version	str)	version of the application	required
application_name	str)	name of the application	required

Source code in api/output_file_settings.py

def __init__(self, application_name: str, application_version: str) -> None:
    """Creates an instance of OutputFileSettings

    Args:
        application_version (str) : version of the application
        application_name (str) : name of the application
    """
    self._application_name: str = application_name
    self._application_version: str = application_version
    self._variables_to_save: Optional[List[str]] = None