runem 0.0.11__tar.gz → 0.0.13__tar.gz

{runem-0.0.11 → runem-0.0.13}/HISTORY.md

@@ -4,6 +4,50 @@ Changelog
 
 (unreleased)
 ------------
+- Merge branch 'feat/better_module_find_error_msg' [Frank Harrison]
+- Feat(better-module-msg): improves the information given when loading a
+  job address. [Frank Harrison]
+
+
+0.0.12 (2023-11-29)
+-------------------
+- Release: version 0.0.12 🚀 [Frank Harrison]
+- Merge branch 'chore/format_yml' [Frank Harrison]
+- Chore(format-yml): reformats the .runem.yml file. [Frank Harrison]
+- Chore(format-yml): adds yml files to the prettier command. [Frank
+  Harrison]
+
+  This means that runems own runem config is reformatted
+- Merge branch 'feat/warn_on_bad_names' [Frank Harrison]
+- Feat(bad-label): errors on bad labels. [Frank Harrison]
+
+  .. not a massive improvment but really helps clarify what you SHOULD be looking at when things go wrong, which is nice
+- Feat(bad-func-ref-message): gives a better error message on bad
+  function references. [Frank Harrison]
+
+  Specifically when those functions cannot be found inside the file/module
+  that they're reference to by the .runem.yml
+- Merge branch 'chore/pretty_json' [Frank Harrison]
+- Chore(pretty-json): prettifies cspell.json. [Frank Harrison]
+- Chore(pretty-json): adds jobs to use prettifier via yarn. [Frank
+  Harrison]
+
+  ... currently this only targets json files
+- Merge branch 'chore/kwargs' [Frank Harrison]
+- Chore(kwargs): makes run_command 'cmd' the first thing as it cannot be
+  infered from the runem kwargs. [Frank Harrison]
+- Feat(kwargs): moves to using kwargs by preference when calling jobs.
+  [Frank Harrison]
+
+  ... jobs can then pass those kwargs down to the run_command
+- Chore(kwargs): deletes 0xDEADCODE. [Frank Harrison]
+
+  This deletes deadcode that was left over from the move out of the lursight codebase
+
+
+0.0.11 (2023-11-29)
+-------------------
+- Release: version 0.0.11 🚀 [Frank Harrison]
 - Merge branch 'fix/warning_when_no_files_for_job' [Frank Harrison]
 - Fix(warn-no-files): starts troubleshooting. [Frank Harrison]
 - Fix(warn-no-files): updates README after deleting defunct jobs. [Frank

{runem-0.0.11 → runem-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.0.11
+Version: 0.0.13
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight

runem-0.0.13/runem/VERSION

@@ -0,0 +1 @@
+0.0.13

{runem-0.0.11 → runem-0.0.13}/runem/run_command.py

@@ -16,19 +16,18 @@ def get_stdout(process: subprocess.CompletedProcess, prefix: str) -> str:
 
 
 def run_command(  # noqa: C901 # pylint: disable=too-many-branches
+    cmd: typing.List[str],  # 'cmd' is the only thing that can't be optionally kwargs
     label: str,
-    cmd: typing.List[str],
     verbose: bool,
     env_overrides: typing.Optional[dict] = None,
     ignore_fails: bool = False,
     valid_exit_ids: typing.Optional[typing.Tuple[int, ...]] = None,
+    **kwargs: typing.Any,
 ) -> str:
     """Runs the given command, returning stdout or throwing on any error."""
     cmd_string: str = " ".join(cmd)
     if verbose:
-        print("runem: test: " + "=" * TERMINAL_WIDTH)
-        print(f"runem: test: {label}")
-        print(f"{cmd_string}")
+        print(f"runem: running: start: {label}: {cmd_string}")
         if valid_exit_ids is not None:
             valid_exit_strs = ",".join([str(exit_code) for exit_code in valid_exit_ids])
             print(f"allowed return ids are: {valid_exit_strs}")
@@ -68,9 +67,6 @@ def run_command(  # noqa: C901 # pylint: disable=too-many-branches
     if run_env:
         run_env_param = run_env
 
-    if verbose:
-        print("runem: test: " + "=" * TERMINAL_WIDTH)
-
     process: subprocess.CompletedProcess
     try:
         process = subprocess.run(
@@ -110,5 +106,5 @@ def run_command(  # noqa: C901 # pylint: disable=too-many-branches
     cmd_stdout: str = get_stdout(process, prefix=label)
     if verbose:
         print(cmd_stdout)
-
+        print(f"runem: running: done: {label}: {cmd_string}")
     return cmd_stdout

{runem-0.0.11 → runem-0.0.13}/runem/runem.py

@@ -630,11 +630,12 @@ def _run_job(
         function(args, options, file_list)
     else:
         function(
-            options,  # type: ignore
-            file_list,  # type: ignore
+            options=options,  # type: ignore
+            file_list=file_list,  # type: ignore
             procs=args.procs,
             root_path=root_path,
             verbose=args.verbose,
+            **job_config,
         )
     end = timer()
     time_taken: timedelta = timedelta(seconds=end - start)
@@ -644,7 +645,7 @@ def _run_job(
 
 
 def _get_test_function(
-    cfg_filepath: typing.Optional[pathlib.Path],
+    cfg_filepath: pathlib.Path,
     module_name: str,
     module_file_path: pathlib.Path,
     function_to_load: str,
@@ -664,7 +665,16 @@ def _get_test_function(
     if not module_spec.loader:
         raise FunctionNotFound("unable to load module")
     module_spec.loader.exec_module(module)
-    function: JobFunction = getattr(module, function_to_load)
+    try:
+        function: JobFunction = getattr(module, function_to_load)
+    except AttributeError as err:
+        raise FunctionNotFound(
+            (
+                f"ERROR! Check that function '{function_to_load}' "
+                f"exists in '{module_file_path}' as expected in "
+                f"your config at '{str(cfg_filepath)}"
+            )
+        ) from err
     return function
 
 
@@ -696,9 +706,19 @@ def get_test_function(job_config: JobConfig, cfg_filepath: pathlib.Path) -> JobF
     Also re-address the job-config.
     """
     function_to_load: str = job_config["addr"]["function"]
-    module_file_path: pathlib.Path = _find_job_module(
-        cfg_filepath, job_config["addr"]["file"]
-    )
+    try:
+        module_file_path: pathlib.Path = _find_job_module(
+            cfg_filepath, job_config["addr"]["file"]
+        )
+    except FunctionNotFound as err:
+        raise FunctionNotFound(
+            (
+                f"Whilst loading job '{job_config['label']}' runem failed to find "
+                f"job.addr.file '{job_config['addr']['file']}' looking for "
+                f"job.addr.function '{function_to_load}'"
+            )
+        ) from err
+
     module_name = module_file_path.stem.replace(" ", "_").replace("-", "_")
 
     try:
@@ -856,10 +876,17 @@ def _parse_job_config(
     Returns the tags generated
     """
     try:
+        job_names_used = job["label"] in in_out_job_names
+        if job_names_used:
+            print("ERROR: duplicate job label!")
+            print(f"\t'{job['label']}' is used twice or more in {str(cfg_filepath)}")
+            sys.exit(1)
+
         # try and load the function _before_ we schedule it's execution
         get_test_function(job, cfg_filepath)
         phase_id: PhaseName = job["when"]["phase"]
         in_out_jobs_by_phase[phase_id].append(job)
+
         in_out_job_names.add(job["label"])
         in_out_phases.add(job["when"]["phase"])
         for tag in job["when"]["tags"]:

{runem-0.0.11 → runem-0.0.13}/runem.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.0.11
+Version: 0.0.13
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight

runem-0.0.11/runem/VERSION

@@ -1 +0,0 @@
-0.0.11