artefacts-cli 0.7.3__py3-none-any.whl → 0.9.1__py3-none-any.whl

artefacts/cli/locales/click.pot

@@ -0,0 +1,438 @@
+# Translations template for artefacts.
+# Copyright (C) 2025 Asteria ART
+# This file is distributed under the same license as the artefacts project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: artefacts 0.8.5.dev2\n"
+"Report-Msgid-Bugs-To: dev@artefacts.com\n"
+"POT-Creation-Date: 2025-04-30 18:06+0900\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+#: venv/lib/python3.10/site-packages/click/_termui_impl.py:179
+msgid "d"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/_termui_impl.py:606
+#, python-brace-format
+msgid "{editor}: Editing failed"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/_termui_impl.py:610
+#, python-brace-format
+msgid "{editor}: Editing failed: {e}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1002
+#, python-brace-format
+msgid ""
+"The parameter {param} is used more than once. Remove its duplicate as "
+"parameters should be unique."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1094
+#: venv/lib/python3.10/site-packages/click/core.py:1131
+#: venv/lib/python3.10/site-packages/click/core.py:2597
+#, python-brace-format
+msgid "(DEPRECATED: {target})"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1096
+#: venv/lib/python3.10/site-packages/click/core.py:1133
+#: venv/lib/python3.10/site-packages/click/core.py:2599
+msgid "(DEPRECATED)"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1098
+#: venv/lib/python3.10/site-packages/click/core.py:1135
+#, python-brace-format
+msgid "{text} {deprecated_message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1154
+msgid "Options"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1216
+#, python-brace-format
+msgid "Got unexpected extra argument ({args})"
+msgid_plural "Got unexpected extra arguments ({args})"
+msgstr[0] ""
+msgstr[1] ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1235
+#, python-brace-format
+msgid "DeprecationWarning: The command {name!r} is deprecated.{extra_message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1419
+msgid "Aborted!"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1793
+msgid "Commands"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1824
+msgid "Missing command."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:1902
+#, python-brace-format
+msgid "No such command {name!r}."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2177
+#, python-brace-format
+msgid "'default' {subject} must match nargs={nargs}."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2185
+#, python-brace-format
+msgid ""
+"The {type_name} '{readable_name}' is deprecated and still required. A "
+"deprecated {type_name} cannot be required."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2326
+msgid "Value must be an iterable."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2347
+#, python-brace-format
+msgid "Takes {nargs} values but 1 was given."
+msgid_plural "Takes {nargs} values but {len} were given."
+msgstr[0] ""
+msgstr[1] ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2427
+#, python-brace-format
+msgid ""
+"DeprecationWarning: The {param_type} {name!r} is "
+"deprecated.{extra_message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2702
+#, python-brace-format
+msgid " (env var: '{var}')"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2716
+#, python-brace-format
+msgid "Name '{name}' defined twice"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2732
+#, python-brace-format
+msgid "Boolean option {decl!r} cannot use the same flag for true/false."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2751
+#, python-brace-format
+msgid "Could not determine name for option with declarations {decls!r}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2758
+#, python-brace-format
+msgid ""
+"No options defined but a name was passed ({name}). Did you mean to "
+"declare an argument instead? Did you mean to pass '--{name}'?"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2835
+#, python-brace-format
+msgid "env var: {var}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2838
+#, python-brace-format
+msgid "default: {default}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2842
+msgid "required"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:2898
+msgid "(dynamic)"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/core.py:3128
+#, python-brace-format
+msgid "Arguments take exactly one parameter declaration, got {length}: {decls}."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/decorators.py:475
+#, python-format
+msgid "%(prog)s, version %(version)s"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/decorators.py:534
+msgid "Show the version and exit."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/decorators.py:560
+msgid "Show this message and exit."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:50
+#: venv/lib/python3.10/site-packages/click/exceptions.py:89
+#, python-brace-format
+msgid "Error: {message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:81
+#, python-brace-format
+msgid "Try '{command} {option}' for help."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:130
+#, python-brace-format
+msgid "Invalid value: {message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:132
+#, python-brace-format
+msgid "Invalid value for {param_hint}: {message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:190
+msgid "Missing argument"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:192
+msgid "Missing option"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:194
+msgid "Missing parameter"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:196
+#, python-brace-format
+msgid "Missing {param_type}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:203
+#, python-brace-format
+msgid "Missing parameter: {param_name}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:223
+#, python-brace-format
+msgid "No such option: {name}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:235
+#, python-brace-format
+msgid "Did you mean {possibility}?"
+msgid_plural "(Possible options: {possibilities})"
+msgstr[0] ""
+msgstr[1] ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:282
+msgid "unknown error"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/exceptions.py:289
+#, python-brace-format
+msgid "Could not open file {filename!r}: {message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/formatting.py:156
+msgid "Usage:"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/parser.py:154
+#, python-brace-format
+msgid "Invalid start character for option ({option})"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/parser.py:190
+#, python-brace-format
+msgid "unknown action '{action}'"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/parser.py:212
+#, python-brace-format
+msgid "Argument {name!r} takes {nargs} values."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/parser.py:395
+#, python-brace-format
+msgid "Option {name!r} does not take a value."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/parser.py:456
+#, python-brace-format
+msgid "Option {name!r} requires an argument."
+msgid_plural "Option {name!r} requires {nargs} arguments."
+msgstr[0] ""
+msgstr[1] ""
+
+#: venv/lib/python3.10/site-packages/click/parser.py:527
+#, python-brace-format
+msgid ""
+"'parser.{name}' is deprecated and will be removed in Click 9.0. The old "
+"parser is available in 'optparse'."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/parser.py:540
+msgid ""
+"Importing 'parser.split_arg_string' is deprecated, it will only be "
+"available in 'shell_completion' in Click 9.0."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/shell_completion.py:334
+msgid "Shell completion is not supported for Bash versions older than 4.4."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/shell_completion.py:341
+msgid "Couldn't detect Bash version, shell completion is not supported."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/termui.py:162
+msgid "Repeat for confirmation"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/termui.py:178
+msgid "Error: The value you entered was invalid."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/termui.py:180
+#, python-brace-format
+msgid "Error: {e.message}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/termui.py:191
+msgid "Error: The two entered values do not match."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/termui.py:247
+msgid "Error: invalid input"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/termui.py:611
+#: venv/lib/python3.10/site-packages/click/termui.py:617
+#, python-brace-format
+msgid "Unknown color {colour!r}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/termui.py:866
+msgid "Press any key to continue..."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:340
+#, python-brace-format
+msgid ""
+"Choose from:\n"
+"\t{choices}"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:377
+#, python-brace-format
+msgid "{value!r} is not {choice}."
+msgid_plural "{value!r} is not one of {choices}."
+msgstr[0] ""
+msgstr[1] ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:383
+#, python-brace-format
+msgid "Choice({choices})"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:468
+#, python-brace-format
+msgid "{value!r} does not match the format {format}."
+msgid_plural "{value!r} does not match the formats {formats}."
+msgstr[0] ""
+msgstr[1] ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:490
+#, python-brace-format
+msgid "{value!r} is not a valid {number_type}."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:546
+#, python-brace-format
+msgid "{value} is not in the range {range}."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:687
+#, python-brace-format
+msgid "{value!r} is not a valid boolean."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:711
+#, python-brace-format
+msgid "{value!r} is not a valid UUID."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:905
+msgid "file"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:907
+msgid "directory"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:909
+msgid "path"
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:956
+#, python-brace-format
+msgid "{name} {filename!r} does not exist."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:965
+#, python-brace-format
+msgid "{name} {filename!r} is a file."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:973
+#, python-brace-format
+msgid "{name} {filename!r} is a directory."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:982
+#, python-brace-format
+msgid "{name} {filename!r} is not readable."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:991
+#, python-brace-format
+msgid "{name} {filename!r} is not writable."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:1000
+#, python-brace-format
+msgid "{name} {filename!r} is not executable."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:1067
+#, python-brace-format
+msgid "{len_type} values are required, but {len_value} was given."
+msgid_plural "{len_type} values are required, but {len_value} were given."
+msgstr[0] ""
+msgstr[1] ""
+
+#: venv/lib/python3.10/site-packages/click/types.py:1130
+#, python-brace-format
+msgid "Attempted to use an uninstantiated parameter type ({type})."
+msgstr ""
+
+#: venv/lib/python3.10/site-packages/click/utils.py:342
+#: venv/lib/python3.10/site-packages/click/utils.py:363
+#, python-brace-format
+msgid "Unknown standard stream '{name}'"
+msgstr ""
+

artefacts/cli/logger.py

@@ -1,10 +1,26 @@
 import logging
 import sys
 
-logger = logging.getLogger()
+logger = logging.getLogger("artefacts")
+logger.setLevel(logging.INFO)  # Allow INFO and above
 
-default_handler = logging.StreamHandler(stream=sys.stderr)
-default_handler.setLevel(logging.ERROR)
-default_handler.setFormatter(logging.Formatter())
 
-logger.addHandler(default_handler)
+# INFO and WARNING messages go to stdout
+class InfoWarningFilter(logging.Filter):
+    def filter(self, record):
+        return record.levelno in [logging.INFO, logging.WARNING]
+
+
+info_handler = logging.StreamHandler(stream=sys.stdout)
+info_handler.setLevel(logging.INFO)
+info_handler.addFilter(InfoWarningFilter())
+info_handler.setFormatter(logging.Formatter("%(message)s"))
+
+# ERROR and above go to stderr
+error_handler = logging.StreamHandler(stream=sys.stderr)
+error_handler.setLevel(logging.ERROR)
+error_handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
+
+logger.addHandler(info_handler)
+logger.addHandler(error_handler)
+logger.propagate = False

artefacts/cli/other.py

@@ -16,10 +16,14 @@ def generate_parameter_output(params: dict):
 
 
 def run_other_tests(run):
+    """Note: parameter names will be set as environment variables
+    (must be letters, numbers and underscores), and saved into yaml and json files
+    """
     scenario = run.params
     if "params" in scenario:
         generate_parameter_output(scenario["params"])
     full_env = {**os.environ, **scenario.get("params", {})}
+    full_env["ARTEFACTS_SCENARIO_PARAMS_FILE"] = TMP_SCENARIO_PARAMS_YAML
 
     command = scenario["run"]
     run_and_save_logs(

artefacts/cli/ros1.py

@@ -4,6 +4,7 @@ from glob import glob
 import os
 import logging
 
+from .i18n import localise
 from .utils import run_and_save_logs
 from .utils_ros import parse_tests_results
 from .parameters import TMP_RUNTIME_PARAMS_YAML, TMP_SCENARIO_PARAMS_YAML
@@ -50,7 +51,9 @@ def generate_rosbag_args(scenario: dict) -> str:
             return topics
         else:
             logging.warning(
-                "[warning in generate_rosbag_args] rosbag_record asks for 'subscriptions' but they are not specified. Falling back to default: no rosbag will be recorded"
+                localise(
+                    "[warning in generate_rosbag_args] rosbag_record asks for 'subscriptions' but they are not specified. Falling back to default: no rosbag will be recorded"
+                )
             )
             return "none"
     else:
@@ -101,10 +104,20 @@ def get_result_path(scenario, PKGDIR, PACKAGE):
         )
         return test_result_file_path
     except Exception as e:
-        logging.error(f"[Exception in get_result_path()] {e}")
         logging.error(
-            f"Unable to parse the ros1 .launch specified ({scenario['ros_testfile']}) and the <test> tag within to find the unittest test method's name.",
-            "Please ensure all ROS and unittest naming conventions are respected. Exiting..",
+            localise("[Exception in get_result_path()] {message}".format(message=e))
+        )
+        logging.error(
+            localise(
+                "Unable to parse the ros1 .launch specified ({testfile}) and the <test> tag within to find the unittest test method's name.".format(
+                    testfile=scenario["ros_testfile"]
+                )
+            )
+        )
+        logging.error(
+            localise(
+                "Please ensure all ROS and unittest naming conventions are respected. Exiting.."
+            )
         )
         return None
 
@@ -210,12 +223,14 @@ def run_ros1_tests(run):
     new_rosbags = set(rosbags).difference(set(preexisting_rosbags))
     if len(new_rosbags) > 0:
         new_rosbag = new_rosbags.pop()
-        logging.info(f"new rosbag found: {new_rosbag}")
+        logging.info(
+            localise("New rosbag found: {file_name}".format(file_name=new_rosbag))
+        )
         # upload rosbag to dashboard
         run.log_single_artifact(new_rosbag, "rosbag")
         # perform any post processing, using the rosbag
         if "rosbag_postprocess" in scenario.keys():
-            logging.info("starting rosbag postprocess")
+            logging.info(localise("starting rosbag postprocess"))
             post_process_folder = os.path.expanduser(f"{PKGDIR}/{PACKAGE}_postprocess")
             os.makedirs(post_process_folder, exist_ok=True)
             existing_files = glob(f"{post_process_folder}/*")

artefacts/cli/ros2.py

@@ -1,8 +1,10 @@
-import yaml
 from glob import glob
 import os
 import shutil
 
+import yaml
+
+from .i18n import localise
 from .utils import run_and_save_logs
 from .utils_ros import parse_tests_results, get_TestSuite_error_result
 from .parameters import TMP_SCENARIO_PARAMS_YAML
@@ -66,7 +68,11 @@ def generate_scenario_parameter_output(params: dict, param_file: str):
         try:
             node, pname = k.split("/")
         except Exception:
-            print("ensure params are in the format `{node_name}/{param_name}`")
+            print(
+                localise(
+                    "Problem with parameter name. Please ensure params are in the format `node/param`"
+                )
+            )
             return
         if node not in content:
             content[node] = {"ros__parameters": {}}
@@ -93,8 +99,11 @@ def run_ros2_tests(run):
         generate_scenario_parameter_output(
             run.params["params"], TMP_SCENARIO_PARAMS_YAML
         )
-
-    preexisting_rosbags = glob("rosbag2*")
+    # We look for the directory as drilling down will find both
+    # the directory as well as the rosbag itself.
+    preexisting_rosbags = [
+        path for path in glob("**/rosbag2*", recursive=True) if os.path.isdir(path)
+    ]
     test_result_file_path = f"{run.output_path}/tests_junit.xml"
     launch_arguments = [
         f"{k}:={v}" for k, v in run.params.get("launch_arguments", {}).items()
@@ -126,7 +135,7 @@ def run_ros2_tests(run):
             },
             output_path=os.path.join(run.output_path, "test_process_log.txt"),
         )
-    except Launch_test_CmdNotFoundError as e:
+    except Launch_test_CmdNotFoundError:
         # raise Exception(
         #    f"Running {scenario['ros_testfile']} failed. Please check that the launch file exists."
         # )
@@ -182,33 +191,40 @@ def run_ros2_tests(run):
     for output in scenario.get("output_dirs", []):
         run.log_artifacts(output)
 
-    # check if any rosbag was created
-    rosbags = glob("rosbag2*")
+    # Checks for a new rosbag after test completions. We look for the directory
+    # as drilling down will find both the directory as well as the rosbag itself.
+    rosbags = [
+        path for path in glob("**/rosbag2*", recursive=True) if os.path.isdir(path)
+    ]
     new_rosbags = set(rosbags).difference(set(preexisting_rosbags))
     from artefacts.cli.bagparser import BagFileParser
 
+    run.logger.info(f"Found new rosbags: {new_rosbags}")
     if len(new_rosbags) > 0:
-        rosbag_path = new_rosbags.pop()
-        run.log_artifacts(rosbag_path, "rosbag")
+        rosbag_dir = new_rosbags.pop()
+        run.log_artifacts(rosbag_dir, "rosbag")
         if "metrics" in run.params:
-            # TODO should go inside BagFileParser?
-            db_files = glob(f"{rosbag_path}/*.mcap")  # Ros2 Default
+            # Search for database files in the directory
+            # TODO: should go inside BagFileParser?
+            db_files = glob(f"{rosbag_dir}/*.mcap")  # Ros2 Default
             if not db_files:
-                db_files = glob(f"{rosbag_path}/*.db3")  # Legacy
+                db_files = glob(f"{rosbag_dir}/*.db3")  # Legacy
             if not db_files:
                 raise FileNotFoundError(
-                    "No .mcap or .db3 files found in the specified path."
+                    "No .mcap or .db3 files found in the specified path. Attempted to find in "
+                    f"{rosbag_dir}/*.mcap and {rosbag_dir}/*.db3"
                 )
             db_file = db_files[0]
+
             bag = BagFileParser(db_file)
             for metric in run.params["metrics"]:
                 try:
                     last_value = bag.get_last_message(metric)[1].data
                     run.log_metric(metric, last_value)
                 except KeyError:
-                    print(f"Metric {metric} not found in rosbag, skipping.")
+                    run.logger.error(f"Metric {metric} not found in rosbag, skipping.")
                 except TypeError or IndexError:
-                    print(
+                    run.logger.error(
                         f"Metric {metric} not found. Is it being published?. Skipping."
                     )
 

artefacts/cli/utils.py

@@ -8,7 +8,7 @@ import click
 
 import artefacts_copava as copava
 from artefacts import ARTEFACTS_DEFAULT_OUTPUT_DIR
-from artefacts.cli import WarpRun
+from artefacts.cli import WarpRun, localise
 
 
 def run_and_save_logs(
@@ -74,13 +74,17 @@ def ensure_available(package: str) -> None:
 def read_config(filename: str) -> dict:
     try:
         with open(filename) as f:
-            return copava.parse(f.read())
+            return copava.parse(f.read()) or {}
     except FileNotFoundError:
-        raise click.ClickException(f"Project config file {filename} not found.")
+        raise click.ClickException(
+            localise(
+                "Project config file {file_name} not found.".format(file_name=filename)
+            )
+        )
 
 
 # Click callback syntax
-def config_validation(context: dict, param: str, value: str) -> str:
+def config_validation(context: click.Context, param: str, value: str) -> str:
     if context.params.get("skip_validation", False):
         return value
     config = read_config(value)