Protocol intersection for mypy
Project description
typing-protocol-intersection
A tiny Python 3 package providing exactly one class - ProtocolIntersection
(for Protocol
s themselves see PEP 544).
Along with a mypy plugin this class allows to say that a function takes a parameter which implements multiple protocols
or returns an object implementing multiple protocols without explicitly creating a new protocol class that inherits them.
See the examples section below.
Installation
pip install typing-protocol-intersection
Configuration
> cat mypy.ini
[mypy]
plugins = typing_protocol_intersection.mypy_plugin
Examples
Make sure to check the Recommended usage section after you familiarize yourself with the examples.
Simple example
from typing import Protocol
from typing_protocol_intersection import ProtocolIntersection
class HasX(Protocol):
x: str
class HasY(Protocol):
y: str
def foo(xy: ProtocolIntersection[HasX, HasY]) -> None:
print(xy.x, xy.y)
Valid program
Here's a more complex example showing what you can write with the help of this mypy plugin:
from types import SimpleNamespace
from typing import Protocol, Generic, TypeVar, Dict
from typing_protocol_intersection import ProtocolIntersection
class HasX(Protocol):
x: str
class HasY(Protocol):
y: str
T = TypeVar("T")
class Builder(Generic[T]):
def __init__(self) -> None:
super().__init__()
self._d: Dict[str, str] = {}
def with_x(self) -> "Builder[ProtocolIntersection[T, HasX]]":
self._d["x"] = "X"
return self # type: ignore
def with_y(self) -> "Builder[ProtocolIntersection[T, HasY]]":
self._d["y"] = "Y"
return self # type: ignore
def build(self) -> T:
return SimpleNamespace(**self._d) # type: ignore
class DesiredObject(HasX, HasY, Protocol):
pass
def get_x_y_1(o: DesiredObject) -> None:
print(f"{o.x=}; {o.y=}")
def get_x_y_2(o: ProtocolIntersection[HasX, HasY]) -> None:
print(f"{o.x=}; {o.y=}")
def main() -> None:
valid_o = Builder().with_x().with_y().build()
get_x_y_1(valid_o)
get_x_y_2(valid_o)
if __name__ == "__main__":
main()
> # without plugin
> mypy example.py
example.py:18:25: error: "ProtocolIntersection" expects no type arguments, but 2 given [type-arg]
example.py:22:25: error: "ProtocolIntersection" expects no type arguments, but 2 given [type-arg]
example.py:35:18: error: "ProtocolIntersection" expects no type arguments, but 2 given [type-arg]
example.py:36:11: error: "ProtocolIntersection" has no attribute "x" [attr-defined]
example.py:36:11: error: "ProtocolIntersection" has no attribute "y" [attr-defined]
example.py:40:15: error: Argument 1 to "get_x_y_1" has incompatible type "ProtocolIntersection"; expected "DesiredObject" [arg-type]
Found 6 errors in 1 file (checked 1 source file)
> # with plugin
> mypy example.py
Success: no issues found in 1 source file
Invalid program
And here's how would the plugin help if you forgot to include one of the protocols:
from types import SimpleNamespace
from typing import Protocol, Generic, TypeVar, Dict
from typing_protocol_intersection import ProtocolIntersection
class HasX(Protocol):
x: str
class HasY(Protocol):
y: str
T = TypeVar("T")
class Builder(Generic[T]):
def __init__(self) -> None:
super().__init__()
self._d: Dict[str, str] = {}
def with_x(self) -> "Builder[ProtocolIntersection[T, HasX]]":
self._d["x"] = "X"
return self # type: ignore
def with_y(self) -> "Builder[ProtocolIntersection[T, HasY]]":
self._d["y"] = "Y"
return self # type: ignore
def build(self) -> T:
return SimpleNamespace(**self._d) # type: ignore
class DesiredObject(HasX, HasY, Protocol):
pass
def get_x_y_1(o: DesiredObject) -> None:
print(f"{o.x=}; {o.y=}")
def get_x_y_2(o: ProtocolIntersection[HasX, HasY]) -> None:
print(f"{o.x=}; {o.y=}")
def main() -> None:
valid_o = Builder().with_x().build() # <-- note no .with_y()
get_x_y_1(valid_o)
get_x_y_2(valid_o)
if __name__ == "__main__":
main()
> mypy example.py
example.py:40:15: error: Argument 1 to "get_x_y_1" has incompatible type "ProtocolIntersection[HasX]"; expected "DesiredObject" [arg-type]
example.py:40:15: note: "ProtocolIntersection" is missing following "DesiredObject" protocol member:
example.py:40:15: note: y
example.py:41:15: error: Argument 1 to "get_x_y_2" has incompatible type "typing_protocol_intersection.types.ProtocolIntersection[HasX]"; expected "typing_protocol_intersection.types.ProtocolIntersection[HasY, HasX]" [arg-type]
example.py:41:15: note: "ProtocolIntersection" is missing following "ProtocolIntersection" protocol member:
example.py:41:15: note: y
Found 2 errors in 1 file (checked 1 source file)
Recommended usage
The ProtocolIntersection
class name might seem a bit lengthy, but it's explicit, which is good.
For brevity and better readability, it's recommended to use an alias when importing.
from typing_protocol_intersection import ProtocolIntersection as Has
The simple example would translate to
from typing import Protocol
from typing_protocol_intersection import ProtocolIntersection as Has
class X(Protocol):
x: str
class Y(Protocol):
y: str
def foo(xy: Has[X, Y]) -> None:
print(xy.x, xy.y)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for typing-protocol-intersection-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d6e3921d6d93709c5134a4deaedae38dd4b10b8b6c5f2eab24a5685a431581a |
|
MD5 | 458d71714cdfc433535dad7457c9f0fc |
|
BLAKE2b-256 | 94c9a98fbc558c699abb82b33c0d482f621582bfa35b8626a9569d6fdc674c60 |
Hashes for typing_protocol_intersection-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59b8e16338727909c5a87fc509125027c43aa6ebf0a0e7a1be9106adca3dc537 |
|
MD5 | 98decca1dd693fb49e8926093c072b30 |
|
BLAKE2b-256 | d5a9d395906660c445a20d89d984d28388b36f9a6548b461ed98b74ab9f272e2 |