fixes #951

Author: jph00

nbdev/cli.py

@@ -54,7 +54,7 @@ def nbdev_filter(
 ):
     "A notebook filter for Quarto"
     os.environ["IN_TEST"] = "1"
-    try: filt = get_config().get('exporter', FilterDefaults)()
+    try: filt = globals()[get_config().get('exporter', 'FilterDefaults')]()
     except FileNotFoundError: filt = FilterDefaults()
     if fname:        nb_txt = Path(fname).read_text()
     elif not nb_txt: nb_txt = sys.stdin.read()

nbdev/config.py

@@ -169,49 +169,52 @@ def nbdev_create_config(
     cfg_fn = Path(path)/cfg_name
     print(f'{cfg_fn} created.')
 
-# %% ../nbs/09_API/01_config.ipynb 26
+# %% ../nbs/09_API/01_config.ipynb 23
 def _nbdev_config_file(cfg_name=_nbdev_cfg_name, path=None):
     cfg_path = path = Path.cwd() if path is None else Path(path)
     while cfg_path != cfg_path.parent and not (cfg_path/cfg_name).exists(): cfg_path = cfg_path.parent
     if not (cfg_path/cfg_name).exists(): cfg_path = path
     return cfg_path/cfg_name
 
-# %% ../nbs/09_API/01_config.ipynb 28
+# %% ../nbs/09_API/01_config.ipynb 25
 def _xdg_config_paths(cfg_name=_nbdev_cfg_name):
     xdg_config_paths = reversed([xdg_config_home()]+xdg_config_dirs())
     return [o/_nbdev_home_dir/cfg_name for o in xdg_config_paths]
 
-# %% ../nbs/09_API/01_config.ipynb 29
+# %% ../nbs/09_API/01_config.ipynb 26
+_types = dict(custom_sidebar=bool, nbs_path=Path, lib_path=Path, doc_path=Path, recursive=bool, 
+    black_formatting=bool, jupyter_hooks=bool, clean_ids=bool, custom_quarto_yml=bool)
+
 @functools.lru_cache(maxsize=None)
 def get_config(cfg_name=_nbdev_cfg_name, path=None):
     "Return nbdev config."
     cfg_file = _nbdev_config_file(cfg_name, path)
     extra_files = _xdg_config_paths(cfg_name)
-    cfg = Config(cfg_file.parent, cfg_file.name, extra_files=extra_files)
+    cfg = Config(cfg_file.parent, cfg_file.name, extra_files=extra_files, types=_types)
     return _apply_defaults(cfg)
 
-# %% ../nbs/09_API/01_config.ipynb 45
+# %% ../nbs/09_API/01_config.ipynb 41
 def config_key(c, default=None, path=True, missing_ok=None):
     "Deprecated: use `get_config().get` or `get_config().path` instead."
     warn("`config_key` is deprecated. Use `get_config().get` or `get_config().path` instead.", DeprecationWarning)
     return get_config().path(c, default) if path else get_config().get(c, default)
 
-# %% ../nbs/09_API/01_config.ipynb 47
+# %% ../nbs/09_API/01_config.ipynb 43
 def create_output(txt, mime):
     "Add a cell output containing `txt` of the `mime` text MIME sub-type"
     return [{"data": { f"text/{mime}": str(txt).splitlines(True) },
              "execution_count": 1, "metadata": {}, "output_type": "execute_result"}]
 
-# %% ../nbs/09_API/01_config.ipynb 48
+# %% ../nbs/09_API/01_config.ipynb 44
 def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
 
-# %% ../nbs/09_API/01_config.ipynb 51
+# %% ../nbs/09_API/01_config.ipynb 47
 _re_version = re.compile('^__version__\s*=.*$', re.MULTILINE)
 _init = '__init__.py'
 
 def update_version(path=None):
     "Add or update `__version__` in the main `__init__.py` of the library."
-    path = Path(path or get_config().path("lib_path"))
+    path = Path(path or get_config().lib_path)
     fname = path/_init
     if not fname.exists(): fname.touch()
     version = f'__version__ = "{get_config().version}"'
@@ -225,7 +228,7 @@ def _has_py(fs): return any(1 for f in fs if f.endswith('.py'))
 def add_init(path=None):
     "Add `__init__.py` in all subdirs of `path` containing python files if it's not there already."
     # we add the lowest-level `__init__.py` files first, which ensures _has_py succeeds for parent modules
-    path = Path(path or get_config().path("lib_path"))
+    path = Path(path or get_config().lib_path)
     path.mkdir(exist_ok=True)
     if not (path/_init).exists(): (path/_init).touch()
     for r,ds,fs in os.walk(path, topdown=False):
@@ -234,16 +237,16 @@ def add_init(path=None):
         if _has_py(fs) or any(filter(_has_py, subds)) and not (r/_init).exists(): (r/_init).touch()
     update_version(path)
 
-# %% ../nbs/09_API/01_config.ipynb 54
+# %% ../nbs/09_API/01_config.ipynb 50
 def write_cells(cells, hdr, file, offset=0):
     "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}')
 
-# %% ../nbs/09_API/01_config.ipynb 55
+# %% ../nbs/09_API/01_config.ipynb 51
 def _basic_export_nb(fname, name, dest=None):
     "Basic exporter to bootstrap nbdev."
-    if dest is None: dest = get_config().path('lib_path')
+    if dest is None: dest = get_config().lib_path
     add_init()
     fname,dest = Path(fname),Path(dest)
     nb = read_nb(fname)

nbdev/doclinks.py

@@ -174,7 +174,7 @@ class NbdevLookup:
     def __init__(self, strip_libs=None, incl_libs=None, skip_mods=None):
         cfg = get_config()
         if strip_libs is None:
-            try: strip_libs = cfg.get('strip_libs', cfg.get('lib_path', 'nbdev')).split()
+            try: strip_libs = cfg.get('strip_libs', cfg.get('lib_path', 'nbdev').name).split()
             except FileNotFoundError: strip_libs = 'nbdev'
         skip_mods = setify(skip_mods)
         strip_libs = L(strip_libs)

nbdev/quarto.py

@@ -9,7 +9,7 @@
 
 from fastcore.utils import *
 from fastcore.script import call_parse
-from fastcore.shutil import rmtree,move
+from fastcore.shutil import rmtree,move,copytree
 from fastcore.meta import delegates
 
 from os import system
@@ -150,7 +150,7 @@ def nbdev_readme(
         _rdmi = tmp_doc_path/(Path(get_config().readme_nb).stem + '_files')
         if _rdm.exists(): _rdm.unlink() # py37 doesn't have arg missing_ok so have to check first
         move(tmp_doc_path/'README.md', cfg_path) # README.md is temporarily in nbs/_docs
-        if _rdmi.exists(): move(_rdmi, cfg_path) # Move Supporting files for README
+        if _rdmi.exists(): copytree(_rdmi, cfg_path/_rdmi.name) # Move Supporting files for README
 
 # %% ../nbs/09_API/13_quarto.ipynb 19
 @call_parse
@@ -215,7 +215,7 @@ def refresh_quarto_yml():
     p = cfg.path('nbs_path')/'_quarto.yml'
     vals = {k:cfg.get(k) for k in ['doc_path', 'title', 'description', 'branch', 'git_url', 'doc_host', 'doc_baseurl']}
     # Do not build _quarto_yml if custom_quarto_yml is set to True
-    if str2bool(get_config().custom_quarto_yml): return
+    if str2bool(cfg.get('custom_quarto_yml', False)): return
     if 'title' not in vals: vals['title'] = vals['lib_name']
     yml=_quarto_yml.format(**vals)
     p.write_text(yml)

nbs/09_API/01_config.ipynb

@@ -64,7 +64,7 @@
     "nbdev is heavily customizeable, thanks to the configuration system defined in this module. There are 2 ways to interact with nbdev's config:\n",
     "\n",
     "- **In the terminal:** `nbdev_create_config` creates a config file (if you're starting a new project use `nbdev_new` instead)\n",
-    "- **In your library:** `get_config` returns a [`Config`](https://fastcore.fast.ai/foundation.html#config) object.\n",
+    "- **In your library:** `get_config` returns a `fastcore.foundation.Config` object.\n",
     "\n",
     "Read on for more about how these work."
    ]
@@ -189,7 +189,16 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/Users/jhoward/git/ghapi/ghapi/core.py:99: UserWarning: Neither GITHUB_TOKEN nor GITHUB_JWT_TOKEN found: running as unauthenticated\n",
+      "  else: warn('Neither GITHUB_TOKEN nor GITHUB_JWT_TOKEN found: running as unauthenticated')\n"
+     ]
+    }
+   ],
    "source": [
     "#|hide\n",
     "if os.getenv('GITHUB_ACTIONS') != 'true': # GITHUB_TOKEN in actions has limited scope.\n",
@@ -365,30 +374,15 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The table above also serves as a full reference of nbdev's settings (excluding the `path` and `cfg_name` parameters which decide where the config file is saved). For more about PyPI classifiers, see [_Classifiers_](https://pypi.org/classifiers/)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can create a config file by passing all of the required settings via the command line, as well as any optional settings you'd like to override, for example:"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
+    "The table above also serves as a full reference of nbdev's settings (excluding the `path` and `cfg_name` parameters which decide where the config file is saved). For more about PyPI classifiers, see [_Classifiers_](https://pypi.org/classifiers/).\n",
+    "\n",
+    "You can create a config file by passing all of the required settings via the command line, as well as any optional settings you'd like to override, for example:\n",
+    "\n",
     "```sh\n",
     "nbdev_create_config --repo nbdev --user fastai --author fastai \\\n",
     "                    --author_email [email protected] --description 'A test project'\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
+    "```\n",
+    "\n",
     "If you don't provide required settings from the command line, we'll try to to infer them from git and GitHub. Finally, you'll be asked to manually input any required settings that we couldn't automatically fill in."
    ]
   },
@@ -442,26 +436,24 @@
    "outputs": [],
    "source": [
     "#|export\n",
+    "_types = dict(custom_sidebar=bool, nbs_path=Path, lib_path=Path, doc_path=Path, recursive=bool, \n",
+    "    black_formatting=bool, jupyter_hooks=bool, clean_ids=bool, custom_quarto_yml=bool)\n",
+    "\n",
     "@functools.lru_cache(maxsize=None)\n",
     "def get_config(cfg_name=_nbdev_cfg_name, path=None):\n",
     "    \"Return nbdev config.\"\n",
     "    cfg_file = _nbdev_config_file(cfg_name, path)\n",
     "    extra_files = _xdg_config_paths(cfg_name)\n",
-    "    cfg = Config(cfg_file.parent, cfg_file.name, extra_files=extra_files)\n",
+    "    cfg = Config(cfg_file.parent, cfg_file.name, extra_files=extra_files, types=_types)\n",
     "    return _apply_defaults(cfg)"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Searches up from `path` until `cfg_name` is found. User settings are loaded from `~/.config/nbdev/{cfg_name}`. Unspecified optional settings return defaults."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
+    "Searches up from `path` until `cfg_name` is found. User settings are loaded from `~/.config/nbdev/{cfg_name}`. Unspecified optional settings return defaults.\n",
+    "\n",
     "See `nbdev_create_config` for a full reference of nbdev's settings."
    ]
   },
@@ -524,7 +516,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "For convenience, use `path` to resolve settings that specify project-relative paths:"
+    "Paths are relative to the project:"
    ]
   },
   {
@@ -533,9 +525,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "test_eq(cfg.path('doc_path'), p/'_docs')\n",
-    "test_eq(cfg.path('lib_path'), p/'nbdev')\n",
-    "test_eq(cfg.path('nbs_path'), p/'nbs')"
+    "test_eq(cfg.doc_path, p/'_docs')\n",
+    "test_eq(cfg.lib_path, p/'nbdev')\n",
+    "test_eq(cfg.nbs_path, p/'nbs')"
    ]
   },
   {
@@ -555,7 +547,7 @@
     "    Config('.', 'test_settings.ini', {'repo': 'my-project', 'author': 'fastai', 'nbs_path': 'nbs'});\n",
     "    cfg = get_config('test_settings.ini', '.')\n",
     "    test_eq(cfg.repo, 'my-project')\n",
-    "    test_eq(cfg.lib_path, 'my_project')\n",
+    "    test_eq(cfg.lib_path.name, 'my_project')\n",
     "    test_eq(cfg.copyright, '2022 ownwards, fastai')"
    ]
   },
@@ -573,8 +565,8 @@
    "outputs": [],
    "source": [
     "cfg = get_config('test_settings.ini', '.')\n",
-    "test_eq(cfg.lib_path, 'nbdev')\n",
-    "test_eq(cfg.nbs_path, '.')"
+    "test_eq(cfg.lib_path, Path('nbdev').resolve())\n",
+    "test_eq(cfg.nbs_path, Path('.').resolve())"
    ]
   },
   {
@@ -671,7 +663,7 @@
     "\n",
     "def update_version(path=None):\n",
     "    \"Add or update `__version__` in the main `__init__.py` of the library.\"\n",
-    "    path = Path(path or get_config().path(\"lib_path\"))\n",
+    "    path = Path(path or get_config().lib_path)\n",
     "    fname = path/_init\n",
     "    if not fname.exists(): fname.touch()\n",
     "    version = f'__version__ = \"{get_config().version}\"'\n",
@@ -685,7 +677,7 @@
     "def add_init(path=None):\n",
     "    \"Add `__init__.py` in all subdirs of `path` containing python files if it's not there already.\"\n",
     "    # we add the lowest-level `__init__.py` files first, which ensures _has_py succeeds for parent modules\n",
-    "    path = Path(path or get_config().path(\"lib_path\"))\n",
+    "    path = Path(path or get_config().lib_path)\n",
     "    path.mkdir(exist_ok=True)\n",
     "    if not (path/_init).exists(): (path/_init).touch()\n",
     "    for r,ds,fs in os.walk(path, topdown=False):\n",
@@ -740,7 +732,7 @@
     "#|export\n",
     "def _basic_export_nb(fname, name, dest=None):\n",
     "    \"Basic exporter to bootstrap nbdev.\"\n",
-    "    if dest is None: dest = get_config().path('lib_path')\n",
+    "    if dest is None: dest = get_config().lib_path\n",
     "    add_init()\n",
     "    fname,dest = Path(fname),Path(dest)\n",
     "    nb = read_nb(fname)\n",

nbs/09_API/04b_doclinks.ipynb

@@ -243,18 +243,7 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Path('/home/jhoward/git/nbdev')"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#|export\n",
     "@delegates(globtastic, but=('file_glob', 'skip_folder_re', 'skip_file_re'))\n",
@@ -440,7 +429,7 @@
     "    def __init__(self, strip_libs=None, incl_libs=None, skip_mods=None):\n",
     "        cfg = get_config()\n",
     "        if strip_libs is None:\n",
-    "            try: strip_libs = cfg.get('strip_libs', cfg.get('lib_path', 'nbdev')).split()\n",
+    "            try: strip_libs = cfg.get('strip_libs', cfg.get('lib_path', 'nbdev').name).split()\n",
     "            except FileNotFoundError: strip_libs = 'nbdev'\n",
     "        skip_mods = setify(skip_mods)\n",
     "        strip_libs = L(strip_libs)\n",
@@ -532,8 +521,6 @@
       "text/markdown": [
        "---\n",
        "\n",
-       "[source](https://github.com/fastai/nbdev/blob/master/nbdev/doclinks.py#LNone){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
-       "\n",
        "### NbdevLookup.doc\n",
        "\n",
        ">      NbdevLookup.doc (sym)\n",
@@ -543,8 +530,6 @@
       "text/plain": [
        "---\n",
        "\n",
-       "[source](https://github.com/fastai/nbdev/blob/master/nbdev/doclinks.py#LNone){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
-       "\n",
        "### NbdevLookup.doc\n",
        "\n",
        ">      NbdevLookup.doc (sym)\n",
@@ -626,8 +611,6 @@
       "text/markdown": [
        "---\n",
        "\n",
-       "[source](https://github.com/fastai/nbdev/blob/master/nbdev/doclinks.py#LNone){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
-       "\n",
        "### NbdevLookup.code\n",
        "\n",
        ">      NbdevLookup.code (sym)\n",
@@ -637,8 +620,6 @@
       "text/plain": [
        "---\n",
        "\n",
-       "[source](https://github.com/fastai/nbdev/blob/master/nbdev/doclinks.py#LNone){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
-       "\n",
        "### NbdevLookup.code\n",
        "\n",
        ">      NbdevLookup.code (sym)\n",
@@ -685,17 +666,13 @@
       "text/markdown": [
        "---\n",
        "\n",
-       "[source](https://github.com/fastai/nbdev/blob/master/nbdev/doclinks.py#LNone){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
-       "\n",
        "### NbdevLookup.linkify\n",
        "\n",
        ">      NbdevLookup.linkify (md)"
       ],
       "text/plain": [
        "---\n",
        "\n",
-       "[source](https://github.com/fastai/nbdev/blob/master/nbdev/doclinks.py#LNone){target=\"_blank\" style=\"float:right; font-size:smaller\"}\n",
-       "\n",
        "### NbdevLookup.linkify\n",
        "\n",
        ">      NbdevLookup.linkify (md)"