Merge remote-tracking branch 'origin/trunk' into sql-storage

Author: glyph

.coveragerc

@@ -2,16 +2,16 @@
 branch = True
 parallel = True
 source = klein
-omit = src/klein/test/typing_*.py
+omit = */klein/test/typing_*.py
 
 [paths]
 source=
    src/klein
-   .tox/*/lib/python*/site-packages/klein
+   .tox/*/lib/py*/site-packages/klein
    .tox/*/Lib/site-packages/klein
-   .tox/pypy*/site-packages/klein
 
 [report]
 exclude_lines =
     pragma: no cover
     if TYPE_CHECKING:
+    \s*\.\.\.$

.flake8

@@ -100,3 +100,8 @@ extend-ignore =
     B907,
     D419,
     N818,
+
+    # flake8 incorrectly identifies black folding '...' onto one line as
+    # 'multiple statements'.  See
+    # https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#e701-e704
+    E704, E701,

.github/workflows/cicd.yml

@@ -28,7 +28,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -62,7 +62,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -96,7 +96,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -130,7 +130,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -163,7 +163,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
@@ -193,27 +193,31 @@ jobs:
     strategy:
       matrix:
         os: ["ubuntu-latest"]
-        python-version: ["3.7", "3.9", "3.10", "3.11"]
-        twisted-version: ["21.2", "22.1", "current"]
+        python-version: ["3.9", "3.10", "3.11"]
+        twisted-version: ["21.2", "22.1", "23.8"]
         tox-prefix: ["coverage"]
         optional: [false]
         include:
           - os: "ubuntu-latest"
-            python-version: "pypy-3.8"
-            twisted-version: "current"
+            python-version: "pypy-3.9"
+            twisted-version: "23.8"
             tox-prefix: "test"
             optional: false
           - os: "ubuntu-latest"
-            python-version: "pypy-3.9"
-            twisted-version: "current"
+            python-version: "pypy-3.10"
+            twisted-version: "23.8"
+            tox-prefix: "test"
+            optional: false
+          - os: "ubuntu-latest"
+            python-version: "3.12.0"
+            twisted-version: "23.8"
             tox-prefix: "test"
             optional: false
-          # Test Python 3.12 but allow it to fail
           - os: "ubuntu-latest"
-            python-version: "3.12.0-alpha.7"
-            twisted-version: "current"
+            python-version: "3.13.0"
+            twisted-version: "24.10"
             tox-prefix: "test"
-            optional: true
+            optional: false
 
     steps:
 
@@ -223,7 +227,7 @@ jobs:
           fetch-depth: 2
 
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -266,19 +270,19 @@ jobs:
 
       - name: Upload Trial log artifact
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: trial
+          name: "trial-py${{ matrix.python-version }}-twisted${{ matrix.twisted-version }}-os${{ matrix.os }}"
           path: .tox/${TOX_ENV}/log/trial.log
 
       # Use the latest supported Python version for combining coverage to
       # prevent parsing errors in older versions when looking at modern code.
-      - uses: "actions/setup-python@v4"
+      - uses: "actions/setup-python@v5"
         with:
           python-version: "3.11"
 
       - name: "Upload coverage to Codecov"
-        uses: "codecov/codecov-action@v3"
+        uses: "codecov/codecov-action@v5"
         if: ${{ matrix.tox-prefix == 'coverage' }}
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -11,3 +11,4 @@
 /htmldocs/
 /src/*.egg-info
 coverage.xml
+*/__pycache__/*

.pre-commit-config.yaml

@@ -5,19 +5,18 @@ ci:
 repos:
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: "v3.4.0"
+    rev: "v3.20.0"
     hooks:
       - id: pyupgrade
         args: ["--py37-plus", "--keep-runtime-typing"]
 
   - repo: https://github.com/psf/black
-    rev: "23.3.0"
+    rev: "25.1.0"
     hooks:
       - id: black
-        args: ["--target-version", "py37"]
 
   - repo: https://github.com/PyCQA/autoflake
-    rev: "v2.1.1"
+    rev: "v2.3.1"
     hooks:
       - id: autoflake
         args:
@@ -28,41 +27,47 @@ repos:
           - --remove-unused-variables
 
   - repo: https://github.com/PyCQA/flake8
-    rev: "6.0.0"
+    rev: "7.2.0"
     hooks:
       - id: flake8
         additional_dependencies:
-          - flake8-bugbear==23.5.9
-          - flake8-docstrings==1.7.0
-          - flake8-mutable==1.2.0
-          - flake8-pep3101==2.0.0
-          - pep8-naming==0.13.3
-          - pycodestyle==2.10.0
-          - pydocstyle==6.3.0
-          - pyflakes==3.0.1
+          # duplicated because pre-commit cannot manage dependencies normally;
+          # see https://github.com/pre-commit/pre-commit/issues/730 - for now,
+          # paste and reformat from requirements/flake8.txt manually
+
+          - "flake8-bugbear==24.12.12"
+          - "flake8-docstrings==1.7.0"
+          - "flake8-mutable==1.2.0"
+          - "flake8-pep3101==2.1.0"
+          - "pep8-naming==0.14.1"
+          - "pycodestyle==2.13.0"
+          - "pydocstyle==6.3.0"
+          - "pyflakes==3.3.2"
 
   - repo: https://github.com/asottile/yesqa
-    rev: "v1.4.0"
+    rev: "v1.5.0"
     hooks:
       - id: yesqa
         additional_dependencies:
-          - flake8-bugbear==23.3.23
-          - flake8-docstrings==1.7.0
-          - flake8-mutable==1.2.0
-          - flake8-pep3101==2.0.0
-          - pep8-naming==0.13.3
-          - pycodestyle==2.10.0
-          - pydocstyle==6.3.0
-          - pyflakes==3.0.1
+          # see 'duplicated' above
+          - "flake8-bugbear==24.12.12"
+          - "flake8-docstrings==1.7.0"
+          - "flake8-mutable==1.2.0"
+          - "flake8-pep3101==2.1.0"
+          - "pep8-naming==0.14.1"
+          - "pycodestyle==2.13.0"
+          - "pydocstyle==6.3.0"
+          - "pyflakes==3.3.2"
+        pass_filenames: false
 
   - repo: https://github.com/PyCQA/isort
-    rev: "5.12.0"
+    rev: "6.0.1"
     hooks:
     - id: isort
       args: ["--filter-files"]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.4.0"
+    rev: "v5.0.0"
     hooks:
       - id: check-ast
       - id: check-builtin-literals
@@ -104,6 +109,6 @@ repos:
       - id: text-unicode-replacement-char
 
   - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.49"
+    rev: "0.50"
     hooks:
       - id: check-manifest

CONTRIBUTING.rst

@@ -13,12 +13,12 @@ Klein is an open source project that welcomes contributions of all kinds coming
 Getting started
 ===============
 
-Here is a list of shell commands that will install the dependencies of Klein, run the test suite with Python 3.8 and the current version of Twisted, compile the documentation, and check for coding style issues with flake8.
+Here is a list of shell commands that will install the dependencies of Klein, run the test suite with Python 3.8 and Twisted 23.8, compile the documentation, and check for coding style issues with flake8.
 
 .. code-block:: shell
 
    pip install --user tox
-   tox -e py38-twcurrent
+   tox -e py312-tw238
    tox -e docs
    tox -e flake8
 
@@ -45,7 +45,7 @@ Code
   Klein uses `Twisted Trial <https://docs.twisted.org/en/stable/api/twisted.trial.html>`_ and `tox <https://tox.readthedocs.io/en/latest/>`_ for its tests.
   The command to run the full test suite is ``tox`` with no arguments.
   This will run tests against several versions of Python and Twisted, which can be time-consuming.
-  To run tests against only one or a few versions, pass a ``-e`` argument with an environment from the envlist in ``tox.ini``: for example, ``tox -e py38-twcurrent`` will run tests with Python 3.8 and the current released version of Twisted.
+  To run tests against only one or a few versions, pass a ``-e`` argument with an environment from the envlist in ``tox.ini``: for example, ``tox -e py38-tw238`` will run tests with Python 3.8 and Twisted 23.8.
   To run only one or a few specific tests in the suite, add a filename or fully-qualified Python path to the end of the test invocation: for example, ``tox klein.test.test_app.KleinTestCase.test_foo`` will run only the ``test_foo()`` method of the ``KleinTestCase`` class in ``klein/test/test_app.py``.
   These two test shortcuts can be combined to give you a quick feedback cycle, but make sure to check on the full test suite from time to time to make sure changes haven't had unexpected side effects.
 - Show us your code changes through pull requests sent to `Klein's GitHub repo <https://github.com/twisted/klein>`_.
@@ -58,7 +58,7 @@ Code
 Documentation
 -------------
 
-Klein uses `Epydoc <http://epydoc.sourceforge.net/manual-epytext.html>`_ for docstrings in code and uses `Sphinx <https://www.sphinx-doc.org/en/master/>`_ for standalone documentation.
+Klein uses `Epydoc <https://epydoc.sourceforge.net/manual-epytext.html>`_ for docstrings in code and uses `Sphinx <https://www.sphinx-doc.org/en/master/>`_ for standalone documentation.
 
 - In documents with headers, use this format and order for headers::
 

NEWS.rst

@@ -1,8 +1,8 @@
 NEWS
 ====
 
-NEXT
-----
+23.12.0 - 2023-12-22
+--------------------
 
  * Fixed a compatibility issue with Werkzeug versions greater than 2.2. [`#575 <https://github.com/twisted/klein/pull/575>`]
  * Added explicit support for Python 3.10 and 3.11, although in practice they did work previously in 21.8. [`#578 <https://github.com/twisted/klein/pull/578>`]

docs/conf.py

@@ -70,3 +70,5 @@ def load_source(modname, filename):
 # API links extension, stolen from Twisted's Sphinx setup
 extensions.append("apilinks")
 apilinks_base_url = "https://docs.twisted.org/en/stable/api/"
+
+user_agent = "Klein-Linkcheck/1.0.0"

docs/release.rst

@@ -13,10 +13,22 @@ Releasing Klein
 
 #. Start with a clean (no changes) source tree on the trunk branch.
 #. Create a new release candidate: :code:`tox -e release -- start`
+#. Manually update the ``NEXT`` heading in ``NEWS.rst`` to reference the
+   version that was just updated, *without* the "rc" release-candidate tag, and
+   the current RFC3339-formatted date; i.e. write the ``NEWS.rst`` file as if
+   it were for the final release.
 #. Commit and push the branch
 #. Open a PR from the branch (follow the usual process for opening a PR).
-#. As appropriate, pull the latest code from :code:`trunk`: :code:`git checkout trunk && git pull --rebase` (or use the GitHub UI)
-#. To publish a release candidate to PyPI: :code:`tox -e release -- publish`
+#. As appropriate, pull the latest code from :code:`trunk`: :code:`git checkout
+   trunk && git pull --rebase` (or use the GitHub UI)
+#. To publish a release candidate to PyPI: :code:`tox -e release -- publish --candidate`
 #. Obtain an approving review for the PR using the usual process.
-#. To publish a production release: :code:`tox -e release -- publish --final`
+#. If the date has changed since the release candidate, update the RFC3339 date
+   in the ``NEWS.rst`` header for the release to the current date; commit and
+   push this change to the branch.
+#. Publish a production release with the command: :code:`tox -e release --
+   publish --final`
+#. In ``NEWS.rst``, add a new "NEXT" section at the top.  You do not need a
+   separate review for this addition; it should be done after the release, but
+   before merging to trunk.
 #. Merge the PR to the trunk branch.

pyproject.toml

@@ -7,4 +7,4 @@ build-backend = "setuptools.build_meta"
 [tool.black]
 
 line-length = 80
-target-version = ["py36"]
+target-version = ["py39"]