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

Improve presentation of errors from subprocesses, during installation #10795

Merged
merged 17 commits into from
Jan 27, 2022

Commits on Jan 25, 2022

  1. Require every call_subprocess call-site to pass command_desc

    This serves as additional context that can be presented in error
    messages.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    531c991 View commit details
    Browse the repository at this point in the history
  2. Improve our setuptools shim

    Modernise the shim, to account for the Python 3.2+ support matrix.
    
    This also presents clearer error messages on failures, the included
    comment helps inform users about why this shim exists and the traceback
    now explicitly mentions `<pip-setuptools-shim>` to make it clearer to
    users that this shim exists.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    7a13f7c View commit details
    Browse the repository at this point in the history
  3. Use logger.warning instead of warnings.warn

    This is more in line with the rest of our output presentation logic.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    57198c6 View commit details
    Browse the repository at this point in the history
  4. Clearly document that exceptions shouldn't import any internals

    This file should be importable in all other modules, which means it
    can't be importing any of those modules (to prevent an import loop).
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    543d0b3 View commit details
    Browse the repository at this point in the history
  5. Improve presentation of LegacyInstallFailure

    These errors now more clearly note where the error occurred and what
    component is at fault.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    2a617d5 View commit details
    Browse the repository at this point in the history
  6. Add diagnostics to InstallationSubprocessError

    This more clearly states where the error came from, presents it in a
    more approachable format with context provided for what this error is
    related to.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    1ee3706 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    d527e85 View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    68e0bd4 View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    1a0193f View commit details
    Browse the repository at this point in the history
  10. Prettify messages for discarding candidates due to issues

    These are more pleasing colours and, more importantly, a clearer
    presentation style of the package vs the error.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    a835e0a View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    eb46274 View commit details
    Browse the repository at this point in the history
  12. Tweak the chattymodule to not leak potentially information

    I'd like to use this in screenshots, but the os.environ makes it a bit
    tricky to do.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    deb2d75 View commit details
    Browse the repository at this point in the history
  13. Sort imports

    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    40bed17 View commit details
    Browse the repository at this point in the history
  14. 📰

    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    ba79b1c View commit details
    Browse the repository at this point in the history
  15. Pacify unit tests

    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    94668c6 View commit details
    Browse the repository at this point in the history
  16. Configuration menu
    Copy the full SHA
    2e8e5ad View commit details
    Browse the repository at this point in the history
  17. Double-escape paths on Windows

    This helps ensure that they aren't improperly handled due to the newer
    string-in-string design for the setuptools invocation script.
    pradyunsg committed Jan 25, 2022
    Configuration menu
    Copy the full SHA
    723b2df View commit details
    Browse the repository at this point in the history