setup: use git version instead of hardcoded one

setuptool_scm [1] package is a recommended way to set package version
with git [2]. Version 6.4.2 was chosen due to Python 3.6 support,
latest version 7.0.5 supports only Python 3.7+.

Package version is displayed in documentation, so after this patch
documentation for master branch won't be confused with the last tagged
one.

Version file is created when a user installs the package with
`pip install` or on sources packing with `python setup.py bdist_wheel`
command (readthedocs building pipelines install the package). If one
would simply clone the repo, package `__version__` would be a `'dev'`
placeholder.

1. https://pypi.org/project/setuptools-scm/
2. https://packaging.python.org/en/latest/guides/single-sourcing-package-version/

Part of #238

Author: DifferentialOrange

.github/workflows/testing.yml

@@ -198,6 +198,8 @@ jobs:
 
       - name: Run tests
         run: python -m unittest discover -v
+        env:
+          TEST_PURE_INSTALL: true
 
   run_tests_ce_windows:
     # We want to run on external PRs, but not on our own internal
@@ -348,6 +350,7 @@ jobs:
         env:
           REMOTE_TARANTOOL_HOST: localhost
           REMOTE_TARANTOOL_CONSOLE_PORT: 3302
+          TEST_PURE_INSTALL: true
         run: python -m unittest discover -v
 
       - name: Stop test tarantool instance

CHANGELOG.md

@@ -143,6 +143,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Change documentation HTML theme (#67).
 - Update API documentation strings (#67).
 - Update documentation index, quick start and guide pages (#67).
+- Use git version to set package version (#238).
 
 ### Fixed
 - Package build (#238).

doc/conf.py

@@ -16,12 +16,6 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath('.')), "src"))
 
-# Read package version without importing it
-for line in open(os.path.join(os.path.dirname(os.path.abspath('.')), "tarantool", "__init__.py")):
-    if line.startswith("__version__"):
-        exec(line)
-        break
-
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -57,11 +51,13 @@
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-#
+
+import tarantool
+
 # The short X.Y version.
-version = __version__
+version = tarantool.__version__
 # The full version, including alpha/beta/rc tags.
-release = __version__
+release = tarantool.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

requirements-test.txt

@@ -1,2 +1,3 @@
 dbapi-compliance==1.15.0
 pyyaml==6.0
+importlib-metadata >= 1.0 ; python_version < '3.8'

setup.py

@@ -6,13 +6,34 @@
 
 try:
     from setuptools import setup, find_packages
+    from setuptools.command.build_py import build_py
 except ImportError:
     from distutils.core import setup, find_packages
+    from distutils.command.build_py import build_py
 
 # Extra commands for documentation management
 cmdclass = {}
 command_options = {}
 
+# Build the package
+# python setup.py build_py
+# builds the package with generating correspondent VERSION file
+class BuildPyCommand(build_py):
+    def run(self):
+        # Import here to allow to run commands
+        # like `python setup.py test` without setuptools_scm.
+        from setuptools_scm import get_version
+        version = get_version()
+
+        package_dir = self.get_package_dir('tarantool')
+        version_file = os.path.join(package_dir, 'version.py')
+        with open(version_file, 'w') as file:
+            file.write(f"VERSION = '{version}'")
+
+        return super().run()
+
+cmdclass["build_py"] = BuildPyCommand
+
 # Build Sphinx documentation (html)
 # python setup.py build_sphinx
 # generates files into build/sphinx/html
@@ -74,7 +95,7 @@ def find_version(*file_paths):
     packages=packages,
     package_dir={"tarantool": "tarantool"},
     include_package_data=True,
-    version=find_version('tarantool', '__init__.py'),
+    use_scm_version=True,
     platforms=["all"],
     author="tarantool-python AUTHORS",
     author_email="[email protected]",
@@ -93,5 +114,8 @@ def find_version(*file_paths):
     cmdclass=cmdclass,
     command_options=command_options,
     install_requires=get_dependencies('requirements.txt'),
+    setup_requires=[
+        'setuptools_scm==6.4.2',
+    ],
     python_requires='>=3',
 )

tarantool/__init__.py

@@ -40,7 +40,9 @@
     Interval,
 )
 
-__version__ = "0.9.0"
+from tarantool.version import VERSION
+
+__version__ = VERSION
 
 
 def connect(host="localhost", port=33013, user=None, password=None,

tarantool/version.py

@@ -0,0 +1 @@
+VERSION = 'dev'

test/suites/__init__.py

@@ -19,14 +19,15 @@
 from .test_uuid import TestSuite_UUID
 from .test_datetime import TestSuite_Datetime
 from .test_interval import TestSuite_Interval
+from .test_package import TestSuite_Package
 
 test_cases = (TestSuite_Schema_UnicodeConnection,
               TestSuite_Schema_BinaryConnection,
               TestSuite_Request, TestSuite_Protocol, TestSuite_Reconnect,
               TestSuite_Mesh, TestSuite_Execute, TestSuite_DBAPI,
               TestSuite_Encoding, TestSuite_Pool, TestSuite_Ssl,
               TestSuite_Decimal, TestSuite_UUID, TestSuite_Datetime,
-              TestSuite_Interval)
+              TestSuite_Interval, TestSuite_Package,)
 
 def load_tests(loader, tests, pattern):
     suite = unittest.TestSuite()

test/suites/test_package.py

@@ -0,0 +1,39 @@
+import os
+import sys
+import unittest
+
+if sys.version_info >= (3, 8):
+    from importlib import metadata
+else:
+    import importlib_metadata as metadata
+
+import tarantool
+
+
+def is_test_pure_install():
+    env = os.getenv("TEST_PURE_INSTALL")
+    if env:
+        env = env.upper()
+        return env == "1" or env == "TRUE"
+    return False
+
+
+class TestSuite_Package(unittest.TestCase):
+    @classmethod
+    def setUpClass(self):
+        print(' PACKAGE '.center(70, '='), file=sys.stderr)
+        print('-' * 70, file=sys.stderr)
+
+
+    def test_version(self):
+        if is_test_pure_install():
+            # Pure install: no package source files
+            self.assertEqual(tarantool.__version__, metadata.version('tarantool'))
+        else:
+            try:
+                # Mixed dev and install: no testing since it's hard to
+                # predict anything. This branch is not expected in CI.
+                metadata.version('tarantool')
+            except metadata.PackageNotFoundError:
+                # Pure dev: only package source files
+                self.assertEqual(tarantool.__version__, 'dev')