nbdev 3.0.14__tar.gz → 3.0.16__tar.gz

{nbdev-3.0.14/nbdev.egg-info → nbdev-3.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.0.14
+Version: 3.0.16
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0

{nbdev-3.0.14 → nbdev-3.0.16}/nbdev/__init__.py

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

{nbdev-3.0.14 → nbdev-3.0.16}/nbdev/clean.py

@@ -58,7 +58,7 @@ 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 #b4cde615
-def _clean_cell_output(cell, clean_ids):
+def _clean_cell_output(cell, clean_ids, allowed_out_meta_keys):
     "Remove `cell` output execution count and optionally ids from text reprs"
     outputs = cell.get('outputs', [])
     for o in outputs:
@@ -69,15 +69,15 @@ def _clean_cell_output(cell, clean_ids):
             if k.startswith('text') and clean_ids: data[k] = _clean_cell_output_id(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)
+        if 'metadata' in o: o['metadata'] = {k:v for k,v in o['metadata'].items() if k in allowed_out_meta_keys}
 
 # %% ../nbs/api/11_clean.ipynb #2ba79c93
-def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
+def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids, allowed_out_meta_keys):
     "Clean `cell` by removing superfluous metadata or everything except the input if `clear_all`"
     if 'execution_count' in cell: cell['execution_count'] = None
     if 'outputs' in cell:
         if clear_all: cell['outputs'] = []
-        else:         _clean_cell_output(cell, clean_ids)
+        else:         _clean_cell_output(cell, clean_ids, allowed_out_meta_keys)
     if cell['source'] == ['']: cell['source'] = []
     cell['metadata'] = {} if clear_all else {
         k:v for k,v in cell['metadata'].items() if k in allowed_metadata_keys}
@@ -90,13 +90,16 @@ def clean_nb(
     allowed_metadata_keys:list=None, # Preserve the list of keys in the main notebook metadata
     allowed_cell_metadata_keys:list=None, # Preserve the list of keys in cell level metadata
     clean_ids=True, # Remove ids from plaintext reprs?
+    allowed_out_metadata_keys:list=None, # Preserve the list of keys in output metadata
 ):
     "Clean `nb` from superfluous metadata"
     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)
+    out_meta_keys = set()
+    if allowed_out_metadata_keys: out_meta_keys.update(allowed_out_metadata_keys)
+    for c in nb['cells']: _clean_cell(c, clear_all, cell_metadata_keys, clean_ids, out_meta_keys)
     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}
@@ -127,7 +130,8 @@ def _nbdev_clean(nb, path=None, clear_all=None):
     clear_all = clear_all or cfg.clear_all
     allowed_metadata_keys = cfg.get("allowed_metadata_keys") or []
     allowed_cell_metadata_keys = cfg.get("allowed_cell_metadata_keys") or []
-    clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)
+    allowed_out_metadata_keys = cfg.get("allowed_out_metadata_keys") or []
+    clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids, allowed_out_metadata_keys)
     if path: nbdev_trust.__wrapped__(path)
 
 # %% ../nbs/api/11_clean.ipynb #6af3b9d4
@@ -209,7 +213,7 @@ def nbdev_install_hooks():
     os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)
 
     cmd = 'git config --local include.path ../.gitconfig'
-    (repo_path/'.gitconfig').write_text(f'''# Generated by nbdev_install_hooks
+    (repo_path/'.gitconfig').write_text(f'''# Generated by nbdev-install-hooks
 #
 # If you need to disable this instrumentation do:
 #   git config --local --unset include.path

{nbdev-3.0.14 → nbdev-3.0.16}/nbdev/export.py

@@ -30,7 +30,7 @@ class ExportModuleProc:
     def __call__(self, cell):
         src = cell.source
         if not src: return
-        if cell.cell_type=='markdown' and src.startswith('# '): self.modules['#'].append(cell)
+        if cell.cell_type=='markdown' and (src.startswith('# ') or 'export' in cell.directives_): self._exporti_(cell)
     _exports_=_export_
 
 # %% ../nbs/api/04_export.ipynb #76717e36

{nbdev-3.0.14 → nbdev-3.0.16}/nbdev/maker.py

@@ -111,7 +111,7 @@ def make_code_cells(*ss): return dict2nb({'cells':L(ss).map(mk_cell)}).cells
 # %% ../nbs/api/02_maker.ipynb #a2546836
 def relative_import(name, fname, level=0):
     "Convert a module `name` to a name relative to `fname`"
-    assert not level
+    if level: raise ValueError(f"nbdev export does not support relative imports: module={name}, export_path={fname}")
     sname = name.replace('.','/')
     if not(os.path.commonpath([sname,fname])): return name
     rel = os.path.relpath(sname, fname)
@@ -175,14 +175,15 @@ def _import2relative(cells, lib_path=None):
 
 # %% ../nbs/api/02_maker.ipynb #5bff9d71
 def _retr_mdoc(cells):
-    "Search for md meta quote lines, used to create module docstring"
+    "Search for markdown cells used to create module docstring"
     md1 = first(o for o in cells if o.cell_type=='markdown' and o.source.startswith('# '))
     if not md1: return ''
     lines = dropwhile(lambda l: not l.startswith('> '), md1.source.splitlines())
     lines = list(takewhile(lambda l: l.startswith('> '), lines))
-    if not lines: return ''
     summ = '\n'.join(l.lstrip('> ').strip() for l in lines)
-    return f'"""{summ}"""\n\n' if summ else ''
+    docs = L(o.source.rstrip() for o in cells if o.cell_type=='markdown' and 'export' in getattr(o,'directives_',{}))
+    mdoc = '\n\n'.join(L(summ)+docs).strip()
+    return f'"""{mdoc}"""\n\n' if mdoc else ''
 
 # %% ../nbs/api/02_maker.ipynb #cdd205d6
 @patch

{nbdev-3.0.14 → nbdev-3.0.16}/nbdev/processors.py

@@ -198,8 +198,9 @@ def rm_header_dash(cell):
 _hide_dirs = {'export','exporti', 'hide','default_exp'}
 
 def rm_export(cell):
-    "Remove cells that are exported or hidden"
-    if cell.directives_ and (cell.directives_.keys() & _hide_dirs): del(cell['source'])
+    "Remove code cells that are exported or hidden"
+    if cell.cell_type=='code' and cell.directives_ and (cell.directives_.keys() & _hide_dirs): del(cell['source'])
+
 
 # %% ../nbs/api/10_processors.ipynb #2d9a0a30
 _re_showdoc = re.compile(r'^show_doc', re.MULTILINE)

{nbdev-3.0.14 → nbdev-3.0.16/nbdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.0.14
+Version: 3.0.16
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0

{nbdev-3.0.14 → nbdev-3.0.16}/pyproject.toml

@@ -76,7 +76,7 @@ version = {attr = "nbdev.__version__"}
 include = ["nbdev"]
 
 [tool.nbdev]
-allowed_metadata_keys = ['solveit_dialog_mode', 'solveit_ver']
+allowed_metadata_keys = ['solveit']
 custom_sidebar = true
 readme_nb = "getting_started.ipynb"
 jupyter_hooks = true