The Python package installer https://pip.pypa.io/
Go to file
Jon Dufresne 0b761a164c Harmonize type signature of VersionControl.get_remote_url() subclasses
In the base class, the signature is defined as:

    type: (str) -> str

Further, the docstring says:

    Raises RemoteNotFoundError if the repository does not have a remote
    url configured.

However, some subclasses were returning None instead of raising
RemoteNotFoundError. This violated the type signature and forced calling
code to handle multiple error paradigms.

Now, all subclasses implement the base's signature.

This allowed simplifying some call sites as they can assume None will
not be returned.

This mismatch was noticed while trying to remove "mypy:
disallow-untyped-defs=False" comments.
2020-12-25 13:45:17 -08:00
.azure-pipelines Drop Python 2.7 and 3.5 from CI 2020-12-19 19:55:04 +00:00
.github Drop Python 2.7 and 3.5 from CI 2020-12-19 19:55:04 +00:00
docs Remove encoding cookie from Python source files 2020-12-25 07:26:07 -08:00
news Harmonize type signature of VersionControl.get_remote_url() subclasses 2020-12-25 13:45:17 -08:00
src/pip Harmonize type signature of VersionControl.get_remote_url() subclasses 2020-12-25 13:45:17 -08:00
tests Harmonize type signature of VersionControl.get_remote_url() subclasses 2020-12-25 13:45:17 -08:00
tools Drop u prefix from str literals 2020-12-25 07:26:06 -08:00
.gitattributes Modify gitattributes to match changed location of vendoring patches 2020-01-23 10:53:33 +00:00
.gitignore Update gitignore to ignore sublime text config files 2020-10-30 13:34:11 +02:00
.mailmap Use nickname instead of real name 2020-12-03 17:44:29 +09:00
.pre-commit-config-slow.yaml Improve local pre-commit experience 2020-12-21 20:10:44 +01:00
.pre-commit-config.yaml Merge pull request #9335 from hugovk/rm-2 2020-12-23 17:49:30 +00:00
.readthedocs.yml Add correct builder to ReadTheDocs configuration 2019-08-05 18:09:07 +05:30
.travis.yml Bump to PyPy 3.6 2020-12-19 19:55:04 +00:00
AUTHORS.txt Update AUTHORS.txt 2020-12-15 01:45:05 +00:00
LICENSE.txt Update LICENSE.txt 2020-09-23 17:42:29 +03:00
MANIFEST.in Improve local pre-commit experience 2020-12-21 20:10:44 +01:00
NEWS.rst Bump for release 2020-12-15 15:21:16 +00:00
README.rst docs: Fix README for PyPI rendering 2020-12-13 18:05:42 -05:00
noxfile.py Merge pull request #9333 from sbidoul/pre-commit-speed-sbi 2020-12-23 12:47:20 +01:00
pyproject.toml Explicitly specify build-backend in pyproject.toml (#7742) 2020-04-10 20:16:21 +05:30
setup.cfg Remove obsolete "# type: ignore" comments 2020-12-23 15:42:48 -08:00
setup.py Add `Python 3 :: Only` classifier 2020-12-19 19:55:03 +00:00
tox.ini Merge pull request #9335 from hugovk/rm-2 2020-12-23 17:49:30 +00:00

README.rst

pip - The Python Package Installer
==================================

.. image:: https://img.shields.io/pypi/v/pip.svg
   :target: https://pypi.org/project/pip/

.. image:: https://readthedocs.org/projects/pip/badge/?version=latest
   :target: https://pip.pypa.io/en/latest

pip is the `package installer`_ for Python. You can use pip to install packages from the `Python Package Index`_ and other indexes.

Please take a look at our documentation for how to install and use pip:

* `Installation`_
* `Usage`_

We release updates regularly, with a new version every 3 months. Find more details in our documentation:

* `Release notes`_
* `Release process`_

In pip 20.3, we've `made a big improvement to the heart of pip`_; `learn more`_. We want your input, so `sign up for our user experience research studies`_ to help us do it right.

**Note**: pip 21.0, in January 2021, will remove Python 2 support, per pip's `Python 2 support policy`_. Please migrate to Python 3.

If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:

* `Issue tracking`_
* `Discourse channel`_
* `User IRC`_

If you want to get involved head over to GitHub to get the source code, look at our development documentation and feel free to jump on the developer mailing lists and chat rooms:

* `GitHub page`_
* `Development documentation`_
* `Development mailing list`_
* `Development IRC`_

Code of Conduct
---------------

Everyone interacting in the pip project's codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.

.. _package installer: https://packaging.python.org/guides/tool-recommendations/
.. _Python Package Index: https://pypi.org
.. _Installation: https://pip.pypa.io/en/stable/installing.html
.. _Usage: https://pip.pypa.io/en/stable/
.. _Release notes: https://pip.pypa.io/en/stable/news.html
.. _Release process: https://pip.pypa.io/en/latest/development/release-process/
.. _GitHub page: https://github.com/pypa/pip
.. _Development documentation: https://pip.pypa.io/en/latest/development
.. _made a big improvement to the heart of pip: https://pyfound.blogspot.com/2020/11/pip-20-3-new-resolver.html
.. _learn more: https://pip.pypa.io/en/latest/user_guide/#changes-to-the-pip-dependency-resolver-in-20-3-2020
.. _sign up for our user experience research studies: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
.. _Python 2 support policy: https://pip.pypa.io/en/latest/development/release-process/#python-2-support
.. _Issue tracking: https://github.com/pypa/pip/issues
.. _Discourse channel: https://discuss.python.org/c/packaging
.. _Development mailing list: https://mail.python.org/mailman3/lists/distutils-sig.python.org/
.. _User IRC: https://webchat.freenode.net/?channels=%23pypa
.. _Development IRC: https://webchat.freenode.net/?channels=%23pypa-dev
.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md