cell_number

Author: jph00

fastcore/basics.py

@@ -12,14 +12,14 @@
 __all__ = ['typedispatch', 'lenient_issubclass', 'sorted_topologically', 'TypeDispatch', 'DispatchReg', 'retain_meta',
            'default_set_meta', 'cast', 'retain_type', 'retain_types', 'explode_types']
 
-# %% ../nbs/04_dispatch.ipynb 5
+# %% ../nbs/04_dispatch.ipynb
 def lenient_issubclass(cls, types):
     "If possible return whether `cls` is a subclass of `types`, otherwise return False."
     if cls is object and types is not object: return False # treat `object` as highest level
     try: return isinstance(cls, types) or issubclass(cls, types)
     except: return False
 
-# %% ../nbs/04_dispatch.ipynb 7
+# %% ../nbs/04_dispatch.ipynb
 def sorted_topologically(iterable, *, cmp=operator.lt, reverse=False):
     "Return a new list containing all items from the iterable sorted topologically"
     l,res = L(list(iterable)),[]
@@ -28,7 +28,7 @@ def sorted_topologically(iterable, *, cmp=operator.lt, reverse=False):
         res.append(t), l.remove(t)
     return res[::-1] if reverse else res
 
-# %% ../nbs/04_dispatch.ipynb 11
+# %% ../nbs/04_dispatch.ipynb
 def _chk_defaults(f, ann):
     pass
 # Implementation removed until we can figure out how to do this without `inspect` module
@@ -38,7 +38,7 @@ def _chk_defaults(f, ann):
 #             warn(f"{f.__name__} has default params. These will be ignored.")
 #     except ValueError: pass
 
-# %% ../nbs/04_dispatch.ipynb 12
+# %% ../nbs/04_dispatch.ipynb
 def _p2_anno(f):
     "Get the 1st 2 annotations of `f`, defaulting to `object`"
     hints = type_hints(f)
@@ -47,7 +47,7 @@ def _p2_anno(f):
     while len(ann)<2: ann.append(object)
     return ann[:2]
 
-# %% ../nbs/04_dispatch.ipynb 17
+# %% ../nbs/04_dispatch.ipynb
 class _TypeDict:
     def __init__(self): self.d,self.cache = {},{}
 
@@ -76,7 +76,7 @@ def __getitem__(self, k):
     def __repr__(self): return self.d.__repr__()
     def first(self): return first(self.d.values())
 
-# %% ../nbs/04_dispatch.ipynb 18
+# %% ../nbs/04_dispatch.ipynb
 class TypeDispatch:
     "Dictionary-like object; `__getitem__` matches keys of types using `issubclass`"
     def __init__(self, funcs=(), bases=()):
@@ -137,7 +137,7 @@ def __getitem__(self, k):
             if res is not None: return res
         return None
 
-# %% ../nbs/04_dispatch.ipynb 77
+# %% ../nbs/04_dispatch.ipynb
 class DispatchReg:
     "A global registry for `TypeDispatch` objects keyed by function name"
     def __init__(self): self.d = defaultdict(TypeDispatch)
@@ -150,16 +150,16 @@ def __call__(self, f):
 
 typedispatch = DispatchReg()
 
-# %% ../nbs/04_dispatch.ipynb 84
+# %% ../nbs/04_dispatch.ipynb
 _all_=['cast']
 
-# %% ../nbs/04_dispatch.ipynb 85
+# %% ../nbs/04_dispatch.ipynb
 def retain_meta(x, res, as_copy=False):
     "Call `res.set_meta(x)`, if it exists"
     if hasattr(res,'set_meta'): res.set_meta(x, as_copy=as_copy)
     return res
 
-# %% ../nbs/04_dispatch.ipynb 86
+# %% ../nbs/04_dispatch.ipynb
 def default_set_meta(self, x, as_copy=False):
     "Copy over `_meta` from `x` to `res`, if it's missing"
     if hasattr(x, '_meta') and not hasattr(self, '_meta'):
@@ -168,7 +168,7 @@ def default_set_meta(self, x, as_copy=False):
         self._meta = meta
     return self
 
-# %% ../nbs/04_dispatch.ipynb 87
+# %% ../nbs/04_dispatch.ipynb
 @typedispatch
 def cast(x, typ):
     "cast `x` to type `typ` (may also change `x` inplace)"
@@ -180,7 +180,7 @@ def cast(x, typ):
         except: res = typ(res)
     return retain_meta(x, res)
 
-# %% ../nbs/04_dispatch.ipynb 93
+# %% ../nbs/04_dispatch.ipynb
 def retain_type(new, old=None, typ=None, as_copy=False):
     "Cast `new` to type of `old` or `typ` if it's a superclass"
     # e.g. old is TensorImage, new is Tensor - if not subclass then do nothing
@@ -193,7 +193,7 @@ def retain_type(new, old=None, typ=None, as_copy=False):
     if typ==NoneType or isinstance(new, typ): return new
     return retain_meta(old, cast(new, typ), as_copy=as_copy)
 
-# %% ../nbs/04_dispatch.ipynb 97
+# %% ../nbs/04_dispatch.ipynb
 def retain_types(new, old=None, typs=None):
     "Cast each item of `new` to type of matching item in `old` if it's a superclass"
     if not is_listy(new): return retain_type(new, old, typs)
@@ -205,7 +205,7 @@ def retain_types(new, old=None, typs=None):
     else: t = type(old) if old is not None and isinstance(old,type(new)) else type(new)
     return t(L(new, old, typs).map_zip(retain_types, cycled=True))
 
-# %% ../nbs/04_dispatch.ipynb 99
+# %% ../nbs/04_dispatch.ipynb
 def explode_types(o):
     "Return the type of `o`, potentially in nested dictionaries for thing that are listy"
     if not is_listy(o): return type(o)

fastcore/dispatch.py

@@ -20,36 +20,36 @@
 __all__ = ['empty', 'docstring', 'parse_docstring', 'isdataclass', 'get_dataclass_source', 'get_source', 'get_name', 'qual_name',
            'docments']
 
-# %% ../nbs/06_docments.ipynb 12
+# %% ../nbs/06_docments.ipynb
 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/06_docments.ipynb 14
+# %% ../nbs/06_docments.ipynb
 def parse_docstring(sym):
     "Parse a numpy-style docstring in `sym`"
     docs = docstring(sym)
     return AttrDict(**docscrape.NumpyDocString(docstring(sym)))
 
-# %% ../nbs/06_docments.ipynb 16
+# %% ../nbs/06_docments.ipynb
 def isdataclass(s):
     "Check if `s` is a dataclass but not a dataclass' instance"
     return is_dataclass(s) and isclass(s)
 
-# %% ../nbs/06_docments.ipynb 17
+# %% ../nbs/06_docments.ipynb
 def get_dataclass_source(s):
     "Get source code for dataclass `s`"
     return getsource(s) if not getattr(s, "__module__") == '__main__' else ""
 
-# %% ../nbs/06_docments.ipynb 18
+# %% ../nbs/06_docments.ipynb
 def get_source(s):
     "Get source code for string, function object or dataclass `s`"
     return getsource(s) if isfunction(s) or ismethod(s) else get_dataclass_source(s) if isdataclass(s) else s
 
-# %% ../nbs/06_docments.ipynb 19
+# %% ../nbs/06_docments.ipynb
 def _parses(s):
     "Parse Python code in string, function object or dataclass `s`"
     return parse(dedent(get_source(s)))
@@ -78,10 +78,10 @@ def _param_locs(s, returns=True):
             return res
     return None
 
-# %% ../nbs/06_docments.ipynb 20
+# %% ../nbs/06_docments.ipynb
 empty = Parameter.empty
 
-# %% ../nbs/06_docments.ipynb 21
+# %% ../nbs/06_docments.ipynb
 def _get_comment(line, arg, comments, parms):
     if line in comments: return comments[line].strip()
     line -= 1
@@ -95,7 +95,7 @@ def _get_full(anno, name, default, docs):
     if anno==empty and default!=empty: anno = type(default)
     return AttrDict(docment=docs.get(name), anno=anno, default=default)
 
-# %% ../nbs/06_docments.ipynb 22
+# %% ../nbs/06_docments.ipynb
 def _merge_doc(dm, npdoc):
     if not npdoc: return dm
     if not dm.anno or dm.anno==empty: dm.anno = npdoc.type
@@ -108,14 +108,14 @@ def _merge_docs(dms, npdocs):
     if 'return' in dms: params['return'] = _merge_doc(dms['return'], npdocs['Returns'])
     return params
 
-# %% ../nbs/06_docments.ipynb 23
+# %% ../nbs/06_docments.ipynb
 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/06_docments.ipynb 24
+# %% ../nbs/06_docments.ipynb
 def get_name(obj):
     "Get the name of `obj`"
     if hasattr(obj, '__name__'):       return obj.__name__
@@ -124,14 +124,14 @@ def get_name(obj):
     elif type(obj)==property:          return _get_property_name(obj)
     else:                              return str(obj).split('.')[-1]
 
-# %% ../nbs/06_docments.ipynb 26
+# %% ../nbs/06_docments.ipynb
 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/06_docments.ipynb 29
+# %% ../nbs/06_docments.ipynb
 def _docments(s, returns=True, eval_str=False):
     "`dict` of parameter names to 'docment-style' comments in function or string `s`"
     nps = parse_docstring(s)
@@ -151,7 +151,7 @@ def _docments(s, returns=True, eval_str=False):
             if k in hints: v['anno'] = hints.get(k)
     return res
 
-# %% ../nbs/06_docments.ipynb 30
+# %% ../nbs/06_docments.ipynb
 @delegates(_docments)
 def docments(elt, full=False, **kwargs):
     "Generates a `docment`"

fastcore/docments.py

@@ -4,7 +4,7 @@
 __all__ = ['working_directory', 'add_docs', 'docs', 'coll_repr', 'is_bool', 'mask2idxs', 'cycle', 'zip_cycle', 'is_indexer',
            'CollBase', 'L', 'save_config_file', 'read_config_file', 'Config']
 
-# %% ../nbs/02_foundation.ipynb 1
+# %% ../nbs/02_foundation.ipynb
 from .imports import *
 from .basics import *
 from functools import lru_cache
@@ -13,7 +13,7 @@
 from configparser import ConfigParser
 import random,pickle,inspect
 
-# %% ../nbs/02_foundation.ipynb 5
+# %% ../nbs/02_foundation.ipynb
 @contextmanager
 def working_directory(path):
     "Change working directory to `path` and return to previous on exit."
@@ -22,7 +22,7 @@ def working_directory(path):
     try: yield
     finally: os.chdir(prev_cwd)
 
-# %% ../nbs/02_foundation.ipynb 6
+# %% ../nbs/02_foundation.ipynb
 def add_docs(cls, cls_doc=None, **docs):
     "Copy values from `docs` to `cls` docstrings, and confirm all public methods are documented"
     if cls_doc is not None: cls.__doc__ = cls_doc
@@ -36,24 +36,24 @@ def add_docs(cls, cls_doc=None, **docs):
     assert not nodoc, f"Missing docs: {nodoc}"
     assert cls.__doc__ is not None, f"Missing class docs: {cls}"
 
-# %% ../nbs/02_foundation.ipynb 16
+# %% ../nbs/02_foundation.ipynb
 def docs(cls):
     "Decorator version of `add_docs`, using `_docs` dict"
     add_docs(cls, **cls._docs)
     return cls
 
-# %% ../nbs/02_foundation.ipynb 23
+# %% ../nbs/02_foundation.ipynb
 def coll_repr(c, max_n=10):
     "String repr of up to `max_n` items of (possibly lazy) collection `c`"
     return f'(#{len(c)}) [' + ','.join(itertools.islice(map(repr,c), max_n)) + (
         '...' if len(c)>max_n else '') + ']'
 
-# %% ../nbs/02_foundation.ipynb 28
+# %% ../nbs/02_foundation.ipynb
 def is_bool(x):
     "Check whether `x` is a bool or None"
     return isinstance(x,(bool,NoneType)) or risinstance('bool_', x)
 
-# %% ../nbs/02_foundation.ipynb 29
+# %% ../nbs/02_foundation.ipynb
 def mask2idxs(mask):
     "Convert bool mask or index list to index `L`"
     if isinstance(mask,slice): return mask
@@ -64,23 +64,23 @@ def mask2idxs(mask):
     if is_bool(it): return [i for i,m in enumerate(mask) if m]
     return [int(i) for i in mask]
 
-# %% ../nbs/02_foundation.ipynb 31
+# %% ../nbs/02_foundation.ipynb
 def cycle(o):
     "Like `itertools.cycle` except creates list of `None`s if `o` is empty"
     o = listify(o)
     return itertools.cycle(o) if o is not None and len(o) > 0 else itertools.cycle([None])
 
-# %% ../nbs/02_foundation.ipynb 33
+# %% ../nbs/02_foundation.ipynb
 def zip_cycle(x, *args):
     "Like `itertools.zip_longest` but `cycle`s through elements of all but first argument"
     return zip(x, *map(cycle,args))
 
-# %% ../nbs/02_foundation.ipynb 35
+# %% ../nbs/02_foundation.ipynb
 def is_indexer(idx):
     "Test whether `idx` will index a single item in a list"
     return isinstance(idx,int) or not getattr(idx,'ndim',1)
 
-# %% ../nbs/02_foundation.ipynb 41
+# %% ../nbs/02_foundation.ipynb
 class CollBase:
     "Base class for composing a list of `items`"
     def __init__(self, items): self.items = items
@@ -91,13 +91,13 @@ def __delitem__(self, i): del(self.items[i])
     def __repr__(self): return self.items.__repr__()
     def __iter__(self): return self.items.__iter__()
 
-# %% ../nbs/02_foundation.ipynb 45
+# %% ../nbs/02_foundation.ipynb
 class _L_Meta(type):
     def __call__(cls, x=None, *args, **kwargs):
         if not args and not kwargs and x is not None and isinstance(x,cls): return x
         return super().__call__(x, *args, **kwargs)
 
-# %% ../nbs/02_foundation.ipynb 46
+# %% ../nbs/02_foundation.ipynb
 class L(GetAttr, CollBase, metaclass=_L_Meta):
     "Behaves like a list of `items` but can also index with list of indices or masks"
     _default='items'
@@ -194,7 +194,7 @@ def sum(self): return self.reduce(operator.add, 0)
     def product(self): return self.reduce(operator.mul, 1)
     def setattrs(self, attr, val): [setattr(o,attr,val) for o in self]
 
-# %% ../nbs/02_foundation.ipynb 47
+# %% ../nbs/02_foundation.ipynb
 add_docs(L,
          __getitem__="Retrieve `idx` (can be list of indices, or mask, or int) items",
          range="Class Method: Same as `range`, but returns `L`. Can pass collection for `a`, to use `len(a)`",
@@ -227,29 +227,29 @@ def setattrs(self, attr, val): [setattr(o,attr,val) for o in self]
          setattrs="Call `setattr` on all items"
         )
 
-# %% ../nbs/02_foundation.ipynb 48
+# %% ../nbs/02_foundation.ipynb
 # Here we are fixing the signature of L. What happens is that the __call__ method on the MetaClass of L shadows the __init__
 # giving the wrong signature (https://stackoverflow.com/questions/49740290/call-from-metaclass-shadows-signature-of-init).
 def _f(items=None, *rest, use_list=False, match=None): ...
 L.__signature__ = inspect.signature(_f)
 
-# %% ../nbs/02_foundation.ipynb 49
+# %% ../nbs/02_foundation.ipynb
 Sequence.register(L);
 
-# %% ../nbs/02_foundation.ipynb 129
+# %% ../nbs/02_foundation.ipynb
 def save_config_file(file, d, **kwargs):
     "Write settings dict to a new config file, or overwrite the existing one."
     config = ConfigParser(**kwargs)
     config['DEFAULT'] = d
     config.write(open(file, 'w'))
 
-# %% ../nbs/02_foundation.ipynb 130
+# %% ../nbs/02_foundation.ipynb
 def read_config_file(file, **kwargs):
     config = ConfigParser(**kwargs)
     config.read(file, encoding='utf8')
     return config['DEFAULT']
 
-# %% ../nbs/02_foundation.ipynb 133
+# %% ../nbs/02_foundation.ipynb
 class Config:
     "Reading and writing `ConfigParser` ini files"
     def __init__(self, cfg_path, cfg_name, create=None, save=True, extra_files=None, types=None):