fameio 2.3.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

fameio/source/schema/attribute.py

@@ -1,203 +0,0 @@
-# SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
-#
-# SPDX-License-Identifier: Apache-2.0
-from __future__ import annotations
-
-import typing
-from enum import Enum, auto
-from typing import Any, Dict
-
-from fameio.source.logs import log
-from fameio.source.schema.exception import SchemaException
-from fameio.source.time import FameTime
-from fameio.source.tools import keys_to_lower
-
-
-class AttributeType(Enum):
-    """Specifies known types that Attributes can take"""
-
-    INTEGER = auto()
-    DOUBLE = auto()
-    LONG = auto()
-    TIME_STAMP = auto()
-    STRING = auto()
-    STRING_SET = auto()
-    ENUM = auto()
-    TIME_SERIES = auto()
-    BLOCK = auto()
-
-    def convert_string_to_type(self, value: str):
-        """Converts a given string to this AttributeType's data format"""
-        if self is AttributeType.INTEGER or self is AttributeType.LONG:
-            return int(value)
-        elif self is AttributeType.DOUBLE:
-            return float(value)
-        elif self is AttributeType.TIME_STAMP:
-            return FameTime.convert_string_if_is_datetime(value)
-        elif self is AttributeType.ENUM or self is AttributeType.STRING or self is AttributeType.STRING_SET:
-            return str(value)
-        elif self is AttributeType.TIME_SERIES:
-            return float(value)
-        else:
-            raise ValueError("String conversion not supported for '{}'.".format(self))
-
-
-class AttributeSpecs:
-    """Schema Definition of a single Attribute (with possible inner Attributes) of an agent"""
-
-    _MISSING_SPEC_DEFAULT = "Missing '{}' specification for Attribute '{}' - assuming {}."
-    _MISSING_TYPE = "'AttributeType' not declare for Attribute '{}'."
-    _INVALID_TYPE = "'{}' is not a valid type for an Attribute."
-    _DEFAULT_NOT_LIST = "Attribute is list, but provided Default '{}' is not a list."
-    _DEFAULT_INCOMPATIBLE = "Default '{}' can not be converted to AttributeType '{}'."
-    _DEFAULT_DISALLOWED = "Default '{}' is not an allowed value."
-    _LIST_DISALLOWED = "Attribute '{}' of type TIME_SERIES cannot be a list."
-    _VALUES_ILL_FORMAT = "Only List and Dictionary is supported for 'Values' but was: {}"
-
-    _KEY_MANDATORY = "Mandatory".lower()
-    _KEY_LIST = "List".lower()
-    _KEY_TYPE = "AttributeType".lower()
-    _KEY_NESTED = "NestedAttributes".lower()
-    _KEY_VALUES = "Values".lower()
-    _KEY_DEFAULT = "Default".lower()
-    _KEY_HELP = "Help".lower()
-
-    def __init__(self, name: str, definition: dict):
-        """Loads Attribute from given `definition`"""
-        self._full_name = name
-        definition = keys_to_lower(definition)
-
-        if AttributeSpecs._KEY_MANDATORY in definition:
-            self._is_mandatory = definition[AttributeSpecs._KEY_MANDATORY]
-        else:
-            self._is_mandatory = True
-            log().warning(AttributeSpecs._MISSING_SPEC_DEFAULT.format(AttributeSpecs._KEY_MANDATORY, name, True))
-
-        if AttributeSpecs._KEY_LIST in definition:
-            self._is_list = definition[AttributeSpecs._KEY_LIST]
-        else:
-            self._is_list = False
-            log().warning(AttributeSpecs._MISSING_SPEC_DEFAULT.format(AttributeSpecs._KEY_LIST, name, False))
-
-        if AttributeSpecs._KEY_TYPE in definition:
-            self._attr_type = AttributeSpecs._get_type_for_name(definition[AttributeSpecs._KEY_TYPE])
-        else:
-            log().error(AttributeSpecs._MISSING_TYPE.format(name))
-            raise SchemaException(AttributeSpecs._MISSING_TYPE.format(name))
-
-        if self._attr_type == AttributeType.TIME_SERIES and self._is_list:
-            raise SchemaException(AttributeSpecs._LIST_DISALLOWED.format(name))
-
-        self._values = []
-        if AttributeSpecs._KEY_VALUES in definition:
-            value_definition = definition[AttributeSpecs._KEY_VALUES]
-            if value_definition:
-                self._values = self._read_values(value_definition)
-
-        self._default_value = None
-        if AttributeSpecs._KEY_DEFAULT in definition:
-            provided_value = definition[AttributeSpecs._KEY_DEFAULT]
-            if self._is_list:
-                self._default_value = self._convert_list(provided_value)
-            else:
-                self._default_value = self._convert_to_data_type(provided_value)
-
-        self._nested_attributes = {}
-        if AttributeSpecs._KEY_NESTED in definition:
-            for nested_name, nested_details in definition[AttributeSpecs._KEY_NESTED].items():
-                full_name = name + "." + nested_name
-                self._nested_attributes[nested_name] = AttributeSpecs(full_name, nested_details)
-
-        self._help = None
-        if AttributeSpecs._KEY_HELP in definition:
-            self._help = definition[AttributeSpecs._KEY_HELP]
-
-    @staticmethod
-    def _read_values(definition: Any) -> list:
-        """Returns list of values extracted from given `definition` if it is a list or dict"""
-        if isinstance(definition, list):
-            return definition
-        elif isinstance(definition, dict):
-            return [key for key in definition.keys()]
-        else:
-            raise SchemaException(AttributeSpecs._VALUES_ILL_FORMAT.format(definition))
-
-    def _convert_list(self, values) -> list:
-        """Converts all entries in given `values` list to this attribute data type and returns this new list"""
-        if isinstance(values, list):
-            return [self._convert_to_data_type(item) for item in values]
-        else:
-            raise SchemaException(AttributeSpecs._DEFAULT_NOT_LIST.format(values))
-
-    def _convert_to_data_type(self, value: str):
-        """Converts a given single `value` to this Attribute's data type"""
-        try:
-            converted = self._attr_type.convert_string_to_type(value)
-            if self._values and converted not in self._values:
-                raise SchemaException(AttributeSpecs._DEFAULT_DISALLOWED.format(value))
-            return converted
-        except ValueError:
-            raise SchemaException(AttributeSpecs._DEFAULT_INCOMPATIBLE.format(value, self._attr_type))
-
-    @property
-    def attr_type(self) -> AttributeType:
-        """Returns AttributeType of this attribute"""
-        return self._attr_type
-
-    @property
-    def values(self) -> list:
-        """Returns the list of allowed values for this attribute"""
-        return self._values
-
-    @property
-    def is_list(self) -> bool:
-        """Return True if this attribute type is a list"""
-        return self._is_list
-
-    @property
-    def has_nested_attributes(self) -> bool:
-        """Returns True if nested attributes are defined"""
-        return bool(self._nested_attributes)
-
-    @property
-    def nested_attributes(self) -> Dict[str, "AttributeSpecs"]:
-        """Returns list of nested Attributes of this Attribute or an empty dict if no nested attributes are defined"""
-        return self._nested_attributes
-
-    @property
-    def has_default_value(self) -> bool:
-        """Return True if a default value is available"""
-        return self._default_value is not None
-
-    @property
-    def default_value(self) -> typing.Optional[typing.Any]:
-        """Return the default value of this attribute, if any"""
-        return self._default_value
-
-    @property
-    def is_mandatory(self) -> bool:
-        """Return True if this attribute is mandatory"""
-        return self._is_mandatory
-
-    @property
-    def full_name(self) -> str:
-        """Returns name including name of enclosing parent attributes"""
-        return self._full_name
-
-    @staticmethod
-    def _get_type_for_name(name: str) -> AttributeType:
-        """Returns the AttributeType matching the given `name` converted to upper case"""
-        try:
-            return AttributeType[name.upper()]
-        except KeyError:
-            raise SchemaException(AttributeSpecs._INVALID_TYPE.format(name))
-
-    @property
-    def has_help_text(self) -> bool:
-        """Return True if a help_text is available"""
-        return bool(self._help)
-
-    @property
-    def help_text(self) -> str:
-        """Return the help_text of this attribute, if any, otherwise an empty string"""
-        return self._help if self.has_help_text else ""

fameio/source/schema/exception.py

@@ -1,9 +0,0 @@
-# SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
-#
-# SPDX-License-Identifier: Apache-2.0
-
-
-class SchemaException(Exception):
-    """An exception that occurred while parsing a Schema"""
-
-    pass

fameio-2.3.0.dist-info/RECORD

@@ -1,55 +0,0 @@
-CHANGELOG.md,sha256=vchfAyV552_Bsstyp995JpN4XAMzX9VhibbY_UqVLTQ,11827
-fameio/__init__.py,sha256=IQm0MNOXkhBexiMXBoNZDK5xHUYgazH7oXm-lc0Vm04,109
-fameio/scripts/__init__.py,sha256=Bdu79kajJvvmPWdSP82Y6G8MCpP4n9ftTR-snWSbMJY,741
-fameio/scripts/__init__.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
-fameio/scripts/convert_results.py,sha256=ljrfPTwhauW98w-wJs4Fu4vtTreGzsMEd-io33UC1z0,4189
-fameio/scripts/convert_results.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
-fameio/scripts/make_config.py,sha256=KQsj-aPXXtch8ITITCOcQUj6nYhvDs9LO7tdSikUe6w,1388
-fameio/scripts/make_config.py.license,sha256=2-OqCNxP4504xY2XQqseYypJi1_Qx4xJSzO3t7c3ACM,107
-fameio/source/__init__.py,sha256=14CnWOIkdSeKQg6FioQSgO7UtEFF6pO4MUtDAUfwNmA,278
-fameio/source/cli/__init__.py,sha256=UqrdWnYMoy-o2--m0a4c-MtAorsc4eILXaPq27EXM1Q,112
-fameio/source/cli/convert_results.py,sha256=LY9ySXs3dAyyos0yoc-bY8M1Z9Oti-AgGYEEK5K-Ctg,3412
-fameio/source/cli/make_config.py,sha256=phZKimvItl538xnwv9IhBoDkh__YqNlRk4YNDyTOFaA,2738
-fameio/source/cli/options.py,sha256=5DOFq4LMcObrSOlbt74HGE1vghByn-I30YY46tm5Snc,1422
-fameio/source/cli/parser.py,sha256=cVC6j_oy3lBQOC7nrk5oF2m5CpcohOh5y689lhvu4gw,9726
-fameio/source/loader.py,sha256=-Y0j3OrV2MwAlfxFP2YA3ZwZhP-eFVlT6hdHO4Qze2U,7536
-fameio/source/logs.py,sha256=9Iq9jcglGyALYir-Luxfa-m4uUJX074JkUM0uMwzPNc,3684
-fameio/source/metadata.py,sha256=zdqKEIEQ0NKqEmBTBdPEq0fw1MdsXwCpzs1O6rFTq_Y,1024
-fameio/source/path_resolver.py,sha256=cIEVvz7Eh4e3Rh87XkwyGiyj9iKxUI7TzWtq6ClhLd8,1321
-fameio/source/results/__init__.py,sha256=IQm0MNOXkhBexiMXBoNZDK5xHUYgazH7oXm-lc0Vm04,109
-fameio/source/results/agent_type.py,sha256=pW5cLduLlNOcBBvS6sCLpTpZt3D6B8UMsizEZhe5lJ0,4321
-fameio/source/results/conversion.py,sha256=5s6gPWNIOOLKn0O0-9gVvmJ8wq7m0Dh5NgtXIe1PIJs,3683
-fameio/source/results/csv_writer.py,sha256=lp5fhnhD99ksYLJwUguC9o8mujM8tkyCfq2vQ5LT1zw,5152
-fameio/source/results/data_transformer.py,sha256=tz58m7_TZPE3YjBoDyiMWiP_sz9mWaj1JfW2FjKLVhY,5490
-fameio/source/results/input_dao.py,sha256=5V_7dUhO1XZGNuwH5041HnMGCcQjC9d9_TBR4FZ9QJE,6919
-fameio/source/results/output_dao.py,sha256=-tMewCUS4m3RebTAf8Z33gtlj-SxqRdxnzvGIkg6Ah0,4106
-fameio/source/results/reader.py,sha256=g3cfbNq7eHO98dxtpqjjPE8_YJVM56Wp0MCnNi3ds5g,5054
-fameio/source/results/yaml_writer.py,sha256=rOAbeZQgRojYvofUcXreIdIJtdSbOrHAohiNLkmPgCI,837
-fameio/source/scenario/__init__.py,sha256=YfJvz275GWX8kVWMSMRcF3KsUQNqSAPrwBgNV7tqBTY,372
-fameio/source/scenario/agent.py,sha256=Z8jfMfUjrTJ4R1rEpwNdKCblhEx6-9xioewxGuajuqw,4713
-fameio/source/scenario/attribute.py,sha256=X63ZFpAdObTjMHpf0FD_H3v9sfOOqn7KDdjiGmyMZj4,4899
-fameio/source/scenario/contract.py,sha256=lM2NN_CUDh9iqDghq_F6JE9rEW3ZGUhBJOD0qkjuKBU,9442
-fameio/source/scenario/exception.py,sha256=7MYN4h40ptMZFD1lLtnK5PWXbAGlsmUSDmUQ5FAKeN8,1554
-fameio/source/scenario/fameiofactory.py,sha256=kV2GXGjNxYrt4lv5KoK8wYN6lfN3Z3hWaRNOl89gYv8,1654
-fameio/source/scenario/generalproperties.py,sha256=TkQV9dEo5zMfNiFITolJU1rQUBi-yDJLpoello39e_0,4796
-fameio/source/scenario/scenario.py,sha256=w64SHQXpRFIMhDUNOIRkuK81jY_cXvT_M4CNhtULbMQ,4585
-fameio/source/scenario/stringset.py,sha256=ZfObpTbAsYZcTti-1xoq3KaZf3D59fMToRkkZaTXIcc,1920
-fameio/source/schema/__init__.py,sha256=ZGTyliDbjlYGPAjB9bbggzACOYWdhm4I1VSmm7YGmTk,270
-fameio/source/schema/agenttype.py,sha256=fe6GWJwl2S-J7KmH_eR5Y8Ieez1difez1w7v-r26yGU,5183
-fameio/source/schema/attribute.py,sha256=wzu4563_zUU863dhjZQOuoPBBW4a7TjED5orKWuEujM,8357
-fameio/source/schema/exception.py,sha256=NMftGnrFOaS3MwrjZl8qbx3bi6KYUxhzHJIX1v--B5M,224
-fameio/source/schema/java_packages.py,sha256=-2ZbAG_htEowB-fBSMizsLWrphyiKfESDDHspzdEQP4,2656
-fameio/source/schema/schema.py,sha256=-J8VtO4W9Z-OnTV7MFO1umZWIC_epbLCYd6-q4lNQ8Y,2975
-fameio/source/series.py,sha256=wwq7Nm0i0mOvMOjmqPW5x1gSDnhpWEy14VLceUhWcYw,9041
-fameio/source/time.py,sha256=Vsd95nTubL8x5cwiznJYeti6clZCCHHJv7xjSpYqkF0,6984
-fameio/source/tools.py,sha256=B94U7Idq9ZuvsQmc9HOti016z4jn2oTTMIElWhs-5_w,1062
-fameio/source/validator.py,sha256=44wAlSxzSlaP9cm3YpNXOcs_kXIUNagctHLguY6H3T4,18596
-fameio/source/writer.py,sha256=d35rZGPLil3yku8_N6l1B45J4agKemBhAHJJPynQiJE,12499
-fameio-2.3.0.dist-info/entry_points.txt,sha256=jvQVfwJjZXPWQjJlhj1Dt6PTeblryTc1GxjKeK90twI,123
-fameio-2.3.0.dist-info/LICENSE.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
-fameio-2.3.0.dist-info/LICENSES/Apache-2.0.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
-fameio-2.3.0.dist-info/LICENSES/CC-BY-4.0.txt,sha256=y9WvMYKGt0ZW8UXf9QkZB8wj1tjJrQngKR7CSXeSukE,19051
-fameio-2.3.0.dist-info/LICENSES/CC0-1.0.txt,sha256=9Ofzc7m5lpUDN-jUGkopOcLZC3cl6brz1QhKInF60yg,7169
-fameio-2.3.0.dist-info/METADATA,sha256=meORlVQz4DNt17J2YC61Ioew13vSOPh1hFMYFjJUr8A,32471
-fameio-2.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-fameio-2.3.0.dist-info/RECORD,,