Type hints

[aucampia]

boltons have some nice functionality but it would be very handy if it also had type hints. From #318 it seems you are open to type hints, but I just want to confirm this, and check if you have any specific preferences for how they should be added.

From what I gather from the linked issue:

• You prefer type hints in .py files (i.e. embedded) as opposed to having them in separate .pyi files
• You want validation in CI

Is there any thing more I should consider before working on it?

[mahmoud]

Hey Iwan! Thanks for your interest and I'm glad you asked. Actually since going 3.7+, yes, I think the answer here has gotten a lot simpler: Type hints welcome, annotations preferred, no comments / .pyi necessary.

Other than that, I'd request smaller PRs preferred, starting with the functions/types that are least ambiguous to type or that you feel most comfortable typing. :) Also on the docket, if you're typing a signature that involves a **kwargs, feel free to convert it to * kw-only args. :)

Looking forward to seeing what you come up with!

[Avasam]

I feel like a first good step is getting on-par with typeshed. I did so in #382 (may have to split up per-module if you want small PRs).

Just that would be enough to declare yourself typed (whilst not fully, so aren't the stubs) and for contributors to come here instead of https://github.com/python/typeshed/tree/main/stubs/boltons

Then enabling type-checking tests (mypy, pyright) and best-practices (a few Ruff lint groups [F404, FA, PYI, UP] or pyupgrade + flake8-future-annotations)