fixes #791

Author: jph00

fastcore/docments.py

@@ -28,6 +28,7 @@ def docstring(sym):
     if isinstance(sym, str): return sym
     res = getdoc(sym)
     if not res and isclass(sym): res = getdoc(sym.__init__)
+    if not res and callable(sym) and not isclass(sym): res = getdoc(sym.__call__)
     return res or ""
 
 # %% ../nbs/04_docments.ipynb #1e0cf854
@@ -140,8 +141,10 @@ def get_name(obj):
     elif getattr(obj, '_name', False): return obj._name
     elif hasattr(obj,'__origin__'):    return str(obj.__origin__).split('.')[-1]
     elif type(obj)==property:          return _get_property_name(obj)
+    elif callable(obj):                return type(obj).__name__
     else:                              return str(obj).split('.')[-1]
 
+
 # %% ../nbs/04_docments.ipynb #5e273f22
 def qual_name(obj):
     "Get the qualified name of `obj`"
@@ -364,10 +367,14 @@ def _ret_str(self):
     def params(self): return [(self._fmt_param(k,v), v.get('docment','')) for k,v in self.dm.items() if k != 'return']
 
     def __str__(self):
-        prefix = 'async def' if inspect.iscoroutinefunction(self.obj) else 'def'
-        if (sig := _clean_text_sig(self.obj)) and not self.params: sig_str = f"{prefix} {sig}"
-        else: sig_str = _fmt_sig(get_name(self.obj), self.params, self._ret_str, self.maxline, prefix=prefix)
-        docstr = f'    "{self.obj.__doc__}"' if self.docstring and self.obj.__doc__ else ''
+        o = self.obj
+        is_inst = callable(o) and not (isfunction(o) or isclass(o) or inspect.isbuiltin(o) or ismethod(o))
+        prefix = 'async def' if inspect.iscoroutinefunction(o) else 'def'
+        nm = f'{type(o).__name__}.__call__' if is_inst else get_name(o)
+        if (sig := _clean_text_sig(o)) and not self.params: sig_str = f"{prefix} {sig}"
+        else: sig_str = _fmt_sig(nm, self.params, self._ret_str, self.maxline, prefix=prefix)
+        doc = getattr(o.__call__, '__doc__', None) if is_inst else o.__doc__
+        docstr = f'    "{doc}"' if self.docstring and doc else ''
         return f"{sig_str}\n{docstr}"
 
     __repr__ = __str__

nbs/02_foundation.ipynb

@@ -4473,13 +4473,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "python3",
-   "language": "python",
-   "name": "python3"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
  "nbformat_minor": 5
 }

nbs/04_docments.ipynb

@@ -159,6 +159,7 @@
     "    if isinstance(sym, str): return sym\n",
     "    res = getdoc(sym)\n",
     "    if not res and isclass(sym): res = getdoc(sym.__init__)\n",
+    "    if not res and callable(sym) and not isclass(sym): res = getdoc(sym.__call__)\n",
     "    return res or \"\""
    ]
   },
@@ -414,7 +415,8 @@
     "    elif getattr(obj, '_name', False): return obj._name\n",
     "    elif hasattr(obj,'__origin__'):    return str(obj.__origin__).split('.')[-1]\n",
     "    elif type(obj)==property:          return _get_property_name(obj)\n",
-    "    else:                              return str(obj).split('.')[-1]"
+    "    elif callable(obj):                return type(obj).__name__\n",
+    "    else:                              return str(obj).split('.')[-1]\n"
    ]
   },
   {
@@ -2187,10 +2189,14 @@
     "    def params(self): return [(self._fmt_param(k,v), v.get('docment','')) for k,v in self.dm.items() if k != 'return']\n",
     "\n",
     "    def __str__(self):\n",
-    "        prefix = 'async def' if inspect.iscoroutinefunction(self.obj) else 'def'\n",
-    "        if (sig := _clean_text_sig(self.obj)) and not self.params: sig_str = f\"{prefix} {sig}\"\n",
-    "        else: sig_str = _fmt_sig(get_name(self.obj), self.params, self._ret_str, self.maxline, prefix=prefix)\n",
-    "        docstr = f'    \"{self.obj.__doc__}\"' if self.docstring and self.obj.__doc__ else ''\n",
+    "        o = self.obj\n",
+    "        is_inst = callable(o) and not (isfunction(o) or isclass(o) or inspect.isbuiltin(o) or ismethod(o))\n",
+    "        prefix = 'async def' if inspect.iscoroutinefunction(o) else 'def'\n",
+    "        nm = f'{type(o).__name__}.__call__' if is_inst else get_name(o)\n",
+    "        if (sig := _clean_text_sig(o)) and not self.params: sig_str = f\"{prefix} {sig}\"\n",
+    "        else: sig_str = _fmt_sig(nm, self.params, self._ret_str, self.maxline, prefix=prefix)\n",
+    "        doc = getattr(o.__call__, '__doc__', None) if is_inst else o.__doc__\n",
+    "        docstr = f'    \"{doc}\"' if self.docstring and doc else ''\n",
     "        return f\"{sig_str}\\n{docstr}\"\n",
     "    \n",
     "    __repr__ = __str__\n",
@@ -2303,7 +2309,7 @@
      "data": {
       "text/markdown": [
        "```python\n",
-       "def _g[partial: 1](\n",
+       "def partial.__call__(\n",
        "    b:int, cccccccccccccccccccc:int, ccccccccdccccccccccc:int,\n",
        "    cccccccccccecccccccc:int, cccccccfcccccccccc:int, ccccccccccccgccccc:int,\n",
        "    c:str='foo'\n",
@@ -2312,7 +2318,7 @@
        "```"
       ],
       "text/plain": [
-       "def _g[partial: 1](\n",
+       "def partial.__call__(\n",
        "    b:int, cccccccccccccccccccc:int, ccccccccdccccccccccc:int,\n",
        "    cccccccccccecccccccc:int, cccccccfcccccccccc:int, ccccccccccccgccccc:int,\n",
        "    c:str='foo'\n",
@@ -2598,18 +2604,18 @@
        "):\n",
        "\n",
        "\n",
-       "```"
+       "```\n",
+       "\n",
+       "*Call self as a function.*"
       ],
       "text/plain": [
-       "```python\n",
-       "\n",
        "def g(\n",
        "    b:int | str, # bb\n",
        "    a:int=0, # aa\n",
        "):\n",
-       "\n",
-       "\n",
-       "```"
+       "\"\"\"\n",
+       "Call self as a function.\n",
+       "\"\"\""
       ]
      },
      "execution_count": null,
@@ -2644,18 +2650,14 @@
        "*Add `a` to `b`*"
       ],
       "text/plain": [
-       "```python\n",
-       "\n",
        "async def add_async(\n",
        "    a:int, # The first operand\n",
        "    b:int, # This is the second of the operands to the *addition* operator.\n",
        "Note that passing a negative value here is the equivalent of the *subtraction* operator.\n",
        ")->int: # The result is calculated using Python's builtin `+` operator.\n",
-       "\n",
-       "\n",
-       "```\n",
-       "\n",
-       "*Add `a` to `b`*"
+       "\"\"\"\n",
+       "Add `a` to `b`\n",
+       "\"\"\""
       ]
      },
      "execution_count": null,
@@ -2689,17 +2691,13 @@
        "it is returned instead of raising StopIteration."
       ],
       "text/plain": [
-       "```python\n",
-       "\n",
        "def next(iterator, default=..., /)\n",
-       "\n",
-       "\n",
-       "```\n",
-       "\n",
-       "*Return the next item from the iterator.*\n",
+       "\"\"\"\n",
+       "Return the next item from the iterator.\n",
        "\n",
        "If default is given and the iterator is exhausted,\n",
-       "it is returned instead of raising StopIteration."
+       "it is returned instead of raising StopIteration.\n",
+       "\"\"\""
       ]
      },
      "execution_count": null,
@@ -2782,6 +2780,50 @@
     "assert 'x:int' not in str(_r3.dm), \"Original params should not leak through\""
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e7eaff97",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/markdown": [
+       "```python\n",
+       "\n",
+       "def Foo.__call__(\n",
+       "    x\n",
+       "):\n",
+       "\n",
+       "\n",
+       "```\n",
+       "\n",
+       "*Call foo*"
+      ],
+      "text/plain": [
+       "def Foo.__call__(\n",
+       "    x\n",
+       "):\n",
+       "\"\"\"\n",
+       "Call foo\n",
+       "\"\"\""
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "class Foo:\n",
+    "    def __call__(self, x):\n",
+    "        \"Call foo\"\n",
+    "        return x\n",
+    "\n",
+    "foo = Foo()\n",
+    "MarkdownRenderer(foo)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "51a04f95",