Fix bug and improve test coverage. (#254)

Author: tobiasraabe

src/_pytask/__init__.py

@@ -3,7 +3,7 @@
 
 try:
     from ._version import version as __version__
-except ImportError:
+except ImportError:  # pragma: no cover
     # broken installation, we don't even try unknown only works because we do poor mans
     # version compare
     __version__ = "unknown"

src/_pytask/compat.py

@@ -71,7 +71,7 @@ def import_optional_dependency(
         version is too old and `errors` is ``'warn'``.
 
     """
-    if errors not in ("warn", "raise", "ignore"):
+    if errors not in ("warn", "raise", "ignore"):  # pragma: no cover
         raise ValueError("'errors' must be one of 'warn', 'raise' or 'ignore'.")
 
     package_name = _IMPORT_TO_PACKAGE_NAME.get(name)

src/_pytask/config.py

@@ -75,10 +75,14 @@ def is_file_system_case_sensitive() -> bool:
 
 
 _DEPRECATION_MESSAGE = """WARNING: pytask.ini, tox.ini, and setup.cfg will be \
-deprecated as configuration files for pytask starting with v0.3 or v1.0. To upgrade \
-and silence this warning, copy the content below in a pyproject.toml in the same \
-directory as your old configuration file. It is equivalent to your current \
-configuration.
+deprecated as configuration files for pytask starting with v0.3 or v1.0.
+
+To upgrade and silence this warning, copy the content below in a pyproject.toml in the \
+same directory as your old configuration file. This would be the path: {}. The content \
+is equivalent to your current configuration.
+
+Even if your configuration just has the header and no values, copy it. pytask needs \
+the header to determine the root of your project.
 """
 
 
@@ -109,10 +113,17 @@ def pytask_configure(
         config_from_file = read_config(config["config"])
 
         if read_config.__name__ == "_read_ini_config":
-            toml_string = tomli_w.dumps(
+            toml_string = "# Content of pyproject.toml\n\n" + tomli_w.dumps(
                 {"tool": {"pytask": {"ini_options": config_from_file}}}
             )
-            console.print(Text(_DEPRECATION_MESSAGE, style="warning"))
+            console.print(
+                Text(
+                    _DEPRECATION_MESSAGE.format(
+                        config["config"].with_name("pyproject.toml")
+                    ),
+                    style="warning",
+                )
+            )
             console.print(Syntax(toml_string, "toml"))
 
     # If paths are set in the configuration, process them.

src/_pytask/live.py

@@ -94,8 +94,9 @@ def pytask_post_parse(config: dict[str, Any]) -> None:
 
 @hookimpl(tryfirst=True)
 def pytask_execute_build(session: Session) -> None:
-    live_execution = session.config["pm"].get_plugin("live_execution")
-    live_execution.n_tasks = len(session.tasks)
+    if session.config["verbose"] >= 1:
+        live_execution = session.config["pm"].get_plugin("live_execution")
+        live_execution.n_tasks = len(session.tasks)
 
 
 @attr.s(eq=False)

src/_pytask/outcomes.py

@@ -42,16 +42,6 @@ class CollectionOutcome(Enum):
     SUCCESS = auto()
     FAIL = auto()
 
-    @property
-    def symbol(self) -> str:
-        """The symbol of an outcome."""
-        symbols = {
-            CollectionOutcome.SUCCESS: ".",
-            CollectionOutcome.FAIL: "F",
-        }
-        assert len(symbols) == len(CollectionOutcome)
-        return symbols[self]
-
     @property
     def description(self) -> str:
         """A description of an outcome used in the summary panel."""

src/_pytask/profile.py

@@ -131,7 +131,7 @@ def profile(**config_from_cli: Any) -> NoReturn:
         config = pm.hook.pytask_configure(pm=pm, config_from_cli=config_from_cli)
         session = Session.from_config(config)
 
-    except (ConfigurationError, Exception):
+    except (ConfigurationError, Exception):  # pragma: no cover
         session = Session({}, None)
         session.exit_code = ExitCode.CONFIGURATION_FAILED
         exc_info: tuple[
@@ -159,10 +159,10 @@ def profile(**config_from_cli: Any) -> NoReturn:
 
             console.rule(style="neutral")
 
-        except CollectionError:
+        except CollectionError:  # pragma: no cover
             session.exit_code = ExitCode.COLLECTION_FAILED
 
-        except Exception:
+        except Exception:  # pragma: no cover
             session.exit_code = ExitCode.FAILED
             console.print_exception()
             console.rule(style="failed")
@@ -288,7 +288,7 @@ def pytask_profile_export_profile(
             _export_to_json(profile)
         elif export == _ExportFormats.NO:
             pass
-        else:
+        else:  # pragma: no cover
             raise ValueError(f"The export option {export.value!r} cannot be handled.")
 
 

src/_pytask/traceback.py

@@ -34,7 +34,9 @@ def render_exc_info(
     traceback: str | TracebackType,
     show_locals: bool = False,
 ) -> str | Traceback:
-    if isinstance(traceback, str):
+    """Render an exception info."""
+    # Can be string if send from subprocess by pytask-parallel.
+    if isinstance(traceback, str):  # pragma: no cover
         renderable = traceback
     else:
         renderable = Traceback.from_exception(

tests/_test_console_helpers.py

@@ -5,7 +5,7 @@
 
 def empty_decorator(func):
     @functools.wraps(func)
-    def wrapped():
+    def wrapped():  # pragma: no cover
         return func()
 
     return wrapped

tests/test_capture.py

@@ -56,7 +56,7 @@ def task_show_capture():
         assert "xxxx" in result.output
         assert "Captured stderr" in result.output
         assert "zzzz" in result.output
-    else:
+    else:  # pragma: no cover
         raise NotImplementedError
 
 
@@ -360,7 +360,11 @@ def lsof_check():
     pid = os.getpid()
     try:
         out = subprocess.check_output(("lsof", "-p", str(pid))).decode()
-    except (OSError, subprocess.CalledProcessError, UnicodeDecodeError) as exc:
+    except (
+        OSError,
+        subprocess.CalledProcessError,
+        UnicodeDecodeError,
+    ) as exc:  # pragma: no cover
         # about UnicodeDecodeError, see note on pytester
         pytest.skip(f"could not run 'lsof' ({exc!r})")
     yield

tests/test_cli.py

@@ -19,13 +19,13 @@ def test_version_option():
 @pytest.mark.parametrize(
     "commands",
     [
-        ("pytask",),
-        ("pytask", "build"),
-        ("pytask", "clean"),
-        ("pytask", "collect"),
-        ("pytask", "dag"),
-        ("pytask", "markers"),
-        ("pytask", "profile"),
+        (),
+        ("build"),
+        ("clean"),
+        ("collect"),
+        ("dag"),
+        ("markers"),
+        ("profile"),
     ],
 )
 def test_help_pages(runner, commands, help_option):

tests/test_collect_utils.py

@@ -116,7 +116,7 @@ def test_merge_dictionaries(list_of_dicts, expected):
 )
 def test_extract_args_from_mark(decorator, values, expected):
     @decorator(values)
-    def task_example():
+    def task_example():  # pragma: no cover
         pass
 
     parser = depends_on if decorator.name == "depends_on" else produces
@@ -136,7 +136,7 @@ def task_example():
 )
 def test_extract_kwargs_from_mark(decorator, values, expected):
     @decorator(**values)
-    def task_example():
+    def task_example():  # pragma: no cover
         pass
 
     parser = depends_on if decorator.name == "depends_on" else produces
@@ -153,7 +153,7 @@ def test_raise_error_for_invalid_args_to_depends_on_and_produces(
     decorator, args, kwargs
 ):
     @decorator(*args, **kwargs)
-    def task_example():
+    def task_example():  # pragma: no cover
         pass
 
     parser = depends_on if decorator.name == "depends_on" else produces

tests/test_debugging.py

@@ -13,7 +13,7 @@
 
 try:
     import pexpect
-except ModuleNotFoundError:
+except ModuleNotFoundError:  # pragma: no cover
     IS_PEXPECT_INSTALLED = False
 else:
     IS_PEXPECT_INSTALLED = True

tests/test_graph.py

@@ -11,7 +11,7 @@
 
 try:
     import pydot  # noqa: F401
-except ImportError:
+except ImportError:  # pragma: no cover
     _IS_PYDOT_INSTALLED = False
 else:
     _IS_PYDOT_INSTALLED = True
@@ -39,7 +39,7 @@
 @pytest.mark.parametrize("format_", _TEST_FORMATS)
 @pytest.mark.parametrize("rankdir", ["LR"])
 def test_create_graph_via_cli(tmp_path, runner, format_, layout, rankdir):
-    if sys.platform == "win32" and format_ == "pdf":
+    if sys.platform == "win32" and format_ == "pdf":  # pragma: no cover
         pytest.xfail("gvplugin_pango.dll might be missing on Github Actions.")
 
     source = """
@@ -75,7 +75,7 @@ def task_example(): pass
 @pytest.mark.parametrize("format_", _TEST_FORMATS)
 @pytest.mark.parametrize("rankdir", [_RankDirection.LR.value, _RankDirection.TB])
 def test_create_graph_via_task(tmp_path, runner, format_, layout, rankdir):
-    if sys.platform == "win32" and format_ == "pdf":
+    if sys.platform == "win32" and format_ == "pdf":  # pragma: no cover
         pytest.xfail("gvplugin_pango.dll might be missing on Github Actions.")
 
     rankdir_str = rankdir if isinstance(rankdir, str) else rankdir.name

tests/test_live.py

@@ -43,19 +43,16 @@ def test_parse_n_entries_in_table(value, expectation, expected):
 
 
 @pytest.mark.end_to_end
-@pytest.mark.parametrize("verbose", [False, True])
+@pytest.mark.parametrize("verbose", [0, 1])
 def test_verbose_mode_execution(tmp_path, runner, verbose):
     source = "def task_example(): pass"
     tmp_path.joinpath("task_module.py").write_text(textwrap.dedent(source))
 
-    args = [tmp_path.as_posix()]
-    if not verbose:
-        args.append("-v 0")
-    result = runner.invoke(cli, args)
+    result = runner.invoke(cli, [tmp_path.as_posix(), "--verbose", verbose])
 
-    assert ("Task" in result.output) is verbose
-    assert ("Outcome" in result.output) is verbose
-    assert ("task_module.py::task_example" in result.output) is verbose
+    assert ("Task" in result.output) is (verbose >= 1)
+    assert ("Outcome" in result.output) is (verbose >= 1)
+    assert ("task_module.py::task_example" in result.output) is (verbose >= 1)
 
 
 @pytest.mark.unit

tests/test_mark.py

@@ -27,7 +27,7 @@ def test_pytask_mark_notcallable() -> None:
 @pytest.mark.unit
 @pytest.mark.filterwarnings("ignore:Unknown pytask.mark.foo")
 def test_mark_with_param():
-    def some_function():
+    def some_function():  # pragma: no cover
         pass
 
     class SomeClass:

tests/test_parametrize.py

@@ -32,7 +32,7 @@ def session():
 @pytest.mark.integration
 def test_pytask_generate_tasks_0(session):
     @pytask.mark.parametrize("i", range(2))
-    def func(i):  # noqa: U100
+    def func(i):  # noqa: U100, pragma: no cover
         pass
 
     names_and_objs = pytask_parametrize_task(session, "func", func)
@@ -47,7 +47,7 @@ def func(i):  # noqa: U100
 def test_pytask_generate_tasks_1(session):
     @pytask.mark.parametrize("j", range(2))
     @pytask.mark.parametrize("i", range(2))
-    def func(i, j):  # noqa: U100
+    def func(i, j):  # noqa: U100, pragma: no cover
         pass
 
     pytask_parametrize_task(session, "func", func)
@@ -58,7 +58,7 @@ def func(i, j):  # noqa: U100
 def test_pytask_generate_tasks_2(session):
     @pytask.mark.parametrize("j, k", itertools.product(range(2), range(2)))
     @pytask.mark.parametrize("i", range(2))
-    def func(i, j, k):  # noqa: U100
+    def func(i, j, k):  # noqa: U100, pragma: no cover
         pass
 
     pytask_parametrize_task(session, "func", func)

tests/test_task.py

@@ -338,7 +338,6 @@ def task_example(produces):
 
 
 @pytest.mark.end_to_end
-@pytest.mark.xfail(reason="Partialed functions are not supported.")
 def test_task_function_with_partialed_args(tmp_path, runner):
     source = """
     import pytask
@@ -355,9 +354,8 @@ def func(produces, content):
 
     result = runner.invoke(cli, [tmp_path.as_posix()])
 
-    assert result.exit_code == ExitCode.OK
-    assert "task_func" in result.output
-    assert "1  Skipped" in result.output
+    assert result.exit_code == ExitCode.FAILED
+    assert "TypeError: module, class, method" in result.output
 
 
 @pytest.mark.end_to_end