fixes #1439

Author: jph00

nbdev/clean.py

@@ -3,7 +3,7 @@
 # %% auto 0
 __all__ = ['nbdev_trust', 'clean_nb', 'process_write', 'nbdev_clean', 'clean_jupyter', 'nbdev_install_hooks']
 
-# %% ../nbs/api/11_clean.ipynb 2
+# %% ../nbs/api/11_clean.ipynb
 import ast,warnings,stat
 from astunparse import unparse
 from textwrap import indent
@@ -18,7 +18,7 @@
 from .sync import *
 from .process import first_code_ln
 
-# %% ../nbs/api/11_clean.ipynb 6
+# %% ../nbs/api/11_clean.ipynb
 @call_parse
 def nbdev_trust(
     fname:str=None,  # A notebook name or glob to trust
@@ -45,7 +45,7 @@ def nbdev_trust(
         if not NotebookNotary().check_signature(nb): NotebookNotary().sign(nb)
     check_fname.touch(exist_ok=True)
 
-# %% ../nbs/api/11_clean.ipynb 9
+# %% ../nbs/api/11_clean.ipynb
 _repr_id_re = re.compile('(<.*?)( at 0x[0-9a-fA-F]+)(>)')
 
 _sub = partial(_repr_id_re.sub, r'\1\3')
@@ -55,7 +55,7 @@ def _skip_or_sub(x): return _sub(x) if "at 0x" in x else x
 def _clean_cell_output_id(lines):
     return _skip_or_sub(lines) if isinstance(lines,str) else [_skip_or_sub(o) for o in lines]
 
-# %% ../nbs/api/11_clean.ipynb 11
+# %% ../nbs/api/11_clean.ipynb
 def _clean_cell_output(cell, clean_ids):
     "Remove `cell` output execution count and optionally ids from text reprs"
     outputs = cell.get('outputs', [])
@@ -69,7 +69,7 @@ def _clean_cell_output(cell, clean_ids):
         if 'text' in o and clean_ids: o['text'] = _clean_cell_output_id(o['text'])
         o.get('metadata', {}).pop('tags', None)
 
-# %% ../nbs/api/11_clean.ipynb 12
+# %% ../nbs/api/11_clean.ipynb
 def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
     "Clean `cell` by removing superfluous metadata or everything except the input if `clear_all`"
     if 'execution_count' in cell: cell['execution_count'] = None
@@ -80,7 +80,7 @@ def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
     cell['metadata'] = {} if clear_all else {
         k:v for k,v in cell['metadata'].items() if k in allowed_metadata_keys}
 
-# %% ../nbs/api/11_clean.ipynb 13
+# %% ../nbs/api/11_clean.ipynb
 def clean_nb(
     nb, # The notebook to clean
     clear_all=False, # Remove all cell metadata and cell outputs?
@@ -98,12 +98,12 @@ def clean_nb(
         nb['metadata']['kernelspec']['display_name'] = nb["metadata"]["kernelspec"]["name"]
     nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in metadata_keys}
 
-# %% ../nbs/api/11_clean.ipynb 26
+# %% ../nbs/api/11_clean.ipynb
 def _reconfigure(*strms):
     for s in strms:
         if hasattr(s,'reconfigure'): s.reconfigure(encoding='utf-8')
 
-# %% ../nbs/api/11_clean.ipynb 27
+# %% ../nbs/api/11_clean.ipynb
 def process_write(warn_msg, proc_nb, f_in, f_out=None, disp=False):
     if not f_out: f_out = f_in
     if isinstance(f_in, (str,Path)): f_in = Path(f_in).open(encoding="utf-8")
@@ -116,7 +116,7 @@ def process_write(warn_msg, proc_nb, f_in, f_out=None, disp=False):
         warn(f'{warn_msg}')
         warn(e)
 
-# %% ../nbs/api/11_clean.ipynb 28
+# %% ../nbs/api/11_clean.ipynb
 def _nbdev_clean(nb, path=None, clear_all=None):
     cfg = get_config(path=path)
     clear_all = clear_all or cfg.clear_all
@@ -125,7 +125,7 @@ def _nbdev_clean(nb, path=None, clear_all=None):
     clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)
     if path: nbdev_trust.__wrapped__(path)
 
-# %% ../nbs/api/11_clean.ipynb 29
+# %% ../nbs/api/11_clean.ipynb
 @call_parse
 def nbdev_clean(
     fname:str=None, # A notebook name or glob to clean
@@ -141,15 +141,15 @@ def nbdev_clean(
     if fname is None: fname = get_config().nbs_path
     for f in globtastic(fname, file_glob='*.ipynb', skip_folder_re='^[_.]'): _write(f_in=f, disp=disp)
 
-# %% ../nbs/api/11_clean.ipynb 32
+# %% ../nbs/api/11_clean.ipynb
 def clean_jupyter(path, model, **kwargs):
     "Clean Jupyter `model` pre save to `path`"
     if not (model['type']=='notebook' and model['content']['nbformat']==4): return
     get_config.cache_clear() # Allow config changes without restarting Jupyter
     jupyter_hooks = get_config(path=path).jupyter_hooks
     if jupyter_hooks: _nbdev_clean(model['content'], path=path)
 
-# %% ../nbs/api/11_clean.ipynb 35
+# %% ../nbs/api/11_clean.ipynb
 _pre_save_hook_src = '''
 def nbdev_clean_jupyter(**kwargs):
     try: from nbdev.clean import clean_jupyter
@@ -159,7 +159,7 @@ def nbdev_clean_jupyter(**kwargs):
 c.ContentsManager.pre_save_hook = nbdev_clean_jupyter'''.strip()
 _pre_save_hook_re = re.compile(r'c\.(File)?ContentsManager\.pre_save_hook')
 
-# %% ../nbs/api/11_clean.ipynb 36
+# %% ../nbs/api/11_clean.ipynb
 def _add_jupyter_hooks(src, path):
     if _pre_save_hook_src in src: return
     mod = ast.parse(src)
@@ -177,12 +177,12 @@ def _add_jupyter_hooks(src, path):
     if src: src+='\n\n'
     return src+_pre_save_hook_src
 
-# %% ../nbs/api/11_clean.ipynb 40
+# %% ../nbs/api/11_clean.ipynb
 def _git_root(): 
     try: return Path(run('git rev-parse --show-toplevel'))
     except OSError: return None
 
-# %% ../nbs/api/11_clean.ipynb 43
+# %% ../nbs/api/11_clean.ipynb
 @call_parse
 def nbdev_install_hooks():
     "Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks"

nbdev/cli.py

@@ -27,7 +27,7 @@
 # %% auto 0
 __all__ = ['mapping', 'nbdev_filter', 'extract_tgz', 'nbdev_new', 'nbdev_update_license', 'chelp']
 
-# %% ../nbs/api/13_cli.ipynb 5
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 def nbdev_filter(
     nb_txt:str=None,  # Notebook text (uses stdin if not provided)
@@ -50,20 +50,20 @@ def nbdev_filter(
     if printit: print(res, flush=True)
     else: return res
 
-# %% ../nbs/api/13_cli.ipynb 8
+# %% ../nbs/api/13_cli.ipynb
 def extract_tgz(url, dest='.'):
     from fastcore.net import urlopen
     with urlopen(url) as u: tarfile.open(mode='r:gz', fileobj=u).extractall(dest)
 
-# %% ../nbs/api/13_cli.ipynb 9
+# %% ../nbs/api/13_cli.ipynb
 def _render_nb(fn, cfg):
     "Render templated values like `{{lib_name}}` in notebook at `fn` from `cfg`"
     txt = fn.read_text()
     txt = txt.replace('from your_lib.core', f'from {cfg.lib_path}.core') # for compatibility with old templates
     for k,v in cfg.d.items(): txt = txt.replace('{{'+k+'}}', v)
     fn.write_text(txt)
 
-# %% ../nbs/api/13_cli.ipynb 10
+# %% ../nbs/api/13_cli.ipynb
 def _update_repo_meta(cfg):
     "Enable gh pages and update the homepage and description in your GitHub repo."
     token=os.getenv('GITHUB_TOKEN')
@@ -74,7 +74,7 @@ def _update_repo_meta(cfg):
         except HTTPError:print(f"Could not update the description & URL on the repo: {cfg.user}/{cfg.repo} using $GITHUB_TOKEN.\n"
                   "Use a token with the correction permissions or perform these steps manually.")
 
-# %% ../nbs/api/13_cli.ipynb 11
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 @delegates(nbdev_create_config)
 def nbdev_new(**kwargs):
@@ -123,7 +123,7 @@ def nbdev_new(**kwargs):
     nbdev_export.__wrapped__()
     nbdev_readme.__wrapped__()
 
-# %% ../nbs/api/13_cli.ipynb 13
+# %% ../nbs/api/13_cli.ipynb
 mapping = {
   'mit': 'mit',
   'apache2': 'apache-2.0',
@@ -132,7 +132,7 @@ def nbdev_new(**kwargs):
   'bsd3': 'bsd-3-clause'
 }
 
-# %% ../nbs/api/13_cli.ipynb 14
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 def nbdev_update_license(
     to: str=None, # update license to
@@ -163,7 +163,7 @@ def nbdev_update_license(
     lic.write(body)
     print(f"License updated from {curr_lic} to {to}")
 
-# %% ../nbs/api/13_cli.ipynb 17
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 def chelp():
     "Show help for all console scripts"

nbdev/config.py

@@ -7,11 +7,11 @@
 __all__ = ['nbdev_create_config', 'get_config', 'config_key', 'create_output', 'show_src', 'update_version', 'add_init',
            'write_cells']
 
-# %% ../nbs/api/01_config.ipynb 2
+# %% ../nbs/api/01_config.ipynb
 _doc_ = """Read and write nbdev's `settings.ini` file.
 `get_config` is the main function for reading settings."""
 
-# %% ../nbs/api/01_config.ipynb 3
+# %% ../nbs/api/01_config.ipynb
 from datetime import datetime
 from fastcore.docments import *
 from fastcore.utils import *
@@ -25,16 +25,16 @@
 from execnb.nbio import read_nb,NbCell
 from urllib.error import HTTPError
 
-# %% ../nbs/api/01_config.ipynb 8
+# %% ../nbs/api/01_config.ipynb
 _nbdev_home_dir = 'nbdev' # sub-directory of xdg base dir
 _nbdev_cfg_name = 'settings.ini'
 
-# %% ../nbs/api/01_config.ipynb 9
+# %% ../nbs/api/01_config.ipynb
 def _git_repo():
     try: return repo_details(run('git config --get remote.origin.url'))[1]
     except OSError: return
 
-# %% ../nbs/api/01_config.ipynb 11
+# %% ../nbs/api/01_config.ipynb
 # When adding a named default to the list below, be sure that that name
 # is also added to one of the sections in `_nbdev_cfg_sections` as well,
 # or it won't get written by `nbdev_create_config`:
@@ -82,7 +82,7 @@ def _apply_defaults(
         cfg[k] = v
     return cfg
 
-# %% ../nbs/api/01_config.ipynb 12
+# %% ../nbs/api/01_config.ipynb
 def _get_info(owner, repo, default_branch='main', default_kw='nbdev'):
     from ghapi.all import GhApi
     api = GhApi(owner=owner, repo=repo, token=os.getenv('GITHUB_TOKEN'))
@@ -98,7 +98,7 @@ def _get_info(owner, repo, default_branch='main', default_kw='nbdev'):
 
     return r.default_branch, default_kw if not getattr(r, 'topics', []) else ' '.join(r.topics), r.description
 
-# %% ../nbs/api/01_config.ipynb 14
+# %% ../nbs/api/01_config.ipynb
 def _fetch_from_git(raise_err=False):
     "Get information for settings.ini from the user."
     res={}
@@ -114,7 +114,7 @@ def _fetch_from_git(raise_err=False):
     else: res['lib_name'] = res['repo'].replace('-','_')
     return res
 
-# %% ../nbs/api/01_config.ipynb 16
+# %% ../nbs/api/01_config.ipynb
 def _prompt_user(cfg, inferred):
     "Let user input values not in `cfg` or `inferred`."
     res = cfg.copy()
@@ -128,7 +128,7 @@ def _prompt_user(cfg, inferred):
                 print(msg+res[k]+' # Automatically inferred from git')
     return res
 
-# %% ../nbs/api/01_config.ipynb 18
+# %% ../nbs/api/01_config.ipynb
 def _cfg2txt(cfg, head, sections, tail=''):
     "Render `cfg` with commented sections."
     nm = cfg.d.name
@@ -140,7 +140,7 @@ def _cfg2txt(cfg, head, sections, tail=''):
     res += tail
     return res.strip()
 
-# %% ../nbs/api/01_config.ipynb 20
+# %% ../nbs/api/01_config.ipynb
 _nbdev_cfg_head = '''# All sections below are required unless otherwise specified.
 # See https://github.com/fastai/nbdev/blob/master/settings.ini for examples.
 
@@ -157,7 +157,7 @@ def _cfg2txt(cfg, head, sections, tail=''):
 # package_data = 
 '''
 
-# %% ../nbs/api/01_config.ipynb 21
+# %% ../nbs/api/01_config.ipynb
 @call_parse
 @delegates(_apply_defaults, but='cfg')
 def nbdev_create_config(
@@ -183,19 +183,19 @@ def nbdev_create_config(
     cfg_fn = Path(path)/cfg_name
     print(f'{cfg_fn} created.')
 
-# %% ../nbs/api/01_config.ipynb 24
+# %% ../nbs/api/01_config.ipynb
 def _nbdev_config_file(cfg_name=_nbdev_cfg_name, path=None):
     cfg_path = path = Path.cwd() if path is None else Path(path)
     while cfg_path != cfg_path.parent and not (cfg_path/cfg_name).exists(): cfg_path = cfg_path.parent
     if not (cfg_path/cfg_name).exists(): cfg_path = path
     return cfg_path/cfg_name
 
-# %% ../nbs/api/01_config.ipynb 26
+# %% ../nbs/api/01_config.ipynb
 def _xdg_config_paths(cfg_name=_nbdev_cfg_name):
     xdg_config_paths = reversed([xdg_config_home()]+xdg_config_dirs())
     return [o/_nbdev_home_dir/cfg_name for o in xdg_config_paths]
 
-# %% ../nbs/api/01_config.ipynb 27
+# %% ../nbs/api/01_config.ipynb
 def _type(t): return bool if t==bool_arg else t
 _types = {k:_type(v['anno']) for k,v in docments(_apply_defaults,full=True,returns=False).items() if k != 'cfg'}
 
@@ -207,22 +207,22 @@ def get_config(cfg_name=_nbdev_cfg_name, path=None):
     cfg = Config(cfg_file.parent, cfg_file.name, extra_files=extra_files, types=_types)
     return _apply_defaults(cfg)
 
-# %% ../nbs/api/01_config.ipynb 42
+# %% ../nbs/api/01_config.ipynb
 def config_key(c, default=None, path=True, missing_ok=None):
     "Deprecated: use `get_config().get` or `get_config().path` instead."
     warn("`config_key` is deprecated. Use `get_config().get` or `get_config().path` instead.", DeprecationWarning)
     return get_config().path(c, default) if path else get_config().get(c, default)
 
-# %% ../nbs/api/01_config.ipynb 44
+# %% ../nbs/api/01_config.ipynb
 def create_output(txt, mime):
     "Add a cell output containing `txt` of the `mime` text MIME sub-type"
     return [{"data": { f"text/{mime}": str(txt).splitlines(True) },
              "execution_count": 1, "metadata": {}, "output_type": "execute_result"}]
 
-# %% ../nbs/api/01_config.ipynb 45
+# %% ../nbs/api/01_config.ipynb
 def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
 
-# %% ../nbs/api/01_config.ipynb 48
+# %% ../nbs/api/01_config.ipynb
 _re_version = re.compile(r'^__version__\s*=.*$', re.MULTILINE)
 _init = '__init__.py'
 
@@ -251,15 +251,15 @@ def add_init(path=None):
         if _has_py(fs) or any(filter(_has_py, subds)) and not (r/_init).exists(): (r/_init).touch()
     if get_config().get('put_version_in_init', True): update_version(path)
 
-# %% ../nbs/api/01_config.ipynb 51
+# %% ../nbs/api/01_config.ipynb
 def write_cells(cells, hdr, file, offset=0, cell_number=True):
     "Write `cells` to `file` along with header `hdr` starting at index `offset` (mainly for nbdev internal use)."
     for cell in cells:
         if cell.source.strip():
             idx = f" {cell.idx_+offset}" if cell_number else ""
             file.write(f'\n\n{hdr}{idx}\n{cell.source}')
 
-# %% ../nbs/api/01_config.ipynb 52
+# %% ../nbs/api/01_config.ipynb
 def _basic_export_nb(fname, name, dest=None):
     "Basic exporter to bootstrap nbdev."
     if dest is None: dest = get_config().lib_path