fameio 1.8.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

fameio/source/cli.py

@@ -1,253 +0,0 @@
-# SPDX-FileCopyrightText: 2023 German Aerospace Center <fame@dlr.de>
-#
-# SPDX-License-Identifier: Apache-2.0
-
-import argparse
-import copy
-from enum import Enum, auto
-from pathlib import Path
-from typing import Optional, Dict, Any, List, Tuple
-
-from fameio.source.logs import LOG_LEVELS
-
-ERR_NEGATIVE_INT = "Given value `{}` is not a non-negative int."
-
-
-class Options(Enum):
-    """Specifies command line configuration options"""
-
-    FILE = auto()
-    LOG_LEVEL = auto()
-    LOG_FILE = auto()
-    OUTPUT = auto()
-    AGENT_LIST = auto()
-    SINGLE_AGENT_EXPORT = auto()
-    MEMORY_SAVING = auto()
-    RESOLVE_COMPLEX_FIELD = auto()
-    TIME = auto()
-    TIME_MERGING = auto()
-
-
-class TimeOptions(Enum):
-    """Specifies options for conversion of time in output"""
-
-    INT = auto()
-    UTC = auto()
-    FAME = auto()
-
-
-class ResolveOptions(Enum):
-    """Specifies options for resolving complex fields in output files"""
-
-    IGNORE = auto()
-    SPLIT = auto()
-    MERGE = auto()
-
-
-class MergingOptions(Enum):
-    """Specifies options for merging TimeSteps"""
-
-    FOCAL_POINT = auto()
-    STEPS_BEFORE = auto()
-    STEPS_AFTER = auto()
-
-
-def arg_handling_make_config(args: List[str], defaults: Dict) -> Tuple[str, Dict]:
-    """Handles command line arguments and returns `input_file` and `run_config` for make_config script"""
-    parser = argparse.ArgumentParser()
-
-    add_file_argument(parser, "provide path to configuration file")
-    add_log_level_argument(parser, defaults[Options.LOG_LEVEL])
-    add_logfile_argument(parser)
-    add_output_argument(parser, defaults[Options.OUTPUT], "provide file-path for the file to generate")
-
-    args = parser.parse_args(args)
-    run_config = {
-        Options.LOG_LEVEL: args.log,
-        Options.LOG_FILE: args.logfile,
-        Options.OUTPUT: args.output,
-    }
-    return args.file, run_config
-
-
-def arg_handling_convert_results(args: List[str], defaults: Dict) -> Tuple[str, Dict]:
-    """Handles command line arguments and returns `input_file` and `run_config` for convert_results script"""
-    parser = argparse.ArgumentParser()
-
-    add_file_argument(parser, "provide path to protobuf file")
-    add_log_level_argument(parser, defaults[Options.LOG_LEVEL])
-    add_logfile_argument(parser)
-    add_output_argument(
-        parser,
-        defaults[Options.OUTPUT],
-        "provide path to folder to store output .csv files",
-    )
-    add_select_agents_argument(parser)
-    add_single_export_argument(parser, defaults[Options.SINGLE_AGENT_EXPORT])
-    add_memory_saving_argument(parser, defaults[Options.MEMORY_SAVING])
-    add_resolve_complex_argument(parser, defaults[Options.RESOLVE_COMPLEX_FIELD])
-    add_time_argument(parser, defaults[Options.TIME])
-    add_merge_time_parser(parser)
-
-    args = parser.parse_args(args)
-
-    run_config = {
-        Options.LOG_LEVEL: args.log,
-        Options.LOG_FILE: args.logfile,
-        Options.OUTPUT: args.output,
-        Options.AGENT_LIST: args.agents,
-        Options.SINGLE_AGENT_EXPORT: args.single_export,
-        Options.MEMORY_SAVING: args.memory_saving,
-        Options.RESOLVE_COMPLEX_FIELD: ResolveOptions[args.complex_column],
-        Options.TIME: args.time,
-        Options.TIME_MERGING: get_merging_args(args),
-    }
-    return args.file, run_config
-
-
-def add_file_argument(parser: argparse.ArgumentParser, help_text: str) -> None:
-    """Adds required 'file' argument to the provided `parser` with the provided `help_text`"""
-    parser.add_argument("-f", "--file", type=Path, required=True, help=help_text)
-
-
-def add_select_agents_argument(parser: argparse.ArgumentParser) -> None:
-    """Adds optional repeatable string argument 'agent' to given `parser`"""
-    help_text = "Provide list of agents to extract (default=None)"
-    parser.add_argument("-a", "--agents", nargs="*", type=str, help=help_text)
-
-
-def add_logfile_argument(parser: argparse.ArgumentParser) -> None:
-    """Adds optional argument 'logfile' to given `parser`"""
-    help_text = "provide logging file (default=None)"
-    parser.add_argument("-lf", "--logfile", type=Path, help=help_text)
-
-
-def add_output_argument(parser: argparse.ArgumentParser, default_value, help_text: str) -> None:
-    """Adds optional argument 'output' to given `parser` using the given `help_text` and `default_value`"""
-    parser.add_argument("-o", "--output", type=Path, default=default_value, help=help_text)
-
-
-def add_log_level_argument(parser: argparse.ArgumentParser, default_value: str) -> None:
-    """Adds optional argument 'log' to given `parser`"""
-    help_text = "choose logging level (default: {})".format(default_value)
-    parser.add_argument(
-        "-l",
-        "--log",
-        default=default_value,
-        choices=list(LOG_LEVELS.keys()),
-        type=str.lower,
-        help=help_text,
-    )
-
-
-def add_single_export_argument(parser: argparse.ArgumentParser, default_value: bool) -> None:
-    """Adds optional repeatable string argument 'agent' to given `parser`"""
-    help_text = "Enable export of single agents (default=False)"
-    parser.add_argument(
-        "-se",
-        "--single-export",
-        default=default_value,
-        action="store_true",
-        help=help_text,
-    )
-
-
-def add_memory_saving_argument(parser: argparse.ArgumentParser, default_value: bool) -> None:
-    """Adds optional bool argument to given `parser` to enable memory saving mode"""
-    help_text = "Reduces memory usage profile at the cost of runtime (default=False)"
-    parser.add_argument(
-        "-m",
-        "--memory-saving",
-        default=default_value,
-        action="store_true",
-        help=help_text,
-    )
-
-
-def add_resolve_complex_argument(parser, default_value: str):
-    """Instructs given `parser` how to deal with complex field outputs"""
-    help_text = f"How to deal with complex index columns? (default={default_value})"
-    parser.add_argument(
-        "-cc",
-        "--complex-column",
-        default=default_value,
-        choices=[e.name for e in ResolveOptions],
-        help=help_text,
-        type=str.upper,
-    )
-
-
-def add_time_argument(parser: argparse.ArgumentParser, default_value: str) -> None:
-    """Adds optional argument to given `parser` to define conversion of TimeSteps"""
-    help_text = "Apply conversion of time steps to given format (default=UTC)"
-    parser.add_argument(
-        "-t", "--time", default=default_value, choices=[e.name for e in TimeOptions], help=help_text, type=str.upper
-    )
-
-
-def add_merge_time_parser(parser: argparse.ArgumentParser) -> None:
-    """Adds subparser for merging of TimeSteps to given `parser`"""
-    subparser = parser.add_subparsers(dest="time_merging", required=False, help="Optional merging of TimeSteps")
-    group_parser = subparser.add_parser("merge-times")
-    add_focal_point_argument(group_parser)
-    add_steps_before_argument(group_parser)
-    add_steps_after_argument(group_parser)
-
-
-def add_focal_point_argument(parser: argparse.ArgumentParser) -> None:
-    """Adds `focal-point` argument to given `parser`"""
-    help_text = "TimeStep on which `steps_before` earlier and `steps_after` later TimeSteps are merged on"
-    parser.add_argument("-fp", "--focal-point", required=True, type=int, help=help_text)
-
-
-def add_steps_before_argument(parser: argparse.ArgumentParser) -> None:
-    """Adds `steps-before` argument to given `parser`"""
-    help_text = "Range of TimeSteps before the `focal-point` they get merged to"
-    parser.add_argument("-sb", "--steps-before", required=True, type=non_negative_int, help=help_text)
-
-
-def non_negative_int(value: Any) -> int:
-    """
-    Casts a given ´value` to int and checks it for non-negativity
-
-    Args:
-        value: to check and parse
-
-    Returns:
-        `value` parsed to int if it is a non-negative integer
-
-    Raises:
-        TypeError: if `value` is None
-        ValueError: if `value` cannot be parsed to int
-        argparse.ArgumentTypeError: if `value` is a negative int
-
-    """
-    value = int(value)
-    if value < 0:
-        raise argparse.ArgumentTypeError(ERR_NEGATIVE_INT.format(value))
-    return value
-
-
-def add_steps_after_argument(parser: argparse.ArgumentParser) -> None:
-    """Adds `steps-after` argument to given `parser`"""
-    help_text = "Range of TimeSteps after the `focal-point` they get merged to"
-    parser.add_argument("-sa", "--steps-after", required=True, type=non_negative_int, help=help_text)
-
-
-def get_merging_args(args: argparse.Namespace) -> Dict[MergingOptions, int]:
-    """Returns a dictionary of GroupingOptions with their values if `time_merging` entry exists"""
-    merging_args = {}
-    if vars(args).get("time_merging"):
-        merging_args[MergingOptions.FOCAL_POINT] = args.focal_point
-        merging_args[MergingOptions.STEPS_BEFORE] = args.steps_before
-        merging_args[MergingOptions.STEPS_AFTER] = args.steps_after
-    return merging_args
-
-
-def update_default_config(config: Optional[dict], default: dict) -> dict:
-    """Returns `default` config with updated fields received from `config`"""
-    result = copy.deepcopy(default)
-    if config:
-        for name, option in config.items():
-            result[name] = option
-    return result

fameio-1.8.1.dist-info/RECORD

@@ -1,40 +0,0 @@
-fameio/__init__.py,sha256=IQm0MNOXkhBexiMXBoNZDK5xHUYgazH7oXm-lc0Vm04,109
-fameio/scripts/__init__.py,sha256=9WB1NgbuF-CoBLL_FhWJMtEAO7hUV6GUM_Grx3Y4OL8,746
-fameio/scripts/convert_results.py,sha256=LKqSP-jG0rEf4jK3eRxkOXOtYNo1c-WvbkYS5rXyE18,3296
-fameio/scripts/make_config.py,sha256=F2cmYNmWtLbLO-bHS6i8YlBtZ67JPXaKEPkiblX-QqU,1339
-fameio/source/__init__.py,sha256=14CnWOIkdSeKQg6FioQSgO7UtEFF6pO4MUtDAUfwNmA,278
-fameio/source/cli.py,sha256=UuIrC3cB-HehuoQwwjsVn86qdNdqSL5m0jmyiboKdtc,9384
-fameio/source/loader.py,sha256=Ol_Q83OD2HeSPD3lX8XP3bGHef-E7YvCXGEspddoAyA,7403
-fameio/source/logs.py,sha256=lO11JHAl6iWr_d6-ETD_IVwkeL__ZIhi27wSvSuWKnI,1929
-fameio/source/path_resolver.py,sha256=cIEVvz7Eh4e3Rh87XkwyGiyj9iKxUI7TzWtq6ClhLd8,1321
-fameio/source/series.py,sha256=BgJLmxGGzrZmWjXMYrUcj53-y3VwV8PbAaqsa1TuiRQ,1924
-fameio/source/time.py,sha256=TCcGl0BYVJztiptqh8uagIvYEUlKbY9FMtkxnPYM884,6943
-fameio/source/tools.py,sha256=SyR1VoWRos64zp7zieQ9JWnB3qP9Zh2Ig-VI9J9w5Pw,630
-fameio/source/validator.py,sha256=hSKogx2mQpIDlIZdi5OEa9h39dOqL9rzNW4wJS6imgE,11409
-fameio/source/writer.py,sha256=HqRbNOwHK-367sOi3sA1JP3ZHCS6te55Fk9T9FjlSyc,11633
-fameio/source/results/__init__.py,sha256=IQm0MNOXkhBexiMXBoNZDK5xHUYgazH7oXm-lc0Vm04,109
-fameio/source/results/agent_type.py,sha256=pW5cLduLlNOcBBvS6sCLpTpZt3D6B8UMsizEZhe5lJ0,4321
-fameio/source/results/conversion.py,sha256=j75BP5jdSFMY251SMk5SMOVURVi_uUKapCSkMak_0Ro,3793
-fameio/source/results/csv_writer.py,sha256=OHjglOdEzQcWrupVMlt7ya5jC3prPP2FaX6D_yLP_xY,4216
-fameio/source/results/data_transformer.py,sha256=Elbb5tHzvGeGGXgw7O-mvM5IzGlddY858d3lEImBZGA,6222
-fameio/source/results/output_dao.py,sha256=8FocGe4yyH3EdHD5Chw9uCGnDetfJoSglBga0o3lnWE,3960
-fameio/source/results/reader.py,sha256=hluy_hPCbq-bbu6qyRUuph710ANXPfEv9B5Y0YyzBO0,4791
-fameio/source/scenario/__init__.py,sha256=YfJvz275GWX8kVWMSMRcF3KsUQNqSAPrwBgNV7tqBTY,372
-fameio/source/scenario/agent.py,sha256=YbzEP-mahBPkKCbyAKm9u-JTmoIrmo36ql9VhWcOtTw,3830
-fameio/source/scenario/attribute.py,sha256=iRGVkH33wKgB-B2GcmaDo2P4Mcj_qzzGryE_0YPhC3M,5002
-fameio/source/scenario/contract.py,sha256=4ewwtX9bXgM5dczKbiXvafQKloxkeG_A21_ZrcTC5cI,8853
-fameio/source/scenario/exception.py,sha256=0dkBAs2pcV5zeqEUF8eYVZ51b-2pewWyLDjggjANQyo,1455
-fameio/source/scenario/fameiofactory.py,sha256=7P-x8i9sSU9sIkOlgF6gVRFuNacFMUBrBh4KdHoAUtU,1376
-fameio/source/scenario/generalproperties.py,sha256=SIRmIyDFMhdzNtHfGnK4jdsZZtS8fxtKizqL6XzANyA,4593
-fameio/source/scenario/scenario.py,sha256=z5SaEXhfJcEDtQv_WtAo8YJVYexypz0JQdcN5d1LLOo,3582
-fameio/source/schema/__init__.py,sha256=ZGTyliDbjlYGPAjB9bbggzACOYWdhm4I1VSmm7YGmTk,270
-fameio/source/schema/agenttype.py,sha256=vXzcSGz-swftDESy5GL_6p4FXBU5kYg1bkzVnISQiXA,3331
-fameio/source/schema/attribute.py,sha256=pgxUjacqRhIJRgIrkBz3_r1LbbsRe9KssajRMyVRYFo,8214
-fameio/source/schema/exception.py,sha256=NMftGnrFOaS3MwrjZl8qbx3bi6KYUxhzHJIX1v--B5M,224
-fameio/source/schema/schema.py,sha256=mJyPlIhw_5AJZwNnsPCKhtfbjXKsTozBgFz5Xrkowic,1715
-fameio-1.8.1.dist-info/LICENSE.txt,sha256=eGHBZnhr9CWjE95SWjRfmhtK1lvVn5X4Fpf3KrrAZDg,10391
-fameio-1.8.1.dist-info/METADATA,sha256=np8UZsZi3Y4c6tUox6iyqN7xzkorZrd9qxhbnOF-kkE,29656
-fameio-1.8.1.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-fameio-1.8.1.dist-info/entry_points.txt,sha256=9pwKjYQ6B5n1umD1wjrGU3t9jUJ0fawThOt0wTKoqUA,126
-fameio-1.8.1.dist-info/top_level.txt,sha256=awP3PJ9u2oNrXHwVGcSaXYYnpCa1-4OXrUuYhnWjlMA,7
-fameio-1.8.1.dist-info/RECORD,,

fameio-1.8.1.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-convertFameResults = fameio.scripts:convertFameResults
-makeFameRunConfig = fameio.scripts:makeFameRunConfig

fameio-1.8.1.dist-info/top_level.txt

@@ -1 +0,0 @@
-fameio