Refactorings related to ExitCode. (#188)

Author: tobiasraabe

docs/source/changes.rst

@@ -11,6 +11,7 @@ all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
 ------------------
 
 - :gh:`186` enhance live displays by deactivating auto-refresh among other things.
+- :gh:`188` refactors some code related to :class:`_pytask.enums.ExitCode`.
 
 
 0.1.4 - 2022-01-04

src/_pytask/build.py

@@ -7,11 +7,11 @@
 import click
 from _pytask.config import hookimpl
 from _pytask.console import console
-from _pytask.enums import ExitCode
 from _pytask.exceptions import CollectionError
 from _pytask.exceptions import ConfigurationError
 from _pytask.exceptions import ExecutionError
 from _pytask.exceptions import ResolvingDependenciesError
+from _pytask.outcomes import ExitCode
 from _pytask.pluginmanager import get_plugin_manager
 from _pytask.session import Session
 

src/_pytask/clean.py

@@ -20,9 +20,9 @@
 from _pytask.config import hookimpl
 from _pytask.config import IGNORED_TEMPORARY_FILES_AND_FOLDERS
 from _pytask.console import console
-from _pytask.enums import ExitCode
 from _pytask.exceptions import CollectionError
 from _pytask.nodes import MetaTask
+from _pytask.outcomes import ExitCode
 from _pytask.path import find_common_ancestor
 from _pytask.path import relative_to
 from _pytask.pluginmanager import get_plugin_manager

src/_pytask/collect_command.py

@@ -15,12 +15,12 @@
 from _pytask.console import format_task_id
 from _pytask.console import PYTHON_ICON
 from _pytask.console import TASK_ICON
-from _pytask.enums import ExitCode
 from _pytask.exceptions import CollectionError
 from _pytask.exceptions import ConfigurationError
 from _pytask.exceptions import ResolvingDependenciesError
 from _pytask.mark import select_by_keyword
 from _pytask.mark import select_by_mark
+from _pytask.outcomes import ExitCode
 from _pytask.path import find_common_ancestor
 from _pytask.path import relative_to
 from _pytask.pluginmanager import get_plugin_manager

src/_pytask/enums.py

@@ -13,10 +13,10 @@
 from _pytask.config import hookimpl
 from _pytask.console import console
 from _pytask.dag import descending_tasks
-from _pytask.enums import ExitCode
 from _pytask.exceptions import CollectionError
 from _pytask.exceptions import ConfigurationError
 from _pytask.exceptions import ResolvingDependenciesError
+from _pytask.outcomes import ExitCode
 from _pytask.pluginmanager import get_plugin_manager
 from _pytask.session import Session
 from _pytask.shared import get_first_non_none_value

src/_pytask/graph.py

@@ -265,20 +265,24 @@ class LiveCollection:
 
     @hookimpl(hookwrapper=True)
     def pytask_collect(self) -> Generator[None, None, None]:
+        """Start the status of the cllection."""
         self._live_manager.start()
         yield
 
     @hookimpl
     def pytask_collect_file_log(self, reports: List[CollectionReport]) -> None:
+        """Update the status after a file is collected."""
         self._update_statistics(reports)
         self._update_status()
 
     @hookimpl(hookwrapper=True)
     def pytask_collect_log(self) -> Generator[None, None, None]:
+        """Stop the live display when all tasks have been collected."""
         self._live_manager.stop(transient=True)
         yield
 
     def _update_statistics(self, reports: List[CollectionReport]) -> None:
+        """Update the statistics on collected tasks and errors."""
         if reports is None:
             reports = []
         for report in reports:
@@ -288,10 +292,12 @@ def _update_statistics(self, reports: List[CollectionReport]) -> None:
                 self._n_errors += 1
 
     def _update_status(self) -> None:
+        """Update the status."""
         status = self._generate_status()
         self._live_manager.update(status)
 
     def _generate_status(self) -> Status:
+        """Generate the status."""
         msg = f"Collected {self._n_collected_tasks} tasks."
         if self._n_errors > 0:
             msg += f" {self._n_errors} errors."

src/_pytask/live.py

@@ -56,6 +56,7 @@ def pytask_parse_config(
     config_from_file: Dict[str, Any],
     config_from_cli: Dict[str, Any],
 ) -> None:
+    """Parse configuration."""
     config["show_locals"] = get_first_non_none_value(
         config_from_cli,
         config_from_file,
@@ -138,6 +139,7 @@ def pytask_log_session_footer(
 
 
 def _format_duration(duration: float) -> str:
+    """Format the duration."""
     duration_tuples = _humanize_time(duration, "seconds", short_label=False)
 
     # Remove seconds if the execution lasted days or hours.

src/_pytask/logging.py

@@ -11,7 +11,6 @@
 from _pytask.config import hookimpl
 from _pytask.console import console
 from _pytask.dag import task_and_preceding_tasks
-from _pytask.enums import ExitCode
 from _pytask.exceptions import ConfigurationError
 from _pytask.mark.expression import Expression
 from _pytask.mark.expression import ParseError
@@ -20,6 +19,7 @@
 from _pytask.mark.structures import MarkDecorator
 from _pytask.mark.structures import MarkGenerator
 from _pytask.nodes import MetaTask
+from _pytask.outcomes import ExitCode
 from _pytask.pluginmanager import get_plugin_manager
 from _pytask.session import Session
 from _pytask.shared import convert_truthy_or_falsy_to_bool

src/_pytask/mark/__init__.py

@@ -1,6 +1,7 @@
 """This module contains code related to outcomes."""
 from enum import auto
 from enum import Enum
+from enum import IntEnum
 from typing import Dict
 from typing import Optional
 from typing import Sequence
@@ -99,6 +100,7 @@ class TaskOutcome(Enum):
 
     @property
     def symbol(self) -> str:
+        """The symbol of an outcome."""
         symbols = {
             TaskOutcome.SUCCESS: ".",
             TaskOutcome.PERSISTENCE: "p",
@@ -112,6 +114,7 @@ def symbol(self) -> str:
 
     @property
     def description(self) -> str:
+        """A description of an outcome used in the summary panel."""
         descriptions = {
             TaskOutcome.SUCCESS: "Succeeded",
             TaskOutcome.PERSISTENCE: "Persisted",
@@ -125,6 +128,7 @@ def description(self) -> str:
 
     @property
     def style(self) -> str:
+        """Return the style of an outcome."""
         styles = {
             TaskOutcome.SUCCESS: "success",
             TaskOutcome.PERSISTENCE: "success",
@@ -138,6 +142,7 @@ def style(self) -> str:
 
     @property
     def style_textonly(self) -> str:
+        """Return the style of an outcome when only the text is colored."""
         styles_textonly = {
             TaskOutcome.SUCCESS: "success.textonly",
             TaskOutcome.PERSISTENCE: "success.textonly",
@@ -169,6 +174,24 @@ def count_outcomes(
     }
 
 
+class ExitCode(IntEnum):
+    """Exit codes for pytask."""
+
+    OK = 0
+    """Tasks were executed successfully."""
+
+    FAILED = 1
+    """Failed while executing tasks."""
+
+    CONFIGURATION_FAILED = 2
+
+    COLLECTION_FAILED = 3
+    """Failed while collecting tasks."""
+
+    RESOLVING_DEPENDENCIES_FAILED = 4
+    """Failed while resolving dependencies."""
+
+
 class PytaskOutcome(Exception):
     """Base outcome of a task."""