nbdev 3.3.10__tar.gz → 3.3.12__tar.gz

{nbdev-3.3.10/nbdev.egg-info → nbdev-3.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.3.10
+Version: 3.3.12
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0
@@ -17,7 +17,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: fastcore>=2.2.7
-Requires-Dist: execnb>=0.2.11
+Requires-Dist: execnb>=0.3.2
 Requires-Dist: astunparse
 Requires-Dist: ghapi>=2.0.2
 Requires-Dist: watchdog

{nbdev-3.3.10 → nbdev-3.3.12}/nbdev/__init__.py

@@ -6,7 +6,7 @@ Modules:
 - `nbdev.moddocs`: # Module docs: creating them from existing notebooks
 - `nbdev.skill`: Author clear, executable nbdev notebooks where code, prose, examples, outputs, and tests form one coherent narrative."""
 
-__version__ = "3.3.10"
+__version__ = "3.3.12"
 
 from .doclinks import nbdev_export
 from .showdoc import show_doc

{nbdev-3.3.10 → nbdev-3.3.12}/nbdev/_modidx.py

@@ -378,7 +378,8 @@ d = { 'settings': { 'branch': 'main',
                             'nbdev.sync._update_nb': ('api/sync.html#_update_nb', 'nbdev/sync.py'),
                             'nbdev.sync.absolute_import': ('api/sync.html#absolute_import', 'nbdev/sync.py'),
                             'nbdev.sync.nbdev_update': ('api/sync.html#nbdev_update', 'nbdev/sync.py')},
-            'nbdev.test': { 'nbdev.test._keep_file': ('api/test.html#_keep_file', 'nbdev/test.py'),
-                            'nbdev.test._test_nb_sync': ('api/test.html#_test_nb_sync', 'nbdev/test.py'),
+            'nbdev.test': { 'nbdev.test._await_chain': ('api/test.html#_await_chain', 'nbdev/test.py'),
+                            'nbdev.test._int_handler': ('api/test.html#_int_handler', 'nbdev/test.py'),
+                            'nbdev.test._keep_file': ('api/test.html#_keep_file', 'nbdev/test.py'),
                             'nbdev.test.nbdev_test': ('api/test.html#nbdev_test', 'nbdev/test.py'),
                             'nbdev.test.test_nb': ('api/test.html#test_nb', 'nbdev/test.py')}}}

{nbdev-3.3.10 → nbdev-3.3.12}/nbdev/config.py

@@ -417,13 +417,16 @@ def update_init_mdoc(path=None, desc=None):
     "Write `pkg_mdoc` as the docstring of `path/__init__.py`, replacing any existing docstring"
     path = Path(path or get_config().lib_path)
     mdoc = pkg_mdoc(path, desc=desc)
-    if not mdoc: return
     fn = path/'__init__.py'
     txt = fn.read_text(encoding='utf-8') if fn.exists() else ''
     body = ast.parse(txt).body
-    rest = txt
+    rest,cur = txt,''
     if body and isinstance(body[0], ast.Expr) and isinstance(getattr(body[0].value, 'value', None), str):
+        cur = body[0].value.value
         rest = ''.join(txt.splitlines(keepends=True)[body[0].end_lineno:])
+    if not mdoc:
+        if '\nModules:\n' not in cur: return
+        mdoc = desc if desc is not None else get_config().description
     res = f'"""{mdoc}"""\n'
     if rest.strip(): res += '\n'+rest.lstrip('\n')
     fn.write_text(res, encoding='utf-8')
@@ -447,11 +450,13 @@ def pkg_llms(path=None, desc=None, index_nb=None):
     return '\n\n'.join(filter(None, parts)) + '\n'
 
 def update_llms_txt(path=None, fn=None, desc=None, index_nb=None):
-    "Write `pkg_llms` to `fn` when it's absent or generated (has the nbdev marker); never touch a hand-written file"
+    "Write `pkg_llms` to `fn` when it's absent or generated (has the nbdev marker)"
     if fn is None: fn = get_config().nbs_path/'llms.txt'
     txt = pkg_llms(path, desc=desc, index_nb=index_nb)
-    if not txt: return
     if fn.exists() and _llms_marker not in fn.read_text(encoding='utf-8'): return
+    if not txt:
+        if fn.exists(): fn.unlink()
+        return
     fn.write_text(txt, encoding='utf-8')
 
 # %% ../nbs/api/01_config.ipynb #95cebda6

{nbdev-3.3.10 → nbdev-3.3.12}/nbdev/diff.py

@@ -5,7 +5,7 @@ Docs: https://nbdev.fast.ai/api/diff.html.md"""
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/19_diff.ipynb.
 
 # %% auto #0
-__all__ = ['read_nb_from_git', 'nbs_pair', 'changed_cells', 'source_diff', 'cell_diffs', 'render_diff', 'nb_diff',
+__all__ = ['MAXLEN', 'read_nb_from_git', 'nbs_pair', 'changed_cells', 'source_diff', 'cell_diffs', 'render_diff', 'nb_diff',
            'nbdev_diff_driver', 'nbdev_diff']
 
 # %% ../nbs/api/19_diff.ipynb #10c8ad0b
@@ -105,9 +105,10 @@ def cell_diffs(nb_path, **kwargs):
     return _cell_changes(nb_path, f, **kwargs)
 
 # %% ../nbs/api/19_diff.ipynb #d670e58e
+MAXLEN = 180 # Most characters shown per displayed line
 _dcolors = {'-':'\x1b[31m', '+':'\x1b[32m', '@':'\x1b[36m', '#':'\x1b[1m', '# ':'\x1b[1;7m'}
 
-def _dline(l, maxlen=120, color=False):
+def _dline(l, maxlen=MAXLEN, color=False):
     "Truncate `l` to `maxlen` with an ellipsis, optionally colored by its leading diff marker"
     if maxlen and len(l)>maxlen: l = l[:maxlen]+'…'
     c = (_dcolors.get(l[:2]) or _dcolors.get(l[:1])) if color else None
@@ -127,7 +128,7 @@ def _diff_order(old, new):
 def render_diff(
     old, # `{id: source}` for the old version of the notebook
     new, # `{id: source}` for the new version
-    maxlen:int=120, # Truncate diff lines to this width (falsy: no limit)
+    maxlen:int=MAXLEN, # Truncate diff lines to this width (falsy: no limit)
     color:bool=False # Add ANSI colors?
 ): # One section per changed cell, in notebook order
     "Render cell-level changes between two notebooks as truncated unified diffs"
@@ -145,7 +146,7 @@ def nb_diff(
     nb_path, # Path to the notebook
     ref_a='HEAD', # First git ref
     ref_b=None, # Second git ref; None for working dir
-    maxlen:int=120, # Truncate diff lines to this width (falsy: no limit)
+    maxlen:int=MAXLEN, # Truncate diff lines to this width (falsy: no limit)
     color:bool=False # Add ANSI colors?
 ): # Rendered diff of changed cells
     "Rendered cell diff for `nb_path` between two refs"
@@ -172,7 +173,7 @@ def nbdev_diff_driver(
     new_mode:_pos=None, # Post-change file mode
     rename_to:_pos=None, # New repo path, when git detected a rename
     similarity:_pos=None, # Similarity score, when git detected a rename
-    maxlen:int=120 # Truncate diff lines to this width (0 for no limit)
+    maxlen:int=MAXLEN # Truncate diff lines to this width (0 for no limit)
 ):
     "Git external diff driver for notebooks; installed by `nbdev-install-hooks`"
     if not new_file: return print(f'unmerged: {path}')
@@ -188,7 +189,7 @@ def nbdev_diff(
     path:str=None, # Notebook or directory (default: project's notebooks folder)
     ref_a:str='HEAD', # First git ref
     ref_b:str=None, # Second git ref (default: working directory)
-    maxlen:int=120, # Truncate diff lines to this width (0 for no limit)
+    maxlen:int=MAXLEN, # Truncate diff lines to this width (0 for no limit)
     color:bool_arg=None # Add ANSI colors? (default: only if stdout is a tty)
 ):
     "Cell-level diffs for changed notebooks between two git refs"

{nbdev-3.3.10 → nbdev-3.3.12}/nbdev/processors.py

@@ -12,8 +12,6 @@ __all__ = ['populate_language', 'insert_warning', 'cell_lang', 'add_show_docs',
 # %% ../nbs/api/10_processors.ipynb #2398f5ef-06d3-4890-8a54-7cf4f81f3894
 import ast
 
-from fastcore.aio import run_sync
-
 from .config import *
 from .imports import *
 from .process import *
@@ -257,7 +255,7 @@ class exec_show_docs(Processor):
         if not self.nb.has_docs_ or not hasattr(self, 'k'): return
         fm = getattr(self.nb, 'frontmatter_', {})
         if str2bool(fm.get('skip_showdoc', False)): return
-        if _do_eval(cell): run_sync(self.k.cell(cell))
+        if _do_eval(cell): self.k.cell(cell)
         title = fm.get('title', '')
         if self.k.exc: 
             raise Exception(f"Error{' in notebook: '+title if title else ''} in cell {cell.idx_} :\n{cell.source}") from self.k.exc

{nbdev-3.3.10 → nbdev-3.3.12}/nbdev/test.py

@@ -8,7 +8,7 @@ Docs: https://nbdev.fast.ai/api/test.html.md"""
 __all__ = ['test_nb', 'nbdev_test']
 
 # %% ../nbs/api/12_test.ipynb #45e10c3f
-import time,os,sys,traceback,contextlib,inspect,faulthandler,signal,asyncio
+import time,os,sys,io,traceback,contextlib,inspect,signal,asyncio,threading
 from fastcore.basics import *
 from fastcore.imports import *
 from fastcore.foundation import *
@@ -24,8 +24,38 @@ from .frontmatter import nb_frontmatter
 from fastcore.nbio import *
 from execnb.shell import *
 
+# %% ../nbs/api/12_test.ipynb #dc8994ac
+_cur_nb = [None]
+_cur_shell = [None]
+
+def _await_chain(t):
+    "One frame per coroutine in task `t`'s await chain, deepest last: where a suspended hang actually sits"
+    co = t.get_coro()
+    while co is not None:
+        f = getattr(co, 'cr_frame', None) or getattr(co, 'ag_frame', None) or getattr(co, 'gi_frame', None)
+        if f is not None: yield f, f.f_lineno
+        co = getattr(co, 'cr_await', None) or getattr(co, 'ag_await', None) or getattr(co, 'gi_yieldfrom', None)
+
+def _int_handler(signum, frame):
+    "Dump the running notebook's stack and exit; installed on SIGINT by `test_nb`"
+    if _cur_nb[0] is not None:
+        buf = io.StringIO()
+        traceback.print_stack(frame, file=buf)
+        k = _cur_shell[0]
+        if k is not None:
+            f = sys._current_frames().get(k._thread.ident)
+            if f is not None:
+                print('\n--- shell loop thread ---', file=buf)
+                traceback.print_stack(f, file=buf)
+            with contextlib.suppress(RuntimeError):
+                for t in asyncio.all_tasks(k.loop):
+                    print(f'\n{t}', file=buf)
+                    buf.writelines(traceback.StackSummary.extract(_await_chain(t)).format())
+        os.write(2, f'\n=== nbdev-test interrupted: {_cur_nb[0]} ===\n{buf.getvalue()}'.encode())
+    os._exit(130)
+
 # %% ../nbs/api/12_test.ipynb #3f4fa1ad
-async def test_nb(
+def test_nb(
     fn,  # file name of notebook to test
     skip_flags=None,  # list of flags marking cells to skip
     force_flags=None,  # list of flags marking cells to always run
@@ -34,11 +64,13 @@ async def test_nb(
     basepath=None,  # path to add to sys.path
     verbose=False,  # stream stdout/stderr from cells to console?
     save=False,  # write outputs back to notebook on success?
-    profile:bool=None # load the IPython profile, as `ipykernel` does? (default: `exec_profile` config key)
+    profile:bool=None, # load the IPython profile, as `ipykernel` does? (default: `exec_profile` config key)
+    cell_timeout:int=600  # seconds before each cell times out (None: no limit)
 ):
     "Execute tests in notebook in `fn` except those with `skip_flags`"
-    faulthandler.register(signal.SIGINT, file=sys.__stderr__, all_threads=True, chain=True)
+    if not IN_NOTEBOOK and threading.current_thread() is threading.main_thread(): signal.signal(signal.SIGINT, _int_handler)
     fn = Path(fn)
+    _cur_nb[0] = fn
     if basepath: sys.path.insert(0, str(basepath))
     prev_test = os.environ.get('IN_TEST')
     if not IN_NOTEBOOK: os.environ['IN_TEST'] = '1'
@@ -57,25 +89,25 @@ async def test_nb(
         start = time.time()
         if profile is None: profile = bool(get_config(fn.parent).exec_profile)
         k = CaptureShell(fn, profile=profile)
+        _cur_shell[0] = k
         if do_print: print(f'Starting {fn}')
         try:
             with working_directory(fn.parent):
-                await k.run_all(nb, exc_stop=True, preproc=_no_eval, verbose=verbose)
+                k.run_all(nb, exc_stop=True, preproc=_no_eval, verbose=verbose, cell_timeout=cell_timeout)
                 if save: write_nb(nb, fn)
                 res = True
         except: 
             if showerr: sys.stderr.write(k.prettytb(fname=fn)+'\n')
             res=False
+        if k.leaks and showerr: sys.stderr.write(f'{fn}: {len(k.leaks)} leaked task(s) survived cancellation\n')
         if do_print: print(f'- Completed {fn}')
         return res,time.time()-start
     finally:
+        _cur_nb[0] = _cur_shell[0] = None
         if prev_test is None: os.environ.pop('IN_TEST', None)
         else: os.environ['IN_TEST'] = prev_test
 
 
-# %% ../nbs/api/12_test.ipynb #12516e0a
-def _test_nb_sync(fn, **kwargs): return asyncio.run(test_nb(fn, **kwargs))
-
 # %% ../nbs/api/12_test.ipynb #d8bf1f1b-935d-4b69-ba96-827c5d7213f0
 def _keep_file(
     p:Path, # filename for which to check for `indicator_fname`
@@ -98,6 +130,7 @@ def nbdev_test(
     ignore_fname:str='.notest', # Filename that will result in siblings being ignored
     verbose:bool=False, # Print stdout/stderr from notebook cells?
     save:bool=False, # Write outputs back to notebooks on success?
+    cell_timeout:int=600, # Seconds before each cell times out (0: no limit)
     **kwargs
 ):
     "Test in parallel notebooks matching `path`, passing along `flags`"
@@ -114,8 +147,13 @@ def nbdev_test(
     else: kw = {'method':'spawn'} if sys.platform=='darwin' else {}
     wd_pth = cfg.nbs_path
     with working_directory(wd_pth if (wd_pth and wd_pth.exists()) else os.getcwd()):
-        results = parallel(_test_nb_sync, files, skip_flags=skip_flags, force_flags=force_flags, n_workers=n_workers,
-                           basepath=cfg.config_path, pause=pause, do_print=do_print, verbose=verbose, save=save, **kw)
+        try:
+            results = parallel(test_nb, files, skip_flags=skip_flags, force_flags=force_flags, n_workers=n_workers,
+                               basepath=cfg.config_path, pause=pause, do_print=do_print, verbose=verbose, save=save,
+                               cell_timeout=cell_timeout or None, **kw)
+        except KeyboardInterrupt:
+            sys.stderr.write('\nnbdev-test interrupted; in-flight notebook stacks shown above\n')
+            sys.exit(130)
     passed,times = zip(*results)
     if all(passed): print("Success.")
     else: 

{nbdev-3.3.10 → nbdev-3.3.12/nbdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.3.10
+Version: 3.3.12
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0
@@ -17,7 +17,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: fastcore>=2.2.7
-Requires-Dist: execnb>=0.2.11
+Requires-Dist: execnb>=0.3.2
 Requires-Dist: astunparse
 Requires-Dist: ghapi>=2.0.2
 Requires-Dist: watchdog

{nbdev-3.3.10 → nbdev-3.3.12}/nbdev.egg-info/requires.txt

@@ -1,5 +1,5 @@
 fastcore>=2.2.7
-execnb>=0.2.11
+execnb>=0.3.2
 astunparse
 ghapi>=2.0.2
 watchdog

{nbdev-3.3.10 → nbdev-3.3.12}/pyproject.toml

@@ -19,7 +19,7 @@ classifiers = [
     "License :: OSI Approved :: Apache Software License",
 ]
 dynamic = ["version"]
-dependencies = [ "fastcore>=2.2.7", "execnb>=0.2.11", "astunparse", "ghapi>=2.0.2", "watchdog", "asttokens",
+dependencies = [ "fastcore>=2.2.7", "execnb>=0.3.2", "astunparse", "ghapi>=2.0.2", "watchdog", "asttokens",
     "setuptools", "build", "fastgit>=0.0.7", "pyyaml", "tomli; python_version < '3.11'", ]
 
 [project.optional-dependencies]