nbdev 2.3.23__py3-none-any.whl → 2.3.26__py3-none-any.whl

nbdev/__init__.py

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

nbdev/clean.py

@@ -30,6 +30,7 @@ def nbdev_trust(
         import warnings
         warnings.warn("Please install jupyter and try again")
         return
+    from nbformat import read
 
     fname = Path(fname if fname else get_config().nbs_path)
     path = fname if fname.is_dir() else fname.parent
@@ -40,7 +41,7 @@ def nbdev_trust(
         if last_checked and not force_all:
             last_changed = os.path.getmtime(fn)
             if last_changed < last_checked: continue
-        nb = read_nb(fn)
+        with open(fn, 'r', encoding='utf-8') as f: nb = read(f, as_version=4)
         if not NotebookNotary().check_signature(nb): NotebookNotary().sign(nb)
     check_fname.touch(exist_ok=True)
 
@@ -121,7 +122,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").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)
+    clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)
+    if path: nbdev_trust.__wrapped__(path)
 
 # %% ../nbs/api/11_clean.ipynb 29
 @call_parse

nbdev/config.py

@@ -66,6 +66,7 @@ def _apply_defaults(
     jupyter_hooks:bool_arg=False, # Run Jupyter hooks?
     clean_ids:bool_arg=True, # Remove ids from plaintext reprs?
     clear_all:bool_arg=False, # Remove all cell metadata and cell outputs?
+    cell_number:bool_arg=True, # Add cell number to the exported file
     put_version_in_init:bool_arg=True, # Add the version to the main __init__.py in nbdev_export
 ):
     "Apply default settings where missing in `cfg`."
@@ -222,7 +223,7 @@ def create_output(txt, mime):
 def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
 
 # %% ../nbs/api/01_config.ipynb 48
-_re_version = re.compile('^__version__\s*=.*$', re.MULTILINE)
+_re_version = re.compile(r'^__version__\s*=.*$', re.MULTILINE)
 _init = '__init__.py'
 
 def update_version(path=None):
@@ -251,10 +252,12 @@ def add_init(path=None):
     if get_config().get('put_version_in_init', True): update_version(path)
 
 # %% ../nbs/api/01_config.ipynb 51
-def write_cells(cells, hdr, file, offset=0):
+def write_cells(cells, hdr, file, offset=0, cell_number=True):
     "Write `cells` to `file` along with header `hdr` starting at index `offset` (mainly for nbdev internal use)."
     for cell in cells:
-        if cell.source.strip(): file.write(f'\n\n{hdr} {cell.idx_+offset}\n{cell.source}')
+        if cell.source.strip():
+            idx = f" {cell.idx_+offset}" if cell_number else ""
+            file.write(f'\n\n{hdr}{idx}\n{cell.source}')
 
 # %% ../nbs/api/01_config.ipynb 52
 def _basic_export_nb(fname, name, dest=None):

nbdev/doclinks.py

@@ -47,16 +47,22 @@ def _iter_py_cells(p):
     "Yield cells from an exported Python file."
     p = Path(p)
     cells = p.read_text(encoding='utf-8').split("\n# %% ")
+    has_cell_number = get_config().cell_number
     for cell in cells[1:]:
         top,code = cell.split('\n', 1)
         try:
-          *nb,idx = top.split()
-          nb = ' '.join(nb)
+            if has_cell_number:
+                *nb,idx = top.split()
+                nb = ' '.join(nb)
+                idx = int(idx)
+            else:
+                nb = top
+                idx = None
         except ValueError: raise ValueError(f"Unexpected format in '{p}' at cell:\n```\n# %% {cell.strip()}.\n```\n"
                                             "The expected format is: '# %% {nb_path} {cell_idx}'.")
         nb_path = None if nb=='auto' else (p.parent/nb).resolve()  # NB paths are stored relative to .py file
         if code.endswith('\n'): code=code[:-1]
-        yield AttrDict(nb=nb, idx=int(idx), code=code, nb_path=nb_path, py_path=p.resolve())
+        yield AttrDict(nb=nb, idx=idx, code=code, nb_path=nb_path, py_path=p.resolve())
 
 # %% ../nbs/api/05_doclinks.ipynb 11
 def _nbpath2html(p): return p.with_name(re.sub(r'^\d+[a-zA-Z0-9]*_', '', p.name.lower())).with_suffix('.html')
@@ -71,7 +77,7 @@ def _get_modidx(py_path, code_root, nbs_path):
     _def_types = ast.FunctionDef,ast.AsyncFunctionDef,ast.ClassDef
     d = {}
     for cell in _iter_py_cells(py_path):
-        if cell.nb == 'auto': continue
+        if 'auto' in cell.nb: continue
         loc = _nbpath2html(cell.nb_path.relative_to(nbs_path))
 
         def _stor(nm):
@@ -98,7 +104,7 @@ def _build_modidx(dest=None, nbs_path=None, skip_exists=False):
     res['settings'] = {k:v for k,v in get_config().d.items()
                        if k in ('doc_host','doc_baseurl','lib_path','git_url','branch')}
     code_root = dest.parent.resolve()
-    for file in globtastic(dest, file_glob="*.py", skip_file_re='^_', skip_folder_re="\.ipynb_checkpoints"):
+    for file in globtastic(dest, file_glob="*.py", skip_file_re='^_', skip_folder_re=r"\.ipynb_checkpoints"):
         res['syms'].update(_get_modidx((dest.parent/file).resolve(), code_root, nbs_path=nbs_path))
     idxfile.write_text("# Autogenerated by nbdev\n\nd = "+pformat(res, width=140, indent=2, compact=True)+'\n')
 

nbdev/maker.py

@@ -207,7 +207,7 @@ def make(self:ModuleMaker, cells, all_cells=None, lib_path=None):
         f.write(f"# AUTOGENERATED! DO NOT EDIT! File to edit: {self.dest2nb}.")
         if last_future > 0: write_cells(cells[:last_future], self.hdr, f)
         if self.parse: f.write(f"\n\n# %% auto 0\n__all__ = {all_str}")
-        write_cells(cells[last_future:], self.hdr, f)
+        write_cells(cells[last_future:], self.hdr, f, cell_number=get_config().cell_number)
         f.write('\n')
 
 # %% ../nbs/api/02_maker.ipynb 38

nbdev/quarto.py

@@ -68,7 +68,7 @@ def _sort(a):
     if y.startswith('index.'): return x,'00'
     return a
 #|export
-_def_file_re = '\.(?:ipynb|qmd|html)$'
+_def_file_re = r'\.(?:ipynb|qmd|html)$'
 
 @delegates(nbglob_cli)
 def _nbglob_docs(
@@ -87,12 +87,12 @@ def _recursive_parser(
         set_index: bool = True): # If `True`, `index` file will be set to href.
     for name, val in dir_dict.items():
         if type(val) is str:
-            if re.search('index\..*', re.sub('^\d+_', '', val)) and set_index and section:
+            if re.search('index\..*', re.sub(r'^\d+_', '', val)) and set_index and section:
                 section.update({'href': str(dirpath/val)})
             else:
                 contents.append(str(dirpath/val))
         elif type(val) is dict:
-            name = re.sub('^\d+_', '', name)
+            name = re.sub(r'^\d+_', '', name)
             section = {'section': name, 'contents': []}
             contents.append(section)
             _recursive_parser(val, section['contents'], dirpath/name, section=section)

nbdev/release.py

@@ -240,11 +240,11 @@ def write_conda_meta(path='conda'):
     _write_yaml(path, *_get_conda_meta())
 
 # %% ../nbs/api/18_release.ipynb 43
-# This function is used as a utility for creating HF spaces.
-def write_requirements(directory=None):
+@call_parse
+def write_requirements(path:str=''):
     "Writes a `requirements.txt` file to `directory` based on settings.ini."
     cfg = get_config()
-    d = Path(directory) if directory else cfg.config_path
+    d = Path(path) if path else cfg.config_path
     req = '\n'.join([cfg.get(k, '').replace(' ', '\n') for k in ['requirements', 'pip_requirements']])
     (d/'requirements.txt').mk_write(req)
 

nbdev/showdoc.py

@@ -25,7 +25,7 @@ def _bold(s): return f'**{s}**' if s.strip() else s
 
 # %% ../nbs/api/08_showdoc.ipynb 7
 def _escape_markdown(s):
-    for c in '|^': s = re.sub(rf'\\?\{c}', f'\{c}', s)
+    for c in '|^': s = re.sub(rf'\\?\{c}', rf'\{c}', s)
     return s.replace('\n', '<br>')
 
 # %% ../nbs/api/08_showdoc.ipynb 9

nbdev/sync.py

@@ -34,7 +34,7 @@ def _mod_files():
     return L(files for mod in midx.d['syms'].values() for _,files in mod.values()).unique()
 
 # %% ../nbs/api/06_sync.ipynb 8
-_re_import = re.compile("from\s+\S+\s+import\s+\S")
+_re_import = re.compile(r"from\s+\S+\s+import\s+\S")
 
 # %% ../nbs/api/06_sync.ipynb 10
 def _to_absolute(code, py_path, lib_dir):
@@ -67,6 +67,7 @@ def nbdev_update(fname:str=None): # A Python file name to update
     if fname and fname.endswith('.ipynb'): raise ValueError("`nbdev_update` operates on .py files.  If you wish to convert notebooks instead, see `nbdev_export`.")
     if os.environ.get('IN_TEST',0): return
     cfg = get_config()
+    if not cfg.cell_number: raise ValueError("`nbdev_update` does not support without cell_number in .py files. Please check your settings.ini")
     fname = Path(fname or cfg.lib_path)
     lib_dir = cfg.lib_path.parent
     files = globtastic(fname, file_glob='*.py', skip_folder_re='^[_.]').filter(lambda x: str(Path(x).absolute().relative_to(lib_dir) in _mod_files()))

{nbdev-2.3.23.dist-info → nbdev-2.3.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbdev
-Version: 2.3.23
+Version: 2.3.26
 Summary: Create delightful software with Jupyter Notebooks
 Home-page: https://github.com/fastai/nbdev
 Author: Jeremy Howard and Hamel Husain
@@ -143,10 +143,12 @@ available commands:
     nbdev_release_both        Release both conda and PyPI packages
     nbdev_release_gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
     nbdev_release_git         Tag and create a release in GitHub for the current version
+    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on settings.ini.
     nbdev_sidebar             Create sidebar.yml
     nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
     nbdev_trust               Trust notebooks matching `fname`
     nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
+    nbdev_update_license      Allows you to update the license of your project.
 
 ## FAQ
 

{nbdev-2.3.23.dist-info → nbdev-2.3.26.dist-info}/RECORD

@@ -1,29 +1,29 @@
-nbdev/__init__.py,sha256=3fHAHcA_BTXmByVi4y4h51YHZ1ncErSQeTNZxw1-fBM,90
+nbdev/__init__.py,sha256=P9VMWkWqJEua4n5Tu90cHCgvYUZEs9x3z4dHMMiCs4U,90
 nbdev/_modidx.py,sha256=cfvhKryWwys106hchXzhcUqC37lQHHAKJKk6vrUiRAs,40317
-nbdev/clean.py,sha256=lLtfhCLjkDBqf8MvIG9lDSWSmA9vUDvn2QhS6LPprHI,9284
+nbdev/clean.py,sha256=RLhM4-joJNpxauTy33HYb3gaUHaKtCOaWfrKWec5Zd4,9403
 nbdev/cli.py,sha256=OAEdAqGdgHbUFYjHmn8ZmFNbBCxJjwvtDwgYatjmh1U,5639
-nbdev/config.py,sha256=2WrrWR_3kyxUEmzz7hliVWDlYzWkLlOsiL08tUopNnI,12236
-nbdev/doclinks.py,sha256=X5d8Xz52p-LlWwhhCN6d-00RQ0E8BsONuPH_xUSA6kc,10287
+nbdev/config.py,sha256=CdaimA7eSdWHYYw7q07QA5j4q_pzMyOhG0BRHw3D2Qk,12387
+nbdev/doclinks.py,sha256=zqhEyOXFBfGNZ6HSIQihwofoLzxjgGqzikaBI-EnSc4,10475
 nbdev/export.py,sha256=LEhn7UpfMSm9QKrC31q91Bsw-ZHd68DNv7MjhsNi15A,3275
 nbdev/extract_attachments.py,sha256=O4mS4EFIOXL_yQ3jmsnBStrWxGR_nPNvxLYXHtLeimw,2208
 nbdev/frontmatter.py,sha256=L9XbOPA99XuHSWU6eJfRIR4mBU4-NhDIQSP80EIk51g,2708
 nbdev/imports.py,sha256=f5Ynco14hsJyFCf43-uP_YARMhHADe6lM-20Mc_vXhw,95
-nbdev/maker.py,sha256=1hmOlElYhREqaJEc5jimiZ2Q5kkFUtQ9MNR05B-3L6c,9729
+nbdev/maker.py,sha256=Q8K3lFMcLIxJ1OptGQcD6mjSSFz_UZwPKE6JIvKfnhQ,9767
 nbdev/merge.py,sha256=QrP8tdlPRfZZ-TH5dTRwj9jXr7jWEsrLwgcIVPSHJSs,4319
 nbdev/migrate.py,sha256=l2hO2Ymkjm1C3_JmFDsM-DN6bxgFeLjj-pBr1xNqunI,7317
 nbdev/process.py,sha256=7dl9U7JLL9wbJta-KKTTnkMktBVsK5s-y8OBxtfk68I,5863
 nbdev/processors.py,sha256=O5r2gXOCQlHI6aX0UFl_4PdaYV0fKPy6joYov_T7V88,11492
 nbdev/qmd.py,sha256=3Cskd8ynm25Hh7bo-_t0hxCMF6jqXxgq_VfkpLBKu_w,2958
-nbdev/quarto.py,sha256=uPburjx-OG9ruNTI08Ku_iOV5gerUUGNQUXDeOGmAco,12017
-nbdev/release.py,sha256=1rqBx77XPWSfb9JW8X7rTyaHz7wc4aRd3BHIkJafcKI,14229
+nbdev/quarto.py,sha256=SYqJyElI6KMP4g16fZ87SmhK7NTYdnDIi1f1Y4GKO1I,12020
+nbdev/release.py,sha256=6lwSBn9HkTNSl9jWIkYcKdBtWGo-LWl3YBjhQREuI2k,14167
 nbdev/serve.py,sha256=8q2qa82-osuIOpQamJ13Q_WEnnVZycxb8Vj467PGias,3020
 nbdev/serve_drv.py,sha256=IZ2acem_KKsXYYe0iUECiR_orkYLBkT1ZG_258ZS7SQ,657
-nbdev/showdoc.py,sha256=sWkpTLpWLUMQBsysHqyvS7czIVcmfkJ_pjSU3zcp-AI,9150
-nbdev/sync.py,sha256=ZKcWRJd49EaYJXeIB8hSa8oWHDrqRWoyRbGUGHDYxJg,2898
+nbdev/showdoc.py,sha256=ZyT1HX9IXNl1hXRzzQ6XYu3NK6yLgPweatiItQbulbk,9151
+nbdev/sync.py,sha256=BsdWf-1rw1WIPszL3Sw93U3Q5El2A-_9VnQz9_iP5Cw,3044
 nbdev/test.py,sha256=74db-sK_rnc69Q3beztibXDSZUeOk6M9nIiIORLHzlo,4397
-nbdev-2.3.23.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-nbdev-2.3.23.dist-info/METADATA,sha256=WpH_OXekTry10XDDbLtfnv_HrMxysgOyG-DlOuHZGKM,10158
-nbdev-2.3.23.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-nbdev-2.3.23.dist-info/entry_points.txt,sha256=lFZD1JQyZQI8x8PuaaSqbfnhInHhpm56nCR6n84nFKk,1272
-nbdev-2.3.23.dist-info/top_level.txt,sha256=3cWYLMuaXsZjz3TQRGEkWGs9Z8ieEDmYcq8TZS3y3vU,6
-nbdev-2.3.23.dist-info/RECORD,,
+nbdev-2.3.26.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+nbdev-2.3.26.dist-info/METADATA,sha256=sNarWOTzuXPsKUBIiqKTordf8MS39d7qE5YpyjxbFxE,10339
+nbdev-2.3.26.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+nbdev-2.3.26.dist-info/entry_points.txt,sha256=GMherdbuc27OmIuaaom4eNx5sTdCvAdNrZA6XLEZOA8,1326
+nbdev-2.3.26.dist-info/top_level.txt,sha256=3cWYLMuaXsZjz3TQRGEkWGs9Z8ieEDmYcq8TZS3y3vU,6
+nbdev-2.3.26.dist-info/RECORD,,

{nbdev-2.3.23.dist-info → nbdev-2.3.26.dist-info}/entry_points.txt

@@ -23,6 +23,7 @@ nbdev_readme = nbdev.quarto:nbdev_readme
 nbdev_release_both = nbdev.release:release_both
 nbdev_release_gh = nbdev.release:release_gh
 nbdev_release_git = nbdev.release:release_git
+nbdev_requirements = nbdev.release:write_requirements
 nbdev_sidebar = nbdev.quarto:nbdev_sidebar
 nbdev_test = nbdev.test:nbdev_test
 nbdev_trust = nbdev.clean:nbdev_trust