l.behm/bumblebee-status
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[all] black code :)

Browse source
This commit is contained in:
tobi-wan-kenobi 2020-05-09 21:24:28 +02:00
parent 320827d577
commit 92577e7d26
14 changed files with 291 additions and 192 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

154
bumblebee_status/_version.py
View file

@ -1,4 +1,3 @@
# This file helps to compute a version number in source trees obtained from # This file helps to compute a version number in source trees obtained from
# git-archive tarball (such as those provided by githubs download-from-tag # git-archive tarball (such as those provided by githubs download-from-tag
# feature). Distribution tarballs (built by setup.py sdist) and build # feature). Distribution tarballs (built by setup.py sdist) and build
@ -58,17 +57,18 @@ HANDLERS = {}
def register_vcs_handler(vcs, method): # decorator def register_vcs_handler(vcs, method): # decorator
"""Decorator to mark a method as the handler for a particular VCS.""" """Decorator to mark a method as the handler for a particular VCS."""
def decorate(f): def decorate(f):
"""Store f in HANDLERS[vcs][method].""" """Store f in HANDLERS[vcs][method]."""
if vcs not in HANDLERS: if vcs not in HANDLERS:
HANDLERS[vcs] = {} HANDLERS[vcs] = {}
HANDLERS[vcs][method] = f HANDLERS[vcs][method] = f
return f return f
return decorate return decorate
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None):
env=None):
"""Call the given command(s).""" """Call the given command(s)."""
assert isinstance(commands, list) assert isinstance(commands, list)
p = None p = None
@ -76,10 +76,13 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
try: try:
dispcmd = str([c] + args) dispcmd = str([c] + args)
# remember shell=False, so use git.cmd on windows, not just git # remember shell=False, so use git.cmd on windows, not just git
p = subprocess.Popen([c] + args, cwd=cwd, env=env, p = subprocess.Popen(
stdout=subprocess.PIPE, [c] + args,
stderr=(subprocess.PIPE if hide_stderr cwd=cwd,
else None)) env=env,
stdout=subprocess.PIPE,
stderr=(subprocess.PIPE if hide_stderr else None),
)
break break
except EnvironmentError: except EnvironmentError:
e = sys.exc_info()[1] e = sys.exc_info()[1]
@ -116,16 +119,22 @@ def versions_from_parentdir(parentdir_prefix, root, verbose):
for i in range(3): for i in range(3):
dirname = os.path.basename(root) dirname = os.path.basename(root)
if dirname.startswith(parentdir_prefix): if dirname.startswith(parentdir_prefix):
return {"version": dirname[len(parentdir_prefix):], return {
"full-revisionid": None, "version": dirname[len(parentdir_prefix) :],
"dirty": False, "error": None, "date": None} "full-revisionid": None,
"dirty": False,
"error": None,
"date": None,
}
else: else:
rootdirs.append(root) rootdirs.append(root)
root = os.path.dirname(root) # up a level root = os.path.dirname(root) # up a level
if verbose: if verbose:
print("Tried directories %s but none started with prefix %s" % print(
(str(rootdirs), parentdir_prefix)) "Tried directories %s but none started with prefix %s"
% (str(rootdirs), parentdir_prefix)
)
raise NotThisMethod("rootdir doesn't start with parentdir_prefix") raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
@ -181,7 +190,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
# just "foo-1.0". If we see a "tag: " prefix, prefer those. # just "foo-1.0". If we see a "tag: " prefix, prefer those.
TAG = "tag: " TAG = "tag: "
tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) tags = set([r[len(TAG) :] for r in refs if r.startswith(TAG)])
if not tags: if not tags:
# Either we're using git < 1.8.3, or there really are no tags. We use # Either we're using git < 1.8.3, or there really are no tags. We use
# a heuristic: assume all version tags have a digit. The old git %d # a heuristic: assume all version tags have a digit. The old git %d
@ -190,7 +199,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
# between branches and tags. By ignoring refnames without digits, we # between branches and tags. By ignoring refnames without digits, we
# filter out many common branch names like "release" and # filter out many common branch names like "release" and
# "stabilization", as well as "HEAD" and "master". # "stabilization", as well as "HEAD" and "master".
tags = set([r for r in refs if re.search(r'\d', r)]) tags = set([r for r in refs if re.search(r"\d", r)])
if verbose: if verbose:
print("discarding '%s', no digits" % ",".join(refs - tags)) print("discarding '%s', no digits" % ",".join(refs - tags))
if verbose: if verbose:
@ -198,19 +207,26 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
for ref in sorted(tags): for ref in sorted(tags):
# sorting will prefer e.g. "2.0" over "2.0rc1" # sorting will prefer e.g. "2.0" over "2.0rc1"
if ref.startswith(tag_prefix): if ref.startswith(tag_prefix):
r = ref[len(tag_prefix):] r = ref[len(tag_prefix) :]
if verbose: if verbose:
print("picking %s" % r) print("picking %s" % r)
return {"version": r, return {
"full-revisionid": keywords["full"].strip(), "version": r,
"dirty": False, "error": None, "full-revisionid": keywords["full"].strip(),
"date": date} "dirty": False,
"error": None,
"date": date,
}
# no suitable tags, so version is "0+unknown", but full hex is still there # no suitable tags, so version is "0+unknown", but full hex is still there
if verbose: if verbose:
print("no suitable tags, using unknown + full revision id") print("no suitable tags, using unknown + full revision id")
return {"version": "0+unknown", return {
"full-revisionid": keywords["full"].strip(), "version": "0+unknown",
"dirty": False, "error": "no suitable tags", "date": None} "full-revisionid": keywords["full"].strip(),
"dirty": False,
"error": "no suitable tags",
"date": None,
}
@register_vcs_handler("git", "pieces_from_vcs") @register_vcs_handler("git", "pieces_from_vcs")
@ -225,8 +241,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
if sys.platform == "win32": if sys.platform == "win32":
GITS = ["git.cmd", "git.exe"] GITS = ["git.cmd", "git.exe"]
out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=True)
hide_stderr=True)
if rc != 0: if rc != 0:
if verbose: if verbose:
print("Directory %s not under git control" % root) print("Directory %s not under git control" % root)
@ -234,10 +249,19 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
# if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
# if there isn't one, this yields HEX[-dirty] (no NUM) # if there isn't one, this yields HEX[-dirty] (no NUM)
describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", describe_out, rc = run_command(
"--always", "--long", GITS,
"--match", "%s*" % tag_prefix], [
cwd=root) "describe",
"--tags",
"--dirty",
"--always",
"--long",
"--match",
"%s*" % tag_prefix,
],
cwd=root,
)
# --long was added in git-1.5.5 # --long was added in git-1.5.5
if describe_out is None: if describe_out is None:
raise NotThisMethod("'git describe' failed") raise NotThisMethod("'git describe' failed")
@ -260,17 +284,16 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
dirty = git_describe.endswith("-dirty") dirty = git_describe.endswith("-dirty")
pieces["dirty"] = dirty pieces["dirty"] = dirty
if dirty: if dirty:
git_describe = git_describe[:git_describe.rindex("-dirty")] git_describe = git_describe[: git_describe.rindex("-dirty")]
# now we have TAG-NUM-gHEX or HEX # now we have TAG-NUM-gHEX or HEX
if "-" in git_describe: if "-" in git_describe:
# TAG-NUM-gHEX # TAG-NUM-gHEX
mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) mo = re.search(r"^(.+)-(\d+)-g([0-9a-f]+)$", git_describe)
if not mo: if not mo:
# unparseable. Maybe git-describe is misbehaving? # unparseable. Maybe git-describe is misbehaving?
pieces["error"] = ("unable to parse git-describe output: '%s'" pieces["error"] = "unable to parse git-describe output: '%s'" % describe_out
% describe_out)
return pieces return pieces
# tag # tag
@ -279,10 +302,12 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
if verbose: if verbose:
fmt = "tag '%s' doesn't start with prefix '%s'" fmt = "tag '%s' doesn't start with prefix '%s'"
print(fmt % (full_tag, tag_prefix)) print(fmt % (full_tag, tag_prefix))
pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" pieces["error"] = "tag '%s' doesn't start with prefix '%s'" % (
% (full_tag, tag_prefix)) full_tag,
tag_prefix,
)
return pieces return pieces
pieces["closest-tag"] = full_tag[len(tag_prefix):] pieces["closest-tag"] = full_tag[len(tag_prefix) :]
# distance: number of commits since tag # distance: number of commits since tag
pieces["distance"] = int(mo.group(2)) pieces["distance"] = int(mo.group(2))
@ -293,13 +318,13 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
else: else:
# HEX: no tags # HEX: no tags
pieces["closest-tag"] = None pieces["closest-tag"] = None
count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root)
cwd=root)
pieces["distance"] = int(count_out) # total number of commits pieces["distance"] = int(count_out) # total number of commits
# commit date: see ISO-8601 comment in git_versions_from_keywords() # commit date: see ISO-8601 comment in git_versions_from_keywords()
date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[
cwd=root)[0].strip() 0
].strip()
pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
return pieces return pieces
@ -330,8 +355,7 @@ def render_pep440(pieces):
rendered += ".dirty" rendered += ".dirty"
else: else:
# exception #1 # exception #1
rendered = "0+untagged.%d.g%s" % (pieces["distance"], rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"])
pieces["short"])
if pieces["dirty"]: if pieces["dirty"]:
rendered += ".dirty" rendered += ".dirty"
return rendered return rendered
@ -445,11 +469,13 @@ def render_git_describe_long(pieces):
def render(pieces, style): def render(pieces, style):
"""Render the given version pieces into the requested style.""" """Render the given version pieces into the requested style."""
if pieces["error"]: if pieces["error"]:
return {"version": "unknown", return {
"full-revisionid": pieces.get("long"), "version": "unknown",
"dirty": None, "full-revisionid": pieces.get("long"),
"error": pieces["error"], "dirty": None,
"date": None} "error": pieces["error"],
"date": None,
}
if not style or style == "default": if not style or style == "default":
style = "pep440" # the default style = "pep440" # the default
@ -469,9 +495,13 @@ def render(pieces, style):
else: else:
raise ValueError("unknown style '%s'" % style) raise ValueError("unknown style '%s'" % style)
return {"version": rendered, "full-revisionid": pieces["long"], return {
"dirty": pieces["dirty"], "error": None, "version": rendered,
"date": pieces.get("date")} "full-revisionid": pieces["long"],
"dirty": pieces["dirty"],
"error": None,
"date": pieces.get("date"),
}
def get_versions(): def get_versions():
@ -485,8 +515,7 @@ def get_versions():
verbose = cfg.verbose verbose = cfg.verbose
try: try:
return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, verbose)
verbose)
except NotThisMethod: except NotThisMethod:
pass pass
@ -495,13 +524,16 @@ def get_versions():
# versionfile_source is the relative path from the top of the source # versionfile_source is the relative path from the top of the source
# tree (where the .git directory might live) to this file. Invert # tree (where the .git directory might live) to this file. Invert
# this to find the root from __file__. # this to find the root from __file__.
for i in cfg.versionfile_source.split('/'): for i in cfg.versionfile_source.split("/"):
root = os.path.dirname(root) root = os.path.dirname(root)
except NameError: except NameError:
return {"version": "0+unknown", "full-revisionid": None, return {
"dirty": None, "version": "0+unknown",
"error": "unable to find root of source tree", "full-revisionid": None,
"date": None} "dirty": None,
"error": "unable to find root of source tree",
"date": None,
}
try: try:
pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose)
@ -515,6 +547,10 @@ def get_versions():
except NotThisMethod: except NotThisMethod:
pass pass
return {"version": "0+unknown", "full-revisionid": None, return {
"dirty": None, "version": "0+unknown",
"error": "unable to compute version", "date": None} "full-revisionid": None,
"dirty": None,
"error": "unable to compute version",
"date": None,
}

8
bumblebee_status/core/config.py
View file

@ -95,7 +95,7 @@ class print_usage(argparse.Action):
doc = "{}\n\n.. image:: ../screenshots/{}.png".format(doc, m) doc = "{}\n\n.. image:: ../screenshots/{}.png".format(doc, m)
rst[module_type] = rst.get(module_type, []) rst[module_type] = rst.get(module_type, [])
rst[module_type].append({ "module": m, "content": doc }) rst[module_type].append({"module": m, "content": doc})
else: else:
print( print(
textwrap.fill( textwrap.fill(
@ -119,10 +119,10 @@ class print_usage(argparse.Action):
if self._format == "rst": if self._format == "rst":
print("List of modules\n===============") print("List of modules\n===============")
for k in [ "core", "contrib" ]: for k in ["core", "contrib"]:
print("\n{}\n{}\n".format(k, "-"*len(k))) print("\n{}\n{}\n".format(k, "-" * len(k)))
for mod in rst[k]: for mod in rst[k]:
print("\n{}\n{}\n".format(mod["module"], "~"*len(mod["module"]))) print("\n{}\n{}\n".format(mod["module"], "~" * len(mod["module"])))
print(mod["content"]) print(mod["content"])

2
bumblebee_status/core/theme.py
View file

@ -15,7 +15,7 @@ PATHS = [
".", ".",
os.path.join(THEME_BASE_DIR, "../../themes"), os.path.join(THEME_BASE_DIR, "../../themes"),
os.path.expanduser("~/.config/bumblebee-status/themes"), os.path.expanduser("~/.config/bumblebee-status/themes"),
os.path.expanduser("~/.local/share/bumblebee-status/themes"), # PIP os.path.expanduser("~/.local/share/bumblebee-status/themes"), # PIP
] ]

5
bumblebee_status/discover.py
View file

@ -3,7 +3,10 @@ import sys
def discover(): def discover():
libdir = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "bumblebee_status")) libdir = os.path.abspath(
os.path.join(os.path.dirname(__file__), "..", "bumblebee_status")
)
sys.path.append(libdir) sys.path.append(libdir)
# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4 # vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4

8
bumblebee_status/modules/contrib/battery.py
View file

@ -121,15 +121,11 @@ class Module(core.module.Module):
) )
if util.format.asbool(self.parameter("compact-devices", False)): if util.format.asbool(self.parameter("compact-devices", False)):
widget = self.add_widget( widget = self.add_widget(full_text=self.capacity, name="all-batteries")
full_text=self.capacity, name="all-batteries"
)
else: else:
for battery in self._batteries: for battery in self._batteries:
log.debug("adding new widget for {}".format(battery)) log.debug("adding new widget for {}".format(battery))
widget = self.add_widget( widget = self.add_widget(full_text=self.capacity, name=battery)
full_text=self.capacity, name=battery
)
for w in self.widgets(): for w in self.widgets():
if util.format.asbool(self.parameter("decorate", True)) == False: if util.format.asbool(self.parameter("decorate", True)) == False:
widget.set("theme.exclude", "suffix") widget.set("theme.exclude", "suffix")

3
bumblebee_status/modules/contrib/traffic.py
View file

@ -159,8 +159,7 @@ class Module(core.module.Module):
for direction in ["rx", "tx"]: for direction in ["rx", "tx"]:
name = "traffic.{}-{}".format(direction, interface) name = "traffic.{}-{}".format(direction, interface)
widget = self.create_widget( widget = self.create_widget(
name, name, attributes={"theme.minwidth": self.get_minwidth_str()},
attributes={"theme.minwidth": self.get_minwidth_str()},
) )
prev = self._prev.get(name, 0) prev = self._prev.get(name, 0)
bspeed = (int(data[direction]) - int(prev)) / timediff bspeed = (int(data[direction]) - int(prev)) / timediff

1
bumblebee_status/modules/contrib/zpool.py
View file

@ -198,7 +198,6 @@ class Module(core.module.Module):
) )
) )
def state(self, widget): def state(self, widget):
if widget.name.endswith("__read"): if widget.name.endswith("__read"):
return "poolread" return "poolread"

1
bumblebee_status/modules/core/git.py
View file

@ -59,7 +59,6 @@ class Module(core.module.Module):
if "deleted" in state: if "deleted" in state:
self.add_widget(name="git.deleted") self.add_widget(name="git.deleted")
except Exception as e: except Exception as e:
self.__error = True self.__error = True

4
bumblebee_status/modules/core/xrandr.py
View file

@ -66,9 +66,7 @@ class Module(core.module.Module):
widget = self.widget(display) widget = self.widget(display)
if not widget: if not widget:
widget = self.add_widget( widget = self.add_widget(full_text=display, name=display)
full_text=display, name=display
)
core.input.register(widget, button=1, cmd=self._toggle) core.input.register(widget, button=1, cmd=self._toggle)
core.input.register(widget, button=3, cmd=self._toggle) core.input.register(widget, button=3, cmd=self._toggle)
widget.set("state", "on" if m else "off") widget.set("state", "on" if m else "off")

2
docs/conf.py
View file

@ -20,7 +20,7 @@
project = "bumblebee-status" project = "bumblebee-status"
copyright = "2020, tobi-wan-kenobi" copyright = "2020, tobi-wan-kenobi"
author = "tobi-wan-kenobi" author = "tobi-wan-kenobi"
master_doc = 'index' master_doc = "index"
import os import os
import sys import sys

4
docs/development/module.rst
View file

@ -6,10 +6,10 @@ Introduction
Adding a new module to ``bumblebee-status`` is straight-forward: Adding a new module to ``bumblebee-status`` is straight-forward:
- Add a new Python module in ``modules/contrib/``. The name of the - Add a new Python module in ``bumblebee_status/modules/contrib/``. The name of the
module will be the name that the user needs to specify when invoking module will be the name that the user needs to specify when invoking
``bumblebee-status`` (i.e. a module called ``bumblebee-status`` (i.e. a module called
``modules/contrib/test.py`` will be loaded using ``bumblebee_status/modules/contrib/test.py`` will be loaded using
``bumblebee-status -m test``) ``bumblebee-status -m test``)
- See below for how to actually write the module - See below for how to actually write the module
- Test (run ``bumblebee-status`` in the CLI) - Test (run ``bumblebee-status`` in the CLI)

20
setup.py
View file

@ -4,14 +4,15 @@
from setuptools import setup from setuptools import setup
import versioneer import versioneer
with open('requirements/base.txt') as f: with open("requirements/base.txt") as f:
INSTALL_REQS = [line for line in f.read().split('\n') if line] INSTALL_REQS = [line for line in f.read().split("\n") if line]
# Module packages # Module packages
def read_module(filename): def read_module(filename):
"""Read each in a module's requirements and parse it for extras""" """Read each in a module's requirements and parse it for extras"""
with open('requirements/modules/{}.txt'.format(filename)) as fname: with open("requirements/modules/{}.txt".format(filename)) as fname:
return [rline for rline in fname.read().split('\n') if rline] return [rline for rline in fname.read().split("\n") if rline]
EXTRAS_REQUIREMENTS_MAP = { EXTRAS_REQUIREMENTS_MAP = {
"battery-upower": read_module("battery_upower_reqs"), "battery-upower": read_module("battery_upower_reqs"),
@ -45,14 +46,15 @@ EXTRAS_REQUIREMENTS_MAP = {
import glob import glob
setup( setup(
# packages=["bumblebee-status-packages"], # packages=["bumblebee-status-packages"],
# package_dir={"bumblebee-status-packages": "."}, # package_dir={"bumblebee-status-packages": "."},
install_requires=INSTALL_REQS, install_requires=INSTALL_REQS,
extras_require=EXTRAS_REQUIREMENTS_MAP, extras_require=EXTRAS_REQUIREMENTS_MAP,
version=versioneer.get_version(), version=versioneer.get_version(),
cmdclass=versioneer.get_cmdclass(), cmdclass=versioneer.get_cmdclass(),
zip_safe=False, zip_safe=False,
data_files=[('share/bumblebee-status/themes', glob.glob('themes/*.json')), data_files=[
('share/bumblebee-status/themes/icons', glob.glob('themes/icons/*.json')) ("share/bumblebee-status/themes", glob.glob("themes/*.json")),
] ("share/bumblebee-status/themes/icons", glob.glob("themes/icons/*.json")),
],
) )

6
tests/core/test_config.py
View file

@ -62,7 +62,11 @@ class config(unittest.TestCase):
pyname = "{}.py".format(module) pyname = "{}.py".format(module)
base = os.path.abspath( base = os.path.abspath(
os.path.join( os.path.join(
os.path.dirname(os.path.realpath(__file__)), "..", "..", "bumblebee_status", "modules" os.path.dirname(os.path.realpath(__file__)),
"..",
"..",
"bumblebee_status",
"modules",
) )
) )
self.assertTrue( self.assertTrue(

265
versioneer.py
View file

@ -1,4 +1,3 @@
# Version: 0.18 # Version: 0.18
"""The Versioneer - like a rocketeer, but for versions. """The Versioneer - like a rocketeer, but for versions.
@ -277,6 +276,7 @@ https://creativecommons.org/publicdomain/zero/1.0/ .
""" """
from __future__ import print_function from __future__ import print_function
try: try:
import configparser import configparser
except ImportError: except ImportError:
@ -308,11 +308,13 @@ def get_root():
setup_py = os.path.join(root, "setup.py") setup_py = os.path.join(root, "setup.py")
versioneer_py = os.path.join(root, "versioneer.py") versioneer_py = os.path.join(root, "versioneer.py")
if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)):
err = ("Versioneer was unable to run the project root directory. " err = (
"Versioneer requires setup.py to be executed from " "Versioneer was unable to run the project root directory. "
"its immediate directory (like 'python setup.py COMMAND'), " "Versioneer requires setup.py to be executed from "
"or in a way that lets it use sys.argv[0] to find the root " "its immediate directory (like 'python setup.py COMMAND'), "
"(like 'python path/to/setup.py COMMAND').") "or in a way that lets it use sys.argv[0] to find the root "
"(like 'python path/to/setup.py COMMAND')."
)
raise VersioneerBadRootError(err) raise VersioneerBadRootError(err)
try: try:
# Certain runtime workflows (setup.py install/develop in a setuptools # Certain runtime workflows (setup.py install/develop in a setuptools
@ -325,8 +327,10 @@ def get_root():
me_dir = os.path.normcase(os.path.splitext(me)[0]) me_dir = os.path.normcase(os.path.splitext(me)[0])
vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0])
if me_dir != vsr_dir: if me_dir != vsr_dir:
print("Warning: build in %s is using versioneer.py from %s" print(
% (os.path.dirname(me), versioneer_py)) "Warning: build in %s is using versioneer.py from %s"
% (os.path.dirname(me), versioneer_py)
)
except NameError: except NameError:
pass pass
return root return root
@ -348,6 +352,7 @@ def get_config_from_root(root):
if parser.has_option("versioneer", name): if parser.has_option("versioneer", name):
return parser.get("versioneer", name) return parser.get("versioneer", name)
return None return None
cfg = VersioneerConfig() cfg = VersioneerConfig()
cfg.VCS = VCS cfg.VCS = VCS
cfg.style = get(parser, "style") or "" cfg.style = get(parser, "style") or ""
@ -372,17 +377,18 @@ HANDLERS = {}
def register_vcs_handler(vcs, method): # decorator def register_vcs_handler(vcs, method): # decorator
"""Decorator to mark a method as the handler for a particular VCS.""" """Decorator to mark a method as the handler for a particular VCS."""
def decorate(f): def decorate(f):
"""Store f in HANDLERS[vcs][method].""" """Store f in HANDLERS[vcs][method]."""
if vcs not in HANDLERS: if vcs not in HANDLERS:
HANDLERS[vcs] = {} HANDLERS[vcs] = {}
HANDLERS[vcs][method] = f HANDLERS[vcs][method] = f
return f return f
return decorate return decorate
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, env=None):
env=None):
"""Call the given command(s).""" """Call the given command(s)."""
assert isinstance(commands, list) assert isinstance(commands, list)
p = None p = None
@ -390,10 +396,13 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
try: try:
dispcmd = str([c] + args) dispcmd = str([c] + args)
# remember shell=False, so use git.cmd on windows, not just git # remember shell=False, so use git.cmd on windows, not just git
p = subprocess.Popen([c] + args, cwd=cwd, env=env, p = subprocess.Popen(
stdout=subprocess.PIPE, [c] + args,
stderr=(subprocess.PIPE if hide_stderr cwd=cwd,
else None)) env=env,
stdout=subprocess.PIPE,
stderr=(subprocess.PIPE if hide_stderr else None),
)
break break
except EnvironmentError: except EnvironmentError:
e = sys.exc_info()[1] e = sys.exc_info()[1]
@ -418,7 +427,9 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
return stdout, p.returncode return stdout, p.returncode
LONG_VERSION_PY['git'] = ''' LONG_VERSION_PY[
"git"
] = '''
# This file helps to compute a version number in source trees obtained from # This file helps to compute a version number in source trees obtained from
# git-archive tarball (such as those provided by githubs download-from-tag # git-archive tarball (such as those provided by githubs download-from-tag
# feature). Distribution tarballs (built by setup.py sdist) and build # feature). Distribution tarballs (built by setup.py sdist) and build
@ -993,7 +1004,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
# just "foo-1.0". If we see a "tag: " prefix, prefer those. # just "foo-1.0". If we see a "tag: " prefix, prefer those.
TAG = "tag: " TAG = "tag: "
tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) tags = set([r[len(TAG) :] for r in refs if r.startswith(TAG)])
if not tags: if not tags:
# Either we're using git < 1.8.3, or there really are no tags. We use # Either we're using git < 1.8.3, or there really are no tags. We use
# a heuristic: assume all version tags have a digit. The old git %d # a heuristic: assume all version tags have a digit. The old git %d
@ -1002,7 +1013,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
# between branches and tags. By ignoring refnames without digits, we # between branches and tags. By ignoring refnames without digits, we
# filter out many common branch names like "release" and # filter out many common branch names like "release" and
# "stabilization", as well as "HEAD" and "master". # "stabilization", as well as "HEAD" and "master".
tags = set([r for r in refs if re.search(r'\d', r)]) tags = set([r for r in refs if re.search(r"\d", r)])
if verbose: if verbose:
print("discarding '%s', no digits" % ",".join(refs - tags)) print("discarding '%s', no digits" % ",".join(refs - tags))
if verbose: if verbose:
@ -1010,19 +1021,26 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
for ref in sorted(tags): for ref in sorted(tags):
# sorting will prefer e.g. "2.0" over "2.0rc1" # sorting will prefer e.g. "2.0" over "2.0rc1"
if ref.startswith(tag_prefix): if ref.startswith(tag_prefix):
r = ref[len(tag_prefix):] r = ref[len(tag_prefix) :]
if verbose: if verbose:
print("picking %s" % r) print("picking %s" % r)
return {"version": r, return {
"full-revisionid": keywords["full"].strip(), "version": r,
"dirty": False, "error": None, "full-revisionid": keywords["full"].strip(),
"date": date} "dirty": False,
"error": None,
"date": date,
}
# no suitable tags, so version is "0+unknown", but full hex is still there # no suitable tags, so version is "0+unknown", but full hex is still there
if verbose: if verbose:
print("no suitable tags, using unknown + full revision id") print("no suitable tags, using unknown + full revision id")
return {"version": "0+unknown", return {
"full-revisionid": keywords["full"].strip(), "version": "0+unknown",
"dirty": False, "error": "no suitable tags", "date": None} "full-revisionid": keywords["full"].strip(),
"dirty": False,
"error": "no suitable tags",
"date": None,
}
@register_vcs_handler("git", "pieces_from_vcs") @register_vcs_handler("git", "pieces_from_vcs")
@ -1037,8 +1055,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
if sys.platform == "win32": if sys.platform == "win32":
GITS = ["git.cmd", "git.exe"] GITS = ["git.cmd", "git.exe"]
out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, hide_stderr=True)
hide_stderr=True)
if rc != 0: if rc != 0:
if verbose: if verbose:
print("Directory %s not under git control" % root) print("Directory %s not under git control" % root)
@ -1046,10 +1063,19 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
# if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
# if there isn't one, this yields HEX[-dirty] (no NUM) # if there isn't one, this yields HEX[-dirty] (no NUM)
describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", describe_out, rc = run_command(
"--always", "--long", GITS,
"--match", "%s*" % tag_prefix], [
cwd=root) "describe",
"--tags",
"--dirty",
"--always",
"--long",
"--match",
"%s*" % tag_prefix,
],
cwd=root,
)
# --long was added in git-1.5.5 # --long was added in git-1.5.5
if describe_out is None: if describe_out is None:
raise NotThisMethod("'git describe' failed") raise NotThisMethod("'git describe' failed")
@ -1072,17 +1098,16 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
dirty = git_describe.endswith("-dirty") dirty = git_describe.endswith("-dirty")
pieces["dirty"] = dirty pieces["dirty"] = dirty
if dirty: if dirty:
git_describe = git_describe[:git_describe.rindex("-dirty")] git_describe = git_describe[: git_describe.rindex("-dirty")]
# now we have TAG-NUM-gHEX or HEX # now we have TAG-NUM-gHEX or HEX
if "-" in git_describe: if "-" in git_describe:
# TAG-NUM-gHEX # TAG-NUM-gHEX
mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) mo = re.search(r"^(.+)-(\d+)-g([0-9a-f]+)$", git_describe)
if not mo: if not mo:
# unparseable. Maybe git-describe is misbehaving? # unparseable. Maybe git-describe is misbehaving?
pieces["error"] = ("unable to parse git-describe output: '%s'" pieces["error"] = "unable to parse git-describe output: '%s'" % describe_out
% describe_out)
return pieces return pieces
# tag # tag
@ -1091,10 +1116,12 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
if verbose: if verbose:
fmt = "tag '%s' doesn't start with prefix '%s'" fmt = "tag '%s' doesn't start with prefix '%s'"
print(fmt % (full_tag, tag_prefix)) print(fmt % (full_tag, tag_prefix))
pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" pieces["error"] = "tag '%s' doesn't start with prefix '%s'" % (
% (full_tag, tag_prefix)) full_tag,
tag_prefix,
)
return pieces return pieces
pieces["closest-tag"] = full_tag[len(tag_prefix):] pieces["closest-tag"] = full_tag[len(tag_prefix) :]
# distance: number of commits since tag # distance: number of commits since tag
pieces["distance"] = int(mo.group(2)) pieces["distance"] = int(mo.group(2))
@ -1105,13 +1132,13 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
else: else:
# HEX: no tags # HEX: no tags
pieces["closest-tag"] = None pieces["closest-tag"] = None
count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], cwd=root)
cwd=root)
pieces["distance"] = int(count_out) # total number of commits pieces["distance"] = int(count_out) # total number of commits
# commit date: see ISO-8601 comment in git_versions_from_keywords() # commit date: see ISO-8601 comment in git_versions_from_keywords()
date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[
cwd=root)[0].strip() 0
].strip()
pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
return pieces return pieces
@ -1167,16 +1194,22 @@ def versions_from_parentdir(parentdir_prefix, root, verbose):
for i in range(3): for i in range(3):
dirname = os.path.basename(root) dirname = os.path.basename(root)
if dirname.startswith(parentdir_prefix): if dirname.startswith(parentdir_prefix):
return {"version": dirname[len(parentdir_prefix):], return {
"full-revisionid": None, "version": dirname[len(parentdir_prefix) :],
"dirty": False, "error": None, "date": None} "full-revisionid": None,
"dirty": False,
"error": None,
"date": None,
}
else: else:
rootdirs.append(root) rootdirs.append(root)
root = os.path.dirname(root) # up a level root = os.path.dirname(root) # up a level
if verbose: if verbose:
print("Tried directories %s but none started with prefix %s" % print(
(str(rootdirs), parentdir_prefix)) "Tried directories %s but none started with prefix %s"
% (str(rootdirs), parentdir_prefix)
)
raise NotThisMethod("rootdir doesn't start with parentdir_prefix") raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
@ -1205,11 +1238,13 @@ def versions_from_file(filename):
contents = f.read() contents = f.read()
except EnvironmentError: except EnvironmentError:
raise NotThisMethod("unable to read _version.py") raise NotThisMethod("unable to read _version.py")
mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", mo = re.search(
contents, re.M | re.S) r"version_json = '''\n(.*)''' # END VERSION_JSON", contents, re.M | re.S
)
if not mo: if not mo:
mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", mo = re.search(
contents, re.M | re.S) r"version_json = '''\r\n(.*)''' # END VERSION_JSON", contents, re.M | re.S
)
if not mo: if not mo:
raise NotThisMethod("no version_json in _version.py") raise NotThisMethod("no version_json in _version.py")
return json.loads(mo.group(1)) return json.loads(mo.group(1))
@ -1218,8 +1253,7 @@ def versions_from_file(filename):
def write_to_version_file(filename, versions): def write_to_version_file(filename, versions):
"""Write the given version number to the given _version.py file.""" """Write the given version number to the given _version.py file."""
os.unlink(filename) os.unlink(filename)
contents = json.dumps(versions, sort_keys=True, contents = json.dumps(versions, sort_keys=True, indent=1, separators=(",", ": "))
indent=1, separators=(",", ": "))
with open(filename, "w") as f: with open(filename, "w") as f:
f.write(SHORT_VERSION_PY % contents) f.write(SHORT_VERSION_PY % contents)
@ -1251,8 +1285,7 @@ def render_pep440(pieces):
rendered += ".dirty" rendered += ".dirty"
else: else:
# exception #1 # exception #1
rendered = "0+untagged.%d.g%s" % (pieces["distance"], rendered = "0+untagged.%d.g%s" % (pieces["distance"], pieces["short"])
pieces["short"])
if pieces["dirty"]: if pieces["dirty"]:
rendered += ".dirty" rendered += ".dirty"
return rendered return rendered
@ -1366,11 +1399,13 @@ def render_git_describe_long(pieces):
def render(pieces, style): def render(pieces, style):
"""Render the given version pieces into the requested style.""" """Render the given version pieces into the requested style."""
if pieces["error"]: if pieces["error"]:
return {"version": "unknown", return {
"full-revisionid": pieces.get("long"), "version": "unknown",
"dirty": None, "full-revisionid": pieces.get("long"),
"error": pieces["error"], "dirty": None,
"date": None} "error": pieces["error"],
"date": None,
}
if not style or style == "default": if not style or style == "default":
style = "pep440" # the default style = "pep440" # the default
@ -1390,9 +1425,13 @@ def render(pieces, style):
else: else:
raise ValueError("unknown style '%s'" % style) raise ValueError("unknown style '%s'" % style)
return {"version": rendered, "full-revisionid": pieces["long"], return {
"dirty": pieces["dirty"], "error": None, "version": rendered,
"date": pieces.get("date")} "full-revisionid": pieces["long"],
"dirty": pieces["dirty"],
"error": None,
"date": pieces.get("date"),
}
class VersioneerBadRootError(Exception): class VersioneerBadRootError(Exception):
@ -1415,8 +1454,9 @@ def get_versions(verbose=False):
handlers = HANDLERS.get(cfg.VCS) handlers = HANDLERS.get(cfg.VCS)
assert handlers, "unrecognized VCS '%s'" % cfg.VCS assert handlers, "unrecognized VCS '%s'" % cfg.VCS
verbose = verbose or cfg.verbose verbose = verbose or cfg.verbose
assert cfg.versionfile_source is not None, \ assert (
"please set versioneer.versionfile_source" cfg.versionfile_source is not None
), "please set versioneer.versionfile_source"
assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix"
versionfile_abs = os.path.join(root, cfg.versionfile_source) versionfile_abs = os.path.join(root, cfg.versionfile_source)
@ -1470,9 +1510,13 @@ def get_versions(verbose=False):
if verbose: if verbose:
print("unable to compute version") print("unable to compute version")
return {"version": "0+unknown", "full-revisionid": None, return {
"dirty": None, "error": "unable to compute version", "version": "0+unknown",
"date": None} "full-revisionid": None,
"dirty": None,
"error": "unable to compute version",
"date": None,
}
def get_version(): def get_version():
@ -1521,6 +1565,7 @@ def get_cmdclass():
print(" date: %s" % vers.get("date")) print(" date: %s" % vers.get("date"))
if vers["error"]: if vers["error"]:
print(" error: %s" % vers["error"]) print(" error: %s" % vers["error"])
cmds["version"] = cmd_version cmds["version"] = cmd_version
# we override "build_py" in both distutils and setuptools # we override "build_py" in both distutils and setuptools
@ -1553,14 +1598,15 @@ def get_cmdclass():
# now locate _version.py in the new build/ directory and replace # now locate _version.py in the new build/ directory and replace
# it with an updated value # it with an updated value
if cfg.versionfile_build: if cfg.versionfile_build:
target_versionfile = os.path.join(self.build_lib, target_versionfile = os.path.join(self.build_lib, cfg.versionfile_build)
cfg.versionfile_build)
print("UPDATING %s" % target_versionfile) print("UPDATING %s" % target_versionfile)
write_to_version_file(target_versionfile, versions) write_to_version_file(target_versionfile, versions)
cmds["build_py"] = cmd_build_py cmds["build_py"] = cmd_build_py
if "cx_Freeze" in sys.modules: # cx_freeze enabled? if "cx_Freeze" in sys.modules: # cx_freeze enabled?
from cx_Freeze.dist import build_exe as _build_exe from cx_Freeze.dist import build_exe as _build_exe
# nczeczulin reports that py2exe won't like the pep440-style string # nczeczulin reports that py2exe won't like the pep440-style string
# as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g.
# setup(console=[{ # setup(console=[{
@ -1581,17 +1627,21 @@ def get_cmdclass():
os.unlink(target_versionfile) os.unlink(target_versionfile)
with open(cfg.versionfile_source, "w") as f: with open(cfg.versionfile_source, "w") as f:
LONG = LONG_VERSION_PY[cfg.VCS] LONG = LONG_VERSION_PY[cfg.VCS]
f.write(LONG % f.write(
{"DOLLAR": "$", LONG
"STYLE": cfg.style, % {
"TAG_PREFIX": cfg.tag_prefix, "DOLLAR": "$",
"PARENTDIR_PREFIX": cfg.parentdir_prefix, "STYLE": cfg.style,
"VERSIONFILE_SOURCE": cfg.versionfile_source, "TAG_PREFIX": cfg.tag_prefix,
}) "PARENTDIR_PREFIX": cfg.parentdir_prefix,
"VERSIONFILE_SOURCE": cfg.versionfile_source,
}
)
cmds["build_exe"] = cmd_build_exe cmds["build_exe"] = cmd_build_exe
del cmds["build_py"] del cmds["build_py"]
if 'py2exe' in sys.modules: # py2exe enabled? if "py2exe" in sys.modules: # py2exe enabled?
try: try:
from py2exe.distutils_buildexe import py2exe as _py2exe # py3 from py2exe.distutils_buildexe import py2exe as _py2exe # py3
except ImportError: except ImportError:
@ -1610,13 +1660,17 @@ def get_cmdclass():
os.unlink(target_versionfile) os.unlink(target_versionfile)
with open(cfg.versionfile_source, "w") as f: with open(cfg.versionfile_source, "w") as f:
LONG = LONG_VERSION_PY[cfg.VCS] LONG = LONG_VERSION_PY[cfg.VCS]
f.write(LONG % f.write(
{"DOLLAR": "$", LONG
"STYLE": cfg.style, % {
"TAG_PREFIX": cfg.tag_prefix, "DOLLAR": "$",
"PARENTDIR_PREFIX": cfg.parentdir_prefix, "STYLE": cfg.style,
"VERSIONFILE_SOURCE": cfg.versionfile_source, "TAG_PREFIX": cfg.tag_prefix,
}) "PARENTDIR_PREFIX": cfg.parentdir_prefix,
"VERSIONFILE_SOURCE": cfg.versionfile_source,
}
)
cmds["py2exe"] = cmd_py2exe cmds["py2exe"] = cmd_py2exe
# we override different "sdist" commands for both environments # we override different "sdist" commands for both environments
@ -1643,8 +1697,10 @@ def get_cmdclass():
# updated value # updated value
target_versionfile = os.path.join(base_dir, cfg.versionfile_source) target_versionfile = os.path.join(base_dir, cfg.versionfile_source)
print("UPDATING %s" % target_versionfile) print("UPDATING %s" % target_versionfile)
write_to_version_file(target_versionfile, write_to_version_file(
self._versioneer_generated_versions) target_versionfile, self._versioneer_generated_versions
)
cmds["sdist"] = cmd_sdist cmds["sdist"] = cmd_sdist
return cmds return cmds
@ -1699,11 +1755,13 @@ def do_setup():
root = get_root() root = get_root()
try: try:
cfg = get_config_from_root(root) cfg = get_config_from_root(root)
except (EnvironmentError, configparser.NoSectionError, except (
configparser.NoOptionError) as e: EnvironmentError,
configparser.NoSectionError,
configparser.NoOptionError,
) as e:
if isinstance(e, (EnvironmentError, configparser.NoSectionError)): if isinstance(e, (EnvironmentError, configparser.NoSectionError)):
print("Adding sample versioneer config to setup.cfg", print("Adding sample versioneer config to setup.cfg", file=sys.stderr)
file=sys.stderr)
with open(os.path.join(root, "setup.cfg"), "a") as f: with open(os.path.join(root, "setup.cfg"), "a") as f:
f.write(SAMPLE_CONFIG) f.write(SAMPLE_CONFIG)
print(CONFIG_ERROR, file=sys.stderr) print(CONFIG_ERROR, file=sys.stderr)
@ -1712,15 +1770,18 @@ def do_setup():
print(" creating %s" % cfg.versionfile_source) print(" creating %s" % cfg.versionfile_source)
with open(cfg.versionfile_source, "w") as f: with open(cfg.versionfile_source, "w") as f:
LONG = LONG_VERSION_PY[cfg.VCS] LONG = LONG_VERSION_PY[cfg.VCS]
f.write(LONG % {"DOLLAR": "$", f.write(
"STYLE": cfg.style, LONG
"TAG_PREFIX": cfg.tag_prefix, % {
"PARENTDIR_PREFIX": cfg.parentdir_prefix, "DOLLAR": "$",
"VERSIONFILE_SOURCE": cfg.versionfile_source, "STYLE": cfg.style,
}) "TAG_PREFIX": cfg.tag_prefix,
"PARENTDIR_PREFIX": cfg.parentdir_prefix,
"VERSIONFILE_SOURCE": cfg.versionfile_source,
}
)
ipy = os.path.join(os.path.dirname(cfg.versionfile_source), ipy = os.path.join(os.path.dirname(cfg.versionfile_source), "__init__.py")
"__init__.py")
if os.path.exists(ipy): if os.path.exists(ipy):
try: try:
with open(ipy, "r") as f: with open(ipy, "r") as f:
@ -1762,8 +1823,10 @@ def do_setup():
else: else:
print(" 'versioneer.py' already in MANIFEST.in") print(" 'versioneer.py' already in MANIFEST.in")
if cfg.versionfile_source not in simple_includes: if cfg.versionfile_source not in simple_includes:
print(" appending versionfile_source ('%s') to MANIFEST.in" % print(
cfg.versionfile_source) " appending versionfile_source ('%s') to MANIFEST.in"
% cfg.versionfile_source
)
with open(manifest_in, "a") as f: with open(manifest_in, "a") as f:
f.write("include %s\n" % cfg.versionfile_source) f.write("include %s\n" % cfg.versionfile_source)
else: else: