New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Only fail on warnings from Jupyter packages #877
Open
minrk
wants to merge
1
commit into
jupyter-server:main
Choose a base branch
from
minrk:warn-self
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is lazy, but catches packages that start with
jupyter
, which most of ours do. We could focus specifically on this package withjupyter_server
, or explicitly list one or more exact packages we want to be strict withThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I disagree with this approach, as it will mask actual incompatibilities and deprecation warnings. The allowlist is for known warnings that we cannot work around.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be clear: mask actual incompatibilities that may well not be relevant that we cannot control, and that should hopefully be addressed by those packages in a reasonable amount of time.
Surfacing this info is good (warnings already do this), but errors block all progress when nothing's actually broken.
For instance, I can't run the serverapp tests locally because I have pytest-asyncio installed to work with other packages, and it throws a deprecation warning when asyncio_mode is not set. But it's not set because serverapp doesn't even use it, though serverapp's warning policy treats this as a failure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the right solution then is to update the contributing guide to show how to disable warnings (as we do with the minimum version test):
pytest -vv -W default
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, maybe we use something like
pytest -vv -W error
the regular CI tests, and document how to to that locally to reproduce.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think running the prerelease tests with -Werror is a good idea, since it serves a similar purpose: peeking into the future for things that will fail, but haven't yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you like me to take over this PR and update the workflows/docs? I like the idea of preserving the errors for our own warnings, I think we should keep that change.