runem 0.1.2__tar.gz → 0.3.0__tar.gz

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

@@ -4,6 +4,56 @@ Changelog
 
 (unreleased)
 ------------
+- Merge pull request #66 from
+  lursight/feat/option_switches_in_simple_commands. [Frank Harrison]
+
+  Feat/option switches in simple commands
+- Chore(pytest): force colour output in pytest, makes it easier to read.
+  [Frank Harrison]
+- Feat(option-switches): adds ability to turn on/off switches in simple
+  commands. [Frank Harrison]
+
+  THis is pretty noddy for now, but it means we can do more things like
+  run `black` or `ruff` with `--check` enabled... as well as some other
+  switches.
+- Merge pull request #65 from lursight/feat/error_on_misplaced_config.
+  [Frank Harrison]
+
+  feat(where-errors): errors when 'tags' and 'phase' are not under 'where'
+- Feat(where-errors): errors when 'tags' and 'phase' are not under
+  'where' [Frank Harrison]
+
+
+0.2.0 (2024-11-21)
+------------------
+- Release: version 0.2.0 🚀 [Frank Harrison]
+- Merge pull request #63 from
+  lursight/dependabot/github_actions/actions/cache-4. [Frank Harrison]
+
+  chore(deps): bump actions/cache from 3 to 4
+- Chore(deps): bump actions/cache from 3 to 4. [dependabot[bot]]
+
+  Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4.
+  - [Release notes](https://github.com/actions/cache/releases)
+  - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md)
+  - [Commits](https://github.com/actions/cache/compare/v3...v4)
+
+  ---
+  updated-dependencies:
+  - dependency-name: actions/cache
+    dependency-type: direct:production
+    update-type: version-update:semver-major
+  ...
+- Feat(simple-files): adds ability to pass file-lists to simple-
+  commands. [Frank Harrison]
+- Feat(simple-files): strongly types the simple job executor. [Frank
+  Harrison]
+- Feat(simple-files): fixes docstring. [Frank Harrison]
+
+
+0.1.2 (2024-11-18)
+------------------
+- Release: version 0.1.2 🚀 [Frank Harrison]
 - Chore(actions): simplifies code paths for actions. [Frank Harrison]
 - Chore(contrib): removes the Makefile commands that have been removed.
   [Frank Harrison]

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

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

runem-0.3.0/runem/VERSION

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

{runem-0.1.2 → runem-0.3.0}/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-0.3.0/runem/job_runner_simple_command.py

@@ -0,0 +1,64 @@
+import shlex
+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
+
+
+def validate_simple_command(command_string: str) -> typing.List[str]:
+    """Use shlex to handle parsing of the command string, a non-trivial problem."""
+    split_command: typing.List[str] = shlex.split(command_string)
+    return split_command
+
+
+def job_runner_simple_command(
+    **kwargs: Unpack[AllKwargs],
+) -> None:
+    """Parses the command and tries to run it via the system.
+
+    Commands inherit the environment.
+    """
+    # assume we have the job.command entry, allowing KeyError to propagate up
+    job_config: JobConfig = kwargs["job"]
+    command_string: str = job_config["command"]
+
+    command_string_files: str = command_string
+    if "{file_list}" in command_string:
+        file_list: FilePathList = kwargs["file_list"]
+        file_list_with_quotes: typing.List[str] = [
+            f'"{str(file_path)}"' for file_path in file_list
+        ]
+        command_string_files = command_string.replace(
+            "{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_options)
+
+    # preserve quotes for consistent handling of strings and avoid the "word
+    # splitting" problem for unix-like shells.
+    cmd_with_quotes = [f'"{token}"' if " " in token else token for token in cmd]
+
+    run_command(cmd=cmd_with_quotes, **kwargs)

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

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

{runem-0.1.2 → runem-0.3.0}/tests/test_job.py

@@ -3,7 +3,7 @@ from collections import defaultdict
 
 import pytest
 
-from runem.job import Job, NoJobName
+from runem.job import BadWhenConfigLocation, Job, NoJobName
 from runem.types.common import FilePathList, JobTags
 from runem.types.filters import FilePathListLookup
 from runem.types.runem_config import JobConfig
@@ -27,6 +27,24 @@ def test_get_job_tags(
     assert result == expected_result
 
 
+def test_get_job_tags_bad_tags_path() -> None:
+    """Tests that the 'tags' entry is on 'when' and not on root."""
+    job_config: JobConfig = {  # type: ignore[typeddict-unknown-key]
+        "tags": ["dummy tags"],
+    }
+    with pytest.raises(BadWhenConfigLocation):
+        Job.get_job_tags(job_config)
+
+
+def test_get_job_tags_bad_phase_path() -> None:
+    """Tests that the 'phase' entry is on 'when' and not on root."""
+    job_config: JobConfig = {  # type: ignore[typeddict-unknown-key]
+        "phase": "dummy tags",
+    }
+    with pytest.raises(BadWhenConfigLocation):
+        Job.get_job_tags(job_config)
+
+
 @pytest.fixture(name="file_lists")
 def file_lists_fixture() -> FilePathListLookup:
     """Define a sample file_lists dictionary for testing."""

runem-0.3.0/tests/test_job_runner_simple_command.py

@@ -0,0 +1,155 @@
+import io
+import typing
+from contextlib import redirect_stdout
+from pathlib import Path
+from unittest.mock import ANY, Mock, patch
+
+from runem.config_metadata import ConfigMetadata
+from runem.job import Job
+from runem.job_runner_simple_command import job_runner_simple_command
+from runem.types.runem_config import JobConfig
+from tests.test_runem import gen_dummy_config_metadata
+
+
+@patch(
+    "runem.job_runner_simple_command.run_command",
+    # return_value=None,
+)
+def test_job_runner_simple_command(mock_run_command: Mock) -> None:
+    """Tests the basics of job_runner_simple_command."""
+    job_config: JobConfig = {
+        "command": "echo 'testing job_runner_simple_command'",
+    }
+    config_metadata: ConfigMetadata = gen_dummy_config_metadata()
+    with io.StringIO() as buf, redirect_stdout(buf):
+        ret: None = job_runner_simple_command(  # type: ignore[func-returns-value]
+            config_metadata=config_metadata,
+            options=config_metadata.options,  # type: ignore
+            file_list=[],
+            procs=config_metadata.args.procs,
+            root_path=Path("."),
+            verbose=True,  # config_metadata.args.verbose,
+            # unpack useful data points from the job_config
+            label=Job.get_job_name(job_config),
+            job=job_config,
+        )
+        run_command_stdout = buf.getvalue()
+
+    assert ret is None
+    assert run_command_stdout.split("\n") == [""]
+    mock_run_command.assert_called_once_with(
+        cmd=["echo", '"testing job_runner_simple_command"'],
+        config_metadata=ANY,
+        file_list=[],
+        job={"command": "echo 'testing job_runner_simple_command'"},
+        label="echo 'testing job_runner_simple_command'",
+        options=ANY,
+        procs=1,
+        root_path=Path("."),
+        verbose=True,
+    )
+
+
+@patch(
+    "runem.job_runner_simple_command.run_command",
+    # return_value=None,
+)
+def test_job_runner_simple_command_with_file_list(mock_run_command: Mock) -> None:
+    """Tests the basics of job_runner_simple_command."""
+    test_cmd_string: str = (
+        'echo "some option before files" {file_list} "some option after files"'
+    )
+    job_config: JobConfig = {
+        "command": test_cmd_string,
+    }
+    config_metadata: ConfigMetadata = gen_dummy_config_metadata()
+    file_list: typing.List[typing.Union[str, Path]] = [
+        Path("file1"),
+        "file2",
+        "file with spaces",
+    ]
+    with io.StringIO() as buf, redirect_stdout(buf):
+        ret: None = job_runner_simple_command(  # type: ignore[func-returns-value]
+            file_list=file_list,  # type: ignore[arg-type] # intentional type mismatch
+            job=job_config,
+            label=Job.get_job_name(job_config),
+            config_metadata=config_metadata,
+            options=config_metadata.options,  # type: ignore
+            procs=config_metadata.args.procs,
+            root_path=Path("."),
+            verbose=True,  # config_metadata.args.verbose,
+        )
+        run_command_stdout = buf.getvalue()
+
+    assert ret is None
+    assert run_command_stdout.split("\n") == [""]
+    mock_run_command.assert_called_once_with(
+        cmd=[
+            "echo",
+            '"some option before files"',
+            "file1",
+            "file2",
+            '"file with spaces"',
+            '"some option after files"',
+        ],
+        config_metadata=ANY,
+        file_list=file_list,
+        job=job_config,
+        label=test_cmd_string,
+        options=ANY,
+        procs=1,
+        root_path=Path("."),
+        verbose=True,
+    )
+
+
+@patch(
+    "runem.job_runner_simple_command.run_command",
+    # return_value=None,
+)
+def test_job_runner_simple_command_with_option(mock_run_command: Mock) -> None:
+    """Tests that option-passing to jobs, pass --option_on but not --option_off."""
+    test_cmd_string: str = (
+        'echo "some option before switch" {option_on} {option_off} "some option after switch"'
+    )
+    job_config: JobConfig = {
+        "command": test_cmd_string,
+    }
+    config_metadata: ConfigMetadata = gen_dummy_config_metadata()
+    file_list: typing.List[typing.Union[str, Path]] = [
+        Path("file1"),
+        "file2",
+        "file with spaces",
+    ]
+    with io.StringIO() as buf, redirect_stdout(buf):
+        ret: None = job_runner_simple_command(  # type: ignore[func-returns-value]
+            file_list=file_list,  # type: ignore[arg-type] # intentional type mismatch
+            job=job_config,
+            label=Job.get_job_name(job_config),
+            config_metadata=config_metadata,
+            options=config_metadata.options,  # type: ignore
+            procs=config_metadata.args.procs,
+            root_path=Path("."),
+            verbose=True,  # config_metadata.args.verbose,
+        )
+        run_command_stdout = buf.getvalue()
+
+    assert ret is None
+    assert run_command_stdout.split("\n") == [""]
+    mock_run_command.assert_called_once_with(
+        cmd=[
+            "echo",
+            '"some option before switch"',
+            "--option_on",
+            # Not this -> "--option_off",
+            '"some option after switch"',
+        ],
+        config_metadata=ANY,
+        file_list=file_list,
+        job=job_config,
+        label=test_cmd_string,
+        options={"option_on": True, "option_off": False},
+        procs=1,
+        root_path=Path("."),
+        verbose=True,
+    )

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

@@ -1780,7 +1780,7 @@ def test_progress_updater_with_false(show_spinner: bool) -> None:
         )
 
 
-def _dummy_config_metadata() -> ConfigMetadata:
+def gen_dummy_config_metadata() -> ConfigMetadata:
     config_metadata: ConfigMetadata = ConfigMetadata(
         cfg_filepath=pathlib.Path(__file__),
         phases=("dummy phase 1",),
@@ -1803,13 +1803,13 @@ def _dummy_config_metadata() -> ConfigMetadata:
         phases_to_run=set(),  # JobPhases,
         tags_to_run=set(),  # ignored JobTags,
         tags_to_avoid=set(),  # ignored  JobTags,
-        options=InformativeDict({}),  # Options,
+        options=InformativeDict({"option_on": True, "option_off": False}),  # Options,
     )
     return config_metadata
 
 
 DUMMY_MAIN_RETURN: MainReturnType = (
-    _dummy_config_metadata(),  # ConfigMetadata,
+    gen_dummy_config_metadata(),  # ConfigMetadata,
     {},  # job_run_metadatas,
     IntentionalTestError(),
 )

runem-0.1.2/runem/VERSION

@@ -1 +0,0 @@
-0.1.2

runem-0.1.2/runem/job_runner_simple_command.py

@@ -1,32 +0,0 @@
-import shlex
-import typing
-
-from runem.run_command import run_command
-from runem.types.runem_config import JobConfig
-
-
-def validate_simple_command(command_string: str) -> typing.List[str]:
-    # use shlex to handle parsing of the command string, a non-trivial problem.
-    split_command: typing.List[str] = shlex.split(command_string)
-    return split_command
-
-
-def job_runner_simple_command(
-    **kwargs: typing.Any,
-) -> None:
-    """Parses the command and tries to run it via the system.
-
-    Commands inherit the environment.
-    """
-    # assume we have the job.command entry, allowing KeyError to propagate up
-    job_config: JobConfig = kwargs["job"]
-    command_string: str = job_config["command"]
-
-    # use shlex to handle parsing of the command string, a non-trivial problem.
-    result = validate_simple_command(command_string)
-
-    # preserve quotes for consistent handling of strings and avoid the "word
-    # splitting" problem for unix-like shells.
-    result_with_quotes = [f'"{token}"' if " " in token else token for token in result]
-
-    run_command(cmd=result_with_quotes, **kwargs)

runem-0.1.2/tests/test_job_runner_simple_command.py

@@ -1,39 +0,0 @@
-import io
-from contextlib import redirect_stdout
-from unittest.mock import Mock, patch
-
-from runem.job import Job
-from runem.job_runner_simple_command import job_runner_simple_command
-from runem.types.runem_config import JobConfig
-
-
-@patch(
-    "runem.job_runner_simple_command.run_command",
-    # return_value=None,
-)
-def test_job_runner_simple_command(mock_run_command: Mock) -> None:
-    """Tests the basics of job_runner_simple_command."""
-    job_config: JobConfig = {
-        "command": "echo 'testing job_runner_simple_command'",
-    }
-    with io.StringIO() as buf, redirect_stdout(buf):
-        ret: None = job_runner_simple_command(  # type: ignore[func-returns-value]
-            # options=config_metadata.options,  # type: ignore
-            # file_list=file_list,
-            # procs=config_metadata.args.procs,
-            # root_path=root_path,
-            verbose=True,  # config_metadata.args.verbose,
-            # unpack useful data points from the job_config
-            label=Job.get_job_name(job_config),
-            job=job_config,
-        )
-        run_command_stdout = buf.getvalue()
-
-    assert ret is None
-    assert run_command_stdout.split("\n") == [""]
-    mock_run_command.assert_called_once_with(
-        cmd=["echo", '"testing job_runner_simple_command"'],
-        verbose=True,
-        label="echo 'testing job_runner_simple_command'",
-        job={"command": "echo 'testing job_runner_simple_command'"},
-    )