diff --git a/api/.gitattributes b/api/.gitattributes new file mode 100644 index 0000000..dca80b8 --- /dev/null +++ b/api/.gitattributes @@ -0,0 +1 @@ +pybricks/_version.py export-subst diff --git a/api/LICENSE b/api/LICENSE new file mode 100644 index 0000000..e9663c4 --- /dev/null +++ b/api/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Laurens Valk and David Lechner + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/api/MANIFEST.in b/api/MANIFEST.in new file mode 100644 index 0000000..35ba291 --- /dev/null +++ b/api/MANIFEST.in @@ -0,0 +1,2 @@ +include versioneer.py +include pybricks/_version.py diff --git a/api/README.rst b/api/README.rst new file mode 100644 index 0000000..7c20c79 --- /dev/null +++ b/api/README.rst @@ -0,0 +1,10 @@ +Fake Pybricks +============= + +This is a standard Python 3.x library that provides the Pybricks API with a +totally fake implementation. It is used to provide documentation and type +hints for code completion. + +Local install for developers: Navigate to this directory and then run +``python3 setup.py sdist bdist_wheel`` +``pip3 install --user -e .`` diff --git a/api/pybricks/__init__.py b/api/pybricks/__init__.py new file mode 100644 index 0000000..74f4e66 --- /dev/null +++ b/api/pybricks/__init__.py @@ -0,0 +1,4 @@ + +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions diff --git a/api/pybricks/_common.py b/api/pybricks/_common.py new file mode 100644 index 0000000..1c22435 --- /dev/null +++ b/api/pybricks/_common.py @@ -0,0 +1,385 @@ +"""Generic cross-platform module for typical hub devices like displays, speakers, and batteries.""" + +from parameters import Align, Direction, Stop + + +class Motor(): + """Generic class for a motor with rotational encoders.""" + + def __init__(self, port, direction=Direction.CLOCKWISE, gears=None): + """Motor(port, direction=Direction.CLOCKWISE, gears=None) + + Arguments: + port (Port): Port to which the motor is connected. + direction (Direction): Positive speed direction (*Default*: Direction.CLOCKWISE). + gears (list): List of gears linked to the motor (*Default*: ``None``). + + For example: ``[12, 36]`` represents a gear train with a 12-tooth and a 36-tooth gear. See :ref:`ratio` for illustrated examples. + + Use a list of lists for multiple gear trains, such as ``[[12, 36], [20, 16, 40]]``. + + When you specify a gear train, all motor commands and settings are automatically adjusted to account for the resulting gear ratio. The motor direction remains unchanged, no matter how many gears you choose. + + For example, with ``gears=[12, 36]``, the gear ratio is 3, which means that the output is mechanically slowed down by a factor of 3. To compensate, the motor will automatically turn 3 times as fast and 3 times as far when you give a motor command. So when you choose ``run_angle(200, 90)``, your mechanism output simply turns at 200 deg/s for 90 degrees. + + The same holds for the documentation below: When it states "motor angle" or "motor speed", you can read this as "mechanism output angle" and "mechanism output speed", and so on, as the gear ratio is automatically accounted for. + + The ``gears`` setting is only available for motors with rotation sensors. + + Example:: + + # Initialize a motor (by default this means clockwise, without any gears). + example_motor = Motor(Port.A) + + # Initialize a motor where positive speed values should go counterclockwise + right_motor = Motor(Port.B, Direction.COUNTERCLOCKWISE) + + # Initialize a motor with a gear train + robot_arm = Motor(Port.C, Direction.CLOCKWISE, [12, 36]) + """ + pass + + def dc(self, duty): + """Set the :ref:`duty cycle ` of the motor. + + Arguments: + duty (:ref:`percentage`): The duty cycle (-100.0 to 100). + + Example:: + + # Set the motor duty cycle to 75%. + example_motor.duty(75) + + """ + pass + + def angle(self): + """Get the rotation angle of the motor. + + Returns: + :ref:`angle`: Motor angle. + + """ + pass + + def speed(self): + """Get the speed (angular velocity) of the motor. + + Returns: + :ref:`speed`: Motor speed. + + """ + pass + + def stalled(self): + """Check whether the motor is currently stalled. + + A motor is stalled when it cannot move even with the maximum torque. For example, when something is blocking the motor or your mechanism simply cannot turn any further. + + Specifically, the motor is stalled when the duty cycle computed by the PID controllers has reached the maximum (so ``duty`` = ``duty_limit``) and still the motor cannot reach a minimal speed (so ``speed`` < ``stall_speed``) for a period of at least ``stall_time``. + + You can change the ``duty_limit``, ``stall_speed``, and ``stall_time`` settings using :meth:`.set_dc_settings` and :meth:`.set_pid_settings` in order to change the sensitivity to being stalled. + + Returns: + bool: ``True`` if the motor is stalled, ``False`` if it is not. + + """ + pass + + def reset_angle(self, angle): + """Reset the accumulated rotation angle of the motor. + + Arguments: + angle (:ref:`angle`): Value to which the angle should be reset. + """ + pass + + def stop(self, stop_type=Stop.COAST): + """stop(stop_type=Stop.COAST) + + Stop the motor. + + Arguments: + stop_type (Stop): Whether to coast, brake, or hold (*Default*: :class:`Stop.COAST `). + """ + pass + + def run(self, speed): + """Keep the motor running at a constant speed (angular velocity). + + The motor will accelerate towards the requested speed and the duty cycle is automatically adjusted to keep the speed constant, even under some load. This continues in the background until you give the motor a new command or the program stops. + + Arguments: + speed (:ref:`speed`): Speed of the motor. + """ + pass + + def run_time(self, speed, time, stop_type=Stop.COAST, wait=True): + """run_time(speed, time, stop_type=Stop.COAST, wait=True) + + Run the motor at a constant speed (angular velocity) for a given amount of time. + + The motor will accelerate towards the requested speed and the duty cycle is automatically adjusted to keep the speed constant, even under some load. It begins to decelerate just in time to reach standstill after the specified duration. + + Arguments: + speed (:ref:`speed`): Speed of the motor. + time (:ref:`time`): Duration of the maneuver. + stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST `). + wait (bool): Wait for the maneuver to complete before continuing with the rest of the program (*Default*: ``True``). This means that your program waits for the specified ``time``. + """ + pass + + def run_angle(self, speed, rotation_angle, stop_type=Stop.COAST, wait=True): + """run_angle(speed, rotation_angle, stop_type=Stop.COAST, wait=True) + + Run the motor at a constant speed (angular velocity) by a given angle. + + The motor will accelerate towards the requested speed and the duty cycle is automatically adjusted to keep the speed constant, even under some load. It begins to decelerate just in time so that it comes to a standstill after traversing the given angle. + + Arguments: + speed (:ref:`speed`): Speed of the motor. + rotation_angle (:ref:`angle`): Angle by which the motor should rotate. + stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST `). + wait (bool): Wait for the maneuver to complete before continuing with the rest of the program (*Default*: ``True``). This means that your program waits until the motor has traveled precisely the requested angle. + """ + pass + + def run_target(self, speed, target_angle, stop_type=Stop.COAST, wait=True): + """run_target(speed, target_angle, stop_type=Stop.COAST, wait=True) + + Run the motor at a constant speed (angular velocity) towards a given target angle. + + The motor will accelerate towards the requested speed and the duty cycle is automatically adjusted to keep the speed constant, even under some load. It begins to decelerate just in time so that it comes to a standstill at the given target angle. + + The direction of rotation is automatically selected based on the target angle. + + Arguments: + speed (:ref:`speed`): Absolute speed of the motor. The direction will be automatically selected based on the target angle: it makes no difference if you specify a positive or negative speed. + target_angle (:ref:`angle`): Target angle that the motor should rotate to, regardless of its current angle. + stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST `). + wait (bool): Wait for the maneuver to complete before continuing with the rest of the program (*Default*: ``True``). This means that your program waits until the motor has reached the target angle. + """ + pass + + def run_until_stalled(self, speed, stop_type=Stop.COAST, duty_limit=None): + """run_until_stalled(speed, stop_type=Stop.COAST, duty_limit=default) + + Run the motor at a constant speed (angular velocity) until it stalls. The motor is considered stalled when it cannot move even with the maximum torque. See :meth:`.stalled` for a more precise definition. + + The ``duty_limit`` argument lets you temporarily limit the motor torque during this maneuver. This is useful to avoid applying the full motor torque to a geared or lever mechanism. + + Arguments: + speed (:ref:`speed`): Speed of the motor. + stop_type (Stop): Whether to coast, brake, or hold after coming to a standstill (*Default*: :class:`Stop.COAST `). + duty_limit (:ref:`percentage`): Relative torque limit. This limit works just like :meth:`.set_dc_settings`, but in this case the limit is temporary: it returns to its previous value after completing this command. + """ + pass + + def track_target(self, target_angle): + """Track a target angle that varies in time. + + This function is quite similar to :meth:`.run_target`, but speed and acceleration settings are ignored: it will move to the target angle as fast as possible. Instead, you adjust speed and acceleration by choosing how fast or slow you vary the ``target_angle``. + + This method is useful in fast loops where the motor target changes continuously. + + Arguments: + target_angle (:ref:`angle`): Target angle that the motor should rotate to. + + Example:: + + # Initialize motor and timer + from math import sin + motor = Motor(Port.A) + watch = StopWatch() + amplitude = 90 + + # In a fast loop, compute a reference angle + # and make the motor track it. + while True: + # Get the time in seconds + seconds = watch.time()/1000 + # Compute a reference angle. This produces + # a sine wave that makes the motor move + # smoothly between -90 and +90 degrees. + angle_now = sin(seconds)*amplitude + # Make the motor track the given angle + motor.track_target(angle_now) + + """ + pass + + def set_dc_settings(self, duty_limit, duty_offset): + """Configure the settings to adjust the behavior of the :meth:`.dc` command. This also affects all of the ``run`` commands, which use the :meth:`.dc` method in the background. + + Arguments: + duty_limit (:ref:`percentage`): Relative torque limit during subsequent motor commands. This sets the maximum duty cycle that is applied during any subsequent motor command. This reduces the maximum torque output to a percentage of the absolute maximum stall torque. This is useful to avoid applying the full motor torque to a geared or lever mechanism, or to prevent your LEGO® train from unintentionally going at full speed. (*Default*: 100). + duty_offset (:ref:`percentage`): Minimum duty cycle given when you use :meth:`.dc`. This adds a small feed forward torque so that your motor will move even for very low duty cycle values, which can be useful when you create your own feedback controllers (*Default*: 0). + """ + pass + + def set_run_settings(self, max_speed, acceleration): + """Configure the maximum speed and acceleration/deceleration of the motor for all run commands. + + This applies to the ``run``, ``run_time``, ``run_angle``, ``run_target``, or ``run_until_stalled`` commands you give the motor. See also the :ref:`default parameters ` for each motor. + + Arguments: + max_speed (:ref:`speed`): Maximum speed of the motor during a motor command. + acceleration (:ref:`acceleration`): Acceleration towards the target speed and deceleration towards standstill. This should be a positive value. The motor will automatically change the sign to decelerate as needed. + + Example:: + + # Set the maximum speed to 200 deg/s and acceleration to 400 deg/s/s. + example_motor.set_run_settings(200, 400) + + # Make the motor run for 5 seconds. Even though the speed argument is 300 + # deg/s in this example, the motor will move at only 200 deg/s because of + # the settings above. + example_motor.run_time(300, 5000) + """ + pass + + def set_pid_settings(self, kp, ki, kd, tight_loop_limit, angle_tolerance, speed_tolerance, stall_speed, stall_time): + """Configure the settings of the position and speed controllers. See also :ref:`pid` and the :ref:`default parameters ` for each motor. + + Arguments: + kp (int): Proportional position (and integral speed) control constant. + ki (int): Integral position control constant. + kd (int): Derivative position (and proportional speed) control constant. + tight_loop_limit (:ref:`time`): If you execute any of the ``run`` commands within this interval after starting the previous command, the controllers assume that you want to control the speed directly. This means that it will ignore the acceleration setting and immediately begin tracking the speed you give in the ``run`` command. This is useful in a fast loop, where you usually want the motors to respond quickly rather than accelerate smoothly, for example with a line-following robot. + angle_tolerance (:ref:`angle`): Allowed deviation from the target angle before motion is considered complete. + speed_tolerance (:ref:`speed`): Allowed deviation from zero speed before motion is considered complete. + stall_speed (:ref:`speed`): See :meth:`.stalled`. + stall_time (:ref:`time`): See :meth:`.stalled`. + """ + pass + + +class Display(): + """Show images or text on a display.""" + + def clear(self): + """Clear everything on the display.""" + pass + + def text(self, text, coordinate=None): + """Display text. + + Parameters: + text (str): The text to display. + coordinate (tuple): ``(x, y)`` coordinate tuple. It is the top-left corner of the first character. If no coordinate is specified, it is printed on the next line. + + Example:: + + # Clear the display + brick.display.clear() + + # Print ``Hello`` near the middle of the screen + brick.display.text("Hello", (60, 50)) + + # Print ``World`` directly underneath it + brick.display.text("World") + + """ + pass + + def image(self, file_name, alignment=Align.CENTER, coordinate=None, clear=True): + """image(file_name, alignment=Align.CENTER, coordinate=None, clear=True) + + Show an image file. + + You can specify its placement either using ``alignment`` or by specifying a ``coordinate``, but not both. + + Arguments: + file_name (str): Path to the image file. Paths may be absolute or relative from the project folder. + alignment (Align): Where to place the image (*Default*: Align.CENTER). + coordinate (tuple): ``(x, y)`` coordinate tuple. It is the top-left corner of the image (*Default*: None). + clear (bool): Whether to clear the screen before showing the image (*Default*: ``True``). + + Example:: + + # Show a built-in image of two eyes looking upward + brick.display.image(ImageFile.UP) + + # Display a custom image from your project folder + brick.display.image('pybricks.png') + + # Display a custom image at the top right of the screen, without clearing + # the screen first + brick.display.image('arrow.png', Align.TOP_RIGHT, clear=False) + """ + pass + + +class Speaker(): + """Play beeps and sound files using a speaker.""" + + def beep(self, frequency=500, duration=100, volume=30): + """Play a beep/tone. + + Arguments: + frequency (:ref:`frequency`): Frequency of the beep (*Default*: 500). + duration (:ref:`time`): Duration of the beep (*Default*: 100). + volume (:ref:`percentage`): Volume of the beep (*Default*: 30). + + Example:: + + # A simple beep + brick.sound.beep() + + # A high pitch (1500 Hz) for one second (1000 ms) at 50% volume + brick.sound.beep(1500, 1000, 50) + """ + pass + + def beeps(self, number): + """Play a number of default beeps with a brief pause in between. + + Arguments: + number (int): Number of beeps. + + Example:: + + # Make 5 simple beeps + brick.sound.beeps(5) + """ + pass + + def file(self, file_name, volume=100): + """Play a sound file. + + Arguments: + file_name (str): Path to the sound file, including extension. + volume (:ref:`percentage`): Volume of the sound (*Default*: 100). + + Example:: + + # Play one of the built-in sounds + brick.sound.file(SoundFile.HELLO) + + # Play a sound file from your project folder + brick.sound.file('mysound.wav') + + """ + + pass + + +class Battery(): + """Get the status of a battery.""" + + def voltage(self): + """Get the voltage of the battery. + + Returns: + :ref:`voltage`: Battery voltage. + """ + pass + + def current(self): + """Get the current supplied by the battery. + + Returns: + :ref:`current`: Battery current. + + """ + pass diff --git a/api/pybricks/_version.py b/api/pybricks/_version.py new file mode 100644 index 0000000..dd4c25a --- /dev/null +++ b/api/pybricks/_version.py @@ -0,0 +1,520 @@ + +# 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 +# feature). Distribution tarballs (built by setup.py sdist) and build +# 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.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + + +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 + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "$Format:%d$" + git_full = "$Format:%H$" + git_date = "$Format:%ci$" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "pep440" + cfg.tag_prefix = "v" + cfg.parentdir_prefix = "fake-pybricks-" + cfg.versionfile_source = "pybricks/_version.py" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +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 + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +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 = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@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") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # 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. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # 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 + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=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* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # 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) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +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): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +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 + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} diff --git a/api/pybricks/ev3brick.py b/api/pybricks/ev3brick.py new file mode 100644 index 0000000..21739a9 --- /dev/null +++ b/api/pybricks/ev3brick.py @@ -0,0 +1,53 @@ +"""LEGO® MINDSTORMS® EV3 Brick.""" + +from parameters import Color +from _common import Speaker, Display, Battery + + +def buttons(): + """Check which buttons on the EV3 Brick are currently pressed. + + :returns: List of pressed buttons. + :rtype: List of :class:`Button ` + + Examples:: + + # Do something if the left button is pressed + if Button.LEFT in brick.buttons(): + print("The left button is pressed.") + + :: + + # Wait until any of the buttons are pressed + while not any(brick.buttons()): + wait(10) + + # Wait until all buttons are released + while any(brick.buttons()): + wait(10) + + """ + pass + + +def light(color): + """Set the color of the brick light. + + Arguments: + color (Color): Color of the light. Choose ``Color.BLACK`` or ``None`` + to turn the light off. + + Example:: + + # Make the light red + brick.light(Color.RED) + + # Turn the light off + brick.light(None) + """ + pass + + +sound = Speaker() +display = Display() +battery = Battery() diff --git a/api/pybricks/ev3devices.py b/api/pybricks/ev3devices.py new file mode 100644 index 0000000..6b36868 --- /dev/null +++ b/api/pybricks/ev3devices.py @@ -0,0 +1,257 @@ +"""LEGO® MINDSTORMS® EV3 motors and sensors.""" + +from parameters import Direction +from _common import Motor as CommonMotor + + +class Motor(CommonMotor): + """LEGO® MINDSTORMS® EV3 Medium or Large Motor. + + Element 99455/6148292 or 95658/6148278, contained in: + + * 31313: LEGO® MINDSTORMS® EV3 (2013) + * 45544: LEGO® MINDSTORMS® Education EV3 Core Set (2013) + * 45503 or 45502: Separate part (2013) + """ + + +class TouchSensor(): + """LEGO® MINDSTORMS® EV3 Touch Sensor. + + Element 95648/6138404, contained in: + + * 31313: LEGO® MINDSTORMS® EV3 (2013) + * 45544: LEGO® MINDSTORMS® Education EV3 Core Set (2013) + * 45507: Separate part (2013) + + """ + + def __init__(self, port): + """TouchSensor(port) + + Arguments: + port (Port): Port to which the sensor is connected. + """ + pass + + def pressed(self): + """Check if the sensor is pressed. + + Returns: + :obj:`bool`: ``True`` if the sensor is pressed, ``False`` if it is not pressed. + + """ + pass + + +class ColorSensor(): + """LEGO® MINDSTORMS® EV3 Color Sensor. + + Element 95650/6128869, contained in: + + * 31313: LEGO® MINDSTORMS® EV3 (2013) + * 45544: LEGO® MINDSTORMS® Education EV3 Core Set (2013) + * 45506: Separate part (2013) + """ + + def __init__(self, port): + """ColorSensor(port) + + Arguments: + port (Port): Port to which the sensor is connected. + + """ + pass + + def color(self): + """Measure the color of a surface. + + :returns: + ``Color.BLACK``, ``Color.BLUE``, ``Color.GREEN``, ``Color.YELLOW``, + ``Color.RED``, ``Color.WHITE``, ``Color.BROWN`` or ``None``. + :rtype: :class:`Color `, or ``None`` if no color is detected. + """ + pass + + def ambient(self): + """Measure the ambient light intensity. + + Returns: + :ref:`percentage`: Ambient light intensity, ranging from 0 (dark) to 100 (bright). + """ + pass + + def reflection(self): + """Measure the reflection of a surface using a red light. + + Returns: + :ref:`percentage`: Reflection, ranging from 0 (no reflection) to 100 (high reflection). + + """ + pass + + def rgb(self): + """Measure the reflection of a surface using a red, green, and then a blue light. + + Returns: + tuple of three :ref:`percentages `: Reflection for red, green, and blue light, each ranging from 0.0 (no reflection) to 100.0 (high reflection). + + """ + pass + + +class InfraredSensor(): + """LEGO® MINDSTORMS® EV3 Infrared Sensor and Beacon. + + Element 95654/6132629 and 72156/6127283, contained in: + + * 31313: LEGO® MINDSTORMS® EV3 (2013) + * 45509 and 45508: Separate parts (2013) + """ + + def __init__(self, port): + """InfraredSensor(port) + + Arguments: + port (Port): Port to which the sensor is connected. + + """ + pass + + def distance(self): + """Measure the relative distance between the sensor and an object using infrared light. + + Returns: + :ref:`relativedistance`: Relative distance ranging from 0 (closest) to 100 (farthest). + + """ + pass + + def beacon(self, channel): + """Measure the relative distance and angle between the remote and the infrared sensor. + + Arguments: + channel (int): Channel number of the remote. + + :returns: Tuple of relative distance (0 to 100) and approximate angle (-75 to 75 degrees) between remote and infrared sensor. + :rtype: (:ref:`relativedistance`, :ref:`angle`) or (``None``, ``None``) if no remote is detected. + """ + pass + + def buttons(self, channel): + """Check which buttons on the infrared remote are pressed. + + Arguments: + channel (int): Channel number of the remote. + + :returns: List of pressed buttons on the remote on the specified channel. + :rtype: List of :class:`Button ` + + """ + pass + + +class GyroSensor(): + """LEGO® MINDSTORMS® EV3 Gyro Sensor. + + Element 99380/6138411, contained in: + + * 45544: LEGO® MINDSTORMS® Education EV3 Core Set (2013) + * 45505: Separate part (2013) + """ + + def __init__(self, port, direction=Direction.CLOCKWISE): + """GyroSensor(port, direction=Direction.CLOCKWISE) + + Arguments: + port (Port): Port to which the sensor is connected. + direction (Direction): Positive rotation direction when looking at the red dot on top of the sensor (*Default*: Direction.CLOCKWISE). + + """ + pass + + def speed(self): + """Get the speed (angular velocity) of the sensor. + + Returns: + :ref:`speed`: Sensor angular velocity. + + """ + pass + + def angle(self): + """Get the accumulated angle of the sensor. + + Returns: + :ref:`angle`: Rotation angle. + + """ + pass + + def reset_angle(self, angle): + """Set the rotation angle of the sensor to a desired value. + + Arguments: + angle (:ref:`angle`): Value to which the angle should be reset. + """ + pass + + def _calibrate(self): + """Calibrate the sensor. + + This process sets the speed and angle to zero and ensures that the + angle value does not drift. + + Make sure that the sensor does not move while calibrating. + + This process can take up to 15 seconds. + """ + pass + + +class UltrasonicSensor(): + """LEGO® MINDSTORMS® EV3 Ultrasonic Sensor. + + Element 95652/6138403, contained in: + + * 45544: LEGO® MINDSTORMS® Education EV3 Core Set (2013) + * 45504: Separate part (2013) + + """ + + def __init__(self, port): + """UltrasonicSensor(port) + + Arguments: + port (Port): Port to which the sensor is connected. + + """ + pass + + def distance(self, silent=False): + """Measure the distance between the sensor and an object using ultrasonic sound waves. + + Arguments: + silent (bool): Choose ``True`` to turn the sensor off after measuring the distance. + + Choose ``False`` to leave the sensor on (*Default*). + + When you choose ``silent=True``, the sensor does not emit sounds waves + except when taking the measurement. This reduces interference with + other ultrasonic sensors, but turning the sensor off takes approximately 300 ms each time. + + Returns: + :ref:`distance`: Distance (millimeters). + + """ + pass + + def presence(self): + """Check for the presence of other ultrasonic sensors by detecting ultrasonic sounds. + + If the other ultrasonic sensor is operating in silent mode, you can only detect the presence of that sensor while it is taking a measurement. + + Returns: + :obj:`bool`: ``True`` if ultrasonic sounds are detected, ``False`` if not. + """ + pass diff --git a/api/pybricks/hub4.py b/api/pybricks/hub4.py new file mode 100644 index 0000000..376f194 --- /dev/null +++ b/api/pybricks/hub4.py @@ -0,0 +1,5 @@ +"""LEGO® Power Functions 2.0 Hub 4.""" + +from _common import Battery + +battery = Battery() diff --git a/api/pybricks/lpf2devices.py b/api/pybricks/lpf2devices.py new file mode 100644 index 0000000..9f171a2 --- /dev/null +++ b/api/pybricks/lpf2devices.py @@ -0,0 +1,64 @@ +"""LEGO® Power Functions 2.0 motor, sensors, and lights.""" + +from _common import Motor as CommonMotor + + +class Motor(CommonMotor): + """LEGO® Power Functions 2.0 motors: + + * ?/6181852: LEGO® BOOST Interactive Motor + * TODO: Expand list with compatible devices + """ + + +class ColorDistanceSensor(): + """LEGO® Power Functions 2.0 Color and Distance Sensor. + Element ?/6182145, contained in: + * 17101: LEGO® BOOST Creative Toolbox (2017) + * ?: Separate part (?) + """ + + def __init__(self, port): + """ColorDistanceSensor(port) + Arguments: + port (Port): Port to which the sensor is connected. + """ + pass + + def color(self): + """Measure the color of a surface. + + :returns: + ``Color.BLACK``, ``Color.BLUE``, ``Color.GREEN``, ``Color.YELLOW``, + ``Color.RED``, ``Color.WHITE``, or ``None``. + :rtype: :class:`Color `, or ``None`` if no color is detected. + """ + pass + + def ambient(self): + """Measure the ambient light intensity. + Returns: + :ref:`percentage`: Ambient light intensity, ranging from 0 (dark) to 100 (bright). + """ + pass + + def reflection(self): + """Measure the reflection of a surface using a red light. + Returns: + :ref:`percentage`: Reflection, ranging from 0.0 (no reflection) to 100.0 (high reflection). + """ + pass + + def rgb(self): + """Measure the reflection of a surface using a red, green, and then a blue light. + Returns: + tuple of three :ref:`percentages `: Reflection for red, green, and blue light, each ranging from 0.0 (no reflection) to 100.0 (high reflection). + """ + pass + + def distance(self): + """Measure the relative distance between the sensor and an object using infrared light. + Returns: + :ref:`relativedistance`: Relative distance ranging from 0 (closest) to 100 (farthest). + """ + pass diff --git a/api/pybricks/movehub.py b/api/pybricks/movehub.py new file mode 100644 index 0000000..beceefa --- /dev/null +++ b/api/pybricks/movehub.py @@ -0,0 +1,5 @@ +"""LEGO® Power Functions 2.0 Move Hub.""" + +from _common import Battery + +battery = Battery() diff --git a/api/pybricks/parameters.py b/api/pybricks/parameters.py new file mode 100644 index 0000000..d480e57 --- /dev/null +++ b/api/pybricks/parameters.py @@ -0,0 +1,558 @@ +"""Constant parameters/arguments for the Pybricks API.""" + +from enum import Enum + + +class Color(Enum): + """Light or surface color. + + .. data:: BLACK + .. data:: BLUE + .. data:: GREEN + .. data:: YELLOW + .. data:: RED + .. data:: WHITE + .. data:: BROWN + .. data:: ORANGE + .. data:: PURPLE + """ + + BLACK = 1 + BLUE = 2 + GREEN = 3 + YELLOW = 4 + RED = 5 + WHITE = 6 + BROWN = 7 + ORANGE = 8 + PURPLE = 9 + + +class Port(Enum): + """Port on the EV3 Programmable Brick. + + Motor ports: + + .. data:: A + .. data:: B + .. data:: C + .. data:: D + + Sensor ports: + + .. data:: S1 + .. data:: S2 + .. data:: S3 + .. data:: S4 + """ + + # Generic motor/sensor ports + A = ord('A') + B = ord('B') + C = ord('C') + D = ord('D') + + # NXT/EV3 sensor ports + S1 = ord('1') + S2 = ord('2') + S3 = ord('3') + S4 = ord('4') + + +class Stop(Enum): + """Action after the motor stops: coast, brake, or hold. + + .. data:: COAST + + Let the motor move freely. + + .. data:: BRAKE + + Passively resist small external forces. + + .. data:: HOLD + + Keep controlling the motor to hold it at the commanded angle. This is only available on motors with encoders. + + The stop type defines the resistance to motion after coming to a standstill: + + +-----------+-------------+------------------------------------------+ + |Parameter | Resistance | Physical meaning | + +===========+=============+==========================================+ + |Stop.COAST | low | Friction | + +-----------+-------------+------------------------------------------+ + |Stop.BRAKE | medium | Friction + Torque opposite to motion | + +-----------+-------------+------------------------------------------+ + |Stop.HOLD | high | Friction + Torque to hold commanded angle| + +-----------+-------------+------------------------------------------+ + + """ + + COAST = 0 + BRAKE = 1 + HOLD = 2 + + +class Direction(): + """Rotational direction for positive speed values: clockwise or counterclockwise. + + .. data:: CLOCKWISE + + A positive speed value should make the motor move clockwise. + + .. data:: COUNTERCLOCKWISE + + A positive speed value should make the motor move counterclockwise. + + For all motors, this is defined when looking at the shaft, just like looking at a clock. + + For NXT or EV3 motors, make sure to look at the motor with the red/orange shaft to the lower right. + + +----------------------------+-------------------+-----------------+ + | Parameter | Positive speed | Negative speed | + +============================+===================+=================+ + | Direction.CLOCKWISE | clockwise | counterclockwise| + +----------------------------+-------------------+-----------------+ + | Direction.COUNTERCLOCKWISE | counterclockwise | clockwise | + +----------------------------+-------------------+-----------------+ + + :: + + + Medium EV3 Motor: + + + counterclockwise clockwise + ____ _____ + / \\ + / _____________ \\ + / / \ \\ + | | _ | | + | | __| |__ | | + v | |__ o __| | v + | |_| | + | | + \______________/ + + + Large EV3 Motor: + + ________ + / \ ___ ___ + _| \ / \\ + | ----/------ \\ + counterclockwise | __\__ | clockwise + \__________ v / \ v + -------| + | + \_____/ + + + """ + + CLOCKWISE = 0 + COUNTERCLOCKWISE = 1 + + +class Button(Enum): + """Buttons on a brick or remote: + + .. data:: LEFT_DOWN + .. data:: DOWN + .. data:: RIGHT_DOWN + .. data:: LEFT + .. data:: CENTER + .. data:: RIGHT + .. data:: LEFT_UP + .. data:: UP + .. data:: BEACON + .. data:: RIGHT_UP + + +-----------+----------+-----------+ + | | | | + | LEFT_UP |UP/BEACON | RIGHT_UP | + | | | | + +-----------+----------+-----------+ + | | | | + | LEFT | CENTER | RIGHT | + | | | | + +-----------+----------+-----------+ + | | | | + | LEFT_DOWN | DOWN | RIGHT_DOWN| + | | | | + +-----------+----------+-----------+ + """ + + LEFT_DOWN = 1 + DOWN = 2 + RIGHT_DOWN = 3 + LEFT = 4 + CENTER = 5 + RIGHT = 6 + LEFT_UP = 7 + UP = 8 + BEACON = 8 + RIGHT_UP = 9 + + +class Align(): + """Alignment of an image on the display. + + .. data:: BOTTOM_LEFT + .. data:: BOTTOM + .. data:: BOTTOM_RIGHT + .. data:: LEFT + .. data:: CENTER + .. data:: RIGHT + .. data:: TOP_LEFT + .. data:: TOP + .. data:: TOP_RIGHT + """ + BOTTOM_LEFT = 1 + BOTTOM = 2 + BOTTOM_RIGHT = 3 + LEFT = 4 + CENTER = 5 + RIGHT = 6 + TOP_LEFT = 7 + TOP = 8 + TOP_RIGHT = 9 + + +class SoundFile(): + """Paths to standard EV3 sounds. + + Expressions + + .. data:: SHOUTING + .. data:: CHEERING + .. data:: CRYING + .. data:: OUCH + .. data:: LAUGHING_2 + .. data:: SNEEZING + .. data:: SMACK + .. data:: BOING + .. data:: BOO + .. data:: UH_OH + .. data:: SNORING + .. data:: KUNG_FU + .. data:: FANFARE + .. data:: CRUNCHING + .. data:: MAGIC_WAND + .. data:: LAUGHING_1 + + Information + + .. data:: LEFT + .. data:: BACKWARDS + .. data:: RIGHT + .. data:: OBJECT + .. data:: COLOR + .. data:: FLASHING + .. data:: ERROR + .. data:: ERROR_ALARM + .. data:: DOWN + .. data:: FORWARD + .. data:: ACTIVATE + .. data:: SEARCHING + .. data:: TOUCH + .. data:: UP + .. data:: ANALYZE + .. data:: STOP + .. data:: DETECTED + .. data:: TURN + .. data:: START + + Communication + + .. data:: MORNING + .. data:: EV3 + .. data:: GO + .. data:: GOOD_JOB + .. data:: OKEY_DOKEY + .. data:: GOOD + .. data:: NO + .. data:: THANK_YOU + .. data:: YES + .. data:: GAME_OVER + .. data:: OKAY + .. data:: SORRY + .. data:: BRAVO + .. data:: GOODBYE + .. data:: HI + .. data:: HELLO + .. data:: MINDSTORMS + .. data:: LEGO + .. data:: FANTASTIC + + Movements + + .. data:: SPEED_IDLE + .. data:: SPEED_DOWN + .. data:: SPEED_UP + + Color + + .. data:: BROWN + .. data:: GREEN + .. data:: BLACK + .. data:: WHITE + .. data:: RED + .. data:: BLUE + .. data:: YELLOW + + Mechanical + + .. data:: TICK_TACK + .. data:: HORN_1 + .. data:: BACKING_ALERT + .. data:: MOTOR_IDLE + .. data:: AIR_RELEASE + .. data:: AIRBRAKE + .. data:: RATCHET + .. data:: MOTOR_STOP + .. data:: HORN_2 + .. data:: LASER + .. data:: SONAR + .. data:: MOTOR_START + + Animals + + .. data:: INSECT_BUZZ_2 + .. data:: ELEPHANT_CALL + .. data:: SNAKE_HISS + .. data:: DOG_BARK_2 + .. data:: DOG_WHINE + .. data:: INSECT_BUZZ_1 + .. data:: DOG_SNIFF + .. data:: T_REX_ROAR + .. data:: INSECT_CHIRP + .. data:: DOG_GROWL + .. data:: SNAKE_RATTLE + .. data:: DOG_BARK_1 + .. data:: CAT_PURR + + Numbers + + .. data:: ZERO + .. data:: ONE + .. data:: TWO + .. data:: THREE + .. data:: FOUR + .. data:: FIVE + .. data:: SIX + .. data:: SEVEN + .. data:: EIGHT + .. data:: NINE + .. data:: TEN + + System + + .. data:: READY + .. data:: CONFIRM + .. data:: GENERAL_ALERT + .. data:: CLICK + .. data:: OVERPOWER + + """ + + _BASE_PATH = '/usr/share/sounds/ev3dev/' + SHOUTING = _BASE_PATH + 'expressions/shouting.wav' + CHEERING = _BASE_PATH + 'expressions/cheering.wav' + CRYING = _BASE_PATH + 'expressions/crying.wav' + OUCH = _BASE_PATH + 'expressions/ouch.wav' + LAUGHING_2 = _BASE_PATH + 'expressions/laughing_2.wav' + SNEEZING = _BASE_PATH + 'expressions/sneezing.wav' + SMACK = _BASE_PATH + 'expressions/smack.wav' + BOING = _BASE_PATH + 'expressions/boing.wav' + BOO = _BASE_PATH + 'expressions/boo.wav' + UH_OH = _BASE_PATH + 'expressions/uh-oh.wav' + SNORING = _BASE_PATH + 'expressions/snoring.wav' + KUNG_FU = _BASE_PATH + 'expressions/kung_fu.wav' + FANFARE = _BASE_PATH + 'expressions/fanfare.wav' + CRUNCHING = _BASE_PATH + 'expressions/crunching.wav' + MAGIC_WAND = _BASE_PATH + 'expressions/magic_wand.wav' + LAUGHING_1 = _BASE_PATH + 'expressions/laughing_1.wav' + LEFT = _BASE_PATH + 'information/left.wav' + BACKWARDS = _BASE_PATH + 'information/backwards.wav' + RIGHT = _BASE_PATH + 'information/right.wav' + OBJECT = _BASE_PATH + 'information/object.wav' + COLOR = _BASE_PATH + 'information/color.wav' + FLASHING = _BASE_PATH + 'information/flashing.wav' + ERROR = _BASE_PATH + 'information/error.wav' + ERROR_ALARM = _BASE_PATH + 'information/error_alarm.wav' + DOWN = _BASE_PATH + 'information/down.wav' + FORWARD = _BASE_PATH + 'information/forward.wav' + ACTIVATE = _BASE_PATH + 'information/activate.wav' + SEARCHING = _BASE_PATH + 'information/searching.wav' + TOUCH = _BASE_PATH + 'information/touch.wav' + UP = _BASE_PATH + 'information/up.wav' + ANALYZE = _BASE_PATH + 'information/analyze.wav' + STOP = _BASE_PATH + 'information/stop.wav' + DETECTED = _BASE_PATH + 'information/detected.wav' + TURN = _BASE_PATH + 'information/turn.wav' + START = _BASE_PATH + 'information/start.wav' + MORNING = _BASE_PATH + 'communication/morning.wav' + EV3 = _BASE_PATH + 'communication/ev3.wav' + GO = _BASE_PATH + 'communication/go.wav' + GOOD_JOB = _BASE_PATH + 'communication/good_job.wav' + OKEY_DOKEY = _BASE_PATH + 'communication/okey-dokey.wav' + GOOD = _BASE_PATH + 'communication/good.wav' + NO = _BASE_PATH + 'communication/no.wav' + THANK_YOU = _BASE_PATH + 'communication/thank_you.wav' + YES = _BASE_PATH + 'communication/yes.wav' + GAME_OVER = _BASE_PATH + 'communication/game_over.wav' + OKAY = _BASE_PATH + 'communication/okay.wav' + SORRY = _BASE_PATH + 'communication/sorry.wav' + BRAVO = _BASE_PATH + 'communication/bravo.wav' + GOODBYE = _BASE_PATH + 'communication/goodbye.wav' + HI = _BASE_PATH + 'communication/hi.wav' + HELLO = _BASE_PATH + 'communication/hello.wav' + MINDSTORMS = _BASE_PATH + 'communication/mindstorms.wav' + LEGO = _BASE_PATH + 'communication/lego.wav' + FANTASTIC = _BASE_PATH + 'communication/fantastic.wav' + SPEED_IDLE = _BASE_PATH + 'movements/speed_idle.wav' + SPEED_DOWN = _BASE_PATH + 'movements/speed_down.wav' + SPEED_UP = _BASE_PATH + 'movements/speed_up.wav' + BROWN = _BASE_PATH + 'colors/brown.wav' + GREEN = _BASE_PATH + 'colors/green.wav' + BLACK = _BASE_PATH + 'colors/black.wav' + WHITE = _BASE_PATH + 'colors/white.wav' + RED = _BASE_PATH + 'colors/red.wav' + BLUE = _BASE_PATH + 'colors/blue.wav' + YELLOW = _BASE_PATH + 'colors/yellow.wav' + TICK_TACK = _BASE_PATH + 'mechanical/tick_tack.wav' + HORN_1 = _BASE_PATH + 'mechanical/horn_1.wav' + BACKING_ALERT = _BASE_PATH + 'mechanical/backing_alert.wav' + MOTOR_IDLE = _BASE_PATH + 'mechanical/motor_idle.wav' + AIR_RELEASE = _BASE_PATH + 'mechanical/air_release.wav' + AIRBRAKE = _BASE_PATH + 'mechanical/airbrake.wav' + RATCHET = _BASE_PATH + 'mechanical/ratchet.wav' + MOTOR_STOP = _BASE_PATH + 'mechanical/motor_stop.wav' + HORN_2 = _BASE_PATH + 'mechanical/horn_2.wav' + LASER = _BASE_PATH + 'mechanical/laser.wav' + SONAR = _BASE_PATH + 'mechanical/sonar.wav' + MOTOR_START = _BASE_PATH + 'mechanical/motor_start.wav' + INSECT_BUZZ_2 = _BASE_PATH + 'animals/insect_buzz_2.wav' + ELEPHANT_CALL = _BASE_PATH + 'animals/elephant_call.wav' + SNAKE_HISS = _BASE_PATH + 'animals/snake_hiss.wav' + DOG_BARK_2 = _BASE_PATH + 'animals/dog_bark_2.wav' + DOG_WHINE = _BASE_PATH + 'animals/dog_whine.wav' + INSECT_BUZZ_1 = _BASE_PATH + 'animals/insect_buzz_1.wav' + DOG_SNIFF = _BASE_PATH + 'animals/dog_sniff.wav' + T_REX_ROAR = _BASE_PATH + 'animals/t-rex_roar.wav' + INSECT_CHIRP = _BASE_PATH + 'animals/insect_chirp.wav' + DOG_GROWL = _BASE_PATH + 'animals/dog_growl.wav' + SNAKE_RATTLE = _BASE_PATH + 'animals/snake_rattle.wav' + DOG_BARK_1 = _BASE_PATH + 'animals/dog_bark_1.wav' + CAT_PURR = _BASE_PATH + 'animals/cat_purr.wav' + EIGHT = _BASE_PATH + 'numbers/eight.wav' + SEVEN = _BASE_PATH + 'numbers/seven.wav' + SIX = _BASE_PATH + 'numbers/six.wav' + FOUR = _BASE_PATH + 'numbers/four.wav' + TEN = _BASE_PATH + 'numbers/ten.wav' + ONE = _BASE_PATH + 'numbers/one.wav' + TWO = _BASE_PATH + 'numbers/two.wav' + THREE = _BASE_PATH + 'numbers/three.wav' + ZERO = _BASE_PATH + 'numbers/zero.wav' + FIVE = _BASE_PATH + 'numbers/five.wav' + NINE = _BASE_PATH + 'numbers/nine.wav' + READY = _BASE_PATH + 'system/ready.wav' + CONFIRM = _BASE_PATH + 'system/confirm.wav' + GENERAL_ALERT = _BASE_PATH + 'system/general_alert.wav' + CLICK = _BASE_PATH + 'system/click.wav' + OVERPOWER = _BASE_PATH + 'system/overpower.wav' + + +class ImageFile(): + """Paths to standard EV3 images. + + Information + + .. data:: RIGHT + .. data:: FORWARD + .. data:: ACCEPT + .. data:: QUESTION_MARK + .. data:: STOP_1 + .. data:: LEFT + .. data:: DECLINE + .. data:: THUMBS_DOWN + .. data:: BACKWARD + .. data:: NO_GO + .. data:: WARNING + .. data:: STOP_2 + .. data:: THUMBS_UP + + LEGO + + .. data:: EV3 + .. data:: EV3_ICON + + Objects + + .. data:: TARGET + + Eyes + + .. data:: BOTTOM_RIGHT + .. data:: BOTTOM_LEFT + .. data:: EVIL + .. data:: CRAZY_2 + .. data:: KNOCKED_OUT + .. data:: PINCHED_RIGHT + .. data:: WINKING + .. data:: DIZZY + .. data:: DOWN + .. data:: TIRED_MIDDLE + .. data:: MIDDLE_RIGHT + .. data:: SLEEPING + .. data:: MIDDLE_LEFT + .. data:: TIRED_RIGHT + .. data:: PINCHED_LEFT + .. data:: PINCHED_MIDDLE + .. data:: CRAZY_1 + .. data:: NEUTRAL + .. data:: AWAKE + .. data:: UP + .. data:: TIRED_LEFT + .. data:: ANGRY + """ + + _BASE_PATH = '/usr/share/images/ev3dev/mono/' + RIGHT = _BASE_PATH + 'information/right.png' + FORWARD = _BASE_PATH + 'information/forward.png' + ACCEPT = _BASE_PATH + 'information/accept.png' + QUESTION_MARK = _BASE_PATH + 'information/question_mark.png' + STOP_1 = _BASE_PATH + 'information/stop_1.png' + LEFT = _BASE_PATH + 'information/left.png' + DECLINE = _BASE_PATH + 'information/decline.png' + THUMBS_DOWN = _BASE_PATH + 'information/thumbs_down.png' + BACKWARD = _BASE_PATH + 'information/backward.png' + NO_GO = _BASE_PATH + 'information/no_go.png' + WARNING = _BASE_PATH + 'information/warning.png' + STOP_2 = _BASE_PATH + 'information/stop_2.png' + THUMBS_UP = _BASE_PATH + 'information/thumbs_up.png' + EV3 = _BASE_PATH + 'lego/ev3.png' + EV3_ICON = _BASE_PATH + 'lego/ev3_icon.png' + TARGET = _BASE_PATH + 'objects/target.png' + BOTTOM_RIGHT = _BASE_PATH + 'eyes/bottom_right.png' + BOTTOM_LEFT = _BASE_PATH + 'eyes/bottom_left.png' + EVIL = _BASE_PATH + 'eyes/evil.png' + CRAZY_2 = _BASE_PATH + 'eyes/crazy_2.png' + KNOCKED_OUT = _BASE_PATH + 'eyes/knocked_out.png' + PINCHED_RIGHT = _BASE_PATH + 'eyes/pinched_right.png' + WINKING = _BASE_PATH + 'eyes/winking.png' + DIZZY = _BASE_PATH + 'eyes/dizzy.png' + DOWN = _BASE_PATH + 'eyes/down.png' + TIRED_MIDDLE = _BASE_PATH + 'eyes/tired_middle.png' + MIDDLE_RIGHT = _BASE_PATH + 'eyes/middle_right.png' + SLEEPING = _BASE_PATH + 'eyes/sleeping.png' + MIDDLE_LEFT = _BASE_PATH + 'eyes/middle_left.png' + TIRED_RIGHT = _BASE_PATH + 'eyes/tired_right.png' + PINCHED_LEFT = _BASE_PATH + 'eyes/pinched_left.png' + PINCHED_MIDDLE = _BASE_PATH + 'eyes/pinched_middle.png' + CRAZY_1 = _BASE_PATH + 'eyes/crazy_1.png' + NEUTRAL = _BASE_PATH + 'eyes/neutral.png' + AWAKE = _BASE_PATH + 'eyes/awake.png' + UP = _BASE_PATH + 'eyes/up.png' + TIRED_LEFT = _BASE_PATH + 'eyes/tired_left.png' + ANGRY = _BASE_PATH + 'eyes/angry.png' diff --git a/api/pybricks/robotics.py b/api/pybricks/robotics.py new file mode 100644 index 0000000..679e67f --- /dev/null +++ b/api/pybricks/robotics.py @@ -0,0 +1,77 @@ +"""Robotics module for the Pybricks API.""" + +from parameters import Stop, Direction + + +class DriveBase(): + """Class representing a robotic vehicle with two powered wheels and optional wheel caster(s).""" + + def __init__(self, left_motor, right_motor, wheel_diameter, axle_track): + """DriveBase(left_motor, right_motor, wheel_diameter, axle_track) + + Arguments: + left_motor (Motor): The motor that drives the left wheel. + right_motor (Motor): The motor that drives the right wheel. + wheel_diameter (:ref:`dimension`): Diameter of the wheels. + axle_track (:ref:`dimension`): Distance between the midpoints of the two wheels. + + Example:: + + # Initialize two motors and a drive base + left = Motor(Port.B) + right = Motor(Port.C) + robot = DriveBase(left, right, 56, 114) + """ + + def drive(self, speed, steering): + """Start driving at the specified speed and turnrate, both measured at the center point between the wheels of the robot. + + Arguments: + speed (:ref:`travelspeed`): Forward speed of the robot. + steering (:ref:`speed`): Turn rate of the robot. + + Example:: + + # Initialize two motors and a drive base + left = Motor(Port.B) + right = Motor(Port.C) + robot = DriveBase(left, right, 56, 114) + + # Initialize a sensor + sensor = UltrasonicSensor(Port.S4) + + # Drive forward until an object is detected + robot.drive(100, 0) + while sensor.distance() > 500: + wait(10) + robot.stop() + """ + pass + + def drive_time(self, speed, steering, time): + """Drive at the specified speed and turnrate for a given amount of time, and then stop. + + Arguments: + speed (:ref:`travelspeed`): Forward speed of the robot. + steering (:ref:`speed`): Turn rate of the robot. + time (:ref:`time`): Duration of the maneuver. + + Example:: + + # Drive forward at 100 mm/s for two seconds + robot.drive_time(100, 0, 2000) + + # Turn at 45 deg/s for three seconds + robot.drive_time(0, 45, 3000) + """ + pass + + def stop(self, stop_type=Stop.COAST): + """stop(stop_type=Stop.COAST) + + Stop the robot. + + Arguments: + stop_type (Stop): Whether to coast, brake, or hold (*Default*: :class:`Stop.COAST `). + """ + pass diff --git a/api/pybricks/tools.py b/api/pybricks/tools.py new file mode 100644 index 0000000..1913d09 --- /dev/null +++ b/api/pybricks/tools.py @@ -0,0 +1,61 @@ +"""Common tools for timing and datalogging.""" + + +def print(): + """print(value, ..., sep, end, file, flush) + + Print values on the terminal or a stream. + + Example:: + + # Print some text + print("Hello, world") + + # Print some text and a number + print("Value:", 5) + + """ + pass + + +def wait(time): + """Pause the user program for a specified amount of time. + + Arguments: + time (:ref:`time`): How long to wait. + + """ + pass + + +class StopWatch(): + """A stopwatch to measure time intervals. Similar to the stopwatch feature on your phone.""" + + def __init__(self): + pass + + def time(self): + """Get the current time of the stopwatch. + + Returns: + :ref:`time`: Elapsed time. + """ + pass + + def pause(self): + """Pause the stopwatch.""" + pass + + def resume(self): + """Resume the stopwatch.""" + pass + + def reset(self): + """Reset the stopwatch time to 0. + + The run state is unaffected: + + * If it was paused, it stays paused (but now at 0). + * If it was running, it stays running (but starting again from 0). + """ + pass diff --git a/api/setup.cfg b/api/setup.cfg new file mode 100644 index 0000000..007d8e0 --- /dev/null +++ b/api/setup.cfg @@ -0,0 +1,12 @@ + +# See the docstring in versioneer.py for instructions. Note that you must +# re-run 'versioneer.py setup' after changing this section, and commit the +# resulting files. + +[versioneer] +VCS = git +style = pep440 +versionfile_source = pybricks/_version.py +versionfile_build = pybricks/_version.py +tag_prefix = v +parentdir_prefix = fake-pybricks- diff --git a/api/setup.py b/api/setup.py new file mode 100644 index 0000000..ad92834 --- /dev/null +++ b/api/setup.py @@ -0,0 +1,36 @@ +"""pypi compatible setup module. + +This setup is based on: +https://packaging.python.org/tutorials/distributing-packages/ + + +""" +from setuptools import setup +from codecs import open +from os import path + +import versioneer + + +here = path.abspath(path.dirname(__file__)) +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='fake-pybricks', + version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), + description='Pybricks', + long_description=long_description, + url='https://github.com/pybricks', + author='Laurens Valk and David Lechner', + author_email='laurensvalk@gmail.com', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + ], + keywords='lego mindstorms ev3', + python_requires='~=3.4', + packages=['pybricks'], +) diff --git a/api/versioneer.py b/api/versioneer.py new file mode 100644 index 0000000..64fea1c --- /dev/null +++ b/api/versioneer.py @@ -0,0 +1,1822 @@ + +# Version: 0.18 + +"""The Versioneer - like a rocketeer, but for versions. + +The Versioneer +============== + +* like a rocketeer, but for versions! +* https://github.com/warner/python-versioneer +* Brian Warner +* License: Public Domain +* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, and pypy +* [![Latest Version] +(https://pypip.in/version/versioneer/badge.svg?style=flat) +](https://pypi.python.org/pypi/versioneer/) +* [![Build Status] +(https://travis-ci.org/warner/python-versioneer.png?branch=master) +](https://travis-ci.org/warner/python-versioneer) + +This is a tool for managing a recorded version number in distutils-based +python projects. The goal is to remove the tedious and error-prone "update +the embedded version string" step from your release process. Making a new +release should be as easy as recording a new tag in your version-control +system, and maybe making new tarballs. + + +## Quick Install + +* `pip install versioneer` to somewhere to your $PATH +* add a `[versioneer]` section to your setup.cfg (see below) +* run `versioneer install` in your source tree, commit the results + +## Version Identifiers + +Source trees come from a variety of places: + +* a version-control system checkout (mostly used by developers) +* a nightly tarball, produced by build automation +* a snapshot tarball, produced by a web-based VCS browser, like github's + "tarball from tag" feature +* a release tarball, produced by "setup.py sdist", distributed through PyPI + +Within each source tree, the version identifier (either a string or a number, +this tool is format-agnostic) can come from a variety of places: + +* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows + about recent "tags" and an absolute revision-id +* the name of the directory into which the tarball was unpacked +* an expanded VCS keyword ($Id$, etc) +* a `_version.py` created by some earlier build step + +For released software, the version identifier is closely related to a VCS +tag. Some projects use tag names that include more than just the version +string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool +needs to strip the tag prefix to extract the version identifier. For +unreleased software (between tags), the version identifier should provide +enough information to help developers recreate the same tree, while also +giving them an idea of roughly how old the tree is (after version 1.2, before +version 1.3). Many VCS systems can report a description that captures this, +for example `git describe --tags --dirty --always` reports things like +"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the +0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has +uncommitted changes. + +The version identifier is used for multiple purposes: + +* to allow the module to self-identify its version: `myproject.__version__` +* to choose a name and prefix for a 'setup.py sdist' tarball + +## Theory of Operation + +Versioneer works by adding a special `_version.py` file into your source +tree, where your `__init__.py` can import it. This `_version.py` knows how to +dynamically ask the VCS tool for version information at import time. + +`_version.py` also contains `$Revision$` markers, and the installation +process marks `_version.py` to have this marker rewritten with a tag name +during the `git archive` command. As a result, generated tarballs will +contain enough information to get the proper version. + +To allow `setup.py` to compute a version too, a `versioneer.py` is added to +the top level of your source tree, next to `setup.py` and the `setup.cfg` +that configures it. This overrides several distutils/setuptools commands to +compute the version when invoked, and changes `setup.py build` and `setup.py +sdist` to replace `_version.py` with a small static file that contains just +the generated version data. + +## Installation + +See [INSTALL.md](./INSTALL.md) for detailed installation instructions. + +## Version-String Flavors + +Code which uses Versioneer can learn about its version string at runtime by +importing `_version` from your main `__init__.py` file and running the +`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can +import the top-level `versioneer.py` and run `get_versions()`. + +Both functions return a dictionary with different flavors of version +information: + +* `['version']`: A condensed version string, rendered using the selected + style. This is the most commonly used value for the project's version + string. The default "pep440" style yields strings like `0.11`, + `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section + below for alternative styles. + +* `['full-revisionid']`: detailed revision identifier. For Git, this is the + full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". + +* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the + commit date in ISO 8601 format. This will be None if the date is not + available. + +* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that + this is only accurate if run in a VCS checkout, otherwise it is likely to + be False or None + +* `['error']`: if the version string could not be computed, this will be set + to a string describing the problem, otherwise it will be None. It may be + useful to throw an exception in setup.py if this is set, to avoid e.g. + creating tarballs with a version string of "unknown". + +Some variants are more useful than others. Including `full-revisionid` in a +bug report should allow developers to reconstruct the exact code being tested +(or indicate the presence of local changes that should be shared with the +developers). `version` is suitable for display in an "about" box or a CLI +`--version` output: it can be easily compared against release notes and lists +of bugs fixed in various releases. + +The installer adds the following text to your `__init__.py` to place a basic +version in `YOURPROJECT.__version__`: + + from ._version import get_versions + __version__ = get_versions()['version'] + del get_versions + +## Styles + +The setup.cfg `style=` configuration controls how the VCS information is +rendered into a version string. + +The default style, "pep440", produces a PEP440-compliant string, equal to the +un-prefixed tag name for actual releases, and containing an additional "local +version" section with more detail for in-between builds. For Git, this is +TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags +--dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the +tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and +that this commit is two revisions ("+2") beyond the "0.11" tag. For released +software (exactly equal to a known tag), the identifier will only contain the +stripped tag, e.g. "0.11". + +Other styles are available. See [details.md](details.md) in the Versioneer +source tree for descriptions. + +## Debugging + +Versioneer tries to avoid fatal errors: if something goes wrong, it will tend +to return a version of "0+unknown". To investigate the problem, run `setup.py +version`, which will run the version-lookup code in a verbose mode, and will +display the full contents of `get_versions()` (including the `error` string, +which may help identify what went wrong). + +## Known Limitations + +Some situations are known to cause problems for Versioneer. This details the +most significant ones. More can be found on Github +[issues page](https://github.com/warner/python-versioneer/issues). + +### Subprojects + +Versioneer has limited support for source trees in which `setup.py` is not in +the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are +two common reasons why `setup.py` might not be in the root: + +* Source trees which contain multiple subprojects, such as + [Buildbot](https://github.com/buildbot/buildbot), which contains both + "master" and "slave" subprojects, each with their own `setup.py`, + `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI + distributions (and upload multiple independently-installable tarballs). +* Source trees whose main purpose is to contain a C library, but which also + provide bindings to Python (and perhaps other langauges) in subdirectories. + +Versioneer will look for `.git` in parent directories, and most operations +should get the right version string. However `pip` and `setuptools` have bugs +and implementation details which frequently cause `pip install .` from a +subproject directory to fail to find a correct version string (so it usually +defaults to `0+unknown`). + +`pip install --editable .` should work correctly. `setup.py install` might +work too. + +Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in +some later version. + +[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking +this issue. The discussion in +[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the +issue from the Versioneer side in more detail. +[pip PR#3176](https://github.com/pypa/pip/pull/3176) and +[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve +pip to let Versioneer work correctly. + +Versioneer-0.16 and earlier only looked for a `.git` directory next to the +`setup.cfg`, so subprojects were completely unsupported with those releases. + +### Editable installs with setuptools <= 18.5 + +`setup.py develop` and `pip install --editable .` allow you to install a +project into a virtualenv once, then continue editing the source code (and +test) without re-installing after every change. + +"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a +convenient way to specify executable scripts that should be installed along +with the python package. + +These both work as expected when using modern setuptools. When using +setuptools-18.5 or earlier, however, certain operations will cause +`pkg_resources.DistributionNotFound` errors when running the entrypoint +script, which must be resolved by re-installing the package. This happens +when the install happens with one version, then the egg_info data is +regenerated while a different version is checked out. Many setup.py commands +cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into +a different virtualenv), so this can be surprising. + +[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes +this one, but upgrading to a newer version of setuptools should probably +resolve it. + +### Unicode version strings + +While Versioneer works (and is continually tested) with both Python 2 and +Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. +Newer releases probably generate unicode version strings on py2. It's not +clear that this is wrong, but it may be surprising for applications when then +write these strings to a network connection or include them in bytes-oriented +APIs like cryptographic checksums. + +[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates +this question. + + +## Updating Versioneer + +To upgrade your project to a new release of Versioneer, do the following: + +* install the new Versioneer (`pip install -U versioneer` or equivalent) +* edit `setup.cfg`, if necessary, to include any new configuration settings + indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. +* re-run `versioneer install` in your source tree, to replace + `SRC/_version.py` +* commit any changed files + +## Future Directions + +This tool is designed to make it easily extended to other version-control +systems: all VCS-specific components are in separate directories like +src/git/ . The top-level `versioneer.py` script is assembled from these +components by running make-versioneer.py . In the future, make-versioneer.py +will take a VCS name as an argument, and will construct a version of +`versioneer.py` that is specific to the given VCS. It might also take the +configuration arguments that are currently provided manually during +installation by editing setup.py . Alternatively, it might go the other +direction and include code from all supported VCS systems, reducing the +number of intermediate scripts. + + +## License + +To make Versioneer easier to embed, all its code is dedicated to the public +domain. The `_version.py` that it creates is also in the public domain. +Specifically, both are released under the Creative Commons "Public Domain +Dedication" license (CC0-1.0), as described in +https://creativecommons.org/publicdomain/zero/1.0/ . + +""" + +from __future__ import print_function +try: + import configparser +except ImportError: + import ConfigParser as configparser +import errno +import json +import os +import re +import subprocess +import sys + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_root(): + """Get the project root directory. + + We require that all commands are run from the project root, i.e. the + directory that contains setup.py, setup.cfg, and versioneer.py . + """ + root = os.path.realpath(os.path.abspath(os.getcwd())) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "versioneer.py") + if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): + # allow 'python path/to/setup.py COMMAND' + root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) + setup_py = os.path.join(root, "setup.py") + versioneer_py = os.path.join(root, "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. " + "Versioneer requires setup.py to be executed from " + "its immediate directory (like 'python 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) + try: + # Certain runtime workflows (setup.py install/develop in a setuptools + # tree) execute all dependencies in a single python process, so + # "versioneer" may be imported multiple times, and python's shared + # module-import table will cache the first one. So we can't use + # os.path.dirname(__file__), as that will find whichever + # versioneer.py was first imported, even in later projects. + me = os.path.realpath(os.path.abspath(__file__)) + me_dir = os.path.normcase(os.path.splitext(me)[0]) + vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) + if me_dir != vsr_dir: + print("Warning: build in %s is using versioneer.py from %s" + % (os.path.dirname(me), versioneer_py)) + except NameError: + pass + return root + + +def get_config_from_root(root): + """Read the project setup.cfg file to determine Versioneer config.""" + # This might raise EnvironmentError (if setup.cfg is missing), or + # configparser.NoSectionError (if it lacks a [versioneer] section), or + # configparser.NoOptionError (if it lacks "VCS="). See the docstring at + # the top of versioneer.py for instructions on writing your setup.cfg . + setup_cfg = os.path.join(root, "setup.cfg") + parser = configparser.SafeConfigParser() + with open(setup_cfg, "r") as f: + parser.readfp(f) + VCS = parser.get("versioneer", "VCS") # mandatory + + def get(parser, name): + if parser.has_option("versioneer", name): + return parser.get("versioneer", name) + return None + cfg = VersioneerConfig() + cfg.VCS = VCS + cfg.style = get(parser, "style") or "" + cfg.versionfile_source = get(parser, "versionfile_source") + cfg.versionfile_build = get(parser, "versionfile_build") + cfg.tag_prefix = get(parser, "tag_prefix") + if cfg.tag_prefix in ("''", '""'): + cfg.tag_prefix = "" + cfg.parentdir_prefix = get(parser, "parentdir_prefix") + cfg.verbose = get(parser, "verbose") + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +# these dictionaries contain VCS-specific tools +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % dispcmd) + print("stdout was %s" % stdout) + return None, p.returncode + return stdout, p.returncode + + +LONG_VERSION_PY['git'] = ''' +# 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 +# feature). Distribution tarballs (built by setup.py sdist) and build +# 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.18 (https://github.com/warner/python-versioneer) + +"""Git implementation of _version.py.""" + +import errno +import os +import re +import subprocess +import sys + + +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 + # each be defined on a line of their own. _version.py will just call + # get_keywords(). + git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" + git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" + git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" + keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} + return keywords + + +class VersioneerConfig: + """Container for Versioneer configuration parameters.""" + + +def get_config(): + """Create, populate and return the VersioneerConfig() object.""" + # these strings are filled in when 'setup.py versioneer' creates + # _version.py + cfg = VersioneerConfig() + cfg.VCS = "git" + cfg.style = "%(STYLE)s" + cfg.tag_prefix = "%(TAG_PREFIX)s" + cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" + cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" + cfg.verbose = False + return cfg + + +class NotThisMethod(Exception): + """Exception raised if a method is not valid for the current scenario.""" + + +LONG_VERSION_PY = {} +HANDLERS = {} + + +def register_vcs_handler(vcs, method): # decorator + """Decorator to mark a method as the handler for a particular VCS.""" + def decorate(f): + """Store f in HANDLERS[vcs][method].""" + if vcs not in HANDLERS: + HANDLERS[vcs] = {} + HANDLERS[vcs][method] = f + return f + return decorate + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, + env=None): + """Call the given command(s).""" + assert isinstance(commands, list) + p = None + for c in commands: + try: + dispcmd = str([c] + args) + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, env=env, + stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %%s" %% dispcmd) + print(e) + return None, None + else: + if verbose: + print("unable to find command, tried %%s" %% (commands,)) + return None, None + stdout = p.communicate()[0].strip() + if sys.version_info[0] >= 3: + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %%s (error)" %% dispcmd) + print("stdout was %%s" %% stdout) + return None, p.returncode + return stdout, p.returncode + + +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 + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %%s but none started with prefix %%s" %% + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +@register_vcs_handler("git", "get_keywords") +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 = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@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") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # 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. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # 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 + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%%s', no digits" %% ",".join(refs - tags)) + if verbose: + print("likely tags: %%s" %% ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %%s" %% r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=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* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %%s not under git control" %% root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # 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) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%%s*" %% tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%%s'" + %% describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%%s' doesn't start with prefix '%%s'" + print(fmt %% (full_tag, tag_prefix)) + pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" + %% (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +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): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%%d" %% pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%%d" %% pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%%s" %% pieces["short"] + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%%s" %% pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%%d" %% pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%%s'" %% style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +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 + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded keywords. + + cfg = get_config() + verbose = cfg.verbose + + try: + return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, + verbose) + except NotThisMethod: + pass + + try: + root = os.path.realpath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in cfg.versionfile_source.split('/'): + root = os.path.dirname(root) + except NameError: + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to find root of source tree", + "date": None} + + try: + pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) + return render(pieces, cfg.style) + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + except NotThisMethod: + pass + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, + "error": "unable to compute version", "date": None} +''' + + +@register_vcs_handler("git", "get_keywords") +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 = {} + try: + f = open(versionfile_abs, "r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["full"] = mo.group(1) + if line.strip().startswith("git_date ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + keywords["date"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return keywords + + +@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") + date = keywords.get("date") + if date is not None: + # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant + # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 + # -like" string, which we must then edit to make compliant), because + # it's been around since git-1.5.3, and it's too difficult to + # discover which version we're using, or to work around using an + # older one. + date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + refnames = keywords["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("keywords are unexpanded, not using") + raise NotThisMethod("unexpanded keywords, not a git-archive tarball") + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # 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. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # 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 + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs - tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return {"version": r, + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": None, + "date": date} + # no suitable tags, so version is "0+unknown", but full hex is still there + if verbose: + print("no suitable tags, using unknown + full revision id") + return {"version": "0+unknown", + "full-revisionid": keywords["full"].strip(), + "dirty": False, "error": "no suitable tags", "date": None} + + +@register_vcs_handler("git", "pieces_from_vcs") +def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=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* + expanded, and _version.py hasn't already been rewritten with a short + version string, meaning we're inside a checked out source tree. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + + out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, + hide_stderr=True) + if rc != 0: + if verbose: + print("Directory %s not under git control" % root) + raise NotThisMethod("'git rev-parse --git-dir' returned error") + + # 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) + describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", + "--always", "--long", + "--match", "%s*" % tag_prefix], + cwd=root) + # --long was added in git-1.5.5 + if describe_out is None: + raise NotThisMethod("'git describe' failed") + describe_out = describe_out.strip() + full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if full_out is None: + raise NotThisMethod("'git rev-parse' failed") + full_out = full_out.strip() + + pieces = {} + pieces["long"] = full_out + pieces["short"] = full_out[:7] # maybe improved later + pieces["error"] = None + + # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] + # TAG might have hyphens. + git_describe = describe_out + + # look for -dirty suffix + dirty = git_describe.endswith("-dirty") + pieces["dirty"] = dirty + if dirty: + git_describe = git_describe[:git_describe.rindex("-dirty")] + + # now we have TAG-NUM-gHEX or HEX + + if "-" in git_describe: + # TAG-NUM-gHEX + mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) + if not mo: + # unparseable. Maybe git-describe is misbehaving? + pieces["error"] = ("unable to parse git-describe output: '%s'" + % describe_out) + return pieces + + # tag + full_tag = mo.group(1) + if not full_tag.startswith(tag_prefix): + if verbose: + fmt = "tag '%s' doesn't start with prefix '%s'" + print(fmt % (full_tag, tag_prefix)) + pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" + % (full_tag, tag_prefix)) + return pieces + pieces["closest-tag"] = full_tag[len(tag_prefix):] + + # distance: number of commits since tag + pieces["distance"] = int(mo.group(2)) + + # commit: short hex revision ID + pieces["short"] = mo.group(3) + + else: + # HEX: no tags + pieces["closest-tag"] = None + count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], + cwd=root) + pieces["distance"] = int(count_out) # total number of commits + + # commit date: see ISO-8601 comment in git_versions_from_keywords() + date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], + cwd=root)[0].strip() + pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) + + return pieces + + +def do_vcs_install(manifest_in, versionfile_source, ipy): + """Git-specific installation logic for Versioneer. + + For Git, this means creating/changing .gitattributes to mark _version.py + for export-subst keyword substitution. + """ + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + files = [manifest_in, versionfile_source] + if ipy: + files.append(ipy) + try: + me = __file__ + if me.endswith(".pyc") or me.endswith(".pyo"): + me = os.path.splitext(me)[0] + ".py" + versioneer_file = os.path.relpath(me) + except NameError: + versioneer_file = "versioneer.py" + files.append(versioneer_file) + present = False + try: + f = open(".gitattributes", "r") + for line in f.readlines(): + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + f.close() + except EnvironmentError: + pass + if not present: + f = open(".gitattributes", "a+") + f.write("%s export-subst\n" % versionfile_source) + f.close() + files.append(".gitattributes") + run_command(GITS, ["add", "--"] + files) + + +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 + the project name and a version string. We will also support searching up + two directory levels for an appropriately named parent directory + """ + rootdirs = [] + + for i in range(3): + dirname = os.path.basename(root) + if dirname.startswith(parentdir_prefix): + return {"version": dirname[len(parentdir_prefix):], + "full-revisionid": None, + "dirty": False, "error": None, "date": None} + else: + rootdirs.append(root) + root = os.path.dirname(root) # up a level + + if verbose: + print("Tried directories %s but none started with prefix %s" % + (str(rootdirs), parentdir_prefix)) + raise NotThisMethod("rootdir doesn't start with parentdir_prefix") + + +SHORT_VERSION_PY = """ +# This file was generated by 'versioneer.py' (0.18) from +# revision-control system data, or from the parent directory name of an +# unpacked source archive. Distribution tarballs contain a pre-generated copy +# of this file. + +import json + +version_json = ''' +%s +''' # END VERSION_JSON + + +def get_versions(): + return json.loads(version_json) +""" + + +def versions_from_file(filename): + """Try to determine the version from _version.py if present.""" + try: + with open(filename) as f: + contents = f.read() + except EnvironmentError: + raise NotThisMethod("unable to read _version.py") + mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", + contents, re.M | re.S) + if not mo: + raise NotThisMethod("no version_json in _version.py") + return json.loads(mo.group(1)) + + +def write_to_version_file(filename, versions): + """Write the given version number to the given _version.py file.""" + os.unlink(filename) + contents = json.dumps(versions, sort_keys=True, + indent=1, separators=(",", ": ")) + with open(filename, "w") as f: + f.write(SHORT_VERSION_PY % contents) + + print("set %s to '%s'" % (filename, versions["version"])) + + +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): + """Build up version string, with post-release "local version identifier". + + Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you + get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty + + Exceptions: + 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += plus_or_dot(pieces) + rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + else: + # exception #1 + rendered = "0+untagged.%d.g%s" % (pieces["distance"], + pieces["short"]) + if pieces["dirty"]: + rendered += ".dirty" + return rendered + + +def render_pep440_pre(pieces): + """TAG[.post.devDISTANCE] -- No -dirty. + + Exceptions: + 1: no tags. 0.post.devDISTANCE + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += ".post.dev%d" % pieces["distance"] + else: + # exception #1 + rendered = "0.post.dev%d" % pieces["distance"] + return rendered + + +def render_pep440_post(pieces): + """TAG[.postDISTANCE[.dev0]+gHEX] . + + The ".dev0" means dirty. Note that .dev0 sorts backwards + (a dirty tree will appear "older" than the corresponding clean one), + but you shouldn't be releasing software with -dirty anyways. + + Exceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += plus_or_dot(pieces) + rendered += "g%s" % pieces["short"] + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + rendered += "+g%s" % pieces["short"] + return rendered + + +def render_pep440_old(pieces): + """TAG[.postDISTANCE[.dev0]] . + + The ".dev0" means dirty. + + Eexceptions: + 1: no tags. 0.postDISTANCE[.dev0] + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"] or pieces["dirty"]: + rendered += ".post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + else: + # exception #1 + rendered = "0.post%d" % pieces["distance"] + if pieces["dirty"]: + rendered += ".dev0" + return rendered + + +def render_git_describe(pieces): + """TAG[-DISTANCE-gHEX][-dirty]. + + Like 'git describe --tags --dirty --always'. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + if pieces["distance"]: + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render_git_describe_long(pieces): + """TAG-DISTANCE-gHEX[-dirty]. + + Like 'git describe --tags --dirty --always -long'. + The distance/hash is unconditional. + + Exceptions: + 1: no tags. HEX[-dirty] (note: no 'g' prefix) + """ + if pieces["closest-tag"]: + rendered = pieces["closest-tag"] + rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) + else: + # exception #1 + rendered = pieces["short"] + if pieces["dirty"]: + rendered += "-dirty" + return rendered + + +def render(pieces, style): + """Render the given version pieces into the requested style.""" + if pieces["error"]: + return {"version": "unknown", + "full-revisionid": pieces.get("long"), + "dirty": None, + "error": pieces["error"], + "date": None} + + if not style or style == "default": + style = "pep440" # the default + + if style == "pep440": + rendered = render_pep440(pieces) + elif style == "pep440-pre": + rendered = render_pep440_pre(pieces) + elif style == "pep440-post": + rendered = render_pep440_post(pieces) + elif style == "pep440-old": + rendered = render_pep440_old(pieces) + elif style == "git-describe": + rendered = render_git_describe(pieces) + elif style == "git-describe-long": + rendered = render_git_describe_long(pieces) + else: + raise ValueError("unknown style '%s'" % style) + + return {"version": rendered, "full-revisionid": pieces["long"], + "dirty": pieces["dirty"], "error": None, + "date": pieces.get("date")} + + +class VersioneerBadRootError(Exception): + """The project root directory is unknown or missing key files.""" + + +def get_versions(verbose=False): + """Get the project version from whatever source is available. + + Returns dict with two keys: 'version' and 'full'. + """ + if "versioneer" in sys.modules: + # see the discussion in cmdclass.py:get_cmdclass() + del sys.modules["versioneer"] + + root = get_root() + cfg = get_config_from_root(root) + + assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" + handlers = HANDLERS.get(cfg.VCS) + assert handlers, "unrecognized VCS '%s'" % cfg.VCS + verbose = verbose or cfg.verbose + assert cfg.versionfile_source is not None, \ + "please set versioneer.versionfile_source" + assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" + + versionfile_abs = os.path.join(root, cfg.versionfile_source) + + # extract version from first of: _version.py, VCS command (e.g. 'git + # describe'), parentdir. This is meant to work for developers using a + # source checkout, for users of a tarball created by 'setup.py sdist', + # and for users of a tarball/zipball created by 'git archive' or github's + # download-from-tag feature or the equivalent in other VCSes. + + get_keywords_f = handlers.get("get_keywords") + from_keywords_f = handlers.get("keywords") + if get_keywords_f and from_keywords_f: + try: + keywords = get_keywords_f(versionfile_abs) + ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) + if verbose: + print("got version from expanded keyword %s" % ver) + return ver + except NotThisMethod: + pass + + try: + ver = versions_from_file(versionfile_abs) + if verbose: + print("got version from file %s %s" % (versionfile_abs, ver)) + return ver + except NotThisMethod: + pass + + from_vcs_f = handlers.get("pieces_from_vcs") + if from_vcs_f: + try: + pieces = from_vcs_f(cfg.tag_prefix, root, verbose) + ver = render(pieces, cfg.style) + if verbose: + print("got version from VCS %s" % ver) + return ver + except NotThisMethod: + pass + + try: + if cfg.parentdir_prefix: + ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) + if verbose: + print("got version from parentdir %s" % ver) + return ver + except NotThisMethod: + pass + + if verbose: + print("unable to compute version") + + return {"version": "0+unknown", "full-revisionid": None, + "dirty": None, "error": "unable to compute version", + "date": None} + + +def get_version(): + """Get the short version string for this project.""" + return get_versions()["version"] + + +def get_cmdclass(): + """Get the custom setuptools/distutils subclasses used by Versioneer.""" + if "versioneer" in sys.modules: + del sys.modules["versioneer"] + # this fixes the "python setup.py develop" case (also 'install' and + # 'easy_install .'), in which subdependencies of the main project are + # built (using setup.py bdist_egg) in the same python process. Assume + # a main project A and a dependency B, which use different versions + # of Versioneer. A's setup.py imports A's Versioneer, leaving it in + # sys.modules by the time B's setup.py is executed, causing B to run + # with the wrong versioneer. Setuptools wraps the sub-dep builds in a + # sandbox that restores sys.modules to it's pre-build state, so the + # parent is protected against the child's "import versioneer". By + # removing ourselves from sys.modules here, before the child build + # happens, we protect the child from the parent's versioneer too. + # Also see https://github.com/warner/python-versioneer/issues/52 + + cmds = {} + + # we add "version" to both distutils and setuptools + from distutils.core import Command + + class cmd_version(Command): + description = "report generated version string" + user_options = [] + boolean_options = [] + + def initialize_options(self): + pass + + def finalize_options(self): + pass + + def run(self): + vers = get_versions(verbose=True) + print("Version: %s" % vers["version"]) + print(" full-revisionid: %s" % vers.get("full-revisionid")) + print(" dirty: %s" % vers.get("dirty")) + print(" date: %s" % vers.get("date")) + if vers["error"]: + print(" error: %s" % vers["error"]) + cmds["version"] = cmd_version + + # we override "build_py" in both distutils and setuptools + # + # most invocation pathways end up running build_py: + # distutils/build -> build_py + # distutils/install -> distutils/build ->.. + # setuptools/bdist_wheel -> distutils/install ->.. + # setuptools/bdist_egg -> distutils/install_lib -> build_py + # setuptools/install -> bdist_egg ->.. + # setuptools/develop -> ? + # pip install: + # copies source tree to a tempdir before running egg_info/etc + # if .git isn't copied too, 'git describe' will fail + # then does setup.py bdist_wheel, or sometimes setup.py install + # setup.py egg_info -> ? + + # we override different "build_py" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.build_py import build_py as _build_py + else: + from distutils.command.build_py import build_py as _build_py + + class cmd_build_py(_build_py): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + _build_py.run(self) + # now locate _version.py in the new build/ directory and replace + # it with an updated value + if cfg.versionfile_build: + target_versionfile = os.path.join(self.build_lib, + cfg.versionfile_build) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + cmds["build_py"] = cmd_build_py + + if "cx_Freeze" in sys.modules: # cx_freeze enabled? + from cx_Freeze.dist import build_exe as _build_exe + # nczeczulin reports that py2exe won't like the pep440-style string + # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. + # setup(console=[{ + # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION + # "product_version": versioneer.get_version(), + # ... + + class cmd_build_exe(_build_exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _build_exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["build_exe"] = cmd_build_exe + del cmds["build_py"] + + if 'py2exe' in sys.modules: # py2exe enabled? + try: + from py2exe.distutils_buildexe import py2exe as _py2exe # py3 + except ImportError: + from py2exe.build_exe import py2exe as _py2exe # py2 + + class cmd_py2exe(_py2exe): + def run(self): + root = get_root() + cfg = get_config_from_root(root) + versions = get_versions() + target_versionfile = cfg.versionfile_source + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, versions) + + _py2exe.run(self) + os.unlink(target_versionfile) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % + {"DOLLAR": "$", + "STYLE": cfg.style, + "TAG_PREFIX": cfg.tag_prefix, + "PARENTDIR_PREFIX": cfg.parentdir_prefix, + "VERSIONFILE_SOURCE": cfg.versionfile_source, + }) + cmds["py2exe"] = cmd_py2exe + + # we override different "sdist" commands for both environments + if "setuptools" in sys.modules: + from setuptools.command.sdist import sdist as _sdist + else: + from distutils.command.sdist import sdist as _sdist + + class cmd_sdist(_sdist): + def run(self): + versions = get_versions() + self._versioneer_generated_versions = versions + # unless we update this, the command will keep using the old + # version + self.distribution.metadata.version = versions["version"] + return _sdist.run(self) + + def make_release_tree(self, base_dir, files): + root = get_root() + cfg = get_config_from_root(root) + _sdist.make_release_tree(self, base_dir, files) + # now locate _version.py in the new base_dir directory + # (remembering that it may be a hardlink) and replace it with an + # updated value + target_versionfile = os.path.join(base_dir, cfg.versionfile_source) + print("UPDATING %s" % target_versionfile) + write_to_version_file(target_versionfile, + self._versioneer_generated_versions) + cmds["sdist"] = cmd_sdist + + return cmds + + +CONFIG_ERROR = """ +setup.cfg is missing the necessary Versioneer configuration. You need +a section like: + + [versioneer] + VCS = git + style = pep440 + versionfile_source = src/myproject/_version.py + versionfile_build = myproject/_version.py + tag_prefix = + parentdir_prefix = myproject- + +You will also need to edit your setup.py to use the results: + + import versioneer + setup(version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), ...) + +Please read the docstring in ./versioneer.py for configuration instructions, +edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. +""" + +SAMPLE_CONFIG = """ +# See the docstring in versioneer.py for instructions. Note that you must +# re-run 'versioneer.py setup' after changing this section, and commit the +# resulting files. + +[versioneer] +#VCS = git +#style = pep440 +#versionfile_source = +#versionfile_build = +#tag_prefix = +#parentdir_prefix = + +""" + +INIT_PY_SNIPPET = """ +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions +""" + + +def do_setup(): + """Main VCS-independent setup function for installing Versioneer.""" + root = get_root() + try: + cfg = get_config_from_root(root) + except (EnvironmentError, configparser.NoSectionError, + configparser.NoOptionError) as e: + if isinstance(e, (EnvironmentError, configparser.NoSectionError)): + print("Adding sample versioneer config to setup.cfg", + file=sys.stderr) + with open(os.path.join(root, "setup.cfg"), "a") as f: + f.write(SAMPLE_CONFIG) + print(CONFIG_ERROR, file=sys.stderr) + return 1 + + print(" creating %s" % cfg.versionfile_source) + with open(cfg.versionfile_source, "w") as f: + LONG = LONG_VERSION_PY[cfg.VCS] + f.write(LONG % {"DOLLAR": "$", + "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), + "__init__.py") + if os.path.exists(ipy): + try: + with open(ipy, "r") as f: + old = f.read() + except EnvironmentError: + old = "" + if INIT_PY_SNIPPET not in old: + print(" appending to %s" % ipy) + with open(ipy, "a") as f: + f.write(INIT_PY_SNIPPET) + else: + print(" %s unmodified" % ipy) + else: + print(" %s doesn't exist, ok" % ipy) + ipy = None + + # Make sure both the top-level "versioneer.py" and versionfile_source + # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so + # they'll be copied into source distributions. Pip won't be able to + # install the package without this. + manifest_in = os.path.join(root, "MANIFEST.in") + simple_includes = set() + try: + with open(manifest_in, "r") as f: + for line in f: + if line.startswith("include "): + for include in line.split()[1:]: + simple_includes.add(include) + except EnvironmentError: + pass + # That doesn't cover everything MANIFEST.in can do + # (http://docs.python.org/2/distutils/sourcedist.html#commands), so + # it might give some false negatives. Appending redundant 'include' + # lines is safe, though. + if "versioneer.py" not in simple_includes: + print(" appending 'versioneer.py' to MANIFEST.in") + with open(manifest_in, "a") as f: + f.write("include versioneer.py\n") + else: + print(" 'versioneer.py' already in MANIFEST.in") + if cfg.versionfile_source not in simple_includes: + print(" appending versionfile_source ('%s') to MANIFEST.in" % + cfg.versionfile_source) + with open(manifest_in, "a") as f: + f.write("include %s\n" % cfg.versionfile_source) + else: + print(" versionfile_source already in MANIFEST.in") + + # Make VCS-specific changes. For git, this means creating/changing + # .gitattributes to mark _version.py for export-subst keyword + # substitution. + do_vcs_install(manifest_in, cfg.versionfile_source, ipy) + return 0 + + +def scan_setup_py(): + """Validate the contents of setup.py against Versioneer's expectations.""" + found = set() + setters = False + errors = 0 + with open("setup.py", "r") as f: + for line in f.readlines(): + if "import versioneer" in line: + found.add("import") + if "versioneer.get_cmdclass()" in line: + found.add("cmdclass") + if "versioneer.get_version()" in line: + found.add("get_version") + if "versioneer.VCS" in line: + setters = True + if "versioneer.versionfile_source" in line: + setters = True + if len(found) != 3: + print("") + print("Your setup.py appears to be missing some important items") + print("(but I might be wrong). Please make sure it has something") + print("roughly like the following:") + print("") + print(" import versioneer") + print(" setup( version=versioneer.get_version(),") + print(" cmdclass=versioneer.get_cmdclass(), ...)") + print("") + errors += 1 + if setters: + print("You should remove lines like 'versioneer.VCS = ' and") + print("'versioneer.versionfile_source = ' . This configuration") + print("now lives in setup.cfg, and should be removed from setup.py") + print("") + errors += 1 + return errors + + +if __name__ == "__main__": + cmd = sys.argv[1] + if cmd == "setup": + errors = do_setup() + errors += scan_setup_py() + if errors: + sys.exit(1)