Replace typeguard with beartype #685
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
This reverts commit 21c7e32. Signed-off-by: Holger Frydrych <holger.frydrych@tngtech.com>
typeguard was prohibitively slow on large inputs, beartype is significantly faster. However, beartype comes with a caveat in that it does not do deep nested type checks, but instead utilizes randomized sampled testing. As such, this still allows certain misuses of types to go undetected and may not be our final solution. However, in the meantime we deem it is much better to have beartype than not have any type checking taking place. Signed-off-by: Holger Frydrych <holger.frydrych@tngtech.com>
Signed-off-by: Holger Frydrych <holger.frydrych@tngtech.com>
Signed-off-by: Holger Frydrych <holger.frydrych@tngtech.com>
armintaenzertng
requested changes
Jun 1, 2023
There was a problem hiding this comment.
We might want to keep this kind of test so that we retain some control over what the error messages would actually look like. Point in case: The latest typeguard update changed the error message for union types to an incomprehensible multi-liner.
There was a problem hiding this comment.
Unfortunately, beartype error messages are a bit randomized in the order of union types, so this test would need to be done a bit differently. I propose dropping it for now, and if we stick with beartype longer term, we can have a more detailed look into its error messages and add appropriate tests and improvements to them.
Signed-off-by: Holger Frydrych <holger.frydrych@tngtech.com>
armintaenzertng
approved these changes
Jun 1, 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.
As typeguard was found to be too slow for larger input files, this PR replaces it with beartype. beartype is significantly faster and can handle large inputs, however, it comes with a caveat in that it does not do full nested deep type checks, but instead does random sampling in such instances. As such, it can allow certain misuses of types to go undetected, but it will still detect a majority of typical type mistakes. It is most likely better to have beartype than have nothing now even if it ends up not being the final solution to the validation issue.