Skip to content

Commit

Permalink
update versioneer from extension template
Browse files Browse the repository at this point in the history
  • Loading branch information
@jsheunis
jsheunis committed Jan 9, 2024
1 parent 6f4cd35 commit cd10e83
Show file tree
Hide file tree
Showing 3 changed files with 165 additions and 328 deletions.
6 changes: 0 additions & 6 deletions datalad_catalog/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,6 @@

from datalad import setup_package
from datalad import teardown_package

from ._version import get_versions

__version__ = get_versions()["version"]
del get_versions

from . import _version

__version__ = _version.get_versions()["version"]
92 changes: 33 additions & 59 deletions datalad_catalog/_version.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
# directories (produced by setup.py build) will contain a much shorter file
# that just contains the computed version number.

# This file is released into the public domain.
# Generated by versioneer-0.29
# https://github.com/python-versioneer/python-versioneer
# This file is released into the public domain. Generated by
# versioneer-0.23 (https://github.com/python-versioneer/python-versioneer)

"""Git implementation of _version.py."""

Expand All @@ -16,11 +15,11 @@
import re
import subprocess
import sys
from typing import Any, Callable, Dict, List, Optional, Tuple
from typing import Callable, Dict
import functools


def get_keywords() -> Dict[str, str]:
def get_keywords():
"""Get the keywords needed to look up the version information."""
# these strings will be replaced by git during git-archive.
# setup.py/versioneer.py will grep for the variable names, so they must
Expand All @@ -36,15 +35,8 @@ def get_keywords() -> Dict[str, str]:
class VersioneerConfig:
"""Container for Versioneer configuration parameters."""

VCS: str
style: str
tag_prefix: str
parentdir_prefix: str
versionfile_source: str
verbose: bool


def get_config() -> VersioneerConfig:
def get_config():
"""Create, populate and return the VersioneerConfig() object."""
# these strings are filled in when 'setup.py versioneer' creates
# _version.py
Expand All @@ -66,9 +58,9 @@ class NotThisMethod(Exception):
HANDLERS: Dict[str, Dict[str, Callable]] = {}


def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator
def register_vcs_handler(vcs, method): # decorator
"""Create decorator to mark a method as the handler of a VCS."""
def decorate(f: Callable) -> Callable:
def decorate(f):
"""Store f in HANDLERS[vcs][method]."""
if vcs not in HANDLERS:
HANDLERS[vcs] = {}
Expand All @@ -77,19 +69,13 @@ def decorate(f: Callable) -> Callable:
return decorate


def run_command(
commands: List[str],
args: List[str],
cwd: Optional[str] = None,
verbose: bool = False,
hide_stderr: bool = False,
env: Optional[Dict[str, str]] = None,
) -> Tuple[Optional[str], Optional[int]]:
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
env=None):
"""Call the given command(s)."""
assert isinstance(commands, list)
process = None

popen_kwargs: Dict[str, Any] = {}
popen_kwargs = {}
if sys.platform == "win32":
# This hides the console window if pythonw.exe is used
startupinfo = subprocess.STARTUPINFO()
Expand All @@ -105,7 +91,8 @@ def run_command(
stderr=(subprocess.PIPE if hide_stderr
else None), **popen_kwargs)
break
except OSError as e:
except OSError:
e = sys.exc_info()[1]
if e.errno == errno.ENOENT:
continue
if verbose:
Expand All @@ -125,11 +112,7 @@ def run_command(
return stdout, process.returncode


def versions_from_parentdir(
parentdir_prefix: str,
root: str,
verbose: bool,
) -> Dict[str, Any]:
def versions_from_parentdir(parentdir_prefix, root, verbose):
"""Try to determine the version from the parent directory name.
Source tarballs conventionally unpack into a directory that includes both
Expand All @@ -154,13 +137,13 @@ def versions_from_parentdir(


@register_vcs_handler("git", "get_keywords")
def git_get_keywords(versionfile_abs: str) -> Dict[str, str]:
def git_get_keywords(versionfile_abs):
"""Extract version information from the given file."""
# the code embedded in _version.py can just fetch the value of these
# keywords. When used from setup.py, we don't want to import _version.py,
# so we do it with a regexp instead. This function is not used from
# _version.py.
keywords: Dict[str, str] = {}
keywords = {}
try:
with open(versionfile_abs, "r") as fobj:
for line in fobj:
Expand All @@ -182,11 +165,7 @@ def git_get_keywords(versionfile_abs: str) -> Dict[str, str]:


@register_vcs_handler("git", "keywords")
def git_versions_from_keywords(
keywords: Dict[str, str],
tag_prefix: str,
verbose: bool,
) -> Dict[str, Any]:
def git_versions_from_keywords(keywords, tag_prefix, verbose):
"""Get version information from git keywords."""
if "refnames" not in keywords:
raise NotThisMethod("Short version file found")
Expand Down Expand Up @@ -250,12 +229,7 @@ def git_versions_from_keywords(


@register_vcs_handler("git", "pieces_from_vcs")
def git_pieces_from_vcs(
tag_prefix: str,
root: str,
verbose: bool,
runner: Callable = run_command
) -> Dict[str, Any]:
def git_pieces_from_vcs(tag_prefix, root, verbose, runner=run_command):
"""Get version from 'git describe' in the root of the source tree.
This only gets called if the git-archive 'subst' keywords were *not*
Expand All @@ -274,7 +248,7 @@ def git_pieces_from_vcs(
runner = functools.partial(runner, env=env)

_, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root,
hide_stderr=not verbose)
hide_stderr=True)
if rc != 0:
if verbose:
print("Directory %s not under git control" % root)
Expand All @@ -285,7 +259,7 @@ def git_pieces_from_vcs(
describe_out, rc = runner(GITS, [
"describe", "--tags", "--dirty", "--always", "--long",
"--match", f"{tag_prefix}[[:digit:]]*"
], cwd=root)
], cwd=root)
# --long was added in git-1.5.5
if describe_out is None:
raise NotThisMethod("'git describe' failed")
Expand All @@ -295,7 +269,7 @@ def git_pieces_from_vcs(
raise NotThisMethod("'git rev-parse' failed")
full_out = full_out.strip()

pieces: Dict[str, Any] = {}
pieces = {}
pieces["long"] = full_out
pieces["short"] = full_out[:7] # maybe improved later
pieces["error"] = None
Expand Down Expand Up @@ -387,14 +361,14 @@ def git_pieces_from_vcs(
return pieces


def plus_or_dot(pieces: Dict[str, Any]) -> str:
def plus_or_dot(pieces):
"""Return a + if we don't already have one, else return a ."""
if "+" in pieces.get("closest-tag", ""):
return "."
return "+"


def render_pep440(pieces: Dict[str, Any]) -> str:
def render_pep440(pieces):
"""Build up version string, with post-release "local version identifier".
Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
Expand All @@ -419,7 +393,7 @@ def render_pep440(pieces: Dict[str, Any]) -> str:
return rendered


def render_pep440_branch(pieces: Dict[str, Any]) -> str:
def render_pep440_branch(pieces):
"""TAG[[.dev0]+DISTANCE.gHEX[.dirty]] .
The ".dev0" means not master branch. Note that .dev0 sorts backwards
Expand Down Expand Up @@ -449,7 +423,7 @@ def render_pep440_branch(pieces: Dict[str, Any]) -> str:
return rendered


def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]:
def pep440_split_post(ver):
"""Split pep440 version string at the post-release segment.
Returns the release segments before the post-release and the
Expand All @@ -459,7 +433,7 @@ def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]:
return vc[0], int(vc[1] or 0) if len(vc) == 2 else None


def render_pep440_pre(pieces: Dict[str, Any]) -> str:
def render_pep440_pre(pieces):
"""TAG[.postN.devDISTANCE] -- No -dirty.
Exceptions:
Expand All @@ -483,7 +457,7 @@ def render_pep440_pre(pieces: Dict[str, Any]) -> str:
return rendered


def render_pep440_post(pieces: Dict[str, Any]) -> str:
def render_pep440_post(pieces):
"""TAG[.postDISTANCE[.dev0]+gHEX] .
The ".dev0" means dirty. Note that .dev0 sorts backwards
Expand All @@ -510,7 +484,7 @@ def render_pep440_post(pieces: Dict[str, Any]) -> str:
return rendered


def render_pep440_post_branch(pieces: Dict[str, Any]) -> str:
def render_pep440_post_branch(pieces):
"""TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] .
The ".dev0" means not master branch.
Expand Down Expand Up @@ -539,7 +513,7 @@ def render_pep440_post_branch(pieces: Dict[str, Any]) -> str:
return rendered


def render_pep440_old(pieces: Dict[str, Any]) -> str:
def render_pep440_old(pieces):
"""TAG[.postDISTANCE[.dev0]] .
The ".dev0" means dirty.
Expand All @@ -561,7 +535,7 @@ def render_pep440_old(pieces: Dict[str, Any]) -> str:
return rendered


def render_git_describe(pieces: Dict[str, Any]) -> str:
def render_git_describe(pieces):
"""TAG[-DISTANCE-gHEX][-dirty].
Like 'git describe --tags --dirty --always'.
Expand All @@ -581,7 +555,7 @@ def render_git_describe(pieces: Dict[str, Any]) -> str:
return rendered


def render_git_describe_long(pieces: Dict[str, Any]) -> str:
def render_git_describe_long(pieces):
"""TAG-DISTANCE-gHEX[-dirty].
Like 'git describe --tags --dirty --always -long'.
Expand All @@ -601,7 +575,7 @@ def render_git_describe_long(pieces: Dict[str, Any]) -> str:
return rendered


def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]:
def render(pieces, style):
"""Render the given version pieces into the requested style."""
if pieces["error"]:
return {"version": "unknown",
Expand Down Expand Up @@ -637,7 +611,7 @@ def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]:
"date": pieces.get("date")}


def get_versions() -> Dict[str, Any]:
def get_versions():
"""Get version information or return default if unable to do so."""
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
# __file__, we can work backwards from there to the root. Some
Expand Down Expand Up @@ -680,4 +654,4 @@ def get_versions() -> Dict[str, Any]:

return {"version": "0+unknown", "full-revisionid": None,
"dirty": None,
"error": "unable to compute version", "date": None}
"error": "unable to compute version", "date": None}
Loading

0 comments on commit cd10e83

Please sign in to comment.