*.pyi files not included when building a package

[dolfandringa]

I am writing a library/python package which uses some auto generated types generated from google's protobuf types. The google protobuf compiler also provides .pyi stub files for those types, since it uses dark magic to generate the actual classes. I include those in the code of my library, but poetry when building the packages seems to ignore all *.pyi files.

According to the docs https://typing.readthedocs.io/en/latest/guides/libraries.html#providing-type-annotations it should be fine to provide *.pyi type stubs with the code, mixed with inline type hinting for other files, so type checkers understand the types.

I don't want to create a separate stubs package as almost all my code has inline type definitions. Its only in 2 files with auto generated code where i need separatre stub files.

I did a quick test, and if I manually copy the .pyi files to my (poetry) virtual env where I installed the library, then pyright picks up the type definitions just fine. So type checkers behave with a mix of inline type information and stub files just fine, but how do i make sure poetry actually includes the .pyi files?

My library structure:

src
  mypackage
    __init__.py
    py.typed
    profiles.py # <-- inline type info
    io
      __init__.py
      messages.py # <-- the actual python source code that uses some google protobuf magic to create the classes
      messages.pyi  # <-- separate stub file to tell type checkers what classes are generated in messages.py

For some reason the .pyi file is not included in the files produced with poetry build and poetry publish.

[Secrus]

It should be as easy as

[tool.poetry]
include = ["*.pyi"]
# or, if your wheel building process doesn't include the pyi files compilation
include = [
     { path = "*.pyi", format = ["sdist", "wheel"] }
]

[finswimmer]

Hey @dolfandringa,

I cannot reproduce it. *.pyi should be included in sdist and wheel by default. Can you create a github rep with a project where we can reproduce it? Which version of Poetry do you use?

fin swimmer

[dolfandringa]

I didn't add include statements. Should I have? There are very little docs about pyi files on poetry. The only thing I saw in discussions online is that stubs-only package building isn't supported by poetry. I just started the library in question, but can't (yet) share it (although I hope I can convince my company to FOSS it), but making a fake version shouldn't be too hard. Let me try.
Also, I am using poetry 2.0.1.

[dolfandringa]

@finswimmer
Ugh, it turns out I was being stupid, and your request for a minimal example made me realise (I did make one).
It was the version number of the library that was wrong in a pyproject.toml file causing poetry update not to install the latest version of the library, but an older version which didn't include the pyi files yet. I completely went after the red herring of pyright telling me the pyi files were missing and googling that and thinking it had something to do with poetry........

Never contribute to malice (or bad engineering) what can be contributed to stupidity..... Sorry for the noise guys.

Maybe a small sentence somewhere in the docs about pyi files and what is included in built (wheel/sdist) packages (basically everything, also my .proto files are in there) would be nice somewhere, but basically it was just me being stupid. What also fed the red herring was that I did see some discussion on the setuptools repo regarding including pyi files in packages, while this in hindsight obviously "just works" with poetry.