[internal] Add context manager to handle temporary unfreezing of frozen_after_init objects
#16863
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
…nit` objects # Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels] (cherry picked from commit a6190ec)
chrisjrn
changed the title
frozen_after_init objectsfrozen_after_init objects
chrisjrn
added
the
category:internal
|
This is needed to strip out plugin fields in environments unit tests in order to do equality testing |
Eric-Arellano
approved these changes
Sep 14, 2022
| @@ -125,6 +126,15 @@ def freeze_instance(self) -> None: | |||
| def unfreeze_instance(self) -> None: | |||
| self._is_frozen = False | |||
|
|
|||
| @contextmanager | |||
| def unfrozen(self) -> Iterator: | |||
There was a problem hiding this comment.
Maybe we should name this something like unsafe_unfrozen() or unfrozen_for_tests()? I don't think we want this used in production. While pantsbuild/pants contributors will know better, plugin authors might not.
There was a problem hiding this comment.
It's added as _unfrozen, and you need to do cast(Any, frozen_instance)._unfrozen(), so I don't think there's a good chance that people will find this unless they go looking.
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.
This adds a safer way to temporarily unfreeze
frozen_after_initobjects, for example in tests. The API is not exposed to static typing (just like the existing_unfreeze_instance), but it will re-freeze once finished.