0.9.7 (#168)

* 🔧 Allow to inherit doc from base class for Pipen/Proc

* 🔖 0.9.7

docs/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.9.7
+
+- 🔧 Allow to inherit doc from base class for Pipen/Proc
+
 ## 0.9.6
 
 - 🎨 Let plugins change and create workdir

pipen/pipen.py

@@ -101,7 +101,9 @@ def __init__(
             )
 
         self.desc = (
-            desc or self.__class__.desc or desc_from_docstring(self.__class__)
+            desc
+            or self.__class__.desc
+            or desc_from_docstring(self.__class__, Pipen)
         )
         self.outdir = Path(
             outdir or self.__class__.outdir or f"./{self.name}-output"

pipen/proc.py

@@ -330,7 +330,7 @@ def __init__(self, pipeline: Pipen = None) -> None:
         # Compute the properties
         # otherwise, the property can be accessed directly from class vars
         if self.desc is None:
-            self.desc: str = desc_from_docstring(self.__class__)
+            self.desc: str = desc_from_docstring(self.__class__, Proc)
 
         if self.export is None:
             self.export = bool(not self.nexts)

pipen/utils.py

@@ -49,6 +49,7 @@
     from rich.segment import Segment
     from rich.console import RenderableType
 
+    from .pipen import Pipen
     from .proc import Proc
 
 
@@ -152,7 +153,10 @@ def get_logger(
 logger = get_logger()
 
 
-def desc_from_docstring(obj: Any) -> str:
+def desc_from_docstring(
+    obj: Type[Pipen | Proc],
+    base: Type[Pipen | Proc],
+) -> str:
     """Get the description from docstring
 
     Only extract the summary.
@@ -163,8 +167,18 @@ def desc_from_docstring(obj: Any) -> str:
     Returns:
         The summary as desc
     """
-    if not obj.__doc__:  # pragma: no cover
-        return None
+    if not obj.__doc__:
+        # If the docstring is empty, use the base's docstring
+        # Get the base from mro
+        bases = [
+            cls
+            for cls in obj.__mro__
+            if is_subclass(cls, base) and cls != base and cls != obj
+        ]
+        if not bases:
+            return None
+
+        return desc_from_docstring(bases[0], base)
 
     started: bool = False
     out: List[str] = []

pipen/version.py

@@ -1,3 +1,3 @@
 """Provide version of pipen"""
 
-__version__ = "0.9.6"
+__version__ = "0.9.7"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "pipen"
-version = "0.9.6"
+version = "0.9.7"
 description = "A pipeline framework for python"
 authors = [ "pwwang <[email protected]>",]
 license = "MIT"
@@ -16,7 +16,7 @@ repository = "https://github.com/pwwang/pipen"
 generate-setup-file = true
 
 [tool.poetry.dependencies]
-python = "^3.8" # align with datar/pandas
+python = "^3.8"
 liquidpy = "^0.8"
 pandas = "^1.4"
 enlighten = "^1"

tests/test_utils.py

@@ -50,15 +50,18 @@ def test_get_mtime_dir():
 
 
 def test_desc_from_docstring():
-    def obj1():
+    class Base:
+        ...
+
+    class Obj1(Base):
         """
 
         abc
         def
 
         """
 
-    desc = desc_from_docstring(obj1)
+    desc = desc_from_docstring(Obj1, Base)
     assert desc == "abc def"