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

TYP: annotation of __init__ return type (PEP 484) (pandas/utils) #46276

Merged
merged 2 commits into from
Mar 16, 2022

Conversation

nafarya
Copy link
Contributor

@nafarya nafarya commented Mar 8, 2022

According to documentation pandas uses PEP484 for type hints.
PEP484 states that __init__ function should have -> None return type annotation.
In this PR I added return type annotation to __init__ functions in pandas/utils module.
Thanks!

@NickCrews
Copy link
Contributor

@nafarya Hi! Thanks for this! I'm wondering if there is a way to configure our code checks so that this is caught automatically? ie can black or flake8 somehow catch this? That seems like the golden standard, if possible, so that the entire codebase is consistent.

@nafarya
Copy link
Contributor Author

nafarya commented Mar 8, 2022

@nafarya Hi! Thanks for this! I'm wondering if there is a way to configure our code checks so that this is caught automatically? ie can black or flake8 somehow catch this? That seems like the golden standard, if possible, so that the entire codebase is consistent.

Hi! Thats great idea and I think it should be possible! Maybe it could be done the same way as you check for PEP 8: via https://github.com/pep8speaks

@NickCrews
Copy link
Contributor

Floated the idea to black here: psf/black#2913

@phofl
Copy link
Member

phofl commented Mar 9, 2022

Please wait for #46283 (comment)

@jreback jreback added this to the 1.5 milestone Mar 16, 2022
@jreback jreback added the Typing type annotations, mypy/pyright type checking label Mar 16, 2022
@jreback jreback merged commit e12d4ec into pandas-dev:main Mar 16, 2022
@jreback
Copy link
Contributor

jreback commented Mar 16, 2022

thanks @nafarya

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Typing type annotations, mypy/pyright type checking
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants