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 objects to the python SDK #15

Merged
merged 1 commit into from
Jan 8, 2024

Conversation

vdurmont
Copy link
Contributor

I have no idea if this will work... Any idea on how to test it?

Copy link
Contributor Author

vdurmont commented Dec 20, 2023

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @vdurmont and the rest of your teammates on Graphite Graphite

@vdurmont vdurmont requested review from jklein24, mgorven and a team December 20, 2023 00:17
Copy link
Contributor

@jklein24 jklein24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me, but I know nothing about how this stuff works, so good to wait for @mgorven on this one haha.

@mgorven
Copy link
Contributor

mgorven commented Jan 2, 2024

I'm not familiar with py.typed; what's the goal here?

@jklein24
Copy link
Contributor

jklein24 commented Jan 2, 2024

I'm not familiar with py.typed; what's the goal here?

@mgorven The Ripio folks reported that our SDK isn't marked typed because apparently we need to distribute it with a py.typed file in order for types to be parsed in consuming applications: https://peps.python.org/pep-0561/

@mgorven
Copy link
Contributor

mgorven commented Jan 3, 2024

I think the py.typed file is only needed at the package top level (lightspark/py.typed). The PEP says "This marker applies recursively: if a top-level package includes it, all its sub-packages MUST support type checking as well."

@vdurmont vdurmont force-pushed the 12-19-Add_py.typed_objects_to_the_python_SDK branch from 5de284a to 5f0441c Compare January 8, 2024 17:47
@vdurmont vdurmont requested a review from jklein24 January 8, 2024 17:47
Copy link
Contributor Author

vdurmont commented Jan 8, 2024

Updated the PR to remove useless recursive py.typed files.

@vdurmont vdurmont merged commit a4c16c9 into main Jan 8, 2024
5 checks passed
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.

3 participants