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 annotations & type checking #78

Open
Mr0grog opened this issue Mar 22, 2021 · 3 comments
Open

Add type annotations & type checking #78

Mr0grog opened this issue Mar 22, 2021 · 3 comments
Labels
code quality help wanted Extra attention is needed
Milestone

Comments

@Mr0grog
Copy link
Member

Mr0grog commented Mar 22, 2021

This is not high priority, but I think it might be useful to add type annotations here. As library, users might appreciate having typing information available (especially now that we have our own return types for everything now, like Memento, rather than returning values directly from requests).

As we add annotations, we should also add type checking to CI, probably with Mypy or Pyright.

@lion-sz
Copy link
Contributor

lion-sz commented Mar 22, 2021

I'm actually interested in this. I've recently looked into mypy for another project of mine but decided against it.
So I'd be interested in implementing / working on the type annotations.

Did you plan on adding the annotations as you go or going through the entire project?

@Mr0grog
Copy link
Member Author

Mr0grog commented Mar 25, 2021

Probably as we go, the rate of code change here isn’t high, but I don’t want to block anything thing on one giant change.

@Mr0grog Mr0grog added this to the v0.5.x milestone Nov 10, 2022
@Mr0grog Mr0grog modified the milestones: v0.5.x, v0.4.x Dec 4, 2023
@Mr0grog
Copy link
Member Author

Mr0grog commented Dec 12, 2023

Quick note here: I've started adding annotations in all new code and am going to try and enforce that on all PRs going forward. I have not added type checking yet (PRs welcome!).

I don't necessarily expect to add types to everything in time for v0.5.0 (shipping this month), but would like to get everything done sometime before spring 2024.

@Mr0grog Mr0grog added the help wanted Extra attention is needed label Dec 12, 2023
@Mr0grog Mr0grog moved this to Backlog in Wayback Roadmap Dec 13, 2023
@Mr0grog Mr0grog moved this from Backlog to Prioritized in Wayback Roadmap Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality help wanted Extra attention is needed
Projects
Status: Prioritized
Development

No branches or pull requests

2 participants