[Python-modules-commits] [epsilon] 03/15: Import epsilon_0.7.1.orig.tar.gz

Tristan Seligmann mithrandi at moszumanska.debian.org
Sat Oct 10 15:45:38 UTC 2015


This is an automated email from the git hooks/post-receive script.

mithrandi pushed a commit to branch master
in repository epsilon.

commit 910d0b771c11ee8f7cdf229eaf5d4c478cf19976
Author: Tristan Seligmann <mithrandi at debian.org>
Date:   Sat Oct 10 16:22:49 2015 +0200

    Import epsilon_0.7.1.orig.tar.gz
---
 Epsilon.egg-info/PKG-INFO       |    8 +-
 Epsilon.egg-info/SOURCES.txt    |    3 +
 Epsilon.egg-info/requires.txt   |    2 +-
 MANIFEST.in                     |    2 +
 PKG-INFO                        |    8 +-
 bin/certcreate                  |    5 +
 epsilon/__init__.py             |   10 +-
 epsilon/_version.py             |   22 +-
 epsilon/extime.py               |   14 +-
 epsilon/scripts/benchmark.py    |    2 +-
 epsilon/test/test_benchmark.py  |   21 +
 epsilon/test/test_caseless.py   |    4 +-
 epsilon/test/test_extime.py     |    8 +
 epsilon/test/test_structlike.py |   18 +-
 setup.cfg                       |    8 +
 setup.py                        |   15 +-
 versioneer.py                   | 1699 +++++++++++++++++++++++++++++++++++++++
 17 files changed, 1816 insertions(+), 33 deletions(-)

diff --git a/Epsilon.egg-info/PKG-INFO b/Epsilon.egg-info/PKG-INFO
index 0803c6a..1aa89d4 100644
--- a/Epsilon.egg-info/PKG-INFO
+++ b/Epsilon.egg-info/PKG-INFO
@@ -1,10 +1,10 @@
 Metadata-Version: 1.1
 Name: Epsilon
-Version: 0.7.0
+Version: 0.7.1
 Summary: A set of utility modules used by Divmod projects
-Home-page: https://launchpad.net/divmod.org
-Author: divmod-dev
-Author-email: divmod-dev at lists.launchpad.net
+Home-page: https://github.com/twisted/epsilon
+Author: UNKNOWN
+Author-email: UNKNOWN
 License: MIT
 Description: UNKNOWN
 Platform: any
diff --git a/Epsilon.egg-info/SOURCES.txt b/Epsilon.egg-info/SOURCES.txt
index 6e06e05..e667900 100644
--- a/Epsilon.egg-info/SOURCES.txt
+++ b/Epsilon.egg-info/SOURCES.txt
@@ -3,13 +3,16 @@ MANIFEST.in
 NAME.txt
 NEWS.txt
 README
+setup.cfg
 setup.py
+versioneer.py
 Epsilon.egg-info/PKG-INFO
 Epsilon.egg-info/SOURCES.txt
 Epsilon.egg-info/dependency_links.txt
 Epsilon.egg-info/requires.txt
 Epsilon.egg-info/top_level.txt
 bin/benchmark
+bin/certcreate
 epsilon/__init__.py
 epsilon/_version.py
 epsilon/ampauth.py
diff --git a/Epsilon.egg-info/requires.txt b/Epsilon.egg-info/requires.txt
index 3d00638..2878fdb 100644
--- a/Epsilon.egg-info/requires.txt
+++ b/Epsilon.egg-info/requires.txt
@@ -1,2 +1,2 @@
 Twisted>=13.2.0
-PyOpenSSL>=0.13
\ No newline at end of file
+PyOpenSSL>=0.13
diff --git a/MANIFEST.in b/MANIFEST.in
index af4d484..1ce0d38 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,5 @@
 include LICENSE
 include NAME.txt
 include NEWS.txt
+include versioneer.py
+include epsilon/_version.py
diff --git a/PKG-INFO b/PKG-INFO
index 0803c6a..1aa89d4 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,10 +1,10 @@
 Metadata-Version: 1.1
 Name: Epsilon
-Version: 0.7.0
+Version: 0.7.1
 Summary: A set of utility modules used by Divmod projects
-Home-page: https://launchpad.net/divmod.org
-Author: divmod-dev
-Author-email: divmod-dev at lists.launchpad.net
+Home-page: https://github.com/twisted/epsilon
+Author: UNKNOWN
+Author-email: UNKNOWN
 License: MIT
 Description: UNKNOWN
 Platform: any
diff --git a/bin/certcreate b/bin/certcreate
new file mode 100755
index 0000000..b24f26f
--- /dev/null
+++ b/bin/certcreate
@@ -0,0 +1,5 @@
+#!/usr/bin/python
+# Copyright 2005 Divmod, Inc.  See LICENSE file for details
+
+from epsilon.scripts import certcreate
+certcreate.main()
diff --git a/epsilon/__init__.py b/epsilon/__init__.py
index 70b649d..797f5d6 100644
--- a/epsilon/__init__.py
+++ b/epsilon/__init__.py
@@ -1,8 +1,14 @@
 # -*- test-case-name: epsilon.test -*-
-from epsilon._version import __version__
+from epsilon._version import get_versions
+__version__ = get_versions()['version']
+del get_versions
+
 from twisted.python import versions
 
 def asTwistedVersion(packageName, versionString):
-    return versions.Version(packageName, *map(int, versionString.split(".")))
+    return versions.Version(
+        packageName, *map(int, versionString.split('+', 1)[0].split(".")))
 
 version = asTwistedVersion("epsilon", __version__)
+
+__all__ = ['__version__', 'version']
diff --git a/epsilon/_version.py b/epsilon/_version.py
index 49e0fc1..d84baf9 100644
--- a/epsilon/_version.py
+++ b/epsilon/_version.py
@@ -1 +1,21 @@
-__version__ = "0.7.0"
+
+# This file was generated by 'versioneer.py' (0.15) 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
+import sys
+
+version_json = '''
+{
+ "dirty": false,
+ "error": null,
+ "full-revisionid": "a36710813df371d41a839d97f15e9580a8807034",
+ "version": "0.7.1"
+}
+'''  # END VERSION_JSON
+
+
+def get_versions():
+    return json.loads(version_json)
diff --git a/epsilon/extime.py b/epsilon/extime.py
index cd1b429..b1b6cf4 100644
--- a/epsilon/extime.py
+++ b/epsilon/extime.py
@@ -8,7 +8,7 @@ See the class 'Time' for details.
 import datetime
 import re
 
-from email.Utils import parsedate_tz
+from email.Utils import formatdate, parsedate_tz
 
 _EPOCH = datetime.datetime.utcfromtimestamp(0)
 
@@ -727,6 +727,18 @@ class Time(object):
 
         return rfcstring
 
+
+    def asRFC1123(self):
+        """
+        Return the time formatted as specified in RFC 1123.
+
+        Useful when setting the max-age value of an HTTP cookie, which
+        requires the timezone be represented as the string 'GMT',
+        rather than an offset, e.g., '-0000'
+        """
+        return formatdate(self.asPOSIXTimestamp(), False, True)
+
+
     def asISO8601TimeAndDate(self, includeDelimiters=True, tzinfo=None,
                              includeTimezone=True):
         """Return this time formatted as specified by ISO 8861.
diff --git a/epsilon/scripts/benchmark.py b/epsilon/scripts/benchmark.py
index 708a369..ae5f4aa 100644
--- a/epsilon/scripts/benchmark.py
+++ b/epsilon/scripts/benchmark.py
@@ -423,7 +423,7 @@ def discoverCurrentWorkingDevice():
     """
     possibilities = []
     cwd = os.getcwd()
-    for L in file('/etc/mtab'):
+    for L in file('/proc/self/mounts'):
         parts = L.split()
         if cwd.startswith(parts[1]):
             possibilities.append((len(parts[1]), parts[0]))
diff --git a/epsilon/test/test_benchmark.py b/epsilon/test/test_benchmark.py
index f51bc42..c938822 100644
--- a/epsilon/test/test_benchmark.py
+++ b/epsilon/test/test_benchmark.py
@@ -14,7 +14,21 @@ from epsilon.scripts import benchmark
 from epsilon import juice
 
 
+try:
+    filepath.FilePath('/proc/diskstats').open().close()
+    filepath.FilePath('/proc/self/mounts').open().close()
+except IOError:
+    hasProc = False
+else:
+    hasProc = True
+
+
+
 class DiskstatTestCase(unittest.TestCase):
+    if not hasProc:
+        skip = 'epsilon.benchmark requires access to /proc'
+
+
     def testDiskLineParser(self):
         """
         Test the parsing of a single line into a single diststat instance.
@@ -393,6 +407,10 @@ class BasicProcessTestCase(SpawnMixin, unittest.TestCase):
 
 
 class SnapshotTestCase(unittest.TestCase):
+    if not hasProc:
+        skip = 'epsilon.benchmark requires access to /proc'
+
+
     def testStart(self):
         c = benchmark.Change()
         c.start(filepath.FilePath('.'), 'hda', 'hda1')
@@ -407,6 +425,9 @@ class SnapshotTestCase(unittest.TestCase):
 
 
 class BenchmarkProcessTestCase(SpawnMixin, unittest.TestCase):
+    if not hasProc:
+        skip = 'epsilon.benchmark requires access to /proc'
+
 
     processProtocol = benchmark.BenchmarkProcess
 
diff --git a/epsilon/test/test_caseless.py b/epsilon/test/test_caseless.py
index 7e954b1..f39c8da 100644
--- a/epsilon/test/test_caseless.py
+++ b/epsilon/test/test_caseless.py
@@ -258,7 +258,7 @@ class CaselessTestCase(TestCase):
         def assertNotFound(a, b, rest=()):
             self.assertEquals(a.find(b, *rest), -1)
             err = self.assertRaises(ValueError, lambda: a.index(b, *rest))
-            self.assertEquals(str(err), 'substring not found')
+            self.assertSubstring('substring not found', str(err))
 
         for a in map(Caseless, self._casings(u'abcbabcba')):
             assertNotFound(a, u'foo')
@@ -278,7 +278,7 @@ class CaselessTestCase(TestCase):
         def assertNotFound(a, b, rest=()):
             self.assertEquals(a.rfind(b, *rest), -1)
             err = self.assertRaises(ValueError, lambda: a.rindex(b, *rest))
-            self.assertEquals(str(err), 'substring not found')
+            self.assertSubstring('substring not found', str(err))
 
         for a in map(Caseless, self._casings(u'abcbabcba')):
             assertNotFound(a, u'foo')
diff --git a/epsilon/test/test_extime.py b/epsilon/test/test_extime.py
index d8dca18..9f6a850 100644
--- a/epsilon/test/test_extime.py
+++ b/epsilon/test/test_extime.py
@@ -303,6 +303,14 @@ class TestTime(unittest.TestCase):
     def test_asPOSIXTimestamp(self):
         self.assertEquals( self._createReference().asPOSIXTimestamp(), 1102342516 )
 
+
+    def test_asRFC1123(self):
+        self.assertEquals(
+            self._createReference().asRFC1123(),
+            'Mon, 06 Dec 2004 14:15:16 GMT'
+        )
+
+
     def test_asRFC2822(self):
         self.assertEquals( self._createReference().asRFC2822(), 'Mon, 6 Dec 2004 14:15:16 -0000' )
         self.assertEquals( self._createReference().asRFC2822(self.MST()), 'Mon, 6 Dec 2004 07:15:16 -0700' )
diff --git a/epsilon/test/test_structlike.py b/epsilon/test/test_structlike.py
index b9d7ebf..16fdd16 100644
--- a/epsilon/test/test_structlike.py
+++ b/epsilon/test/test_structlike.py
@@ -5,10 +5,12 @@ Tests for L{epsilon.structlike}.
 
 import threading
 
-from twisted.trial import unittest
-from twisted.internet.threads import deferToThread
-from twisted.internet.defer import gatherResults
 from epsilon.structlike import record
+from twisted.internet import reactor
+from twisted.internet.defer import gatherResults
+from twisted.internet.threads import deferToThreadPool
+from twisted.python.threadpool import ThreadPool
+from twisted.trial import unittest
 
 
 class MyRecord(record('something somethingElse')):
@@ -144,6 +146,10 @@ class StructLike(unittest.TestCase):
         look the same (i.e. the repr state tracking for '...' should be
         thread-local).
         """
+        pool = ThreadPool(2, 2)
+        pool.start()
+        self.addCleanup(pool.stop)
+
         class StickyRepr(object):
             """
             This has a __repr__ which will block until a separate thread
@@ -161,7 +167,7 @@ class StructLike(unittest.TestCase):
                 return 'sticky'
         r = StickyRepr()
         mr = MyRecord(something=1, somethingElse=r)
-        d = deferToThread(repr, mr)
+        d = deferToThreadPool(reactor, pool, repr, mr)
         def otherRepr():
             # First we wait for the first thread doing a repr() to enter its
             # __repr__()...
@@ -174,7 +180,7 @@ class StructLike(unittest.TestCase):
             # Now we're done, wake up the other repr and let it complete.
             r.wait.set()
             return result
-        d2 = deferToThread(otherRepr)
+        d2 = deferToThreadPool(reactor, pool, otherRepr)
 
         def done((thread1repr, thread2repr)):
             knownGood = 'MyRecord(something=1, somethingElse=sticky)'
@@ -182,5 +188,3 @@ class StructLike(unittest.TestCase):
             self.assertEquals(thread1repr, knownGood)
             self.assertEquals(thread2repr, knownGood)
         return gatherResults([d, d2]).addCallback(done)
-
-
diff --git a/setup.cfg b/setup.cfg
index 861a9f5..78028ba 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,3 +1,11 @@
+[versioneer]
+vcs = git
+style = pep440
+versionfile_source = epsilon/_version.py
+versionfile_build = epsilon/_version.py
+tag_prefix = 
+parentdir_prefix = epsilon-
+
 [egg_info]
 tag_build = 
 tag_date = 0
diff --git a/setup.py b/setup.py
index 6822156..068fe67 100644
--- a/setup.py
+++ b/setup.py
@@ -1,25 +1,20 @@
+import versioneer
 from setuptools import setup, find_packages
-import re
-
-versionPattern = re.compile(r"""^__version__ = ['"](.*?)['"]$""", re.M)
-with open("epsilon/_version.py", "rt") as f:
-    version = versionPattern.search(f.read()).group(1)
 
 setup(
+    version=versioneer.get_version(),
+    cmdclass=versioneer.get_cmdclass(),
     name="Epsilon",
-    version=version,
     description="A set of utility modules used by Divmod projects",
 
-    maintainer="divmod-dev",
-    maintainer_email="divmod-dev at lists.launchpad.net",
-    url="https://launchpad.net/divmod.org",
+    url="https://github.com/twisted/epsilon",
 
     install_requires=[
         "Twisted>=13.2.0",
         "PyOpenSSL>=0.13"
     ],
     packages=find_packages(),
-    scripts=['bin/benchmark'],
+    scripts=['bin/benchmark', 'bin/certcreate'],
 
     license="MIT",
     platforms=["any"],
diff --git a/versioneer.py b/versioneer.py
new file mode 100644
index 0000000..c010f63
--- /dev/null
+++ b/versioneer.py
@@ -0,0 +1,1699 @@
+
+# Version: 0.15
+
+"""
+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, 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
+
+First, decide on values for the following configuration variables:
+
+* `VCS`: the version control system you use. Currently accepts "git".
+
+* `style`: the style of version string to be produced. See "Styles" below for
+  details. Defaults to "pep440", which looks like
+  `TAG[+DISTANCE.gSHORTHASH[.dirty]]`.
+
+* `versionfile_source`:
+
+  A project-relative pathname into which the generated version strings should
+  be written. This is usually a `_version.py` next to your project's main
+  `__init__.py` file, so it can be imported at runtime. If your project uses
+  `src/myproject/__init__.py`, this should be `src/myproject/_version.py`.
+  This file should be checked in to your VCS as usual: the copy created below
+  by `setup.py setup_versioneer` will include code that parses expanded VCS
+  keywords in generated tarballs. The 'build' and 'sdist' commands will
+  replace it with a copy that has just the calculated version string.
+
+  This must be set even if your project does not have any modules (and will
+  therefore never import `_version.py`), since "setup.py sdist" -based trees
+  still need somewhere to record the pre-calculated version strings. Anywhere
+  in the source tree should do. If there is a `__init__.py` next to your
+  `_version.py`, the `setup.py setup_versioneer` command (described below)
+  will append some `__version__`-setting assignments, if they aren't already
+  present.
+
+* `versionfile_build`:
+
+  Like `versionfile_source`, but relative to the build directory instead of
+  the source directory. These will differ when your setup.py uses
+  'package_dir='. If you have `package_dir={'myproject': 'src/myproject'}`,
+  then you will probably have `versionfile_build='myproject/_version.py'` and
+  `versionfile_source='src/myproject/_version.py'`.
+
+  If this is set to None, then `setup.py build` will not attempt to rewrite
+  any `_version.py` in the built tree. If your project does not have any
+  libraries (e.g. if it only builds a script), then you should use
+  `versionfile_build = None` and override `distutils.command.build_scripts`
+  to explicitly insert a copy of `versioneer.get_version()` into your
+  generated script.
+
+* `tag_prefix`:
+
+  a string, like 'PROJECTNAME-', which appears at the start of all VCS tags.
+  If your tags look like 'myproject-1.2.0', then you should use
+  tag_prefix='myproject-'. If you use unprefixed tags like '1.2.0', this
+  should be an empty string.
+
+* `parentdir_prefix`:
+
+  a optional string, frequently the same as tag_prefix, which appears at the
+  start of all unpacked tarball filenames. If your tarball unpacks into
+  'myproject-1.2.0', this should be 'myproject-'. To disable this feature,
+  just omit the field from your `setup.cfg`.
+
+This tool provides one script, named `versioneer`. That script has one mode,
+"install", which writes a copy of `versioneer.py` into the current directory
+and runs `versioneer.py setup` to finish the installation.
+
+To versioneer-enable your project:
+
+* 1: Modify your `setup.cfg`, adding a section named `[versioneer]` and
+  populating it with the configuration values you decided earlier (note that
+  the option names are not case-sensitive):
+
+  ````
+  [versioneer]
+  VCS = git
+  style = pep440
+  versionfile_source = src/myproject/_version.py
+  versionfile_build = myproject/_version.py
+  tag_prefix = ""
+  parentdir_prefix = myproject-
+  ````
+
+* 2: Run `versioneer install`. This will do the following:
+
+  * copy `versioneer.py` into the top of your source tree
+  * create `_version.py` in the right place (`versionfile_source`)
+  * modify your `__init__.py` (if one exists next to `_version.py`) to define
+    `__version__` (by calling a function from `_version.py`)
+  * modify your `MANIFEST.in` to include both `versioneer.py` and the
+    generated `_version.py` in sdist tarballs
+
+  `versioneer install` will complain about any problems it finds with your
+  `setup.py` or `setup.cfg`. Run it multiple times until you have fixed all
+  the problems.
+
+* 3: add a `import versioneer` to your setup.py, and add the following
+  arguments to the setup() call:
+
+        version=versioneer.get_version(),
+        cmdclass=versioneer.get_cmdclass(),
+
+* 4: commit these changes to your VCS. To make sure you won't forget,
+  `versioneer install` will mark everything it touched for addition using
+  `git add`. Don't forget to add `setup.py` and `setup.cfg` too.
+
+## Post-Installation Usage
+
+Once established, all uses of your tree from a VCS checkout should get the
+current version string. All generated tarballs should include an embedded
+version string (so users who unpack them will not need a VCS tool installed).
+
+If you distribute your project through PyPI, then the release process should
+boil down to two steps:
+
+* 1: git tag 1.0
+* 2: python setup.py register sdist upload
+
+If you distribute it through github (i.e. users use github to generate
+tarballs with `git archive`), the process is:
+
+* 1: git tag 1.0
+* 2: git push; git push --tags
+
+Versioneer will report "0+untagged.NUMCOMMITS.gHASH" until your tree has at
+least one tag in its history.
+
+## 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".
+
+* `['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 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).
+
+## 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
+* re-run `versioneer install` in your source tree, to replace
+  `SRC/_version.py`
+* commit any changed files
+
+### Upgrading to 0.15
+
+Starting with this version, Versioneer is configured with a `[versioneer]`
+section in your `setup.cfg` file. Earlier versions required the `setup.py` to
+set attributes on the `versioneer` module immediately after import. The new
+version will refuse to run (raising an exception during import) until you
+have provided the necessary `setup.cfg` section.
+
+In addition, the Versioneer package provides an executable named
+`versioneer`, and the installation process is driven by running `versioneer
+install`. In 0.14 and earlier, the executable was named
+`versioneer-installer` and was run without an argument.
+
+### Upgrading to 0.14
+
+0.14 changes the format of the version string. 0.13 and earlier used
+hyphen-separated strings like "0.11-2-g1076c97-dirty". 0.14 and beyond use a
+plus-separated "local version" section strings, with dot-separated
+components, like "0.11+2.g1076c97". PEP440-strict tools did not like the old
+format, but should be ok with the new one.
+
+### Upgrading from 0.11 to 0.12
+
+Nothing special.
+
+### Upgrading from 0.10 to 0.11
+
+You must add a `versioneer.VCS = "git"` to your `setup.py` before re-running
+`setup.py setup_versioneer`. This will enable the use of additional
+version-control systems (SVN, etc) in the future.
+
+## 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 hereby released into the
+public domain. The `_version.py` that it creates is also in the public
+domain.
+
+"""
+
+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:
+    pass
+
+
+def get_root():
+    # 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__))
+        if os.path.splitext(me)[0] != os.path.splitext(versioneer_py)[0]:
+            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):
+    # 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")
+    cfg.parentdir_prefix = get(parser, "parentdir_prefix")
+    cfg.verbose = get(parser, "verbose")
+    return cfg
+
+
+class NotThisMethod(Exception):
+    pass
+
+# these dictionaries contain VCS-specific tools
+LONG_VERSION_PY = {}
+HANDLERS = {}
+
+
+def register_vcs_handler(vcs, method):  # decorator
+    def decorate(f):
+        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):
+    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, 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
+    else:
+        if verbose:
+            print("unable to find command, tried %s" % (commands,))
+        return 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)
+        return None
+    return stdout
+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.15 (https://github.com/warner/python-versioneer)
+
+import errno
+import os
+import re
+import subprocess
+import sys
+
+
+def get_keywords():
+    # 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"
+    keywords = {"refnames": git_refnames, "full": git_full}
+    return keywords
+
+
+class VersioneerConfig:
+    pass
+
+
+def get_config():
+    # 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):
+    pass
+
+
+LONG_VERSION_PY = {}
+HANDLERS = {}
+
+
+def register_vcs_handler(vcs, method):  # decorator
+    def decorate(f):
+        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):
+    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, 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
+    else:
+        if verbose:
+            print("unable to find command, tried %%s" %% (commands,))
+        return 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)
+        return None
+    return stdout
+
+
+def versions_from_parentdir(parentdir_prefix, root, verbose):
+    # Source tarballs conventionally unpack into a directory that includes
+    # both the project name and a version string.
+    dirname = os.path.basename(root)
+    if not dirname.startswith(parentdir_prefix):
+        if verbose:
+            print("guessing rootdir is '%%s', but '%%s' doesn't start with "
+                  "prefix '%%s'" %% (root, dirname, parentdir_prefix))
+        raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
+    return {"version": dirname[len(parentdir_prefix):],
+            "full-revisionid": None,
+            "dirty": False, "error": None}
+
+
+ at register_vcs_handler("git", "get_keywords")
+def git_get_keywords(versionfile_abs):
+    # 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)
... 1106 lines suppressed ...

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/epsilon.git



More information about the Python-modules-commits mailing list