Skip to content

remove warning from nbdev as pkg_resources is already deprecated #1522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

remove warning from nbdev as pkg_resources is already deprecated #1522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions nbdev/doclinks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
from fastcore.net import urlread

import ast,builtins,contextlib
import pkg_resources,importlib
import importlib.metadata
import importlib.util

from astunparse import unparse
from io import BytesIO
Expand Down Expand Up @@ -236,9 +237,10 @@ def _build_lookup_table(strip_libs=None, incl_libs=None, skip_mods=None):
strip_libs = L(strip_libs)
if incl_libs is not None: incl_libs = (L(incl_libs)+strip_libs).unique()
entries = {}
for o in pkg_resources.iter_entry_points(group='nbdev'):
if incl_libs is not None and o.dist.key not in incl_libs: continue
try: entries[o.name] = _qual_syms(o.resolve())
eps = importlib.metadata.entry_points()
for o in eps.select(group='nbdev') if hasattr(eps, 'select') else eps.get('nbdev', []):
if incl_libs is not None and o.dist.name not in incl_libs: continue
try: entries[o.name] = _qual_syms(o.load())
except Exception: pass
py_syms = merge(*L(o['syms'].values() for o in entries.values()).concat())
for m in strip_libs:
Expand Down
66 changes: 54 additions & 12 deletions nbs/api/05_doclinks.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,20 @@
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"outputs": [
{
"ename": "SyntaxError",
"evalue": "expected 'except' or 'finally' block (doclinks.py, line 244)",
"output_type": "error",
"traceback": [
"Traceback \u001b[36m(most recent call last)\u001b[39m:\n",
" File \u001b[92m~/git/nbdev/.venv/lib/python3.12/site-packages/IPython/core/interactiveshell.py:3672\u001b[39m in \u001b[95mrun_code\u001b[39m\n exec(code_obj, self.user_global_ns, self.user_ns)\n",
" Cell \u001b[92mIn[2]\u001b[39m\u001b[92m, line 2\u001b[39m\n from nbdev.config import *\n",
"\u001b[36m \u001b[39m\u001b[36mFile \u001b[39m\u001b[32m~/git/nbdev/nbdev/__init__.py:3\u001b[39m\n\u001b[31m \u001b[39m\u001b[31mfrom .doclinks import nbdev_export\u001b[39m\n",
" \u001b[36mFile \u001b[39m\u001b[32m~/git/nbdev/nbdev/doclinks.py:244\u001b[39m\n\u001b[31m \u001b[39m\u001b[31mpy_syms = merge(*L(o['syms'].values() for o in entries.values()).concat())\u001b[39m\n ^\n\u001b[31mSyntaxError\u001b[39m\u001b[31m:\u001b[39m expected 'except' or 'finally' block\n"
]
}
],
"source": [
"#|export\n",
"from nbdev.config import *\n",
Expand All @@ -36,7 +49,8 @@
"from fastcore.net import urlread\n",
"\n",
"import ast,builtins,contextlib\n",
"import pkg_resources,importlib\n",
"import importlib.metadata\n",
"import importlib.util\n",
"\n",
"from astunparse import unparse\n",
"from io import BytesIO\n",
Expand All @@ -51,7 +65,20 @@
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"outputs": [
{
"ename": "SyntaxError",
"evalue": "expected 'except' or 'finally' block (doclinks.py, line 244)",
"output_type": "error",
"traceback": [
"Traceback \u001b[36m(most recent call last)\u001b[39m:\n",
" File \u001b[92m~/git/nbdev/.venv/lib/python3.12/site-packages/IPython/core/interactiveshell.py:3672\u001b[39m in \u001b[95mrun_code\u001b[39m\n exec(code_obj, self.user_global_ns, self.user_ns)\n",
" Cell \u001b[92mIn[3]\u001b[39m\u001b[92m, line 7\u001b[39m\n from nbdev.showdoc import show_doc\n",
"\u001b[36m \u001b[39m\u001b[36mFile \u001b[39m\u001b[32m~/git/nbdev/nbdev/__init__.py:3\u001b[39m\n\u001b[31m \u001b[39m\u001b[31mfrom .doclinks import nbdev_export\u001b[39m\n",
" \u001b[36mFile \u001b[39m\u001b[32m~/git/nbdev/nbdev/doclinks.py:244\u001b[39m\n\u001b[31m \u001b[39m\u001b[31mpy_syms = merge(*L(o['syms'].values() for o in entries.values()).concat())\u001b[39m\n ^\n\u001b[31mSyntaxError\u001b[39m\u001b[31m:\u001b[39m expected 'except' or 'finally' block\n"
]
}
],
"source": [
"#|hide\n",
"from IPython.display import Markdown,display\n",
Expand Down Expand Up @@ -619,9 +646,10 @@
" strip_libs = L(strip_libs)\n",
" if incl_libs is not None: incl_libs = (L(incl_libs)+strip_libs).unique()\n",
" entries = {}\n",
" for o in pkg_resources.iter_entry_points(group='nbdev'):\n",
" if incl_libs is not None and o.dist.key not in incl_libs: continue\n",
" try: entries[o.name] = _qual_syms(o.resolve())\n",
" eps = importlib.metadata.entry_points()\n",
" for o in eps.select(group='nbdev') if hasattr(eps, 'select') else eps.get('nbdev', []):\n",
" if incl_libs is not None and o.dist.name not in incl_libs: continue\n",
" try: entries[o.name] = _qual_syms(o.load())\n",
" except Exception: pass\n",
" py_syms = merge(*L(o['syms'].values() for o in entries.values()).concat())\n",
" for m in strip_libs:\n",
Expand Down Expand Up @@ -675,13 +703,13 @@
"# Create mock entry points\n",
"class BadEntryPoint:\n",
" name = 'bad_entry'\n",
" dist = type('Dist', (), {'key': 'bad_lib'})()\n",
" def resolve(self): raise AttributeError(\"Simulated error\")\n",
" dist = type('Dist', (), {'name': 'bad_lib'})()\n",
" def load(self): raise AttributeError(\"Simulated error\")\n",
"\n",
"class GoodEntryPoint:\n",
" name = 'good_entry'\n",
" dist = type('Dist', (), {'key': 'good_lib'})()\n",
" def resolve(self): return {'syms': {}, 'settings': {}}"
" dist = type('Dist', (), {'name': 'good_lib'})()\n",
" def load(self): return {'syms': {}, 'settings': {}}"
]
},
{
Expand All @@ -704,8 +732,22 @@
"# Clear the cache before testing\n",
"_build_lookup_table.cache_clear()\n",
"\n",
"# Patch iter_entry_points\n",
"with xpatch('pkg_resources.iter_entry_points', return_value=[BadEntryPoint(), GoodEntryPoint()]):\n",
"# Create a mock entry points object that supports both access patterns\n",
"class MockEntryPoints:\n",
" def __init__(self, entries):\n",
" self.entries = entries\n",
" \n",
" def select(self, group):\n",
" return self.entries if group == 'nbdev' else []\n",
" \n",
" def get(self, group, default=None):\n",
" return self.entries if group == 'nbdev' else (default or [])\n",
"\n",
"# Create mock entry points\n",
"mock_eps = MockEntryPoints([BadEntryPoint(), GoodEntryPoint()])\n",
"\n",
"# Patch importlib.metadata.entry_points\n",
"with xpatch('importlib.metadata.entry_points', return_value=mock_eps):\n",
" entries, py_syms = _build_lookup_table()\n",
" \n",
" # Should only contain the good entry\n",
Expand Down