switch from entrypoints to importlib-metadata #1782
Conversation
entrypoints is deprecated and recommends switching to importlib-metadata. I've implemented this because I'm using a custom import mechanism that works with the documented importlib.metadata interface but not with entrypoints' custom logic
pyproject.toml
Outdated
| @@ -23,7 +23,7 @@ dependencies = [ | |||
| "beautifulsoup4", | |||
| "bleach", | |||
| "defusedxml", | |||
| "entrypoints>=0.2.2", | |||
| "importlib-metadata;python_version<3.8", | |||
There was a problem hiding this comment.
One thing: we have been trying to avoid importlib-metadata<3.6, and the stdlib one in python<3.10: it loads every installed entrypoint, which can take a couple seconds.
nbconvert/exporters/base.py
Outdated
| @@ -97,20 +100,14 @@ def get_exporter(name, config=get_config()): # noqa | |||
| name = "notebook" | |||
|
|
|||
| try: | |||
| exporter = entrypoints.get_single("nbconvert.exporters", name).load() | |||
| exporters = importlib_metadata.entry_points()["nbconvert.exporters"] | |||
There was a problem hiding this comment.
this loads every single entry_point, and can take seconds: indeed, i think it throws warnings on newer pythons.
Using entry_points(group="nbconvert.exporters.script") will only load the one requested, but there are some version quirks (see comment on pyproject.toml).
nbconvert/exporters/base.py
Outdated
| @@ -5,7 +5,10 @@ | |||
|
|
|||
| import os | |||
|
|
|||
| import entrypoints | |||
| try: | |||
There was a problem hiding this comment.
one last thing: because the stdlib version was broken, this is most accurate as a check of sys.version, e.g.:
if sys.version_info < (3, 10):
from importlib_metadata import entry_points
else:
from importlib.metadata import entry_pointshttps://github.com/jupyterlab/jupyterlab_server/blob/main/jupyterlab_server/translation_utils.py#L20
|
Thanks for the notes @bollwyvl, I switched it to the group syntax |
nbconvert/exporters/base.py
Outdated
| @@ -136,7 +134,7 @@ def get_export_names(config=get_config()): # noqa | |||
| Exporters can be found in external packages by registering | |||
| them as an nbconvert.exporter entrypoint. | |||
| """ | |||
| exporters = sorted(entrypoints.get_group_named("nbconvert.exporters")) | |||
| exporters = (e.name for e in entry_points(group="nbconvert.exporters")) | |||
There was a problem hiding this comment.
is this a generator? should probably still be sorted, as well...
|
in my ci run tests are passing, but docs aren't, i assume the docs failure is unrelated? |
|
Yes, docs error is unrelated. Thanks again! |
entrypoints is deprecated and recommends switching to importlib-metadata. I've implemented this because I'm using a custom import mechanism that works with the documented importlib.metadata interface but not with entrypoints' custom logic