replbase 0.0.34__tar.gz → 0.0.36__tar.gz

{replbase-0.0.34 → replbase-0.0.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: replbase
-Version: 0.0.34
+Version: 0.0.36
 Summary: "Combination of other REPL tools into a reusable class that generates a REPL"
 License: MIT
 Author: Joseph Bochinski

{replbase-0.0.34 → replbase-0.0.36}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "replbase"
-version = "0.0.34"
+version = "0.0.36"
 description = "\"Combination of other REPL tools into a reusable class that generates a REPL\""
 authors = [ "Joseph Bochinski <stirgejr@gmail.com>",]
 license = "MIT"

{replbase-0.0.34 → replbase-0.0.36}/replbase/cmd_meta.py

@@ -86,7 +86,7 @@ class CommandMeta:
         self.type_hints = get_type_hints(self.func)
         self.sig_parms = dict(inspect.signature(self.func).parameters)
 
-        docstring = self.func.__doc__
+        docstring = self.get_docstring()
 
         header_re = re.compile(r"[A-Z].*?:$")
 
@@ -99,7 +99,7 @@ class CommandMeta:
 
         def get_header(header: str) -> str:
             nonlocal header_re
-            header_name = header_re.search(header).groups()[0]
+            header_name = header_re.findall(header)[0]
 
             return header_name.lower().replace(":", "")
 
@@ -122,6 +122,55 @@ class CommandMeta:
         self.parse_lines()
         self.parse_flags()
 
+    def get_docstring(self) -> str | None:
+        """Retrieve docstring from function or, if not available, from inherited classes
+
+        Returns:
+            str | None: Docstring value
+        """
+
+        if not self.func:
+            return
+
+        if hasattr(self.func, "__doc__") and self.func.__doc__:
+            return self.func.__doc__
+
+        if not hasattr(self.func, "__name__") or not hasattr(self.func, "__self__"):
+            return
+
+        fname = self.func.__name__
+        fn_self = getattr(self.func, "__self__")
+
+        if not hasattr(fn_self, "__class__"):
+            return
+
+        cls = getattr(fn_self, "__class__")
+        if not hasattr(cls, "__bases__"):
+            return
+
+        bases = getattr(cls, "__bases__")
+
+        cls_fn = getattr(cls, fname)
+
+        cls_sig = inspect.signature(cls_fn)
+
+        for base in bases:
+            if not hasattr(base, fname):
+                continue
+
+            base_fn = getattr(base, fname)
+
+            if not inspect.signature(base_fn) == cls_sig:
+                continue
+
+            if not hasattr(base_fn, "__doc__"):
+                continue
+
+            doc = getattr(base_fn, "__doc__")
+
+            if doc:
+                return doc
+
     def gen_command(self) -> ReplCommand:
         """Generate a ReplCommand object from the provided function
 

{replbase-0.0.34 → replbase-0.0.36}/replbase/repl_base.py

@@ -424,7 +424,7 @@ class ReplBase:
         if not callable(cmd):
             return
 
-        return CommandMeta(cmd).gen_command()
+        return CommandMeta(func=cmd, register_cmd=self.add_command).gen_command()
 
     def setup_cmds(self, *cmd_names: list[str]) -> None:
         """Automatically configure commands based on the provided names