You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the internal APIs for better or worse there are a lot of abstract classes. This can result in code being hard to understand unless you know there is a method being overriden.
This PR adds an @abstractmethod and @override decorators for documentation purposes (think of them as similar to adding a comment that a method is abstract or is overriding something. The override(cls) decorator also checks that the target class actually has the method to help catch simple mistakes.
Also, it moves around methods around to more consistently order by {overrides, abstract methods, private methods} for readability
This file contains hidden or 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
tests-okThe tagger certifies test failures are unrelated and assumes personal liability.
4 participants
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?
In the internal APIs for better or worse there are a lot of abstract classes. This can result in code being hard to understand unless you know there is a method being overriden.
This PR adds an
@abstractmethodand@overridedecorators for documentation purposes (think of them as similar to adding a comment that a method is abstract or is overriding something. Theoverride(cls)decorator also checks that the target class actually has the method to help catch simple mistakes.Also, it moves around methods around to more consistently order by {overrides, abstract methods, private methods} for readability