Merge lp:~cjwatson/lazr.restfulclient/faster-version into lp:lazr.restfulclient

[Colin Watson]

Adjust versioning strategy to avoid importing pkg_resources, which is slow in large environments.

[Cristian Gonzalez (cristiangsp)]

Looks good!

review: Approve

=== modified file 'NEWS.rst'
--- NEWS.rst	2021-01-18 23:11:05 +0000
+++ NEWS.rst	2021-09-13 09:39:14 +0000
@@ -6,6 +6,8 @@
 ======
 
   - Drop support for Python < 2.6.
+  - Adjust versioning strategy to avoid importing pkg_resources, which is
+    slow in large environments.
 
 0.14.3 (2020-01-27)
 ===================

=== modified file 'setup.py'
--- setup.py	2019-11-04 12:35:42 +0000
+++ setup.py	2021-09-13 09:39:14 +0000
@@ -36,8 +36,6 @@
 # end generic helpers
 
 
-__version__ = open("src/lazr/restfulclient/version.txt").read().strip()
-
 tests_require = [
     'fixtures>=1.3.0',
     'lazr.authentication',
@@ -51,11 +49,10 @@
 
 setup(
     name='lazr.restfulclient',
-    version=__version__,
+    version='0.14.4',
     namespace_packages=['lazr'],
     packages=find_packages('src'),
     package_dir={'':'src'},
-    package_data={'lazr.restfulclient': ['version.txt']},
     include_package_data=True,
     zip_safe=False,
     maintainer='LAZR Developers',
@@ -69,6 +66,7 @@
         'distro',
         'httplib2; python_version < "3"',
         'httplib2>=0.7.7; python_version >= "3"',
+        'importlib-metadata; python_version < "3.8"',
         'oauthlib',
         'setuptools',
         'six',

=== modified file 'src/lazr/restfulclient/__init__.py'
--- src/lazr/restfulclient/__init__.py	2018-04-27 13:37:34 +0000
+++ src/lazr/restfulclient/__init__.py	2021-09-13 09:39:14 +0000
@@ -16,8 +16,9 @@
 # License along with lazr.restfulclient.  If not, see
 # <http://www.gnu.org/licenses/>.
 
-import pkg_resources
-__version__ = pkg_resources.resource_string(
-    "lazr.restfulclient", "version.txt").strip()
-if not isinstance(__version__, str):
-    __version__ = __version__.decode('ASCII')
+try:
+    import importlib.metadata as importlib_metadata
+except ImportError:
+    import importlib_metadata
+
+__version__ = importlib_metadata.version("lazr.restfulclient")

=== modified file 'src/lazr/restfulclient/docs/conf.py'
--- src/lazr/restfulclient/docs/conf.py	2018-05-08 08:05:00 +0000
+++ src/lazr/restfulclient/docs/conf.py	2021-09-13 09:39:14 +0000
@@ -12,8 +12,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-with open('../version.txt') as version_file:
-    _version = version_file.read().strip()
+from lazr.restfulclient import __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
@@ -56,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = _version
+version = __version__
 # The full version, including alpha/beta/rc tags.
-release = _version
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

=== removed file 'src/lazr/restfulclient/version.txt'