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):