♻️ Remove incremental

.github/workflows/ci.yml

@@ -254,7 +254,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools wheel
+        python -m pip install --upgrade pip wheel
         python -m pip install pep517
 
     - name: Display structure of files to be pushed

docs/conf.py

@@ -55,19 +55,17 @@
 project = "Towncrier"
 copyright = "{}, Towncrier contributors. Ver {}".format(
     _today.year,
-    towncrier_version.public(),
+    towncrier_version,
 )
 author = "Amber Brown"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 # The short X.Y version.
-version = "{}.{}.{}".format(
-    towncrier_version.major, towncrier_version.minor, towncrier_version.micro
-)
+version = ".".join(towncrier_version.split(".")[:3])
 # The full version, including alpha/beta/rc tags.
-release = towncrier_version.public()
+release = towncrier_version
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "hatchling",
-    "incremental == 22.10.0",
+    "wheel",
 ]
 build-backend = "hatchling.build"
 
@@ -32,8 +32,7 @@ dependencies = [
     "click",
     "importlib-resources>=5; python_version<'3.10'",
     "importlib-metadata>=4.6; python_version<'3.10'",
-    "incremental",
-    "jinja2>=3",
+    "jinja2",
     "tomli; python_version<'3.11'",
 ]
 
@@ -153,12 +152,6 @@ module = 'towncrier.click_default_group'
 # Vendored module without type annotations.
 ignore_errors = true
 
-[[tool.mypy.overrides]]
-module = 'incremental'
-# No released version with type hints.
-ignore_missing_imports = true
-
-
 [tool.coverage.run]
 parallel = true
 branch = true

src/towncrier/__init__.py

@@ -7,13 +7,11 @@
 
 from __future__ import annotations
 
-from incremental import Version
-
 
 __all__ = ["__version__"]
 
 
-def __getattr__(name: str) -> Version:
+def __getattr__(name: str) -> str:
     if name != "__version__":
         raise AttributeError(f"module {__name__} has no attribute {name}")
 

src/towncrier/_project.py

@@ -7,14 +7,12 @@
 
 from __future__ import annotations
 
+import contextlib
 import sys
 
 from importlib import import_module
 from importlib.metadata import version as metadata_version
 from types import ModuleType
-from typing import Any
-
-from incremental import Version as IncrementalVersion
 
 
 if sys.version_info >= (3, 10):
@@ -63,17 +61,15 @@ def get_version(package_dir: str, package: str) -> str:
     Try to extract the version from the distribution version metadata that matches
     `package`, then fall back to looking for the package in `package_dir`.
     """
-    version: Any
+    version: str
 
     # First try to get the version from the package metadata.
     if version := _get_metadata_version(package):
         return version
 
     # When no version if found, fall back to looking for the package in `package_dir`.
     module = _get_package(package_dir, package)
-
     version = getattr(module, "__version__", None)
-
     if not version:
         raise Exception(
             f"No __version__ or metadata version info for the '{package}' package."
@@ -82,37 +78,30 @@ def get_version(package_dir: str, package: str) -> str:
     if isinstance(version, str):
         return version.strip()
 
-    if isinstance(version, IncrementalVersion):
-        # FIXME:https://github.com/twisted/incremental/issues/81
-        # Incremental uses `.rcN`.
-        # importlib uses `rcN` (without a dot separation).
-        # Here we make incremental work like importlib.
-        return version.base().strip().replace(".rc", "rc")
-
     if isinstance(version, tuple):
         return ".".join(map(str, version)).strip()
 
+    # Try duck-typing as an Incremental version.
+    if hasattr(version, "base"):
+        try:
+            version = str(version.base()).strip()
+            # Incremental uses `X.Y.rcN`.
+            # Standardize on importlib (and PEP440) use of `X.YrcN`:
+            return version.replace(".rc", "rc")  # type: ignore
+        except TypeError:
+            pass
+
     raise Exception(
-        "I only know how to look at a __version__ that is a str, "
-        "an Increment Version, or a tuple. If you can't provide "
-        "that, use the --version argument and specify one."
+        "Version must be a string, tuple, or an Incremental Version."
+        " If you can't provide that, use the --version argument and specify one."
     )
 
 
 def get_project_name(package_dir: str, package: str) -> str:
     module = _get_package(package_dir, package)
-
     version = getattr(module, "__version__", None)
+    # Incremental has support for package names, try duck-typing it.
+    with contextlib.suppress(AttributeError):
+        return str(version.package)  # type: ignore
 
-    if not version:
-        # welp idk
-        return package.title()
-
-    if isinstance(version, str):
-        return package.title()
-
-    if isinstance(version, IncrementalVersion):
-        # Incremental has support for package names
-        return version.package
-
-    raise TypeError(f"Unsupported type for __version__: {type(version)}")
+    return package.title()

src/towncrier/_shell.py

@@ -19,7 +19,7 @@
 
 
 @click.group(cls=DefaultGroup, default="build", default_if_no_args=True)
-@click.version_option(__version__.public())
+@click.version_option(__version__)
 def cli() -> None:
     """
     Towncrier is a utility to produce useful, summarised news files for your project.

src/towncrier/_version.py

@@ -2,18 +2,11 @@
 Provides towncrier version information.
 """
 
-# This file is auto-generated! Do not edit!
-# Use `python -m incremental.update towncrier` to change this file.
-
-from incremental import Version
-
-
-# For dev   - Version('towncrier', 23, 8, 1, dev=0)
-# For RC    - Version('towncrier', 23, 9, 0, release_candidate=1)
-# For final - Version('towncrier', 23, 9, 0)
-__version__ = Version("towncrier", 23, 11, 1, dev=0)
-# The version is exposed in string format to be
-# available for the hatching build tools.
-_hatchling_version = __version__.short()
-
-__all__ = ["__version__", "_hatchling_version"]
+# For dev   - 23.11.1.dev0
+# For RC    - 23.11.1.rc1
+# For final - 23.11.1
+# make sure to follow PEP440
+__version__ = "23.11.1.dev0"
+
+_hatchling_version = __version__
+__all__ = ["_hatchling_version"]

src/towncrier/newsfragments/491.misc

@@ -0,0 +1,3 @@
+Remove incremental dependency from towncrier.
+
+Towncrier can still read incremental versions, it just doesn't rely on the package itself any more.

src/towncrier/test/test_packaging.py

@@ -1,22 +1,26 @@
 # Copyright (c) Amber Brown, 2015
 # See LICENSE for details.
 
-from incremental import Version
 from twisted.trial.unittest import TestCase
 
-from towncrier._version import _hatchling_version
+import towncrier
 
 
 class TestPackaging(TestCase):
-    def test_version_warning(self):
+    def test_version_attr(self):
         """
-        Import __version__ from towncrier returns an Incremental version object
-        and raises a warning.
+        towncrier.__version__ was deprecated, but still exists for now.
         """
-        with self.assertWarnsRegex(
-            DeprecationWarning, "Accessing towncrier.__version__ is deprecated.*"
-        ):
-            from towncrier import __version__
 
-        self.assertIsInstance(__version__, Version)
-        self.assertEqual(_hatchling_version, __version__.short())
+        def access__version():
+            return towncrier.__version__
+
+        expected_warning = (
+            "Accessing towncrier.__version__ is deprecated and will be "
+            "removed in a future release. Use importlib.metadata directly "
+            "to query for towncrier's packaging metadata."
+        )
+
+        self.assertWarns(
+            DeprecationWarning, expected_warning, __file__, access__version
+        )

src/towncrier/test/test_project.py

@@ -5,7 +5,6 @@
 import sys
 
 from importlib.metadata import version as metadata_version
-from unittest import mock
 
 from click.testing import CliRunner
 from twisted.trial.unittest import TestCase
@@ -45,32 +44,65 @@ def test_tuple(self):
         version = get_version(temp, "mytestproja")
         self.assertEqual(version, "1.3.12")
 
-    def test_incremental(self):
+        def test_incremental(self):
+            """
+            An incremental-like Version __version__  is picked up.
+            """
+            temp = self.mktemp()
+            os.makedirs(temp)
+            os.makedirs(os.path.join(temp, "mytestprojinc"))
+
+            with open(os.path.join(temp, "mytestprojinc", "__init__.py"), "w") as f:
+                f.write(
+                    """
+    class Version:
+        '''
+        This is emulating a Version object from incremental.
+        '''
+
+        def __init__(self, *version_parts):
+            self.version = version_parts
+
+        def base(self):
+            return '.'.join(map(str, self.version))
+
+
+    __version__ = Version(1, 3, 12, "rc1")
+    """
+                )
+            version = get_version(temp, "mytestprojinc")
+            self.assertEqual(version, "1.3.12rc1")
+
+    def test_not_incremental(self):
         """
-        An incremental Version __version__  is picked up.
+        An incremental-like Version __version__  is picked up, base takes unexpected
+        arguments.
         """
-        pkg = "../src"
+        temp = self.mktemp()
+        os.makedirs(os.path.join(temp, "mytestprojnotinc"))
 
-        with self.assertWarnsRegex(
-            DeprecationWarning, "Accessing towncrier.__version__ is deprecated.*"
-        ):
-            # Previously this triggered towncrier.__version__ but now the first version
-            # check is from the package metadata. Let's mock out that part to ensure we
-            # can get incremental versions from __version__ still.
-            with mock.patch(
-                "towncrier._project._get_metadata_version", return_value=None
-            ):
-                version = get_version(pkg, "towncrier")
+        with open(os.path.join(temp, "mytestprojnotinc", "__init__.py"), "w") as f:
+            f.write(
+                """
+class WeirdVersion:
+    def base(self, some_arg):
+        return "shouldn't get here"
 
-            version = get_version(pkg, "towncrier")
 
-        with self.assertWarnsRegex(
-            DeprecationWarning, "Accessing towncrier.__version__ is deprecated.*"
-        ):
-            name = get_project_name(pkg, "towncrier")
+__version__ = WeirdVersion()
+"""
+            )
+        with self.assertRaises(Exception) as e:
+            get_version(temp, "mytestprojnotinc")
 
-        self.assertEqual(metadata_version("towncrier"), version)
-        self.assertEqual("towncrier", name)
+        self.assertEqual(
+            (
+                "Version must be a string, tuple, or an Incremental Version. "
+                "If you can't provide that, use the --version argument and "
+                "specify one.",
+            ),
+            e.exception.args,
+        )
 
     def test_version_from_metadata(self):
         """
@@ -129,7 +161,7 @@ def test_unknown_type(self):
 
         self.assertRaises(Exception, get_version, temp, "mytestprojb")
 
-        self.assertRaises(TypeError, get_project_name, temp, "mytestprojb")
+        self.assertEqual("Mytestprojb", get_project_name(temp, "mytestprojb"))
 
     def test_import_fails(self):
         """