Add type hints (#562) #581
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As of e0baec2 we no longer test the code for Python < 3.8, so it doesn't make sense to keep "supporting" them
TODO: fix all the type errors later on
|
Awesome! Thank you for the work on this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #562 by adding type hints to the library, dropping Python 3.6 and 3.7 support in the process.
3.6 and 3.7 were recently dropped from the test suite after Github removed them from CICD. It doesn't make sense to claim support for versions we don't test so I dropped them completely.
I've added type hints to pretty much every function. The
Markdownobject should be covered and most of the extras should either be explicitly covered or inferred through the type hints attached to theExtrabase class.All of the public API and a decent amount of the internal functions should be covered. The main gaping hole at the moment is the
extrasdict/param for theMarkdownobject. It's currently annotated asDict[str, any](after it's been massaged in the constructor), which is quite broad. Hopefully this can be improved over time as more extras are converted to the new format and their options can be better documented/annotated.