wheerd / multiset / 8575140849

97%

push

github

Support mypy typing (#127)

* Support mypy typing

The big change here is to convert the library from a "single file module"
to a "packages" module. Here there is only only one package and we use an
__init__.py with `from .multiset import *` to continue to allow `from
multiset import Multiset` and similar. As crazy as it sounds I don't think
there's any way to signal to mypy with the py.typed file that the library
has type stubs without restructuring like this.

I also made some small changes to multiset.pyi to bring it in line with what
mypy wants.

A wheel package built with `python -m build` or `python -m build --wheel`
will now create a directory under site-packages containing multiset.py,
multiset.pyi, and py.typed, rather than just putting multiset.py into
site-packages as it did previously. If we publish this on pypi, clients of
the library will be able to use it typed without `type: ignore` comments
and will be able to type their Multisets like this and catch more bugs as
well as not getting told off by mypy:

```
from multiset import Multiset

m = Multiset[int | float] = Multiset([1, 2.2, 9, 33.8])
m1.add("hello")  # mypy says 'Argument 1 to "add" of "Multiset" has incompatible type "str"; expected "int | float"'
```

Cool!

* Update Makefiles with new location of code

---------

Co-authored-by: Manuel Krebber <admin@wheerd.de>

540 of 609 branches covered (88.67%)

1 of 1 new or added line in 1 file covered. (100.0%)

897 of 921 relevant lines covered (97.39%)

3.41 hits per line