Re: [PATCH 01/11] python: expose typing information via PEP 561

[John Snow]

On Mon, Jun 28, 2021 at 4:12 PM Wainer dos Santos Moschetta <wainersm@redhat.com> wrote:

Hi,

On 6/25/21 12:45 PM, John Snow wrote:
> https://www.python.org/dev/peps/pep-0561/#specification
> Create 'py.typed' files in each subpackage that indicate to mypy that
> this is a typed module, so that users of any of these packages can use
> mypy to check their code as well.
>
> Note: Theoretically it's possible to ditch MANIFEST.in in favor of using
> package_data in setup.cfg, but I genuinely could not figure out how to
> get it to include things from the *source root* into the *package root*;
> only how to include things from each subpackage. I tried!
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   python/qemu/machine/py.typed | 0
>   python/qemu/qmp/py.typed     | 0
>   python/qemu/utils/py.typed   | 0
>   python/setup.cfg             | 4 ++++
>   4 files changed, 4 insertions(+)
>   create mode 100644 python/qemu/machine/py.typed
>   create mode 100644 python/qemu/qmp/py.typed
>   create mode 100644 python/qemu/utils/py.typed

Just double-checking that you did not add a single py.typed on the root
"python" dir, so that all modules inherit from it, because this is a
namespace package. Right?

Yes, that's right. Each sub-package here can technically be typed or not independently from one another, even though the packaging script I have written at the moment will bundle all three of these packages together. Complying with PEP 561 requires package-level information.

(So far as I am aware at-present, anyway.)

 

Anyway,

Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>

Thanks!

--js