⬆️ bump dependencies, add py311 support

Author: ariebovenberg

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,3 +10,8 @@ to make sure you didn't miss anything.
 - [ ] Tests added
 - [ ] Build OK
 - [ ] Added changelog entry (section 'next release')
+- [ ] Bumped version in `pyproject.toml`
+- [ ] Merge PR
+- [ ] Delete branch
+- [ ] Add tag
+- [ ] Publish to PyPI

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v1
@@ -25,6 +25,6 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install tox tox-gh-actions poetry==1.2.2
+        pip install tox tox-gh-actions poetry==1.3.2
     - name: Test with tox
       run: tox

CHANGELOG.rst

@@ -4,6 +4,15 @@ Changelog
 Next release
 ------------
 
+1.0.0 (2023-02-03)
+------------------
+
+- 🦺 First 1.x release. Semantic versioning will be used to
+  indicate potential breaking changes in the future.
+- 🐍 Add official Python 3.11 support.
+- 👌 Simplify name of mypy plugin from ``quacks.mypy`` to ``quacks``.
+  The old name is still accessible for backwards compatibility.
+
 0.2.0 (2022-01-04)
 ------------------
 

README.rst

@@ -41,7 +41,7 @@ your `mypy config file <https://mypy.readthedocs.io/en/latest/config_file.html>`
 .. code-block:: ini
 
    [mypy]
-   plugins = quacks.mypy
+   plugins = quacks
 
 Features
 --------
@@ -76,40 +76,3 @@ reducing readability:
         def name(self) -> str: ...
         @property
         def is_premium(self) -> bool: ...
-
-Partial protocols (work in progress)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-What if you want to reuse parts of a protocol?
-Imagine we have several functions who use various properties of ``User``.
-With partial protocols you can reuse attributes without having to define
-many overlapping protocols.
-Inspired by `clojure spec <https://youtu.be/YR5WdGrpoug?t=1971>`_.
-
-(exact syntax TBD)
-
-.. code-block:: python
-
-    class User(Protocol):
-        id: int
-        name: str
-        is_premium: bool
-        address: Address
-
-    class Address(Protocol):
-        street: str
-        city: str
-        country: str
-
-    from quacks import _
-
-    def determine_discount(u: User[_.id.is_premium]) -> int:
-        ...  # access `id` and `is_premium` attributes
-
-    def greet(u: User[_.name.address[_.country]]) -> None:
-        ...  # access `name` and `address.country` attributes
-
-    u: User = ...
-
-    determine_discount(u)
-    greet(u)

mypy.ini

@@ -11,7 +11,7 @@ warn_unused_ignores = true
 warn_no_return = true
 warn_unreachable = true
 warn_return_any = true
-plugins = quacks.mypy
+plugins = quacks
 
 [mypy-tests.*]
 disallow_untyped_defs = false

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "quacks"
-version = "0.2.0"
+version = "1.0.0"
 description = "Better duck-typing with mypy-compatible extensions to Protocol"
 authors = ["Arie Bovenberg <a.c.bovenberg@gmail.com>"]
 license = "MIT"
@@ -23,6 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
 ]
 
 [tool.poetry.dependencies]
@@ -32,7 +33,7 @@ typing-extensions = ">3.7,<5"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.2.0"
-black = "^22.10"
+black = "^23.1.0"
 mypy = "^0.991"
 pytest-mypy-plugins = "^1.10.1"
 isort = "^5.11.5"

pyproject.toml

@@ -1,5 +1,5 @@
 from typing import _GenericAlias  # type: ignore
-from typing import ClassVar
+from typing import TYPE_CHECKING, ClassVar
 
 from typing_extensions import Protocol
 
@@ -14,6 +14,20 @@
 __all__ = ["readonly"]
 
 
+# The logic below allows the mypy plugin to be exposed at root level,
+# while also ensuring:
+# - mypy doesn't become a runtime dependency
+# - mypy itself is not scanned during type checking
+if not TYPE_CHECKING:  # pragma: no cover
+
+    def __getattr__(name):
+        if name == "plugin":
+            from .mypy import plugin
+
+            return plugin
+        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
 def readonly(cls: type) -> type:
     """Decorate a :class:`~typing.Protocol` to make it read-only.
 

src/quacks/__init__.py

@@ -26,7 +26,6 @@ class C:  # type: ignore
 
 
 def test_protocol_implementation_not_accepted():
-
     with pytest.raises(TypeError, match="Protocol"):
 
         class A(Protocol):

tests/test_readonly.py

@@ -1,6 +1,6 @@
 [tox]
 isolated_build = true
-envlist = py{37,38,39,310},lint,docs,minimal,isort
+envlist = py{37,38,39,310,311},lint,docs,isort
 [testenv]
 allowlist_externals =
   poetry
@@ -10,18 +10,15 @@ commands =
   poetry run pytest {posargs}
 
 [testenv:lint]
-basepython=python3.9
 commands=
   poetry run black --check --diff src/ tests/
   poetry run flake8 src/ tests/
 
 [testenv:isort]
-basepython=python3.9
 commands=
   poetry run isort --check-only --diff src/ tests/
 
 [testenv:docs]
-basepython=python3.9
 commands_pre=pip install .
 deps=
   -rdocs/requirements.txt
@@ -44,5 +41,6 @@ exclude_lines=
 python =
     3.7: py37
     3.8: py38
-    3.9: py39, lint, isort, docs
+    3.9: py39
     3.10: py310
+    3.11: py311, lint, isort, docs