add virtualenvwrapper.version module

Have setuptools_scm write a module with the package version so we
don't need to use importlib.metadata to look up the value at
runtime. This makes version handling more portable across versions of
Python.

Author: dhellmann

.gitignore

@@ -36,3 +36,4 @@ syntax: re
 ^web/
 .python-version
 .eggs
+/virtualenvwrapper/version.py

docs/requirements.txt

@@ -1,5 +1,3 @@
 # sphinxcontrib-bitbucket
 # sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
 sphinx
-# We need importlib.metadata, which was added in 3.10.
-importlib_metadata;python_version<'3.10'

docs/source/conf.py

@@ -13,7 +13,8 @@
 # serve to show the default.
 
 import datetime
-import importlib.metadata
+
+import virtualenvwrapper.version
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -51,7 +52,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = importlib.metadata.version('virtualenvwrapper')
+version = virtualenvwrapper.version.version
 # The full version, including alpha/beta/rc tags.
 release = version
 

pyproject.toml

@@ -38,6 +38,7 @@ dependencies = [
 
 # https://github.com/pypa/setuptools_scm/
 [tool.setuptools_scm]
+write_to = "virtualenvwrapper/version.py"
 
 [project.urls]
 homepage = "https://virtualenvwrapper.readthedocs.io/"

tests/test_virtualenvwrapper.sh

@@ -27,13 +27,13 @@ test_virtualenvwrapper_script_set() {
 }
 
 test_virtualenvwrapper_version() {
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     typeset ver=$(_virtualenvwrapper_version)
     assertTrue "version is empty" "[ -n $ver ]"
 }
 
 test_virtualenvwrapper_help_shows_version() {
-    source "$test_dir/../virtualenvwrapper.sh"
+    load_wrappers
     typeset pattern="Version: $(_virtualenvwrapper_version)"
     assertTrue "version not in command output" "virtualenvwrapper | grep \"$pattern\""
 }

virtualenvwrapper/hook_loader.py

@@ -13,8 +13,9 @@
 import os
 import sys
 
-from stevedore import ExtensionManager
-from stevedore import NamedExtensionManager
+from stevedore import ExtensionManager, NamedExtensionManager
+
+import virtualenvwrapper.version
 
 LOG_FORMAT = '%(asctime)s %(levelname)s %(name)s %(message)s'
 
@@ -89,8 +90,7 @@ def main():
     options, args = parser.parse_args()
 
     if options.version:
-        import importlib.metadata
-        print(importlib.metadata.version('virtualenvwrapper'))
+        print(virtualenvwrapper.version.version)
         return 0
 
     root_logger = logging.getLogger('virtualenvwrapper')