VERSIONEER: Improve short version file handling

Made and tagged nibabel-specific hacks for including a fallback version
for using with git-archive. This is no longer the canonical versioneer
but should behave identically except in git archives made on non-release
revisions.

Author: effigies

nibabel/_version.py

@@ -156,6 +156,8 @@ def git_get_keywords(versionfile_abs):
         f.close()
     except EnvironmentError:
         pass
+    # CJM: Nibabel hack to ensure we can git-archive off-release versions and
+    # revert to old X.Y.Zdev versions + githash
     try:
         rel = runpy.run_path(os.path.join(os.path.dirname(versionfile_abs), "info.py"))
         keywords["fallback"] = rel["VERSION"]
@@ -167,8 +169,9 @@ def git_get_keywords(versionfile_abs):
 @register_vcs_handler("git", "keywords")
 def git_versions_from_keywords(keywords, tag_prefix, verbose):
     """Get version information from git keywords."""
-    if not keywords:
-        raise NotThisMethod("no keywords at all, weird")
+    # CJM: Nibabel fix to avoid hitting unguarded dictionary lookup, better explanation
+    if "refnames" not in keywords:
+        raise NotThisMethod("Short version file found")
     date = keywords.get("date")
     if date is not None:
         # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant

versioneer.py

@@ -577,6 +577,8 @@ def git_get_keywords(versionfile_abs):
         f.close()
     except EnvironmentError:
         pass
+    # CJM: Nibabel hack to ensure we can git-archive off-release versions and
+    # revert to old X.Y.Zdev versions + githash
     try:
         rel = runpy.run_path(os.path.join(os.path.dirname(versionfile_abs), "info.py"))
         keywords["fallback"] = rel["VERSION"]
@@ -588,8 +590,9 @@ def git_get_keywords(versionfile_abs):
 @register_vcs_handler("git", "keywords")
 def git_versions_from_keywords(keywords, tag_prefix, verbose):
     """Get version information from git keywords."""
-    if not keywords:
-        raise NotThisMethod("no keywords at all, weird")
+    # CJM: Nibabel fix to avoid hitting unguarded dictionary lookup, better explanation
+    if "refnames" not in keywords:
+        raise NotThisMethod("Short version file found")
     date = keywords.get("date")
     if date is not None:
         # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant
@@ -974,6 +977,8 @@ def git_get_keywords(versionfile_abs):
         f.close()
     except EnvironmentError:
         pass
+    # CJM: Nibabel hack to ensure we can git-archive off-release versions and
+    # revert to old X.Y.Zdev versions + githash
     try:
         rel = runpy.run_path(os.path.join(os.path.dirname(versionfile_abs), "info.py"))
         keywords["fallback"] = rel["VERSION"]
@@ -985,8 +990,9 @@ def git_get_keywords(versionfile_abs):
 @register_vcs_handler("git", "keywords")
 def git_versions_from_keywords(keywords, tag_prefix, verbose):
     """Get version information from git keywords."""
-    if not keywords:
-        raise NotThisMethod("no keywords at all, weird")
+    # CJM: Nibabel fix to avoid hitting unguarded dictionary lookup, better explanation
+    if "refnames" not in keywords:
+        raise NotThisMethod("Short version file found")
     date = keywords.get("date")
     if date is not None:
         # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant