0.7.3 (#159)

* ✨ Add `--list` for `pipen profile` to list the names of available profiles

* ✨ Add exception hook to show uncaught in log

* ✨ Add `on_job_cached` hook

* 🔖 0.7.3

docs/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 0.7.3
+
+- ✨ Add `--list` for `pipen profile` to list the names of available profiles
+- ✨ Add exception hook to show uncaught in log
+- ✨ Add `on_job_cached` hook
+
+## 0.7.2
+
+- ✨ Add `utils.mark` and `get_marked` to mark a process
+    Unlike plugin_opts, template_opts or envs, these marks are not inherited in subclasses
+
 ## 0.7.1
 
 - ⬆️ Upgrade simplug to 0.2.3

pipen/cli/profile.py

@@ -35,6 +35,13 @@ def __init__(
             default="",
             help="The name of the profile to show. Show all if not provided.",
         )
+        subparser.add_argument(
+            "-l",
+            "--list",
+            action="store_true",
+            default=False,
+            help="List the names of all available profiles (-n won't work).",
+        )
 
     def exec_command(self, args: Namespace) -> None:
         """Run the command"""
@@ -45,6 +52,10 @@ def exec_command(self, args: Namespace) -> None:
             ignore_nonexist=True,
         )
 
+        if args.list:
+            print("\n".join(ProfileConfig.profiles(config)))
+            return
+
         print("Configurations loaded from:")
         print("- pipen.defaults.CONFIG (python dictionary)")
         for conffile in reversed(CONFIG_FILES):

pipen/pluginmgr.py

@@ -214,6 +214,16 @@ async def on_job_succeeded(proc: Proc, job: Job):
     """
 
 
+@plugin.spec
+async def on_job_cached(proc: Proc, job: Job):
+    """When a job is cached.
+
+    Args:
+        proc: The process
+        job: The job
+    """
+
+
 @plugin.spec
 async def on_job_failed(proc: Proc, job: Job):
     """When a job is done but failed.

pipen/proc.py

@@ -459,6 +459,7 @@ async def run(self) -> None:
                 self.pbar.update_job_running()
                 self.pbar.update_job_succeeded()
                 job.status = JobStatus.FINISHED
+                await plugin.hooks.on_job_cached(self, job)
             else:
                 await self.xqute.put(job)
         if cached_jobs:

pipen/utils.py

@@ -1,8 +1,10 @@
 """Provide some utilities"""
 from __future__ import annotations
 
+import sys
 import logging
 import textwrap
+import typing
 from itertools import groupby
 from operator import itemgetter
 from io import StringIO
@@ -21,6 +23,8 @@
     Type,
 )
 
+import diot
+import simplug
 from rich.console import Console
 from rich.logging import RichHandler as _RichHandler
 from rich.table import Table
@@ -106,12 +110,33 @@ def _render_buffer(self, buffer: Iterable[Segment]) -> str:
     omit_repeated_times=False,  # rich 10+
     markup=True,
     log_time_format="%m-%d %H:%M:%S",
+    tracebacks_extra_lines=0,
+    tracebacks_suppress=[simplug, diot, typing],
 )
 _logger_handler.setFormatter(
     logging.Formatter("[purple]%(plugin_name)-7s[/purple] %(message)s")
 )
 
 
+def _excepthook(
+    type_: Type[BaseException],
+    value: BaseException,
+    traceback: Any,
+) -> None:
+    """The excepthook for pipen, to show rich traceback"""
+    if type_ is KeyboardInterrupt:  # pragma: no cover
+        logger.error("Interrupted by user")
+        return
+
+    logger.exception(
+        f"{type_.__name__}: {value}",
+        exc_info=(type_, value, traceback),
+    )
+
+
+sys.excepthook = _excepthook
+
+
 def get_logger(
     name: str = LOGGER_NAME,
     level: str | int = None,

pipen/version.py

@@ -1,3 +1,3 @@
 """Provide version of pipen"""
 
-__version__ = "0.7.2"
+__version__ = "0.7.3"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "pipen"
-version = "0.7.2"
+version = "0.7.3"
 description = "A pipeline framework for python"
 authors = [ "pwwang <[email protected]>",]
 license = "MIT"

tests/test_cli.py

@@ -37,6 +37,8 @@ def test_help():
 def test_profile_all():
     out = cmdoutput(["pipen", "profile"])
     assert "Note:" in out
+    out = cmdoutput(["pipen", "profile", "--list"])
+    assert "default" in out
 
 
 def test_profile_default():