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 Type hints to the codebase #1705

Open
leandrodesouzadev opened this issue Nov 11, 2022 · 9 comments · May be fixed by #1848
Open

Add Type hints to the codebase #1705

leandrodesouzadev opened this issue Nov 11, 2022 · 9 comments · May be fixed by #1848

Comments

@leandrodesouzadev
Copy link
Contributor

Is there any plans to add type hints to the codebase?
As a newcomer to the project, i feel like there's a lot of places that could use type hints to better describe functions.
I'm willing to do the job! 🦾

@tim-schilling
Copy link
Member

I don't have major any qualms against it. I think they're useful for method signatures and class members. However, I'm not committing getting to a point where we are going to say we need type hints on everything.

@tim-schilling
Copy link
Member

@leandrodesouzadev looks like you have the go-ahead on this. I'd suggest doing it piecemeal so you don't end up with too many merge conflicts from long living branches. And so you don't burn yourself out. Thank you!

@leandrodesouzadev
Copy link
Contributor Author

Looks great, baby steps all the way.
Maybe one module per pull request? How that sounds to you?
Monday I will start working on this.

@tim-schilling
Copy link
Member

That sounds good! Let us know if you need any help.

@tim-schilling
Copy link
Member

@leandrodesouzadev circling back to this. How are things going?

@leandrodesouzadev
Copy link
Contributor Author

I haven't touched on the code base for a while now.
I will try to do some other module or two this week and open the pull requests

@ataylor32
Copy link

I would like to see this addressed too. Currently, I'm getting this error with mypy:

error: Skipping analyzing "debug_toolbar": module is installed, but missing library stubs or py.typed marker  [import-untyped]

@tim-schilling
Copy link
Member

@ataylor32 is this something you would have time to help out with?

@ataylor32
Copy link

@tim-schilling Possibly, but I don't have experience with creating stubs. I'll have to look into it.

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 a pull request may close this issue.

3 participants