Generate NEWS

Includes some re-ordering by @pradyunsg
2019-07-22 22:57:57 +05:30 · 2019-07-22 22:57:57 +05:30 · 0e642958ad
parent 0df416d66e
commit 0e642958ad
57 changed files with 85 additions and 70 deletions
--- a/NEWS.rst
+++ b/NEWS.rst
@ -7,6 +7,91 @@

 .. towncrier release notes start

+19.2 (2019-07-22)
+=================
+
+Deprecations and Removals
+-------------------------
+
+- Drop support for EOL Python 3.4. (`#6685 <https://github.com/pypa/pip/issues/6685>`_)
+- Improve deprecation messages to include the version in which the functionality will be removed. (`#6549 <https://github.com/pypa/pip/issues/6549>`_)
+
+Features
+--------
+
+- Credentials will now be loaded using `keyring` when installed. (`#5948 <https://github.com/pypa/pip/issues/5948>`_)
+- Fully support using ``--trusted-host`` inside requirements files. (`#3799 <https://github.com/pypa/pip/issues/3799>`_)
+- Update timestamps in pip's ``--log`` file to include milliseconds. (`#6587 <https://github.com/pypa/pip/issues/6587>`_)
+- Respect whether a file has been marked as "yanked" from a simple repository
+  (see `PEP 592 <https://www.python.org/dev/peps/pep-0592/>`__ for details). (`#6633 <https://github.com/pypa/pip/issues/6633>`_)
+- When choosing candidates to install, prefer candidates with a hash matching
+  one of the user-provided hashes. (`#5874 <https://github.com/pypa/pip/issues/5874>`_)
+- Improve the error message when ``METADATA`` or ``PKG-INFO`` is None when
+  accessing metadata. (`#5082 <https://github.com/pypa/pip/issues/5082>`_)
+- Add a new command ``pip debug`` that can display e.g. the list of compatible
+  tags for the current Python. (`#6638 <https://github.com/pypa/pip/issues/6638>`_)
+- Display hint on installing with --pre when search results include pre-release versions. (`#5169 <https://github.com/pypa/pip/issues/5169>`_)
+- Report to Warehouse that pip is running under CI if the ``PIP_IS_CI`` environment variable is set. (`#5499 <https://github.com/pypa/pip/issues/5499>`_)
+- Allow ``--python-version`` to be passed as a dotted version string (e.g.
+  ``3.7`` or ``3.7.3``). (`#6585 <https://github.com/pypa/pip/issues/6585>`_)
+- Log the final filename and SHA256 of a ``.whl`` file when done building a
+  wheel. (`#5908 <https://github.com/pypa/pip/issues/5908>`_)
+- Include the wheel's tags in the log message explanation when a candidate
+  wheel link is found incompatible. (`#6121 <https://github.com/pypa/pip/issues/6121>`_)
+- Add a ``--path`` argument to ``pip freeze`` to support ``--target``
+  installations. (`#6404 <https://github.com/pypa/pip/issues/6404>`_)
+- Add a ``--path`` argument to ``pip list`` to support ``--target``
+  installations. (`#6551 <https://github.com/pypa/pip/issues/6551>`_)
+
+Bug Fixes
+---------
+
+- Set ``sys.argv[0]`` to the underlying ``setup.py`` when invoking ``setup.py``
+  via the setuptools shim so setuptools doesn't think the path is ``-c``. (`#1890 <https://github.com/pypa/pip/issues/1890>`_)
+- Update ``pip download`` to respect the given ``--python-version`` when checking
+  ``"Requires-Python"``. (`#5369 <https://github.com/pypa/pip/issues/5369>`_)
+- Respect ``--global-option`` and ``--install-option`` when installing from
+  a version control url (e.g. ``git``). (`#5518 <https://github.com/pypa/pip/issues/5518>`_)
+- Make the "ascii" progress bar really be "ascii" and not Unicode. (`#5671 <https://github.com/pypa/pip/issues/5671>`_)
+- Fail elegantly when trying to set an incorrectly formatted key in config. (`#5963 <https://github.com/pypa/pip/issues/5963>`_)
+- Prevent DistutilsOptionError when prefix is indicated in the global environment and `--target` is used. (`#6008 <https://github.com/pypa/pip/issues/6008>`_)
+- Fix ``pip install`` to respect ``--ignore-requires-python`` when evaluating
+  links. (`#6371 <https://github.com/pypa/pip/issues/6371>`_)
+- Fix a debug log message when freezing an editable, non-version controlled
+  requirement. (`#6383 <https://github.com/pypa/pip/issues/6383>`_)
+- Extend to Subversion 1.8+ the behavior of calling Subversion in
+  interactive mode when pip is run interactively. (`#6386 <https://github.com/pypa/pip/issues/6386>`_)
+- Prevent ``pip install <url>`` from permitting directory traversal if e.g.
+  a malicious server sends a ``Content-Disposition`` header with a filename
+  containing ``../`` or ``..\\``. (`#6413 <https://github.com/pypa/pip/issues/6413>`_)
+- Hide passwords in output when using ``--find-links``. (`#6489 <https://github.com/pypa/pip/issues/6489>`_)
+- Include more details in the log message if ``pip freeze`` can't generate a
+  requirement string for a particular distribution. (`#6513 <https://github.com/pypa/pip/issues/6513>`_)
+- Add the line number and file location to the error message when reading an
+  invalid requirements file in certain situations. (`#6527 <https://github.com/pypa/pip/issues/6527>`_)
+- Prefer ``os.confstr`` to ``ctypes`` when extracting glibc version info. (`#6543 <https://github.com/pypa/pip/issues/6543>`_, `#6675 <https://github.com/pypa/pip/issues/6675>`_)
+- Improve error message printed when an invalid editable requirement is provided. (`#6648 <https://github.com/pypa/pip/issues/6648>`_)
+- Improve error message formatting when a command errors out in a subprocess. (`#6651 <https://github.com/pypa/pip/issues/6651>`_)
+
+Vendored Libraries
+------------------
+
+- Upgrade certifi to 2019.6.16
+- Upgrade distlib to 0.2.9.post0
+- Upgrade msgpack to 0.6.1
+- Upgrade requests to 2.22.0
+- Upgrade urllib3 to 1.25.3
+- Patch vendored html5lib, to prefer using `collections.abc` where possible.
+
+Improved Documentation
+----------------------
+
+- Document how Python 2.7 support will be maintained. (`#6726 <https://github.com/pypa/pip/issues/6726>`_)
+- Upgrade Sphinx version used to build documentation. (`#6471 <https://github.com/pypa/pip/issues/6471>`_)
+- Fix generation of subcommand manpages. (`#6724 <https://github.com/pypa/pip/issues/6724>`_)
+- Mention that pip can install from git refs. (`#6512 <https://github.com/pypa/pip/issues/6512>`_)
+- Replace a failing example of pip installs with extras with a working one. (`#4733 <https://github.com/pypa/pip/issues/4733>`_)
+
 19.1.1 (2019-05-06)
 ===================

--- a/news/1234.trivial
+++ b/news/1234.trivial
--- a/news/1890.bugfix
+++ b/news/1890.bugfix
@ -1,2 +0,0 @@
-Set ``sys.argv[0]`` to the underlying ``setup.py`` when invoking ``setup.py``
-via the setuptools shim so setuptools doesn't think the path is ``-c``.
--- a/news/3662.trivial
+++ b/news/3662.trivial
@ -1 +0,0 @@
-Work around an issue with Jython's `re` implementation that resulted in a Java StackOverflowError.
--- a/news/3799.feature
+++ b/news/3799.feature
@ -1 +0,0 @@
-Fully support using ``--trusted-host`` inside requirements files.
--- a/news/4733.doc
+++ b/news/4733.doc
@ -1 +0,0 @@
-Replace a failing example of pip installs with extras with a working one.
--- a/news/5059.trivial
+++ b/news/5059.trivial
--- a/news/5082.feature
+++ b/news/5082.feature
@ -1,2 +0,0 @@
-Improve the error message when ``METADATA`` or ``PKG-INFO`` is None when
-accessing metadata.
--- a/news/5169.feature
+++ b/news/5169.feature
@ -1 +0,0 @@
-Display hint on installing with --pre when search results include pre-release versions.
--- a/news/5369.bugfix
+++ b/news/5369.bugfix
@ -1,2 +0,0 @@
-Update ``pip download`` to respect the given ``--python-version`` when checking
-``"Requires-Python"``.
--- a/news/5499.feature
+++ b/news/5499.feature
@ -1 +0,0 @@
-Report to Warehouse that pip is running under CI if the ``PIP_IS_CI`` environment variable is set.
--- a/news/5518.bugfix
+++ b/news/5518.bugfix
@ -1,2 +0,0 @@
-Respect ``--global-option`` and ``--install-option`` when installing from
-a version control url (e.g. ``git``).
--- a/news/5671.bugfix
+++ b/news/5671.bugfix
@ -1 +0,0 @@
-Make the "ascii" progress bar really be "ascii" and not Unicode.
--- a/news/5874.feature
+++ b/news/5874.feature
@ -1,2 +0,0 @@
-When choosing candidates to install, prefer candidates with a hash matching
-one of the user-provided hashes.
--- a/news/5908.feature
+++ b/news/5908.feature
@ -1,2 +0,0 @@
-Log the final filename and SHA256 of a ``.whl`` file when done building a
-wheel.
--- a/news/5948.feature
+++ b/news/5948.feature
@ -1 +0,0 @@
-Credentials will now be loaded using `keyring` when installed.
--- a/news/5963.bugfix
+++ b/news/5963.bugfix
@ -1 +0,0 @@
-Fail elegantly when trying to set an incorrectly formatted key in config.
--- a/news/6008.bugfix
+++ b/news/6008.bugfix
@ -1 +0,0 @@
-Prevent DistutilsOptionError when prefix is indicated in the global environment and `--target` is used.
--- a/news/6121.feature
+++ b/news/6121.feature
@ -1,2 +0,0 @@
-Include the wheel's tags in the log message explanation when a candidate
-wheel link is found incompatible.
--- a/news/6371.bugfix
+++ b/news/6371.bugfix
@ -1,2 +0,0 @@
-Fix ``pip install`` to respect ``--ignore-requires-python`` when evaluating
-links.
--- a/news/6383.bugfix
+++ b/news/6383.bugfix
@ -1,2 +0,0 @@
-Fix a debug log message when freezing an editable, non-version controlled
-requirement.
--- a/news/6386.bugfix
+++ b/news/6386.bugfix
@ -1,2 +0,0 @@
-Extend to Subversion 1.8+ the behavior of calling Subversion in
-interactive mode when pip is run interactively.
--- a/news/6404.feature
+++ b/news/6404.feature
@ -1,2 +0,0 @@
-Add a ``--path`` argument to ``pip freeze`` to support ``--target``
-installations.
--- a/news/6413.bugfix
+++ b/news/6413.bugfix
@ -1,3 +0,0 @@
-Prevent ``pip install <url>`` from permitting directory traversal if e.g.
-a malicious server sends a ``Content-Disposition`` header with a filename
-containing ``../`` or ``..\\``.
--- a/news/6471.doc
+++ b/news/6471.doc
@ -1 +0,0 @@
-Upgrade Sphinx version used to build documentation.
--- a/news/6486.trivial
+++ b/news/6486.trivial
@ -1 +0,0 @@
-This change will add .DS_Store to .gitignore
--- a/news/6489.bugfix
+++ b/news/6489.bugfix
@ -1 +0,0 @@
-Hide passwords in output when using ``--find-links``.
--- a/news/6512.doc
+++ b/news/6512.doc
@ -1 +0,0 @@
-Mention that pip can install from git refs.
--- a/news/6513.bugfix
+++ b/news/6513.bugfix
@ -1,2 +0,0 @@
-Include more details in the log message if ``pip freeze`` can't generate a
-requirement string for a particular distribution.
--- a/news/6527.bugfix
+++ b/news/6527.bugfix
@ -1,2 +0,0 @@
-Add the line number and file location to the error message when reading an
-invalid requirements file in certain situations.
--- a/news/6533.trivial
+++ b/news/6533.trivial
@ -1 +0,0 @@
-Override the definition of the function was_installed_by_pip (src\pip\_internal\utils\outdated.py) too specific with a more general alternative
--- a/news/6543.bugfix
+++ b/news/6543.bugfix
@ -1 +0,0 @@
-Prefer ``os.confstr`` to ``ctypes`` when extracting glibc version info.
--- a/news/6549.feature
+++ b/news/6549.feature
@ -1 +0,0 @@
-Improve deprecation messages to include the version in which the functionality will be removed.
--- a/news/6551.feature
+++ b/news/6551.feature
@ -1,2 +0,0 @@
-Add a ``--path`` argument to ``pip list`` to support ``--target``
-installations.
--- a/news/6579.trivial
+++ b/news/6579.trivial
@ -1 +0,0 @@
-Link with developer documentation added in .github/CONTRIBUTING.md
--- a/news/6585.feature
+++ b/news/6585.feature
@ -1,2 +0,0 @@
-Allow ``--python-version`` to be passed as a dotted version string (e.g.
-``3.7`` or ``3.7.3``).
--- a/news/6587.feature
+++ b/news/6587.feature
@ -1 +0,0 @@
-Update timestamps in pip's ``--log`` file to include milliseconds.
--- a/news/6633.feature
+++ b/news/6633.feature
@ -1,2 +0,0 @@
-Respect whether a file has been marked as "yanked" from a simple repository
-(see `PEP 592 <https://www.python.org/dev/peps/pep-0592/>`__ for details).
--- a/news/6638.feature
+++ b/news/6638.feature
@ -1,2 +0,0 @@
-Add a new command ``pip debug`` that can display e.g. the list of compatible
-tags for the current Python.
--- a/news/6644.trivial
+++ b/news/6644.trivial
--- a/news/6648.bugfix
+++ b/news/6648.bugfix
@ -1 +0,0 @@
-Improve error message printed when an invalid editable requirement is provided.
--- a/news/6651.bugfix
+++ b/news/6651.bugfix
@ -1 +0,0 @@
-Improve error message formatting when a command errors out in a subprocess.
--- a/news/6659.trivial
+++ b/news/6659.trivial
--- a/news/6675.bugfix
+++ b/news/6675.bugfix
@ -1 +0,0 @@
-Prefer ``os.confstr`` to ``ctypes`` when extracting glibc version info.
--- a/news/6685.removal
+++ b/news/6685.removal
@ -1 +0,0 @@
-Drop support for EOL Python 3.4.
--- a/news/6724.doc
+++ b/news/6724.doc
@ -1 +0,0 @@
-Fix generation of subcommand manpages.
--- a/news/6726.doc
+++ b/news/6726.doc
@ -1 +0,0 @@
-Document how Python 2.7 support will be maintained.
--- a/news/certifi.vendor
+++ b/news/certifi.vendor
@ -1 +0,0 @@
-Upgrade certifi to 2019.6.16
--- a/news/cleanup.trivial
+++ b/news/cleanup.trivial
@ -1,2 +0,0 @@
-Exit conditional sooner if not local_version_is_older for faster execution (src/pip/_internal/utils/outdated.py)
-Moved local and remote pip version check conditional to a variable (src/pip/_internal/utils/outdated.py)
--- a/news/distlib.vendor
+++ b/news/distlib.vendor
@ -1 +0,0 @@
-Upgrade distlib to 0.2.9.post0
--- a/news/git_looks_like_hash.trivial
+++ b/news/git_looks_like_hash.trivial
@ -1 +0,0 @@
-Be stricter in identifying git commit hashes.
--- a/news/html5lib-collections-patch.vendor
+++ b/news/html5lib-collections-patch.vendor
@ -1 +0,0 @@
-Patch vendored html5lib, to prefer using `collections.abc` where possible.
--- a/news/msgpack.vendor
+++ b/news/msgpack.vendor
@ -1 +0,0 @@
-Upgrade msgpack to 0.6.1
--- a/news/pathlib-refactor-1.trivial
+++ b/news/pathlib-refactor-1.trivial
--- a/news/pathlib-refactor-2.trivial
+++ b/news/pathlib-refactor-2.trivial
--- a/news/requests.vendor
+++ b/news/requests.vendor
@ -1 +0,0 @@
-Upgrade requests to 2.22.0
--- a/news/urllib3.vendor
+++ b/news/urllib3.vendor
@ -1 +0,0 @@
-Upgrade urllib3 to 1.25.3
				`@ -1 +0,0 @@`
				Work around an issue with Jython's `re` implementation that resulted in a Java StackOverflowError.
				`@ -1 +0,0 @@`
				Fully support using ``--trusted-host`` inside requirements files.
				`@ -1 +0,0 @@`
				`Replace a failing example of pip installs with extras with a working one.`
				`@ -1 +0,0 @@`
				`Display hint on installing with --pre when search results include pre-release versions.`
				`@ -1 +0,0 @@`
				Report to Warehouse that pip is running under CI if the ``PIP_IS_CI`` environment variable is set.
				`@ -1 +0,0 @@`
				`Make the "ascii" progress bar really be "ascii" and not Unicode.`
				`@ -1 +0,0 @@`
				Credentials will now be loaded using `keyring` when installed.
				`@ -1 +0,0 @@`
				`Fail elegantly when trying to set an incorrectly formatted key in config.`
				`@ -1 +0,0 @@`
				Prevent DistutilsOptionError when prefix is indicated in the global environment and `--target` is used.
				`@ -1 +0,0 @@`
				`Upgrade Sphinx version used to build documentation.`