Backport PR #23144: Only import setuptools_scm when we are in a matplotlib git repo

jklymak · meeseeksmachine · commit f2a3ec5f3c36 · 2022-06-11T09:34:12.000Z
diff --git a/.matplotlib-repo b/.matplotlib-repo
@@ -0,0 +1,3 @@
+The existence of this file signals that the code is a matplotlib source repo
+and not an installed version. We use this in __init__.py for gating version
+detection.
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -160,11 +160,13 @@ def _parse_to_version_info(version_str):
 
 def _get_version():
     """Return the version string used for __version__."""
-    # Only shell out to a git subprocess if really needed, and not on a
-    # shallow clone, such as those used by CI, as the latter would trigger
-    # a warning from setuptools_scm.
+    # Only shell out to a git subprocess if really needed, i.e. when we are in
+    # a matplotlib git repo but not in a shallow clone, such as those used by
+    # CI, as the latter would trigger a warning from setuptools_scm.
     root = Path(__file__).resolve().parents[2]
-    if (root / ".git").exists() and not (root / ".git/shallow").exists():
+    if ((root / ".matplotlib-repo").exists()
+            and (root / ".git").exists()
+            and not (root / ".git/shallow").exists()):
         import setuptools_scm
         return setuptools_scm.get_version(
             root=root,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+The existence of this file signals that the code is a matplotlib source repo`
	`2`	`+and not an installed version. We use this in __init__.py for gating version`
	`3`	`+detection.`