Avoid a global state in utils.builtin_lookup and avoid reinstantiating TransformVisitor
#1563
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
…ing `TransformVisitor` This global state of `utils.builtin_lookup` could be out-of-date if the builtins module had been rebuilt by AstroidManager.clear_cache(). Also, reinstantiating `TransformVisitor` in `clear_cache()` could lead to to diverging registries of transforms.
jacobtylerwalls
commented
May 14, 2022
| @@ -318,7 +318,7 @@ def test_borg(self) -> None: | |||
| self.assertIs(built, second_built) | |||
|
|
|||
|
|
|||
| class ClearCacheTest(unittest.TestCase, resources.AstroidCacheSetupMixin): | |||
| class ClearCacheTest(unittest.TestCase): | |||
There was a problem hiding this comment.
I'd like to get out of the usage of this mixin. I think it masks tests that don't clean up after each other (in this case, the problems were upstream in other tests). We can keep fuzzing to find the problems.
There was a problem hiding this comment.
Thank you for understanding the problem well enough so that we can stop fuzzing around 😄
Pull Request Test Coverage Report for Build 2324393982
💛 - Coveralls |
jacobtylerwalls
commented
May 14, 2022
| self.assertIs(inferred.value, True) | ||
|
|
||
| def test_builtins_inference_after_clearing_cache_manually(self) -> None: | ||
| # Not recommended to manipulate this, so we detect it and call clear_cache() instead |
There was a problem hiding this comment.
In trying to cover the missed lines I just decided to support this, since it's an easy mistake to make.
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.
Description
1
The global state of
utils.builtin_lookup()introduced in #1460 could be stale if the builtins module had been rebuilt byAstroidManager.clear_cache().2
Noticed while testing (necessary to get the tests to pass): reinstantiating
TransformVisitorinclear_cache()could lead to to diverging registries of transforms.The bug from 1 can be reproduced on prior versions by just calling
clear_cacheat the beginning ofTestIsinstanceInference.test_isinstance_int_true. That's a public API, so I added a changelog and an explicit regression test.The bug (2) in
clear_cacheitself was an unreleased issue with my changes in #1528, so I didn't doc it.Type of Changes
Related Issue
Fixes #1559