Merge pull request #316 from 1ucian0/303

adds git describe command option
fixes #303  
fixes #283

Author: RonnyPfannschmidt

CHANGELOG.rst

@@ -4,6 +4,8 @@ v3.1.0
 * fix #297 - correct the invocation in version_from_scm and deprecate it as its exposed by accident
 * fix #298 - handle git file listing on empty repositories
 * fix #268 - deprecate ScmVersion.extra
+* fix #303 and #283 by adding the option `git_describe_command` to allow the user to control the
+way that `git describe` is called.
 
 v3.0.6
 ======

README.rst

@@ -210,6 +210,13 @@ The currently supported configuration keys are:
   defaults to the value of ``setuptools_scm.config.DEFAULT_TAG_REGEX``
   (see `config.py <src/setuptools_scm/config.py>`_).
 
+:git_describe_command:
+  This command will be used instead the default `git describe` command.
+  Use with caution, this is a function for advanced use, and you should be
+  familiar with the setuptools_scm internals to use it.
+
+  The default value is set by ``setuptools_scm.git.DEFAULT_DESCRIBE``
+  (see `git.py <src/setuptools_scm/git.py>`_).
 
 To use setuptools_scm in other Python code you can use the
 ``get_version`` function:

src/setuptools_scm/__init__.py

@@ -121,6 +121,7 @@ def get_version(
     relative_to=None,
     tag_regex=None,
     parse=None,
+    git_describe_command=None,
 ):
     """
     If supplied, relative_to should be a file from which root may
@@ -138,6 +139,7 @@ def get_version(
     config.relative_to = relative_to
     config.tag_regex = tag_regex
     config.parse = parse
+    config.git_describe_command = git_describe_command
 
     parsed_version = _do_parse(config)
 

src/setuptools_scm/config.py

@@ -61,6 +61,7 @@ def __init__(self, relative_to=None, root="."):
         self.write_to_template = None
         self.parse = None
         self.tag_regex = DEFAULT_TAG_REGEX
+        self.git_describe_command = None
 
     @property
     def absolute_root(self):

src/setuptools_scm/git.py

@@ -101,9 +101,12 @@ def parse(
     if pre_parse:
         pre_parse(wd)
 
+    if config.git_describe_command:
+        describe_command = config.git_describe_command
+
     out, unused_err, ret = wd.do_ex(describe_command)
     if ret:
-        # If 'git describe' failed, try to get the information otherwise.
+        # If 'git git_describe_command' failed, try to get the information otherwise.
         rev_node = wd.node()
         dirty = wd.is_dirty()
 

testing/test_git.py

@@ -191,3 +191,18 @@ def test_git_feature_branch_increments_major(wd):
     wd("git checkout -b feature/fun")
     wd.commit_testfile()
     assert wd.get_version(version_scheme="python-simplified-semver").startswith("1.1.0")
+
+
+@pytest.mark.issue("https://github.com/pypa/setuptools_scm/issues/303")
+def test_not_matching_tags(wd):
+    wd.commit_testfile()
+    wd("git tag apache-arrow-0.11.1")
+    wd.commit_testfile()
+    wd("git tag apache-arrow-js-0.9.9")
+    wd.commit_testfile()
+    assert wd.get_version(
+        tag_regex=r"^apache-arrow-([\.0-9]+)$",
+        git_describe_command="git describe --dirty --tags --long --exclude *js* ",
+    ).startswith(
+        "0.11.2"
+    )