.github/workflows/deploy.yml

@@ -1,35 +1,117 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
-name: "Publish to PyPI"
-
-on:
-  push:
-    tags:
-      - "*"
+# Adapted from https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
 
+name: Publish to PyPI
+on: push
 permissions:
-  contents: "read"
+  contents: read
 
 jobs:
-  publish:
-    name: "Publish to PyPI"
-    runs-on: "ubuntu-latest"
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+    - name: Set up Python
+      uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: python3 -m pip install build --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
     environment:
-      name: "publish"
+      name: pypi
+      url: https://pypi.org/p/idna  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
     steps:
-    - name: "Checkout repository"
-      uses: "actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b"
+    - name: Download all the dists
+      uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@ec4db0b4ddc65acdf4bff5fa45ac92d78b56bdf0 # release/v1
+
+  github-release:
+    name: Sign and upload GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
 
-    - name: "Setup Python"
-      uses: "actions/setup-python@b55428b1882923874294fa556849718a1d7f2ca5"
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download the dists
+      uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
       with:
-        python-version: "3.x"
+        name: python-package-distributions
+        path: dist/
+    - name: Sign with Sigstore
+      uses: sigstore/gh-action-sigstore-python@1f6a500bbfdd9a2a339cf033e5421951fbc1cd2 # v2.1.1
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'
+
+#  publish-to-testpypi:
+#    name: Publish to Test PyPI
+#    needs:
+#    - build
+#    runs-on: ubuntu-latest
+
+#    environment:
+#      name: testpypi
+#      url: https://test.pypi.org/p/idna
 
-    - name: "Build dists"
-      run: |
-        python -m pip install build
-        python -m build
+#    permissions:
+#      id-token: write  # IMPORTANT: mandatory for trusted publishing
 
-    - name: "Publish to PyPI"
-      uses: "pypa/gh-action-pypi-publish@37f50c210e3d2f9450da2cd423303d6a14a6e29f"
+#    steps:
+#    - name: Download all the dists
+#      uses: actions/download-artifact@v4
+#      with:
+#        name: python-package-distributions
+#        path: dist/
+#    - name: Publish distribution to TestPyPI
+#      uses: pypa/gh-action-pypi-publish@ec4db0b4ddc65acdf4bff5fa45ac92d78b56bdf0 # release/v1
+#      with:
+#        verbose: true
+#        print-hash: true
+#        repository-url: https://test.pypi.org/legacy/

.github/workflows/python-package.yml

@@ -13,18 +13,20 @@ permissions:
 jobs:
   mypy:
     strategy:
+      fail-fast: false
       matrix:
         python-version:
           - '3.8'
           - '3.9'
           - '3.10'
           - '3.11'
           - '3.12'
+          - '3.13'
     runs-on: ${{ matrix.os || 'ubuntu-latest' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5.1.1
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -35,6 +37,7 @@ jobs:
 
   build:
     strategy:
+      fail-fast: false
       matrix:
         python-version:
           - '3.7'
@@ -43,17 +46,16 @@ jobs:
           - '3.10'
           - '3.11'
           - '3.12'
+          - '3.13'
           - 'pypy-3.9'
         include:
-          - python-version: 3.5
-            os: ubuntu-20.04
           - python-version: 3.6
             os: ubuntu-20.04
     runs-on: ${{ matrix.os || 'ubuntu-latest' }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5.1.1
       with:
         python-version: ${{ matrix.python-version }}
         allow-prereleases: true

.github/workflows/scorecard.yml

@@ -25,12 +25,12 @@ jobs:
 
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@v4
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
+        uses: ossf/scorecard-action@a46b90b4caca61e2298cc4a9bd4c90d3dfe7f09d # v2.4.0
         with:
           results_file: results.sarif
           results_format: sarif
@@ -47,7 +47,7 @@ jobs:
       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
       # format to the repository Actions tab.
       - name: "Upload artifact"
-        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
+        uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4
         with:
           name: SARIF file
           path: results.sarif

HISTORY.rst

@@ -3,6 +3,18 @@
 History
 -------
 
+3.8 (2024-08-23)
+++++++++++++++++
+
+- Fix regression where IDNAError exception was not being produced for
+  certain inputs.
+- Add support for Python 3.13, drop support for Python 3.5 as it is no
+  longer testable.
+- Documentation improvements
+- Updates to package testing using Github actions
+
+Thanks to Hugo van Kemenade for contributions to this release.
+
 3.7 (2024-04-11)
 ++++++++++++++++
 

README.rst

@@ -83,7 +83,9 @@ This library provides one such mapping that was developed by the
 Unicode Consortium. Known as `Unicode IDNA Compatibility Processing
 <https://unicode.org/reports/tr46/>`_, it provides for both a regular
 mapping for typical applications, as well as a transitional mapping to
-help migrate from older IDNA 2003 applications.
+help migrate from older IDNA 2003 applications. Strings are
+preprocessed according to Section 4.4 “Preprocessing for IDNA2008”
+prior to the IDNA operations.
 
 For example, “Königsgäßchen” is not a permissible label as *LATIN
 CAPITAL LETTER K* is not allowed (nor are capital letters in general).
@@ -183,17 +185,17 @@ Additional Notes
 * **Packages**. The latest tagged release version is published in the
   `Python Package Index <https://pypi.org/project/idna/>`_.
 
-* **Version support**. This library supports Python 3.5 and higher.
+* **Version support**. This library supports Python 3.6 and higher.
   As this library serves as a low-level toolkit for a variety of
   applications, many of which strive for broad compatibility with older
   Python versions, there is no rush to remove older interpreter support.
   Removing support for older versions should be well justified in that the
   maintenance burden has become too high.
 
 * **Python 2**. Python 2 is supported by version 2.x of this library.
-  While active development of the version 2.x series has ended, notable
-  issues being corrected may be backported to 2.x. Use "idna<3" in your
-  requirements file if you need this library for a Python 2 application.
+  Use "idna<3" in your requirements file if you need this library for
+  a Python 2 application. Be advised that these versions are no longer
+  actively developed.
 
 * **Testing**. The library has a test suite based on each rule of the
   IDNA specification, as well as tests that are provided as part of the

idna/core.py

@@ -240,8 +240,12 @@ def check_label(label: Union[str, bytes, bytearray]) -> None:
         if intranges_contain(cp_value, idnadata.codepoint_classes['PVALID']):
             continue
         elif intranges_contain(cp_value, idnadata.codepoint_classes['CONTEXTJ']):
-            if not valid_contextj(label, pos):
-                raise InvalidCodepointContext('Joiner {} not allowed at position {} in {}'.format(
+            try:
+                if not valid_contextj(label, pos):
+                    raise InvalidCodepointContext('Joiner {} not allowed at position {} in {}'.format(
+                        _unot(cp_value), pos+1, repr(label)))
+            except ValueError:
+                raise IDNAError('Unknown codepoint adjacent to joiner {} at position {} in {}'.format(
                     _unot(cp_value), pos+1, repr(label)))
         elif intranges_contain(cp_value, idnadata.codepoint_classes['CONTEXTO']):
             if not valid_contexto(label, pos):

idna/package_data.py

@@ -1,2 +1,2 @@
-__version__ = '3.7'
+__version__ = '3.8'
 

pyproject.toml

@@ -19,21 +19,21 @@ classifiers = [
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.5",
   "Programming Language :: Python :: 3.6",
   "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
   "Topic :: Internet :: Name Service (DNS)",
   "Topic :: Software Development :: Libraries :: Python Modules",
   "Topic :: Utilities",
 ]
-requires-python = ">=3.5"
+requires-python = ">=3.6"
 dynamic = ["version"]
 
 [project.urls]

setup.cfg

@@ -14,22 +14,22 @@ classifiers =
   Programming Language :: Python
   Programming Language :: Python :: 3
   Programming Language :: Python :: 3 :: Only
-  Programming Language :: Python :: 3.5
   Programming Language :: Python :: 3.6
   Programming Language :: Python :: 3.7
   Programming Language :: Python :: 3.8
   Programming Language :: Python :: 3.9
   Programming Language :: Python :: 3.10
   Programming Language :: Python :: 3.11
   Programming Language :: Python :: 3.12
+  Programming Language :: Python :: 3.13
   Programming Language :: Python :: Implementation :: CPython
   Programming Language :: Python :: Implementation :: PyPy
   Topic :: Internet :: Name Service (DNS)
   Topic :: Software Development :: Libraries :: Python Modules
   Topic :: Utilities
 
 [options]
-python_requires = >=3.5
+python_requires = >=3.6
 packages=find:
 
 [options.packages.find]

tests/test_idna.py

@@ -270,6 +270,7 @@ def test_decode(self, decode=None, skip_str=False):
         self.assertRaises(idna.IDNAError, decode, b'xn--')
         self.assertRaises(idna.IDNAError, decode, b'\x8d\xd2')
         self.assertRaises(idna.IDNAError, decode, b'A.A.0.a.a.A.0.a.A.A.0.a.A.0A.2.a.A.A.0.a.A.0.A.a.A0.a.a.A.0.a.fB.A.A.a.A.A.B.A.A.a.A.A.B.A.A.a.A.A.0.a.A.a.a.A.A.0.a.A.0.A.a.A0.a.a.A.0.a.fB.A.A.a.A.A.B.0A.A.a.A.A.B.A.A.a.A.A.a.A.A.B.A.A.a.A.0.a.B.A.A.a.A.B.A.a.A.A.5.a.A.0.a.Ba.A.B.A.A.a.A.0.a.Xn--B.A.A.A.a')
+        self.assertRaises(idna.IDNAError, decode, b'xn--ukba655qaaaa14431eeaaba.c')
 
 if __name__ == '__main__':
     unittest.main()

tools/idna-data

@@ -671,7 +671,7 @@ def main():
     elif args.action == 'make-libdata':
         make_libdata(args, ucdata)
     else:
-        result = re.match(r'^(?i)(U\+|)(?P<cp>[0-9A-F]{4,6})$', args.action)
+        result = re.match(r'(?i)^(U\+|)(?P<cp>[0-9A-F]{4,6})$', args.action)
         if result:
             codepoint = int(result.group('cp'), 16)
             diagnose_codepoint(codepoint, args, ucdata)