stub-package for python modules or extensions? about stub-package HOT 4 CLOSED

Henry is incorrect there, see for example mypy's test data for stub packages: https://github.com/python/mypy/tree/master/test-data/packages/typedpkg-stubs

The point of the -stubs prefix is that it is meant only for type-checkers, it shouldn't be importable.

from stub-package.

Thank you for the clarification!

from stub-package.

Hi, PEP 561 doesn't support single module packages, see https://peps.python.org/pep-0561/#packaging-type-information

I would recommend putting a folder of the same name of the module that includes either an __init__.pyi or making a separate -stubs package if you are worried about the folder conflicting with the module. Hopefully that makes sense?

from stub-package.

This PEP does not support distributing typing information as part of module-only distributions or single-file modules within namespace packages.
The single-file module should be refactored into a package and indicate that the package supports typing as described above.

Indeed I missed this information.

I would recommend putting a folder of the same name of the module that includes either an init.pyi or making a separate -stubs package if you are worried about the folder conflicting with the module. Hopefully that makes sense?

Makes sense. The package folder with -stubs ending sounds safer.

This works so far for an extension only distribution.

One thing that still bothers me is the naming. According to pypa/distutils#108 (comment) the folder name shoud contain an underscore while the packages and package_data entries should contain dash.

Is this correct?

from stub-package.