runem 0.3.0__tar.gz → 0.4.0__tar.gz

{runem-0.3.0 → runem-0.4.0}/HISTORY.md

@@ -4,6 +4,27 @@ Changelog
 
 (unreleased)
 ------------
+- Merge pull request #67 from lursight/feat/prettier_logging. [Frank
+  Harrison]
+
+  feat(rich): prettier logging with rich
+- Feat(rich): disable markup handling. [Frank Harrison]
+
+  We got errors running logging through rich in CiCd where
+  [/path/to/thing] was being seen as rich markup, specifically as a rich
+  markup close-tag.
+
+  This stops parsing strings as markup and therefore works around the
+  error.
+- Feat(rich): prettier logging with rich. [Frank Harrison]
+
+  It also makes the logging more useful in different contexts by removing
+  tabs and so on.
+
+
+0.3.0 (2024-12-03)
+------------------
+- Release: version 0.3.0 🚀 [Frank Harrison]
 - Merge pull request #66 from
   lursight/feat/option_switches_in_simple_commands. [Frank Harrison]
 

{runem-0.3.0 → runem-0.4.0}/PKG-INFO

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

runem-0.4.0/runem/VERSION

@@ -0,0 +1 @@
+0.4.0

runem-0.4.0/runem/blocking_print.py

@@ -0,0 +1,62 @@
+import time
+import typing
+
+from rich.console import Console
+
+
+def _reset_console() -> Console:
+    """Sets the nice user-facing console.
+
+    This function exists so we can reset the output from tests.
+    """
+    global RICH_CONSOLE  # pylint: disable=global-statement
+
+    RICH_CONSOLE = Console(
+        log_path=False,  # Do NOT print the source path.
+        markup=False,  # Do NOT print markup e.g. `[blink]Don't Panic![/blink]`.
+    )
+    return RICH_CONSOLE
+
+
+# Overridden in tests.
+RICH_CONSOLE: Console = _reset_console()
+
+
+def _reset_console_for_tests() -> None:
+    """Overrides the console output with more deterministic version.
+
+    ... so we can have deterministic tests.
+    """
+    global RICH_CONSOLE  # pylint: disable=global-statement
+    RICH_CONSOLE = Console(
+        log_path=False,  # Do NOT print the source path.
+        log_time=False,  # Do not prefix with log time e.g. `[time] log message`.
+        markup=False,  # Do NOT print markup e.g. `[blink]Don't Panic![/blink]`.
+        width=999,  # A very wide width.
+    )
+
+
+def blocking_print(
+    msg: str = "",
+    end: typing.Optional[str] = None,
+    max_retries: int = 5,
+    sleep_time_s: float = 0.1,
+) -> None:
+    """Attempt to print a message, retrying on BlockingIOError.
+
+    Sometimes in long-lasting jobs, that produce lots of output, we hit
+    BlockingIOError where we can't print to screen because the buffer is full or
+    already being written to (for example), i.e. the `print` would need to be a
+    'blocking' call, which it is not.
+    """
+    if end is None:
+        end = "\n"
+    for _ in range(max_retries):
+        try:
+            RICH_CONSOLE.print(msg, end=end)
+            break  # Success, exit the retry loop
+        except BlockingIOError:
+            time.sleep(sleep_time_s)  # Wait a bit for the buffer to clear
+    else:
+        # Optional: handle the failure to print after all retries
+        pass

{runem-0.3.0 → runem-0.4.0}/runem/runem.py

@@ -36,6 +36,7 @@ from rich.console import Console, ConsoleOptions, ConsoleRenderable, RenderResul
 from rich.spinner import Spinner
 from rich.text import Text
 
+from runem.blocking_print import RICH_CONSOLE
 from runem.command_line import parse_args
 from runem.config import load_project_config, load_user_configs
 from runem.config_metadata import ConfigMetadata
@@ -57,8 +58,6 @@ from runem.types.types_jobs 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.
@@ -143,7 +142,7 @@ def _update_progress(
 
     last_running_jobs_set: typing.Set[str] = set()
 
-    with rich_console.status(spinner):
+    with RICH_CONSOLE.status(spinner):
         while is_running.value:
             running_jobs_set: typing.Set[str] = set(running_jobs.values())
 
@@ -157,7 +156,7 @@ def _update_progress(
                 spinner.text = report
             else:
                 if last_running_jobs_set != running_jobs_set:
-                    rich_console.log(report)
+                    RICH_CONSOLE.log(report)
 
             # Sleep for reduced CPU usage
             time.sleep(0.1)

{runem-0.3.0 → runem-0.4.0}/runem.egg-info/PKG-INFO

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

{runem-0.3.0 → runem-0.4.0}/tests/conftest.py

@@ -5,9 +5,23 @@ import typing
 
 import pytest
 
+from runem.blocking_print import _reset_console, _reset_console_for_tests
+
 FixtureRequest = typing.Any
 
 
+@pytest.fixture(autouse=True)
+def use_test_rich_print(request: FixtureRequest) -> typing.Generator[None, None, None]:
+    """Each test should use the test-version of the `rich` print function.
+
+    This is so we get deterministic output with out timestamps nor auto-wrapping console
+    output.
+    """
+    _reset_console_for_tests()
+    yield
+    _reset_console()
+
+
 # each test runs on cwd to its temp dir
 @pytest.fixture(autouse=True)
 def go_to_tmp_path(request: FixtureRequest) -> typing.Generator[None, None, None]:

{runem-0.3.0 → runem-0.4.0}/tests/test_blocking_print.py

@@ -8,7 +8,7 @@ from runem import blocking_print
 
 @pytest.fixture(name="mock_print")
 def mock_print_fixture() -> typing.Generator[MagicMock, None, None]:
-    with patch("runem.blocking_print.print") as mock_print:
+    with patch("runem.blocking_print.RICH_CONSOLE.print") as mock_print:
         yield mock_print
 
 
@@ -23,7 +23,7 @@ def test_blocking_print_success_first_try(
 ) -> None:
     """Test that blocking_print prints the message successfully on the first try."""
     blocking_print.blocking_print("Test message")
-    mock_print.assert_called_once_with("Test message", end=None)
+    mock_print.assert_called_once_with("Test message", end="\n")
     mock_sleep.assert_not_called()
 
 
@@ -57,7 +57,7 @@ def test_blocking_print_empty_message(
 ) -> None:
     """Test that blocking_print handles an empty message."""
     blocking_print.blocking_print()
-    mock_print.assert_called_once_with("", end=None)
+    mock_print.assert_called_once_with("", end="\n")
     mock_sleep.assert_not_called()
 
 

{runem-0.3.0 → runem-0.4.0}/tests/test_hook_manager.py

@@ -149,7 +149,7 @@ def test_invoke_hooks(do_hooks: bool, hook_man: HookManager) -> None:
     if do_hooks:
         expected_stdout = [
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: "
                 "<THIS_FILE>._dummy_hook"

{runem-0.3.0 → runem-0.4.0}/tests/test_run_command.py

@@ -300,7 +300,7 @@ def test_run_command_basic_call_non_standard_exit_ok_code_verbose(
     # check the log output hasn't changed. Update as needed.
     assert run_command_stdout == (
         "runem: running: start: test command: ls\n"
-        "runem: 	allowed return ids are: 3\n"
+        "runem:  allowed return ids are: 3\n"
         "runem: test command: test output\n"
         "runem: running: done: test command: ls\n"
     )

{runem-0.3.0 → runem-0.4.0}/tests/test_runem.py

@@ -110,16 +110,17 @@ def test_runem_basic_with_config(
         runem_stdout: typing.List[str] = sanitise_reports_footer(buf.getvalue())
         assert [] == _strip_reports_footer(runem_stdout)
 
-        assert [
-            "runem: reports:",
-            "runem (total wall-clock)  [<float>]",
-            "├runem.pre-build          [<float>]",
-            "└runem.run-phases         [<float>]",
-            " └mock phase (user-time)  [<float>]",
-            "runem: DONE: runem took: <float>, saving you <float>, without runem you "
-            "would have waited <float>",
-            "",
-        ] == runem_stdout
+    pprint(runem_stdout)
+    assert runem_stdout == [
+        "runem: reports:",
+        "runem (total wall-clock)  [<float>]",
+        "├runem.pre-build          [<float>]",
+        "└runem.run-phases         [<float>]",
+        " └mock phase (user-time)  [<float>]",
+        "runem: DONE: runem took: <float>, saving you <float>, without runem you "
+        "would have waited <float>",
+        "",
+    ]
     load_config_metadata_mock.assert_called_once()
 
 
@@ -156,7 +157,7 @@ def test_runem_basic_with_config_no_options(
         # with pytest.raises(SystemExit):
         timed_main(["--help"])
         runem_stdout = buf.getvalue()
-        assert [
+        assert sanitise_reports_footer(runem_stdout) == [
             "runem: reports:",
             "runem (total wall-clock)  [<float>]",
             "├runem.pre-build          [<float>]",
@@ -165,7 +166,7 @@ def test_runem_basic_with_config_no_options(
             "runem: DONE: runem took: <float>, saving you <float>, without runem you "
             "would have waited <float>",
             "",
-        ] == sanitise_reports_footer(runem_stdout)
+        ]
 
 
 MOCK_JOB_EXECUTE_INNER_RET: typing.Tuple[JobTiming, JobReturn] = (
@@ -407,17 +408,17 @@ def test_runem_with_full_config(verbosity: bool) -> None:
             ),
         ]
     else:
-        assert [
+        assert runem_stdout == [
             (
                 "runem: WARNING: no phase found for 'echo \"hello world!\"', using "
                 "'dummy phase 1'"
             ),
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -433,9 +434,9 @@ def test_runem_with_full_config(verbosity: bool) -> None:
                 "'tag only on job 1', 'tag only on job 2'"
             ),
             "runem: will run 2 jobs for phase 'dummy phase 1'",
-            "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+            "runem:  'dummy job label 1', 'echo \"hello world!\"'",
             "runem: will run 2 jobs for phase 'dummy phase 2'",
-            "runem: \t'dummy job label 2', 'hello world'",
+            "runem:  'dummy job label 2', 'hello world'",
             "runem: Running Phase dummy phase 1",
             (
                 "runem: Running 'dummy phase 1' with 2 workers (of [NUM CORES] max) "
@@ -446,7 +447,7 @@ def test_runem_with_full_config(verbosity: bool) -> None:
                 "runem: Running 'dummy phase 2' with 2 workers (of [NUM CORES] max) "
                 "processing 2 jobs"
             ),
-        ] == runem_stdout
+        ]
 
 
 def test_runem_with_full_config_verbose() -> None:
@@ -463,17 +464,17 @@ def test_runem_with_full_config_verbose() -> None:
     if error_raised is not None:  # pragma: no cover
         raise error_raised  # re-raise the error that shouldn't have been raised
 
-    assert [
+    assert runem_stdout == [
         (
             "runem: WARNING: no phase found for 'echo \"hello world!\"', using "
             "'dummy phase 1'"
         ),
         "runem: hooks: loading user hooks from 'local-user-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: initialising 2 hooks",
-        "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
         (
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'"
@@ -489,14 +490,14 @@ def test_runem_with_full_config_verbose() -> None:
             "'tag only on job 1', 'tag only on job 2'"
         ),
         "runem: will run 2 jobs for phase 'dummy phase 1'",
-        "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+        "runem:  'dummy job label 1', 'echo \"hello world!\"'",
         "runem: will run 2 jobs for phase 'dummy phase 2'",
-        "runem: \t'dummy job label 2', 'hello world'",
+        "runem:  'dummy job label 2', 'hello world'",
         "runem: Running Phase dummy phase 1",
         "runem: Running 'dummy phase 1' with 2 workers (of [NUM CORES] max) processing 2 jobs",
         "runem: Running Phase dummy phase 2",
         "runem: Running 'dummy phase 2' with 2 workers (of [NUM CORES] max) processing 2 jobs",
-    ] == runem_stdout
+    ]
 
 
 def test_runem_with_single_phase() -> None:
@@ -513,17 +514,17 @@ def test_runem_with_single_phase() -> None:
     if error_raised is not None:  # pragma: no cover
         raise error_raised  # re-raise the error that shouldn't have been raised
 
-    assert [
+    assert runem_stdout == [
         (
             "runem: WARNING: no phase found for 'echo \"hello world!\"', using "
             "'dummy phase 1'"
         ),
         "runem: hooks: loading user hooks from 'local-user-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: initialising 2 hooks",
-        "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
         (
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'"
@@ -539,14 +540,14 @@ def test_runem_with_single_phase() -> None:
             "'tag only on job 1', 'tag only on job 2'"
         ),
         "runem: will run 2 jobs for phase 'dummy phase 1'",
-        "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+        "runem:  'dummy job label 1', 'echo \"hello world!\"'",
         "runem: skipping phase 'dummy phase 2'",
         "runem: Running Phase dummy phase 1",
         (
             "runem: Running 'dummy phase 1' with 2 workers (of [NUM CORES] max) "
             "processing 2 jobs"
         ),
-    ] == runem_stdout
+    ]
 
 
 def test_runem_with_single_phase_verbose() -> None:
@@ -570,11 +571,11 @@ def test_runem_with_single_phase_verbose() -> None:
             "'dummy phase 1'"
         ),
         "runem: hooks: loading user hooks from 'local-user-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: initialising 2 hooks",
-        "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
         (
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'"
@@ -590,7 +591,7 @@ def test_runem_with_single_phase_verbose() -> None:
             "'tag only on job 1', 'tag only on job 2'"
         ),
         "runem: will run 2 jobs for phase 'dummy phase 1'",
-        "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+        "runem:  'dummy job label 1', 'echo \"hello world!\"'",
         "runem: skipping phase 'dummy phase 2'",
         "runem: Running Phase dummy phase 1",
         (
@@ -758,11 +759,11 @@ def test_runem_version(switch_to_test: str, verbosity: bool) -> None:
     if verbosity:
         expected_version_output = [
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'",
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 2: echo 'mock "
@@ -828,11 +829,11 @@ def test_runem_bad_validate_switch_jobs(switch_to_test: str) -> None:
             "'dummy phase 1'"
         ),
         "runem: hooks: loading user hooks from 'local-user-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: initialising 2 hooks",
-        "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
         (
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'"
@@ -879,11 +880,11 @@ def test_runem_bad_validate_switch_tags(switch_to_test: str) -> None:
             "'dummy phase 1'"
         ),
         "runem: hooks: loading user hooks from 'local-user-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: initialising 2 hooks",
-        "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
         (
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'"
@@ -925,11 +926,11 @@ def test_runem_bad_validate_tag_exclude() -> None:
             "'dummy phase 1'"
         ),
         "runem: hooks: loading user hooks from 'local-user-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: initialising 2 hooks",
-        "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
         (
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'"
@@ -945,13 +946,13 @@ def test_runem_bad_validate_tag_exclude() -> None:
             "only on job 2'"
         ),
         "runem: will run 2 jobs for phase 'dummy phase 1'",
-        "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+        "runem:  'dummy job label 1', 'echo \"hello world!\"'",
         (
             "runem: not running job 'dummy job label 2' because it contains the "
             "following tags: 'tag only on job 2'"
         ),
         "runem: will run 1 jobs for phase 'dummy phase 2'",
-        "runem: \t'hello world'",
+        "runem:  'hello world'",
         "runem: Running Phase dummy phase 1",
         (
             "runem: Running 'dummy phase 1' with 2 workers (of [NUM CORES] max) "
@@ -994,11 +995,11 @@ def test_runem_bad_validate_switch_phases(switch_to_test: str) -> None:
             "'dummy phase 1'"
         ),
         "runem: hooks: loading user hooks from 'local-user-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-        "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
         "runem: hooks: initialising 2 hooks",
-        "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+        "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
         (
             "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
             "user local hook'"
@@ -1046,11 +1047,11 @@ def test_runem_job_filters_work(verbosity: bool) -> None:
                 "'dummy phase 1'"
             ),
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -1070,7 +1071,7 @@ def test_runem_job_filters_work(verbosity: bool) -> None:
                 "in the list of job names. See --jobs and --not-jobs"
             ),
             "runem: will run 1 jobs for phase 'dummy phase 1'",
-            "runem: \t'dummy job label 1'",
+            "runem:  'dummy job label 1'",
             (
                 "runem: not running job 'dummy job label 2' because it isn't in the list "
                 "of job names. See --jobs and --not-jobs"
@@ -1097,11 +1098,11 @@ def test_runem_job_filters_work(verbosity: bool) -> None:
                 "'dummy phase 1'"
             ),
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -1121,7 +1122,7 @@ def test_runem_job_filters_work(verbosity: bool) -> None:
                 "the list of job names. See --jobs and --not-jobs"
             ),
             "runem: will run 1 jobs for phase 'dummy phase 1'",
-            "runem: \t'dummy job label 1'",
+            "runem:  'dummy job label 1'",
             (
                 "runem: not running job 'dummy job label 2' because it isn't in the list of "
                 "job names. See --jobs and --not-jobs"
@@ -1176,11 +1177,11 @@ def test_runem_tag_filters_work(verbosity: bool) -> None:
                 "'dummy phase 1'"
             ),
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -1193,7 +1194,7 @@ def test_runem_tag_filters_work(verbosity: bool) -> None:
             "runem: found 1 batches, 1 'mock phase' files, ",
             "runem: filtering for tags 'tag only on job 1'",
             "runem: will run 2 jobs for phase 'dummy phase 1'",
-            "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+            "runem:  'dummy job label 1', 'echo \"hello world!\"'",
             (
                 "runem: not running job 'dummy job label 2' because it doesn't have "
                 "any of the following tags: 'tag only on job 1'"
@@ -1216,11 +1217,11 @@ def test_runem_tag_filters_work(verbosity: bool) -> None:
                 "'dummy phase 1'"
             ),
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -1233,7 +1234,7 @@ def test_runem_tag_filters_work(verbosity: bool) -> None:
             "runem: found 1 batches, 1 'mock phase' files, ",
             "runem: filtering for tags 'tag only on job 1'",
             "runem: will run 2 jobs for phase 'dummy phase 1'",
-            "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+            "runem:  'dummy job label 1', 'echo \"hello world!\"'",
             (
                 "runem: not running job 'dummy job label 2' because it doesn't have "
                 "any of the following tags: 'tag only on job 1'"
@@ -1295,11 +1296,11 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
                     "'dummy phase 1'"
                 ),
                 "runem: hooks: loading user hooks from 'local-user-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: initialising 2 hooks",
-                "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
                 (
                     "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                     "user local hook'"
@@ -1319,9 +1320,9 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
                     "the following tags: 'tag only on job 1'"
                 ),
                 "runem: will run 1 jobs for phase 'dummy phase 1'",
-                "runem: \t'echo \"hello world!\"'",
+                "runem:  'echo \"hello world!\"'",
                 "runem: will run 2 jobs for phase 'dummy phase 2'",
-                "runem: \t'dummy job label 2', 'hello world'",
+                "runem:  'dummy job label 2', 'hello world'",
                 "runem: Running Phase dummy phase 1",
                 (
                     "runem: Running 'dummy phase 1' with 1 workers (of [NUM CORES] max) "
@@ -1341,11 +1342,11 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
                     "'dummy phase 1'"
                 ),
                 "runem: hooks: loading user hooks from 'local-user-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: initialising 2 hooks",
-                "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
                 (
                     "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                     "user local hook'"
@@ -1365,9 +1366,9 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
                     "the following tags: 'tag only on job 1'"
                 ),
                 "runem: will run 1 jobs for phase 'dummy phase 1'",
-                "runem: \t'echo \"hello world!\"'",
+                "runem:  'echo \"hello world!\"'",
                 "runem: will run 2 jobs for phase 'dummy phase 2'",
-                "runem: \t'dummy job label 2', 'hello world'",
+                "runem:  'dummy job label 2', 'hello world'",
                 "runem: Running Phase dummy phase 1",
                 (
                     "runem: Running 'dummy phase 1' with 1 workers (of [NUM CORES] max) "
@@ -1384,11 +1385,11 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
             # no-one-liner + verbosity
             assert runem_stdout == [
                 "runem: hooks: loading user hooks from 'local-user-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: initialising 2 hooks",
-                "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
                 (
                     "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                     "user local hook'"
@@ -1412,7 +1413,7 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
                     "'dummy tag 2', 'tag only on job 2'"
                 ),
                 "runem: will run 2 jobs for phase 'dummy phase 2'",
-                "runem: \t'dummy job label 2', 'hello world'",
+                "runem:  'dummy job label 2', 'hello world'",
                 "runem: Running Phase dummy phase 2",
                 (
                     "runem: Running 'dummy phase 2' with 2 workers (of [NUM CORES] max) "
@@ -1423,11 +1424,11 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
             # no-one-liner + no-verbosity
             assert runem_stdout == [
                 "runem: hooks: loading user hooks from 'local-user-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-                "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
                 "runem: hooks: initialising 2 hooks",
-                "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+                "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
                 (
                     "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                     "user local hook'"
@@ -1451,7 +1452,7 @@ def test_runem_tag_out_filters_work(verbosity: bool, one_liner: bool) -> None:
                     "'dummy tag 2', 'tag only on job 2'"
                 ),
                 "runem: will run 2 jobs for phase 'dummy phase 2'",
-                "runem: \t'dummy job label 2', 'hello world'",
+                "runem:  'dummy job label 2', 'hello world'",
                 "runem: Running Phase dummy phase 2",
                 (
                     "runem: Running 'dummy phase 2' with 2 workers (of [NUM CORES] max) "
@@ -1497,11 +1498,11 @@ def test_runem_tag_out_filters_work_all_tags(verbosity: bool) -> None:
     if verbosity:
         assert runem_stdout == [
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -1576,11 +1577,11 @@ def test_runem_phase_filters_work(verbosity: bool) -> None:
                 "'dummy phase 1'"
             ),
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -1596,7 +1597,7 @@ def test_runem_phase_filters_work(verbosity: bool) -> None:
                 "'tag only on job 2'"
             ),
             "runem: will run 2 jobs for phase 'dummy phase 1'",
-            "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+            "runem:  'dummy job label 1', 'echo \"hello world!\"'",
             "runem: skipping phase 'dummy phase 2'",
             "runem: Running Phase dummy phase 1",
             (
@@ -1611,11 +1612,11 @@ def test_runem_phase_filters_work(verbosity: bool) -> None:
                 "'dummy phase 1'"
             ),
             "runem: hooks: loading user hooks from 'local-user-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: loading user hooks from 'local-user-home-dir-config.yml'",
-            "runem: hooks:\tadded 1 user hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   added 1 user hooks for 'HookName.ON_EXIT'",
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: echo 'mock "
                 "user local hook'"
@@ -1631,7 +1632,7 @@ def test_runem_phase_filters_work(verbosity: bool) -> None:
                 "'tag only on job 1', 'tag only on job 2'"
             ),
             "runem: will run 2 jobs for phase 'dummy phase 1'",
-            "runem: \t'dummy job label 1', 'echo \"hello world!\"'",
+            "runem:  'dummy job label 1', 'echo \"hello world!\"'",
             "runem: skipping phase 'dummy phase 2'",
             "runem: Running Phase dummy phase 1",
             (

runem-0.3.0/runem/VERSION

@@ -1 +0,0 @@
-0.3.0

runem-0.3.0/runem/blocking_print.py

@@ -1,26 +0,0 @@
-import time
-import typing
-
-
-def blocking_print(
-    msg: str = "",
-    end: typing.Optional[str] = None,
-    max_retries: int = 5,
-    sleep_time_s: float = 0.1,
-) -> None:
-    """Attempt to print a message, retrying on BlockingIOError.
-
-    Sometimes in long-lasting jobs, that produce lots of output, we hit
-    BlockingIOError where we can't print to screen because the buffer is full or
-    already being written to (for example), i.e. the `print` would need to be a
-    'blocking' call, which it is not.
-    """
-    for _ in range(max_retries):
-        try:
-            print(msg, end=end)
-            break  # Success, exit the retry loop
-        except BlockingIOError:
-            time.sleep(sleep_time_s)  # Wait a bit for the buffer to clear
-    else:
-        # Optional: handle the failure to print after all retries
-        pass