runem 0.0.32__tar.gz → 0.1.1__tar.gz

{runem-0.0.32 → runem-0.1.1}/HISTORY.md

@@ -4,6 +4,94 @@ Changelog
 
 (unreleased)
 ------------
+- Merge pull request #58 from lursight/fix/completed_job_counts. [Frank
+  Harrison]
+
+  fix(complete-job-count): fixes and simplifies the in-progress report code
+- Fix(complete-job-count): fixes and simplifies the in-progress report
+  code. [Frank Harrison]
+
+  The core problem was that the remaining-job-count didn't match the
+  number of job-labels that were being shown.
+
+  The root-cause was due to some of the job-tasks completing before the
+  `_update_progress()` thread had started monitoring the jobs.
+
+  We fix this by adding a new parameter to the job-executer that tracks
+  when job completed. It's a very simple fix and reduces the overall
+  complexity for about the same cost of threading-primitives.
+
+
+0.1.0 (2024-11-17)
+------------------
+- Release: version 0.1.0 🚀 [Frank Harrison]
+- Merge pull request #57 from lursight/feat/replace_halo_with_rich.
+  [Frank Harrison]
+
+  feat(rich): moves to using rich instead of halo for spinners
+- Feat(rich): moves to using rich instead of halo for spinners. [Frank
+  Harrison]
+- Merge pull request #56 from lursight/feat/better_job_function_typing.
+  [Frank Harrison]
+
+  feat(better-job-function-typing): adds stronger typing for job and hook tasks
+- Feat(better-job-function-typing): adds stronger typing for job and
+  hook tasks. [Frank Harrison]
+
+  We do this by typing the kwargs convenience variable, for which we need
+  to use `Unpack` (for back compatibility), and `type_extensions` for
+  cross-python-version compatibility (i.e. something that work for all
+  targeted version of python).
+
+  As a side-effect of this we get the benefit of seeing when and where we
+  add extra data into the call-stack for `job_execute()` and it emerges
+  that we only extend the key-word args when we are calling hooks in a
+  non-threaded way, which makes sense.
+
+  We do several things to achieve this:
+    1. We have common parameters passed to both hooks and job-tasks
+        - These common parameters make the hooks and job-task feel similar
+          to develop.
+    2. We put all hook-specific kwargs in one place, and mark each as
+       optional.
+        - this, for now, is mainly because we only have one hook, so this
+          will likely change.
+    3. We share and combine kwargs in a range of inheritance types, mainly
+       to work with(/around?) python-typing, which isn't great in this
+       type of situation.
+- Chore(ignores): adds the tox/ dir to the ignores. [Frank Harrison]
+- Chore(ignores): update git ignore for coverage files and docs gen.
+  [Frank Harrison]
+
+  The docs are recent additions.
+- Merge pull request #55 from lursight/chore/test_improvements. [Frank
+  Harrison]
+
+  Chore/test improvements
+- Chore(coverage): reduce false-positives by deleteing old
+  coverage_report files. [Frank Harrison]
+
+  Sometimes we would have stale .coverage_report.* files left behind where
+  from the multi-distributed pytest runs. These would lead more lines
+  being reported as coverage than actual - aka false-positive test passes
+  for coverage.
+- Chore(help-tests): fixes the help output width in tests. [Frank
+  Harrison]
+
+  This reduces false-negative test results where we get word-splits in
+  directories or between process counters or other dynamic content.
+
+  This was due to the width of the terminal when the test was being run
+  being variant with developer-machine. This uses a fixed-width output,
+  reducing, if not stopping issues.
+- Chore(deps): updates black 24.3.0 -> 24.10.0. [Frank Harrison]
+- Chore(deps): updates to latest pytest 8.1.1 -> 8.3.3 + plugins. [Frank
+  Harrison]
+
+
+0.0.32 (2024-11-17)
+-------------------
+- Release: version 0.0.32 🚀 [Frank Harrison]
 - Merge pull request #54 from lursight/chore/use_tox_on_release. [Frank
   Harrison]
 

{runem-0.0.32 → runem-0.1.1}/PKG-INFO

@@ -1,17 +1,18 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.0.32
+Version: 0.1.1
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: halo
 Requires-Dist: packaging
 Requires-Dist: PyYAML
+Requires-Dist: rich
+Requires-Dist: typing_extensions
 Provides-Extra: tests
-Requires-Dist: black==24.3.0; extra == "tests"
-Requires-Dist: coverage==7.4.4; extra == "tests"
+Requires-Dist: black==24.10.0; extra == "tests"
+Requires-Dist: coverage==7.5; extra == "tests"
 Requires-Dist: docformatter==1.7.5; extra == "tests"
 Requires-Dist: flake8-bugbear==24.2.6; extra == "tests"
 Requires-Dist: flake8==7.0.0; extra == "tests"
@@ -22,10 +23,10 @@ Requires-Dist: mypy==1.9.0; extra == "tests"
 Requires-Dist: pydocstyle==6.3.0; extra == "tests"
 Requires-Dist: pylint==3.1.0; extra == "tests"
 Requires-Dist: pylama==8.4.1; extra == "tests"
-Requires-Dist: pytest-cov==4.1.0; extra == "tests"
+Requires-Dist: pytest-cov==6.0.0; extra == "tests"
 Requires-Dist: pytest-profiling==1.7.0; extra == "tests"
-Requires-Dist: pytest-xdist==3.5.0; extra == "tests"
-Requires-Dist: pytest==8.1.1; extra == "tests"
+Requires-Dist: pytest-xdist==3.6.1; extra == "tests"
+Requires-Dist: pytest==8.3.3; extra == "tests"
 Requires-Dist: setuptools; extra == "tests"
 Requires-Dist: termplotlib==0.3.9; extra == "tests"
 Requires-Dist: tox; extra == "tests"

{runem-0.0.32 → runem-0.1.1}/requirements-test.txt

@@ -1,6 +1,6 @@
 # This requirements are for development and testing only, not for production.
-black==24.3.0
-coverage==7.4.4
+black==24.10.0
+coverage==7.5
 docformatter==1.7.5
 flake8-bugbear==24.2.6
 flake8==7.0.0
@@ -11,10 +11,10 @@ mypy==1.9.0
 pydocstyle==6.3.0
 pylint==3.1.0
 pylama==8.4.1
-pytest-cov==4.1.0
+pytest-cov==6.0.0
 pytest-profiling==1.7.0
-pytest-xdist==3.5.0
-pytest==8.1.1
+pytest-xdist==3.6.1
+pytest==8.3.3
 setuptools
 termplotlib==0.3.9
 tox

runem-0.1.1/requirements.txt

@@ -0,0 +1,9 @@
+packaging
+PyYAML
+
+# For UI Elements
+rich
+
+# For pre python3.12 Unpack features we need the `typing_extensions` module to
+# be installed.
+typing_extensions

runem-0.1.1/runem/VERSION

@@ -0,0 +1 @@
+0.1.1

{runem-0.0.32 → runem-0.1.1}/runem/command_line.py

@@ -12,6 +12,45 @@ from runem.types import JobNames, OptionConfig, OptionsWritable
 from runem.utils import printable_set
 
 
+class HelpFormatterFixedWidth(argparse.HelpFormatter):
+    """This works around test issues via constant width helo output.
+
+    This ensures that we get more constant for help-text by fixing the width to
+    something reasonable.
+    """
+
+    def __init__(self, prog: typing.Any) -> None:
+        # Override the default width with a fixed width, for tests.
+        super().__init__(
+            prog,
+            # Pretty wide so we do not get wrapping on directories
+            # or process-count output.
+            width=1000,
+        )
+
+
+def _get_argparse_help_formatter() -> typing.Any:
+    """Returns a help-formatter for argparse.
+
+    This is for tests only to fake terminals of a constant with when rendering help
+    output.
+    """
+    # Check environment variable to see if we're in tests and need a fixed width
+    # help output.
+    use_fixed_width = os.getenv("RUNEM_FIXED_HELP_WIDTH", None)
+
+    if use_fixed_width:
+        # Use custom formatter with the width specified in the environment variable
+        return (
+            lambda prog: HelpFormatterFixedWidth(  # pylint: disable=unnecessary-lambda
+                prog
+            )
+        )
+
+    # Use default formatter
+    return argparse.HelpFormatter
+
+
 def parse_args(
     config_metadata: ConfigMetadata, argv: typing.List[str]
 ) -> ConfigMetadata:
@@ -23,7 +62,9 @@ def parse_args(
     Returns the parsed args, the jobs_names_to_run, job_phases_to_run, job_tags_to_run
     """
     parser = argparse.ArgumentParser(
-        add_help=False, description="Runs the Lursight Lang test-suite"
+        add_help=False,
+        description="Runs the Lursight Lang test-suite",
+        formatter_class=_get_argparse_help_formatter(),
     )
     parser.add_argument(
         "-H", "--help", action="help", help="show this help message and exit"

{runem-0.0.32 → runem-0.1.1}/runem/hook_manager.py

@@ -1,6 +1,8 @@
 import typing
 from collections import defaultdict
 
+from typing_extensions import Unpack
+
 from runem.config_metadata import ConfigMetadata
 from runem.job import Job
 from runem.job_execute import job_execute
@@ -10,6 +12,7 @@ from runem.types import (
     HookConfig,
     HookName,
     Hooks,
+    HookSpecificKwargs,
     HooksStore,
     JobConfig,
 )
@@ -69,7 +72,7 @@ class HookManager:
         self,
         hook_name: HookName,
         config_metadata: ConfigMetadata,
-        **kwargs: typing.Any,
+        **kwargs: Unpack[HookSpecificKwargs],
     ) -> None:
         """Invokes all functions registered to a specific hook."""
         hooks: typing.List[HookConfig] = self.hooks_store.get(hook_name, [])
@@ -92,6 +95,7 @@ class HookManager:
             job_execute(
                 job_config,
                 running_jobs={},
+                completed_jobs={},
                 config_metadata=config_metadata,
                 file_lists=file_lists,
                 **kwargs,

{runem-0.0.32 → runem-0.1.1}/runem/job_execute.py

@@ -5,13 +5,17 @@ import uuid
 from datetime import timedelta
 from timeit import default_timer as timer
 
+from typing_extensions import Unpack
+
 from runem.config_metadata import ConfigMetadata
 from runem.informative_dict import ReadOnlyInformativeDict
 from runem.job import Job
 from runem.job_wrapper import get_job_wrapper
 from runem.log import error, log
 from runem.types import (
+    FilePathList,
     FilePathListLookup,
+    HookSpecificKwargs,
     JobConfig,
     JobFunction,
     JobReturn,
@@ -26,7 +30,7 @@ def job_execute_inner(
     job_config: JobConfig,
     config_metadata: ConfigMetadata,
     file_lists: FilePathListLookup,
-    **kwargs: typing.Any,
+    **kwargs: Unpack[HookSpecificKwargs],
 ) -> typing.Tuple[JobTiming, JobReturn]:
     """Wrapper for running a job inside a sub-process.
 
@@ -36,13 +40,12 @@ def job_execute_inner(
     if config_metadata.args.verbose:
         log(f"START: '{label}'")
     root_path: pathlib.Path = config_metadata.cfg_filepath.parent
-    function: JobFunction
     job_tags: typing.Optional[JobTags] = Job.get_job_tags(job_config)
     os.chdir(root_path)
-    function = get_job_wrapper(job_config, config_metadata.cfg_filepath)
+    function: JobFunction = get_job_wrapper(job_config, config_metadata.cfg_filepath)
 
     # get the files for all files found for this job's tags
-    file_list = Job.get_job_files(file_lists, job_tags)
+    file_list: FilePathList = Job.get_job_files(file_lists, job_tags)
 
     if not file_list:
         # no files to work on
@@ -77,8 +80,9 @@ def job_execute_inner(
         log(f"job: running: '{Job.get_job_name(job_config)}'")
     reports: JobReturn
     try:
+        assert isinstance(function, JobFunction)
         reports = function(
-            options=ReadOnlyInformativeDict(config_metadata.options),  # type: ignore
+            options=ReadOnlyInformativeDict(config_metadata.options),
             file_list=file_list,
             procs=config_metadata.args.procs,
             root_path=root_path,
@@ -107,9 +111,10 @@ def job_execute_inner(
 def job_execute(
     job_config: JobConfig,
     running_jobs: typing.Dict[str, str],
+    completed_jobs: typing.Dict[str, str],
     config_metadata: ConfigMetadata,
     file_lists: FilePathListLookup,
-    **kwargs: typing.Any,
+    **kwargs: Unpack[HookSpecificKwargs],
 ) -> typing.Tuple[JobTiming, JobReturn]:
     """Thin-wrapper around job_execute_inner needed for mocking in tests.
 
@@ -123,5 +128,6 @@ def job_execute(
         file_lists,
         **kwargs,
     )
+    completed_jobs[this_id] = running_jobs[this_id]
     del running_jobs[this_id]
     return results

{runem-0.0.32 → runem-0.1.1}/runem/job_wrapper.py

@@ -18,7 +18,7 @@ def get_job_wrapper(job_wrapper: JobWrapper, cfg_filepath: pathlib.Path) -> JobF
         # validate that the command is "understandable" and usable.
         command_string: str = job_wrapper["command"]
         validate_simple_command(command_string)
-        return job_runner_simple_command  # type: ignore # NO_COMMIT
+        return job_runner_simple_command
 
     # if we do not have a simple command address assume we have just an addressed
     # function

{runem-0.0.32 → runem-0.1.1}/runem/runem.py

@@ -28,17 +28,19 @@ import typing
 from collections import defaultdict
 from datetime import timedelta
 from itertools import repeat
-from multiprocessing.managers import DictProxy, ListProxy, ValueProxy
+from multiprocessing.managers import DictProxy, ValueProxy
 from timeit import default_timer as timer
+from types import TracebackType
 
-from halo import Halo
+from rich.console import Console, ConsoleOptions, ConsoleRenderable, RenderResult
+from rich.spinner import Spinner
+from rich.text import Text
 
 from runem.command_line import parse_args
 from runem.config import load_project_config, load_user_configs
 from runem.config_metadata import ConfigMetadata
 from runem.config_parse import load_config_metadata
 from runem.files import find_files
-from runem.job import Job
 from runem.job_execute import job_execute
 from runem.job_filter import filter_jobs
 from runem.log import error, log, warn
@@ -58,6 +60,8 @@ from runem.types import (
 )
 from runem.utils import printable_set
 
+rich_console = Console()
+
 
 def _determine_run_parameters(argv: typing.List[str]) -> ConfigMetadata:
     """Loads config, parsing cli input and produces the run config.
@@ -85,10 +89,40 @@ def _determine_run_parameters(argv: typing.List[str]) -> ConfigMetadata:
     return config_metadata
 
 
+class DummySpinner(ConsoleRenderable):  # pragma: no cover
+    """A dummy spinner for when spinners are disabled."""
+
+    def __init__(self) -> None:
+        self.text = ""
+
+    def __rich__(self) -> Text:
+        """Return a rich Text object for rendering."""
+        return Text(self.text)
+
+    def __rich_console__(
+        self, console: Console, options: ConsoleOptions
+    ) -> RenderResult:
+        """Yield an empty string or placeholder text."""
+        yield Text(self.text)
+
+    def __enter__(self) -> None:
+        """Support for context manager."""
+        pass
+
+    def __exit__(
+        self,
+        exc_type: typing.Optional[typing.Type[BaseException]],
+        exc_value: typing.Optional[BaseException],
+        traceback: typing.Optional[TracebackType],
+    ) -> None:
+        """Support for context manager."""
+        pass
+
+
 def _update_progress(
     label: str,
     running_jobs: typing.Dict[str, str],
-    seen_jobs: typing.List[str],
+    completed_jobs: typing.Dict[str, str],
     all_jobs: Jobs,
     is_running: ValueProxy[bool],
     num_workers: int,
@@ -99,57 +133,37 @@ def _update_progress(
     Args:
         label (str): The identifier.
         running_jobs (Dict[str, str]): The currently running jobs.
-        seen_jobs (List[str]): Jobs that the function has previously tracked.
         all_jobs (Jobs): All jobs, encompassing both completed and running jobs.
         is_running (ValueProxy[bool]): Flag indicating if jobs are still running.
         num_workers (int): Indicates the number of workers performing the jobs.
     """
-    # Using Halo library to show a loading spinner on console
+    # Using the `rich` module to show a loading spinner on console
+    spinner: typing.Union[Spinner, DummySpinner]
     if show_spinner:
-        spinner = Halo(text="", spinner="dots")
-        spinner.start()
-
-    # The set of all job labels, and the set of completed jobs
-    all_job_names: typing.Set[str] = {Job.get_job_name(job) for job in all_jobs}
-    completed_jobs: typing.Set[str] = set()
+        spinner = Spinner("dots", text="Starting tasks...")
+    else:
+        spinner = DummySpinner()
 
-    # This dataset is used to track changes between iterations
     last_running_jobs_set: typing.Set[str] = set()
 
-    while is_running.value:
-        running_jobs_set: typing.Set[str] = set(running_jobs.values())
-        seen_jobs = list(running_jobs_set.union(seen_jobs))  # Update the seen jobs
+    with rich_console.status(spinner):
+        while is_running.value:
+            running_jobs_set: typing.Set[str] = set(running_jobs.values())
 
-        # Jobs that have disappeared since last check
-        disappeared_jobs: typing.Set[str] = last_running_jobs_set - running_jobs_set
+            # Progress report
+            progress: str = f"{len(completed_jobs)}/{len(all_jobs)}"
+            running_jobs_list = printable_set(
+                running_jobs_set
+            )  # Reflect current running jobs accurately
+            report: str = f"{label}: {progress}({num_workers}): {running_jobs_list}"
+            if show_spinner:
+                spinner.text = report
+            else:
+                if last_running_jobs_set != running_jobs_set:
+                    rich_console.log(report)
 
-        # Jobs that have not yet completed
-        remaining_jobs: typing.Set[str] = all_job_names - completed_jobs
-
-        # Check if we're closing to completion
-        workers_retiring: bool = len(remaining_jobs) <= num_workers
-
-        if workers_retiring:
-            # Handle edge case: a task may have disappeared whilst process was sleeping
-            all_completed_jobs: typing.Set[str] = all_job_names - remaining_jobs
-            disappeared_jobs.update(all_completed_jobs - running_jobs_set)
-
-        completed_jobs.update(disappeared_jobs)
-
-        # Prepare progress report
-        progress: str = f"{len(completed_jobs)}/{len(all_jobs)}"
-        running_jobs_list = printable_set(running_jobs_set)
-        if show_spinner:
-            spinner.text = f"{label}: {progress}({num_workers}): {running_jobs_list}"
-
-        # Update the tracked dataset for the next iteration
-        last_running_jobs_set = running_jobs_set
-
-        # Sleep to decrease frequency of updates and reduce CPU usage
-        time.sleep(0.1)
-
-    if show_spinner:
-        spinner.stop()
+            # Sleep for reduced CPU usage
+            time.sleep(0.1)
 
 
 def _process_jobs(
@@ -187,8 +201,8 @@ def _process_jobs(
     subprocess_error: typing.Optional[BaseException] = None
 
     with multiprocessing.Manager() as manager:
-        seen_jobs: ListProxy[str] = manager.list()
         running_jobs: DictProxy[typing.Any, typing.Any] = manager.dict()
+        completed_jobs: DictProxy[typing.Any, typing.Any] = manager.dict()
         is_running: ValueProxy[bool] = manager.Value("b", True)
 
         terminal_writer_process = multiprocessing.Process(
@@ -196,7 +210,7 @@ def _process_jobs(
             args=(
                 phase,
                 running_jobs,
-                seen_jobs,
+                completed_jobs,
                 jobs,
                 is_running,
                 num_concurrent_procs,
@@ -209,10 +223,11 @@ def _process_jobs(
             with multiprocessing.Pool(processes=num_concurrent_procs) as pool:
                 # use starmap so we can pass down the job-configs and the args and the files
                 in_out_job_run_metadatas[phase] = pool.starmap(
-                    job_execute,
+                    job_execute,  # no kwargs passed for jobs here
                     zip(
                         jobs,
                         repeat(running_jobs),
+                        repeat(completed_jobs),
                         repeat(config_metadata),
                         repeat(file_lists),
                     ),

{runem-0.0.32 → runem-0.1.1}/runem/types.py

@@ -1,9 +1,37 @@
-import argparse
+"""
+
+Some note on Unpack and kwargs:
+    We *try* to strongly type `**kwargs` for clarity.
+    We have tried several ways to define a Generic type that encapsulates
+        `**kwargs: SingleType`
+    ... but none of the solutions worked with python 3.9 -> 3.12 and mypy 1.9.0,
+    so we have to recommend instead using:
+        `**kwargs: Unpack[KwArgsType]`
+
+    For this to work across versions of python where support for Unpack changes;
+    for example `Unpack` is a python 3.12 feature, but available in the
+    `typing_extensions` module.
+
+    So, for now, it looks like we get away with importing `Unpack` from the
+    `typing_extensions` module, even in python 3.12, so we will use, and
+    recommend using, the `typing_extensions` of `Unpack`, until it becomes
+    obsolete.
+
+    Alternatively, we can use the following, but it's unnecessarily verbose.
+
+    if sys.version_info >= (3, 12):  # pragma: no coverage
+        from typing import Unpack
+    else:  # pragma: no coverage
+        from typing_extensions import Unpack
+"""
+
 import pathlib
 import typing
 from datetime import timedelta
 from enum import Enum
 
+from typing_extensions import Unpack
+
 from runem.informative_dict import InformativeDict, ReadOnlyInformativeDict
 
 
@@ -96,12 +124,6 @@ FilePathSerialise = str
 FilePathList = typing.List[FilePathSerialise]
 FilePathListLookup = typing.DefaultDict[JobTag, FilePathList]
 
-# FIXME: this type is no-longer the actual spec of the test-functions
-JobFunction = typing.Union[
-    typing.Callable[[argparse.Namespace, OptionsWritable, FilePathList], None],
-    typing.Callable[[typing.Any], None],
-]
-
 
 class JobParamConfig(typing.TypedDict):
     """Configures what parameters are passed to the test-callable.
@@ -250,3 +272,86 @@ ConfigNodes = typing.Union[
 Config = typing.List[ConfigNodes]
 
 UserConfigMetadata = typing.List[typing.Tuple[Config, pathlib.Path]]
+
+
+class CommonKwargs(
+    typing.TypedDict,
+    total=True,  # each of these are guaranteed to exist in jobs and hooks
+):
+    """Defines the base args that are passed to all jobs.
+
+    As we call hooks and job-task in the same manner, this defines the variables that we
+    can access from both hooks and job-tasks.
+    """
+
+    root_path: pathlib.Path  # the path where the .runem.yml file is
+    job: JobConfig  # the job or hook task spec ¢ TODO: rename this
+    label: str  # the name of the hook or the job-label
+    options: Options  # options passed in on the command line
+    procs: int  # the max number of concurrent procs to run
+    verbose: bool  # control log verbosity
+
+
+class HookSpecificKwargs(typing.TypedDict, total=False):
+    """Defines the args that are passed down to the hooks.
+
+    NOTE: that although these however
+     outside of the *hook* context, the data will not be present. Such is the
+     difficulty in dynamic programming.
+    """
+
+    wall_clock_time_saved: timedelta  # only on `HookName.ON_EXIT`
+
+
+class JobTaskKwargs(
+    typing.TypedDict,
+    total=False,  # for now, we don't enforce these types for job-context, but we should.
+):
+    """Defines the task-specific args for job-task functions."""
+
+    file_list: FilePathList
+    record_sub_job_time: typing.Optional[typing.Callable[[str, timedelta], None]]
+
+
+class HookKwargs(CommonKwargs, HookSpecificKwargs):
+    """A merged set of kwargs for runem-hooks."""
+
+    pass
+
+
+class JobKwargs(CommonKwargs, JobTaskKwargs):
+    """A merged set of kwargs for job-tasks."""
+
+    pass
+
+
+class AllKwargs(CommonKwargs, JobTaskKwargs, HookSpecificKwargs):
+    """A merged set of kwargs for al job-functions."""
+
+    pass
+
+
+@typing.runtime_checkable
+class JobFunction(typing.Protocol):
+    def __call__(self, **kwargs: Unpack[AllKwargs]) -> JobReturn:  # pragma: no cover
+        """Defines the call() protocol's abstract pattern for job-tasks."""
+
+    @property
+    def __name__(self) -> str:  # pragma: no cover
+        """Defines the name protocol for job-task functions.
+
+        This is primarily used for internal tests but can be useful for introspection.
+        """
+
+
+def _hook_example(
+    wall_clock_time_saved: timedelta,
+    **kwargs: typing.Any,
+) -> None:
+    """An example hook."""
+
+
+def _job_task_example(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    """An example job-task function."""

{runem-0.0.32 → runem-0.1.1}/runem.egg-info/PKG-INFO

@@ -1,17 +1,18 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.0.32
+Version: 0.1.1
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: halo
 Requires-Dist: packaging
 Requires-Dist: PyYAML
+Requires-Dist: rich
+Requires-Dist: typing_extensions
 Provides-Extra: tests
-Requires-Dist: black==24.3.0; extra == "tests"
-Requires-Dist: coverage==7.4.4; extra == "tests"
+Requires-Dist: black==24.10.0; extra == "tests"
+Requires-Dist: coverage==7.5; extra == "tests"
 Requires-Dist: docformatter==1.7.5; extra == "tests"
 Requires-Dist: flake8-bugbear==24.2.6; extra == "tests"
 Requires-Dist: flake8==7.0.0; extra == "tests"
@@ -22,10 +23,10 @@ Requires-Dist: mypy==1.9.0; extra == "tests"
 Requires-Dist: pydocstyle==6.3.0; extra == "tests"
 Requires-Dist: pylint==3.1.0; extra == "tests"
 Requires-Dist: pylama==8.4.1; extra == "tests"
-Requires-Dist: pytest-cov==4.1.0; extra == "tests"
+Requires-Dist: pytest-cov==6.0.0; extra == "tests"
 Requires-Dist: pytest-profiling==1.7.0; extra == "tests"
-Requires-Dist: pytest-xdist==3.5.0; extra == "tests"
-Requires-Dist: pytest==8.1.1; extra == "tests"
+Requires-Dist: pytest-xdist==3.6.1; extra == "tests"
+Requires-Dist: pytest==8.3.3; extra == "tests"
 Requires-Dist: setuptools; extra == "tests"
 Requires-Dist: termplotlib==0.3.9; extra == "tests"
 Requires-Dist: tox; extra == "tests"

{runem-0.0.32 → runem-0.1.1}/runem.egg-info/requires.txt

@@ -1,10 +1,11 @@
-halo
 packaging
 PyYAML
+rich
+typing_extensions
 
 [tests]
-black==24.3.0
-coverage==7.4.4
+black==24.10.0
+coverage==7.5
 docformatter==1.7.5
 flake8-bugbear==24.2.6
 flake8==7.0.0
@@ -15,10 +16,10 @@ mypy==1.9.0
 pydocstyle==6.3.0
 pylint==3.1.0
 pylama==8.4.1
-pytest-cov==4.1.0
+pytest-cov==6.0.0
 pytest-profiling==1.7.0
-pytest-xdist==3.5.0
-pytest==8.1.1
+pytest-xdist==3.6.1
+pytest==8.3.3
 setuptools
 termplotlib==0.3.9
 tox

{runem-0.0.32 → runem-0.1.1}/tests/test_job_execute.py

@@ -45,7 +45,7 @@ def _job_execute_and_capture_stdout(
     ret_err: typing.Optional[BaseException] = None
     with io.StringIO() as buf, redirect_stdout(buf):
         try:
-            job_execute(job_config, running_jobs, config_metadata, file_lists)
+            job_execute(job_config, running_jobs, {}, config_metadata, file_lists)
         except BaseException as err:  # pylint: disable=broad-exception-caught
             # capture the error and return it
             ret_err = err

{runem-0.0.32 → runem-0.1.1}/tests/test_runem.py

@@ -669,6 +669,8 @@ def test_runem_help(
     As we build features we want to ensure that the help output stays consistent as we
     leverage the argparse system to generate the help for a specific .runem.yml config
     """
+    # Ensure we get fixed-width output.
+    os.environ["RUNEM_FIXED_HELP_WIDTH"] = "1"
     runem_cli_switches: typing.List[str] = ["--help"]
     runem_stdout: typing.List[str]
     error_raised: typing.Optional[BaseException]
@@ -1673,11 +1675,12 @@ def test_progress_updater_with_running_jobs(
     show_spinner: bool,
 ) -> None:
     running_jobs: typing.Dict[str, str] = {"job1": "running", "job2": "pending"}
+    completed_jobs: typing.Dict[str, str] = {}
     with pytest.raises(SleepCalledError), multiprocessing.Manager() as manager:
         _update_progress(
             "dummy label",
             running_jobs,
-            seen_jobs=[],
+            completed_jobs,
             all_jobs=[],
             is_running=manager.Value("b", True),
             num_workers=1,
@@ -1688,6 +1691,7 @@ def test_progress_updater_with_running_jobs(
 
 def test_progress_updater_with_running_jobs_and_10_jobs(mock_sleep: Mock) -> None:
     running_jobs: typing.Dict[str, str] = {"job1": "running", "job2": "pending"}
+    completed_jobs: typing.Dict[str, str] = {}
     job_config: JobConfig = {
         "addr": {
             "file": __file__,
@@ -1713,7 +1717,7 @@ def test_progress_updater_with_running_jobs_and_10_jobs(mock_sleep: Mock) -> Non
         _update_progress(
             "dummy label",
             running_jobs,
-            seen_jobs=[],
+            completed_jobs,
             all_jobs=all_jobs,
             is_running=manager.Value("b", True),
             num_workers=1,
@@ -1724,11 +1728,12 @@ def test_progress_updater_with_running_jobs_and_10_jobs(mock_sleep: Mock) -> Non
 
 def test_progress_updater_without_running_jobs(mock_sleep: Mock) -> None:
     running_jobs: typing.Dict[str, str] = {}
+    completed_jobs: typing.Dict[str, str] = {}
     with pytest.raises(SleepCalledError), multiprocessing.Manager() as manager:
         _update_progress(
             "dummy label",
             running_jobs,
-            seen_jobs=[],
+            completed_jobs,
             all_jobs=[],
             is_running=manager.Value("b", True),
             num_workers=1,
@@ -1739,11 +1744,12 @@ def test_progress_updater_without_running_jobs(mock_sleep: Mock) -> None:
 
 def test_progress_updater_with_empty_running_jobs(mock_sleep: Mock) -> None:
     running_jobs: typing.Dict[str, str] = {"job1": ""}
+    completed_jobs: typing.Dict[str, str] = {}
     with pytest.raises(SleepCalledError), multiprocessing.Manager() as manager:
         _update_progress(
             "dummy label",
             running_jobs,
-            seen_jobs=[],
+            completed_jobs,
             all_jobs=[],
             is_running=manager.Value("b", True),
             num_workers=1,
@@ -1767,7 +1773,7 @@ def test_progress_updater_with_false(show_spinner: bool) -> None:
         _update_progress(
             "dummy label",
             running_jobs,
-            [],
+            {},
             [],
             manager.Value("b", False),
             1,

runem-0.0.32/requirements.txt

@@ -1,3 +0,0 @@
-halo
-packaging
-PyYAML

runem-0.0.32/runem/VERSION

@@ -1 +0,0 @@
-0.0.32