Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add py.typed file #185

Merged
merged 3 commits into from
Nov 10, 2024
Merged

add py.typed file #185

merged 3 commits into from
Nov 10, 2024

Conversation

mgab
Copy link
Contributor

@mgab mgab commented Nov 7, 2024

@liormizr
Copy link
Owner

liormizr commented Nov 9, 2024

Hi @mgab
Thank you for taking this task :-)
2 questions, do we need to add global-include *.typed to the MANIFEST.in file?
second question, I see that the py.typed is empty, are you planning to fill it?

I'm planning to deploy a big version in few days
waiting for your feedback to see if we will include this task

@mgab
Copy link
Contributor Author

mgab commented Nov 10, 2024

do we need to add global-include *.typed to the MANIFEST.in file?

I think it's equivalent to adding it to the package_data parameter in setup.py, but for consistency probably it's better to add it in the MANIFEST.in file instead.

I see that the py.typed is empty, are you planning to fill it?

AFAIU it's supposed to be a marker file that just needs to exist without any expected content. The docs only mention filling it with partial\n if the package provides both inline type hints and stubs.

In any case I'll add a comment just as they do in the mypy package to make clear why it exists

@liormizr
Copy link
Owner

Hi @mgab

Thank you verry much
I approved the PR and it will be part of version 0.6

@liormizr liormizr merged commit 1ff8173 into liormizr:master Nov 10, 2024
5 checks passed
@mgab
Copy link
Contributor Author

mgab commented Nov 10, 2024

Oh, I was just making the changes mentioned (use manifest instead of package_Data, and add a comment in py.typed). Are you interested in them?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add py.typed file to s3path for mypy support
2 participants