add typehints and refactor lock objects and add more documentation #496
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.
What do these changes do?
These Changes add better type hints through the entire code and not just places that users have access to but all of it. I also added
__slots__
to try and increase the performance of these locks, As for #468 I did add a todo that this should be investigated otherwise dropped.Edit: I also ran ruff to format everything and I even ran isort as the cherry on top.
Are there changes in behavior for the user?
More functions have been documented and with
__slots__
added should improve the speed of the locks in general. With tests now properly type hinted at it allow for at least some improved readability.Related issue number
Checklist