Merge branch 'main' into main

Author: RonnyPfannschmidt

.github/workflows/python-tests.yml

@@ -26,15 +26,15 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: hynek/build-and-inspect-python-package@v1
+      - uses: hynek/build-and-inspect-python-package@v2
 
   test:
     needs: [package]
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        python_version: [ '3.8', '3.9', '3.10', '3.11', '3.12.0-beta - 3.12', 'pypy-3.8' ]
+        python_version: [ '3.8', '3.9', '3.10', '3.11', '3.12', 'pypy-3.10' ]
         os: [windows-latest, ubuntu-latest] #, macos-latest]
         include:
         - os: windows-latest
@@ -43,8 +43,10 @@ jobs:
     name: ${{ matrix.os }} - Python ${{ matrix.python_version }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Setup python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         if: matrix.python_version != 'msys2'
         with:
           python-version: ${{ matrix.python_version }}
@@ -80,7 +82,7 @@ jobs:
           git config --system gpg.program "C:\Program Files (x86)\gnupg\bin\gpg.exe"
         if: runner.os == 'Windows'
       - run: pip install -U 'setuptools>=61'
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: Packages
           path: dist
@@ -89,7 +91,7 @@ jobs:
       - run: |
           $(hg debuginstall --template "{pythonexe}") -m pip install hg-git --user
         if: matrix.os == 'ubuntu-latest'
-      # this hopefull helps with os caches, hg init sometimes gets 20s timeouts
+      # this hopefully helps with os caches, hg init sometimes gets 20s timeouts
       - run: hg version
       - run: pytest
         timeout-minutes: 15
@@ -102,7 +104,7 @@ jobs:
       id-token: write
     needs: [test]
     steps:
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
         name: Packages
         path: dist
@@ -115,7 +117,7 @@ jobs:
     permissions:
       id-token: write
     steps:
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
         name: Packages
         path: dist

.pre-commit-config.yaml

@@ -1,45 +1,25 @@
-default_language_version:
-  python: python3.9
 repos:
--   repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-    - id: black
-      args: [--safe, --quiet]
-      exclude: docs/examples/
--   repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.11.0
-    hooks:
-    -   id: reorder-python-imports
-        args: [ "--application-directories=.:src" , --py38-plus, --add-import, 'from __future__ import annotations']
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
     -   id: trailing-whitespace
     -   id: check-yaml
     -   id: debug-statements
--   repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
-    hooks:
-    -   id: flake8
--   repo: https://github.com/asottile/pyupgrade
-    rev: v3.13.0
-    hooks:
-    - id: pyupgrade
-      args: [--py38-plus]
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.0.291
+  rev: v0.3.0
   hooks:
     - id: ruff
       args: [--fix, --exit-non-zero-on-fix]
+    - id: ruff-format
+
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: "1.1.0"
+  rev: "1.7.0"
   hooks:
     - id: pyproject-fmt
       exclude: docs/examples/
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.5.1'
+    rev: 'v1.8.0'
     hooks:
     -   id: mypy
         args: [--strict]

CHANGELOG.md

@@ -100,7 +100,7 @@
 
 # v7.0.5
 
-- fixes #742, #745: correctly hande accidentally released archival files
+- fixes #742, #745: correctly handle accidentally released archival files
 
 # v7.0.4
 
@@ -484,7 +484,7 @@ v3.0.3 (pulled from pypi due to a packaging issue) ======
 
 v1.15.7 ======
 
--   Fix #174 with #207: Re-use samefile backport as developed in
+-   Fix #174 with #207: Reuse samefile backport as developed in
     jaraco.windows, and only use the backport where samefile is not
     available.
 

README.md

@@ -20,15 +20,14 @@ Unwanted files must be excluded via `MANIFEST.in`.
 The preferred way to configure [setuptools-scm] is to author
 settings in a `tool.setuptools_scm` section of `pyproject.toml`.
 
-This feature requires setuptools 60 or later.
+This feature requires setuptools 61 or later.
 First, ensure that [setuptools-scm] is present during the project's
 build step by specifying it as one of the build requirements.
 
-```toml
+```toml title="pyproject.toml"
 [build-system]
-requires = [
-    "setuptools>=60",
-    "setuptools-scm>=8.0"]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
 ```
 
 That will be sufficient to require [setuptools-scm] for projects
@@ -46,6 +45,7 @@ dynamically in the `project` section of `pyproject.toml`:
 [project]
 # version = "0.0.1"  # Remove any existing version parameter.
 dynamic = ["version"]
+
 [tool.setuptools_scm]
 ```
 

_own_version_helper.py

@@ -5,22 +5,23 @@
 it works only if the backend-path of the build-system section
 from pyproject.toml is respected
 """
+
 from __future__ import annotations
 
 import logging
-from typing import Callable
 
-from setuptools import build_meta as build_meta  # noqa
+from typing import Callable
 
-from setuptools_scm import _types as _t
+from setuptools import build_meta as build_meta
 from setuptools_scm import Configuration
+from setuptools_scm import _types as _t
 from setuptools_scm import get_version
 from setuptools_scm import git
 from setuptools_scm import hg
 from setuptools_scm.fallbacks import parse_pkginfo
+from setuptools_scm.version import ScmVersion
 from setuptools_scm.version import get_local_node_and_date
 from setuptools_scm.version import guess_next_dev_version
-from setuptools_scm.version import ScmVersion
 
 log = logging.getLogger("setuptools_scm")
 # todo: take fake entrypoints from pyproject.toml

changelog.d/20240105_133254_subprocess_timeout_var.md

@@ -0,0 +1,4 @@
+
+### Changed
+
+- fix #957 - add subprocess timeout control env var

changelog.d/20240108_134756_cli_version_file_force.md

@@ -0,0 +1,30 @@
+
+### Added
+
+- fix #960: add a ``--force-write-version-files`` flag for the cli
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category.
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category.
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category.
+
+-->

changelog.d/20240305_102047_allow_non_normalized_semver.md

@@ -0,0 +1,4 @@
+
+### Fixed
+
+- fix #1018: allow non-normalized versions for semver

docs/config.md

@@ -27,11 +27,14 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
     !!! warning ""
 
         Only files with `.py` and `.txt` extensions have builtin templates,
-        for other file types it is necessary to provide `write_to_template`.
+        for other file types it is necessary to provide `version_file_template`.
+
+`version_file_template: str | None = None`
+:   A new-style format string taking `version`, `scm_version` and `version_tuple` as parameters.
+    `version` is the generated next_version as string,
+    `version_tuple` is a tuple of split numbers/strings and
+    `scm_version` is the `ScmVersion` instance the current `version` was rendered from
 
-`version_file_template_template: str | None = None`
-:   A new-style format string that is given the current version as
-    the `version` keyword argument for formatting.
 
 `write_to: Pathlike[str] | Path | None = None`
 :  (deprecated) legacy option to create a version file relative to the scm root
@@ -108,17 +111,22 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
 :   used as the primary source for the version number
     in which case it will be an unparsed string
 
-    !!! warning "it is strongly recommended to use use distribution name specific pretend versions"
+    !!! warning ""
 
+        it is strongly recommended to use distribution-specific pretend versions
+        (see below).
 
 `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME}`
-:   used as the primary source for the version number
-    in which case it will be an unparsed string
+:   used as the primary source for the version number,
+    in which case it will be an unparsed string.
+    Specifying distribution-specific pretend versions will
+    avoid possible collisions with third party distributions
+    also using ``setuptools_scm``
 
     the dist name normalization follows adapted PEP 503 semantics, with one or
-    more of ".-_" being replaced by a single "_", and the name being upper-cased
+    more of ".-\_" being replaced by a single "\_", and the name being upper-cased
 
-    it takes precedence over ``SETUPTOOLS_SCM_PRETEND_VERSION``
+    this will take precedence over ``SETUPTOOLS_SCM_PRETEND_VERSION``
 
 `SETUPTOOLS_SCM_DEBUG`
 :    enable the debug logging

docs/customizing.md

@@ -31,13 +31,10 @@ setup(use_scm_version={"version_scheme": myversion_func})
 ```
 
 
-``` { .python title="pyproject.toml" file="docs/examples/version_scheme_code/pyproject.toml" }
+``` { .toml title="pyproject.toml" file="docs/examples/version_scheme_code/pyproject.toml" }
 [build-system]
-requires = [
-  "setuptools>=64",
-  "setuptools_scm>=8",
-  "wheel",
-]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
 
 [project]
 name = "scm-example"
@@ -49,9 +46,6 @@ dynamic = [
 ```
 
 - [ ] add a build block that adds example output
-- [ ] correct config after [entangled mkdocs bug] is fixed
-
-[entangled mkdocs bug]: https://github.com/entangled/mkdocs-plugin/issues/1