fix 587 file finding no commit

.github/workflows/python-tests.yml

@@ -8,6 +8,7 @@ on:
     tags:
     - "v*"
   release:
+    types: [published]
 
 jobs:
   test:
@@ -40,6 +41,12 @@ jobs:
       - run: pip install -U setuptools
         if: matrix.python_version != 'msys2'
       - run: pip install -e .[toml] pytest
+      # pip2 is needed because Mercurial uses python2 on Ubuntu 20.04
+      - run: |
+          curl https://bootstrap.pypa.io/pip/2.7/get-pip.py --output get-pip.py
+          sudo python2 get-pip.py
+          $(hg debuginstall --template "{pythonexe}") -m pip install hg-git --user
+        if: matrix.os == 'ubuntu-latest'
       - run: pytest
 
   check_selfinstall:

.gitignore

@@ -44,6 +44,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *,cover
+.hypothesis/
 
 # Sphinx documentation
 docs/_build/

.pre-commit-config.yaml

@@ -1,26 +1,38 @@
 repos:
 -   repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 21.7b0
     hooks:
     - id: black
       args: [--safe, --quiet]
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.6.0
+    hooks:
+    -   id: reorder-python-imports
+        args: [ "--application-directories=.:src" , --py3-plus]
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.0.1
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-yaml
     -   id: debug-statements
--   repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.0
+-   repo: https://github.com/PyCQA/flake8
+    rev: 3.9.2
     hooks:
     -   id: flake8
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.11.0
+    rev: v2.24.0
     hooks:
     - id: pyupgrade
       args: [--py36-plus]
 -   repo: https://github.com/asottile/setup-cfg-fmt
     rev: v1.17.0
     hooks:
     -   id: setup-cfg-fmt
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v0.910'
+    hooks:
+    -   id: mypy
+        additional_dependencies:
+            - types-setuptools
+            - tokenize-rt==3.2.0

CHANGELOG.rst

@@ -1,3 +1,10 @@
+In progress
+===========
+
+* fix #587: don't fail file finders when distribution is not given
+* fix #524: new parameters ``normalize`` and ``version_cls`` to customize the version normalization class.
+* fix #585: switch from toml to tomli
+
 v6.0.1
 =======
 

README.rst

@@ -70,11 +70,15 @@ to be supplied to ``get_version()``. For example:
     # pyproject.toml
 
     [tool.setuptools_scm]
-    write_to = "pkg/version.py"
+    write_to = "pkg/_version.py"
 
 
-``setup.py`` usage
-------------------
+``setup.py`` usage (deprecated)
+-------------------------------
+
+.. warning::
+
+   ``setup_requires`` has been deprecated in favor of ``pyproject.toml``
 
 The following settings are considered legacy behavior and
 superseded by the ``pyproject.toml`` usage, but for maximal
@@ -129,8 +133,8 @@ You can confirm the version number locally via ``setup.py``:
    not defined in ``setup.cfg``.
 
 
-``setup.cfg`` usage
--------------------
+``setup.cfg`` usage (deprecated)
+------------------------------------
 
 as ``setup_requires`` is deprecated in favour of ``pyproject.toml``
 usage in ``setup.cfg`` is considered deprecated,
@@ -147,7 +151,7 @@ than the project's root, you can use:
     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``.
+See `setup.py Usage (deprecated)`_ above for how to use this within ``setup.py``.
 
 
 Retrieving package version at runtime
@@ -169,7 +173,7 @@ or the `importlib_metadata`_ backport:
         pass
 
 Alternatively, you can use ``pkg_resources`` which is included in
-``setuptools``:
+``setuptools`` (but has a significant runtime cost):
 
 .. code:: python
 
@@ -192,13 +196,14 @@ Usage from Sphinx
 -----------------
 
 It is discouraged to use ``setuptools_scm`` from Sphinx itself,
-instead use ``pkg_resources`` after editable/real installation:
+instead use ``importlib.metadata`` after editable/real installation:
 
 .. code:: python
 
+    # contents of docs/conf.py
     from importlib.metadata import version
-
-    release = version("package-name")
+    release = version('myproject')
+    # for example take major/minor
     version = '.'.join(release.split('.')[:2])
 
 The underlying reason is, that services like *Read the Docs* sometimes change
@@ -311,7 +316,7 @@ The currently supported configuration keys are:
 
 :write_to:
     A path to a file that gets replaced with a file containing the current
-    version. It is ideal for creating a ``version.py`` file within the
+    version. It is ideal for creating a ``_version.py`` file within the
     package, typically used to avoid using `pkg_resources.get_distribution`
     (which adds some overhead).
 
@@ -371,6 +376,30 @@ The currently supported configuration keys are:
     Defaults to the value set by ``setuptools_scm.git.DEFAULT_DESCRIBE``
     (see `git.py <src/setuptools_scm/git.py>`_).
 
+:normalize:
+    A boolean flag indicating if the version string should be normalized.
+    Defaults to ``True``. Setting this to ``False`` is equivalent to setting
+    ``version_cls`` to ``setuptools_scm.version.NonNormalizedVersion``
+
+:version_cls:
+    An optional class used to parse, verify and possibly normalize the version
+    string. Its constructor should receive a single string argument, and its
+    ``str`` should return the normalized version string to use.
+    This option can also receive a class qualified name as a string.
+
+    This defaults to ``packaging.version.Version`` if available. If
+    ``packaging`` is not installed, ``pkg_resources.packaging.version.Version``
+    is used. Note that it is known to modify git release candidate schemes.
+
+    The ``setuptools_scm.NonNormalizedVersion`` convenience class is
+    provided to disable the normalization step done by
+    ``packaging.version.Version``. If this is used while ``setuptools_scm``
+    is integrated in a setuptools packaging process, the non-normalized
+    version number will appear in all files (see ``write_to``) BUT note
+    that setuptools will still normalize it to create the final distribution,
+    so as to stay compliant with the python packaging standards.
+
+
 To use ``setuptools_scm`` in other Python code you can use the ``get_version``
 function:
 
@@ -390,7 +419,7 @@ Example configuration in ``setup.py`` format:
 
     setup(
         use_scm_version={
-            'write_to': 'version.py',
+            'write_to': '_version.py',
             'write_to_template': '__version__ = "{version}"',
             'tag_regex': r'^(?P<prefix>v)?(?P<version>[^\+]+)(?P<suffix>.*)?$',
         }

mypy.ini

@@ -0,0 +1,9 @@
+[mypy]
+python_version = 3.6
+warn_return_any = True
+warn_unused_configs = True
+mypy_path = $MYPY_CONFIG_FILE_DIR/src
+
+[mypy-setuptools_scm.*]
+# disabled as it will take a bit
+# disallow_untyped_defs = True

setup.cfg

@@ -69,4 +69,4 @@ setuptools_scm.version_scheme =
 
 [options.extras_require]
 toml =
-    toml
+    tomli~=1.0.0

setup.py

@@ -11,21 +11,31 @@
 """
 import os
 import sys
+
 import setuptools
 
 
 def scm_config():
+
+    if sys.version_info < (3, 6):
+        raise RuntimeError(
+            "support for python < 3.6 has been removed in setuptools_scm>=6.0.0"
+        )
+
     here = os.path.dirname(os.path.abspath(__file__))
     src = os.path.join(here, "src")
     egg_info = os.path.join(src, "setuptools_scm.egg-info")
     has_entrypoints = os.path.isdir(egg_info)
     import pkg_resources
 
+    pkg_resources.require("setuptools>=45")
+
     sys.path.insert(0, src)
     pkg_resources.working_set.add_entry(src)
     # FIXME: remove debug
     print(src)
     print(pkg_resources.working_set)
+
     from setuptools_scm.hacks import parse_pkginfo
     from setuptools_scm.git import parse as parse_git
     from setuptools_scm.version import guess_next_dev_version, get_local_node_and_date

src/setuptools_scm/__init__.py

@@ -5,11 +5,17 @@
 import os
 import warnings
 
+try:
+    from packaging.version import parse
+except ImportError:
+    from pkg_resources import parse_version as parse
+
 from .config import (
     Configuration,
     DEFAULT_VERSION_SCHEME,
     DEFAULT_LOCAL_SCHEME,
     DEFAULT_TAG_REGEX,
+    NonNormalizedVersion,
 )
 from .utils import function_has_arg, trace
 from .version import format_version, meta
@@ -61,7 +67,8 @@ def _version_from_entrypoints(config, fallback=False):
     else:
         entrypoint = "setuptools_scm.parse_scm"
         root = config.absolute_root
-    for ep in iter_matching_entrypoints(root, entrypoint):
+
+    for ep in iter_matching_entrypoints(root, entrypoint, config):
         version = _call_entrypoint_fn(root, config, ep.load())
 
         if version:
@@ -83,15 +90,12 @@ def dump_version(root, version, write_to, template=None):
             )
         )
 
-    # version_tuple: each field is converted to an int if possible or kept as string
-    fields = tuple(version.split("."))
-    version_fields = []
-    for field in fields:
-        try:
-            v = int(field)
-        except ValueError:
-            v = field
-        version_fields.append(v)
+    parsed_version = parse(version)
+    version_fields = parsed_version.release
+    if parsed_version.dev is not None:
+        version_fields += (f"dev{parsed_version.dev}",)
+    if parsed_version.local is not None:
+        version_fields += (parsed_version.local,)
 
     with open(target, "w") as fp:
         fp.write(template.format(version=version, version_tuple=tuple(version_fields)))
@@ -157,6 +161,9 @@ def get_version(
     parse=None,
     git_describe_command=None,
     dist_name=None,
+    version_cls=None,
+    normalize=True,
+    search_parent_directories=False,
 ):
     """
     If supplied, relative_to should be a file from which root may
@@ -186,3 +193,22 @@ def _get_version(config):
         )
 
         return version_string
+
+
+# Public API
+__all__ = [
+    "get_version",
+    "dump_version",
+    "version_from_scm",
+    "Configuration",
+    "NonNormalizedVersion",
+    "DEFAULT_VERSION_SCHEME",
+    "DEFAULT_LOCAL_SCHEME",
+    "DEFAULT_TAG_REGEX",
+    # TODO: are the symbols below part of public API ?
+    "function_has_arg",
+    "trace",
+    "format_version",
+    "meta",
+    "iter_matching_entrypoints",
+]

src/setuptools_scm/__main__.py

@@ -1,9 +1,10 @@
 import sys
+
 from setuptools_scm import get_version
 from setuptools_scm.integration import find_files
 
 
-def main():
+def main() -> None:
     print("Guessed Version", get_version())
     if "ls" in sys.argv:
         for fname in find_files("."):