runem 0.5.0__tar.gz → 0.7.0__tar.gz

{runem-0.5.0 → runem-0.7.0}/HISTORY.md

@@ -4,6 +4,125 @@ Changelog
 
 (unreleased)
 ------------
+- Merge pull request #83 from
+  lursight/feat/no_runem_traceback_on_job_fail. [Frank Harrison]
+
+  Feat/no runem traceback on job fail
+- Feat(error-only): only shows the error not the runem error tracback.
+  [Frank Harrison]
+
+  The runem error traceback is irelevant if the sub-task fails. So we just
+  show that task's output instead of the traceback for where we handle the
+  error.
+- Feat(error-ctx): shows the failed job label as we show the causing
+  error. [Frank Harrison]
+- Feat(remove-failed): always remove the failed job from the list of
+  running jobs. [Frank Harrison]
+- Merge pull request #82 from lursight/feat/schema_validation. [Frank
+  Harrison]
+
+  feat(validation): validates the .runem.yml file against the schema
+- Feat(validation): validates the .runem.yml file against the schema.
+  [Frank Harrison]
+- Merge pull request #81 from lursight/chore/ruff. [Frank Harrison]
+
+  Chore/ruff
+- Chore(ruff): some formatting change made whilst configuring ruff.
+  [Frank Harrison]
+- Chore(ruff): use ruff as its faster/better. [Frank Harrison]
+- Merge pull request #80 from lursight/chore/update_deps. [Frank
+  Harrison]
+
+  Chore/update deps
+- Chore(deps): updates pylint 3.1.0 -> 3.3.6. [Frank Harrison]
+- Chore(deps): updates pytest 8.3.3 -> 8.3.5 and pytest-cov to latest.
+  [Frank Harrison]
+- Merge pull request #79 from
+  lursight/feat/removes_dectorate_param_from_log. [Frank Harrison]
+
+  feat(log): changes the semantics of log's 'decorate' to allow overriding
+- Feat(log): changes the semantics of log's 'decorate' to allow
+  overriding. [Frank Harrison]
+
+  Also renames the log API's param decorate -> prefix.
+
+  This better represents the intent of the param as decorate was adding a
+  default prefix.
+
+
+0.6.0 (2025-02-03)
+------------------
+- Release: version 0.6.0 🚀 [Frank Harrison]
+- Merge pull request #78 from lursight/feat/better_error_display. [Frank
+  Harrison]
+
+  Feat/better error display
+- Fix(spinner): fixes the Spinner show it only shows for --show-spinner.
+  [Frank Harrison]
+
+  Also, fixes it so that it shows only a single spinner
+- Feat(colours): adds better colours to the terminal output. [Frank
+  Harrison]
+
+  This helps to reinfoce time-saved and other aspects of the tool.
+- Feat(better-errors): makes finding the stderr in the list of errors
+  easier. [Frank Harrison]
+
+  We do this by colouring the text for the commands and wrapping the
+  errors with a red-box.
+
+  We colour:
+  - command-lines -> yellow
+  - job-labels -> blue
+  - errors -> red
+  - in-progress -> green box
+- Merge pull request #77 from lursight/fix/log-verbosity. [Frank
+  Harrison]
+
+  fix(log-verbosity): fixes verbosity bug when not showing the spinner
+- Fix(log-verbosity): fixes verbosity bug when not showing the spinner.
+  [Frank Harrison]
+
+  We were showing the running procs on every tick, instead of just the
+  changes to the running procs, if any.
+- Merge pull request #76 from lursight/chore/types/job-return-type.
+  [Frank Harrison]
+
+  chore(types) fixes exports for JobReturn type
+- Chore(types): exports the JobReturn type from the types submodule.
+  [Frank Harrison]
+- Merge pull request #75 from lursight/chore/todos. [Frank Harrison]
+
+  chore(todos): adds TODOD.txt to track ideas for runem
+- Chore(todos): adds TODOD.txt to track ideas for runem. [Frank
+  Harrison]
+- Merge pull request #74 from lursight/chore/help_docs. [Frank Harrison]
+
+  chore(docs): removes help output from a details block
+- Chore(docs): removes help output from a details block. [Frank
+  Harrison]
+
+  The details block broke the pre-formatted styling of the code-block.
+- Merge pull request #73 from lursight/chore/update_contrib. [Frank
+  Harrison]
+
+  chore(docs): trying to add line-breaks to non-bulletpointed list
+- Chore(docs): trying to add line-breaks to non-bulletpointed list.
+  [Frank Harrison]
+- Merge pull request #72 from lursight/chore/update_contrib. [Frank
+  Harrison]
+
+  Chore/update CONTRIBUTING.md and README.md
+- Chore(spell): adds 'pyenv' to dictionary. [Frank Harrison]
+- Chore(docs): improves the README. [Frank Harrison]
+- Docs(contrib): updates the contributing docs. [Frank Harrison]
+
+  We add some of the basics as well as some more recent changes
+
+
+0.5.0 (2024-12-12)
+------------------
+- Release: version 0.5.0 🚀 [Frank Harrison]
 - Merge pull request #71 from lursight/feat/pyproject. [Frank Harrison]
 
   Feat/pyproject

runem-0.7.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.4
+Name: runem
+Version: 0.7.0
+Summary: Awesome runem created by lursight
+Author: lursight
+License: Specify your license here
+Project-URL: Homepage, https://github.com/lursight/runem/
+Keywords: example,runem
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: packaging>=22.0
+Requires-Dist: PyYAML>=5.0.0
+Requires-Dist: jsonschema>=4.22
+Requires-Dist: rich>10.0.0
+Requires-Dist: typing_extensions>3.0.0
+Provides-Extra: tests
+Requires-Dist: coverage==7.5; extra == "tests"
+Requires-Dist: flake8-bugbear==24.2.6; extra == "tests"
+Requires-Dist: flake8==7.0.0; extra == "tests"
+Requires-Dist: gitchangelog==3.0.4; extra == "tests"
+Requires-Dist: mkdocs==1.5.3; extra == "tests"
+Requires-Dist: mypy==1.9.0; extra == "tests"
+Requires-Dist: pydocstyle==6.3.0; extra == "tests"
+Requires-Dist: pylint==3.3.6; extra == "tests"
+Requires-Dist: pylama==8.4.1; extra == "tests"
+Requires-Dist: pytest-cov==6.1.1; extra == "tests"
+Requires-Dist: pytest-profiling==1.7.0; extra == "tests"
+Requires-Dist: pytest-xdist==3.6.1; extra == "tests"
+Requires-Dist: pytest==8.3.5; extra == "tests"
+Requires-Dist: ruff==0.11.6; extra == "tests"
+Requires-Dist: setuptools; extra == "tests"
+Requires-Dist: termplotlib==0.3.9; extra == "tests"
+Requires-Dist: tox; extra == "tests"
+Requires-Dist: types-PyYAML==6.0.12.20240311; extra == "tests"
+Requires-Dist: requests-mock==1.11.0; extra == "tests"
+Requires-Dist: types-jsonschema; extra == "tests"
+Requires-Dist: types-setuptools; extra == "tests"
+Dynamic: license-file
+
+<!-- [![codecov](https://codecov.io/gh/lursight/runem/branch/main/graph/badge.svg?token=run-test_token_here)](https://codecov.io/gh/lursight/runem) -->
+[![CI](https://github.com/lursight/runem/actions/workflows/main.yml/badge.svg)](https://github.com/lursight/runem/actions/workflows/main.yml)
+[![DOCS](https://lursight.github.io/runem/docs/VIEW-DOCS-31c553.svg)](https://lursight.github.io/runem/)
+
+# Run’em
+
+**Your Blueprint of Commands. Your Engine of Parallel Execution.**
+Run’em is your definitive blueprint of tasks and commands—instantly discoverable, effortlessly parallel, and elegantly extensible.
+
+## Core Strengths
+
+**Blueprint** - discover tasks and onboard smoothly\
+**Parallel**  - get results quicker\
+**Simple**  - define task easily\
+**Extensible** - add tasks quickly\
+**Filters** - powerful task selection\
+**Reports** - see metrics on tasks
+
+## Why Run’em?
+- **Command Blueprint:** Instantly see and run all your tasks. No guesswork, no rummaging.
+- **Effortless Parallelism:** Execute tasks side-by-side to obliterate downtime.
+- **Simple YAML Declarations:** Define everything in one `.runem.yml`.
+- **Extensible & Smart:** Adapt to monorepos, complex workflows, and evolving needs.
+- **Discoverable by Design:** `runem --help` guides your team, new hires, or contributors to every defined command.
+
+## Contents
+- [Run’em](#runem)
+  - [Core Strengths](#core-strengths)
+  - [Why Run’em?](#why-runem)
+  - [Contents](#contents)
+- [Highlights](#highlights)
+- [Quick Start](#quick-start)
+- [Basic Use](#basic-use)
+- [Advanced Use](#advanced-use)
+- [Help & Discovery](#help--discovery)
+- [Troubleshooting](#troubleshooting)
+- [Contribute & Support](#contribute--support)
+- [About Run’em](#about-runem)
+
+# Highlights
+## Blueprint of Commands:
+The blueprint (available via `--help`) gives you a manifest of all jobs and tasks in a
+project. A single source of truth for all tasks.
+## Parallel Execution:
+Maximise speed with automatic concurrency. Runem tries to run all tasks as quickly as
+possible, looking at resources, with dependencies. It is not yet a full
+dependency-execution graph, but by version 1.0.0 it will be.
+## Filtering:
+Use powerful and flexible filtering. Select or excluded tasks by `tags`, `name` and
+`phase`. Chose the task to be run based on your needs, right now.
+
+You can also customise filtering by adding your own command `options`.
+
+See `--tags`, `--not-tags`, `--jobs`, `--not-jobs`, `--phases` and `--not-phases`.
+## Powerful Insights:** Understand what ran, how fast, and what failed.
+**Quiet by Default:** Focus on what matters, and reveal detail only when needed.
+
+# Quick Start
+**Install:**
+```bash
+pip install runem
+```
+**Define a task:**
+
+```yaml
+`# .runem.yml
+ - job:
+    command: echo "hello world!"
+```
+
+**Run:**
+
+```bash
+runem
+```
+
+Run multiple commands in parallel, see timing, and keep output minimal. Need detail?
+
+```bash
+runem --verbose
+```
+
+[Quick Start Docs](https://lursight.github.io/runem/docs/quick_start.html)
+
+# Basic Use
+
+Get comfortable with typical workflows:
+[Basic Use Docs](https://lursight.github.io/runem/docs/basic_use.html)
+
+# Advanced Use
+
+Scale up with multi-phase configs, filtered execution, and custom reporting:
+[Advanced Configuration](https://lursight.github.io/runem/docs/configuration.html)
+[Custom Reporting](https://lursight.github.io/runem/docs/reports.html)
+
+# Help & Discovery
+
+`runem --help` is your radar—instantly mapping out every available task:
+[Help & Job Discovery](https://lursight.github.io/runem/docs/help_and_job_discovery.html)
+
+# Troubleshooting
+
+Swift solutions to common issues:
+[Troubleshooting & Known Issues](https://lursight.github.io/runem/docs/troubleshooting_known_issues.html)
+
+---
+
+# Contribute & Support
+
+Brought to you by [Lursight Ltd.](https://lursight.com) and an open community.
+[CONTRIBUTING.md](CONTRIBUTING.md)
+[❤️ Sponsor](https://github.com/sponsors/lursight/)
+
+# About Run’em
+
+Run’em exists to accelerate your team’s delivery and reduce complexity. Learn about our [Mission](https://lursight.github.io/runem/docs/mission.html).
+

runem-0.7.0/README.md

@@ -0,0 +1,117 @@
+<!-- [![codecov](https://codecov.io/gh/lursight/runem/branch/main/graph/badge.svg?token=run-test_token_here)](https://codecov.io/gh/lursight/runem) -->
+[![CI](https://github.com/lursight/runem/actions/workflows/main.yml/badge.svg)](https://github.com/lursight/runem/actions/workflows/main.yml)
+[![DOCS](https://lursight.github.io/runem/docs/VIEW-DOCS-31c553.svg)](https://lursight.github.io/runem/)
+
+# Run’em
+
+**Your Blueprint of Commands. Your Engine of Parallel Execution.**
+Run’em is your definitive blueprint of tasks and commands—instantly discoverable, effortlessly parallel, and elegantly extensible.
+
+## Core Strengths
+
+**Blueprint** - discover tasks and onboard smoothly\
+**Parallel**  - get results quicker\
+**Simple**  - define task easily\
+**Extensible** - add tasks quickly\
+**Filters** - powerful task selection\
+**Reports** - see metrics on tasks
+
+## Why Run’em?
+- **Command Blueprint:** Instantly see and run all your tasks. No guesswork, no rummaging.
+- **Effortless Parallelism:** Execute tasks side-by-side to obliterate downtime.
+- **Simple YAML Declarations:** Define everything in one `.runem.yml`.
+- **Extensible & Smart:** Adapt to monorepos, complex workflows, and evolving needs.
+- **Discoverable by Design:** `runem --help` guides your team, new hires, or contributors to every defined command.
+
+## Contents
+- [Run’em](#runem)
+  - [Core Strengths](#core-strengths)
+  - [Why Run’em?](#why-runem)
+  - [Contents](#contents)
+- [Highlights](#highlights)
+- [Quick Start](#quick-start)
+- [Basic Use](#basic-use)
+- [Advanced Use](#advanced-use)
+- [Help & Discovery](#help--discovery)
+- [Troubleshooting](#troubleshooting)
+- [Contribute & Support](#contribute--support)
+- [About Run’em](#about-runem)
+
+# Highlights
+## Blueprint of Commands:
+The blueprint (available via `--help`) gives you a manifest of all jobs and tasks in a
+project. A single source of truth for all tasks.
+## Parallel Execution:
+Maximise speed with automatic concurrency. Runem tries to run all tasks as quickly as
+possible, looking at resources, with dependencies. It is not yet a full
+dependency-execution graph, but by version 1.0.0 it will be.
+## Filtering:
+Use powerful and flexible filtering. Select or excluded tasks by `tags`, `name` and
+`phase`. Chose the task to be run based on your needs, right now.
+
+You can also customise filtering by adding your own command `options`.
+
+See `--tags`, `--not-tags`, `--jobs`, `--not-jobs`, `--phases` and `--not-phases`.
+## Powerful Insights:** Understand what ran, how fast, and what failed.
+**Quiet by Default:** Focus on what matters, and reveal detail only when needed.
+
+# Quick Start
+**Install:**
+```bash
+pip install runem
+```
+**Define a task:**
+
+```yaml
+`# .runem.yml
+ - job:
+    command: echo "hello world!"
+```
+
+**Run:**
+
+```bash
+runem
+```
+
+Run multiple commands in parallel, see timing, and keep output minimal. Need detail?
+
+```bash
+runem --verbose
+```
+
+[Quick Start Docs](https://lursight.github.io/runem/docs/quick_start.html)
+
+# Basic Use
+
+Get comfortable with typical workflows:
+[Basic Use Docs](https://lursight.github.io/runem/docs/basic_use.html)
+
+# Advanced Use
+
+Scale up with multi-phase configs, filtered execution, and custom reporting:
+[Advanced Configuration](https://lursight.github.io/runem/docs/configuration.html)
+[Custom Reporting](https://lursight.github.io/runem/docs/reports.html)
+
+# Help & Discovery
+
+`runem --help` is your radar—instantly mapping out every available task:
+[Help & Job Discovery](https://lursight.github.io/runem/docs/help_and_job_discovery.html)
+
+# Troubleshooting
+
+Swift solutions to common issues:
+[Troubleshooting & Known Issues](https://lursight.github.io/runem/docs/troubleshooting_known_issues.html)
+
+---
+
+# Contribute & Support
+
+Brought to you by [Lursight Ltd.](https://lursight.com) and an open community.
+[CONTRIBUTING.md](CONTRIBUTING.md)
+[❤️ Sponsor](https://github.com/sponsors/lursight/)
+
+# About Run’em
+
+Run’em exists to accelerate your team’s delivery and reduce complexity. Learn about our [Mission](https://lursight.github.io/runem/docs/mission.html).
+

{runem-0.5.0 → runem-0.7.0}/pyproject.toml

@@ -23,7 +23,10 @@ classifiers = [
 dependencies = [
   # `packaging` is probably not needed after moving to pyproject.toml
   "packaging>=22.0",
+
+  # For yml passingg and validation
   "PyYAML>=5.0.0",
+  "jsonschema>=4.22",
 
   # For UI Elements
   "rich>10.0.0",
@@ -49,26 +52,25 @@ runem = ["VERSION"]
 [project.optional-dependencies]
 tests = [
   # This requirements are for development and testing only, not for production.
-  "black==24.10.0",
   "coverage==7.5",
-  "docformatter==1.7.5",
   "flake8-bugbear==24.2.6",
   "flake8==7.0.0",
   "gitchangelog==3.0.4",
-  "isort==5.13.2",
   "mkdocs==1.5.3",
   "mypy==1.9.0",
   "pydocstyle==6.3.0",
-  "pylint==3.1.0",
+  "pylint==3.3.6",
   "pylama==8.4.1",
-  "pytest-cov==6.0.0",
+  "pytest-cov==6.1.1",
   "pytest-profiling==1.7.0",
   "pytest-xdist==3.6.1",
-  "pytest==8.3.3",
+  "pytest==8.3.5",
+  "ruff==0.11.6",
   "setuptools",
   "termplotlib==0.3.9",
   "tox",
   "types-PyYAML==6.0.12.20240311",
   "requests-mock==1.11.0",
+  "types-jsonschema",
   "types-setuptools",
 ]

runem-0.7.0/runem/VERSION

@@ -0,0 +1 @@
+0.7.0

{runem-0.5.0 → runem-0.7.0}/runem/blocking_print.py

@@ -13,7 +13,14 @@ def _reset_console() -> Console:
 
     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]`.
+        # We allow markup here, BUT stdout/stderr from other procs should have
+        # `escape()` called on them so they don't error here.
+        # This means 'rich' effects/colors can be judiciously applied:
+        # e.g. `[blink]Don't Panic![/blink]`.
+        markup=True,
+        # `highlight` is what colourises string and number in print() calls.
+        # We do not want this to be auto-magic.
+        highlight=False,
     )
     return RICH_CONSOLE
 
@@ -31,7 +38,8 @@ def _reset_console_for_tests() -> None:
     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]`.
+        markup=True,  # Allow some markup e.g. `[blink]Don't Panic![/blink]`.
+        highlight=False,
         width=999,  # A very wide width.
     )
 

{runem-0.5.0 → runem-0.7.0}/runem/cli/initialise_options.py

@@ -13,7 +13,6 @@ def initialise_options(
 
     Returns the options dictionary
     """
-
     options: OptionsWritable = InformativeDict(
         {option["name"]: option["default"] for option in config_metadata.options_config}
     )

{runem-0.5.0 → runem-0.7.0}/runem/command_line.py

@@ -43,10 +43,8 @@ def _get_argparse_help_formatter() -> typing.Any:
 
     if use_fixed_width:
         # Use custom formatter with the width specified in the environment variable
-        return (
-            lambda prog: HelpFormatterFixedWidth(  # pylint: disable=unnecessary-lambda
-                prog
-            )
+        return lambda prog: HelpFormatterFixedWidth(  # pylint: disable=unnecessary-lambda
+            prog
         )
 
     # Use default formatter
@@ -294,12 +292,12 @@ def parse_args(
     error_on_log_logic(args.verbose, args.silent)
 
     if args.show_root_path_and_exit:
-        log(str(config_metadata.cfg_filepath.parent), decorate=False)
+        log(str(config_metadata.cfg_filepath.parent), prefix=False)
         # cleanly exit
         sys.exit(0)
 
     if args.show_version_and_exit:
-        log(str(get_runem_version()), decorate=False)
+        log(str(get_runem_version()), prefix=False)
         # cleanly exit
         sys.exit(0)
 
@@ -383,7 +381,6 @@ def initialise_options(
 
     Returns the options dictionary
     """
-
     options: OptionsWritable = InformativeDict(
         {option["name"]: option["default"] for option in config_metadata.options_config}
     )

{runem-0.5.0 → runem-0.7.0}/runem/config.py

@@ -2,9 +2,9 @@ import pathlib
 import sys
 import typing
 
-import yaml
 from packaging.version import Version
 
+from runem.config_validate import validate_runem_file
 from runem.log import error, log
 from runem.runem_version import get_runem_version
 from runem.types.runem_config import (
@@ -13,6 +13,7 @@ from runem.types.runem_config import (
     GlobalSerialisedConfig,
     UserConfigMetadata,
 )
+from runem.yaml_utils import load_yaml_object
 
 CFG_FILE_YAML = pathlib.Path(".runem.yml")
 
@@ -46,7 +47,7 @@ def _search_up_multiple_dirs_for_file(
 
 
 def _find_config_file(
-    config_filename: typing.Union[str, pathlib.Path]
+    config_filename: typing.Union[str, pathlib.Path],
 ) -> typing.Tuple[typing.Optional[pathlib.Path], typing.Tuple[pathlib.Path, ...]]:
     """Searches up from the cwd for the given config file-name."""
     start_dirs = (pathlib.Path(".").absolute(),)
@@ -117,8 +118,11 @@ def _conform_global_config_types(
 
 def load_and_parse_config(cfg_filepath: pathlib.Path) -> Config:
     """For the given config file pass, project or user, load it & parse/conform it."""
-    with cfg_filepath.open("r+", encoding="utf-8") as config_file_handle:
-        all_config = yaml.full_load(config_file_handle)
+    all_config = load_yaml_object(cfg_filepath)
+    validate_runem_file(
+        cfg_filepath,
+        all_config,
+    )
 
     conformed_config: Config
     global_config: typing.Optional[GlobalConfig]

{runem-0.5.0 → runem-0.7.0}/runem/config_parse.py

@@ -162,7 +162,8 @@ def parse_job_config(
             ("cwd" in job["ctx"]) and (job["ctx"]["cwd"] is not None)
         )
         if (not have_ctw_cwd) or isinstance(
-            job["ctx"]["cwd"], str  # type: ignore # handled above
+            job["ctx"]["cwd"],  # type: ignore # handled above
+            str,
         ):
             # if
             # - we don't have a cwd, ctx

runem-0.7.0/runem/config_validate.py

@@ -0,0 +1,47 @@
+import pathlib
+import typing
+
+from runem.log import error, log
+from runem.types.errors import SystemExitBad
+from runem.yaml_utils import load_yaml_object
+from runem.yaml_validation import ValidationErrors, validate_yaml
+
+
+def _load_runem_schema() -> typing.Any:
+    """Loads and returns the yaml schema for runem.
+
+    Returns:
+        Any: the Draft202012Validator conformant schema.
+    """
+    schema_path: pathlib.Path = pathlib.Path(__file__).with_name("schema.yml")
+    if not schema_path.exists():
+        error(
+            (
+                "runem schema file not found, cannot continue! "
+                f"Is the install corrupt? {schema_path}"
+            )
+        )
+        raise SystemExitBad(1)
+    schema: typing.Any = load_yaml_object(schema_path)
+    return schema
+
+
+def validate_runem_file(
+    cfg_filepath: pathlib.Path,
+    all_config: typing.Any,
+) -> None:
+    """Validates the config Loader object against the runem schema.
+
+    Exits if the files does not validate.
+    """
+    schema: typing.Any = _load_runem_schema()
+    errors: ValidationErrors = validate_yaml(all_config, schema)
+    if not errors:
+        # aok
+        return
+
+    error(f"failed to validate runem config [yellow]{cfg_filepath}[/yellow]")
+    for err in errors:
+        path = ".".join(map(str, err.path)) or "<root>"
+        log(f" [yellow]{path}[/yellow]: {err.message}")
+    raise SystemExit("Config validation failed.")

{runem-0.5.0 → runem-0.7.0}/runem/informative_dict.py

@@ -9,8 +9,7 @@ class InformativeDict(typing.Dict[K, V], typing.Generic[K, V]):
     """A dictionary type that prints out the available keys."""
 
     def __getitem__(self, key: K) -> V:
-        """Attempt to retrieve an item, raising a detailed exception if the key is not
-        found."""
+        """Attempt to get item, raising a detailed exception if the key is not found."""
         try:
             return super().__getitem__(key)
         except KeyError:
@@ -24,19 +23,25 @@ class ReadOnlyInformativeDict(InformativeDict[K, V], typing.Generic[K, V]):
     """A read-only variant of the above."""
 
     def __setitem__(self, key: K, value: V) -> None:
+        """Readonly object, setitem disallowed."""
         raise NotImplementedError("This dictionary is read-only")
 
     def __delitem__(self, key: K) -> None:
+        """Readonly object, delitem disallowed."""
         raise NotImplementedError("This dictionary is read-only")
 
     def pop(self, *args: typing.Any, **kwargs: typing.Any) -> V:
+        """Readonly object, pop disallowed."""
         raise NotImplementedError("This dictionary is read-only")
 
     def popitem(self) -> typing.Tuple[K, V]:
+        """Readonly object, popitem disallowed."""
         raise NotImplementedError("This dictionary is read-only")
 
     def clear(self) -> None:
+        """Readonly object, clear disallowed."""
         raise NotImplementedError("This dictionary is read-only")
 
     def update(self, *args: typing.Any, **kwargs: typing.Any) -> None:
+        """Readonly object, update disallowed."""
         raise NotImplementedError("This dictionary is read-only")

{runem-0.5.0 → runem-0.7.0}/runem/job.py

@@ -71,7 +71,6 @@ class Job:
 
         TODO: make a non-static member function
         """
-
         # default to all file-tags
         tags_for_files: typing.Iterable[str] = file_lists.keys()
         use_default_tags: bool = job_tags is None
@@ -91,7 +90,6 @@ class Job:
 
         TODO: make a non-static member function
         """
-
         # First try one of the following keys.
         valid_name_keys = ("label", "command")
         for candidate in valid_name_keys:
@@ -101,6 +99,6 @@ class Job:
 
         # The try the python-wrapper address
         try:
-            return f'{job["addr"]["file"]}.{job["addr"]["function"]}'
+            return f"{job['addr']['file']}.{job['addr']['function']}"
         except KeyError:
             raise NoJobName()  # pylint: disable=raise-missing-from