Merge branch 'master' into master

Author: RonnyPfannschmidt

CHANGELOG.rst

@@ -6,6 +6,8 @@ v3.4.0
 
 * fix #305 - ensure the git file finder closes filedescriptors even when errors happen
 
+* fix #381 - clean out env vars from the git hook system to ensure correct function from within
+
 v3.3.3
 ======
 

MANIFEST.in

@@ -8,3 +8,4 @@ include tox.ini
 include *.rst
 include LICENSE
 include *.toml
+recursive-include testing *.bash

README.rst

@@ -15,6 +15,7 @@ Unwanted files must be excluded by discarding them via ``MANIFEST.in``.
 .. image:: https://tidelift.com/badges/package/pypi/setuptools-scm
    :target: https://tidelift.com/subscription/pkg/pypi-setuptools-scm?utm_source=pypi-setuptools-scm&utm_medium=readme
 
+
 ``pyproject.toml`` usage
 ------------------------
 
@@ -50,7 +51,7 @@ To enable version inference, add this section to your pyproject.toml:
 .. code:: toml
 
     # pyproject.toml
-    [tools.setuptools_scm]
+    [tool.setuptools_scm]
 
 Including this section is comparable to supplying
 ``use_scm_version=True`` in ``setup.py``. Additionally,
@@ -60,7 +61,8 @@ to be supplied to ``get_version()``. For example:
 .. code:: toml
 
     # pyproject.toml
-    [tools.setuptools_scm]
+
+    [tool.setuptools_scm]
     write_to = "pkg/version.py"
 
 
@@ -103,20 +105,7 @@ Arguments to ``get_version()`` (see below) may be passed as a dictionary to
         ...,
     )
 
-Once configured, you can access the version number in your package via
-``pkg_resources`` (`PEP-0396 <https://www.python.org/dev/peps/pep-0396>`_). For
-example:
-
-.. code:: python
-
-   from pkg_resources import get_distribution, DistributionNotFound
-   try:
-       __version__ = get_distribution(__name__).version
-   except DistributionNotFound:
-       # package is not installed
-       pass
-
-You can also confirm the version number locally via ``setup.py``:
+You can confirm the version number locally via ``setup.py``:
 
 .. code-block:: shell
 
@@ -129,8 +118,8 @@ You can also confirm the version number locally via ``setup.py``:
    not defined in ``setup.cfg``.
 
 
-``setup.cfg``
--------------
+``setup.cfg`` usage
+-------------------
 
 If using `setuptools 30.3.0
 <https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files>`_
@@ -189,6 +178,43 @@ than the project's root, you can use:
 See `setup.py Usage`_ above for how to use this within ``setup.py``.
 
 
+Retrieving package version at runtime
+-------------------------------------
+
+If you have opted not to hardcode the version number inside the package,
+you can retrieve it at runtime from PEP-0566_ metadata using
+``importlib.metadata`` from the standard library
+or the `importlib_metadata`_ backport:
+
+.. code:: python
+
+    from importlib.metadata import version, PackageNotFoundError
+
+    try:
+        __version__ = version(__name__)
+    except PackageNotFoundError:
+        # package is not installed
+       pass
+
+Alternatively, you can use ``pkg_resources`` which is included in
+``setuptools``:
+
+.. code:: python
+
+   from pkg_resources import get_distribution, DistributionNotFound
+
+   try:
+       __version__ = get_distribution(__name__).version
+   except DistributionNotFound:
+        # package is not installed
+       pass
+
+This does place a runtime dependency on ``setuptools``.
+
+.. _PEP-0566: https://www.python.org/dev/peps/pep-0566/
+.. _importlib_metadata: https://pypi.org/project/importlib-metadata/
+
+
 Usage from Sphinx
 -----------------
 

src/setuptools_scm/utils.py

@@ -20,6 +20,27 @@
 string_types = (str,) if PY3 else (str, unicode)  # noqa
 
 
+def no_git_env(env):
+    # adapted from pre-commit
+    # Too many bugs dealing with environment variables and GIT:
+    # https://github.com/pre-commit/pre-commit/issues/300
+    # In git 2.6.3 (maybe others), git exports GIT_WORK_TREE while running
+    # pre-commit hooks
+    # In git 1.9.1 (maybe others), git exports GIT_DIR and GIT_INDEX_FILE
+    # while running pre-commit hooks in submodules.
+    # GIT_DIR: Causes git clone to clone wrong thing
+    # GIT_INDEX_FILE: Causes 'error invalid object ...' during commit
+    for k, v in env.items():
+        if k.startswith("GIT_"):
+            trace(k, v)
+    return {
+        k: v
+        for k, v in env.items()
+        if not k.startswith("GIT_")
+        or k in ("GIT_EXEC_PATH", "GIT_SSH", "GIT_SSH_COMMAND")
+    }
+
+
 def trace(*k):
     if DEBUG:
         print(*k)
@@ -48,15 +69,15 @@ def _always_strings(env_dict):
 
 
 def _popen_pipes(cmd, cwd):
-
     return subprocess.Popen(
         cmd,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
         cwd=str(cwd),
         env=_always_strings(
             dict(
-                os.environ,
+                no_git_env(os.environ),
+                # os.environ,
                 # try to disable i18n
                 LC_ALL="C",
                 LANGUAGE="",

testing/play_out_381.bash

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euxo pipefail
+
+rm -rf y z home venv tmp
+
+[ ! -d black ] && git clone https://github.com/psf/black
+export SETUPTOOLS_SCM_DEBUG=1
+export PRE_COMMIT_HOME="$PWD/home"
+export TMPDIR="$PWD/tmp"
+
+git init y
+git init z
+git -C z commit --allow-empty -m 'commit!'
+git -C y submodule add "$PWD/z"
+cat > "$PWD/y/.git/modules/z/hooks/pre-commit" <<EOF
+#!/usr/bin/env bash
+virtualenv "$PWD/venv"
+"$PWD/venv/bin/pip" install -e "$1"
+"$PWD/venv/bin/pip" install --no-clean "$PWD/black"
+EOF
+chmod +x "$PWD/y/.git/modules/z/hooks/pre-commit"
+cd y/z
+git commit -m "test"

testing/test_git.py

@@ -229,3 +229,14 @@ def test_not_matching_tags(wd):
         tag_regex=r"^apache-arrow-([\.0-9]+)$",
         git_describe_command="git describe --dirty --tags --long --exclude *js* ",
     ).startswith("0.11.2")
+
+
+@pytest.mark.issue("https://github.com/pypa/setuptools_scm/issues/381")
+def test_gitdir(monkeypatch, wd):
+    """
+    """
+    wd.commit_testfile()
+    normal = wd.version
+    # git hooks set this and break subsequent setuptools_scm unless we clean
+    monkeypatch.setenv("GIT_DIR", __file__)
+    assert wd.version == normal