Warn the user when distutils is present #2256
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
…direct users to the recommended usage. Closes #2230.
webknjaz
reviewed
Jul 12, 2020
| warnings.warn( | ||
| "Distutils was imported before Setuptools. This usage is discouraged " | ||
| "and may exhibit undesirable behaviors or errors. Please use " | ||
| "Setuptools' objects directly or at least import Setuptools first.") |
There was a problem hiding this comment.
@jaraco I'd use stacklevel=3 arg here.
There was a problem hiding this comment.
Yep, I'm seeing the warning come from setuptools, not my own code:
/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/site-packages/setuptools/distutils_patch.py:25: UserWarning: Distutils was imported before Setuptools. This usage is discouraged and may exhibit undesirable behaviors or errors. Please use Setuptools' objects directly or at least import Setuptools first.
I'd actually need stacklevel=4 for it to point to my code:
setup.py:20: UserWarning: Distutils was imported before Setuptools. This usage is discouraged and may exhibit undesirable behaviors or errors. Please use Setuptools' objects directly or at least import Setuptools first.
There was a problem hiding this comment.
Fair enough. I've probably miscalculated the nesting :)
This was referenced Jul 13, 2020
webknjaz
added a commit
to ansible/pylibssh
that referenced
this pull request
Jul 17, 2020
mitya57
added a commit
to retext-project/retext
that referenced
this pull request
Jan 19, 2021
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.
Discourage this usage and direct users to the recommended usage. Closes #2230.
Pull Request Checklist