fixes #748

Author: jph00

fastcore/basics.py

@@ -2,12 +2,12 @@
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/04_docments.ipynb.
 
-# %% auto 0
+# %% auto #0
 __all__ = ['empty', 'docstring', 'parse_docstring', 'isdataclass', 'get_dataclass_source', 'get_source', 'get_name', 'qual_name',
            'docments', 'sig_source', 'extract_docstrings', 'DocmentTbl', 'DocmentList', 'DocmentText', 'sig2str',
            'ShowDocRenderer', 'MarkdownRenderer']
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #4c662acc
 import re,ast,inspect
 from tokenize import tokenize,COMMENT
 from ast import parse,FunctionDef,AsyncFunctionDef,AnnAssign
@@ -22,36 +22,36 @@
 from textwrap import fill
 from inspect import isclass,getdoc,signature
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #53e21187
 def docstring(sym):
     "Get docstring for `sym` for functions ad classes"
     if isinstance(sym, str): return sym
     res = getdoc(sym)
     if not res and isclass(sym): res = getdoc(sym.__init__)
     return res or ""
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #1e0cf854
 def parse_docstring(sym):
     "Parse a numpy-style docstring in `sym`"
     return AttrDict(**docscrape.NumpyDocString(docstring(sym)))
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #b1a586d1
 def isdataclass(s):
     "Check if `s` is a dataclass but not a dataclass' instance"
     return is_dataclass(s) and isclass(s)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #6549c4b2
 def get_dataclass_source(s):
     "Get source code for dataclass `s`"
     return getsource(s) if not getattr(s, "__module__") == '__main__' else ""
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #cac59989
 def get_source(s):
     "Get source code for string, function object or dataclass `s`"
     if isinstance(s,str): return s
     return getsource(s) if isfunction(s) or ismethod(s) else get_dataclass_source(s) if isdataclass(s) else None
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #91c0d15f
 def _parses(s):
     "Parse Python code in string, function object or dataclass `s`"
     return parse(dedent(get_source(s) or ''))
@@ -87,10 +87,10 @@ def _param_locs(s, returns=True, args_kwargs=False):
             return res
     return None
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #93930c1f
 empty = Parameter.empty
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #6434e80e
 def _get_comment(line, arg, comments, parms):
     if line in comments: return comments[line].strip()
     line -= 1
@@ -108,7 +108,7 @@ def _get_full(p, docs, eval_str=False):
         elif eval_str: anno = None
     return AttrDict(docment=docs.get(p.name), anno=anno, default=p.default)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #1b4d817c
 def _merge_doc(dm, npdoc):
     if not npdoc: return dm
     if not isinstance(dm, dict): return dm or '\n'.join(npdoc.desc)
@@ -122,14 +122,14 @@ def _merge_docs(dms, npdocs):
     if 'return' in dms: params['return'] = _merge_doc(dms['return'], npdocs['Returns'])
     return params
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #40e3f274
 def _get_property_name(p):
     "Get the name of property `p`"
     if hasattr(p, 'fget'):
         return p.fget.func.__qualname__ if hasattr(p.fget, 'func') else p.fget.__qualname__
     else: return next(iter(re.findall(r'\'(.*)\'', str(p)))).split('.')[-1]
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #f5efac13
 def get_name(obj):
     "Get the name of `obj`"
     if hasattr(obj, '__name__'):       return obj.__name__
@@ -138,14 +138,14 @@ def get_name(obj):
     elif type(obj)==property:          return _get_property_name(obj)
     else:                              return str(obj).split('.')[-1]
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #5e273f22
 def qual_name(obj):
     "Get the qualified name of `obj`"
     if hasattr(obj,'__qualname__'): return obj.__qualname__
     if ismethod(obj):       return f"{get_name(obj.__self__)}.{get_name(fn)}"
     return get_name(obj)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #9b62ab20
 def docments(s, full=False, eval_str=False, returns=True, args_kwargs=False):
     "Get docments for `s`"
     if isclass(s) and not is_dataclass(s): s = s.__init__
@@ -166,7 +166,7 @@ def docments(s, full=False, eval_str=False, returns=True, args_kwargs=False):
         else: res['return'] = docs.get('return')
     return AttrDict(_merge_docs(res, nps))
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #40cdbeb2
 def sig_source(obj):
     "Full source of signature line(s) for a function or class."
     src = inspect.getsource(obj)
@@ -175,14 +175,14 @@ def sig_source(obj):
     if body_start == 1: return src.splitlines()[0]
     return '\n'.join(src.splitlines()[:body_start-1])
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #6f0d6ea4
 def _get_params(node):
     params = [a.arg for a in node.args.args]
     if node.args.vararg: params.append(f"*{node.args.vararg.arg}")
     if node.args.kwarg: params.append(f"**{node.args.kwarg.arg}")
     return ", ".join(params)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #180b4c2d
 class _DocstringExtractor(ast.NodeVisitor):
     def __init__(self): self.docstrings,self.cls,self.cls_init = {},None,None
 
@@ -213,31 +213,31 @@ def visit_Module(self, node):
         if module_doc: self.docstrings['_module'] = (module_doc, "")
         self.generic_visit(node)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #b1d612e9
 def extract_docstrings(code):
     "Create a dict from function/class/method names to tuples of docstrings and param lists"
     extractor = _DocstringExtractor()
     extractor.visit(ast.parse(code))
     return extractor.docstrings
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #e4e1b815
 def _non_empty_keys(d:dict): return L([k for k,v in d.items() if v != inspect._empty])
 def _bold(s): return f'**{s}**' if s.strip() else s
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #ac070254
 def _escape_markdown(s):
     for c in '|^': s = re.sub(rf'\\?\{c}', rf'\{c}', s)
     return s.replace('\n', '<br>')
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #ced78f56
 def _maybe_nm(o):
     if (o == inspect._empty): return ''
     else: return o.__name__ if hasattr(o, '__name__') else str(o)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #fe6d83f1
 def _list2row(l:list): return '| '+' | '.join([_maybe_nm(o) for o in l]) + ' |'
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #44ac2e4f
 class _DocmentBase:
     def __init__(self, obj):
         self.obj,self.dm = obj, docments(obj, full=True)
@@ -246,7 +246,7 @@ def __init__(self, obj):
     @property
     def has_docment(self): return any(v.get('docment') for v in self.dm.values())
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #b45f731d
 class DocmentTbl(_DocmentBase):
     _map = {'anno':'Type', 'default':'Default', 'docment':'Details'}
 
@@ -303,7 +303,7 @@ def __eq__(self,other): return self.__str__() == str(other).strip()
     __str__ = _repr_markdown_
     __repr__ = basic_repr()
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #5af61ab1
 class DocmentList(_DocmentBase):
     def _fmt(self, nm, p):
         anno,default,doc = _maybe_nm(p.get('anno','')), p.get('default',empty), p.get('docment','')
@@ -314,7 +314,7 @@ def _fmt(self, nm, p):
     def _repr_markdown_(self): return '\n'.join(self._fmt(k,v) for k,v in self.dm.items())
     __repr__=__str__=_repr_markdown_
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #4550820f
 class DocmentText(_DocmentBase):
     def __init__(self, obj, maxline=110, docstring=True):
         super().__init__(obj)
@@ -351,17 +351,17 @@ def __str__(self):
     __repr__ = __str__
     def _repr_markdown_(self): return f"```python\n{self}\n```"
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #d44a7fe3
 def sig2str(func, maxline=110):
     "Generate function signature with docments as comments"
     return DocmentText(func, maxline=maxline, docstring=False)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #07287425
 def _docstring(sym):
     npdoc = parse_docstring(sym)
     return '\n\n'.join([npdoc['Summary'], npdoc['Extended']]).strip()
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #9de89cb6
 def _fullname(o):
     module,name = getattr(o, "__module__", None),qual_name(o)
     return name if module is None or module in ('__main__','builtins') else module + '.' + name
@@ -382,7 +382,7 @@ def __init__(self, sym, name:str|None=None, title_level:int=3, maxline:int=110):
 
     __repr__ = basic_repr()
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #e569d885
 def _f_name(o): return f'<function {o.__name__}>' if isinstance(o, FunctionType) else None
 def _fmt_anno(o): return inspect.formatannotation(o).strip("'").replace(' ','')
 
@@ -395,12 +395,12 @@ def _show_param(param):
     if default is not inspect._empty: res += f'={_f_name(default) or repr(default)}'
     return res
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #59797eb7
 def _ital_first(s:str):
     "Surround first line with * for markdown italics, preserving leading spaces"
     return re.sub(r'^(\s*)(.+)', r'\1*\2*', s, count=1)
 
-# %% ../nbs/04_docments.ipynb
+# %% ../nbs/04_docments.ipynb #9184b175
 class MarkdownRenderer(ShowDocRenderer):
     "Markdown renderer for `show_doc`"
     def _repr_markdown_(self):