runem 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

runem/VERSION

@@ -1 +1 @@
-0.2.0
+0.4.0

runem/blocking_print.py

@@ -1,6 +1,40 @@
 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 = "",
@@ -15,9 +49,11 @@ def blocking_print(
     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:
-            print(msg, end=end)
+            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

runem/job.py

@@ -11,6 +11,12 @@ class NoJobName(ValueError):
     pass
 
 
+class BadWhenConfigLocation(ValueError):
+    """The job-config does not contain a label and can't be coerced to crate one."""
+
+    pass
+
+
 class Job:
     """A class with utility functions for jobs.
 
@@ -27,6 +33,16 @@ class Job:
 
         TODO: make a non-static member function
         """
+        if "tags" in job:
+            raise BadWhenConfigLocation(
+                "'tags' should be listed inside the 'when' config for jobs"
+            )
+
+        if "phase" in job:
+            raise BadWhenConfigLocation(
+                "'phase' should be listed inside the 'when' config for jobs"
+            )
+
         if "when" not in job or "tags" not in job["when"]:
             # handle the special case where we have No tags
             return None

runem/job_runner_simple_command.py

@@ -3,8 +3,10 @@ import typing
 
 from typing_extensions import Unpack
 
+from runem.config_metadata import ConfigMetadata
 from runem.run_command import run_command
 from runem.types.common import FilePathList
+from runem.types.options import OptionsWritable
 from runem.types.runem_config import JobConfig
 from runem.types.types_jobs import AllKwargs
 
@@ -36,8 +38,24 @@ def job_runner_simple_command(
             "{file_list}", " ".join(file_list_with_quotes)
         )
 
+    config_metadata: ConfigMetadata = kwargs["config_metadata"]
+    options: OptionsWritable = config_metadata.options
+    command_string_options: str = command_string_files
+    for name, value in options.items():
+        # For now, just pass `--option-name`, `--check` or similar to the
+        # command line. At some point we will want this to be cleverer, but
+        # this will do for now.
+        option_search = f"{{{name}}}"
+        if option_search in command_string_files:
+            replacement = ""
+            if value:
+                replacement = f"--{name}"
+            command_string_options = command_string_options.replace(
+                option_search, replacement
+            )
+
     # use shlex to handle parsing of the command string, a non-trivial problem.
-    cmd = validate_simple_command(command_string_files)
+    cmd = validate_simple_command(command_string_options)
 
     # preserve quotes for consistent handling of strings and avoid the "word
     # splitting" problem for unix-like shells.

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.2.0.dist-info → runem-0.4.0.dist-info}/METADATA

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

{runem-0.2.0.dist-info → runem-0.4.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
-runem/VERSION,sha256=H5MN0fEzwfl6lP46y42zQ3LPTAH_2ys_9Mpy-UlBIek,6
+runem/VERSION,sha256=QLjrQACpE6d5EJBTXykdPTaYdBYqie88nj1OiHobnnk,6
 runem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runem/__main__.py,sha256=dsOiVZegpfK9JOs5n7UmbX5iwwbj7iFkEbLoVeEgAn4,136
 runem/base.py,sha256=EZfR7FIlwEdU9Vfe47Wk2DOO8GQqpKxxLNKp6YHueZ4,316
-runem/blocking_print.py,sha256=S9dtgAeuTzc2-ht-vk9Wl6l-0PwS2tYbHDHDQQitrlA,841
+runem/blocking_print.py,sha256=R3c3HSnRMPCf7ykDXdKG2hKH4CzbBaxmOfP3xEU_wEI,1919
 runem/cli.py,sha256=wEt_Jnumhl8SiOdKdSJzLkJpWv6n3_Odhi_HeIixr1k,134
 runem/command_line.py,sha256=HsZjxJsVQZLfAeSRI6cpx6P1foeuqCYhHmeQ8Xg9RHY,13774
 runem/config.py,sha256=UiEU0Jyg5qjrNStvasWYjMOABQHhpZjbPiX3-sH_CMg,5969
@@ -11,17 +11,17 @@ runem/config_parse.py,sha256=sXPMA8HSUcaJoq0dUfphK181waZqnIrq20mpYOQ_XCo,13498
 runem/files.py,sha256=59boeFvUANYOS-PllIjeKIht6lNINZ43WxahDg90oAc,4392
 runem/hook_manager.py,sha256=H0TL3HCqU2mgKm_-dgCD7TsK5T1bLT4g7x6kpytMPhU,4350
 runem/informative_dict.py,sha256=U7p9z78UwOT4TAfng1iDXCEyeYz6C-XZlx9Z1pWNVrI,1548
-runem/job.py,sha256=LmNXDHxDxAwyJxAAdPHIv_0bwZy2btyTPHPGO_N7euI,2986
+runem/job.py,sha256=NOdRQnGePPyYdmIR_6JKVFzp9nbgNGetpE13bHEHaf4,3442
 runem/job_execute.py,sha256=BPkeTpeTGJs3QWa0-07DZvF1f0uKO79e4yMsTxq1UHk,4656
 runem/job_filter.py,sha256=7vgG4YWJ9gyGBFjV7QbSojG5ofYoszAmxXx9HnMLkHo,5384
-runem/job_runner_simple_command.py,sha256=RcM6tfw3i_idgv77MSVmoxGXIF2VfngGOYHOKiuJvX4,1625
+runem/job_runner_simple_command.py,sha256=iP5an6yixW8o4C0ZBtu6csb-oVK3Q62ZZgtHBmxlXaU,2428
 runem/job_wrapper.py,sha256=q5GtopZ5vhSJ581rwU4-lF9KnbL3ZYgOC8fqaCnXD_g,983
 runem/job_wrapper_python.py,sha256=rx7J_N-JXs8GgMq7Sla7B9s_ZAfofKUhEnzgMcq_bts,4303
 runem/log.py,sha256=dIrocigvIJs1ZGkAzTogXkAK-0ZW3q5FkjpDgLdeW-E,630
 runem/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 runem/report.py,sha256=IedwW9mmJfGC6vKQdKDHQH5eoiYzTWHaaD4a3J4e_Pc,9020
 runem/run_command.py,sha256=Egl_j4bJ9mwi2JEFCsl0W6WH2IRgIdpMN7qdj8voClQ,6386
-runem/runem.py,sha256=QbJU48zx1hyiRIG5Kf4DAa4Kka2dOKYgqlZ1T6fN62k,13316
+runem/runem.py,sha256=tQg-4e--GmIBJrX3gP8dAUGQTCP6QOPiSSGwKxVmBac,13336
 runem/runem_version.py,sha256=MbETwZO2Tb1Y3hX_OYZjKepEMKA1cjNvr-7Cqhz6e3s,271
 runem/utils.py,sha256=3N_kel9LsriiMq7kOjT14XhfxUOgz4hdDg97wlLKm3U,221
 runem/types/__init__.py,sha256=6TzF4KV9tDGuDTr2qAXmWWkfDU52WuVlQ8Hcz48aYDk,286
@@ -34,9 +34,9 @@ runem/types/runem_config.py,sha256=qG_bghm5Nr-ZTbaZbf1v8Fx447V-hgEvvRy5NZ3t-Io,5
 runem/types/types_jobs.py,sha256=wqiiBmRIJDbGlKcfOqewHGKx350w0p4_7pysMm7xGmo,4906
 tests/test_types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_types/test_public_api.py,sha256=QHiwt7CetQur65JSbFRnOzQxhCJkX5MVLymHHVd_6yc,160
-runem-0.2.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
-runem-0.2.0.dist-info/METADATA,sha256=g7u9feZjpdo9L3U8hWqYIhSx3_6K1514AL_Nxyk_gkk,5842
-runem-0.2.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-runem-0.2.0.dist-info/entry_points.txt,sha256=nu0g_vBeuPihYtimbtlNusxWovylMppvJ8UxdJlJfvM,46
-runem-0.2.0.dist-info/top_level.txt,sha256=Zu65aVeDPh8WbChU4Mi7-Md4S3XJDPuqdQjEE3DSQno,12
-runem-0.2.0.dist-info/RECORD,,
+runem-0.4.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+runem-0.4.0.dist-info/METADATA,sha256=EaVqmVWBeMkJI4tLfI7Nt0A5L3i_OkGCtD_Y8zTJ9kY,5842
+runem-0.4.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+runem-0.4.0.dist-info/entry_points.txt,sha256=nu0g_vBeuPihYtimbtlNusxWovylMppvJ8UxdJlJfvM,46
+runem-0.4.0.dist-info/top_level.txt,sha256=Zu65aVeDPh8WbChU4Mi7-Md4S3XJDPuqdQjEE3DSQno,12
+runem-0.4.0.dist-info/RECORD,,