From 19177fbd5d6d9b29ccc302d65f9d9417ece082ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Wirtel?= Date: Tue, 15 May 2018 20:58:35 +0200 Subject: [PATCH] bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814) --- Doc/distributing/index.rst | 2 +- Doc/distutils/apiref.rst | 2 +- Doc/distutils/packageindex.rst | 2 +- Doc/distutils/setupscript.rst | 2 +- Doc/faq/general.rst | 2 +- Doc/faq/library.rst | 4 ++-- Doc/howto/curses.rst | 6 +++--- Doc/howto/pyporting.rst | 14 ++++++------- Doc/installing/index.rst | 2 +- Doc/library/distribution.rst | 2 +- Doc/library/index.rst | 2 +- Doc/library/pprint.rst | 20 +++++++++---------- Doc/library/re.rst | 2 +- Doc/library/ssl.rst | 4 ++-- Doc/library/unittest.mock.rst | 4 ++-- Doc/library/xml.rst | 4 ++-- Doc/tutorial/venv.rst | 2 +- Doc/tutorial/whatnow.rst | 2 +- Doc/using/windows.rst | 2 +- Doc/whatsnew/2.3.rst | 2 +- Doc/whatsnew/2.5.rst | 2 +- Doc/whatsnew/2.7.rst | 2 +- Doc/whatsnew/3.5.rst | 2 +- .../2018-05-14-20-08-58.bpo-33503.Wvt0qg.rst | 1 + 24 files changed, 45 insertions(+), 44 deletions(-) create mode 100644 Misc/NEWS.d/next/Documentation/2018-05-14-20-08-58.bpo-33503.Wvt0qg.rst diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index aedbe712d3d..5dd14b1f7a6 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -31,7 +31,7 @@ installing other Python projects, refer to the Key terms ========= -* the `Python Packaging Index `__ is a public +* the `Python Packaging Index `__ is a public repository of open source licensed packages made available for use by other Python users * the `Python Packaging Authority diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst index 9fce46ad266..3c89468220a 100644 --- a/Doc/distutils/apiref.rst +++ b/Doc/distutils/apiref.rst @@ -78,7 +78,7 @@ setup script). Indirectly provides the :class:`distutils.dist.Distribution` and | | be built | :class:`distutils.core.Extension` | +--------------------+--------------------------------+-------------------------------------------------------------+ | *classifiers* | A list of categories for the | a list of strings; valid classifiers are listed on `PyPI | - | | package | `_. | + | | package | `_. | +--------------------+--------------------------------+-------------------------------------------------------------+ | *distclass* | the :class:`Distribution` | a subclass of | | | class to use | :class:`distutils.core.Distribution` | diff --git a/Doc/distutils/packageindex.rst b/Doc/distutils/packageindex.rst index 086e14eb255..50cb74f2b6c 100644 --- a/Doc/distutils/packageindex.rst +++ b/Doc/distutils/packageindex.rst @@ -250,4 +250,4 @@ without warnings does not guarantee that PyPI will convert the content successfully. -.. _Python Package Index (PyPI): https://pypi.python.org/pypi +.. _Python Package Index (PyPI): https://pypi.org diff --git a/Doc/distutils/setupscript.rst b/Doc/distutils/setupscript.rst index 952607a4073..1d96acbe98f 100644 --- a/Doc/distutils/setupscript.rst +++ b/Doc/distutils/setupscript.rst @@ -625,7 +625,7 @@ Notes: (7) The valid classifiers are listed on - `PyPI `_. + `PyPI `_. (8) To preserve backward compatibility, this field also accepts a string. If diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index 0d1cb198da8..9d3e199fca6 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -117,7 +117,7 @@ programming), software engineering (unit testing, logging, profiling, parsing Python code), and operating system interfaces (system calls, filesystems, TCP/IP sockets). Look at the table of contents for :ref:`library-index` to get an idea of what's available. A wide variety of third-party extensions are also -available. Consult `the Python Package Index `_ to +available. Consult `the Python Package Index `_ to find packages of interest to you. diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst index aec4bf9b85d..ab92a879a88 100644 --- a/Doc/faq/library.rst +++ b/Doc/faq/library.rst @@ -19,7 +19,7 @@ standard library module. (Eventually you'll learn what's in the standard library and will be able to skip this step.) For third-party packages, search the `Python Package Index -`_ or try `Google `_ or +`_ or try `Google `_ or another Web search engine. Searching for "Python" plus a keyword or two for your topic of interest will usually find something helpful. @@ -611,7 +611,7 @@ use ``p.read(n)``. "expect" library. A Python extension that interfaces to expect is called "expy" and available from http://expectpy.sourceforge.net. A pure Python solution that works like expect is `pexpect - `_. + `_. How do I access the serial (RS232) port? diff --git a/Doc/howto/curses.rst b/Doc/howto/curses.rst index 19d65d6996b..cc4b4785b12 100644 --- a/Doc/howto/curses.rst +++ b/Doc/howto/curses.rst @@ -41,7 +41,7 @@ appearance---and the curses library will figure out what control codes need to be sent to the terminal to produce the right output. curses doesn't provide many user-interface concepts such as buttons, checkboxes, or dialogs; if you need such features, consider a user interface library such as -`Urwid `_. +`Urwid `_. The curses library was originally written for BSD Unix; the later System V versions of Unix from AT&T added many enhancements and new functions. BSD curses @@ -55,7 +55,7 @@ everything, though. The Windows version of Python doesn't include the :mod:`curses` module. A ported version called `UniCurses -`_ is available. You could +`_ is available. You could also try `the Console module `_ written by Fredrik Lundh, which doesn't use the same API as curses but provides cursor-addressable text output @@ -432,7 +432,7 @@ User Input The C curses library offers only very simple input mechanisms. Python's :mod:`curses` module adds a basic text-input widget. (Other libraries -such as `Urwid `_ have more extensive +such as `Urwid `_ have more extensive collections of widgets.) There are two methods for getting input from a window: diff --git a/Doc/howto/pyporting.rst b/Doc/howto/pyporting.rst index 98c81206741..3be6bb380d6 100644 --- a/Doc/howto/pyporting.rst +++ b/Doc/howto/pyporting.rst @@ -427,25 +427,25 @@ to make sure everything functions as expected in both versions of Python. .. _2to3: https://docs.python.org/3/library/2to3.html -.. _caniusepython3: https://pypi.python.org/pypi/caniusepython3 +.. _caniusepython3: https://pypi.org/project/caniusepython3 .. _cheat sheet: http://python-future.org/compatible_idioms.html -.. _coverage.py: https://pypi.python.org/pypi/coverage +.. _coverage.py: https://pypi.org/project/coverage .. _Futurize: http://python-future.org/automatic_conversion.html .. _importlib: https://docs.python.org/3/library/importlib.html#module-importlib -.. _importlib2: https://pypi.python.org/pypi/importlib2 +.. _importlib2: https://pypi.org/project/importlib2 .. _Modernize: https://python-modernize.readthedocs.io/ .. _mypy: http://mypy-lang.org/ .. _Porting to Python 3: http://python3porting.com/ -.. _Pylint: https://pypi.python.org/pypi/pylint +.. _Pylint: https://pypi.org/project/pylint .. _Python 3 Q & A: https://ncoghlan-devs-python-notes.readthedocs.io/en/latest/python3/questions_and_answers.html .. _pytype: https://github.com/google/pytype .. _python-future: http://python-future.org/ .. _python-porting: https://mail.python.org/mailman/listinfo/python-porting -.. _six: https://pypi.python.org/pypi/six -.. _tox: https://pypi.python.org/pypi/tox -.. _trove classifier: https://pypi.python.org/pypi?%3Aaction=list_classifiers +.. _six: https://pypi.org/project/six +.. _tox: https://pypi.org/project/tox +.. _trove classifier: https://pypi.org/classifiers .. _"What's New": https://docs.python.org/3/whatsnew/index.html diff --git a/Doc/installing/index.rst b/Doc/installing/index.rst index 9f9f5a070b2..8f105a15161 100644 --- a/Doc/installing/index.rst +++ b/Doc/installing/index.rst @@ -44,7 +44,7 @@ Key terms ``venv``. It allows virtual environments to be used on versions of Python prior to 3.4, which either don't provide ``venv`` at all, or aren't able to automatically install ``pip`` into created environments. -* The `Python Packaging Index `__ is a public +* The `Python Packaging Index `__ is a public repository of open source licensed packages made available for use by other Python users. * the `Python Packaging Authority diff --git a/Doc/library/distribution.rst b/Doc/library/distribution.rst index 3e6e84b42a2..8d4befe41b3 100644 --- a/Doc/library/distribution.rst +++ b/Doc/library/distribution.rst @@ -4,7 +4,7 @@ Software Packaging and Distribution These libraries help you with publishing and installing Python software. While these modules are designed to work in conjunction with the -`Python Package Index `__, they can also be used +`Python Package Index `__, they can also be used with a local index server, or without any index server at all. .. toctree:: diff --git a/Doc/library/index.rst b/Doc/library/index.rst index da6a460e2c3..b8fbf44ae49 100644 --- a/Doc/library/index.rst +++ b/Doc/library/index.rst @@ -30,7 +30,7 @@ optional components. In addition to the standard library, there is a growing collection of several thousand components (from individual programs and modules to packages and entire application development frameworks), available from -the `Python Package Index `_. +the `Python Package Index `_. .. toctree:: diff --git a/Doc/library/pprint.rst b/Doc/library/pprint.rst index 65d94fe386c..aa97d3eabaf 100644 --- a/Doc/library/pprint.rst +++ b/Doc/library/pprint.rst @@ -212,12 +212,12 @@ Example ------- To demonstrate several uses of the :func:`pprint` function and its parameters, -let's fetch information about a project from `PyPI `_:: +let's fetch information about a project from `PyPI `_:: >>> import json >>> import pprint >>> from urllib.request import urlopen - >>> with urlopen('http://pypi.python.org/pypi/Twisted/json') as url: + >>> with urlopen('http://pypi.org/project/Twisted/json') as url: ... http_info = url.info() ... raw_data = url.read().decode(http_info.get_content_charset()) >>> project_info = json.loads(raw_data) @@ -248,9 +248,9 @@ In its basic form, :func:`pprint` shows the whole object:: 'maintainer': '', 'maintainer_email': '', 'name': 'Twisted', - 'package_url': 'http://pypi.python.org/pypi/Twisted', + 'package_url': 'http://pypi.org/project/Twisted', 'platform': 'UNKNOWN', - 'release_url': 'http://pypi.python.org/pypi/Twisted/12.3.0', + 'release_url': 'http://pypi.org/project/Twisted/12.3.0', 'requires_python': None, 'stable_version': None, 'summary': 'An asynchronous networking framework written in Python', @@ -264,7 +264,7 @@ In its basic form, :func:`pprint` shows the whole object:: 'python_version': 'source', 'size': 2615733, 'upload_time': '2012-12-26T12:47:03', - 'url': 'https://pypi.python.org/packages/source/T/Twisted/Twisted-12.3.0.tar.bz2'}, + 'url': 'https://pypi.org/packages/source/T/Twisted/Twisted-12.3.0.tar.bz2'}, {'comment_text': '', 'downloads': 5224, 'filename': 'Twisted-12.3.0.win32-py2.7.msi', @@ -274,7 +274,7 @@ In its basic form, :func:`pprint` shows the whole object:: 'python_version': '2.7', 'size': 2916352, 'upload_time': '2012-12-26T12:48:15', - 'url': 'https://pypi.python.org/packages/2.7/T/Twisted/Twisted-12.3.0.win32-py2.7.msi'}]} + 'url': 'https://pypi.org/packages/2.7/T/Twisted/Twisted-12.3.0.win32-py2.7.msi'}]} The result can be limited to a certain *depth* (ellipsis is used for deeper contents):: @@ -301,9 +301,9 @@ contents):: 'maintainer': '', 'maintainer_email': '', 'name': 'Twisted', - 'package_url': 'http://pypi.python.org/pypi/Twisted', + 'package_url': 'http://pypi.org/project/Twisted', 'platform': 'UNKNOWN', - 'release_url': 'http://pypi.python.org/pypi/Twisted/12.3.0', + 'release_url': 'http://pypi.org/project/Twisted/12.3.0', 'requires_python': None, 'stable_version': None, 'summary': 'An asynchronous networking framework written in Python', @@ -339,9 +339,9 @@ cannot be split, the specified width will be exceeded:: 'maintainer': '', 'maintainer_email': '', 'name': 'Twisted', - 'package_url': 'http://pypi.python.org/pypi/Twisted', + 'package_url': 'http://pypi.org/project/Twisted', 'platform': 'UNKNOWN', - 'release_url': 'http://pypi.python.org/pypi/Twisted/12.3.0', + 'release_url': 'http://pypi.org/project/Twisted/12.3.0', 'requires_python': None, 'stable_version': None, 'summary': 'An asynchronous networking ' diff --git a/Doc/library/re.rst b/Doc/library/re.rst index ddb74f8d386..b5a88834599 100644 --- a/Doc/library/re.rst +++ b/Doc/library/re.rst @@ -45,7 +45,7 @@ fine-tuning parameters. .. seealso:: - The third-party `regex `_ module, + The third-party `regex `_ module, which has an API compatible with the standard library :mod:`re` module, but offers additional functionality and a more thorough Unicode support. diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 8082a383d5a..f96549427af 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -2158,9 +2158,9 @@ Visual inspection shows that the certificate does identify the desired service (('commonName', 'www.python.org'),)), 'subjectAltName': (('DNS', 'www.python.org'), ('DNS', 'python.org'), - ('DNS', 'pypi.python.org'), + ('DNS', 'pypi.org'), ('DNS', 'docs.python.org'), - ('DNS', 'testpypi.python.org'), + ('DNS', 'testpypi.org'), ('DNS', 'bugs.python.org'), ('DNS', 'wiki.python.org'), ('DNS', 'hg.python.org'), diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst index ac9dd3b6f79..bb647bb6a81 100644 --- a/Doc/library/unittest.mock.rst +++ b/Doc/library/unittest.mock.rst @@ -35,7 +35,7 @@ is based on the 'action -> assertion' pattern instead of 'record -> replay' used by many mocking frameworks. There is a backport of :mod:`unittest.mock` for earlier versions of Python, -available as `mock on PyPI `_. +available as `mock on PyPI `_. Quick Guide @@ -2085,7 +2085,7 @@ mock_open the start. If you need more control over the data that you are feeding to the tested code you will need to customize this mock for yourself. When that is insufficient, one of the in-memory filesystem packages on `PyPI - `_ can offer a realistic filesystem for testing. + `_ can offer a realistic filesystem for testing. .. versionchanged:: 3.4 Added :meth:`~io.IOBase.readline` and :meth:`~io.IOBase.readlines` support. diff --git a/Doc/library/xml.rst b/Doc/library/xml.rst index d833b7fe997..63c24f80ac8 100644 --- a/Doc/library/xml.rst +++ b/Doc/library/xml.rst @@ -130,8 +130,8 @@ but will not be included in any bugfix releases of Python because they break backward compatibility. -.. _defusedxml: https://pypi.python.org/pypi/defusedxml/ -.. _defusedexpat: https://pypi.python.org/pypi/defusedexpat/ +.. _defusedxml: https://pypi.org/project/defusedxml/ +.. _defusedexpat: https://pypi.org/project/defusedexpat/ .. _Billion Laughs: https://en.wikipedia.org/wiki/Billion_laughs .. _ZIP bomb: https://en.wikipedia.org/wiki/Zip_bomb .. _DTD: https://en.wikipedia.org/wiki/Document_type_definition diff --git a/Doc/tutorial/venv.rst b/Doc/tutorial/venv.rst index e2dd57d48f2..dc4136e42a8 100644 --- a/Doc/tutorial/venv.rst +++ b/Doc/tutorial/venv.rst @@ -88,7 +88,7 @@ Managing Packages with pip You can install, upgrade, and remove packages using a program called :program:`pip`. By default ``pip`` will install packages from the Python -Package Index, . You can browse the Python +Package Index, . You can browse the Python Package Index by going to it in your web browser, or you can use ``pip``'s limited search feature: diff --git a/Doc/tutorial/whatnow.rst b/Doc/tutorial/whatnow.rst index 1ea22ae5cdc..d876d0740d8 100644 --- a/Doc/tutorial/whatnow.rst +++ b/Doc/tutorial/whatnow.rst @@ -38,7 +38,7 @@ More Python resources: * https://docs.python.org: Fast access to Python's documentation. -* https://pypi.python.org/pypi: The Python Package Index, previously also nicknamed +* https://pypi.org: The Python Package Index, previously also nicknamed the Cheese Shop, is an index of user-created Python modules that are available for download. Once you begin releasing code, you can register it here so that others can find it. diff --git a/Doc/using/windows.rst b/Doc/using/windows.rst index 3bab6fe503c..5cbf13f5108 100644 --- a/Doc/using/windows.rst +++ b/Doc/using/windows.rst @@ -848,7 +848,7 @@ The Windows-specific standard modules are documented in PyWin32 ------- -The `PyWin32 `_ module by Mark Hammond +The `PyWin32 `_ module by Mark Hammond is a collection of modules for advanced Windows-specific support. This includes utilities for: diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index b5628a910ae..590015af98f 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -659,7 +659,7 @@ The heart of the catalog is the new Distutils :command:`register` command. Running ``python setup.py register`` will collect the metadata describing a package, such as its name, version, maintainer, description, &c., and send it to a central catalog server. The resulting catalog is available from -https://pypi.python.org/pypi. +https://pypi.org. To make the catalog a bit more useful, a new optional *classifiers* keyword argument has been added to the Distutils :func:`setup` function. A list of diff --git a/Doc/whatsnew/2.5.rst b/Doc/whatsnew/2.5.rst index 15d35d384c4..79c5a73dcf2 100644 --- a/Doc/whatsnew/2.5.rst +++ b/Doc/whatsnew/2.5.rst @@ -229,7 +229,7 @@ required packages. :: ) Another new enhancement to the Python package index at -https://pypi.python.org is storing source and binary archives for a +https://pypi.org is storing source and binary archives for a package. The new :command:`upload` Distutils command will upload a package to the repository. diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst index 90ce06c3286..02525f4c4c9 100644 --- a/Doc/whatsnew/2.7.rst +++ b/Doc/whatsnew/2.7.rst @@ -1828,7 +1828,7 @@ new features were added. Most of these features were implemented by Michael Foord, unless otherwise noted. The enhanced version of the module is downloadable separately for use with Python versions 2.4 to 2.6, packaged as the :mod:`unittest2` package, from -https://pypi.python.org/pypi/unittest2. +https://pypi.org/project/unittest2. When used from the command line, the module can automatically discover tests. It's not as fancy as `py.test `__ or diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst index a6ba5bbb720..3e3329a84cf 100644 --- a/Doc/whatsnew/3.5.rst +++ b/Doc/whatsnew/3.5.rst @@ -951,7 +951,7 @@ New :class:`~collections.abc.Awaitable`, :class:`~collections.abc.Coroutine`, (Contributed by Yury Selivanov in :issue:`24184`.) For earlier Python versions, a backport of the new ABCs is available in an -external `PyPI package `_. +external `PyPI package `_. compileall diff --git a/Misc/NEWS.d/next/Documentation/2018-05-14-20-08-58.bpo-33503.Wvt0qg.rst b/Misc/NEWS.d/next/Documentation/2018-05-14-20-08-58.bpo-33503.Wvt0qg.rst new file mode 100644 index 00000000000..27025c31a03 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2018-05-14-20-08-58.bpo-33503.Wvt0qg.rst @@ -0,0 +1 @@ +Fix broken pypi link