Remove all non-numeric symbols from version prefix

Author: dolfinus

CHANGELOG.rst

@@ -10,12 +10,17 @@ Changelog
     .. change::
         :tags: core, breaking
 
-        ``version_callback`` option is used even if there are some tags in the current branch
+        :ref:`version-callback-option` option is used even if there are some tags in the current branch
+
+    .. change::
+        :tags: config, feature
+
+        Raise exception if both :ref:`version-callback-option` and :ref:`version-file-option` options are set
 
     .. change::
         :tags: core, feature
 
-        Raise exception if both ``version_file`` and ``version_callback`` options are set
+        Remove all non-numeric symbols from version prefix, not just ``v``
 
 1.9
 ----

docs/options/dev_template.rst

@@ -5,7 +5,7 @@
 
 Version number template for :ref:`tag-release` or :ref:`version-file` versioning schemas.
 
-Used if no untracked files and current commit is not tagged.
+Used if there are no untracked files, and current commit is not tagged.
 
 .. note::
 

docs/schemas/callback/version_callback.rst

@@ -98,6 +98,9 @@ If a value of this option is not a function but just str, it also could be used:
 is set**.
 You should explicitly call ``setuptools_git_versioning.version_from_git`` function in the callback.
 
+.. note::
+
+    Callback result is returned *as is*, so it should be a :pep:`440` compatible version number
 
 See also
 """"""""

setuptools_git_versioning.py

@@ -21,6 +21,8 @@
 DEFAULT_SORT_BY = "creatordate"
 ENV_VARS_REGEXP = re.compile(r"\{env:(?P<name>[^:}]+):?(?P<default>[^}]+\}*)?\}", re.IGNORECASE | re.UNICODE)
 TIMESTAMP_REGEXP = re.compile(r"\{timestamp:?(?P<fmt>[^:}]+)?\}", re.IGNORECASE | re.UNICODE)
+LOCAL_REGEXP = re.compile(r"[^a-z\d.]+", re.IGNORECASE)
+VERSION_PREFIX_REGEXP = re.compile(r"^[^\d]+", re.IGNORECASE | re.UNICODE)
 
 DEFAULT_CONFIG = {
     "template": DEFAULT_TEMPLATE,
@@ -343,16 +345,16 @@ def get_version_from_callback(
     log.warning(f"Parsing version_callback {version_callback} with type {type(version_callback)}")
 
     if callable(version_callback):
-        return version_callback()
-
-    result = version_callback
+        result = version_callback()
+    else:
+        result = version_callback
 
-    try:
-        return load_callable(version_callback, package_name)()
-    except ValueError:
-        result = import_reference(version_callback, package_name)
-    except (ImportError, NameError) as e:
-        log.warning(f"version_callback is not a valid reference:\n\t{e}")
+        try:
+            result = load_callable(version_callback, package_name)()
+        except ValueError:
+            result = import_reference(version_callback, package_name)
+        except (ImportError, NameError) as e:
+            log.warning(f"version_callback is not a valid reference:\n\t{e}")
 
     from packaging.version import Version
 
@@ -402,8 +404,7 @@ def version_from_git(
                 return starting_version
 
             if not count_commits_from_version_file:
-                # TODO: drop all leading non-numeric symbols
-                return tag.lstrip("v")  # for tag "v1.0.0" drop leading "v" symbol
+                return VERSION_PREFIX_REGEXP.sub("", tag)  # for tag "v1.0.0" drop leading "v" symbol
 
             tag_sha = get_latest_file_commit(version_file)
     else:
@@ -435,7 +436,6 @@ def version_from_git(
 
     # Ensure local version label only contains permitted characters
     public, sep, local = version.partition("+")
-    local_sanitized = re.sub(r"[^a-zA-Z0-9.]", ".", local)
-    # TODO: drop all leading non-numeric symbols
-    public_sanitized = public.lstrip("v")  # for version "v1.0.0" drop leading "v" symbol
+    local_sanitized = LOCAL_REGEXP.sub(".", local)
+    public_sanitized = VERSION_PREFIX_REGEXP.sub("", public)  # for version "v1.0.0" drop leading "v" symbol
     return public_sanitized + sep + local_sanitized

tests/lib/util.py

@@ -100,7 +100,7 @@ def create_file(
     if content is None:
         content = rand_str()
 
-    log.warning(content)
+    log.info(content)
     with open(os.path.join(cwd, name), "w") as f:
         f.write(content)
 

tests/test_integration/test_tag.py

@@ -103,9 +103,11 @@ def test_tag_no_tag(repo, create_config, starting_version, version):
     [
         ("1.0.0", "1.0.0"),
         ("v1.2.3", "1.2.3"),
+        ("beta1.2.3", "1.2.3"),
+        ("alpha1.2.3", "1.2.3"),
     ],
 )
-def test_tag_drop_leading_v(repo, create_config, tag, version):
+def test_tag_drop_leading_non_numbers(repo, create_config, tag, version):
     create_config(repo)
 
     create_tag(repo, tag)

tests/test_integration/test_version_callback.py

@@ -137,6 +137,14 @@ def test_version_callback_drop_leading_v(repo, version, real_version, create_con
     assert get_version(repo) == real_version
 
 
+def test_version_callback_wrong_version_number(repo, create_config):
+    create_file(repo, "version.py", VERSION_PY.format(version="alpha1.2.3"), commit=False)
+    create_config(repo, {"version_callback": "version:get_version"})
+
+    with pytest.raises(subprocess.CalledProcessError):
+        get_version(repo)
+
+
 def test_version_callback_not_a_repo(repo_dir, create_config):
     version = "1.0.0"
     create_file(repo_dir, "version.py", VERSION_PY.format(version=version), add=False, commit=False)

tests/test_integration/test_version_file.py

@@ -113,9 +113,11 @@ def test_version_file_dirty(repo, create_config, add, template, subst):
     [
         ("1.0.0", "1.0.0"),
         ("v1.2.3", "1.2.3"),
+        ("beta1.2.3", "1.2.3"),
+        ("alpha1.2.3", "1.2.3"),
     ],
 )
-def test_version_file_drop_leading_v(repo, create_config, version, real_version):
+def test_version_file_drop_leading_non_numbers(repo, create_config, version, real_version):
     create_config(
         repo,
         {