From 859d45bf8f7254858fbfb6167fe073479e712cfd Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Sun, 12 Jul 2020 18:42:40 -0400 Subject: replace pkg_resources with importlib.metadata Importing pkg_resources has a side-effect of scanning every installed distribution on sys.path to load the metadata, especially the entry points defined in the packages. This can have a significant launch-time cost for command line applications when there are a lot of distributions to scan. Since cmd2 is only using pkg_resources to find the version of the installed package, pkg_resources can be replaced with importlib.metadata. The implementation in the new library is significantly faster because it goes immediately to the metadata file for the requested distribution, instead of scanning all of them. There are also no import-time side-effects. importlib.metadata is a new standard library module starting with python 3.8. For earlier versions, a compatible library has been released to PyPI as 'importlib_metadata'. This change adds the new dependency with a qualifier so that it is only applied to older versions of python, and then updates the places that were importing pkg_resources to look for the different versions of the new library instead. The documentation configuration is changed to import cmd2 itself to get its version, since the package has to be installed for the metadata to be available anyway. Signed-off-by: Doug Hellmann --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6c6faf0d..8a71268a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ documentation root, use os.path.abspath to make it absolute, like shown here. """ # Import for custom theme from Read the Docs import sphinx_rtd_theme -from pkg_resources import get_distribution +import cmd2 # -- General configuration ----------------------------------------------------- @@ -57,7 +57,7 @@ author = 'cmd2 contributors' # built documents. # # version will look like x.y.z -version = get_distribution('cmd2').version +version = cmd2.__version__ # release will look like x.y release = '.'.join(version.split('.')[:2]) -- cgit v1.2.1