Merge remote-tracking branch 'origin/master' into scrub-magics

Author: yegeniy

README.md

@@ -3,12 +3,8 @@ Getting Started
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
-<div>
-
 ![CI](https://github.com/fastai/nbdev/actions/workflows/test.yaml/badge.svg)
 
-</div>
-
 *NB: This is nbdev v2, a major upgrade of nbdev. Whilst the differences
 to nbdev1 aren’t huge, it does require some changes. The old version
 docs are at [nbdev1.fast.ai](https://nbdev1.fast.ai). You can use
@@ -75,8 +71,6 @@ The best way to learn how to use nbdev is to complete either the
 [written walkthrough](https://nbdev.fast.ai/tutorials/tutorial.html) or
 video walkthrough:
 
-<div style="text-align: center">
-
 <div>
 
 <a href="http://www.youtube.com/watch?v=l7zS8Ld4_iA" target="_blank"
@@ -86,8 +80,6 @@ style="border-radius: 10px" width="560" height="315" /></a>
 
 </div>
 
-</div>
-
 Alternatively, there’s a [shortened version of the video
 walkthrough](https://youtu.be/67FdzLSt4aA) with coding sections sped up
 using the `unsilence` Python library – it’s 27 minutes faster, but a bit

nbdev/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.3.12"
+__version__ = "2.3.13"
 
 from .doclinks import nbdev_export
 from .showdoc import show_doc

nbdev/_modidx.py

@@ -6,7 +6,6 @@
                 'git_url': 'https://github.com/fastai/nbdev',
                 'lib_path': 'nbdev'},
   'syms': { 'nbdev.clean': { 'nbdev.clean._add_jupyter_hooks': ('api/clean.html#_add_jupyter_hooks', 'nbdev/clean.py'),
-                             'nbdev.clean._add_trailing_n': ('api/clean.html#_add_trailing_n', 'nbdev/clean.py'),
                              'nbdev.clean._clean_cell': ('api/clean.html#_clean_cell', 'nbdev/clean.py'),
                              'nbdev.clean._clean_cell_output': ('api/clean.html#_clean_cell_output', 'nbdev/clean.py'),
                              'nbdev.clean._clean_cell_output_id': ('api/clean.html#_clean_cell_output_id', 'nbdev/clean.py'),

nbdev/clean.py

@@ -55,11 +55,6 @@ 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
-def _add_trailing_n(img):
-    if not isinstance(img,str): return [ _add_trailing_n(o) for o in img ]
-    return img + "\n" if img[-1] != "\n" else img
-
-# %% ../nbs/api/11_clean.ipynb 12
 def _clean_cell_output(cell, clean_ids):
     "Remove `cell` output execution count and optionally ids from text reprs"
     outputs = cell.get('outputs', [])
@@ -69,11 +64,11 @@ def _clean_cell_output(cell, clean_ids):
         data.pop("application/vnd.google.colaboratory.intrinsic+json", None)
         for k in data:
             if k.startswith('text') and clean_ids: data[k] = _clean_cell_output_id(data[k])
-            if k.startswith('image'): data[k] = _add_trailing_n(data[k])
+            if k.startswith('image') and "svg" not in k: data[k] = data[k].rstrip()
         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 13
+# %% ../nbs/api/11_clean.ipynb 12
 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
@@ -84,7 +79,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 14
+# %% ../nbs/api/11_clean.ipynb 13
 def clean_nb(
     nb, # The notebook to clean
     clear_all=False, # Remove all cell metadata and cell outputs?
@@ -93,43 +88,42 @@ def clean_nb(
     clean_ids=True, # Remove ids from plaintext reprs?
 ):
     "Clean `nb` from superfluous metadata"
-    assert isinstance(nb, AttrDict)
     metadata_keys = {"kernelspec", "jekyll", "jupytext", "doc", "widgets"}
     if allowed_metadata_keys: metadata_keys.update(allowed_metadata_keys)
     cell_metadata_keys = {"hide_input"}
     if allowed_cell_metadata_keys: cell_metadata_keys.update(allowed_cell_metadata_keys)
     for c in nb['cells']: _clean_cell(c, clear_all, cell_metadata_keys, clean_ids)
-    if nested_attr(nb, 'metadata.kernelspec.name'):
-        nb['metadata']['kernelspec']['display_name'] = nb.metadata.kernelspec.name
+    if nb.get('metadata', {}).get('kernelspec', {}).get('name', None):
+        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 27
+# %% ../nbs/api/11_clean.ipynb 26
 def _reconfigure(*strms):
     for s in strms:
         if hasattr(s,'reconfigure'): s.reconfigure(encoding='utf-8')
 
-# %% ../nbs/api/11_clean.ipynb 28
+# %% ../nbs/api/11_clean.ipynb 27
 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()
+    if isinstance(f_in, (str,Path)): f_in = Path(f_in).open(encoding="utf-8")
     try:
         _reconfigure(f_in, f_out)
-        nb = dict2nb(loads(f_in.read()))
+        nb = loads(f_in.read())
         proc_nb(nb)
         write_nb(nb, f_out) if not disp else sys.stdout.write(nb2str(nb))
     except Exception as e:
         warn(f'{warn_msg}')
         warn(e)
 
-# %% ../nbs/api/11_clean.ipynb 29
+# %% ../nbs/api/11_clean.ipynb 28
 def _nbdev_clean(nb, path=None, clear_all=None):
     cfg = get_config(path=path)
     clear_all = clear_all or cfg.clear_all
     allowed_metadata_keys = cfg.get("allowed_metadata_keys").split()
     allowed_cell_metadata_keys = cfg.get("allowed_cell_metadata_keys").split()
     return clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)
 
-# %% ../nbs/api/11_clean.ipynb 30
+# %% ../nbs/api/11_clean.ipynb 29
 @call_parse
 def nbdev_clean(
     fname:str=None, # A notebook name or glob to clean
@@ -145,15 +139,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 33
+# %% ../nbs/api/11_clean.ipynb 32
 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 36
+# %% ../nbs/api/11_clean.ipynb 35
 _pre_save_hook_src = '''
 def nbdev_clean_jupyter(**kwargs):
     try: from nbdev.clean import clean_jupyter
@@ -163,7 +157,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 37
+# %% ../nbs/api/11_clean.ipynb 36
 def _add_jupyter_hooks(src, path):
     if _pre_save_hook_src in src: return
     mod = ast.parse(src)
@@ -181,12 +175,12 @@ def _add_jupyter_hooks(src, path):
     if src: src+='\n\n'
     return src+_pre_save_hook_src
 
-# %% ../nbs/api/11_clean.ipynb 41
+# %% ../nbs/api/11_clean.ipynb 40
 def _git_root(): 
     try: return Path(run('git rev-parse --show-toplevel'))
     except OSError: return None
 
-# %% ../nbs/api/11_clean.ipynb 44
+# %% ../nbs/api/11_clean.ipynb 43
 @call_parse
 def nbdev_install_hooks():
     "Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks"

nbdev/cli.py

@@ -42,7 +42,7 @@ def nbdev_filter(
     elif not nb_txt: nb_txt = sys.stdin.read()
     nb = dict2nb(loads(nb_txt))
     if printit:
-        with open(os.devnull, 'w') as dn:
+        with open(os.devnull, 'w', encoding="utf-8") as dn:
             with redirect_stdout(dn): filt(nb)
     else: filt(nb)
     res = nb2str(nb)

nbdev/config.py

@@ -272,7 +272,7 @@ def _basic_export_nb(fname, name, dest=None):
     exp_funcs = [f for f in funcs if f[0]!='_']
 
     # write out the file
-    with (dest/name).open('w') as f:
+    with (dest/name).open('w',encoding="utf-8") as f:
         f.write(f"# %% auto 0\n__all__ = {exp_funcs}")
         write_cells(cells, f"# %% {fname.relpath(dest)}", f)
         f.write('\n')

nbdev/maker.py

@@ -202,7 +202,7 @@ def make(self:ModuleMaker, cells, all_cells=None, lib_path=None):
         last_future = self._last_future(cells) if len(all_cells)>0 else 0
         tw = TextWrapper(width=120, initial_indent='', subsequent_indent=' '*11, break_long_words=False)
         all_str = '\n'.join(tw.wrap(str(_all)))
-    with self.fname.open('w') as f:
+    with self.fname.open('w', encoding="utf-8") as f:
         f.write(_retr_mdoc(cells))
         f.write(f"# AUTOGENERATED! DO NOT EDIT! File to edit: {self.dest2nb}.")
         if last_future > 0: write_cells(cells[:last_future], self.hdr, f)
@@ -220,7 +220,7 @@ def _make_exists(self:ModuleMaker, cells, all_cells=None):
     "`make` for `is_new=False`"
     if all_cells and self.parse:
         update_var('__all__', partial(self._update_all, all_cells), fn=self.fname)
-    with self.fname.open('a') as f: write_cells(cells, self.hdr, f)
+    with self.fname.open('a', encoding="utf-8") as f: write_cells(cells, self.hdr, f)
 
 # %% ../nbs/api/02_maker.ipynb 44
 def _basic_export_nb2(fname, name, dest=None):

nbdev/release.py

@@ -169,7 +169,7 @@ def pypi_details(name):
 
 def _run(cmd):
     res = ""
-    with Popen(shlex.split(cmd), stdout=PIPE, bufsize=1, text=True) as p:
+    with Popen(shlex.split(cmd), stdout=PIPE, bufsize=1, text=True, encoding="utf-8") as p:
         for line in p.stdout:
             print(line, end='')
             res += line
@@ -188,7 +188,7 @@ def _write_yaml(path, name, d1, d2):
     p = path/name
     p.mkdir(exist_ok=True, parents=True)
     yaml.SafeDumper.ignore_aliases = lambda *args : True
-    with (p/'meta.yaml').open('w') as f:
+    with (p/'meta.yaml').open('w', encoding="utf-8") as f:
         yaml.safe_dump(d1, f)
         yaml.safe_dump(d2, f)
 

nbs/api/01_config.ipynb

@@ -754,7 +754,7 @@
     "    exp_funcs = [f for f in funcs if f[0]!='_']\n",
     "\n",
     "    # write out the file\n",
-    "    with (dest/name).open('w') as f:\n",
+    "    with (dest/name).open('w',encoding=\"utf-8\") as f:\n",
     "        f.write(f\"# %% auto 0\\n__all__ = {exp_funcs}\")\n",
     "        write_cells(cells, f\"# %% {fname.relpath(dest)}\", f)\n",
     "        f.write('\\n')"

nbs/api/02_maker.ipynb

@@ -514,7 +514,7 @@
     "        last_future = self._last_future(cells) if len(all_cells)>0 else 0\n",
     "        tw = TextWrapper(width=120, initial_indent='', subsequent_indent=' '*11, break_long_words=False)\n",
     "        all_str = '\\n'.join(tw.wrap(str(_all)))\n",
-    "    with self.fname.open('w') as f:\n",
+    "    with self.fname.open('w', encoding=\"utf-8\") as f:\n",
     "        f.write(_retr_mdoc(cells))\n",
     "        f.write(f\"# AUTOGENERATED! DO NOT EDIT! File to edit: {self.dest2nb}.\")\n",
     "        if last_future > 0: write_cells(cells[:last_future], self.hdr, f)\n",
@@ -661,7 +661,7 @@
     "    \"`make` for `is_new=False`\"\n",
     "    if all_cells and self.parse:\n",
     "        update_var('__all__', partial(self._update_all, all_cells), fn=self.fname)\n",
-    "    with self.fname.open('a') as f: write_cells(cells, self.hdr, f)"
+    "    with self.fname.open('a', encoding=\"utf-8\") as f: write_cells(cells, self.hdr, f)"
    ]
   },
   {