Add sort_table option (#261)

Author: timmens

docs/source/changes.md

@@ -7,6 +7,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 
 ## 0.2.1 - 2022-xx-xx
 
+- {pull}`261` adds a config file option to sort entries in live table
 - {pull}`259` adds an `.svg` for profiling tasks.
 
 ## 0.2.0 - 2022-04-14

docs/source/reference_guides/configuration.md

@@ -144,6 +144,18 @@ n_entries_in_table = "all"  # default 15
 
 ````
 
+````{confval} sort_table
+
+You can decide whether the entries displayed in the live table are sorted alphabetically
+once all tasks have been executed, which can be helpful when working with many tasks.
+Use either `true` or `false`. This option is only supported in the configuration file.
+
+```toml
+sort_table = false  # default: true
+```
+
+````
+
 ````{confval} paths
 
 If you want to collect tasks from specific paths without passing the names via the

src/_pytask/config.py

@@ -246,6 +246,10 @@ def pytask_parse_config(
         callback=lambda x: x if x is None else int(x),
     )
 
+    config["sort_table"] = convert_truthy_or_falsy_to_bool(
+        config_from_file.get("sort_table", True)
+    )
+
 
 @hookimpl
 def pytask_post_parse(config: dict[str, Any]) -> None:

src/_pytask/live.py

@@ -85,6 +85,7 @@ def pytask_post_parse(config: dict[str, Any]) -> None:
             n_entries_in_table=config["n_entries_in_table"],
             verbose=config["verbose"],
             editor_url_scheme=config["editor_url_scheme"],
+            sort_final_table=config["sort_table"],
         )
         config["pm"].register(live_execution, "live_execution")
 
@@ -156,6 +157,7 @@ class LiveExecution:
     n_entries_in_table = attr.ib(type=int)
     verbose = attr.ib(type=int)
     editor_url_scheme = attr.ib(type=str)
+    sort_final_table = attr.ib(default=False, type=bool)
     n_tasks = attr.ib(default="x", type=Union[int, str])
     _reports = attr.ib(factory=list, type=List[Dict[str, Any]])
     _running_tasks = attr.ib(factory=dict, type=Dict[str, Task])
@@ -168,7 +170,7 @@ def pytask_execute_build(self) -> Generator[None, None, None]:
         yield
         self.live_manager.stop(transient=True)
         table = self._generate_table(
-            reduce_table=False, sort_table=True, add_caption=False
+            reduce_table=False, sort_table=self.sort_final_table, add_caption=False
         )
         if table is not None:
             console.print(table)

tests/test_live.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import re
 import textwrap
 from contextlib import ExitStack as does_not_raise  # noqa: N813
 
@@ -306,6 +307,35 @@ def task_create_file(produces):
         assert f"{i}.txt" in result.output
 
 
+@pytest.mark.end_to_end
+@pytest.mark.parametrize("sort_table", [True, False])
+def test_sort_table_option(tmp_path, runner, sort_table):
+    source = """
+    import pytask
+
+    def task_a(produces):
+        pass
+
+    @pytask.mark.try_first
+    def task_b():
+        pass
+
+    """
+    tmp_path.joinpath("task_order.py").write_text(textwrap.dedent(source))
+
+    config = f"[tool.pytask.ini_options]\nsort_table = '{sort_table}'"
+    tmp_path.joinpath("pyproject.toml").write_text(textwrap.dedent(config))
+
+    result = runner.invoke(cli, [tmp_path.as_posix()])
+    assert result.exit_code == ExitCode.OK
+
+    lines = result.output.split("\n")
+    task_names = [re.findall("task_[a|b]", line) for line in lines]
+    task_names = [name[0][-1] for name in task_names if name != []]
+    expected = ["a", "b"] if sort_table else ["b", "a"]
+    assert expected == task_names
+
+
 @pytest.mark.end_to_end
 def test_execute_w_partialed_functions(tmp_path, runner):
     """Test with partialed function which make it harder to extract info.