nbdev 3.3.11__tar.gz → 3.3.12__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.3.11
+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

{nbdev-3.3.11 → 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.11"
+__version__ = "3.3.12"
 
 from .doclinks import nbdev_export
 from .showdoc import show_doc

{nbdev-3.3.11 → 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.11 → 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.11 → nbdev-3.3.12/nbdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.3.11
+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