Merge pull request #3 from maxkatzmann/none-selected-warning

Added reminder message and updated documentation.

CHANGELOG.md

@@ -1,7 +1,13 @@
+# 1.0.7
+  * **user experience:** If no run is selected via the command line, a warning
+    is presented to the user as a reminder.
+  * **documentation:** The README now briefly explains how to execute from the
+    command line
+
 # 1.0.6
   * **new feature:** it is now possible to use wildcards to specify
     the names of experiments to be run
-  * bug-fix: under some circumstances the multi-processing pool
+  * **bug-fix:** under some circumstances the multi-processing pool
     was getting an exception when python is shutting down
   * **documentation:** Description of the new feature.
 

README.md

@@ -54,6 +54,8 @@ run.add(
 run.run()
 ```
 
+The experiment is then run using `python example.py experiment1`.
+
 If you want to reformat the output before writing it to a file using a
 function `reformat()`, which takes a string and returns a string, you
 can do so by simply adding `stdout_mod=reformat` to the above example.

run.py

@@ -271,7 +271,7 @@ def _add_run(run):
         _state.runs_by_name[run.name].append(run)
 
 
-def _wildcard_match(pattern: str, candidates: 'list[str]'):
+def _wildcard_match(pattern: str, candidates: "list[str]"):
     """Decides whether some element a pattern with Unix shell-style wildcards
     matches any candidate string.
 
@@ -376,9 +376,19 @@ def run():
             except KeyboardInterrupt:
                 _print_warning("aborted during experiment " + name)
         pool.close()
+
+    # If no runs were selected, we print a brief reminder message that names of
+    # runs should be passed via the command line to execute them.
+    any_selected = any(map(_is_selected, _state.runs_by_name.keys()))
+
     _state.run_completed = True
     _state = _State()
 
+    if not any_selected:
+        _print_warning(
+            f"Did not try to run experiments as none were passed via the command line."
+        )
+
 
 def use_cores(nr_cores):
     """Set the number of cores used to run the experiments.

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="run",
-    version="1.0.6",
+    version="1.0.7",
     description="python module for running experiments",
     url="https://github.com/thobl/run",
     author="Thomas Bläsius",