Update blacklist and whitelist keywords
#1367
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
|
|
martinRenou
reviewed
Aug 2, 2023
| @@ -10,6 +10,9 @@ | |||
| from ._version import __version__ # noqa | |||
| from .server_extension import _load_jupyter_server_extension # noqa | |||
| from .server_extension import load_jupyter_server_extension # noqa | |||
| import warnings | |||
|
|
|||
| warnings.filterwarnings("default", category=DeprecationWarning, module="traitlets") | |||
There was a problem hiding this comment.
Mmmh, Maybe we should not do that and fix the deprecation warnings instead?
There was a problem hiding this comment.
Nope, the DeprecationWarning is hidden by default https://docs.python.org/3/library/exceptions.html#DeprecationWarning
Comment on lines
+68
to
+82
| file_whitelist = List( | ||
| Unicode(), | ||
| [r".*\.(png|jpg|gif|svg)"], | ||
| config=True, | ||
| help="""Deprecated, use `file_allowlist`""", | ||
| ) | ||
|
|
||
| @validate("file_whitelist") | ||
| def _valid_file_whitelist(self, proposal): | ||
| warn( | ||
| "Deprecated, use VoilaConfiguration.file_allowlist instead.", | ||
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
| return proposal["value"] |
There was a problem hiding this comment.
May I suggest another approach for this?
@property
def file_whitelist(self):
warn(
"Deprecated, use VoilaConfiguration.file_allowlist instead.",
DeprecationWarning,
stacklevel=2,
)
return self.file_allowlist
@file_whitelist.setter
def file_whitelist(self, value):
warn(
"Deprecated, use VoilaConfiguration.file_allowlist instead.",
DeprecationWarning,
stacklevel=2,
)
self.file_allowlist = valueThat way we can get rid of the
warnings.filterwarnings("default", category=DeprecationWarning, module="traitlets")?
There was a problem hiding this comment.
My suggestion applies if we consider going from a traitlet to a property is not backward incompatible
There was a problem hiding this comment.
By doing so, users can not set the allow/deny list from the CLI or the voila.json file
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.
References
Closes #1366
Code changes
User-facing changes
blacklistare replaced bydenylistwhitelistare replaced byallowlistDeprecationWarningmessage is raised on using the old keywords.Backwards-incompatible changes
N/A