Add a py.typed file to expose type annotations

minio / minio-py

MinIO Client SDK for Python

https://docs.min.io/docs/python-client-quickstart-guide.html

Apache License 2.0

822 stars 318 forks source link

Add a py.typed file to expose type annotations #1320

Closed brianhelba closed 9 months ago

brianhelba commented 11 months ago

See: https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/

trim21 commented 10 months ago

should we add this file after package is fully typed？

brianhelba commented 10 months ago

I think it'd be beneficial to add now, so downstream packages can start to use the annotations which already exist. Anything without an annotation will just default to Any, which is what happens right now (without py.typed).

I think enabling this might actually help to encourage community contributions to help get this package fully typed, since downstream users will want to add annotations to the APIs which they use.

balamurugana commented 9 months ago

Refer https://github.com/minio/minio-py/pull/1376