merge my 2 branches to fix the travis setup and selfinstall testing

Author: RonnyPfannschmidt

.travis.yml

@@ -17,6 +17,10 @@ matrix:
       env: TOXENV=flake8
     - python: '3.5'
       env: TOXENV=flake8
+    - python: '2.7'
+      env: SELFINSTALL=1
+    - python: '3.5'
+      env: SELFINSTALL=1
 cache:
   files:
   - $HOME/.pip/cache

CHANGELOG.rst

@@ -1,9 +1,21 @@
-v1.15.1
+v1.15.3
 =======
 
 * bring back correctly getting our version in the own sdist, finalizes #114
 
 
+v1.15.2
+=======
+
+* fix issue #128: return None when a scm specific parse fails in a worktree to ease parse reuse
+
+
+v1.15.1
+=======
+
+* fix issue #126: the local part of any tags is discarded
+  when guessing new versions
+
 v1.15.0
 =======
 
@@ -18,6 +30,7 @@ v1.15.0
 * address issue #93: provide an experimental api to customize behaviour on shallow git repos
   a custom parse function may pick pre parse actions to do when using git
 
+
 v1.14.1
 =======
 

README.rst

@@ -18,7 +18,6 @@ To use setuptools_scm just modify your project's setup.py file like this:
 1. Add :code:`'setuptools_scm'` to the :code:`setup_requires` parameter
 2. Add the :code:`use_scm_version` parameter and set it to ``True``
 
-
    E.g.:
 
    .. code:: python
@@ -31,18 +30,47 @@ To use setuptools_scm just modify your project's setup.py file like this:
            ...,
        )
 
+   Arguments to ``get_version()`` (see below) may be passed as a
+   dictionary to ``use_scm_version``. For example:
+
+   .. code:: python
+
+       from setuptools import setup
+       setup(
+           ...,
+           use_scm_version = {"root": "..", "relative_to": __file__},
+           setup_requires=['setuptools_scm'],
+           ...,
+       )
+
+
+3. Access the version number in your package via :code:`pkg_resources`
+
+   E.g. (`PEP-0396 <https://www.python.org/dev/peps/pep-0396>`_):
+
+   .. code:: python
+
+      from pkg_resources import get_distribution, DistributionNotFound
+      try:
+          __version__ = get_distribution(__name__).version
+      except DistributionNotFound:
+         # package is not installed
+         pass
+
 
 Programmatic usage
 ------------------
 
-In order to use setuptools_scm from code
-that one directory deeper than the project's root, you can use:
+In order to use ``setuptools_scm`` from code that one directory deeper
+than the project's root, you can use:
 
 .. code:: python
 
     from setuptools_scm import get_version
     version = get_version(root='..', relative_to=__file__)
 
+See `setup.py Usage`_ above for how to use this within setup.py.
+
 
 Usage from sphinx
 -----------------
@@ -53,8 +81,8 @@ instead use ``pkg_resources`` after editable/real installation:
 .. code:: python
 
     from pkg_resources import get_distribution
-    release = pkg_resources('myproject').version
-    # for the example take major/minor
+    release = get_distribution('myproject').version
+    # for example take major/minor
     version = '.'.join(release.split('.')[:2])
 
 The underlying reason is, that services like readthedocs sometimes change

setup.py

@@ -47,6 +47,7 @@ def scm_config():
         local_scheme=get_local_node_and_date,
     )
 
+
 with open('README.rst') as fp:
     long_description = fp.read()
 

setuptools_scm/git.py

@@ -77,7 +77,10 @@ def parse(root, describe_command=DEFAULT_DESCRIBE, pre_parse=warn_on_shallow):
     """
     if not has_command('git'):
         return
-    wd = GitWorkdir(root)
+
+    wd = GitWorkdir.from_potential_worktree(root)
+    if wd is None:
+        return
     if pre_parse:
         pre_parse(wd)
     rev_node = wd.node()

setuptools_scm/hg.py

@@ -26,6 +26,8 @@ def parse(root):
     if not has_command('hg'):
         return
     l = do('hg id -i -t', root).split()
+    if not l:
+        return
     node = l.pop(0)
     tags = tags_to_versions(l)
     # filter tip in degraded mode on old setuptools

setuptools_scm/version.py

@@ -88,14 +88,29 @@ def meta(tag, distance=None, dirty=False, node=None, **kw):
 
 
 def guess_next_version(tag_version, distance):
-    version = str(tag_version)
-    if '.dev' in version:
-        prefix, tail = version.rsplit('.dev', 1)
-        assert tail == '0', 'own dev numbers are unsupported'
-        return '%s.dev%s' % (prefix, distance)
-    else:
-        prefix, tail = re.match('(.*?)(\d+)$', version).groups()
-        return '%s%d.dev%s' % (prefix, int(tail) + 1, distance)
+    version = _strip_local(str(tag_version))
+    bumped = _bump_dev(version) or _bump_regex(version)
+    suffix = '.dev%s' % distance
+    return bumped + suffix
+
+
+def _strip_local(version_string):
+    public, sep, local = version_string.partition('+')
+    return public
+
+
+def _bump_dev(version):
+    if '.dev' not in version:
+        return
+
+    prefix, tail = version.rsplit('.dev', 1)
+    assert tail == '0', 'own dev numbers are unsupported'
+    return prefix
+
+
+def _bump_regex(version):
+    prefix, tail = re.match('(.*?)(\d+)$', version).groups()
+    return '%s%d' % (prefix, int(tail) + 1)
 
 
 def guess_next_dev_version(version):

testing/runtests_travis.py

@@ -3,12 +3,12 @@
 
 import os
 
-if os.environ['TOXENV']:
+if os.environ.get('TOXENV'):
     import tox
     tox.cmdline()
-elif os.environ['SELFINSTALL']:
+elif os.environ.get('SELFINSTALL'):
     call('python setup.py sdist', shell=True)
     call('easy_install dist/*', shell=True)
-    import pkg_ressources
-    dist = pkg_ressources.get_distribution('setuptools_scm')
-    assert dist.version != '0.0'
+    import pkg_resources
+    dist = pkg_resources.get_distribution('setuptools_scm')
+    assert set(dist.version) != set(".0"), dist.version

testing/test_functions.py

@@ -14,6 +14,7 @@ def __format__(self, *k):
     ('1.1', '1.2.dev0'),
     ('1.2.dev', '1.2.dev0'),
     ('1.1a2', '1.1a3.dev0'),
+    ('23.24.post2+deadbeef', '23.24.post3.dev0'),
     ])
 def test_next_tag(tag, expected):
     version = pkg_resources.parse_version(tag)

testing/test_git.py

@@ -92,6 +92,12 @@ def test_find_files_stop_at_root_git(wd):
     assert integration.find_files(str(wd.cwd/'project')) == []
 
 
+@pytest.mark.issue(128)
+def test_parse_no_worktree(tmpdir):
+    ret = git.parse(str(tmpdir))
+    assert ret is None
+
+
 def test_alphanumeric_tags_match(wd):
     wd.commit_testfile()
     wd('git tag newstyle-development-started')