fix: Simplify logic for Panel.enabled property #1676
Merged
Conversation
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
With this change, having a panel status set in the cookies exits earlier, as it isn't needed to retrieve the Django settings and panel name to calculate the default value.
| def enabled(self): | ||
| def enabled(self) -> bool: | ||
| # The user's cookies should override the default value | ||
| cookie_value = self.toolbar.request.COOKIES.get("djdt" + self.panel_id) |
There was a problem hiding this comment.
If a user has enabled a panel (creating a cookie value of "on"), then changes their settings file to disable it, wouldn't this override the customized settings?
There was a problem hiding this comment.
If I understand correctly, that's the same behavior we have today, as the default value is only used when a cookie value is not found in the request.
This shouldn't change how a panel status is decided, just to return faster when the cookie is set.
There was a problem hiding this comment.
You're correct. DebugToolbar.get_panel_classes is what I was worried about. I wanted to make sure that a developer was still able to stop using a panel even if the cookies are set.
tim-schilling approved these changes Sep 25, 2022
| Thank you for the PR! |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 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.
With this change, having a panel status set in the cookies exits earlier, as it isn't needed to retrieve the Django settings and panel name to calculate the default value.