Merge pull request #194 from ariebovenberg/py312

add Python 3.12 support

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v1
@@ -25,7 +25,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install 'tox<5' tox-gh-actions 'poetry>=1.5,<1.6'
+        pip install 'tox<5' tox-gh-actions 'poetry>=1.6,<1.7'
     - name: Test with tox
       run: tox
 

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+0.17.1 (2023-11-03)
+-------------------
+
+- Fixed ``Generic`` false positive in Python 3.12+ (#201).
+- Remove ``pkgutil`` deprecation warning on Python 3.12+.
+- Official Python 3.12 support.
+
 0.17.0 (2023-07-31)
 -------------------
 

Makefile

@@ -26,7 +26,7 @@ format-check:
 fix: isort format
 
 lint:
-	flake8 --exclude=.tox,build
+	flake8 src tests --exclude=.tox,build
 
 type-check:
 	mypy --pretty src tests/src

docs/advanced.rst

@@ -18,7 +18,7 @@ Use the following configuration:
 
    repos:
    - repo: https://github.com/ariebovenberg/slotscheck
-     rev: v0.17.0
+     rev: v0.17.1
      hooks:
      - id: slotscheck
        # If your Python files are not importable from the project root,

mypy.ini

@@ -1,14 +1,13 @@
 [mypy]
-disallow_untyped_defs = True
+strict = True
 warn_redundant_casts = True
 warn_unused_ignores = True
 warn_unreachable = True
-enable_error_code = redundant-expr
+exclude= ^tests/examples/.*$
 
 [mypy-tests.*]
 check_untyped_defs = True
+disable_error_code =
+   no-untyped-def
 disallow_untyped_defs = False
 warn_unreachable = True
-
-[mypy-module_misc.*,module_singular]
-ignore_errors = True

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "slotscheck"
-version = "0.17.0"
+version = "0.17.1"
 description = "Ensure your __slots__ are working properly."
 authors = ["Arie Bovenberg <[email protected]>"]
 license = "MIT"
@@ -12,6 +12,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
 ]
 packages = [
     { include = "slotscheck", from = "src" },
@@ -36,7 +37,7 @@ pytest-cov = "^4.1.0"
 pytest-mock = "^3.12.0"
 typing_extensions = ">=4.1,<5"
 # Only actually needed as an example library whose __init__ is an extension.
-pydantic = "1.9.2"
+pydantic = "<3"
 
 [tool.poetry.scripts]
 slotscheck = "slotscheck.cli:root"

src/slotscheck/checks.py

@@ -1,7 +1,7 @@
 "Slots-related checks and inspection tools"
 import platform
 import sys
-from typing import Collection, Iterator, Optional
+from typing import Collection, Generic, Iterator, Optional
 
 from .common import is_typeddict
 
@@ -16,14 +16,17 @@ def slots(c: type) -> Optional[Collection[str]]:
     elif isinstance(slots_raw, Iterator):
         raise NotImplementedError("Iterator __slots__ not supported. See #22")
     else:
-        return slots_raw
+        # We know it's a collection of strings now, since class creation
+        # would have failed otherwise
+        return slots_raw  # type: ignore[no-any-return]
 
 
 def has_slots(c: type) -> bool:
     return (
         "__slots__" in c.__dict__
         or not (issubclass(c, BaseException) or is_pure_python(c))
         or is_typeddict(c)
+        or c is Generic  # type: ignore[comparison-overlap]
     )
 
 

src/slotscheck/common.py

@@ -15,6 +15,16 @@
     TypeVar,
 )
 
+__all__ = [
+    "both",
+    "compose",
+    "groupby",
+    "is_protocol",
+    "is_typeddict",
+    "map_optional",
+    "unique",
+]
+
 flatten = chain.from_iterable
 
 
@@ -92,7 +102,10 @@ def is_typeddict(tp: object) -> bool:
 # Note that typing.is_protocol is not available yet (CPython PR 104878)
 # The implementation below is derived from it.
 def is_protocol(t: type) -> bool:  # pragma: no cover
-    return getattr(t, "_is_protocol", False) and t != Protocol
+    return (
+        getattr(t, "_is_protocol", False)
+        and t != Protocol  # type: ignore[comparison-overlap]
+    )
 
 
 try:

src/slotscheck/discovery.py

@@ -4,11 +4,12 @@
 import pkgutil
 from dataclasses import dataclass, field, replace
 from functools import partial, reduce
-from importlib._bootstrap_external import (  # type: ignore[import]
+from importlib._bootstrap_external import (  # type: ignore[import-not-found]
     _NamespaceLoader,
 )
 from importlib.abc import FileLoader
 from importlib.machinery import ExtensionFileLoader
+from importlib.util import find_spec
 from inspect import isclass
 from itertools import chain, takewhile
 from pathlib import Path
@@ -164,9 +165,12 @@ def module_tree(
 ) -> Union[ModuleTree, FailedImport]:
     """May raise ModuleNotFoundError or UnexpectedImportLocation"""
     try:
-        loader = pkgutil.get_loader(module)
+        spec = find_spec(module)
     except BaseException as e:
         return FailedImport(module, e)
+    if spec is None:
+        raise ModuleNotFoundError(f"No module named '{module}'", name=module)
+    loader = spec.loader
     *namespaces, name = module.split(".")
     location: AbsPath
     tree: ModuleTree
@@ -182,8 +186,6 @@ def module_tree(
         assert len(loader._path._path) == 1
         location = Path(loader._path._path[0])
         tree = _package(name, location)
-    elif loader is None:
-        raise ModuleNotFoundError(f"No module named '{module}'", name=module)
     elif module == "builtins":
         return Module(module)
     else:

tests/examples/module_not_ok/foo.py

@@ -1,5 +1,5 @@
+from typing import Generic, Protocol, TypeVar
 
-from typing import Protocol
 from typing_extensions import Protocol as TypingExtProtocol
 
 
@@ -115,3 +115,10 @@ class MyOtherProto(TypingExtProtocol):
 
 class Zb(MyProto):
     __slots__ = ()
+
+
+Tvar = TypeVar("Tvar")
+
+
+class Zc(Generic[Tvar]):
+    __slots__ = ()

tests/src/test_checks.py

@@ -58,7 +58,7 @@ class OneStringSlot(HasSlots):
     __slots__ = "baz"
 
 
-class ArrayInherit(array):
+class ArrayInherit(array):  # type: ignore[type-arg]
     __slots__ = ()
 
 

tests/src/test_cli.py

@@ -1,5 +1,5 @@
 import os
-import pkgutil
+from importlib.util import find_spec
 from pathlib import Path
 
 import pytest
@@ -207,7 +207,7 @@ def test_errors_with_default_settings(runner: CliRunner):
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 ERROR: 'module_not_ok.foo:Zb' has slots but superclass does not.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -234,7 +234,7 @@ def test_errors_require_slots_subclass(runner: CliRunner):
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 ERROR: 'module_not_ok.foo:Zb' has slots but superclass does not.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -259,7 +259,7 @@ def test_errors_disallow_nonslot_inherit(runner: CliRunner):
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 ERROR: 'module_not_ok.foo:Zb' has slots but superclass does not.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -279,7 +279,7 @@ def test_errors_no_require_superclass(runner: CliRunner):
 ERROR: 'module_not_ok.foo:Z' has duplicate slots.
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -302,7 +302,7 @@ def test_errors_with_exclude_classes(runner: CliRunner):
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 ERROR: 'module_not_ok.foo:Zb' has slots but superclass does not.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -322,7 +322,7 @@ def test_errors_with_include_classes(runner: CliRunner):
 ERROR: 'module_not_ok.foo:W' defines overlapping slots.
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -417,8 +417,8 @@ def test_module_not_ok_verbose(runner: CliRunner):
     excluded:  0
     skipped:   0
 
-  classes:     31
-    has slots: 22
+  classes:     32
+    has slots: 23
     no slots:  9
     n/a:       0
 """
@@ -519,7 +519,7 @@ def test_finds_config(runner: CliRunner, mocker, tmpdir):
 ERROR: 'module_not_ok.foo:Z' has duplicate slots.
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -548,7 +548,7 @@ def test_given_config(runner: CliRunner, tmpdir):
 ERROR: 'module_not_ok.foo:Z' has duplicate slots.
 ERROR: 'module_not_ok.foo:Za' defines overlapping slots.
 Oh no, found some problems!
-Scanned 4 module(s), 31 class(es).
+Scanned 4 module(s), 32 class(es).
 """
     )
 
@@ -578,9 +578,9 @@ def test_ambiguous_import(runner: CliRunner):
 See slotscheck.rtfd.io/en/latest/discovery.html
 for more information on why this happens and how to resolve it.
 """.format(
-            pkgutil.get_loader(
+            find_spec(
                 "module_misc.a.b.c"
-            ).path,  # type: ignore[union-attr]
+            ).loader.path,  # type: ignore[union-attr]
             EXAMPLES_DIR / "other/module_misc/a/b/c.py",
         )
     )

tests/src/test_discovery.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import FrozenSet, List, TypeVar
 from unittest import mock
 
 import pytest
@@ -18,8 +18,10 @@
 
 from .conftest import EXAMPLES_DIR
 
+T = TypeVar("T")
 
-def fset(*args) -> frozenset:
+
+def fset(*args: T) -> FrozenSet[T]:
     return frozenset(args)
 
 
@@ -253,34 +255,9 @@ def test_import_error(self, mocker):
         ) == FailedImport("broken.submodule", mocker.ANY)
 
     def test_extension_package(self):
-        assert module_tree("pydantic", None) == make_pkg(
-            "pydantic",
-            Module("annotated_types"),
-            Module("types"),
-            Module("schema"),
-            Module("version"),
-            Module("utils"),
-            Module("parse"),
-            Module("env_settings"),
-            Module("datetime_parse"),
-            Module("json"),
-            Module("decorator"),
-            Module("class_validators"),
-            Module("generics"),
-            Module("validators"),
-            Module("main"),
-            Module("errors"),
-            Module("_hypothesis_plugin"),
-            Module("dataclasses"),
-            Module("mypy"),
-            Module("typing"),
-            Module("networks"),
-            Module("error_wrappers"),
-            Module("config"),
-            Module("fields"),
-            Module("tools"),
-            Module("color"),
-        )
+        tree = module_tree("pydantic", None)
+        assert isinstance(tree, Package)
+        assert len(tree.content) > 20
 
     def test_module(self):
         assert module_tree(

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 isolated_build = true
-envlist = py{38,39,310,311},lint,docs,mypy,isort,slots
+envlist = py{38,39,310,311,312},lint,docs,mypy,isort,slots
 
 [testenv]
 allowlist_externals = 
@@ -56,4 +56,5 @@ python =
     3.8: py38
     3.9: py39
     3.10: py310
-    3.11: py311, docs, mypy, lint, isort, slots
+    3.11: py311, docs, lint, isort, slots
+    3.12: py312, mypy