Add support for Spyder in tqdm.auto #1559
Open
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
casperdcl
reviewed
Mar 25, 2024
tqdm/autonotebook.py
Outdated
| @@ -21,7 +22,11 @@ | |||
| except Exception: | |||
| from .std import tqdm, trange | |||
| else: # pragma: no cover | |||
| from .notebook import tqdm, trange | |||
| if "SPY_TESTING" in os.environ: | |||
There was a problem hiding this comment.
- is
SPY_TESTINGalways defined inside a spyder environment? - is it fairly plausible for
SPY_TESTINGto be defined outside spyder?
There was a problem hiding this comment.
We have used this approach for many years without any issues. Checking environment variables of the form SPY_XXXX is also suggested in https://stackoverflow.com/questions/53829284/how-to-know-if-a-script-is-running-in-spyder-or-any-other-python-ide.
I will create an issue at the Spyder issue tracker to check this is a good approach.
There was a problem hiding this comment.
@casperdcl I have updated the detection method based on the suggestion by the Spyder devs. See spyder-ide/spyder#21929
casperdcl
added
need-feedback 📢
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.
The Spyder environment console uses IPython, and are therefore recognized by tqdm as notebooks. The progress bar does only work with
tqmd.stdthough. In this PR we detect Spyder and import the correct packages.The reason for making the change here is that with third-party packages we cannot always control whether
tqdmis imported fromauto,autonotebookorstd.An alternative would be to check in
tqdm.autonotebookfor a special environment variable that overrides the automatic detection.