feat: add type hints #161
Merged
feat: add type hints #161
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
noahgorstein
force-pushed
the
feature/type-hints
branch
from
6f42f95
to
d82a4ad
Compare
scardena
approved these changes
Jul 12, 2023
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.
Overview
This PR adds type hints to majority of the code (not including tests) in pystardog. Type hints have several benefits - too many to add here but namely they can aid static analysis (e.g.
mypy) of the code and make the code self-documenting. Type hints also aid many IDE's autocomplete support. I think this addition will make this library a bit more friendly to consumers.Sphinx Autodoc Type Hints
This PR also leverages type hints for documentation purposes. Using an extension (sphinx-autodoc-typehints), we can actually generate parameter/return types without needing to explicitly document them in the docstring. See https://github.com/stardog-union/pystardog/tree/feature/type-hints#autodoc-type-hints for additional information.
I have rewritten/restructured a lot of docstrings in the repository such that they can leverage the newly added typehints as well.