nbdev 2.3.27__py3-none-any.whl → 2.3.29__py3-none-any.whl

nbdev/processors.py

@@ -1,11 +1,13 @@
+"""Some processors for NBProcessor"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/10_processors.ipynb.
 
 # %% auto 0
 __all__ = ['populate_language', 'insert_warning', 'cell_lang', 'add_show_docs', 'fdiv', 'boxify', 'mv_exports', 'add_links',
-           'add_fold', 'strip_ansi', 'strip_hidden_metadata', 'hide_', 'hide_line', 'filter_stream_', 'clean_magics',
-           'rm_header_dash', 'rm_export', 'clean_show_doc', 'exec_show_docs', 'FilterDefaults']
+           'add_fold', 'strip_ansi', 'strip_hidden_metadata', 'hide_', 'hide_line', 'filter_stream_', 'ai_magics',
+           'clean_magics', 'rm_header_dash', 'rm_export', 'clean_show_doc', 'exec_show_docs', 'FilterDefaults']
 
-# %% ../nbs/api/10_processors.ipynb 2
+# %% ../nbs/api/10_processors.ipynb
 import ast
 import importlib
 
@@ -23,7 +25,7 @@ from fastcore.imports import *
 from fastcore.xtras import *
 import sys,yaml
 
-# %% ../nbs/api/10_processors.ipynb 7
+# %% ../nbs/api/10_processors.ipynb
 _langs = 'bash|html|javascript|js|latex|markdown|perl|ruby|sh|svg'
 _lang_pattern = re.compile(rf'^\s*%%\s*({_langs})\s*$', flags=re.MULTILINE)
 
@@ -36,13 +38,13 @@ class populate_language(Processor):
         if lang: cell.metadata.language = lang[0]
         else: cell.metadata.language = self.language
 
-# %% ../nbs/api/10_processors.ipynb 9
+# %% ../nbs/api/10_processors.ipynb
 class insert_warning(Processor):
     "Insert Autogenerated Warning Into Notebook after the first cell."
     content = "<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->"
     def begin(self): self.nb.cells.insert(1, mk_cell(self.content, 'markdown'))
 
-# %% ../nbs/api/10_processors.ipynb 13
+# %% ../nbs/api/10_processors.ipynb
 _def_types = (ast.FunctionDef,ast.AsyncFunctionDef,ast.ClassDef)
 def _def_names(cell, shown):
     cellp = cell.parsed_()
@@ -55,7 +57,7 @@ def _get_nm(tree):
     else: val = try_attrs(i.value, 'id', 'func', 'attr')
     return f'{val}.{i.attr}' if isinstance(i, ast.Attribute) else i.id
 
-# %% ../nbs/api/10_processors.ipynb 14
+# %% ../nbs/api/10_processors.ipynb
 def _show_docs(trees):
     return [t for t in trees if isinstance(t,ast.Expr) and nested_attr(t, 'value.func.id')=='show_doc']
 
@@ -82,20 +84,20 @@ class add_show_docs(Processor):
                 nb.cells.insert(cell.idx_+1, new_cell)
         nb.has_docs_ = shown_docs or exports
 
-# %% ../nbs/api/10_processors.ipynb 17
+# %% ../nbs/api/10_processors.ipynb
 def fdiv(attrs=''):
     "Create a fenced div markdown cell in quarto"
     if attrs: attrs = ' {'+attrs+'}'
     return mk_cell(':::'+attrs, cell_type='markdown')
 
-# %% ../nbs/api/10_processors.ipynb 19
+# %% ../nbs/api/10_processors.ipynb
 def boxify(cells):
     "Add a box around `cells`"
     if not isinstance(cells, list): cells = [cells]
     res = [fdiv('.py-2 .px-3 .mb-4 fig-align="center" .border .rounded .shadow-sm')]
     return res+cells+[fdiv()]
 
-# %% ../nbs/api/10_processors.ipynb 20
+# %% ../nbs/api/10_processors.ipynb
 class mv_exports(Processor):
     "Move `exports` cells to after the `show_doc`"
     def begin(self):
@@ -108,7 +110,7 @@ class mv_exports(Processor):
                 srccell = cells.pop(idx)
                 cells[idx:idx] = [doccell,srccell]
 
-# %% ../nbs/api/10_processors.ipynb 21
+# %% ../nbs/api/10_processors.ipynb
 _re_defaultexp = re.compile(r'^\s*#\|\s*default_exp\s+(\S+)', flags=re.MULTILINE)
 
 def _default_exp(nb):
@@ -117,7 +119,7 @@ def _default_exp(nb):
     default_exp = first(code_src.filter().map(_re_defaultexp.search).filter())
     return default_exp.group(1) if default_exp else None
 
-# %% ../nbs/api/10_processors.ipynb 23
+# %% ../nbs/api/10_processors.ipynb
 def add_links(cell):
     "Add links to markdown cells"
     nl = NbdevLookup()
@@ -126,13 +128,13 @@ def add_links(cell):
         if hasattr(o, 'data') and hasattr(o['data'], 'text/markdown'):
             o.data['text/markdown'] = [nl.link_line(s) for s in o.data['text/markdown']]
 
-# %% ../nbs/api/10_processors.ipynb 25
+# %% ../nbs/api/10_processors.ipynb
 def add_fold(cell):
     "Add `code-fold` to `exports` cells"
     if cell.cell_type != 'code' or 'exports' not in cell.directives_: return
     cell.source = f'#| code-fold: show\n#| code-summary: "Exported source"\n{cell.source}'
 
-# %% ../nbs/api/10_processors.ipynb 28
+# %% ../nbs/api/10_processors.ipynb
 _re_ansi_escape = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
 
 def strip_ansi(cell):
@@ -140,17 +142,17 @@ def strip_ansi(cell):
     for outp in cell.get('outputs', []):
         if outp.get('name')=='stdout': outp['text'] = [_re_ansi_escape.sub('', o) for o in outp.text]
 
-# %% ../nbs/api/10_processors.ipynb 30
+# %% ../nbs/api/10_processors.ipynb
 def strip_hidden_metadata(cell):
     '''Strips "hidden" metadata property from code cells so it doesn't interfere with docs rendering'''
     if cell.cell_type == 'code' and 'metadata' in cell: cell.metadata.pop('hidden',None)
 
-# %% ../nbs/api/10_processors.ipynb 31
+# %% ../nbs/api/10_processors.ipynb
 def hide_(cell):
     "Hide cell from output"
     del(cell['source'])
 
-# %% ../nbs/api/10_processors.ipynb 33
+# %% ../nbs/api/10_processors.ipynb
 def _re_hideline(lang=None): return re.compile(fr'{langs[lang]}\|\s*hide_line\s*$', re.MULTILINE)
 
 def hide_line(cell):
@@ -159,7 +161,7 @@ def hide_line(cell):
     if cell.cell_type == 'code' and _re_hideline(lang).search(cell.source):
         cell.source = '\n'.join([c for c in cell.source.splitlines() if not _re_hideline(lang).search(c)])
 
-# %% ../nbs/api/10_processors.ipynb 36
+# %% ../nbs/api/10_processors.ipynb
 def filter_stream_(cell, *words):
     "Remove output lines containing any of `words` in `cell` stream output"
     if not words: return
@@ -167,14 +169,23 @@ def filter_stream_(cell, *words):
         if outp.output_type == 'stream':
             outp['text'] = [l for l in outp.text if not re.search('|'.join(words), l)]
 
-# %% ../nbs/api/10_processors.ipynb 38
+# %% ../nbs/api/10_processors.ipynb
+_aimagics_pattern = re.compile(r'^\s*(%%ai.? |%%ai.?$)', re.MULTILINE)
+
+def ai_magics(cell):
+    "A preprocessor to convert AI magics to markdown"
+    if cell.cell_type == 'code' and _aimagics_pattern.search(cell.source):
+        cell.cell_type ='markdown'
+        cell.source = '\n'.join(cell.source.splitlines()[1:])
+
+# %% ../nbs/api/10_processors.ipynb
 _magics_pattern = re.compile(r'^\s*(%%|%).*', re.MULTILINE)
 
 def clean_magics(cell):
     "A preprocessor to remove cell magic commands"
     if cell.cell_type == 'code': cell.source = _magics_pattern.sub('', cell.source).strip()
 
-# %% ../nbs/api/10_processors.ipynb 40
+# %% ../nbs/api/10_processors.ipynb
 _re_hdr_dash = re.compile(r'^#+\s+.*\s+-\s*$', re.MULTILINE)
 
 def rm_header_dash(cell):
@@ -183,14 +194,14 @@ def rm_header_dash(cell):
         src = cell.source.strip()
         if cell.cell_type == 'markdown' and src.startswith('#') and src.endswith(' -'): del(cell['source'])
 
-# %% ../nbs/api/10_processors.ipynb 42
+# %% ../nbs/api/10_processors.ipynb
 _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'])
 
-# %% ../nbs/api/10_processors.ipynb 44
+# %% ../nbs/api/10_processors.ipynb
 _re_showdoc = re.compile(r'^show_doc', re.MULTILINE)
 def _is_showdoc(cell): return cell['cell_type'] == 'code' and _re_showdoc.search(cell.source)
 def _add_directives(cell, d):
@@ -202,7 +213,7 @@ def clean_show_doc(cell):
     if not _is_showdoc(cell): return
     _add_directives(cell, {'output':'asis','echo':'false'})
 
-# %% ../nbs/api/10_processors.ipynb 45
+# %% ../nbs/api/10_processors.ipynb
 def _ast_contains(trees, types):
     for tree in trees:
         for node in ast.walk(tree):
@@ -223,7 +234,7 @@ def _do_eval(cell):
         return True
     if _show_docs(trees): return True
 
-# %% ../nbs/api/10_processors.ipynb 46
+# %% ../nbs/api/10_processors.ipynb
 class exec_show_docs(Processor):
     "Execute cells needed for `show_docs` output, including exported cells and imports"
     def begin(self):
@@ -250,13 +261,13 @@ class exec_show_docs(Processor):
             widgets = {**old, **new, 'state': {**old.get('state', {}), **new['state']}}
             self.nb.metadata['widgets'] = {mimetype: widgets}
 
-# %% ../nbs/api/10_processors.ipynb 48
+# %% ../nbs/api/10_processors.ipynb
 def _import_obj(s):
     mod_nm, obj_nm = s.split(':')
     mod = importlib.import_module(mod_nm)
     return getattr(mod, obj_nm)
 
-# %% ../nbs/api/10_processors.ipynb 49
+# %% ../nbs/api/10_processors.ipynb
 class FilterDefaults:
     "Override `FilterDefaults` to change which notebook processors are used"
     def xtra_procs(self):
@@ -266,7 +277,8 @@ class FilterDefaults:
     def base_procs(self):
         return [FrontmatterProc, populate_language, add_show_docs, insert_warning,
                 strip_ansi, hide_line, filter_stream_, rm_header_dash,
-                clean_show_doc, exec_show_docs, rm_export, clean_magics, hide_, add_links, add_fold, mv_exports, strip_hidden_metadata]
+                clean_show_doc, exec_show_docs, rm_export, ai_magics, clean_magics, hide_, add_links,
+                add_fold, mv_exports, strip_hidden_metadata]
 
     def procs(self):
         "Processors for export"

nbdev/qmd.py

@@ -1,3 +1,5 @@
+"""Basic qmd generation helpers (experimental)"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/15_qmd.ipynb.
 
 # %% ../nbs/api/15_qmd.ipynb 2
@@ -10,7 +12,7 @@ from fastcore.meta import delegates
 # %% auto 0
 __all__ = ['meta', 'div', 'img', 'btn', 'tbl_row', 'tbl_sep']
 
-# %% ../nbs/api/15_qmd.ipynb 4
+# %% ../nbs/api/15_qmd.ipynb
 def meta(md,  # Markdown to add meta to
          classes=None,  # List of CSS classes to add
          style=None,  # Dict of CSS styles to add
@@ -25,7 +27,7 @@ def meta(md,  # Markdown to add meta to
     meta = ' '.join(meta)
     return md + ("{" + meta + "}" if meta else "")
 
-# %% ../nbs/api/15_qmd.ipynb 5
+# %% ../nbs/api/15_qmd.ipynb
 def div(txt,  # Markdown to add meta to
         classes=None,  # List of CSS classes to add
         style=None,  # Dict of CSS styles to add
@@ -33,7 +35,7 @@ def div(txt,  # Markdown to add meta to
     "A qmd div with optional metadata section"
     return meta("::: ", classes=classes, style=style, **kwargs) + f"\n\n{txt}\n\n:::\n\n"
 
-# %% ../nbs/api/15_qmd.ipynb 6
+# %% ../nbs/api/15_qmd.ipynb
 def img(fname,  # Image to link to
         classes=None,  # List of CSS classes to add
         style=None,   # Dict of CSS styles to add
@@ -51,7 +53,7 @@ def img(fname,  # Image to link to
     res = meta(f'![]({fname})', classes=classes, style=style, **kwargs)
     return  f'[{res}]({fname})' if link else res
 
-# %% ../nbs/api/15_qmd.ipynb 7
+# %% ../nbs/api/15_qmd.ipynb
 def btn(txt, # Button text
         link,  # Button link URL
         classes=None,  # List of CSS classes to add
@@ -60,20 +62,20 @@ def btn(txt, # Button text
     "A qmd button"
     return meta(f'[{txt}]({link})', classes=classes, style=style, role="button")
 
-# %% ../nbs/api/15_qmd.ipynb 8
+# %% ../nbs/api/15_qmd.ipynb
 def tbl_row(cols:list,  # Auto-stringified columns to show in the row
            ):
     "Create a markdown table row from `cols`"
     return '|' + '|'.join(str(c or '') for c in cols) + '|'
 
-# %% ../nbs/api/15_qmd.ipynb 9
+# %% ../nbs/api/15_qmd.ipynb
 def tbl_sep(sizes:int|list=3  # List of column sizes, or single `int` if all sizes the same
            ):
     "Create a markdown table separator with relative column size `sizes`"
     if isinstance(sizes,int): sizes = [3]*sizes
     return tbl_row('-'*s for s in sizes)
 
-# %% ../nbs/api/15_qmd.ipynb 10
+# %% ../nbs/api/15_qmd.ipynb
 def _install_nbdev():
     return div('''#### pip
 

nbdev/quarto.py

@@ -1,3 +1,5 @@
+"""Install and interact with Quarto from nbdev"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/14_quarto.ipynb.
 
 # %% ../nbs/api/14_quarto.ipynb 3
@@ -21,12 +23,12 @@ import yaml
 __all__ = ['BASE_QUARTO_URL', 'install_quarto', 'install', 'IndentDumper', 'nbdev_sidebar', 'refresh_quarto_yml',
            'nbdev_proc_nbs', 'nbdev_readme', 'nbdev_docs', 'prepare', 'fs_watchdog', 'nbdev_preview']
 
-# %% ../nbs/api/14_quarto.ipynb 5
+# %% ../nbs/api/14_quarto.ipynb
 def _sprun(cmd):
     try: subprocess.check_output(cmd, shell=True)
     except subprocess.CalledProcessError as cpe: sys.exit(cpe.returncode)
 
-# %% ../nbs/api/14_quarto.ipynb 7
+# %% ../nbs/api/14_quarto.ipynb
 BASE_QUARTO_URL='https://www.quarto.org/download/latest/'
 
 def _install_linux():
@@ -53,7 +55,7 @@ def install_quarto():
         elif 'linux' in sys.platform: _install_linux()
     finally: system('sudo rm -f .installing')
 
-# %% ../nbs/api/14_quarto.ipynb 8
+# %% ../nbs/api/14_quarto.ipynb
 @call_parse
 def install():
     "Install Quarto and the current library"
@@ -61,7 +63,7 @@ def install():
     d = get_config().lib_path
     if (d/'__init__.py').exists(): system(f'pip install -e "{d.parent}[dev]"')
 
-# %% ../nbs/api/14_quarto.ipynb 10
+# %% ../nbs/api/14_quarto.ipynb
 def _pre(p,b=True): return '    ' * (len(p.parts)) + ('- ' if b else '  ')
 def _sort(a):
     x,y = a
@@ -78,7 +80,7 @@ def _nbglob_docs(
     **kwargs):
     return nbglob(path, file_glob=file_glob, file_re=file_re, **kwargs)
 
-# %% ../nbs/api/14_quarto.ipynb 11
+# %% ../nbs/api/14_quarto.ipynb
 def _recursive_parser(
         dir_dict: dict, # Directory structure as a dict.
         contents: list, # `contents` list from `sidebar.yaml` template dict.
@@ -101,7 +103,7 @@ class IndentDumper(yaml.Dumper):
     def increase_indent(self, flow=False, indentless=False):
         return super(IndentDumper, self).increase_indent(flow, False)
 
-# %% ../nbs/api/14_quarto.ipynb 12
+# %% ../nbs/api/14_quarto.ipynb
 @call_parse
 @delegates(_nbglob_docs)
 def nbdev_sidebar(
@@ -136,7 +138,7 @@ def nbdev_sidebar(
     if printit: return print(yml)
     yml_path.write_text(yml)
 
-# %% ../nbs/api/14_quarto.ipynb 15
+# %% ../nbs/api/14_quarto.ipynb
 _quarto_yml="""project:
   type: website
 
@@ -145,6 +147,8 @@ format:
     theme: cosmo
     css: styles.css
     toc: true
+    keep-md: true
+  commonmark: default
 
 website:
   twitter-card: true
@@ -158,7 +162,7 @@ website:
 
 metadata-files: [nbdev.yml, sidebar.yml]"""
 
-# %% ../nbs/api/14_quarto.ipynb 16
+# %% ../nbs/api/14_quarto.ipynb
 _nbdev_yml="""project:
   output-dir: {doc_path}
 
@@ -170,7 +174,7 @@ website:
   repo-url: "{git_url}"
 """
 
-# %% ../nbs/api/14_quarto.ipynb 17
+# %% ../nbs/api/14_quarto.ipynb
 def refresh_quarto_yml():
     "Generate `_quarto.yml` from `settings.ini`."
     cfg = get_config()
@@ -184,13 +188,13 @@ def refresh_quarto_yml():
     if qy.exists() and not str2bool(cfg.get('custom_quarto_yml', True)): qy.unlink()
     if not qy.exists(): qy.write_text(_quarto_yml)
 
-# %% ../nbs/api/14_quarto.ipynb 18
+# %% ../nbs/api/14_quarto.ipynb
 def _ensure_quarto():
     if shutil.which('quarto'): return
     print("Quarto is not installed. We will download and install it for you.")
     install.__wrapped__()
 
-# %% ../nbs/api/14_quarto.ipynb 19
+# %% ../nbs/api/14_quarto.ipynb
 def _pre_docs(path=None, n_workers:int=defaults.cpus, **kwargs):
     cfg = get_config()
     path = Path(path) if path else cfg.nbs_path
@@ -202,21 +206,21 @@ def _pre_docs(path=None, n_workers:int=defaults.cpus, **kwargs):
     cache = proc_nbs(path, n_workers=n_workers, **kwargs)
     return cache,cfg,path
 
-# %% ../nbs/api/14_quarto.ipynb 20
+# %% ../nbs/api/14_quarto.ipynb
 @call_parse
 @delegates(proc_nbs)
 def nbdev_proc_nbs(**kwargs):
     "Process notebooks in `path` for docs rendering"
     _pre_docs(**kwargs)[0]
 
-# %% ../nbs/api/14_quarto.ipynb 22
+# %% ../nbs/api/14_quarto.ipynb
 def _readme_mtime_not_older(readme_path, readme_nb_path):
     if not readme_nb_path.exists():
         print(f"Could not find {readme_nb_path}")
         return True
     return readme_path.exists() and readme_path.stat().st_mtime>=readme_nb_path.stat().st_mtime
 
-# %% ../nbs/api/14_quarto.ipynb 23
+# %% ../nbs/api/14_quarto.ipynb
 class _SidebarYmlRemoved:
     "Context manager for `nbdev_readme` to avoid rendering whole docs website"
     def __init__(self,path): self._path=path
@@ -229,14 +233,14 @@ class _SidebarYmlRemoved:
     def __exit__(self, exc_type, exc_value, exc_tb):
         if self._moved: (self._path/'sidebar.yml.bak').rename(self._yml_path)
 
-# %% ../nbs/api/14_quarto.ipynb 24
+# %% ../nbs/api/14_quarto.ipynb
 def _copytree(a,b):
     if sys.version_info.major >=3 and sys.version_info.minor >=8: copytree(a, b, dirs_exist_ok=True)
     else:
         from distutils.dir_util import copy_tree
         copy_tree(a, b)
 
-# %% ../nbs/api/14_quarto.ipynb 25
+# %% ../nbs/api/14_quarto.ipynb
 def _save_cached_readme(cache, cfg):
     tmp_doc_path = cache/cfg.doc_path.name
     readme = tmp_doc_path/'README.md'
@@ -247,7 +251,7 @@ def _save_cached_readme(cache, cfg):
         _rdmi = tmp_doc_path/((cache/cfg.readme_nb).stem + '_files') # Supporting files for README
         if _rdmi.exists(): _copytree(_rdmi, cfg.config_path/_rdmi.name)
 
-# %% ../nbs/api/14_quarto.ipynb 26
+# %% ../nbs/api/14_quarto.ipynb
 @call_parse
 def nbdev_readme(
     path:str=None, # Path to notebooks
@@ -263,7 +267,7 @@ def nbdev_readme(
         
     _save_cached_readme(cache, cfg)
 
-# %% ../nbs/api/14_quarto.ipynb 29
+# %% ../nbs/api/14_quarto.ipynb
 @call_parse
 @delegates(_nbglob_docs)
 def nbdev_docs(
@@ -277,7 +281,7 @@ def nbdev_docs(
     shutil.rmtree(cfg.doc_path, ignore_errors=True)
     move(cache/cfg.doc_path.name, cfg.config_path)
 
-# %% ../nbs/api/14_quarto.ipynb 31
+# %% ../nbs/api/14_quarto.ipynb
 @call_parse
 def prepare():
     "Export, test, and clean notebooks, and render README if needed"
@@ -288,7 +292,7 @@ def prepare():
     refresh_quarto_yml()
     nbdev_readme.__wrapped__(chk_time=True)
 
-# %% ../nbs/api/14_quarto.ipynb 33
+# %% ../nbs/api/14_quarto.ipynb
 @contextmanager
 def fs_watchdog(func, path, recursive:bool=True):
     "File system watchdog dispatching to `func`"
@@ -304,7 +308,7 @@ def fs_watchdog(func, path, recursive:bool=True):
         observer.stop()
         observer.join()
 
-# %% ../nbs/api/14_quarto.ipynb 34
+# %% ../nbs/api/14_quarto.ipynb
 @call_parse
 @delegates(_nbglob_docs)
 def nbdev_preview(