Add py.typed file

[ljodal]

This is needed for mypy to read the type signatures defined in the project, ref https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages

There's also a note about needing zip_safe=False, but I'm not to familiar with setuptools so I didn't want to add that unless it's strictly required.

[dlech]

Thanks! Could you also add a changelog entry?

There's also a note about needing zip_safe=False, but I'm not to familiar with setuptools so I didn't want to add that unless it's strictly required.

To test this, you could run python setup.py sdist bdist_wheel (in an environment with setuptools and wheel packages installed) and inspect the resulting files.

[ljodal]

Thanks for the quick feedback! Wasn't sure if this was big enough to warrant a changelog entry, but I'll get that fixed and check the zip_safe flag over the weekend :)

[ljodal]

Hey, sorry about the late follow up here. I researched the zip_safe flag and it seems to only be relevant for .egg distraction, which from what I understood is deprecated anyway. Looking into the PRs when the warning was added to mypy it seems like it's not a common issue, so I'm inclined skip that bit. Does that seem reasonable?

[dlech]

As long as the empty py.typed file ends up in the binary wheel, it's fine with me. 😄

[ljodal]

It does, running python setup.py sdist bdist_wheel it gets included in both the .whl and .tar.gz files :) I'll add a changelog entry and leave it at that.

Note that the typing experience with bleak isn't perfect after this, as noted in #822. At least in strict mode mypy will still complain:

scanner.py:5: error: Module "bleak" does not explicitly export attribute "BleakClient"; implicit reexport disabled  [attr-defined]
scanner.py:5: error: Module "bleak" does not explicitly export attribute "BleakScanner"; implicit reexport disabled  [attr-defined]

[dlech]

Thanks!

[dlech]

Note that the typing experience with bleak isn't perfect after this, as noted in #822. At least in strict mode mypy will still complain:

scanner.py:5: error: Module "bleak" does not explicitly export attribute "BleakClient"; implicit reexport disabled  [attr-defined]
scanner.py:5: error: Module "bleak" does not explicitly export attribute "BleakScanner"; implicit reexport disabled  [attr-defined]

Another related discussion on these two types in particular is #582. It is a rather large chore, but would be nice for consuming the API with static analysis tools like mypy and pyright.

[ljodal]

Yeah, I saw that issue and completely agree :)