Skip to content
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

Disallow explicitly passing install-location-related arguments in --install-options #8556

Merged
merged 5 commits into from
Jul 10, 2020

Conversation

chrahunt
Copy link
Member

@chrahunt chrahunt commented Jul 7, 2020

This converts our deprecation warning into a hard failure.

Closes #7309.

The current test depends on passing `--home` to `--install-option`.
Since we would like that to fail, we need to use another argument. None
of the other possible arguments have a visible side-effect, so we just
write the provided arguments to a file and check that in the test.
Similar to our previous test refactoring, this removes the usage of
`--home` from the test command.

"Overriding" in the original test meant "placed after" in the
command-line arguments, which makes sense because setuptools will use
the last argument passed.
Since it no longer shows a deprecation warning, the previous name
doesn't fit.
@chrahunt chrahunt changed the title Maint/fail on install location options Disallow explicitly passing install-location-related arguments in --install-options Jul 7, 2020
@chrahunt chrahunt added the type: maintenance Related to Development and Maintenance Processes label Jul 7, 2020
@chrahunt chrahunt marked this pull request as ready for review July 7, 2020 23:56
Copy link
Member

@sbidoul sbidoul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

I recently learned that our deprecated function automatically turns deprecation warnings into exceptions when the pip version is greater than the gone_in version. Not sure in which case it is appropriate to use that mechanism, though.

@chrahunt
Copy link
Member Author

chrahunt commented Jul 8, 2020

I assumed that was to make sure we do not forget to follow through on the warning.

@pradyunsg
Copy link
Member

pradyunsg commented Jul 9, 2020

I assumed that was to make sure we do not forget to follow through on the warning.

Yes! The idea is that if we miss this, the release manager would be running the test suite after bumping the version and we'llccatch the missed-deprecation there. This was something I thought was documented in the release process but isn't! We should fix the docs. :)

@chrahunt chrahunt merged commit e950859 into pypa:master Jul 10, 2020
@chrahunt chrahunt deleted the maint/fail-on-install-location-options branch July 10, 2020 01:25
@chrahunt
Copy link
Member Author

Thank you again for your time! Now hopefully we can clean some stuff up.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: maintenance Related to Development and Maintenance Processes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Disallow explicitly passing install-location-related arguments in --install-options
4 participants