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

Missing py.typed file #38

Open
oliverdain opened this issue Aug 28, 2024 · 9 comments
Open

Missing py.typed file #38

oliverdain opened this issue Aug 28, 2024 · 9 comments

Comments

@oliverdain
Copy link

From a quick look at your source code it looks like the library is thoroughly type hinted. However, mypy complains:

error: Skipping analyzing "qreader": module is installed, but missing library stubs or py.typed marker  [import]
note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports

I think simply including a py.typed file in your project will allow mypy to pay attention to the type hints in your source code.

@Eric-Canas
Copy link
Owner

@jandom

I'm not familiar with the changes you did with typing and mypy. Do you know something about that py.typed?

@oliverdain
Copy link
Author

It's just a marker file that says your code contains type hints. More info here: https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-library-stubs-or-py-typed-marker

@jandom
Copy link
Contributor

jandom commented Sep 7, 2024

hey @Eric-Canas sorry was busy the last week, will take a look now!

@jandom
Copy link
Contributor

jandom commented Sep 7, 2024

Thanks @oliverdain I've added a PR with this fix – good catch!

#40

@jandom
Copy link
Contributor

jandom commented Sep 7, 2024

One small follow-up PR and I think we can close this one #41

@jandom
Copy link
Contributor

jandom commented Sep 9, 2024

@Eric-Canas should we close?

@oliverdain
Copy link
Author

It'd be great if you could push a new release to PyPi before closing.

Thanks!!

@Eric-Canas
Copy link
Owner

Hi! Yes!

I have to test it out and get a bit familiar with the new implementation @jandom before uploading to PiPy. As the current PiPy version is previous to your heavy (and amazing ^~^) refactor, and I want to make 100% sure there there are not any unadvertised breaking changes that could affect current projects.

So that's fine, I'll try to get some time to deeply test it and make sure about that and I'll upload it to PiPy

@jandom
Copy link
Contributor

jandom commented Sep 10, 2024

That makes perfect sense - yeah, those PRs touched a lot of stuff. Hopefully, going forward we can reinforce with many tests to confirm the behavior is unchanged

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

No branches or pull requests

3 participants