Merge pull request #307 from netromdk/dev

Python 3.13 support and various fixes and features

Author: netromdk

.github/workflows/analyze.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.12']
+        python-version: ['3.13']
 
     steps:
     - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8

.github/workflows/test.yml

@@ -17,10 +17,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        # Start Linux jobs last since they are fastest to start and complete, and start 3.12 first,
-        # since it pairs wiht macOS+Windows jobs. 3.4 is not supported on GitHub anymore and 3.5,
-        # 3.6, and 3.7 for x64 isn't produced for Ubuntu 22.04 and macOS.
-        python-version: ['3.12', '3.11', '3.10', 3.9, 3.8]
+        # Start Linux jobs last since they are fastest to start and complete, and start 3.13 first,
+        # since it pairs wiht macOS+Windows jobs, and 3.5 and 3.6 last since they only run tests and
+        # don't use venv. 3.4 is not supported on GitHub anymore and 3.5 and 3.6 for x64 isn't
+        # produced for ubuntu 22.04.
+        python-version: ['3.13', '3.12', '3.11', '3.10', 3.9, 3.8, 3.7, 3.6, 3.5]
         os: [windows-latest, macos-latest, ubuntu-latest]
 
         # Choose test script depending on OS.
@@ -33,7 +34,7 @@ jobs:
             test_script_name: ./misc/actions/test.ps1
 
         exclude:
-          # Only test on macOS and Windows with Python 3.12.
+          # Only test on macOS and Windows with Python 3.13.
           - os: macos-latest
             python-version: 3.5
           - os: macos-latest
@@ -48,6 +49,8 @@ jobs:
             python-version: '3.10'
           - os: macos-latest
             python-version: '3.11'
+          - os: macos-latest
+            python-version: '3.12'
 
           - os: windows-latest
             python-version: 3.5
@@ -63,6 +66,8 @@ jobs:
             python-version: '3.10'
           - os: windows-latest
             python-version: '3.11'
+          - os: windows-latest
+            python-version: '3.12'
 
           # Ignore 3.5, 3.6, and 3.7 on Linux because it isn't compiled for x64 on Ubuntu 22.04.
           - os: ubuntu-latest

README.rst

@@ -63,6 +63,7 @@ Table of Contents
 * `API (experimental) <#api-experimental>`__
 * `Analysis Exclusions <#analysis-exclusions>`__
 * `Parsable Output <#parsable-output>`__
+* `GitHub Output <#github-output>`__
 * `Contributing <#contributing>`__
 
 Usage
@@ -147,9 +148,10 @@ bytearray, ``with`` statement, asynchronous ``with`` statement, multiple context
 unpacking assignment, generalized unpacking, ellipsis literal (``...``) out of slices, dictionary
 union (``{..}  | {..}``), dictionary union merge (``a = {..}; a |= {..}``), builtin generic type
 annotations (``list[str]``), function decorators, class decorators, relaxed decorators,
-``metaclass`` class keyword, pattern matching with ``match``, union types written as ``X | Y``, and
-type alias statements (``type X = SomeType``). It tries to detect and ignore user-defined functions,
-classes, arguments, and variables with names that clash with library-defined symbols.
+``metaclass`` class keyword, pattern matching with ``match``, union types written as ``X | Y``, type
+alias statements (``type X = SomeType``), and type alias statements with lambdas/comprehensions in
+class scopes. It tries to detect and ignore user-defined functions, classes, arguments, and
+variables with names that clash with library-defined symbols.
 
 Caveats
 =======
@@ -209,18 +211,18 @@ Examples
 
   % ./vermin.py vermin
   Minimum required versions: 3.0
-  Incompatible versions:     2
+  Incompatible versions:     2.x
 
   % ./vermin.py -t=3.3 vermin
   Minimum required versions: 3.0
-  Incompatible versions:     2
+  Incompatible versions:     2.x
   Target versions not met:   3.3
   % echo $?
   1
 
   % ./vermin.py --versions vermin
   Minimum required versions: 3.0
-  Incompatible versions:     2
+  Incompatible versions:     2.x
   Version range:             2.0, 2.6, 2.7, 3.0
 
   % ./vermin.py -v examples
@@ -233,7 +235,7 @@ Examples
   !2, 3.4      /path/to/examples/abc.py
                /path/to/examples/unknown.py
   Minimum required versions:   3.4
-  Incompatible versions:         2
+  Incompatible versions:       2.x
 
   % ./vermin.py -vv /path/to/examples/abc.py
   Detecting python files..
@@ -243,7 +245,7 @@ Examples
     'abc.ABC' requires !2, 3.4
 
   Minimum required versions: 3.4
-  Incompatible versions:     2
+  Incompatible versions:     2.x
 
   % ./vermin.py -vvv /path/to/examples/abc.py
   Detecting python files..
@@ -253,7 +255,7 @@ Examples
     L2: 'abc.ABC' requires !2, 3.4
 
   Minimum required versions: 3.4
-  Incompatible versions:     2
+  Incompatible versions:     2.x
 
   % ./vermin.py -f parsable /path/to/examples/abc.py
   /path/to/examples/abc.py:1:7:2.6:3.0:'abc' module
@@ -432,6 +434,19 @@ That means that the final result is ``!2`` and ``3.4``, which is shown by the la
 
   :::!2:3.4:
 
+GitHub Output
+=============
+
+The GitHub output format has the same output as `parsable <#parsable-output>`__, but the lines are
+formatted as GitHub Actions annotations. This let's you see minimum version violations as annotated
+errors directly from a GitHub pipeline.
+
+For annotations to appear in a pull request:
+
+- Vermin must be called from a GitHub Actions workflow triggered by a PR
+- Vermin must be called with current working directory as the root of the repository
+- Only violations found in files changed in the PR will show up
+
 Contributing
 ============
 

misc/.analysis-requirements.txt

@@ -1,3 +1,4 @@
+annotated-types==0.7.0
 astroid==2.15.5
 attrs==23.1.0
 bandit==1.7.5
@@ -6,57 +7,77 @@ bracex==2.3.post1
 build==0.10.0
 certifi==2025.4.26
 charset-normalizer==3.1.0
-click==8.1.4
+click==8.1.8
 click-option-group==0.5.6
 colorama==0.4.6
 defusedxml==0.7.1
+Deprecated==1.2.18
 dill==0.3.6
+distlib==0.4.0
 docutils==0.20.1
+exceptiongroup==1.2.2
 face==22.0.0
+filelock==3.19.1
 flake8==6.0.0
-gitdb==4.0.10
+gitdb==4.0.12
 GitPython==3.1.44
 glom==22.1.0
+googleapis-common-protos==1.70.0
 idna==3.10
+importlib_metadata==7.1.0
 isort==5.12.0
 jsonschema==4.18.0
 jsonschema-specifications==2023.6.1
 lazy-object-proxy==1.9.0
 markdown-it-py==3.0.0
 mccabe==0.7.0
 mdurl==0.1.2
+opentelemetry-api==1.25.0
+opentelemetry-exporter-otlp-proto-common==1.25.0
+opentelemetry-exporter-otlp-proto-http==1.25.0
+opentelemetry-instrumentation==0.46b0
+opentelemetry-instrumentation-requests==0.46b0
+opentelemetry-proto==1.25.0
+opentelemetry-sdk==1.25.0
+opentelemetry-semantic-conventions==0.46b0
+opentelemetry-util-http==0.46b0
 packaging==23.1
 pbr==5.11.1
 peewee==3.16.2
-pep517==0.13.0
-platformdirs==3.5.3
+pep517==0.13.1
+platformdirs==3.9.1
+protobuf==4.25.8
 pycodestyle==2.10.0
+pydantic==2.8.2
+pydantic_core==2.20.1
 pyflakes==3.0.1
 Pygments==2.15.1
 pylint==2.17.4
 pyparsing==3.0.9
 pyproject_hooks==1.0.0
 pyroma==4.2
 python-lsp-jsonrpc==1.0.0
-PyYAML==6.0.1
+PyYAML==6.0.2
 referencing==0.29.1
-requests==2.32.3
+requests==2.32.5
 rich==13.4.2
 rpds-py==0.8.10
-ruamel.yaml==0.17.35
-ruamel.yaml.clib==0.2.8
-semgrep==1.31.1
+ruamel.yaml==0.17.40
+ruamel.yaml.clib==0.2.14
+semgrep==1.86.0
 setuptools==80.9.0
 six==1.16.0
-smmap==5.0.0
+smmap==5.0.2
 stevedore==5.1.0
 toml==0.10.2
 tomli==2.0.1
 tomlkit==0.11.8
 trove-classifiers==2023.5.24
-typing_extensions==4.7.1
-ujson==5.8.0
-urllib3==1.26.20
+typing_extensions==4.12.2
+ujson==5.11.0
+urllib3==2.5.0
+virtualenv==20.34.0
 vulture==2.7
 wcmatch==8.4.1
 wrapt==1.15.0
+zipp==3.23.0

misc/actions/test.ps1

@@ -33,5 +33,13 @@ else {
   coveralls debug --service=github-actions
 
   # Report coverage. Note that it requires COVERALLS_REPO_TOKEN to be set!
-  coveralls --service=github-actions
+  for ($i = 0; $i -lt 5; $i++) {
+    $result = coveralls --service=github-actions
+    $exitCode = $LASTEXITCODE
+    Write-Host "Coveralls exit code: $exitCode"
+    if ($exitCode -eq 0) {
+      break
+    }
+    Start-Sleep -Seconds 10
+  }
 }

misc/actions/test.sh

@@ -28,5 +28,11 @@ else
   coveralls debug --service=github-actions
 
   # Note that it requires COVERALLS_REPO_TOKEN to be set!
-  coveralls --service=github-actions
+  for i in {1..5}; do
+    coveralls --service=github-actions
+    CODE=$?
+    echo "Coveralls exit code: $CODE"
+    if [ $CODE -eq 0 ]; then break; fi
+    sleep 10
+  done
 fi

runtests.py

@@ -1,8 +1,16 @@
 #!/usr/bin/env python
+import os
 import sys
 import unittest
 from time import time
 
+ROOT_MODULE = "tests."
+
+# Isolate tests to be run "suite[.Class.test_method]". Class and method are optional.
+ISOLATE = os.getenv("VERMIN_TEST_ISOLATE")
+if ISOLATE is not None:
+  ISOLATE = ROOT_MODULE + ISOLATE.strip()
+
 SUITES = (
   "general",
   "config",
@@ -33,10 +41,19 @@
 )
 
 def runsuite(suite):
-  suite = "tests.{}".format(suite)
+  # skip suite if doesn't match isolation filter
+  suite = ROOT_MODULE + suite
+  if ISOLATE:
+    if ISOLATE != suite and not ISOLATE.startswith(suite + "."):
+      print("Skipping test suite: {}".format(suite))
+      return 0
+    print("Isolated test(s): {}".format(ISOLATE))
   print("Running test suite: {}".format(suite))
   # Buffer output such that only on test errors will stdout/stderr be shown.
-  res = unittest.main(suite, exit=False, buffer=True).result
+  if ISOLATE:
+    res = unittest.main(None, argv=[sys.argv[0], ISOLATE], exit=False, buffer=True).result
+  else:
+    res = unittest.main(suite, exit=False, buffer=True).result
   if len(res.failures) > 0 or len(res.errors) > 0:
     sys.exit(-1)
   return res.testsRun

tests/arguments.py

@@ -337,23 +337,24 @@ def test_format(self):
       self.assertContainsDict({"code": 0}, self.parse_args(["--format", fmt]))
       self.assertEqual(fmt, self.config.format().name())
 
-    # Parsable verbose level 3, no tips, ignore incompatible versions, no `--versions`.
-    for args in (["--format", "parsable"], ["--format", "parsable", "--verbose"],
-                 ["--format", "parsable", "--versions"]):
+    for fmt in ("parsable", "github"):
+      # Parsable verbose level 3, no tips, ignore incompatible versions, no `--versions`.
+      for args in (["--format", fmt], ["--format", fmt, "--verbose"],
+                   ["--format", fmt, "--versions"]):
+        self.config.reset()
+        self.assertContainsDict({"code": 0, "versions": False}, self.parse_args(args))
+        self.assertEqual(3, self.config.verbose())
+        self.assertTrue(self.config.ignore_incomp())
+        self.assertFalse(self.config.show_tips())
+
+      # Verbosity can be higher for parsable
       self.config.reset()
-      self.assertContainsDict({"code": 0, "versions": False}, self.parse_args(args))
-      self.assertEqual(3, self.config.verbose())
+      self.assertContainsDict({"code": 0, "versions": False},
+                              self.parse_args(["--format", fmt, "-vvvv"]))
+      self.assertEqual(4, self.config.verbose())
       self.assertTrue(self.config.ignore_incomp())
       self.assertFalse(self.config.show_tips())
 
-    # Verbosity can be higher for parsable.
-    self.config.reset()
-    self.assertContainsDict({"code": 0, "versions": False},
-                            self.parse_args(["--format", "parsable", "-vvvv"]))
-    self.assertEqual(4, self.config.verbose())
-    self.assertTrue(self.config.ignore_incomp())
-    self.assertFalse(self.config.show_tips())
-
   def test_pessimistic(self):
     self.assertFalse(self.config.pessimistic())
     self.assertContainsDict({"code": 0}, self.parse_args(["--pessimistic"]))

tests/array_typecodes.py

@@ -18,3 +18,12 @@ def test_typecode_q(self, source, min_versions):
   ])
   def test_typecode_Q(self, source, min_versions):
     self.assertDetectMinVersions(source, min_versions)
+
+  @VerminTest.parameterized_args([
+    ("from array import array\narray('w')", (3, 13)),
+    ("import array\narray.array('w')", (3, 13)),
+    ("from array import array\narray('w', [1, 2])", (3, 13)),
+    ("from array import array as a\na('w', [1, 2])", (3, 13)),
+  ])
+  def test_typecode_w(self, source, min_versions):
+    self.assertDetectMinVersions(source, min_versions)

tests/builtin_exceptions.py

@@ -107,6 +107,9 @@ def test_PermissionError(self):
   def test_ProcessLookupError(self):
     self.assertOnlyIn((3, 3), self.detect("ProcessLookupError()"))
 
+  def test_PythonFinalizationError(self):
+    self.assertOnlyIn((3, 13), self.detect("PythonFinalizationError()"))
+
   def test_RecursionError(self):
     self.assertOnlyIn((3, 5), self.detect("RecursionError()"))