-
-
Save tuotuoZ/b80ee07c230a9b2c8888fb5c82a30f20 to your computer and use it in GitHub Desktop.
"""Run the EasyInstall command""" | |
if __name__ == '__main__': | |
from setuptools.command.easy_install import main | |
main() |
[console_scripts] | |
pip = pip._internal.cli.main:main | |
pip3 = pip._internal.cli.main:main | |
pip3.8 = pip._internal.cli.main:main | |
pip |
Copyright (c) 2008-2019 The pip developers (see AUTHORS.txt file) | |
Permission is hereby granted, free of charge, to any person obtaining | |
a copy of this software and associated documentation files (the | |
"Software"), to deal in the Software without restriction, including | |
without limitation the rights to use, copy, modify, merge, publish, | |
distribute, sublicense, and/or sell copies of the Software, and to | |
permit persons to whom the Software is furnished to do so, subject to | |
the following conditions: | |
The above copyright notice and this permission notice shall be | |
included in all copies or substantial portions of the Software. | |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | |
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | |
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | |
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | |
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | |
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
Metadata-Version: 2.1 | |
Name: pip | |
Version: 20.1.1 | |
Summary: The PyPA recommended tool for installing Python packages. | |
Home-page: https://pip.pypa.io/ | |
Author: The pip developers | |
Author-email: pypa-dev@groups.google.com | |
License: MIT | |
Project-URL: Documentation, https://pip.pypa.io | |
Project-URL: Source, https://github.com/pypa/pip | |
Keywords: distutils easy_install egg setuptools wheel virtualenv | |
Platform: UNKNOWN | |
Classifier: Development Status :: 5 - Production/Stable | |
Classifier: Intended Audience :: Developers | |
Classifier: License :: OSI Approved :: MIT License | |
Classifier: Topic :: Software Development :: Build Tools | |
Classifier: Programming Language :: Python | |
Classifier: Programming Language :: Python :: 2 | |
Classifier: Programming Language :: Python :: 2.7 | |
Classifier: Programming Language :: Python :: 3 | |
Classifier: Programming Language :: Python :: 3.5 | |
Classifier: Programming Language :: Python :: 3.6 | |
Classifier: Programming Language :: Python :: 3.7 | |
Classifier: Programming Language :: Python :: 3.8 | |
Classifier: Programming Language :: Python :: Implementation :: CPython | |
Classifier: Programming Language :: Python :: Implementation :: PyPy | |
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.* | |
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 2020, we're working on improvements to the heart of pip. Please `learn more and take our survey`_ to help us do it right. | |
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 `PyPA 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 | |
.. _learn more and take our survey: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html | |
.. _Issue tracking: https://github.com/pypa/pip/issues | |
.. _Discourse channel: https://discuss.python.org/c/packaging | |
.. _Development mailing list: https://groups.google.com/forum/#!forum/pypa-dev | |
.. _User IRC: https://webchat.freenode.net/?channels=%23pypa | |
.. _Development IRC: https://webchat.freenode.net/?channels=%23pypa-dev | |
.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/ | |
../../Scripts/pip.exe,sha256=XbgjYBfTwMRnrOkpOZD0-VjmRDKZYgPX_BngjsXXTW8,106373 | |
../../Scripts/pip3.7.exe,sha256=XbgjYBfTwMRnrOkpOZD0-VjmRDKZYgPX_BngjsXXTW8,106373 | |
../../Scripts/pip3.exe,sha256=XbgjYBfTwMRnrOkpOZD0-VjmRDKZYgPX_BngjsXXTW8,106373 | |
pip-20.1.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 | |
pip-20.1.1.dist-info/LICENSE.txt,sha256=W6Ifuwlk-TatfRU2LR7W1JMcyMj5_y1NkRkOEJvnRDE,1090 | |
pip-20.1.1.dist-info/METADATA,sha256=dwRFheMvgIBpyZllM4tVlf5TfjoXc1ZxlsJf0ze61_M,3634 | |
pip-20.1.1.dist-info/RECORD,, | |
pip-20.1.1.dist-info/WHEEL,sha256=kGT74LWyRUZrL4VgLh6_g12IeVl_9u9ZVhadrgXZUEY,110 | |
pip-20.1.1.dist-info/entry_points.txt,sha256=HtfDOwpUlr9s73jqLQ6wF9V0_0qvUXJwCBz7Vwx0Ue0,125 | |
pip-20.1.1.dist-info/top_level.txt,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4 | |
pip/__init__.py,sha256=9lnkMA2mCKfgnTkqep7tMbosgEJ4rENcyu2tcqDwUNw,455 | |
pip/__main__.py,sha256=bqCAM1cj1HwHCDx3WJa-LJxOBXimGxE8OjBqAvnhVg0,911 | |
pip/__pycache__/__init__.cpython-37.pyc,, | |
pip/__pycache__/__main__.cpython-37.pyc,, | |
pip/_internal/__init__.py,sha256=2si23JBW1erg19xIJ8CD6tfGknz0ijtXmzuXjGfGMGE,495 | |
pip/_internal/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/__pycache__/build_env.cpython-37.pyc,, | |
pip/_internal/__pycache__/cache.cpython-37.pyc,, | |
pip/_internal/__pycache__/configuration.cpython-37.pyc,, | |
pip/_internal/__pycache__/exceptions.cpython-37.pyc,, | |
pip/_internal/__pycache__/locations.cpython-37.pyc,, | |
pip/_internal/__pycache__/main.cpython-37.pyc,, | |
pip/_internal/__pycache__/pyproject.cpython-37.pyc,, | |
pip/_internal/__pycache__/self_outdated_check.cpython-37.pyc,, | |
pip/_internal/__pycache__/wheel_builder.cpython-37.pyc,, | |
pip/_internal/build_env.py,sha256=2P0xaKpDhEfrA5P7cXnbx9QpL52Hc1Uturp8EIcjGRg,7506 | |
pip/_internal/cache.py,sha256=aXPdcihRKQVH26jl1cxSKTmTnV0_hNMs7cGADMUFi1Y,12334 | |
pip/_internal/cli/__init__.py,sha256=FkHBgpxxb-_gd6r1FjnNhfMOzAUYyXoXKJ6abijfcFU,132 | |
pip/_internal/cli/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/autocompletion.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/base_command.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/cmdoptions.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/command_context.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/main.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/main_parser.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/parser.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/progress_bars.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/req_command.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/spinners.cpython-37.pyc,, | |
pip/_internal/cli/__pycache__/status_codes.cpython-37.pyc,, | |
pip/_internal/cli/autocompletion.py,sha256=ekGNtcDI0p7rFVc-7s4T9Tbss4Jgb7vsB649XJIblRg,6547 | |
pip/_internal/cli/base_command.py,sha256=O5fT5HHfc_UYNvhqK0rjfh_13K3fIVQzcKUF4xKbFts,8024 | |
pip/_internal/cli/cmdoptions.py,sha256=SjHNqaQ49FO0VKshjoazPVFb7iDx71FKW_N4KgcS3qQ,28403 | |
pip/_internal/cli/command_context.py,sha256=ygMVoTy2jpNilKT-6416gFSQpaBtrKRBbVbi2fy__EU,975 | |
pip/_internal/cli/main.py,sha256=Hxc9dZyW3xiDsYZX-_J2cGXT5DWNLNn_Y7o9oUme-Ec,2616 | |
pip/_internal/cli/main_parser.py,sha256=voAtjo4WVPIYeu7Fqabva9SXaB3BjG0gH93GBfe6jHQ,2843 | |
pip/_internal/cli/parser.py,sha256=4FfwW8xB84CrkLs35ud90ZkhCcWyVkx17XD6j3XCW7c,9480 | |
pip/_internal/cli/progress_bars.py,sha256=WtKOHkePvHwnlhDUotAmKpjBH6hBdVTOnxSiiuCC2l8,9031 | |
pip/_internal/cli/req_command.py,sha256=NajtG3IfB3YkiM7LANLttyJTfPtgB-3CTErY0YR0k50,15309 | |
pip/_internal/cli/spinners.py,sha256=PS9s53LB5aDPelIn8FhKerK3bOdgeefFH5wSWJ2PCzI,5509 | |
pip/_internal/cli/status_codes.py,sha256=F6uDG6Gj7RNKQJUDnd87QKqI16Us-t-B0wPF_4QMpWc,156 | |
pip/_internal/commands/__init__.py,sha256=yoLAnmEXjoQgYfDuwsuWG3RzzD19oeHobGEhmpIYsB4,4100 | |
pip/_internal/commands/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/cache.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/check.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/completion.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/configuration.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/debug.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/download.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/freeze.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/hash.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/help.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/install.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/list.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/search.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/show.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/uninstall.cpython-37.pyc,, | |
pip/_internal/commands/__pycache__/wheel.cpython-37.pyc,, | |
pip/_internal/commands/cache.py,sha256=LZCLVEYCr5Ugh81Zt07Hz5v6SIt0QQzr2-npj3M44aE,5676 | |
pip/_internal/commands/check.py,sha256=fqRrz2uKPC8Qsx2rgLygAD2Rbr-qxp1Q55zUoyZzB9Q,1677 | |
pip/_internal/commands/completion.py,sha256=BoEW3RZQZhsZe5to1aOe245dcBLkf-PTCJL7_u9A-Es,2957 | |
pip/_internal/commands/configuration.py,sha256=y74Vl2p41dBOE2NwUzW4YqnbGbl9r0lsCyBlHguDAWA,7206 | |
pip/_internal/commands/debug.py,sha256=3YkY_M-h1tfpEzat4agulzAk17MU93Qt7ehy_Gi2l6Q,7275 | |
pip/_internal/commands/download.py,sha256=thDfHi0qY6DQ_1GkYPTutwta3tA0RaHJhKycepC4FgA,4740 | |
pip/_internal/commands/freeze.py,sha256=LveCd11SlrZ7s3RovnWpaK0tXB2Jci4DPcP6A9cj0e4,3342 | |
pip/_internal/commands/hash.py,sha256=KckEd5FeomfsRgZmRzhJRPYSsz-HXbFZGNdrzp12ftQ,1742 | |
pip/_internal/commands/help.py,sha256=s8bDMJbRVxs9ehLKuD4mXTsv1bTRapy1jDwaTCE90qw,1193 | |
pip/_internal/commands/install.py,sha256=1oXXadnvHM-55XWIdeqdaR75BjLPGC2-wXEkkhMyMtQ,25430 | |
pip/_internal/commands/list.py,sha256=GCrhhu07cw3CyZGFk8rGM2ejk3JmeF9XLbC7raiq_bw,10141 | |
pip/_internal/commands/search.py,sha256=KjAz-s9mwkiLfDd-cpQO3pL6KFoOyl1RKlvxnJj3zz8,5191 | |
pip/_internal/commands/show.py,sha256=RqSX_KvzcZWz1gxIOZEnnk4-VeSkNvr0yWz5jF6JrcY,6791 | |
pip/_internal/commands/uninstall.py,sha256=D2Otze7J-RJvjfozRq2Yon9NKJrg4cbBGFuXyEwBMR0,3202 | |
pip/_internal/commands/wheel.py,sha256=oxyo51V1m_Hu4U-HCS53vBx5-82Q6GOhn1doOgAr3KE,6431 | |
pip/_internal/configuration.py,sha256=k3Y3HMMMm_fzNqX75QoNuHvjX8tplmNBuIJJpDHmf9M,14349 | |
pip/_internal/distributions/__init__.py,sha256=ECBUW5Gtu9TjJwyFLvim-i6kUMYVuikNh9I5asL6tbA,959 | |
pip/_internal/distributions/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/distributions/__pycache__/base.cpython-37.pyc,, | |
pip/_internal/distributions/__pycache__/installed.cpython-37.pyc,, | |
pip/_internal/distributions/__pycache__/sdist.cpython-37.pyc,, | |
pip/_internal/distributions/__pycache__/wheel.cpython-37.pyc,, | |
pip/_internal/distributions/base.py,sha256=ruprpM_L2T2HNi3KLUHlbHimZ1sWVw-3Q0Lb8O7TDAI,1425 | |
pip/_internal/distributions/installed.py,sha256=YqlkBKr6TVP1MAYS6SG8ojud21wVOYLMZ8jMLJe9MSU,760 | |
pip/_internal/distributions/sdist.py,sha256=D4XTMlCwgPlK69l62GLYkNSVTVe99fR5iAcVt2EbGok,4086 | |
pip/_internal/distributions/wheel.py,sha256=95uD-TfaYoq3KiKBdzk9YMN4RRqJ28LNoSTS2K46gek,1294 | |
pip/_internal/exceptions.py,sha256=B3tSkzheqSfGoGt5OcAOhLhfnWWMzfJ60URvZWwkwHw,10308 | |
pip/_internal/index/__init__.py,sha256=vpt-JeTZefh8a-FC22ZeBSXFVbuBcXSGiILhQZJaNpQ,30 | |
pip/_internal/index/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/index/__pycache__/collector.cpython-37.pyc,, | |
pip/_internal/index/__pycache__/package_finder.cpython-37.pyc,, | |
pip/_internal/index/collector.py,sha256=tFpQdkBlbNzdwlep7a5_o9unymgWuEmo2WtARsagiao,21547 | |
pip/_internal/index/package_finder.py,sha256=2Uq4RPSRboyRPj1Zp3-SB8ZFNLAEMrZv6G2yH-wVjIA,37676 | |
pip/_internal/locations.py,sha256=VifFEqhc7FWFV8QGoEM3CpECRY8Doq7kTytytxsEgx0,6734 | |
pip/_internal/main.py,sha256=IVBnUQ-FG7DK6617uEXRB5_QJqspAsBFmTmTesYkbdQ,437 | |
pip/_internal/models/__init__.py,sha256=3DHUd_qxpPozfzouoqa9g9ts1Czr5qaHfFxbnxriepM,63 | |
pip/_internal/models/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/candidate.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/direct_url.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/format_control.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/index.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/link.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/scheme.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/search_scope.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/selection_prefs.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/target_python.cpython-37.pyc,, | |
pip/_internal/models/__pycache__/wheel.cpython-37.pyc,, | |
pip/_internal/models/candidate.py,sha256=Y58Bcm6oXUj0iS-yhmerlGo5CQJI2p0Ww9h6hR9zQDw,1150 | |
pip/_internal/models/direct_url.py,sha256=MnBLPci1hE9Ndh6d3m0LAqB7hX3ci80CCJTE5eerFaQ,6900 | |
pip/_internal/models/format_control.py,sha256=ICzVjjGwfZYdX-eLLKHjMHLutEJlAGpfj09OG_eMqac,2673 | |
pip/_internal/models/index.py,sha256=K59A8-hVhBM20Xkahr4dTwP7OjkJyEqXH11UwHFVgqM,1060 | |
pip/_internal/models/link.py,sha256=KobEaGViwOzyPBD7kgzpGqyrQfh5zjlonOStCGAhl2U,7302 | |
pip/_internal/models/scheme.py,sha256=vvhBrrno7eVDXcdKHiZWwxhPHf4VG5uSCEkC0QDR2RU,679 | |
pip/_internal/models/search_scope.py,sha256=AYbFyfEen5cx0kRZTMgUWUxzcMr5nDk32MO4S67Ror4,4712 | |
pip/_internal/models/selection_prefs.py,sha256=rPeif2KKjhTPXeMoQYffjqh10oWpXhdkxRDaPT1HO8k,1908 | |
pip/_internal/models/target_python.py,sha256=bbOSwPmojPMtCW6i2XMNjVJzt_2GQYfx3FcGQY8pL44,3842 | |
pip/_internal/models/wheel.py,sha256=FTfzVb4WIbfIehxhdlAVvCil_MQ0-W44oyN56cE6NHc,2772 | |
pip/_internal/network/__init__.py,sha256=jf6Tt5nV_7zkARBrKojIXItgejvoegVJVKUbhAa5Ioc,50 | |
pip/_internal/network/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/network/__pycache__/auth.cpython-37.pyc,, | |
pip/_internal/network/__pycache__/cache.cpython-37.pyc,, | |
pip/_internal/network/__pycache__/download.cpython-37.pyc,, | |
pip/_internal/network/__pycache__/session.cpython-37.pyc,, | |
pip/_internal/network/__pycache__/utils.cpython-37.pyc,, | |
pip/_internal/network/__pycache__/xmlrpc.cpython-37.pyc,, | |
pip/_internal/network/auth.py,sha256=HJg5peC3gL44H7pmZhCPnu2MrwpAalOSF7d1jmNDqt8,11125 | |
pip/_internal/network/cache.py,sha256=51CExcRkXWrgMZ7WsrZ6cmijKfViD5tVgKbBvJHO1IE,2394 | |
pip/_internal/network/download.py,sha256=MIisedL1oFOSrYAN119HDlIuFfw6eL6CNY7oJhHIzUc,6269 | |
pip/_internal/network/session.py,sha256=Zs0uiyPxTpfpgSv-ZI9hK9TjasmTplBuBivOTcUiJME,15208 | |
pip/_internal/network/utils.py,sha256=iiixo1OeaQ3niUWiBjg59PN6f1w7vvTww1vFriTD_IU,1959 | |
pip/_internal/network/xmlrpc.py,sha256=AL115M3vFJ8xiHVJneb8Hi0ZFeRvdPhblC89w25OG5s,1597 | |
pip/_internal/operations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_internal/operations/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/operations/__pycache__/check.cpython-37.pyc,, | |
pip/_internal/operations/__pycache__/freeze.cpython-37.pyc,, | |
pip/_internal/operations/__pycache__/prepare.cpython-37.pyc,, | |
pip/_internal/operations/build/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_internal/operations/build/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/operations/build/__pycache__/metadata.cpython-37.pyc,, | |
pip/_internal/operations/build/__pycache__/metadata_legacy.cpython-37.pyc,, | |
pip/_internal/operations/build/__pycache__/wheel.cpython-37.pyc,, | |
pip/_internal/operations/build/__pycache__/wheel_legacy.cpython-37.pyc,, | |
pip/_internal/operations/build/metadata.py,sha256=yHMi5gHYXcXyHcvUPWHdO-UyOo3McFWljn_nHfM1O9c,1307 | |
pip/_internal/operations/build/metadata_legacy.py,sha256=VgzBTk8naIO8-8N_ifEYF7ZAxWUDhphWVIaVlZ2FqYM,2011 | |
pip/_internal/operations/build/wheel.py,sha256=ntltdNP6D2Tpr4V0agssu6rE0F9LaBpJkYT6zSdhEbw,1469 | |
pip/_internal/operations/build/wheel_legacy.py,sha256=N1aqNZyGURBX0Bj6wPmB0t4866oMbxoHUpC9pz6FyT0,3356 | |
pip/_internal/operations/check.py,sha256=a6uHG0daoWpmSPCdL7iYJaGQYZ-CRvPvTnCv2PnIIs0,5353 | |
pip/_internal/operations/freeze.py,sha256=mGT2OFjMOb0FlVjgedAzJ9GbNOgNwYiL0130xx60pHA,10587 | |
pip/_internal/operations/install/__init__.py,sha256=mX7hyD2GNBO2mFGokDQ30r_GXv7Y_PLdtxcUv144e-s,51 | |
pip/_internal/operations/install/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/operations/install/__pycache__/editable_legacy.cpython-37.pyc,, | |
pip/_internal/operations/install/__pycache__/legacy.cpython-37.pyc,, | |
pip/_internal/operations/install/__pycache__/wheel.cpython-37.pyc,, | |
pip/_internal/operations/install/editable_legacy.py,sha256=rJ_xs2qtDUjpY2-n6eYlVyZiNoKbOtZXZrYrcnIELt4,1488 | |
pip/_internal/operations/install/legacy.py,sha256=YkKdL_tyNwDP2huOGxmopySh5Pz2v_wRVeSTEa6ZUco,4686 | |
pip/_internal/operations/install/wheel.py,sha256=8IO3GYTtrJ42cqipLOh0rxex4j-PfU8m71HVB0tOQd0,23885 | |
pip/_internal/operations/prepare.py,sha256=RDwtSetVTfv-nv1-_apYBA3Dez5ngBmOYzcuZy2Q3vk,20030 | |
pip/_internal/pyproject.py,sha256=VJKsrXORGiGoDPVKCQhuu4tWlQSTOhoiRlVLRNu4rx4,7400 | |
pip/_internal/req/__init__.py,sha256=UVaYPlHZVGRBQQPjvGC_6jJDQtewXm0ws-8Lxhg_TiY,2671 | |
pip/_internal/req/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/req/__pycache__/constructors.cpython-37.pyc,, | |
pip/_internal/req/__pycache__/req_file.cpython-37.pyc,, | |
pip/_internal/req/__pycache__/req_install.cpython-37.pyc,, | |
pip/_internal/req/__pycache__/req_set.cpython-37.pyc,, | |
pip/_internal/req/__pycache__/req_tracker.cpython-37.pyc,, | |
pip/_internal/req/__pycache__/req_uninstall.cpython-37.pyc,, | |
pip/_internal/req/constructors.py,sha256=i_dU2sYtSk5GMsad68gBx26tfneRmhPF2sYGe4uPnu8,15441 | |
pip/_internal/req/req_file.py,sha256=5QlZr36kkw1Jsbr8vFO-fGUEAef9h-AoRRqjx8EYSuQ,19075 | |
pip/_internal/req/req_install.py,sha256=9yn_fBFTyzHPMjYG5WXBB2WiGQvk3BT6gYl9Khw8ZoE,31713 | |
pip/_internal/req/req_set.py,sha256=EBHZ9zWSR8arxjcadyU2OotZIECemM8oOFQ0nK-Bb7E,7792 | |
pip/_internal/req/req_tracker.py,sha256=cAKhSw-QbhGxqPF1Wc0zD6jo932jpdYF3ROfRSH8hes,4744 | |
pip/_internal/req/req_uninstall.py,sha256=NdErRQBpNScsdwJAo3O_zo2KPPfQyVMJ_Q2mxPWYyOA,23734 | |
pip/_internal/resolution/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_internal/resolution/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/resolution/__pycache__/base.cpython-37.pyc,, | |
pip/_internal/resolution/base.py,sha256=xi72YmIS-lEjyK13PN_3qkGGthA4yGoK0C6qWynyHrE,682 | |
pip/_internal/resolution/legacy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_internal/resolution/legacy/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/resolution/legacy/__pycache__/resolver.cpython-37.pyc,, | |
pip/_internal/resolution/legacy/resolver.py,sha256=56GuGHWcseV24cvTCOuRHMAF_Er1UeDxn5m18XMkHBs,17587 | |
pip/_internal/resolution/resolvelib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_internal/resolution/resolvelib/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/resolution/resolvelib/__pycache__/base.cpython-37.pyc,, | |
pip/_internal/resolution/resolvelib/__pycache__/candidates.cpython-37.pyc,, | |
pip/_internal/resolution/resolvelib/__pycache__/factory.cpython-37.pyc,, | |
pip/_internal/resolution/resolvelib/__pycache__/provider.cpython-37.pyc,, | |
pip/_internal/resolution/resolvelib/__pycache__/requirements.cpython-37.pyc,, | |
pip/_internal/resolution/resolvelib/__pycache__/resolver.cpython-37.pyc,, | |
pip/_internal/resolution/resolvelib/base.py,sha256=l2Z3-1Qg243lWzwFbaN17qixA4U8LYr-qMhZTdaHROc,1502 | |
pip/_internal/resolution/resolvelib/candidates.py,sha256=wzi9t3aX1Twi3xTNEkpG6eWOd0dEg5uKul-QkK3arvw,15173 | |
pip/_internal/resolution/resolvelib/factory.py,sha256=mDs3p8D9N9zfYvn_iIx0saDLHF1SF7KHBQlA1gWSWVQ,7574 | |
pip/_internal/resolution/resolvelib/provider.py,sha256=0fKuPuEoD5T7w-YwKgQZc1AmgSnAkrxGnLBOf-_6Kiw,1703 | |
pip/_internal/resolution/resolvelib/requirements.py,sha256=bu9Y4YINHjvBm-NBKvnxw9IYHW4t6rRlm4-QKVqLDsM,3872 | |
pip/_internal/resolution/resolvelib/resolver.py,sha256=3LXhhCz6CtIpih8tK2nHeRvVEjVJmXrqxNCM1FQM1U0,6673 | |
pip/_internal/self_outdated_check.py,sha256=3KO1pTJUuYaiV9X0t87I9PimkGL82HbhLWbocqKZpBU,8009 | |
pip/_internal/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_internal/utils/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/appdirs.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/compat.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/compatibility_tags.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/deprecation.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/direct_url_helpers.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/distutils_args.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/encoding.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/entrypoints.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/filesystem.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/filetypes.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/glibc.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/hashes.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/inject_securetransport.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/logging.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/misc.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/models.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/packaging.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/pkg_resources.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/setuptools_build.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/subprocess.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/temp_dir.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/typing.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/unpacking.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/urls.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/virtualenv.cpython-37.pyc,, | |
pip/_internal/utils/__pycache__/wheel.cpython-37.pyc,, | |
pip/_internal/utils/appdirs.py,sha256=RZzUG-Bkh2b-miX0DSZ3v703_-bgK-v0PfWCCjwVE9g,1349 | |
pip/_internal/utils/compat.py,sha256=ZRJsXMjq373p0US54CUkKRkpLH-ioOM3H3yAhmbUPcs,8898 | |
pip/_internal/utils/compatibility_tags.py,sha256=b2NWEbxfsrB2pBLwJkNVSYUrIAsumQ2IWDoNabbwLPs,5492 | |
pip/_internal/utils/deprecation.py,sha256=pBnNogoA4UGTxa_JDnPXBRRYpKMbExAhXpBwAwklOBs,3318 | |
pip/_internal/utils/direct_url_helpers.py,sha256=bZCBNwPQVyZpYGjX_VcomvVvRHvKw-9JzEV-Ft09LQc,4359 | |
pip/_internal/utils/distutils_args.py,sha256=a56mblNxk9BGifbpEETG61mmBrqhjtjRkJ4HYn-oOEE,1350 | |
pip/_internal/utils/encoding.py,sha256=hxZz0t3Whw3d4MHQEiofxalTlfKwxFdLc8fpeGfhKo8,1320 | |
pip/_internal/utils/entrypoints.py,sha256=vHcNpnksCv6mllihU6hfifdsKPEjwcaJ1aLIXEaynaU,1152 | |
pip/_internal/utils/filesystem.py,sha256=fqpFwT280152rlX1RjJqjoLp_MXVA8HzKTtDmsl15Ps,6813 | |
pip/_internal/utils/filetypes.py,sha256=R2FwzoeX7b-rZALOXx5cuO8VPPMhUQ4ne7wm3n3IcWA,571 | |
pip/_internal/utils/glibc.py,sha256=LOeNGgawCKS-4ke9fii78fwXD73dtNav3uxz1Bf-Ab8,3297 | |
pip/_internal/utils/hashes.py,sha256=LQVOt2LTWAdBJH6WPim1YGdF0J-0AfBBLghIDlY1-80,3986 | |
pip/_internal/utils/inject_securetransport.py,sha256=M17ZlFVY66ApgeASVjKKLKNz0LAfk-SyU0HZ4ZB6MmI,810 | |
pip/_internal/utils/logging.py,sha256=YIfuDUEkmdn9cIRQ_Ec8rgXs1m5nOwDECtZqM4CBH5U,13093 | |
pip/_internal/utils/misc.py,sha256=cK17YkNfEccS9AuH6Xc9kYQxE0DPNgb-ULh8QgKPr8c,26195 | |
pip/_internal/utils/models.py,sha256=IA0hw_T4awQzui0kqfIEASm5yLtgZAB08ag59Nip5G8,1148 | |
pip/_internal/utils/packaging.py,sha256=VtiwcAAL7LBi7tGL2je7LeW4bE11KMHGCsJ1NZY5XtM,3035 | |
pip/_internal/utils/pkg_resources.py,sha256=ZX-k7V5q_aNWyDse92nN7orN1aCpRLsaxzpkBZ1XKzU,1254 | |
pip/_internal/utils/setuptools_build.py,sha256=E1KswI7wfNnCDE5R6G8c9ZbByENpu7NqocjY26PCQDw,5058 | |
pip/_internal/utils/subprocess.py,sha256=vI2QWpNDqM-dkn-z8i1Yrfxnn5sYniPeWn6FhTxX4dY,9902 | |
pip/_internal/utils/temp_dir.py,sha256=H8yUBrRWqTM83cuUu7jVvw_xKL9eZtg_IIbXQtjMLlA,8185 | |
pip/_internal/utils/typing.py,sha256=xkYwOeHlf4zsHXBDC4310HtEqwhQcYXFPq2h35Tcrl0,1401 | |
pip/_internal/utils/unpacking.py,sha256=M944JTSiapBOSKLWu7lbawpVHSE7flfzZTEr3TAG7v8,9438 | |
pip/_internal/utils/urls.py,sha256=q2rw1kMiiig_XZcoyJSsWMJQqYw-2wUmrMoST4mCW_I,1527 | |
pip/_internal/utils/virtualenv.py,sha256=iVJ8ZlbNtGon6I4uZFsY2SidrUf1vt3YHrgS5CuU98w,3553 | |
pip/_internal/utils/wheel.py,sha256=ofsZEN35YhSxRYC4gfzpTtqa_UQ8GF1tl4jtyUdd0gU,7306 | |
pip/_internal/vcs/__init__.py,sha256=viJxJRqRE_mVScum85bgQIXAd6o0ozFt18VpC-qIJrM,617 | |
pip/_internal/vcs/__pycache__/__init__.cpython-37.pyc,, | |
pip/_internal/vcs/__pycache__/bazaar.cpython-37.pyc,, | |
pip/_internal/vcs/__pycache__/git.cpython-37.pyc,, | |
pip/_internal/vcs/__pycache__/mercurial.cpython-37.pyc,, | |
pip/_internal/vcs/__pycache__/subversion.cpython-37.pyc,, | |
pip/_internal/vcs/__pycache__/versioncontrol.cpython-37.pyc,, | |
pip/_internal/vcs/bazaar.py,sha256=84q1-kj1_nJ9AMzMu8RmMp-riRZu81M7K9kowcYgi3U,3957 | |
pip/_internal/vcs/git.py,sha256=wlvvVT-hPRwCvkihEoOCZmkCzMzosmV43_DTPvEVA_M,14165 | |
pip/_internal/vcs/mercurial.py,sha256=wVdmoFH-RYoaxjtuAqw40b0daMPX-Fr_26W1ME_9HZU,5347 | |
pip/_internal/vcs/subversion.py,sha256=6shByxeASetbM7WCj6WNoPcuLfBK65DoOEqbkSiWPAI,12331 | |
pip/_internal/vcs/versioncontrol.py,sha256=RtSrHr96CynqXYBQIC61cVY_9C0e7hk8dXUV-BpHmpI,23591 | |
pip/_internal/wheel_builder.py,sha256=p9ZFawfCR1GXchTRY6oq7Qx5enLLjs2SouafNFNsAAE,9590 | |
pip/_vendor/__init__.py,sha256=Tfcbsek_rpFZWMnYp6vzGpWHsmiwBGYOmInUX1NGJp4,4788 | |
pip/_vendor/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/__pycache__/appdirs.cpython-37.pyc,, | |
pip/_vendor/__pycache__/contextlib2.cpython-37.pyc,, | |
pip/_vendor/__pycache__/distro.cpython-37.pyc,, | |
pip/_vendor/__pycache__/ipaddress.cpython-37.pyc,, | |
pip/_vendor/__pycache__/pyparsing.cpython-37.pyc,, | |
pip/_vendor/__pycache__/retrying.cpython-37.pyc,, | |
pip/_vendor/__pycache__/six.cpython-37.pyc,, | |
pip/_vendor/__pycache__/toml.cpython-37.pyc,, | |
pip/_vendor/appdirs.py,sha256=pYg72GhKgkVzkPxZNFUSIzMF3tAPWBgIPoQE8jgVftg,25888 | |
pip/_vendor/cachecontrol/__init__.py,sha256=pJtAaUxOsMPnytI1A3juAJkXYDr8krdSnsg4Yg3OBEg,302 | |
pip/_vendor/cachecontrol/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/_cmd.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/adapter.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/cache.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/compat.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/controller.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/filewrapper.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/heuristics.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/serialize.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/__pycache__/wrapper.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/_cmd.py,sha256=URGE0KrA87QekCG3SGPatlSPT571dZTDjNa-ZXX3pDc,1295 | |
pip/_vendor/cachecontrol/adapter.py,sha256=sSwaSYd93IIfCFU4tOMgSo6b2LCt_gBSaQUj8ktJFOA,4882 | |
pip/_vendor/cachecontrol/cache.py,sha256=1fc4wJP8HYt1ycnJXeEw5pCpeBL2Cqxx6g9Fb0AYDWQ,805 | |
pip/_vendor/cachecontrol/caches/__init__.py,sha256=-gHNKYvaeD0kOk5M74eOrsSgIKUtC6i6GfbmugGweEo,86 | |
pip/_vendor/cachecontrol/caches/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/caches/__pycache__/file_cache.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/caches/__pycache__/redis_cache.cpython-37.pyc,, | |
pip/_vendor/cachecontrol/caches/file_cache.py,sha256=nYVKsJtXh6gJXvdn1iWyrhxvkwpQrK-eKoMRzuiwkKk,4153 | |
pip/_vendor/cachecontrol/caches/redis_cache.py,sha256=HxelMpNCo-dYr2fiJDwM3hhhRmxUYtB5tXm1GpAAT4Y,856 | |
pip/_vendor/cachecontrol/compat.py,sha256=kHNvMRdt6s_Xwqq_9qJmr9ou3wYMOMUMxPPcwNxT8Mc,695 | |
pip/_vendor/cachecontrol/controller.py,sha256=CWEX3pedIM9s60suf4zZPtm_JvVgnvogMGK_OiBG5F8,14149 | |
pip/_vendor/cachecontrol/filewrapper.py,sha256=vACKO8Llzu_ZWyjV1Fxn1MA4TGU60N5N3GSrAFdAY2Q,2533 | |
pip/_vendor/cachecontrol/heuristics.py,sha256=BFGHJ3yQcxvZizfo90LLZ04T_Z5XSCXvFotrp7Us0sc,4070 | |
pip/_vendor/cachecontrol/serialize.py,sha256=vIa4jvq4x_KSOLdEIedoknX2aXYHQujLDFV4-F21Dno,7091 | |
pip/_vendor/cachecontrol/wrapper.py,sha256=5LX0uJwkNQUtYSEw3aGmGu9WY8wGipd81mJ8lG0d0M4,690 | |
pip/_vendor/certifi/__init__.py,sha256=AOqspvggP_F62Q_4UmJAhx5rZkoRHoRYBE3SCnSJzAk,64 | |
pip/_vendor/certifi/__main__.py,sha256=1k3Cr95vCxxGRGDljrW3wMdpZdL3Nhf0u1n-k2qdsCY,255 | |
pip/_vendor/certifi/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/certifi/__pycache__/__main__.cpython-37.pyc,, | |
pip/_vendor/certifi/__pycache__/core.cpython-37.pyc,, | |
pip/_vendor/certifi/cacert.pem,sha256=hwBo73gFnF0BKiP3FQKfG32xkGDhxl4SwCQiH2rDKr0,284099 | |
pip/_vendor/certifi/core.py,sha256=c8hoNcYWz6rQo2VAM5d0mcEWiewCvQuOUbCwJz49vhQ,792 | |
pip/_vendor/chardet/__init__.py,sha256=YsP5wQlsHJ2auF1RZJfypiSrCA7_bQiRm3ES_NI76-Y,1559 | |
pip/_vendor/chardet/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/big5freq.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/big5prober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/chardistribution.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/charsetgroupprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/charsetprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/codingstatemachine.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/compat.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/cp949prober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/enums.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/escprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/escsm.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/eucjpprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/euckrfreq.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/euckrprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/euctwfreq.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/euctwprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/gb2312freq.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/gb2312prober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/hebrewprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/jisfreq.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/jpcntx.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/langbulgarianmodel.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/langcyrillicmodel.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/langgreekmodel.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/langhebrewmodel.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/langhungarianmodel.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/langthaimodel.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/langturkishmodel.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/latin1prober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/mbcharsetprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/mbcsgroupprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/mbcssm.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/sbcharsetprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/sbcsgroupprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/sjisprober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/universaldetector.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/utf8prober.cpython-37.pyc,, | |
pip/_vendor/chardet/__pycache__/version.cpython-37.pyc,, | |
pip/_vendor/chardet/big5freq.py,sha256=D_zK5GyzoVsRes0HkLJziltFQX0bKCLOrFe9_xDvO_8,31254 | |
pip/_vendor/chardet/big5prober.py,sha256=kBxHbdetBpPe7xrlb-e990iot64g_eGSLd32lB7_h3M,1757 | |
pip/_vendor/chardet/chardistribution.py,sha256=3woWS62KrGooKyqz4zQSnjFbJpa6V7g02daAibTwcl8,9411 | |
pip/_vendor/chardet/charsetgroupprober.py,sha256=6bDu8YIiRuScX4ca9Igb0U69TA2PGXXDej6Cc4_9kO4,3787 | |
pip/_vendor/chardet/charsetprober.py,sha256=KSmwJErjypyj0bRZmC5F5eM7c8YQgLYIjZXintZNstg,5110 | |
pip/_vendor/chardet/cli/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1 | |
pip/_vendor/chardet/cli/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/chardet/cli/__pycache__/chardetect.cpython-37.pyc,, | |
pip/_vendor/chardet/cli/chardetect.py,sha256=DI8dlV3FBD0c0XA_y3sQ78z754DUv1J8n34RtDjOXNw,2774 | |
pip/_vendor/chardet/codingstatemachine.py,sha256=VYp_6cyyki5sHgXDSZnXW4q1oelHc3cu9AyQTX7uug8,3590 | |
pip/_vendor/chardet/compat.py,sha256=PKTzHkSbtbHDqS9PyujMbX74q1a8mMpeQTDVsQhZMRw,1134 | |
pip/_vendor/chardet/cp949prober.py,sha256=TZ434QX8zzBsnUvL_8wm4AQVTZ2ZkqEEQL_lNw9f9ow,1855 | |
pip/_vendor/chardet/enums.py,sha256=Aimwdb9as1dJKZaFNUH2OhWIVBVd6ZkJJ_WK5sNY8cU,1661 | |
pip/_vendor/chardet/escprober.py,sha256=kkyqVg1Yw3DIOAMJ2bdlyQgUFQhuHAW8dUGskToNWSc,3950 | |
pip/_vendor/chardet/escsm.py,sha256=RuXlgNvTIDarndvllNCk5WZBIpdCxQ0kcd9EAuxUh84,10510 | |
pip/_vendor/chardet/eucjpprober.py,sha256=iD8Jdp0ISRjgjiVN7f0e8xGeQJ5GM2oeZ1dA8nbSeUw,3749 | |
pip/_vendor/chardet/euckrfreq.py,sha256=-7GdmvgWez4-eO4SuXpa7tBiDi5vRXQ8WvdFAzVaSfo,13546 | |
pip/_vendor/chardet/euckrprober.py,sha256=MqFMTQXxW4HbzIpZ9lKDHB3GN8SP4yiHenTmf8g_PxY,1748 | |
pip/_vendor/chardet/euctwfreq.py,sha256=No1WyduFOgB5VITUA7PLyC5oJRNzRyMbBxaKI1l16MA,31621 | |
pip/_vendor/chardet/euctwprober.py,sha256=13p6EP4yRaxqnP4iHtxHOJ6R2zxHq1_m8hTRjzVZ95c,1747 | |
pip/_vendor/chardet/gb2312freq.py,sha256=JX8lsweKLmnCwmk8UHEQsLgkr_rP_kEbvivC4qPOrlc,20715 | |
pip/_vendor/chardet/gb2312prober.py,sha256=gGvIWi9WhDjE-xQXHvNIyrnLvEbMAYgyUSZ65HUfylw,1754 | |
pip/_vendor/chardet/hebrewprober.py,sha256=c3SZ-K7hvyzGY6JRAZxJgwJ_sUS9k0WYkvMY00YBYFo,13838 | |
pip/_vendor/chardet/jisfreq.py,sha256=vpmJv2Bu0J8gnMVRPHMFefTRvo_ha1mryLig8CBwgOg,25777 | |
pip/_vendor/chardet/jpcntx.py,sha256=PYlNqRUQT8LM3cT5FmHGP0iiscFlTWED92MALvBungo,19643 | |
pip/_vendor/chardet/langbulgarianmodel.py,sha256=1HqQS9Pbtnj1xQgxitJMvw8X6kKr5OockNCZWfEQrPE,12839 | |
pip/_vendor/chardet/langcyrillicmodel.py,sha256=LODajvsetH87yYDDQKA2CULXUH87tI223dhfjh9Zx9c,17948 | |
pip/_vendor/chardet/langgreekmodel.py,sha256=8YAW7bU8YwSJap0kIJSbPMw1BEqzGjWzqcqf0WgUKAA,12688 | |
pip/_vendor/chardet/langhebrewmodel.py,sha256=JSnqmE5E62tDLTPTvLpQsg5gOMO4PbdWRvV7Avkc0HA,11345 | |
pip/_vendor/chardet/langhungarianmodel.py,sha256=RhapYSG5l0ZaO-VV4Fan5sW0WRGQqhwBM61yx3yxyOA,12592 | |
pip/_vendor/chardet/langthaimodel.py,sha256=8l0173Gu_W6G8mxmQOTEF4ls2YdE7FxWf3QkSxEGXJQ,11290 | |
pip/_vendor/chardet/langturkishmodel.py,sha256=W22eRNJsqI6uWAfwXSKVWWnCerYqrI8dZQTm_M0lRFk,11102 | |
pip/_vendor/chardet/latin1prober.py,sha256=S2IoORhFk39FEFOlSFWtgVybRiP6h7BlLldHVclNkU8,5370 | |
pip/_vendor/chardet/mbcharsetprober.py,sha256=AR95eFH9vuqSfvLQZN-L5ijea25NOBCoXqw8s5O9xLQ,3413 | |
pip/_vendor/chardet/mbcsgroupprober.py,sha256=h6TRnnYq2OxG1WdD5JOyxcdVpn7dG0q-vB8nWr5mbh4,2012 | |
pip/_vendor/chardet/mbcssm.py,sha256=SY32wVIF3HzcjY3BaEspy9metbNSKxIIB0RKPn7tjpI,25481 | |
pip/_vendor/chardet/sbcharsetprober.py,sha256=LDSpCldDCFlYwUkGkwD2oFxLlPWIWXT09akH_2PiY74,5657 | |
pip/_vendor/chardet/sbcsgroupprober.py,sha256=1IprcCB_k1qfmnxGC6MBbxELlKqD3scW6S8YIwdeyXA,3546 | |
pip/_vendor/chardet/sjisprober.py,sha256=IIt-lZj0WJqK4rmUZzKZP4GJlE8KUEtFYVuY96ek5MQ,3774 | |
pip/_vendor/chardet/universaldetector.py,sha256=qL0174lSZE442eB21nnktT9_VcAye07laFWUeUrjttY,12485 | |
pip/_vendor/chardet/utf8prober.py,sha256=IdD8v3zWOsB8OLiyPi-y_fqwipRFxV9Nc1eKBLSuIEw,2766 | |
pip/_vendor/chardet/version.py,sha256=sp3B08mrDXB-pf3K9fqJ_zeDHOCLC8RrngQyDFap_7g,242 | |
pip/_vendor/colorama/__init__.py,sha256=DqjXH9URVP3IJwmMt7peYw50ns1RNAymIB9-XdPEFV8,239 | |
pip/_vendor/colorama/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/colorama/__pycache__/ansi.cpython-37.pyc,, | |
pip/_vendor/colorama/__pycache__/ansitowin32.cpython-37.pyc,, | |
pip/_vendor/colorama/__pycache__/initialise.cpython-37.pyc,, | |
pip/_vendor/colorama/__pycache__/win32.cpython-37.pyc,, | |
pip/_vendor/colorama/__pycache__/winterm.cpython-37.pyc,, | |
pip/_vendor/colorama/ansi.py,sha256=Fi0un-QLqRm-v7o_nKiOqyC8PapBJK7DLV_q9LKtTO0,2524 | |
pip/_vendor/colorama/ansitowin32.py,sha256=u8QaqdqS_xYSfNkPM1eRJLHz6JMWPodaJaP0mxgHCDc,10462 | |
pip/_vendor/colorama/initialise.py,sha256=PprovDNxMTrvoNHFcL2NZjpH2XzDc8BLxLxiErfUl4k,1915 | |
pip/_vendor/colorama/win32.py,sha256=bJ8Il9jwaBN5BJ8bmN6FoYZ1QYuMKv2j8fGrXh7TJjw,5404 | |
pip/_vendor/colorama/winterm.py,sha256=2y_2b7Zsv34feAsP67mLOVc-Bgq51mdYGo571VprlrM,6438 | |
pip/_vendor/contextlib2.py,sha256=5HjGflUzwWAUfcILhSmC2GqvoYdZZzFzVfIDztHigUs,16915 | |
pip/_vendor/distlib/__init__.py,sha256=gzl1hjUXmDGrqRyU7ZLjBwJGAcMimQbrZ22XPVaKaRE,581 | |
pip/_vendor/distlib/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/compat.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/database.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/index.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/locators.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/manifest.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/markers.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/metadata.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/resources.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/scripts.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/util.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/version.cpython-37.pyc,, | |
pip/_vendor/distlib/__pycache__/wheel.cpython-37.pyc,, | |
pip/_vendor/distlib/_backport/__init__.py,sha256=bqS_dTOH6uW9iGgd0uzfpPjo6vZ4xpPZ7kyfZJ2vNaw,274 | |
pip/_vendor/distlib/_backport/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/distlib/_backport/__pycache__/misc.cpython-37.pyc,, | |
pip/_vendor/distlib/_backport/__pycache__/shutil.cpython-37.pyc,, | |
pip/_vendor/distlib/_backport/__pycache__/sysconfig.cpython-37.pyc,, | |
pip/_vendor/distlib/_backport/__pycache__/tarfile.cpython-37.pyc,, | |
pip/_vendor/distlib/_backport/misc.py,sha256=KWecINdbFNOxSOP1fGF680CJnaC6S4fBRgEtaYTw0ig,971 | |
pip/_vendor/distlib/_backport/shutil.py,sha256=VW1t3uYqUjWZH7jV-6QiimLhnldoV5uIpH4EuiT1jfw,25647 | |
pip/_vendor/distlib/_backport/sysconfig.cfg,sha256=swZKxq9RY5e9r3PXCrlvQPMsvOdiWZBTHLEbqS8LJLU,2617 | |
pip/_vendor/distlib/_backport/sysconfig.py,sha256=BQHFlb6pubCl_dvT1NjtzIthylofjKisox239stDg0U,26854 | |
pip/_vendor/distlib/_backport/tarfile.py,sha256=Ihp7rXRcjbIKw8COm9wSePV9ARGXbSF9gGXAMn2Q-KU,92628 | |
pip/_vendor/distlib/compat.py,sha256=xdNZmqFN5HwF30HjRn5M415pcC2kgXRBXn767xS8v-M,41404 | |
pip/_vendor/distlib/database.py,sha256=fhNzEDtb4HXrpxKyQvhVzDXcOiJlzrOM--UYnvCeZrI,51045 | |
pip/_vendor/distlib/index.py,sha256=SXKzpQCERctxYDMp_OLee2f0J0e19ZhGdCIoMlUfUQM,21066 | |
pip/_vendor/distlib/locators.py,sha256=c9E4cDEacJ_uKbuE5BqAVocoWp6rsuBGTkiNDQq3zV4,52100 | |
pip/_vendor/distlib/manifest.py,sha256=nQEhYmgoreaBZzyFzwYsXxJARu3fo4EkunU163U16iE,14811 | |
pip/_vendor/distlib/markers.py,sha256=6Ac3cCfFBERexiESWIOXmg-apIP8l2esafNSX3KMy-8,4387 | |
pip/_vendor/distlib/metadata.py,sha256=OhbCKmf5lswE8unWBopI1hj7tRpHp4ZbFvU4d6aAEMM,40234 | |
pip/_vendor/distlib/resources.py,sha256=2FGv0ZHF14KXjLIlL0R991lyQQGcewOS4mJ-5n-JVnc,10766 | |
pip/_vendor/distlib/scripts.py,sha256=OAkEwxRvIzX-VSfhEttQEKJFVLA47gbW0OgQXJRs7OQ,16998 | |
pip/_vendor/distlib/t32.exe,sha256=NS3xBCVAld35JVFNmb-1QRyVtThukMrwZVeXn4LhaEQ,96768 | |
pip/_vendor/distlib/t64.exe,sha256=oAqHes78rUWVM0OtVqIhUvequl_PKhAhXYQWnUf7zR0,105984 | |
pip/_vendor/distlib/util.py,sha256=f2jZCPrcLCt6LcnC0gUy-Fur60tXD8reA7k4rDpHMDw,59845 | |
pip/_vendor/distlib/version.py,sha256=_n7F6juvQGAcn769E_SHa7fOcf5ERlEVymJ_EjPRwGw,23391 | |
pip/_vendor/distlib/w32.exe,sha256=lJtnZdeUxTZWya_EW5DZos_K5rswRECGspIl8ZJCIXs,90112 | |
pip/_vendor/distlib/w64.exe,sha256=0aRzoN2BO9NWW4ENy4_4vHkHR4qZTFZNVSAJJYlODTI,99840 | |
pip/_vendor/distlib/wheel.py,sha256=bRtR5bNR_u_DwkwktN1bgZuwLVOJT1p_vNIUPyN8kJc,40452 | |
pip/_vendor/distro.py,sha256=xxMIh2a3KmippeWEHzynTdHT3_jZM0o-pos0dAWJROM,43628 | |
pip/_vendor/html5lib/__init__.py,sha256=Ztrn7UvF-wIFAgRBBa0ML-Gu5AffH3BPX_INJx4SaBI,1162 | |
pip/_vendor/html5lib/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/html5lib/__pycache__/_ihatexml.cpython-37.pyc,, | |
pip/_vendor/html5lib/__pycache__/_inputstream.cpython-37.pyc,, | |
pip/_vendor/html5lib/__pycache__/_tokenizer.cpython-37.pyc,, | |
pip/_vendor/html5lib/__pycache__/_utils.cpython-37.pyc,, | |
pip/_vendor/html5lib/__pycache__/constants.cpython-37.pyc,, | |
pip/_vendor/html5lib/__pycache__/html5parser.cpython-37.pyc,, | |
pip/_vendor/html5lib/__pycache__/serializer.cpython-37.pyc,, | |
pip/_vendor/html5lib/_ihatexml.py,sha256=3LBtJMlzgwM8vpQiU1TvGmEEmNH72sV0yD8yS53y07A,16705 | |
pip/_vendor/html5lib/_inputstream.py,sha256=bPUWcAfJScK4xkjQQaG_HsI2BvEVbFvI0AsodDYPQj0,32552 | |
pip/_vendor/html5lib/_tokenizer.py,sha256=YAaOEBD6qc5ISq9Xt9Nif1OFgcybTTfMdwqBkZhpAq4,76580 | |
pip/_vendor/html5lib/_trie/__init__.py,sha256=8VR1bcgD2OpeS2XExpu5yBhP_Q1K-lwKbBKICBPf1kU,289 | |
pip/_vendor/html5lib/_trie/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/html5lib/_trie/__pycache__/_base.cpython-37.pyc,, | |
pip/_vendor/html5lib/_trie/__pycache__/datrie.cpython-37.pyc,, | |
pip/_vendor/html5lib/_trie/__pycache__/py.cpython-37.pyc,, | |
pip/_vendor/html5lib/_trie/_base.py,sha256=CaybYyMro8uERQYjby2tTeSUatnWDfWroUN9N7ety5w,1013 | |
pip/_vendor/html5lib/_trie/datrie.py,sha256=EQpqSfkZRuTbE-DuhW7xMdVDxdZNZ0CfmnYfHA_3zxM,1178 | |
pip/_vendor/html5lib/_trie/py.py,sha256=wXmQLrZRf4MyWNyg0m3h81m9InhLR7GJ002mIIZh-8o,1775 | |
pip/_vendor/html5lib/_utils.py,sha256=ismpASeqa2jqEPQjHUj8vReAf7yIoKnvLN5fuOw6nv0,4015 | |
pip/_vendor/html5lib/constants.py,sha256=4lmZWLtEPRLnl8NzftOoYTJdo6jpeMtP6dqQC0g_bWQ,83518 | |
pip/_vendor/html5lib/filters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_vendor/html5lib/filters/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/__pycache__/alphabeticalattributes.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/__pycache__/base.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/__pycache__/inject_meta_charset.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/__pycache__/lint.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/__pycache__/optionaltags.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/__pycache__/sanitizer.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/__pycache__/whitespace.cpython-37.pyc,, | |
pip/_vendor/html5lib/filters/alphabeticalattributes.py,sha256=lViZc2JMCclXi_5gduvmdzrRxtO5Xo9ONnbHBVCsykU,919 | |
pip/_vendor/html5lib/filters/base.py,sha256=z-IU9ZAYjpsVsqmVt7kuWC63jR11hDMr6CVrvuao8W0,286 | |
pip/_vendor/html5lib/filters/inject_meta_charset.py,sha256=egDXUEHXmAG9504xz0K6ALDgYkvUrC2q15YUVeNlVQg,2945 | |
pip/_vendor/html5lib/filters/lint.py,sha256=jk6q56xY0ojiYfvpdP-OZSm9eTqcAdRqhCoPItemPYA,3643 | |
pip/_vendor/html5lib/filters/optionaltags.py,sha256=8lWT75J0aBOHmPgfmqTHSfPpPMp01T84NKu0CRedxcE,10588 | |
pip/_vendor/html5lib/filters/sanitizer.py,sha256=4ON02KNjuqda1lCw5_JCUZxb0BzWR5M7ON84dtJ7dm0,26248 | |
pip/_vendor/html5lib/filters/whitespace.py,sha256=8eWqZxd4UC4zlFGW6iyY6f-2uuT8pOCSALc3IZt7_t4,1214 | |
pip/_vendor/html5lib/html5parser.py,sha256=g5g2ezkusHxhi7b23vK_-d6K6BfIJRbqIQmvQ9z4EgI,118963 | |
pip/_vendor/html5lib/serializer.py,sha256=yfcfBHse2wDs6ojxn-kieJjLT5s1ipilQJ0gL3-rJis,15758 | |
pip/_vendor/html5lib/treeadapters/__init__.py,sha256=A0rY5gXIe4bJOiSGRO_j_tFhngRBO8QZPzPtPw5dFzo,679 | |
pip/_vendor/html5lib/treeadapters/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/html5lib/treeadapters/__pycache__/genshi.cpython-37.pyc,, | |
pip/_vendor/html5lib/treeadapters/__pycache__/sax.cpython-37.pyc,, | |
pip/_vendor/html5lib/treeadapters/genshi.py,sha256=CH27pAsDKmu4ZGkAUrwty7u0KauGLCZRLPMzaO3M5vo,1715 | |
pip/_vendor/html5lib/treeadapters/sax.py,sha256=BKS8woQTnKiqeffHsxChUqL4q2ZR_wb5fc9MJ3zQC8s,1776 | |
pip/_vendor/html5lib/treebuilders/__init__.py,sha256=AysSJyvPfikCMMsTVvaxwkgDieELD5dfR8FJIAuq7hY,3592 | |
pip/_vendor/html5lib/treebuilders/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/html5lib/treebuilders/__pycache__/base.cpython-37.pyc,, | |
pip/_vendor/html5lib/treebuilders/__pycache__/dom.cpython-37.pyc,, | |
pip/_vendor/html5lib/treebuilders/__pycache__/etree.cpython-37.pyc,, | |
pip/_vendor/html5lib/treebuilders/__pycache__/etree_lxml.cpython-37.pyc,, | |
pip/_vendor/html5lib/treebuilders/base.py,sha256=wQGp5yy22TNG8tJ6aREe4UUeTR7A99dEz0BXVaedWb4,14579 | |
pip/_vendor/html5lib/treebuilders/dom.py,sha256=22whb0C71zXIsai5mamg6qzBEiigcBIvaDy4Asw3at0,8925 | |
pip/_vendor/html5lib/treebuilders/etree.py,sha256=aqIBOGj_dFYqBURIcTegGNBhAIJOw5iFDHb4jrkYH-8,12764 | |
pip/_vendor/html5lib/treebuilders/etree_lxml.py,sha256=9V0dXxbJYYq-Skgb5-_OL2NkVYpjioEb4CHajo0e9yI,14122 | |
pip/_vendor/html5lib/treewalkers/__init__.py,sha256=yhXxHpjlSqfQyUag3v8-vWjMPriFBU8YRAPNpDgBTn8,5714 | |
pip/_vendor/html5lib/treewalkers/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/html5lib/treewalkers/__pycache__/base.cpython-37.pyc,, | |
pip/_vendor/html5lib/treewalkers/__pycache__/dom.cpython-37.pyc,, | |
pip/_vendor/html5lib/treewalkers/__pycache__/etree.cpython-37.pyc,, | |
pip/_vendor/html5lib/treewalkers/__pycache__/etree_lxml.cpython-37.pyc,, | |
pip/_vendor/html5lib/treewalkers/__pycache__/genshi.cpython-37.pyc,, | |
pip/_vendor/html5lib/treewalkers/base.py,sha256=ouiOsuSzvI0KgzdWP8PlxIaSNs9falhbiinAEc_UIJY,7476 | |
pip/_vendor/html5lib/treewalkers/dom.py,sha256=EHyFR8D8lYNnyDU9lx_IKigVJRyecUGua0mOi7HBukc,1413 | |
pip/_vendor/html5lib/treewalkers/etree.py,sha256=sz1o6mmE93NQ53qJFDO7HKyDtuwgK-Ay3qSFZPC6u00,4550 | |
pip/_vendor/html5lib/treewalkers/etree_lxml.py,sha256=sY6wfRshWTllu6n48TPWpKsQRPp-0CQrT0hj_AdzHSU,6309 | |
pip/_vendor/html5lib/treewalkers/genshi.py,sha256=4D2PECZ5n3ZN3qu3jMl9yY7B81jnQApBQSVlfaIuYbA,2309 | |
pip/_vendor/idna/__init__.py,sha256=9Nt7xpyet3DmOrPUGooDdAwmHZZu1qUAy2EaJ93kGiQ,58 | |
pip/_vendor/idna/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/idna/__pycache__/codec.cpython-37.pyc,, | |
pip/_vendor/idna/__pycache__/compat.cpython-37.pyc,, | |
pip/_vendor/idna/__pycache__/core.cpython-37.pyc,, | |
pip/_vendor/idna/__pycache__/idnadata.cpython-37.pyc,, | |
pip/_vendor/idna/__pycache__/intranges.cpython-37.pyc,, | |
pip/_vendor/idna/__pycache__/package_data.cpython-37.pyc,, | |
pip/_vendor/idna/__pycache__/uts46data.cpython-37.pyc,, | |
pip/_vendor/idna/codec.py,sha256=lvYb7yu7PhAqFaAIAdWcwgaWI2UmgseUua-1c0AsG0A,3299 | |
pip/_vendor/idna/compat.py,sha256=R-h29D-6mrnJzbXxymrWUW7iZUvy-26TQwZ0ij57i4U,232 | |
pip/_vendor/idna/core.py,sha256=Hy1RkJrrIQWW8kicqZ8vQT_GreYlAhkfopjESSzL3wk,11844 | |
pip/_vendor/idna/idnadata.py,sha256=p1_KeD9BqT-sDGqMcGxhBWAOrYNrPxj5YvHya0ImFbU,41201 | |
pip/_vendor/idna/intranges.py,sha256=TY1lpxZIQWEP6tNqjZkFA5hgoMWOj1OBmnUG8ihT87E,1749 | |
pip/_vendor/idna/package_data.py,sha256=IjspS_rQQ_0HCGc0CaNhn3NXl3ohvRg7-_P0gAaSc-o,21 | |
pip/_vendor/idna/uts46data.py,sha256=w9d1B5OESLSgr2tMx0svwoPBi0Qj0_7HRyL1Vq5axwg,201192 | |
pip/_vendor/ipaddress.py,sha256=-0RmurI31XgAaN20WCi0zrcuoat90nNA70_6yGlx2PU,79875 | |
pip/_vendor/msgpack/__init__.py,sha256=2gJwcsTIaAtCM0GMi2rU-_Y6kILeeQuqRkrQ22jSANc,1118 | |
pip/_vendor/msgpack/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/msgpack/__pycache__/_version.cpython-37.pyc,, | |
pip/_vendor/msgpack/__pycache__/exceptions.cpython-37.pyc,, | |
pip/_vendor/msgpack/__pycache__/ext.cpython-37.pyc,, | |
pip/_vendor/msgpack/__pycache__/fallback.cpython-37.pyc,, | |
pip/_vendor/msgpack/_version.py,sha256=hu7lzmZ_ClOaOOmRsWb4xomhzQ4UIsLsvv8KY6UysHE,20 | |
pip/_vendor/msgpack/exceptions.py,sha256=dCTWei8dpkrMsQDcjQk74ATl9HsIBH0ybt8zOPNqMYc,1081 | |
pip/_vendor/msgpack/ext.py,sha256=nV19BzE9Be8SJHrxxYJHFbvEHJaXcP3avRkHVp5wovM,6034 | |
pip/_vendor/msgpack/fallback.py,sha256=Z8V3iYUUPqKVy4WWTk64Vq3G0PylQIOmlWvgnMhmkdU,37133 | |
pip/_vendor/packaging/__about__.py,sha256=y-K51xPSysxvOfTjAb074yqOZfDeX5qSID0ZEbEb9cE,744 | |
pip/_vendor/packaging/__init__.py,sha256=6enbp5XgRfjBjsI9-bn00HjHf5TH21PDMOKkJW8xw-w,562 | |
pip/_vendor/packaging/__pycache__/__about__.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/_compat.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/_structures.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/_typing.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/markers.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/requirements.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/specifiers.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/tags.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/utils.cpython-37.pyc,, | |
pip/_vendor/packaging/__pycache__/version.cpython-37.pyc,, | |
pip/_vendor/packaging/_compat.py,sha256=Z-PwchK0cREbaRGF5MZP8LEv8JkC-qydn2FRrtjeixk,1138 | |
pip/_vendor/packaging/_structures.py,sha256=ozkCX8Q8f2qE1Eic3YiQ4buDVfgz2iYevY9e7R2y3iY,2022 | |
pip/_vendor/packaging/_typing.py,sha256=-cq_iNeveAWCVoseVvqmknWLbvZ_i9g7BeZBo0ShtHg,1449 | |
pip/_vendor/packaging/markers.py,sha256=yap5bk3c8QyPuGtiVbQSYhN70bxWj1nLDv2ZuaCLq7g,9501 | |
pip/_vendor/packaging/requirements.py,sha256=G43p2ylM_REg87RLG9JybjbdwfaPyzaKYRtllRfNdrM,4913 | |
pip/_vendor/packaging/specifiers.py,sha256=Nz8bnFp53cQInmRGZy50QXlIi2tkDXMfRuGyGps2IRE,31314 | |
pip/_vendor/packaging/tags.py,sha256=SCrw-jC3h0ymam6QXDX5ZqgvRcMNq_cQD55gFnT56Xg,23704 | |
pip/_vendor/packaging/utils.py,sha256=v5Wk8B7gUL13Rzed6NNhCZlutPQT7jNV-7hr-WOtacU,1700 | |
pip/_vendor/packaging/version.py,sha256=qRdNN0_XuPFOJ3fut8ehzxJrNYtBzqF8ZtagEvgNUUM,15480 | |
pip/_vendor/pep517/__init__.py,sha256=r5uA106NGJa3slspaD2m32aFpFUiZX-mZ9vIlzAEOp4,84 | |
pip/_vendor/pep517/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/_in_process.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/build.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/check.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/colorlog.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/compat.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/dirtools.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/envbuild.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/meta.cpython-37.pyc,, | |
pip/_vendor/pep517/__pycache__/wrappers.cpython-37.pyc,, | |
pip/_vendor/pep517/_in_process.py,sha256=XrKOTURJdia5R7i3i_OQmS89LASFXE3HQXfX63qZBIE,8438 | |
pip/_vendor/pep517/build.py,sha256=DN4ouyj_bd00knOKqv0KHRtN0-JezJoNNZQmcDi4juk,3335 | |
pip/_vendor/pep517/check.py,sha256=YoaNE3poJGpz96biVCYwtcDshwEGE2HRU5KKya9yfpY,5961 | |
pip/_vendor/pep517/colorlog.py,sha256=Tk9AuYm_cLF3BKTBoSTJt9bRryn0aFojIQOwbfVUTxQ,4098 | |
pip/_vendor/pep517/compat.py,sha256=M-5s4VNp8rjyT76ZZ_ibnPD44DYVzSQlyCEHayjtDPw,780 | |
pip/_vendor/pep517/dirtools.py,sha256=2mkAkAL0mRz_elYFjRKuekTJVipH1zTn4tbf1EDev84,1129 | |
pip/_vendor/pep517/envbuild.py,sha256=szKUFlO50X1ahQfXwz4hD9V2VE_bz9MLVPIeidsFo4w,6041 | |
pip/_vendor/pep517/meta.py,sha256=8mnM5lDnT4zXQpBTliJbRGfesH7iioHwozbDxALPS9Y,2463 | |
pip/_vendor/pep517/wrappers.py,sha256=yFU4Lp7TIYbmuVOTY-pXnlyGZ3F_grIi-JlLkpGN8Gk,10783 | |
pip/_vendor/pkg_resources/__init__.py,sha256=XpGBfvS9fafA6bm5rx7vnxdxs7yqyoc_NnpzKApkJ64,108277 | |
pip/_vendor/pkg_resources/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/pkg_resources/__pycache__/py31compat.cpython-37.pyc,, | |
pip/_vendor/pkg_resources/py31compat.py,sha256=CRk8fkiPRDLsbi5pZcKsHI__Pbmh_94L8mr9Qy9Ab2U,562 | |
pip/_vendor/progress/__init__.py,sha256=fcbQQXo5np2CoQyhSH5XprkicwLZNLePR3uIahznSO0,4857 | |
pip/_vendor/progress/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/progress/__pycache__/bar.cpython-37.pyc,, | |
pip/_vendor/progress/__pycache__/counter.cpython-37.pyc,, | |
pip/_vendor/progress/__pycache__/spinner.cpython-37.pyc,, | |
pip/_vendor/progress/bar.py,sha256=QuDuVNcmXgpxtNtxO0Fq72xKigxABaVmxYGBw4J3Z_E,2854 | |
pip/_vendor/progress/counter.py,sha256=MznyBrvPWrOlGe4MZAlGUb9q3aODe6_aNYeAE_VNoYA,1372 | |
pip/_vendor/progress/spinner.py,sha256=k8JbDW94T0-WXuXfxZIFhdoNPYp3jfnpXqBnfRv5fGs,1380 | |
pip/_vendor/pyparsing.py,sha256=J1b4z3S_KwyJW7hKGnoN-hXW9pgMIzIP6QThyY5yJq4,273394 | |
pip/_vendor/requests/__init__.py,sha256=DoS7sn6SOs-Vmi3IHdJFfM1RmlONZHmEKO3DGvyWsnY,4080 | |
pip/_vendor/requests/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/__version__.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/_internal_utils.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/adapters.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/api.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/auth.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/certs.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/compat.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/cookies.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/exceptions.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/help.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/hooks.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/models.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/packages.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/sessions.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/status_codes.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/structures.cpython-37.pyc,, | |
pip/_vendor/requests/__pycache__/utils.cpython-37.pyc,, | |
pip/_vendor/requests/__version__.py,sha256=dpcXABdGo9y3UFFKFU_Wu_YHSa7TBXxCghOju7S8IYs,441 | |
pip/_vendor/requests/_internal_utils.py,sha256=Zx3PnEUccyfsB-ie11nZVAW8qClJy0gx1qNME7rgT18,1096 | |
pip/_vendor/requests/adapters.py,sha256=e-bmKEApNVqFdylxuMJJfiaHdlmS_zhWhIMEzlHvGuc,21548 | |
pip/_vendor/requests/api.py,sha256=PlHM-HT3PQ5lyufoeGmV-nJxRi7UnUyGVh7OV7B9XV4,6496 | |
pip/_vendor/requests/auth.py,sha256=OMoJIVKyRLy9THr91y8rxysZuclwPB-K1Xg1zBomUhQ,10207 | |
pip/_vendor/requests/certs.py,sha256=nXRVq9DtGmv_1AYbwjTu9UrgAcdJv05ZvkNeaoLOZxY,465 | |
pip/_vendor/requests/compat.py,sha256=LQWuCR4qXk6w7-qQopXyz0WNHUdAD40k0mKnaAEf1-g,2045 | |
pip/_vendor/requests/cookies.py,sha256=Y-bKX6TvW3FnYlE6Au0SXtVVWcaNdFvuAwQxw-G0iTI,18430 | |
pip/_vendor/requests/exceptions.py,sha256=-mLam3TAx80V09EaH3H-ZxR61eAVuLRZ8zgBBSLjK44,3197 | |
pip/_vendor/requests/help.py,sha256=SJPVcoXeo7KfK4AxJN5eFVQCjr0im87tU2n7ubLsksU,3578 | |
pip/_vendor/requests/hooks.py,sha256=QReGyy0bRcr5rkwCuObNakbYsc7EkiKeBwG4qHekr2Q,757 | |
pip/_vendor/requests/models.py,sha256=P7sUBpjV7iIzjpf9rYVzHaOXlxlzJk5ikFP_Nsg6zAU,34278 | |
pip/_vendor/requests/packages.py,sha256=njJmVifY4aSctuW3PP5EFRCxjEwMRDO6J_feG2dKWsI,695 | |
pip/_vendor/requests/sessions.py,sha256=Ju8VnlWZPU_Xr-cMjKXNbs_l2cyanr3Dm9c7fLxprQI,29265 | |
pip/_vendor/requests/status_codes.py,sha256=gT79Pbs_cQjBgp-fvrUgg1dn2DQO32bDj4TInjnMPSc,4188 | |
pip/_vendor/requests/structures.py,sha256=msAtr9mq1JxHd-JRyiILfdFlpbJwvvFuP3rfUQT_QxE,3005 | |
pip/_vendor/requests/utils.py,sha256=VBs99cvV8Z29WGXeWZqHzZ80_nu1AwwjYzJfe0wQIvs,30176 | |
pip/_vendor/resolvelib/__init__.py,sha256=aBndiGQ3I68Ezdv0fMPQ9ek6ScvwpuQRimxn6wp7pJ4,537 | |
pip/_vendor/resolvelib/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/resolvelib/__pycache__/providers.cpython-37.pyc,, | |
pip/_vendor/resolvelib/__pycache__/reporters.cpython-37.pyc,, | |
pip/_vendor/resolvelib/__pycache__/resolvers.cpython-37.pyc,, | |
pip/_vendor/resolvelib/__pycache__/structs.cpython-37.pyc,, | |
pip/_vendor/resolvelib/providers.py,sha256=1JCBbBV0E_Q1o0XOAeAdr2YaKU_zHxO7i_BBLqCLhUc,4913 | |
pip/_vendor/resolvelib/reporters.py,sha256=5gXUn3hRjA4UomD3HHZGreBp23aSjMHgBrC3OgYSpTY,1094 | |
pip/_vendor/resolvelib/resolvers.py,sha256=nTTfBBIMsoxGhqUAyh8GbmR-si_TijpY67wD7aUS264,14481 | |
pip/_vendor/resolvelib/structs.py,sha256=yrdhd-n7DercimPGclXe20rgqhlxw8PnxC0wmcXO19Y,2016 | |
pip/_vendor/retrying.py,sha256=k3fflf5_Mm0XcIJYhB7Tj34bqCCPhUDkYbx1NvW2FPE,9972 | |
pip/_vendor/six.py,sha256=Q6WvEXZ1DGEASAo3CGNCJkKv2tPy8xkSmK-VHE9PYIA,34074 | |
pip/_vendor/toml.py,sha256=D8pTQbgSGge2nDdpsAk8_C7UGJeva0qFq2tGGNaE70Q,35675 | |
pip/_vendor/toml/__init__.py,sha256=CwtvzaEThoIbqNwJJB8BhHoA5clb2_x8V42UF6JAysA,527 | |
pip/_vendor/toml/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/toml/__pycache__/decoder.cpython-37.pyc,, | |
pip/_vendor/toml/__pycache__/encoder.cpython-37.pyc,, | |
pip/_vendor/toml/__pycache__/ordered.cpython-37.pyc,, | |
pip/_vendor/toml/__pycache__/tz.cpython-37.pyc,, | |
pip/_vendor/toml/decoder.py,sha256=8uIcWLLyMFwBGT3fiph98KDx8uF_V2Pf84Qi43pqNf0,35067 | |
pip/_vendor/toml/encoder.py,sha256=Nw1wrNgcUgod1XbOXwxFSDGqO5blgOi07Lp_6kStTgc,8128 | |
pip/_vendor/toml/ordered.py,sha256=UWt5Eka90IWVBYdvLgY5PXnkBcVYpHjnw9T67rM85T8,378 | |
pip/_vendor/toml/tz.py,sha256=DrAgI3wZxZiGcLuV_l8ueA_nPrYoxQ3hZA9tJSjWRsQ,618 | |
pip/_vendor/urllib3/__init__.py,sha256=oVOeFuNyEg33ShIefD4qSeGvbb-aJ3otjcdX2iswkLM,2683 | |
pip/_vendor/urllib3/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/_collections.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/connection.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/connectionpool.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/exceptions.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/fields.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/filepost.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/poolmanager.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/request.cpython-37.pyc,, | |
pip/_vendor/urllib3/__pycache__/response.cpython-37.pyc,, | |
pip/_vendor/urllib3/_collections.py,sha256=GouVsNzwg6jADZTmimMI6oqmwKSswnMo9dh5tGNVWO4,10792 | |
pip/_vendor/urllib3/connection.py,sha256=wHpV1S60bvXWnqEDtdzmHiY9NwIiKeFwQI5VvX7AtqM,14026 | |
pip/_vendor/urllib3/connectionpool.py,sha256=jg_yTHo2B3Zyo4urYVecyg-34v3hxUrH9B401-c4A9w,36513 | |
pip/_vendor/urllib3/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_vendor/urllib3/contrib/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/__pycache__/_appengine_environ.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/__pycache__/appengine.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/__pycache__/ntlmpool.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/__pycache__/pyopenssl.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/__pycache__/securetransport.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/__pycache__/socks.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/_appengine_environ.py,sha256=bDbyOEhW2CKLJcQqAKAyrEHN-aklsyHFKq6vF8ZFsmk,957 | |
pip/_vendor/urllib3/contrib/_securetransport/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_vendor/urllib3/contrib/_securetransport/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/_securetransport/__pycache__/bindings.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/_securetransport/__pycache__/low_level.cpython-37.pyc,, | |
pip/_vendor/urllib3/contrib/_securetransport/bindings.py,sha256=mullWYFaghBdRWla6HYU-TBgFRTPLBEfxj3jplbeJmQ,16886 | |
pip/_vendor/urllib3/contrib/_securetransport/low_level.py,sha256=V7GnujxnWZh2N2sMsV5N4d9Imymokkm3zBwgt77_bSE,11956 | |
pip/_vendor/urllib3/contrib/appengine.py,sha256=gfdK4T7CRin7v9HRhHDbDh-Hbk66hHDWeoz7nV3PJo8,11034 | |
pip/_vendor/urllib3/contrib/ntlmpool.py,sha256=a402AwGN_Ll3N-4ur_AS6UrU-ycUtlnYqoBF76lORg8,4160 | |
pip/_vendor/urllib3/contrib/pyopenssl.py,sha256=w35mWy_1POZUsbOhurVb_zhf0C1Jkd79AFlucLs6KuQ,16440 | |
pip/_vendor/urllib3/contrib/securetransport.py,sha256=iKzVUAxKnChsADR5YMwc05oEixXDzAk0xPU0g-rc2z8,32275 | |
pip/_vendor/urllib3/contrib/socks.py,sha256=nzDMgDIFJWVubKHqvIn2-SKCO91hhJInP92WgHChGzA,7036 | |
pip/_vendor/urllib3/exceptions.py,sha256=P3e-p9_LScyIxX7FoR3wU0A6hZmDqFAVCz2wgI3D0lM,6607 | |
pip/_vendor/urllib3/fields.py,sha256=kroD76QK-GdHHW7f_AUN4XxDC3OQPI2FFrS9eSL4BCs,8553 | |
pip/_vendor/urllib3/filepost.py,sha256=vj0qbrpT1AFzvvW4SuC8M5kJiw7wftHcSr-7b8UpPpw,2440 | |
pip/_vendor/urllib3/packages/__init__.py,sha256=h4BLhD4tLaBx1adaDtKXfupsgqY0wWLXb_f1_yVlV6A,108 | |
pip/_vendor/urllib3/packages/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/urllib3/packages/__pycache__/six.cpython-37.pyc,, | |
pip/_vendor/urllib3/packages/backports/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0 | |
pip/_vendor/urllib3/packages/backports/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/urllib3/packages/backports/__pycache__/makefile.cpython-37.pyc,, | |
pip/_vendor/urllib3/packages/backports/makefile.py,sha256=005wrvH-_pWSnTFqQ2sdzzh4zVCtQUUQ4mR2Yyxwc0A,1418 | |
pip/_vendor/urllib3/packages/six.py,sha256=adx4z-eM_D0Vvu0IIqVzFACQ_ux9l64y7DkSEfbxCDs,32536 | |
pip/_vendor/urllib3/packages/ssl_match_hostname/__init__.py,sha256=ywgKMtfHi1-DrXlzPfVAhzsLzzqcK7GT6eLgdode1Fg,688 | |
pip/_vendor/urllib3/packages/ssl_match_hostname/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/urllib3/packages/ssl_match_hostname/__pycache__/_implementation.cpython-37.pyc,, | |
pip/_vendor/urllib3/packages/ssl_match_hostname/_implementation.py,sha256=rvQDQviqQLtPJB6MfEgABnBFj3nXft7ZJ3Dx-BC0AQY,5696 | |
pip/_vendor/urllib3/poolmanager.py,sha256=JYUyBUN3IiEknUdjZ7VJrpCQr6SP7vi0WwSndrn8XpE,17053 | |
pip/_vendor/urllib3/request.py,sha256=hhoHvEEatyd9Tn5EbGjQ0emn-ENMCyY591yNWTneINA,6018 | |
pip/_vendor/urllib3/response.py,sha256=5OVDLR6ss88mak30ZhDaSqHxXbbAQ7CIUrktI7B5aPA,27833 | |
pip/_vendor/urllib3/util/__init__.py,sha256=bWNaav_OT-1L7-sxm59cGb59rDORlbhb_4noduM5m0U,1038 | |
pip/_vendor/urllib3/util/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/connection.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/queue.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/request.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/response.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/retry.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/ssl_.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/timeout.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/url.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/__pycache__/wait.cpython-37.pyc,, | |
pip/_vendor/urllib3/util/connection.py,sha256=NsxUAKQ98GKywta--zg57CdVpeTCI6N-GElCq78Dl8U,4637 | |
pip/_vendor/urllib3/util/queue.py,sha256=myTX3JDHntglKQNBf3b6dasHH-uF-W59vzGSQiFdAfI,497 | |
pip/_vendor/urllib3/util/request.py,sha256=C-6-AWffxZG03AdRGoY59uqsn4CVItKU6gjxz7Hc3Mc,3815 | |
pip/_vendor/urllib3/util/response.py,sha256=_WbTQr8xRQuJuY2rTIZxVdJD6mnEOtQupjaK_bF_Vj8,2573 | |
pip/_vendor/urllib3/util/retry.py,sha256=Ui74h44gLIIWkAxT9SK3A2mEvu55-odWgJMw3LiUNGk,15450 | |
pip/_vendor/urllib3/util/ssl_.py,sha256=W52OyrqLO1IQ5kUgzM8fLAO-EgJxuftd5nhcTOD54ew,14167 | |
pip/_vendor/urllib3/util/timeout.py,sha256=bCtaS_xVKaTDJ5VMlroXBfCnPUDNVGZqik7-z83issg,9871 | |
pip/_vendor/urllib3/util/url.py,sha256=6cDyd46labP8STbF0vieWygu2xVhKkgcF1h3tc6HYno,13979 | |
pip/_vendor/urllib3/util/wait.py,sha256=k46KzqIYu3Vnzla5YW3EvtInNlU_QycFqQAghIOxoAg,5406 | |
pip/_vendor/vendor.txt,sha256=ZewT4rljE_Ct9eJsAk0HhDlKSHaguTqeBSGlF1zIgss,440 | |
pip/_vendor/webencodings/__init__.py,sha256=qOBJIuPy_4ByYH6W_bNgJF-qYQ2DoU-dKsDu5yRWCXg,10579 | |
pip/_vendor/webencodings/__pycache__/__init__.cpython-37.pyc,, | |
pip/_vendor/webencodings/__pycache__/labels.cpython-37.pyc,, | |
pip/_vendor/webencodings/__pycache__/mklabels.cpython-37.pyc,, | |
pip/_vendor/webencodings/__pycache__/tests.cpython-37.pyc,, | |
pip/_vendor/webencodings/__pycache__/x_user_defined.cpython-37.pyc,, | |
pip/_vendor/webencodings/labels.py,sha256=4AO_KxTddqGtrL9ns7kAPjb0CcN6xsCIxbK37HY9r3E,8979 | |
pip/_vendor/webencodings/mklabels.py,sha256=GYIeywnpaLnP0GSic8LFWgd0UVvO_l1Nc6YoF-87R_4,1305 | |
pip/_vendor/webencodings/tests.py,sha256=OtGLyjhNY1fvkW1GvLJ_FV9ZoqC9Anyjr7q3kxTbzNs,6563 | |
pip/_vendor/webencodings/x_user_defined.py,sha256=yOqWSdmpytGfUgh_Z6JYgDNhoc-BAHyyeeT15Fr42tM,4307 |
pip |
Wheel-Version: 1.0 | |
Generator: bdist_wheel (0.34.2) | |
Root-Is-Purelib: true | |
Tag: py2-none-any | |
Tag: py3-none-any | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional | |
__version__ = "20.1.1" | |
def main(args=None): | |
# type: (Optional[List[str]]) -> int | |
"""This is an internal API only meant for use by pip's own console scripts. | |
For additional details, see https://github.com/pypa/pip/issues/7498. | |
""" | |
from pip._internal.utils.entrypoints import _wrapper | |
return _wrapper(args) |
from __future__ import absolute_import | |
import os | |
import sys | |
# Remove '' and current working directory from the first entry | |
# of sys.path, if present to avoid using current directory | |
# in pip commands check, freeze, install, list and show, | |
# when invoked as python -m pip <command> | |
if sys.path[0] in ('', os.getcwd()): | |
sys.path.pop(0) | |
# If we are running from a wheel, add the wheel to sys.path | |
# This allows the usage python pip-*.whl/pip install pip-*.whl | |
if __package__ == '': | |
# __file__ is pip-*.whl/pip/__main__.py | |
# first dirname call strips of '/__main__.py', second strips off '/pip' | |
# Resulting path is the name of the wheel itself | |
# Add that to sys.path so we can import pip | |
path = os.path.dirname(os.path.dirname(__file__)) | |
sys.path.insert(0, path) | |
from pip._internal.cli.main import main as _main # isort:skip # noqa | |
if __name__ == '__main__': | |
sys.exit(_main()) |
import pip._internal.utils.inject_securetransport # noqa | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, List | |
def main(args=None): | |
# type: (Optional[List[str]]) -> int | |
"""This is preserved for old console scripts that may still be referencing | |
it. | |
For additional details, see https://github.com/pypa/pip/issues/7498. | |
""" | |
from pip._internal.utils.entrypoints import _wrapper | |
return _wrapper(args) |
"""Build Environment used for isolation during sdist building | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
# mypy: disallow-untyped-defs=False | |
import logging | |
import os | |
import sys | |
import textwrap | |
from collections import OrderedDict | |
from distutils.sysconfig import get_python_lib | |
from sysconfig import get_paths | |
from pip._vendor.pkg_resources import Requirement, VersionConflict, WorkingSet | |
from pip import __file__ as pip_location | |
from pip._internal.cli.spinners import open_spinner | |
from pip._internal.utils.subprocess import call_subprocess | |
from pip._internal.utils.temp_dir import TempDirectory, tempdir_kinds | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Tuple, Set, Iterable, Optional, List | |
from pip._internal.index.package_finder import PackageFinder | |
logger = logging.getLogger(__name__) | |
class _Prefix: | |
def __init__(self, path): | |
# type: (str) -> None | |
self.path = path | |
self.setup = False | |
self.bin_dir = get_paths( | |
'nt' if os.name == 'nt' else 'posix_prefix', | |
vars={'base': path, 'platbase': path} | |
)['scripts'] | |
# Note: prefer distutils' sysconfig to get the | |
# library paths so PyPy is correctly supported. | |
purelib = get_python_lib(plat_specific=False, prefix=path) | |
platlib = get_python_lib(plat_specific=True, prefix=path) | |
if purelib == platlib: | |
self.lib_dirs = [purelib] | |
else: | |
self.lib_dirs = [purelib, platlib] | |
class BuildEnvironment(object): | |
"""Creates and manages an isolated environment to install build deps | |
""" | |
def __init__(self): | |
# type: () -> None | |
temp_dir = TempDirectory( | |
kind=tempdir_kinds.BUILD_ENV, globally_managed=True | |
) | |
self._prefixes = OrderedDict(( | |
(name, _Prefix(os.path.join(temp_dir.path, name))) | |
for name in ('normal', 'overlay') | |
)) | |
self._bin_dirs = [] # type: List[str] | |
self._lib_dirs = [] # type: List[str] | |
for prefix in reversed(list(self._prefixes.values())): | |
self._bin_dirs.append(prefix.bin_dir) | |
self._lib_dirs.extend(prefix.lib_dirs) | |
# Customize site to: | |
# - ensure .pth files are honored | |
# - prevent access to system site packages | |
system_sites = { | |
os.path.normcase(site) for site in ( | |
get_python_lib(plat_specific=False), | |
get_python_lib(plat_specific=True), | |
) | |
} | |
self._site_dir = os.path.join(temp_dir.path, 'site') | |
if not os.path.exists(self._site_dir): | |
os.mkdir(self._site_dir) | |
with open(os.path.join(self._site_dir, 'sitecustomize.py'), 'w') as fp: | |
fp.write(textwrap.dedent( | |
''' | |
import os, site, sys | |
# First, drop system-sites related paths. | |
original_sys_path = sys.path[:] | |
known_paths = set() | |
for path in {system_sites!r}: | |
site.addsitedir(path, known_paths=known_paths) | |
system_paths = set( | |
os.path.normcase(path) | |
for path in sys.path[len(original_sys_path):] | |
) | |
original_sys_path = [ | |
path for path in original_sys_path | |
if os.path.normcase(path) not in system_paths | |
] | |
sys.path = original_sys_path | |
# Second, add lib directories. | |
# ensuring .pth file are processed. | |
for path in {lib_dirs!r}: | |
assert not path in sys.path | |
site.addsitedir(path) | |
''' | |
).format(system_sites=system_sites, lib_dirs=self._lib_dirs)) | |
def __enter__(self): | |
self._save_env = { | |
name: os.environ.get(name, None) | |
for name in ('PATH', 'PYTHONNOUSERSITE', 'PYTHONPATH') | |
} | |
path = self._bin_dirs[:] | |
old_path = self._save_env['PATH'] | |
if old_path: | |
path.extend(old_path.split(os.pathsep)) | |
pythonpath = [self._site_dir] | |
os.environ.update({ | |
'PATH': os.pathsep.join(path), | |
'PYTHONNOUSERSITE': '1', | |
'PYTHONPATH': os.pathsep.join(pythonpath), | |
}) | |
def __exit__(self, exc_type, exc_val, exc_tb): | |
for varname, old_value in self._save_env.items(): | |
if old_value is None: | |
os.environ.pop(varname, None) | |
else: | |
os.environ[varname] = old_value | |
def check_requirements(self, reqs): | |
# type: (Iterable[str]) -> Tuple[Set[Tuple[str, str]], Set[str]] | |
"""Return 2 sets: | |
- conflicting requirements: set of (installed, wanted) reqs tuples | |
- missing requirements: set of reqs | |
""" | |
missing = set() | |
conflicting = set() | |
if reqs: | |
ws = WorkingSet(self._lib_dirs) | |
for req in reqs: | |
try: | |
if ws.find(Requirement.parse(req)) is None: | |
missing.add(req) | |
except VersionConflict as e: | |
conflicting.add((str(e.args[0].as_requirement()), | |
str(e.args[1]))) | |
return conflicting, missing | |
def install_requirements( | |
self, | |
finder, # type: PackageFinder | |
requirements, # type: Iterable[str] | |
prefix_as_string, # type: str | |
message # type: Optional[str] | |
): | |
# type: (...) -> None | |
prefix = self._prefixes[prefix_as_string] | |
assert not prefix.setup | |
prefix.setup = True | |
if not requirements: | |
return | |
args = [ | |
sys.executable, os.path.dirname(pip_location), 'install', | |
'--ignore-installed', '--no-user', '--prefix', prefix.path, | |
'--no-warn-script-location', | |
] # type: List[str] | |
if logger.getEffectiveLevel() <= logging.DEBUG: | |
args.append('-v') | |
for format_control in ('no_binary', 'only_binary'): | |
formats = getattr(finder.format_control, format_control) | |
args.extend(('--' + format_control.replace('_', '-'), | |
','.join(sorted(formats or {':none:'})))) | |
index_urls = finder.index_urls | |
if index_urls: | |
args.extend(['-i', index_urls[0]]) | |
for extra_index in index_urls[1:]: | |
args.extend(['--extra-index-url', extra_index]) | |
else: | |
args.append('--no-index') | |
for link in finder.find_links: | |
args.extend(['--find-links', link]) | |
for host in finder.trusted_hosts: | |
args.extend(['--trusted-host', host]) | |
if finder.allow_all_prereleases: | |
args.append('--pre') | |
args.append('--') | |
args.extend(requirements) | |
with open_spinner(message) as spinner: | |
call_subprocess(args, spinner=spinner) | |
class NoOpBuildEnvironment(BuildEnvironment): | |
"""A no-op drop-in replacement for BuildEnvironment | |
""" | |
def __init__(self): | |
pass | |
def __enter__(self): | |
pass | |
def __exit__(self, exc_type, exc_val, exc_tb): | |
pass | |
def cleanup(self): | |
pass | |
def install_requirements(self, finder, requirements, prefix, message): | |
raise NotImplementedError() |
"""Cache Management | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
import hashlib | |
import json | |
import logging | |
import os | |
from pip._vendor.packaging.tags import interpreter_name, interpreter_version | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.exceptions import InvalidWheelFilename | |
from pip._internal.models.link import Link | |
from pip._internal.models.wheel import Wheel | |
from pip._internal.utils.temp_dir import TempDirectory, tempdir_kinds | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import path_to_url | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Set, List, Any, Dict | |
from pip._vendor.packaging.tags import Tag | |
from pip._internal.models.format_control import FormatControl | |
logger = logging.getLogger(__name__) | |
def _hash_dict(d): | |
# type: (Dict[str, str]) -> str | |
"""Return a stable sha224 of a dictionary.""" | |
s = json.dumps(d, sort_keys=True, separators=(",", ":"), ensure_ascii=True) | |
return hashlib.sha224(s.encode("ascii")).hexdigest() | |
class Cache(object): | |
"""An abstract class - provides cache directories for data from links | |
:param cache_dir: The root of the cache. | |
:param format_control: An object of FormatControl class to limit | |
binaries being read from the cache. | |
:param allowed_formats: which formats of files the cache should store. | |
('binary' and 'source' are the only allowed values) | |
""" | |
def __init__(self, cache_dir, format_control, allowed_formats): | |
# type: (str, FormatControl, Set[str]) -> None | |
super(Cache, self).__init__() | |
assert not cache_dir or os.path.isabs(cache_dir) | |
self.cache_dir = cache_dir or None | |
self.format_control = format_control | |
self.allowed_formats = allowed_formats | |
_valid_formats = {"source", "binary"} | |
assert self.allowed_formats.union(_valid_formats) == _valid_formats | |
def _get_cache_path_parts_legacy(self, link): | |
# type: (Link) -> List[str] | |
"""Get parts of part that must be os.path.joined with cache_dir | |
Legacy cache key (pip < 20) for compatibility with older caches. | |
""" | |
# We want to generate an url to use as our cache key, we don't want to | |
# just re-use the URL because it might have other items in the fragment | |
# and we don't care about those. | |
key_parts = [link.url_without_fragment] | |
if link.hash_name is not None and link.hash is not None: | |
key_parts.append("=".join([link.hash_name, link.hash])) | |
key_url = "#".join(key_parts) | |
# Encode our key url with sha224, we'll use this because it has similar | |
# security properties to sha256, but with a shorter total output (and | |
# thus less secure). However the differences don't make a lot of | |
# difference for our use case here. | |
hashed = hashlib.sha224(key_url.encode()).hexdigest() | |
# We want to nest the directories some to prevent having a ton of top | |
# level directories where we might run out of sub directories on some | |
# FS. | |
parts = [hashed[:2], hashed[2:4], hashed[4:6], hashed[6:]] | |
return parts | |
def _get_cache_path_parts(self, link): | |
# type: (Link) -> List[str] | |
"""Get parts of part that must be os.path.joined with cache_dir | |
""" | |
# We want to generate an url to use as our cache key, we don't want to | |
# just re-use the URL because it might have other items in the fragment | |
# and we don't care about those. | |
key_parts = {"url": link.url_without_fragment} | |
if link.hash_name is not None and link.hash is not None: | |
key_parts[link.hash_name] = link.hash | |
if link.subdirectory_fragment: | |
key_parts["subdirectory"] = link.subdirectory_fragment | |
# Include interpreter name, major and minor version in cache key | |
# to cope with ill-behaved sdists that build a different wheel | |
# depending on the python version their setup.py is being run on, | |
# and don't encode the difference in compatibility tags. | |
# https://github.com/pypa/pip/issues/7296 | |
key_parts["interpreter_name"] = interpreter_name() | |
key_parts["interpreter_version"] = interpreter_version() | |
# Encode our key url with sha224, we'll use this because it has similar | |
# security properties to sha256, but with a shorter total output (and | |
# thus less secure). However the differences don't make a lot of | |
# difference for our use case here. | |
hashed = _hash_dict(key_parts) | |
# We want to nest the directories some to prevent having a ton of top | |
# level directories where we might run out of sub directories on some | |
# FS. | |
parts = [hashed[:2], hashed[2:4], hashed[4:6], hashed[6:]] | |
return parts | |
def _get_candidates(self, link, canonical_package_name): | |
# type: (Link, Optional[str]) -> List[Any] | |
can_not_cache = ( | |
not self.cache_dir or | |
not canonical_package_name or | |
not link | |
) | |
if can_not_cache: | |
return [] | |
formats = self.format_control.get_allowed_formats( | |
canonical_package_name | |
) | |
if not self.allowed_formats.intersection(formats): | |
return [] | |
candidates = [] | |
path = self.get_path_for_link(link) | |
if os.path.isdir(path): | |
for candidate in os.listdir(path): | |
candidates.append((candidate, path)) | |
# TODO remove legacy path lookup in pip>=21 | |
legacy_path = self.get_path_for_link_legacy(link) | |
if os.path.isdir(legacy_path): | |
for candidate in os.listdir(legacy_path): | |
candidates.append((candidate, legacy_path)) | |
return candidates | |
def get_path_for_link_legacy(self, link): | |
# type: (Link) -> str | |
raise NotImplementedError() | |
def get_path_for_link(self, link): | |
# type: (Link) -> str | |
"""Return a directory to store cached items in for link. | |
""" | |
raise NotImplementedError() | |
def get( | |
self, | |
link, # type: Link | |
package_name, # type: Optional[str] | |
supported_tags, # type: List[Tag] | |
): | |
# type: (...) -> Link | |
"""Returns a link to a cached item if it exists, otherwise returns the | |
passed link. | |
""" | |
raise NotImplementedError() | |
class SimpleWheelCache(Cache): | |
"""A cache of wheels for future installs. | |
""" | |
def __init__(self, cache_dir, format_control): | |
# type: (str, FormatControl) -> None | |
super(SimpleWheelCache, self).__init__( | |
cache_dir, format_control, {"binary"} | |
) | |
def get_path_for_link_legacy(self, link): | |
# type: (Link) -> str | |
parts = self._get_cache_path_parts_legacy(link) | |
return os.path.join(self.cache_dir, "wheels", *parts) | |
def get_path_for_link(self, link): | |
# type: (Link) -> str | |
"""Return a directory to store cached wheels for link | |
Because there are M wheels for any one sdist, we provide a directory | |
to cache them in, and then consult that directory when looking up | |
cache hits. | |
We only insert things into the cache if they have plausible version | |
numbers, so that we don't contaminate the cache with things that were | |
not unique. E.g. ./package might have dozens of installs done for it | |
and build a version of 0.0...and if we built and cached a wheel, we'd | |
end up using the same wheel even if the source has been edited. | |
:param link: The link of the sdist for which this will cache wheels. | |
""" | |
parts = self._get_cache_path_parts(link) | |
# Store wheels within the root cache_dir | |
return os.path.join(self.cache_dir, "wheels", *parts) | |
def get( | |
self, | |
link, # type: Link | |
package_name, # type: Optional[str] | |
supported_tags, # type: List[Tag] | |
): | |
# type: (...) -> Link | |
candidates = [] | |
if not package_name: | |
return link | |
canonical_package_name = canonicalize_name(package_name) | |
for wheel_name, wheel_dir in self._get_candidates( | |
link, canonical_package_name | |
): | |
try: | |
wheel = Wheel(wheel_name) | |
except InvalidWheelFilename: | |
continue | |
if canonicalize_name(wheel.name) != canonical_package_name: | |
logger.debug( | |
"Ignoring cached wheel {} for {} as it " | |
"does not match the expected distribution name {}.".format( | |
wheel_name, link, package_name | |
) | |
) | |
continue | |
if not wheel.supported(supported_tags): | |
# Built for a different python/arch/etc | |
continue | |
candidates.append( | |
( | |
wheel.support_index_min(supported_tags), | |
wheel_name, | |
wheel_dir, | |
) | |
) | |
if not candidates: | |
return link | |
_, wheel_name, wheel_dir = min(candidates) | |
return Link(path_to_url(os.path.join(wheel_dir, wheel_name))) | |
class EphemWheelCache(SimpleWheelCache): | |
"""A SimpleWheelCache that creates it's own temporary cache directory | |
""" | |
def __init__(self, format_control): | |
# type: (FormatControl) -> None | |
self._temp_dir = TempDirectory( | |
kind=tempdir_kinds.EPHEM_WHEEL_CACHE, | |
globally_managed=True, | |
) | |
super(EphemWheelCache, self).__init__( | |
self._temp_dir.path, format_control | |
) | |
class CacheEntry(object): | |
def __init__( | |
self, | |
link, # type: Link | |
persistent, # type: bool | |
): | |
self.link = link | |
self.persistent = persistent | |
class WheelCache(Cache): | |
"""Wraps EphemWheelCache and SimpleWheelCache into a single Cache | |
This Cache allows for gracefully degradation, using the ephem wheel cache | |
when a certain link is not found in the simple wheel cache first. | |
""" | |
def __init__(self, cache_dir, format_control): | |
# type: (str, FormatControl) -> None | |
super(WheelCache, self).__init__( | |
cache_dir, format_control, {'binary'} | |
) | |
self._wheel_cache = SimpleWheelCache(cache_dir, format_control) | |
self._ephem_cache = EphemWheelCache(format_control) | |
def get_path_for_link_legacy(self, link): | |
# type: (Link) -> str | |
return self._wheel_cache.get_path_for_link_legacy(link) | |
def get_path_for_link(self, link): | |
# type: (Link) -> str | |
return self._wheel_cache.get_path_for_link(link) | |
def get_ephem_path_for_link(self, link): | |
# type: (Link) -> str | |
return self._ephem_cache.get_path_for_link(link) | |
def get( | |
self, | |
link, # type: Link | |
package_name, # type: Optional[str] | |
supported_tags, # type: List[Tag] | |
): | |
# type: (...) -> Link | |
cache_entry = self.get_cache_entry(link, package_name, supported_tags) | |
if cache_entry is None: | |
return link | |
return cache_entry.link | |
def get_cache_entry( | |
self, | |
link, # type: Link | |
package_name, # type: Optional[str] | |
supported_tags, # type: List[Tag] | |
): | |
# type: (...) -> Optional[CacheEntry] | |
"""Returns a CacheEntry with a link to a cached item if it exists or | |
None. The cache entry indicates if the item was found in the persistent | |
or ephemeral cache. | |
""" | |
retval = self._wheel_cache.get( | |
link=link, | |
package_name=package_name, | |
supported_tags=supported_tags, | |
) | |
if retval is not link: | |
return CacheEntry(retval, persistent=True) | |
retval = self._ephem_cache.get( | |
link=link, | |
package_name=package_name, | |
supported_tags=supported_tags, | |
) | |
if retval is not link: | |
return CacheEntry(retval, persistent=False) | |
return None |
"""Subpackage containing all of pip's command line interface related code | |
""" | |
# This file intentionally does not import submodules |
"""Logic that powers autocompletion installed by ``pip completion``. | |
""" | |
import optparse | |
import os | |
import sys | |
from itertools import chain | |
from pip._internal.cli.main_parser import create_main_parser | |
from pip._internal.commands import commands_dict, create_command | |
from pip._internal.utils.misc import get_installed_distributions | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Iterable, List, Optional | |
def autocomplete(): | |
# type: () -> None | |
"""Entry Point for completion of main and subcommand options. | |
""" | |
# Don't complete if user hasn't sourced bash_completion file. | |
if 'PIP_AUTO_COMPLETE' not in os.environ: | |
return | |
cwords = os.environ['COMP_WORDS'].split()[1:] | |
cword = int(os.environ['COMP_CWORD']) | |
try: | |
current = cwords[cword - 1] | |
except IndexError: | |
current = '' | |
parser = create_main_parser() | |
subcommands = list(commands_dict) | |
options = [] | |
# subcommand | |
subcommand_name = None # type: Optional[str] | |
for word in cwords: | |
if word in subcommands: | |
subcommand_name = word | |
break | |
# subcommand options | |
if subcommand_name is not None: | |
# special case: 'help' subcommand has no options | |
if subcommand_name == 'help': | |
sys.exit(1) | |
# special case: list locally installed dists for show and uninstall | |
should_list_installed = ( | |
subcommand_name in ['show', 'uninstall'] and | |
not current.startswith('-') | |
) | |
if should_list_installed: | |
installed = [] | |
lc = current.lower() | |
for dist in get_installed_distributions(local_only=True): | |
if dist.key.startswith(lc) and dist.key not in cwords[1:]: | |
installed.append(dist.key) | |
# if there are no dists installed, fall back to option completion | |
if installed: | |
for dist in installed: | |
print(dist) | |
sys.exit(1) | |
subcommand = create_command(subcommand_name) | |
for opt in subcommand.parser.option_list_all: | |
if opt.help != optparse.SUPPRESS_HELP: | |
for opt_str in opt._long_opts + opt._short_opts: | |
options.append((opt_str, opt.nargs)) | |
# filter out previously specified options from available options | |
prev_opts = [x.split('=')[0] for x in cwords[1:cword - 1]] | |
options = [(x, v) for (x, v) in options if x not in prev_opts] | |
# filter options by current input | |
options = [(k, v) for k, v in options if k.startswith(current)] | |
# get completion type given cwords and available subcommand options | |
completion_type = get_path_completion_type( | |
cwords, cword, subcommand.parser.option_list_all, | |
) | |
# get completion files and directories if ``completion_type`` is | |
# ``<file>``, ``<dir>`` or ``<path>`` | |
if completion_type: | |
paths = auto_complete_paths(current, completion_type) | |
options = [(path, 0) for path in paths] | |
for option in options: | |
opt_label = option[0] | |
# append '=' to options which require args | |
if option[1] and option[0][:2] == "--": | |
opt_label += '=' | |
print(opt_label) | |
else: | |
# show main parser options only when necessary | |
opts = [i.option_list for i in parser.option_groups] | |
opts.append(parser.option_list) | |
flattened_opts = chain.from_iterable(opts) | |
if current.startswith('-'): | |
for opt in flattened_opts: | |
if opt.help != optparse.SUPPRESS_HELP: | |
subcommands += opt._long_opts + opt._short_opts | |
else: | |
# get completion type given cwords and all available options | |
completion_type = get_path_completion_type(cwords, cword, | |
flattened_opts) | |
if completion_type: | |
subcommands = list(auto_complete_paths(current, | |
completion_type)) | |
print(' '.join([x for x in subcommands if x.startswith(current)])) | |
sys.exit(1) | |
def get_path_completion_type(cwords, cword, opts): | |
# type: (List[str], int, Iterable[Any]) -> Optional[str] | |
"""Get the type of path completion (``file``, ``dir``, ``path`` or None) | |
:param cwords: same as the environmental variable ``COMP_WORDS`` | |
:param cword: same as the environmental variable ``COMP_CWORD`` | |
:param opts: The available options to check | |
:return: path completion type (``file``, ``dir``, ``path`` or None) | |
""" | |
if cword < 2 or not cwords[cword - 2].startswith('-'): | |
return None | |
for opt in opts: | |
if opt.help == optparse.SUPPRESS_HELP: | |
continue | |
for o in str(opt).split('/'): | |
if cwords[cword - 2].split('=')[0] == o: | |
if not opt.metavar or any( | |
x in ('path', 'file', 'dir') | |
for x in opt.metavar.split('/')): | |
return opt.metavar | |
return None | |
def auto_complete_paths(current, completion_type): | |
# type: (str, str) -> Iterable[str] | |
"""If ``completion_type`` is ``file`` or ``path``, list all regular files | |
and directories starting with ``current``; otherwise only list directories | |
starting with ``current``. | |
:param current: The word to be completed | |
:param completion_type: path completion type(`file`, `path` or `dir`)i | |
:return: A generator of regular files and/or directories | |
""" | |
directory, filename = os.path.split(current) | |
current_path = os.path.abspath(directory) | |
# Don't complete paths if they can't be accessed | |
if not os.access(current_path, os.R_OK): | |
return | |
filename = os.path.normcase(filename) | |
# list all files that start with ``filename`` | |
file_list = (x for x in os.listdir(current_path) | |
if os.path.normcase(x).startswith(filename)) | |
for f in file_list: | |
opt = os.path.join(current_path, f) | |
comp_file = os.path.normcase(os.path.join(directory, f)) | |
# complete regular files when there is not ``<dir>`` after option | |
# complete directories when there is ``<file>``, ``<path>`` or | |
# ``<dir>``after option | |
if completion_type != 'dir' and os.path.isfile(opt): | |
yield comp_file | |
elif os.path.isdir(opt): | |
yield os.path.join(comp_file, '') |
"""Base Command class, and related routines""" | |
from __future__ import absolute_import, print_function | |
import logging | |
import logging.config | |
import optparse | |
import os | |
import platform | |
import sys | |
import traceback | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.command_context import CommandContextMixIn | |
from pip._internal.cli.parser import ( | |
ConfigOptionParser, | |
UpdatingDefaultsHelpFormatter, | |
) | |
from pip._internal.cli.status_codes import ( | |
ERROR, | |
PREVIOUS_BUILD_DIR_ERROR, | |
SUCCESS, | |
UNKNOWN_ERROR, | |
VIRTUALENV_NOT_FOUND, | |
) | |
from pip._internal.exceptions import ( | |
BadCommand, | |
CommandError, | |
InstallationError, | |
PreviousBuildDirError, | |
UninstallationError, | |
) | |
from pip._internal.utils.deprecation import deprecated | |
from pip._internal.utils.filesystem import check_path_owner | |
from pip._internal.utils.logging import BrokenStdoutLoggingError, setup_logging | |
from pip._internal.utils.misc import get_prog, normalize_path | |
from pip._internal.utils.temp_dir import ( | |
global_tempdir_manager, | |
tempdir_registry, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.virtualenv import running_under_virtualenv | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional, Tuple, Any | |
from optparse import Values | |
from pip._internal.utils.temp_dir import ( | |
TempDirectoryTypeRegistry as TempDirRegistry | |
) | |
__all__ = ['Command'] | |
logger = logging.getLogger(__name__) | |
class Command(CommandContextMixIn): | |
usage = None # type: str | |
ignore_require_venv = False # type: bool | |
def __init__(self, name, summary, isolated=False): | |
# type: (str, str, bool) -> None | |
super(Command, self).__init__() | |
parser_kw = { | |
'usage': self.usage, | |
'prog': '{} {}'.format(get_prog(), name), | |
'formatter': UpdatingDefaultsHelpFormatter(), | |
'add_help_option': False, | |
'name': name, | |
'description': self.__doc__, | |
'isolated': isolated, | |
} | |
self.name = name | |
self.summary = summary | |
self.parser = ConfigOptionParser(**parser_kw) | |
self.tempdir_registry = None # type: Optional[TempDirRegistry] | |
# Commands should add options to this option group | |
optgroup_name = '{} Options'.format(self.name.capitalize()) | |
self.cmd_opts = optparse.OptionGroup(self.parser, optgroup_name) | |
# Add the general options | |
gen_opts = cmdoptions.make_option_group( | |
cmdoptions.general_group, | |
self.parser, | |
) | |
self.parser.add_option_group(gen_opts) | |
def handle_pip_version_check(self, options): | |
# type: (Values) -> None | |
""" | |
This is a no-op so that commands by default do not do the pip version | |
check. | |
""" | |
# Make sure we do the pip version check if the index_group options | |
# are present. | |
assert not hasattr(options, 'no_index') | |
def run(self, options, args): | |
# type: (Values, List[Any]) -> Any | |
raise NotImplementedError | |
def parse_args(self, args): | |
# type: (List[str]) -> Tuple[Any, Any] | |
# factored out for testability | |
return self.parser.parse_args(args) | |
def main(self, args): | |
# type: (List[str]) -> int | |
try: | |
with self.main_context(): | |
return self._main(args) | |
finally: | |
logging.shutdown() | |
def _main(self, args): | |
# type: (List[str]) -> int | |
# We must initialize this before the tempdir manager, otherwise the | |
# configuration would not be accessible by the time we clean up the | |
# tempdir manager. | |
self.tempdir_registry = self.enter_context(tempdir_registry()) | |
# Intentionally set as early as possible so globally-managed temporary | |
# directories are available to the rest of the code. | |
self.enter_context(global_tempdir_manager()) | |
options, args = self.parse_args(args) | |
# Set verbosity so that it can be used elsewhere. | |
self.verbosity = options.verbose - options.quiet | |
level_number = setup_logging( | |
verbosity=self.verbosity, | |
no_color=options.no_color, | |
user_log_file=options.log, | |
) | |
if ( | |
sys.version_info[:2] == (2, 7) and | |
not options.no_python_version_warning | |
): | |
message = ( | |
"pip 21.0 will drop support for Python 2.7 in January 2021. " | |
"More details about Python 2 support in pip, can be found at " | |
"https://pip.pypa.io/en/latest/development/release-process/#python-2-support" # noqa | |
) | |
if platform.python_implementation() == "CPython": | |
message = ( | |
"Python 2.7 reached the end of its life on January " | |
"1st, 2020. Please upgrade your Python as Python 2.7 " | |
"is no longer maintained. " | |
) + message | |
deprecated(message, replacement=None, gone_in=None) | |
# TODO: Try to get these passing down from the command? | |
# without resorting to os.environ to hold these. | |
# This also affects isolated builds and it should. | |
if options.no_input: | |
os.environ['PIP_NO_INPUT'] = '1' | |
if options.exists_action: | |
os.environ['PIP_EXISTS_ACTION'] = ' '.join(options.exists_action) | |
if options.require_venv and not self.ignore_require_venv: | |
# If a venv is required check if it can really be found | |
if not running_under_virtualenv(): | |
logger.critical( | |
'Could not find an activated virtualenv (required).' | |
) | |
sys.exit(VIRTUALENV_NOT_FOUND) | |
if options.cache_dir: | |
options.cache_dir = normalize_path(options.cache_dir) | |
if not check_path_owner(options.cache_dir): | |
logger.warning( | |
"The directory '%s' or its parent directory is not owned " | |
"or is not writable by the current user. The cache " | |
"has been disabled. Check the permissions and owner of " | |
"that directory. If executing pip with sudo, you may want " | |
"sudo's -H flag.", | |
options.cache_dir, | |
) | |
options.cache_dir = None | |
try: | |
status = self.run(options, args) | |
# FIXME: all commands should return an exit status | |
# and when it is done, isinstance is not needed anymore | |
if isinstance(status, int): | |
return status | |
except PreviousBuildDirError as exc: | |
logger.critical(str(exc)) | |
logger.debug('Exception information:', exc_info=True) | |
return PREVIOUS_BUILD_DIR_ERROR | |
except (InstallationError, UninstallationError, BadCommand) as exc: | |
logger.critical(str(exc)) | |
logger.debug('Exception information:', exc_info=True) | |
return ERROR | |
except CommandError as exc: | |
logger.critical('%s', exc) | |
logger.debug('Exception information:', exc_info=True) | |
return ERROR | |
except BrokenStdoutLoggingError: | |
# Bypass our logger and write any remaining messages to stderr | |
# because stdout no longer works. | |
print('ERROR: Pipe to stdout was broken', file=sys.stderr) | |
if level_number <= logging.DEBUG: | |
traceback.print_exc(file=sys.stderr) | |
return ERROR | |
except KeyboardInterrupt: | |
logger.critical('Operation cancelled by user') | |
logger.debug('Exception information:', exc_info=True) | |
return ERROR | |
except BaseException: | |
logger.critical('Exception:', exc_info=True) | |
return UNKNOWN_ERROR | |
finally: | |
self.handle_pip_version_check(options) | |
return SUCCESS |
""" | |
shared options and groups | |
The principle here is to define options once, but *not* instantiate them | |
globally. One reason being that options with action='append' can carry state | |
between parses. pip parses general options twice internally, and shouldn't | |
pass on state. To be consistent, all options will follow this design. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
import textwrap | |
import warnings | |
from distutils.util import strtobool | |
from functools import partial | |
from optparse import SUPPRESS_HELP, Option, OptionGroup | |
from textwrap import dedent | |
from pip._internal.cli.progress_bars import BAR_TYPES | |
from pip._internal.exceptions import CommandError | |
from pip._internal.locations import USER_CACHE_DIR, get_src_prefix | |
from pip._internal.models.format_control import FormatControl | |
from pip._internal.models.index import PyPI | |
from pip._internal.models.target_python import TargetPython | |
from pip._internal.utils.hashes import STRONG_HASHES | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Callable, Dict, Optional, Tuple | |
from optparse import OptionParser, Values | |
from pip._internal.cli.parser import ConfigOptionParser | |
logger = logging.getLogger(__name__) | |
def raise_option_error(parser, option, msg): | |
# type: (OptionParser, Option, str) -> None | |
""" | |
Raise an option parsing error using parser.error(). | |
Args: | |
parser: an OptionParser instance. | |
option: an Option instance. | |
msg: the error text. | |
""" | |
msg = '{} error: {}'.format(option, msg) | |
msg = textwrap.fill(' '.join(msg.split())) | |
parser.error(msg) | |
def make_option_group(group, parser): | |
# type: (Dict[str, Any], ConfigOptionParser) -> OptionGroup | |
""" | |
Return an OptionGroup object | |
group -- assumed to be dict with 'name' and 'options' keys | |
parser -- an optparse Parser | |
""" | |
option_group = OptionGroup(parser, group['name']) | |
for option in group['options']: | |
option_group.add_option(option()) | |
return option_group | |
def check_install_build_global(options, check_options=None): | |
# type: (Values, Optional[Values]) -> None | |
"""Disable wheels if per-setup.py call options are set. | |
:param options: The OptionParser options to update. | |
:param check_options: The options to check, if not supplied defaults to | |
options. | |
""" | |
if check_options is None: | |
check_options = options | |
def getname(n): | |
# type: (str) -> Optional[Any] | |
return getattr(check_options, n, None) | |
names = ["build_options", "global_options", "install_options"] | |
if any(map(getname, names)): | |
control = options.format_control | |
control.disallow_binaries() | |
warnings.warn( | |
'Disabling all use of wheels due to the use of --build-option ' | |
'/ --global-option / --install-option.', stacklevel=2, | |
) | |
def check_dist_restriction(options, check_target=False): | |
# type: (Values, bool) -> None | |
"""Function for determining if custom platform options are allowed. | |
:param options: The OptionParser options. | |
:param check_target: Whether or not to check if --target is being used. | |
""" | |
dist_restriction_set = any([ | |
options.python_version, | |
options.platform, | |
options.abi, | |
options.implementation, | |
]) | |
binary_only = FormatControl(set(), {':all:'}) | |
sdist_dependencies_allowed = ( | |
options.format_control != binary_only and | |
not options.ignore_dependencies | |
) | |
# Installations or downloads using dist restrictions must not combine | |
# source distributions and dist-specific wheels, as they are not | |
# guaranteed to be locally compatible. | |
if dist_restriction_set and sdist_dependencies_allowed: | |
raise CommandError( | |
"When restricting platform and interpreter constraints using " | |
"--python-version, --platform, --abi, or --implementation, " | |
"either --no-deps must be set, or --only-binary=:all: must be " | |
"set and --no-binary must not be set (or must be set to " | |
":none:)." | |
) | |
if check_target: | |
if dist_restriction_set and not options.target_dir: | |
raise CommandError( | |
"Can not use any platform or abi specific options unless " | |
"installing via '--target'" | |
) | |
def _path_option_check(option, opt, value): | |
# type: (Option, str, str) -> str | |
return os.path.expanduser(value) | |
class PipOption(Option): | |
TYPES = Option.TYPES + ("path",) | |
TYPE_CHECKER = Option.TYPE_CHECKER.copy() | |
TYPE_CHECKER["path"] = _path_option_check | |
########### | |
# options # | |
########### | |
help_ = partial( | |
Option, | |
'-h', '--help', | |
dest='help', | |
action='help', | |
help='Show help.', | |
) # type: Callable[..., Option] | |
isolated_mode = partial( | |
Option, | |
"--isolated", | |
dest="isolated_mode", | |
action="store_true", | |
default=False, | |
help=( | |
"Run pip in an isolated mode, ignoring environment variables and user " | |
"configuration." | |
), | |
) # type: Callable[..., Option] | |
require_virtualenv = partial( | |
Option, | |
# Run only if inside a virtualenv, bail if not. | |
'--require-virtualenv', '--require-venv', | |
dest='require_venv', | |
action='store_true', | |
default=False, | |
help=SUPPRESS_HELP | |
) # type: Callable[..., Option] | |
verbose = partial( | |
Option, | |
'-v', '--verbose', | |
dest='verbose', | |
action='count', | |
default=0, | |
help='Give more output. Option is additive, and can be used up to 3 times.' | |
) # type: Callable[..., Option] | |
no_color = partial( | |
Option, | |
'--no-color', | |
dest='no_color', | |
action='store_true', | |
default=False, | |
help="Suppress colored output", | |
) # type: Callable[..., Option] | |
version = partial( | |
Option, | |
'-V', '--version', | |
dest='version', | |
action='store_true', | |
help='Show version and exit.', | |
) # type: Callable[..., Option] | |
quiet = partial( | |
Option, | |
'-q', '--quiet', | |
dest='quiet', | |
action='count', | |
default=0, | |
help=( | |
'Give less output. Option is additive, and can be used up to 3' | |
' times (corresponding to WARNING, ERROR, and CRITICAL logging' | |
' levels).' | |
), | |
) # type: Callable[..., Option] | |
progress_bar = partial( | |
Option, | |
'--progress-bar', | |
dest='progress_bar', | |
type='choice', | |
choices=list(BAR_TYPES.keys()), | |
default='on', | |
help=( | |
'Specify type of progress to be displayed [' + | |
'|'.join(BAR_TYPES.keys()) + '] (default: %default)' | |
), | |
) # type: Callable[..., Option] | |
log = partial( | |
PipOption, | |
"--log", "--log-file", "--local-log", | |
dest="log", | |
metavar="path", | |
type="path", | |
help="Path to a verbose appending log." | |
) # type: Callable[..., Option] | |
no_input = partial( | |
Option, | |
# Don't ask for input | |
'--no-input', | |
dest='no_input', | |
action='store_true', | |
default=False, | |
help=SUPPRESS_HELP | |
) # type: Callable[..., Option] | |
proxy = partial( | |
Option, | |
'--proxy', | |
dest='proxy', | |
type='str', | |
default='', | |
help="Specify a proxy in the form [user:passwd@]proxy.server:port." | |
) # type: Callable[..., Option] | |
retries = partial( | |
Option, | |
'--retries', | |
dest='retries', | |
type='int', | |
default=5, | |
help="Maximum number of retries each connection should attempt " | |
"(default %default times).", | |
) # type: Callable[..., Option] | |
timeout = partial( | |
Option, | |
'--timeout', '--default-timeout', | |
metavar='sec', | |
dest='timeout', | |
type='float', | |
default=15, | |
help='Set the socket timeout (default %default seconds).', | |
) # type: Callable[..., Option] | |
def exists_action(): | |
# type: () -> Option | |
return Option( | |
# Option when path already exist | |
'--exists-action', | |
dest='exists_action', | |
type='choice', | |
choices=['s', 'i', 'w', 'b', 'a'], | |
default=[], | |
action='append', | |
metavar='action', | |
help="Default action when a path already exists: " | |
"(s)witch, (i)gnore, (w)ipe, (b)ackup, (a)bort.", | |
) | |
cert = partial( | |
PipOption, | |
'--cert', | |
dest='cert', | |
type='path', | |
metavar='path', | |
help="Path to alternate CA bundle.", | |
) # type: Callable[..., Option] | |
client_cert = partial( | |
PipOption, | |
'--client-cert', | |
dest='client_cert', | |
type='path', | |
default=None, | |
metavar='path', | |
help="Path to SSL client certificate, a single file containing the " | |
"private key and the certificate in PEM format.", | |
) # type: Callable[..., Option] | |
index_url = partial( | |
Option, | |
'-i', '--index-url', '--pypi-url', | |
dest='index_url', | |
metavar='URL', | |
default=PyPI.simple_url, | |
help="Base URL of the Python Package Index (default %default). " | |
"This should point to a repository compliant with PEP 503 " | |
"(the simple repository API) or a local directory laid out " | |
"in the same format.", | |
) # type: Callable[..., Option] | |
def extra_index_url(): | |
# type: () -> Option | |
return Option( | |
'--extra-index-url', | |
dest='extra_index_urls', | |
metavar='URL', | |
action='append', | |
default=[], | |
help="Extra URLs of package indexes to use in addition to " | |
"--index-url. Should follow the same rules as " | |
"--index-url.", | |
) | |
no_index = partial( | |
Option, | |
'--no-index', | |
dest='no_index', | |
action='store_true', | |
default=False, | |
help='Ignore package index (only looking at --find-links URLs instead).', | |
) # type: Callable[..., Option] | |
def find_links(): | |
# type: () -> Option | |
return Option( | |
'-f', '--find-links', | |
dest='find_links', | |
action='append', | |
default=[], | |
metavar='url', | |
help="If a URL or path to an html file, then parse for links to " | |
"archives such as sdist (.tar.gz) or wheel (.whl) files. " | |
"If a local path or file:// URL that's a directory, " | |
"then look for archives in the directory listing. " | |
"Links to VCS project URLs are not supported.", | |
) | |
def trusted_host(): | |
# type: () -> Option | |
return Option( | |
"--trusted-host", | |
dest="trusted_hosts", | |
action="append", | |
metavar="HOSTNAME", | |
default=[], | |
help="Mark this host or host:port pair as trusted, even though it " | |
"does not have valid or any HTTPS.", | |
) | |
def constraints(): | |
# type: () -> Option | |
return Option( | |
'-c', '--constraint', | |
dest='constraints', | |
action='append', | |
default=[], | |
metavar='file', | |
help='Constrain versions using the given constraints file. ' | |
'This option can be used multiple times.' | |
) | |
def requirements(): | |
# type: () -> Option | |
return Option( | |
'-r', '--requirement', | |
dest='requirements', | |
action='append', | |
default=[], | |
metavar='file', | |
help='Install from the given requirements file. ' | |
'This option can be used multiple times.' | |
) | |
def editable(): | |
# type: () -> Option | |
return Option( | |
'-e', '--editable', | |
dest='editables', | |
action='append', | |
default=[], | |
metavar='path/url', | |
help=('Install a project in editable mode (i.e. setuptools ' | |
'"develop mode") from a local project path or a VCS url.'), | |
) | |
def _handle_src(option, opt_str, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
value = os.path.abspath(value) | |
setattr(parser.values, option.dest, value) | |
src = partial( | |
PipOption, | |
'--src', '--source', '--source-dir', '--source-directory', | |
dest='src_dir', | |
type='path', | |
metavar='dir', | |
default=get_src_prefix(), | |
action='callback', | |
callback=_handle_src, | |
help='Directory to check out editable projects into. ' | |
'The default in a virtualenv is "<venv path>/src". ' | |
'The default for global installs is "<current dir>/src".' | |
) # type: Callable[..., Option] | |
def _get_format_control(values, option): | |
# type: (Values, Option) -> Any | |
"""Get a format_control object.""" | |
return getattr(values, option.dest) | |
def _handle_no_binary(option, opt_str, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
existing = _get_format_control(parser.values, option) | |
FormatControl.handle_mutual_excludes( | |
value, existing.no_binary, existing.only_binary, | |
) | |
def _handle_only_binary(option, opt_str, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
existing = _get_format_control(parser.values, option) | |
FormatControl.handle_mutual_excludes( | |
value, existing.only_binary, existing.no_binary, | |
) | |
def no_binary(): | |
# type: () -> Option | |
format_control = FormatControl(set(), set()) | |
return Option( | |
"--no-binary", dest="format_control", action="callback", | |
callback=_handle_no_binary, type="str", | |
default=format_control, | |
help='Do not use binary packages. Can be supplied multiple times, and ' | |
'each time adds to the existing value. Accepts either ":all:" to ' | |
'disable all binary packages, ":none:" to empty the set (notice ' | |
'the colons), or one or more package names with commas between ' | |
'them (no colons). Note that some packages are tricky to compile ' | |
'and may fail to install when this option is used on them.', | |
) | |
def only_binary(): | |
# type: () -> Option | |
format_control = FormatControl(set(), set()) | |
return Option( | |
"--only-binary", dest="format_control", action="callback", | |
callback=_handle_only_binary, type="str", | |
default=format_control, | |
help='Do not use source packages. Can be supplied multiple times, and ' | |
'each time adds to the existing value. Accepts either ":all:" to ' | |
'disable all source packages, ":none:" to empty the set, or one ' | |
'or more package names with commas between them. Packages ' | |
'without binary distributions will fail to install when this ' | |
'option is used on them.', | |
) | |
platform = partial( | |
Option, | |
'--platform', | |
dest='platform', | |
metavar='platform', | |
default=None, | |
help=("Only use wheels compatible with <platform>. " | |
"Defaults to the platform of the running system."), | |
) # type: Callable[..., Option] | |
# This was made a separate function for unit-testing purposes. | |
def _convert_python_version(value): | |
# type: (str) -> Tuple[Tuple[int, ...], Optional[str]] | |
""" | |
Convert a version string like "3", "37", or "3.7.3" into a tuple of ints. | |
:return: A 2-tuple (version_info, error_msg), where `error_msg` is | |
non-None if and only if there was a parsing error. | |
""" | |
if not value: | |
# The empty string is the same as not providing a value. | |
return (None, None) | |
parts = value.split('.') | |
if len(parts) > 3: | |
return ((), 'at most three version parts are allowed') | |
if len(parts) == 1: | |
# Then we are in the case of "3" or "37". | |
value = parts[0] | |
if len(value) > 1: | |
parts = [value[0], value[1:]] | |
try: | |
version_info = tuple(int(part) for part in parts) | |
except ValueError: | |
return ((), 'each version part must be an integer') | |
return (version_info, None) | |
def _handle_python_version(option, opt_str, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
""" | |
Handle a provided --python-version value. | |
""" | |
version_info, error_msg = _convert_python_version(value) | |
if error_msg is not None: | |
msg = ( | |
'invalid --python-version value: {!r}: {}'.format( | |
value, error_msg, | |
) | |
) | |
raise_option_error(parser, option=option, msg=msg) | |
parser.values.python_version = version_info | |
python_version = partial( | |
Option, | |
'--python-version', | |
dest='python_version', | |
metavar='python_version', | |
action='callback', | |
callback=_handle_python_version, type='str', | |
default=None, | |
help=dedent("""\ | |
The Python interpreter version to use for wheel and "Requires-Python" | |
compatibility checks. Defaults to a version derived from the running | |
interpreter. The version can be specified using up to three dot-separated | |
integers (e.g. "3" for 3.0.0, "3.7" for 3.7.0, or "3.7.3"). A major-minor | |
version can also be given as a string without dots (e.g. "37" for 3.7.0). | |
"""), | |
) # type: Callable[..., Option] | |
implementation = partial( | |
Option, | |
'--implementation', | |
dest='implementation', | |
metavar='implementation', | |
default=None, | |
help=("Only use wheels compatible with Python " | |
"implementation <implementation>, e.g. 'pp', 'jy', 'cp', " | |
" or 'ip'. If not specified, then the current " | |
"interpreter implementation is used. Use 'py' to force " | |
"implementation-agnostic wheels."), | |
) # type: Callable[..., Option] | |
abi = partial( | |
Option, | |
'--abi', | |
dest='abi', | |
metavar='abi', | |
default=None, | |
help=("Only use wheels compatible with Python " | |
"abi <abi>, e.g. 'pypy_41'. If not specified, then the " | |
"current interpreter abi tag is used. Generally " | |
"you will need to specify --implementation, " | |
"--platform, and --python-version when using " | |
"this option."), | |
) # type: Callable[..., Option] | |
def add_target_python_options(cmd_opts): | |
# type: (OptionGroup) -> None | |
cmd_opts.add_option(platform()) | |
cmd_opts.add_option(python_version()) | |
cmd_opts.add_option(implementation()) | |
cmd_opts.add_option(abi()) | |
def make_target_python(options): | |
# type: (Values) -> TargetPython | |
target_python = TargetPython( | |
platform=options.platform, | |
py_version_info=options.python_version, | |
abi=options.abi, | |
implementation=options.implementation, | |
) | |
return target_python | |
def prefer_binary(): | |
# type: () -> Option | |
return Option( | |
"--prefer-binary", | |
dest="prefer_binary", | |
action="store_true", | |
default=False, | |
help="Prefer older binary packages over newer source packages." | |
) | |
cache_dir = partial( | |
PipOption, | |
"--cache-dir", | |
dest="cache_dir", | |
default=USER_CACHE_DIR, | |
metavar="dir", | |
type='path', | |
help="Store the cache data in <dir>." | |
) # type: Callable[..., Option] | |
def _handle_no_cache_dir(option, opt, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
""" | |
Process a value provided for the --no-cache-dir option. | |
This is an optparse.Option callback for the --no-cache-dir option. | |
""" | |
# The value argument will be None if --no-cache-dir is passed via the | |
# command-line, since the option doesn't accept arguments. However, | |
# the value can be non-None if the option is triggered e.g. by an | |
# environment variable, like PIP_NO_CACHE_DIR=true. | |
if value is not None: | |
# Then parse the string value to get argument error-checking. | |
try: | |
strtobool(value) | |
except ValueError as exc: | |
raise_option_error(parser, option=option, msg=str(exc)) | |
# Originally, setting PIP_NO_CACHE_DIR to a value that strtobool() | |
# converted to 0 (like "false" or "no") caused cache_dir to be disabled | |
# rather than enabled (logic would say the latter). Thus, we disable | |
# the cache directory not just on values that parse to True, but (for | |
# backwards compatibility reasons) also on values that parse to False. | |
# In other words, always set it to False if the option is provided in | |
# some (valid) form. | |
parser.values.cache_dir = False | |
no_cache = partial( | |
Option, | |
"--no-cache-dir", | |
dest="cache_dir", | |
action="callback", | |
callback=_handle_no_cache_dir, | |
help="Disable the cache.", | |
) # type: Callable[..., Option] | |
no_deps = partial( | |
Option, | |
'--no-deps', '--no-dependencies', | |
dest='ignore_dependencies', | |
action='store_true', | |
default=False, | |
help="Don't install package dependencies.", | |
) # type: Callable[..., Option] | |
def _handle_build_dir(option, opt, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
if value: | |
value = os.path.abspath(value) | |
setattr(parser.values, option.dest, value) | |
build_dir = partial( | |
PipOption, | |
'-b', '--build', '--build-dir', '--build-directory', | |
dest='build_dir', | |
type='path', | |
metavar='dir', | |
action='callback', | |
callback=_handle_build_dir, | |
help='Directory to unpack packages into and build in. Note that ' | |
'an initial build still takes place in a temporary directory. ' | |
'The location of temporary directories can be controlled by setting ' | |
'the TMPDIR environment variable (TEMP on Windows) appropriately. ' | |
'When passed, build directories are not cleaned in case of failures.' | |
) # type: Callable[..., Option] | |
ignore_requires_python = partial( | |
Option, | |
'--ignore-requires-python', | |
dest='ignore_requires_python', | |
action='store_true', | |
help='Ignore the Requires-Python information.' | |
) # type: Callable[..., Option] | |
no_build_isolation = partial( | |
Option, | |
'--no-build-isolation', | |
dest='build_isolation', | |
action='store_false', | |
default=True, | |
help='Disable isolation when building a modern source distribution. ' | |
'Build dependencies specified by PEP 518 must be already installed ' | |
'if this option is used.' | |
) # type: Callable[..., Option] | |
def _handle_no_use_pep517(option, opt, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
""" | |
Process a value provided for the --no-use-pep517 option. | |
This is an optparse.Option callback for the no_use_pep517 option. | |
""" | |
# Since --no-use-pep517 doesn't accept arguments, the value argument | |
# will be None if --no-use-pep517 is passed via the command-line. | |
# However, the value can be non-None if the option is triggered e.g. | |
# by an environment variable, for example "PIP_NO_USE_PEP517=true". | |
if value is not None: | |
msg = """A value was passed for --no-use-pep517, | |
probably using either the PIP_NO_USE_PEP517 environment variable | |
or the "no-use-pep517" config file option. Use an appropriate value | |
of the PIP_USE_PEP517 environment variable or the "use-pep517" | |
config file option instead. | |
""" | |
raise_option_error(parser, option=option, msg=msg) | |
# Otherwise, --no-use-pep517 was passed via the command-line. | |
parser.values.use_pep517 = False | |
use_pep517 = partial( | |
Option, | |
'--use-pep517', | |
dest='use_pep517', | |
action='store_true', | |
default=None, | |
help='Use PEP 517 for building source distributions ' | |
'(use --no-use-pep517 to force legacy behaviour).' | |
) # type: Any | |
no_use_pep517 = partial( | |
Option, | |
'--no-use-pep517', | |
dest='use_pep517', | |
action='callback', | |
callback=_handle_no_use_pep517, | |
default=None, | |
help=SUPPRESS_HELP | |
) # type: Any | |
install_options = partial( | |
Option, | |
'--install-option', | |
dest='install_options', | |
action='append', | |
metavar='options', | |
help="Extra arguments to be supplied to the setup.py install " | |
"command (use like --install-option=\"--install-scripts=/usr/local/" | |
"bin\"). Use multiple --install-option options to pass multiple " | |
"options to setup.py install. If you are using an option with a " | |
"directory path, be sure to use absolute path.", | |
) # type: Callable[..., Option] | |
global_options = partial( | |
Option, | |
'--global-option', | |
dest='global_options', | |
action='append', | |
metavar='options', | |
help="Extra global options to be supplied to the setup.py " | |
"call before the install command.", | |
) # type: Callable[..., Option] | |
no_clean = partial( | |
Option, | |
'--no-clean', | |
action='store_true', | |
default=False, | |
help="Don't clean up build directories." | |
) # type: Callable[..., Option] | |
pre = partial( | |
Option, | |
'--pre', | |
action='store_true', | |
default=False, | |
help="Include pre-release and development versions. By default, " | |
"pip only finds stable versions.", | |
) # type: Callable[..., Option] | |
disable_pip_version_check = partial( | |
Option, | |
"--disable-pip-version-check", | |
dest="disable_pip_version_check", | |
action="store_true", | |
default=False, | |
help="Don't periodically check PyPI to determine whether a new version " | |
"of pip is available for download. Implied with --no-index.", | |
) # type: Callable[..., Option] | |
# Deprecated, Remove later | |
always_unzip = partial( | |
Option, | |
'-Z', '--always-unzip', | |
dest='always_unzip', | |
action='store_true', | |
help=SUPPRESS_HELP, | |
) # type: Callable[..., Option] | |
def _handle_merge_hash(option, opt_str, value, parser): | |
# type: (Option, str, str, OptionParser) -> None | |
"""Given a value spelled "algo:digest", append the digest to a list | |
pointed to in a dict by the algo name.""" | |
if not parser.values.hashes: | |
parser.values.hashes = {} | |
try: | |
algo, digest = value.split(':', 1) | |
except ValueError: | |
parser.error('Arguments to {} must be a hash name ' | |
'followed by a value, like --hash=sha256:' | |
'abcde...'.format(opt_str)) | |
if algo not in STRONG_HASHES: | |
parser.error('Allowed hash algorithms for {} are {}.'.format( | |
opt_str, ', '.join(STRONG_HASHES))) | |
parser.values.hashes.setdefault(algo, []).append(digest) | |
hash = partial( | |
Option, | |
'--hash', | |
# Hash values eventually end up in InstallRequirement.hashes due to | |
# __dict__ copying in process_line(). | |
dest='hashes', | |
action='callback', | |
callback=_handle_merge_hash, | |
type='string', | |
help="Verify that the package's archive matches this " | |
'hash before installing. Example: --hash=sha256:abcdef...', | |
) # type: Callable[..., Option] | |
require_hashes = partial( | |
Option, | |
'--require-hashes', | |
dest='require_hashes', | |
action='store_true', | |
default=False, | |
help='Require a hash to check each requirement against, for ' | |
'repeatable installs. This option is implied when any package in a ' | |
'requirements file has a --hash option.', | |
) # type: Callable[..., Option] | |
list_path = partial( | |
PipOption, | |
'--path', | |
dest='path', | |
type='path', | |
action='append', | |
help='Restrict to the specified installation path for listing ' | |
'packages (can be used multiple times).' | |
) # type: Callable[..., Option] | |
def check_list_path_option(options): | |
# type: (Values) -> None | |
if options.path and (options.user or options.local): | |
raise CommandError( | |
"Cannot combine '--path' with '--user' or '--local'" | |
) | |
no_python_version_warning = partial( | |
Option, | |
'--no-python-version-warning', | |
dest='no_python_version_warning', | |
action='store_true', | |
default=False, | |
help='Silence deprecation warnings for upcoming unsupported Pythons.', | |
) # type: Callable[..., Option] | |
unstable_feature = partial( | |
Option, | |
'--unstable-feature', | |
dest='unstable_features', | |
metavar='feature', | |
action='append', | |
default=[], | |
choices=['resolver'], | |
help=SUPPRESS_HELP, # TODO: Enable this when the resolver actually works. | |
# help='Enable unstable feature(s) that may be backward incompatible.', | |
) # type: Callable[..., Option] | |
########## | |
# groups # | |
########## | |
general_group = { | |
'name': 'General Options', | |
'options': [ | |
help_, | |
isolated_mode, | |
require_virtualenv, | |
verbose, | |
version, | |
quiet, | |
log, | |
no_input, | |
proxy, | |
retries, | |
timeout, | |
exists_action, | |
trusted_host, | |
cert, | |
client_cert, | |
cache_dir, | |
no_cache, | |
disable_pip_version_check, | |
no_color, | |
no_python_version_warning, | |
unstable_feature, | |
] | |
} # type: Dict[str, Any] | |
index_group = { | |
'name': 'Package Index Options', | |
'options': [ | |
index_url, | |
extra_index_url, | |
no_index, | |
find_links, | |
] | |
} # type: Dict[str, Any] |
from contextlib import contextmanager | |
from pip._vendor.contextlib2 import ExitStack | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Iterator, ContextManager, TypeVar | |
_T = TypeVar('_T', covariant=True) | |
class CommandContextMixIn(object): | |
def __init__(self): | |
# type: () -> None | |
super(CommandContextMixIn, self).__init__() | |
self._in_main_context = False | |
self._main_context = ExitStack() | |
@contextmanager | |
def main_context(self): | |
# type: () -> Iterator[None] | |
assert not self._in_main_context | |
self._in_main_context = True | |
try: | |
with self._main_context: | |
yield | |
finally: | |
self._in_main_context = False | |
def enter_context(self, context_provider): | |
# type: (ContextManager[_T]) -> _T | |
assert self._in_main_context | |
return self._main_context.enter_context(context_provider) |
"""Primary application entrypoint. | |
""" | |
from __future__ import absolute_import | |
import locale | |
import logging | |
import os | |
import sys | |
from pip._internal.cli.autocompletion import autocomplete | |
from pip._internal.cli.main_parser import parse_command | |
from pip._internal.commands import create_command | |
from pip._internal.exceptions import PipError | |
from pip._internal.utils import deprecation | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional | |
logger = logging.getLogger(__name__) | |
# Do not import and use main() directly! Using it directly is actively | |
# discouraged by pip's maintainers. The name, location and behavior of | |
# this function is subject to change, so calling it directly is not | |
# portable across different pip versions. | |
# In addition, running pip in-process is unsupported and unsafe. This is | |
# elaborated in detail at | |
# https://pip.pypa.io/en/stable/user_guide/#using-pip-from-your-program. | |
# That document also provides suggestions that should work for nearly | |
# all users that are considering importing and using main() directly. | |
# However, we know that certain users will still want to invoke pip | |
# in-process. If you understand and accept the implications of using pip | |
# in an unsupported manner, the best approach is to use runpy to avoid | |
# depending on the exact location of this entry point. | |
# The following example shows how to use runpy to invoke pip in that | |
# case: | |
# | |
# sys.argv = ["pip", your, args, here] | |
# runpy.run_module("pip", run_name="__main__") | |
# | |
# Note that this will exit the process after running, unlike a direct | |
# call to main. As it is not safe to do any processing after calling | |
# main, this should not be an issue in practice. | |
def main(args=None): | |
# type: (Optional[List[str]]) -> int | |
if args is None: | |
args = sys.argv[1:] | |
# Configure our deprecation warnings to be sent through loggers | |
deprecation.install_warning_logger() | |
autocomplete() | |
try: | |
cmd_name, cmd_args = parse_command(args) | |
except PipError as exc: | |
sys.stderr.write("ERROR: {}".format(exc)) | |
sys.stderr.write(os.linesep) | |
sys.exit(1) | |
# Needed for locale.getpreferredencoding(False) to work | |
# in pip._internal.utils.encoding.auto_decode | |
try: | |
locale.setlocale(locale.LC_ALL, '') | |
except locale.Error as e: | |
# setlocale can apparently crash if locale are uninitialized | |
logger.debug("Ignoring error %s when setting locale", e) | |
command = create_command(cmd_name, isolated=("--isolated" in cmd_args)) | |
return command.main(cmd_args) |
"""A single place for constructing and exposing the main parser | |
""" | |
import os | |
import sys | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.parser import ( | |
ConfigOptionParser, | |
UpdatingDefaultsHelpFormatter, | |
) | |
from pip._internal.commands import commands_dict, get_similar_commands | |
from pip._internal.exceptions import CommandError | |
from pip._internal.utils.misc import get_pip_version, get_prog | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Tuple, List | |
__all__ = ["create_main_parser", "parse_command"] | |
def create_main_parser(): | |
# type: () -> ConfigOptionParser | |
"""Creates and returns the main parser for pip's CLI | |
""" | |
parser_kw = { | |
'usage': '\n%prog <command> [options]', | |
'add_help_option': False, | |
'formatter': UpdatingDefaultsHelpFormatter(), | |
'name': 'global', | |
'prog': get_prog(), | |
} | |
parser = ConfigOptionParser(**parser_kw) | |
parser.disable_interspersed_args() | |
parser.version = get_pip_version() | |
# add the general options | |
gen_opts = cmdoptions.make_option_group(cmdoptions.general_group, parser) | |
parser.add_option_group(gen_opts) | |
# so the help formatter knows | |
parser.main = True # type: ignore | |
# create command listing for description | |
description = [''] + [ | |
'{name:27} {command_info.summary}'.format(**locals()) | |
for name, command_info in commands_dict.items() | |
] | |
parser.description = '\n'.join(description) | |
return parser | |
def parse_command(args): | |
# type: (List[str]) -> Tuple[str, List[str]] | |
parser = create_main_parser() | |
# Note: parser calls disable_interspersed_args(), so the result of this | |
# call is to split the initial args into the general options before the | |
# subcommand and everything else. | |
# For example: | |
# args: ['--timeout=5', 'install', '--user', 'INITools'] | |
# general_options: ['--timeout==5'] | |
# args_else: ['install', '--user', 'INITools'] | |
general_options, args_else = parser.parse_args(args) | |
# --version | |
if general_options.version: | |
sys.stdout.write(parser.version) # type: ignore | |
sys.stdout.write(os.linesep) | |
sys.exit() | |
# pip || pip help -> print_help() | |
if not args_else or (args_else[0] == 'help' and len(args_else) == 1): | |
parser.print_help() | |
sys.exit() | |
# the subcommand name | |
cmd_name = args_else[0] | |
if cmd_name not in commands_dict: | |
guess = get_similar_commands(cmd_name) | |
msg = ['unknown command "{}"'.format(cmd_name)] | |
if guess: | |
msg.append('maybe you meant "{}"'.format(guess)) | |
raise CommandError(' - '.join(msg)) | |
# all the args without the subcommand | |
cmd_args = args[:] | |
cmd_args.remove(cmd_name) | |
return cmd_name, cmd_args |
"""Base option parser setup""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import optparse | |
import sys | |
import textwrap | |
from distutils.util import strtobool | |
from pip._vendor.six import string_types | |
from pip._internal.cli.status_codes import UNKNOWN_ERROR | |
from pip._internal.configuration import Configuration, ConfigurationError | |
from pip._internal.utils.compat import get_terminal_size | |
logger = logging.getLogger(__name__) | |
class PrettyHelpFormatter(optparse.IndentedHelpFormatter): | |
"""A prettier/less verbose help formatter for optparse.""" | |
def __init__(self, *args, **kwargs): | |
# help position must be aligned with __init__.parseopts.description | |
kwargs['max_help_position'] = 30 | |
kwargs['indent_increment'] = 1 | |
kwargs['width'] = get_terminal_size()[0] - 2 | |
optparse.IndentedHelpFormatter.__init__(self, *args, **kwargs) | |
def format_option_strings(self, option): | |
return self._format_option_strings(option) | |
def _format_option_strings(self, option, mvarfmt=' <{}>', optsep=', '): | |
""" | |
Return a comma-separated list of option strings and metavars. | |
:param option: tuple of (short opt, long opt), e.g: ('-f', '--format') | |
:param mvarfmt: metavar format string | |
:param optsep: separator | |
""" | |
opts = [] | |
if option._short_opts: | |
opts.append(option._short_opts[0]) | |
if option._long_opts: | |
opts.append(option._long_opts[0]) | |
if len(opts) > 1: | |
opts.insert(1, optsep) | |
if option.takes_value(): | |
metavar = option.metavar or option.dest.lower() | |
opts.append(mvarfmt.format(metavar.lower())) | |
return ''.join(opts) | |
def format_heading(self, heading): | |
if heading == 'Options': | |
return '' | |
return heading + ':\n' | |
def format_usage(self, usage): | |
""" | |
Ensure there is only one newline between usage and the first heading | |
if there is no description. | |
""" | |
msg = '\nUsage: {}\n'.format( | |
self.indent_lines(textwrap.dedent(usage), " ")) | |
return msg | |
def format_description(self, description): | |
# leave full control over description to us | |
if description: | |
if hasattr(self.parser, 'main'): | |
label = 'Commands' | |
else: | |
label = 'Description' | |
# some doc strings have initial newlines, some don't | |
description = description.lstrip('\n') | |
# some doc strings have final newlines and spaces, some don't | |
description = description.rstrip() | |
# dedent, then reindent | |
description = self.indent_lines(textwrap.dedent(description), " ") | |
description = '{}:\n{}\n'.format(label, description) | |
return description | |
else: | |
return '' | |
def format_epilog(self, epilog): | |
# leave full control over epilog to us | |
if epilog: | |
return epilog | |
else: | |
return '' | |
def indent_lines(self, text, indent): | |
new_lines = [indent + line for line in text.split('\n')] | |
return "\n".join(new_lines) | |
class UpdatingDefaultsHelpFormatter(PrettyHelpFormatter): | |
"""Custom help formatter for use in ConfigOptionParser. | |
This is updates the defaults before expanding them, allowing | |
them to show up correctly in the help listing. | |
""" | |
def expand_default(self, option): | |
if self.parser is not None: | |
self.parser._update_defaults(self.parser.defaults) | |
return optparse.IndentedHelpFormatter.expand_default(self, option) | |
class CustomOptionParser(optparse.OptionParser): | |
def insert_option_group(self, idx, *args, **kwargs): | |
"""Insert an OptionGroup at a given position.""" | |
group = self.add_option_group(*args, **kwargs) | |
self.option_groups.pop() | |
self.option_groups.insert(idx, group) | |
return group | |
@property | |
def option_list_all(self): | |
"""Get a list of all options, including those in option groups.""" | |
res = self.option_list[:] | |
for i in self.option_groups: | |
res.extend(i.option_list) | |
return res | |
class ConfigOptionParser(CustomOptionParser): | |
"""Custom option parser which updates its defaults by checking the | |
configuration files and environmental variables""" | |
def __init__(self, *args, **kwargs): | |
self.name = kwargs.pop('name') | |
isolated = kwargs.pop("isolated", False) | |
self.config = Configuration(isolated) | |
assert self.name | |
optparse.OptionParser.__init__(self, *args, **kwargs) | |
def check_default(self, option, key, val): | |
try: | |
return option.check_value(key, val) | |
except optparse.OptionValueError as exc: | |
print("An error occurred during configuration: {}".format(exc)) | |
sys.exit(3) | |
def _get_ordered_configuration_items(self): | |
# Configuration gives keys in an unordered manner. Order them. | |
override_order = ["global", self.name, ":env:"] | |
# Pool the options into different groups | |
section_items = {name: [] for name in override_order} | |
for section_key, val in self.config.items(): | |
# ignore empty values | |
if not val: | |
logger.debug( | |
"Ignoring configuration key '%s' as it's value is empty.", | |
section_key | |
) | |
continue | |
section, key = section_key.split(".", 1) | |
if section in override_order: | |
section_items[section].append((key, val)) | |
# Yield each group in their override order | |
for section in override_order: | |
for key, val in section_items[section]: | |
yield key, val | |
def _update_defaults(self, defaults): | |
"""Updates the given defaults with values from the config files and | |
the environ. Does a little special handling for certain types of | |
options (lists).""" | |
# Accumulate complex default state. | |
self.values = optparse.Values(self.defaults) | |
late_eval = set() | |
# Then set the options with those values | |
for key, val in self._get_ordered_configuration_items(): | |
# '--' because configuration supports only long names | |
option = self.get_option('--' + key) | |
# Ignore options not present in this parser. E.g. non-globals put | |
# in [global] by users that want them to apply to all applicable | |
# commands. | |
if option is None: | |
continue | |
if option.action in ('store_true', 'store_false', 'count'): | |
try: | |
val = strtobool(val) | |
except ValueError: | |
error_msg = invalid_config_error_message( | |
option.action, key, val | |
) | |
self.error(error_msg) | |
elif option.action == 'append': | |
val = val.split() | |
val = [self.check_default(option, key, v) for v in val] | |
elif option.action == 'callback': | |
late_eval.add(option.dest) | |
opt_str = option.get_opt_string() | |
val = option.convert_value(opt_str, val) | |
# From take_action | |
args = option.callback_args or () | |
kwargs = option.callback_kwargs or {} | |
option.callback(option, opt_str, val, self, *args, **kwargs) | |
else: | |
val = self.check_default(option, key, val) | |
defaults[option.dest] = val | |
for key in late_eval: | |
defaults[key] = getattr(self.values, key) | |
self.values = None | |
return defaults | |
def get_default_values(self): | |
"""Overriding to make updating the defaults after instantiation of | |
the option parser possible, _update_defaults() does the dirty work.""" | |
if not self.process_default_values: | |
# Old, pre-Optik 1.5 behaviour. | |
return optparse.Values(self.defaults) | |
# Load the configuration, or error out in case of an error | |
try: | |
self.config.load() | |
except ConfigurationError as err: | |
self.exit(UNKNOWN_ERROR, str(err)) | |
defaults = self._update_defaults(self.defaults.copy()) # ours | |
for option in self._get_all_options(): | |
default = defaults.get(option.dest) | |
if isinstance(default, string_types): | |
opt_str = option.get_opt_string() | |
defaults[option.dest] = option.check_value(opt_str, default) | |
return optparse.Values(defaults) | |
def error(self, msg): | |
self.print_usage(sys.stderr) | |
self.exit(UNKNOWN_ERROR, "{}\n".format(msg)) | |
def invalid_config_error_message(action, key, val): | |
"""Returns a better error message when invalid configuration option | |
is provided.""" | |
if action in ('store_true', 'store_false'): | |
return ("{0} is not a valid value for {1} option, " | |
"please specify a boolean value like yes/no, " | |
"true/false or 1/0 instead.").format(val, key) | |
return ("{0} is not a valid value for {1} option, " | |
"please specify a numerical value like 1/0 " | |
"instead.").format(val, key) |
from __future__ import division | |
import itertools | |
import sys | |
from signal import SIGINT, default_int_handler, signal | |
from pip._vendor import six | |
from pip._vendor.progress.bar import Bar, FillingCirclesBar, IncrementalBar | |
from pip._vendor.progress.spinner import Spinner | |
from pip._internal.utils.compat import WINDOWS | |
from pip._internal.utils.logging import get_indentation | |
from pip._internal.utils.misc import format_size | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Dict, List | |
try: | |
from pip._vendor import colorama | |
# Lots of different errors can come from this, including SystemError and | |
# ImportError. | |
except Exception: | |
colorama = None | |
def _select_progress_class(preferred, fallback): | |
# type: (Bar, Bar) -> Bar | |
encoding = getattr(preferred.file, "encoding", None) | |
# If we don't know what encoding this file is in, then we'll just assume | |
# that it doesn't support unicode and use the ASCII bar. | |
if not encoding: | |
return fallback | |
# Collect all of the possible characters we want to use with the preferred | |
# bar. | |
characters = [ | |
getattr(preferred, "empty_fill", six.text_type()), | |
getattr(preferred, "fill", six.text_type()), | |
] | |
characters += list(getattr(preferred, "phases", [])) | |
# Try to decode the characters we're using for the bar using the encoding | |
# of the given file, if this works then we'll assume that we can use the | |
# fancier bar and if not we'll fall back to the plaintext bar. | |
try: | |
six.text_type().join(characters).encode(encoding) | |
except UnicodeEncodeError: | |
return fallback | |
else: | |
return preferred | |
_BaseBar = _select_progress_class(IncrementalBar, Bar) # type: Any | |
class InterruptibleMixin(object): | |
""" | |
Helper to ensure that self.finish() gets called on keyboard interrupt. | |
This allows downloads to be interrupted without leaving temporary state | |
(like hidden cursors) behind. | |
This class is similar to the progress library's existing SigIntMixin | |
helper, but as of version 1.2, that helper has the following problems: | |
1. It calls sys.exit(). | |
2. It discards the existing SIGINT handler completely. | |
3. It leaves its own handler in place even after an uninterrupted finish, | |
which will have unexpected delayed effects if the user triggers an | |
unrelated keyboard interrupt some time after a progress-displaying | |
download has already completed, for example. | |
""" | |
def __init__(self, *args, **kwargs): | |
# type: (List[Any], Dict[Any, Any]) -> None | |
""" | |
Save the original SIGINT handler for later. | |
""" | |
super(InterruptibleMixin, self).__init__( # type: ignore | |
*args, | |
**kwargs | |
) | |
self.original_handler = signal(SIGINT, self.handle_sigint) | |
# If signal() returns None, the previous handler was not installed from | |
# Python, and we cannot restore it. This probably should not happen, | |
# but if it does, we must restore something sensible instead, at least. | |
# The least bad option should be Python's default SIGINT handler, which | |
# just raises KeyboardInterrupt. | |
if self.original_handler is None: | |
self.original_handler = default_int_handler | |
def finish(self): | |
# type: () -> None | |
""" | |
Restore the original SIGINT handler after finishing. | |
This should happen regardless of whether the progress display finishes | |
normally, or gets interrupted. | |
""" | |
super(InterruptibleMixin, self).finish() # type: ignore | |
signal(SIGINT, self.original_handler) | |
def handle_sigint(self, signum, frame): # type: ignore | |
""" | |
Call self.finish() before delegating to the original SIGINT handler. | |
This handler should only be in place while the progress display is | |
active. | |
""" | |
self.finish() | |
self.original_handler(signum, frame) | |
class SilentBar(Bar): | |
def update(self): | |
# type: () -> None | |
pass | |
class BlueEmojiBar(IncrementalBar): | |
suffix = "%(percent)d%%" | |
bar_prefix = " " | |
bar_suffix = " " | |
phases = (u"\U0001F539", u"\U0001F537", u"\U0001F535") # type: Any | |
class DownloadProgressMixin(object): | |
def __init__(self, *args, **kwargs): | |
# type: (List[Any], Dict[Any, Any]) -> None | |
super(DownloadProgressMixin, self).__init__( # type: ignore | |
*args, | |
**kwargs | |
) | |
self.message = (" " * ( | |
get_indentation() + 2 | |
)) + self.message # type: str | |
@property | |
def downloaded(self): | |
# type: () -> str | |
return format_size(self.index) # type: ignore | |
@property | |
def download_speed(self): | |
# type: () -> str | |
# Avoid zero division errors... | |
if self.avg == 0.0: # type: ignore | |
return "..." | |
return format_size(1 / self.avg) + "/s" # type: ignore | |
@property | |
def pretty_eta(self): | |
# type: () -> str | |
if self.eta: # type: ignore | |
return "eta {}".format(self.eta_td) # type: ignore | |
return "" | |
def iter(self, it): # type: ignore | |
for x in it: | |
yield x | |
self.next(len(x)) | |
self.finish() | |
class WindowsMixin(object): | |
def __init__(self, *args, **kwargs): | |
# type: (List[Any], Dict[Any, Any]) -> None | |
# The Windows terminal does not support the hide/show cursor ANSI codes | |
# even with colorama. So we'll ensure that hide_cursor is False on | |
# Windows. | |
# This call needs to go before the super() call, so that hide_cursor | |
# is set in time. The base progress bar class writes the "hide cursor" | |
# code to the terminal in its init, so if we don't set this soon | |
# enough, we get a "hide" with no corresponding "show"... | |
if WINDOWS and self.hide_cursor: # type: ignore | |
self.hide_cursor = False | |
super(WindowsMixin, self).__init__(*args, **kwargs) # type: ignore | |
# Check if we are running on Windows and we have the colorama module, | |
# if we do then wrap our file with it. | |
if WINDOWS and colorama: | |
self.file = colorama.AnsiToWin32(self.file) # type: ignore | |
# The progress code expects to be able to call self.file.isatty() | |
# but the colorama.AnsiToWin32() object doesn't have that, so we'll | |
# add it. | |
self.file.isatty = lambda: self.file.wrapped.isatty() | |
# The progress code expects to be able to call self.file.flush() | |
# but the colorama.AnsiToWin32() object doesn't have that, so we'll | |
# add it. | |
self.file.flush = lambda: self.file.wrapped.flush() | |
class BaseDownloadProgressBar(WindowsMixin, InterruptibleMixin, | |
DownloadProgressMixin): | |
file = sys.stdout | |
message = "%(percent)d%%" | |
suffix = "%(downloaded)s %(download_speed)s %(pretty_eta)s" | |
# NOTE: The "type: ignore" comments on the following classes are there to | |
# work around https://github.com/python/typing/issues/241 | |
class DefaultDownloadProgressBar(BaseDownloadProgressBar, | |
_BaseBar): | |
pass | |
class DownloadSilentBar(BaseDownloadProgressBar, SilentBar): # type: ignore | |
pass | |
class DownloadBar(BaseDownloadProgressBar, # type: ignore | |
Bar): | |
pass | |
class DownloadFillingCirclesBar(BaseDownloadProgressBar, # type: ignore | |
FillingCirclesBar): | |
pass | |
class DownloadBlueEmojiProgressBar(BaseDownloadProgressBar, # type: ignore | |
BlueEmojiBar): | |
pass | |
class DownloadProgressSpinner(WindowsMixin, InterruptibleMixin, | |
DownloadProgressMixin, Spinner): | |
file = sys.stdout | |
suffix = "%(downloaded)s %(download_speed)s" | |
def next_phase(self): # type: ignore | |
if not hasattr(self, "_phaser"): | |
self._phaser = itertools.cycle(self.phases) | |
return next(self._phaser) | |
def update(self): | |
# type: () -> None | |
message = self.message % self | |
phase = self.next_phase() | |
suffix = self.suffix % self | |
line = ''.join([ | |
message, | |
" " if message else "", | |
phase, | |
" " if suffix else "", | |
suffix, | |
]) | |
self.writeln(line) | |
BAR_TYPES = { | |
"off": (DownloadSilentBar, DownloadSilentBar), | |
"on": (DefaultDownloadProgressBar, DownloadProgressSpinner), | |
"ascii": (DownloadBar, DownloadProgressSpinner), | |
"pretty": (DownloadFillingCirclesBar, DownloadProgressSpinner), | |
"emoji": (DownloadBlueEmojiProgressBar, DownloadProgressSpinner) | |
} | |
def DownloadProgressProvider(progress_bar, max=None): # type: ignore | |
if max is None or max == 0: | |
return BAR_TYPES[progress_bar][1]().iter | |
else: | |
return BAR_TYPES[progress_bar][0](max=max).iter |
"""Contains the Command base classes that depend on PipSession. | |
The classes in this module are in a separate module so the commands not | |
needing download / PackageFinder capability don't unnecessarily import the | |
PackageFinder machinery and all its vendored dependencies, etc. | |
""" | |
import logging | |
import os | |
from functools import partial | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.command_context import CommandContextMixIn | |
from pip._internal.exceptions import CommandError, PreviousBuildDirError | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.models.selection_prefs import SelectionPreferences | |
from pip._internal.network.download import Downloader | |
from pip._internal.network.session import PipSession | |
from pip._internal.operations.prepare import RequirementPreparer | |
from pip._internal.req.constructors import ( | |
install_req_from_editable, | |
install_req_from_line, | |
install_req_from_parsed_requirement, | |
install_req_from_req_string, | |
) | |
from pip._internal.req.req_file import parse_requirements | |
from pip._internal.req.req_set import RequirementSet | |
from pip._internal.self_outdated_check import ( | |
make_link_collector, | |
pip_self_version_check, | |
) | |
from pip._internal.utils.temp_dir import tempdir_kinds | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from optparse import Values | |
from typing import Any, List, Optional, Tuple | |
from pip._internal.cache import WheelCache | |
from pip._internal.models.target_python import TargetPython | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.req.req_tracker import RequirementTracker | |
from pip._internal.resolution.base import BaseResolver | |
from pip._internal.utils.temp_dir import ( | |
TempDirectory, | |
TempDirectoryTypeRegistry, | |
) | |
logger = logging.getLogger(__name__) | |
class SessionCommandMixin(CommandContextMixIn): | |
""" | |
A class mixin for command classes needing _build_session(). | |
""" | |
def __init__(self): | |
# type: () -> None | |
super(SessionCommandMixin, self).__init__() | |
self._session = None # Optional[PipSession] | |
@classmethod | |
def _get_index_urls(cls, options): | |
# type: (Values) -> Optional[List[str]] | |
"""Return a list of index urls from user-provided options.""" | |
index_urls = [] | |
if not getattr(options, "no_index", False): | |
url = getattr(options, "index_url", None) | |
if url: | |
index_urls.append(url) | |
urls = getattr(options, "extra_index_urls", None) | |
if urls: | |
index_urls.extend(urls) | |
# Return None rather than an empty list | |
return index_urls or None | |
def get_default_session(self, options): | |
# type: (Values) -> PipSession | |
"""Get a default-managed session.""" | |
if self._session is None: | |
self._session = self.enter_context(self._build_session(options)) | |
# there's no type annotation on requests.Session, so it's | |
# automatically ContextManager[Any] and self._session becomes Any, | |
# then https://github.com/python/mypy/issues/7696 kicks in | |
assert self._session is not None | |
return self._session | |
def _build_session(self, options, retries=None, timeout=None): | |
# type: (Values, Optional[int], Optional[int]) -> PipSession | |
assert not options.cache_dir or os.path.isabs(options.cache_dir) | |
session = PipSession( | |
cache=( | |
os.path.join(options.cache_dir, "http") | |
if options.cache_dir else None | |
), | |
retries=retries if retries is not None else options.retries, | |
trusted_hosts=options.trusted_hosts, | |
index_urls=self._get_index_urls(options), | |
) | |
# Handle custom ca-bundles from the user | |
if options.cert: | |
session.verify = options.cert | |
# Handle SSL client certificate | |
if options.client_cert: | |
session.cert = options.client_cert | |
# Handle timeouts | |
if options.timeout or timeout: | |
session.timeout = ( | |
timeout if timeout is not None else options.timeout | |
) | |
# Handle configured proxies | |
if options.proxy: | |
session.proxies = { | |
"http": options.proxy, | |
"https": options.proxy, | |
} | |
# Determine if we can prompt the user for authentication or not | |
session.auth.prompting = not options.no_input | |
return session | |
class IndexGroupCommand(Command, SessionCommandMixin): | |
""" | |
Abstract base class for commands with the index_group options. | |
This also corresponds to the commands that permit the pip version check. | |
""" | |
def handle_pip_version_check(self, options): | |
# type: (Values) -> None | |
""" | |
Do the pip version check if not disabled. | |
This overrides the default behavior of not doing the check. | |
""" | |
# Make sure the index_group options are present. | |
assert hasattr(options, 'no_index') | |
if options.disable_pip_version_check or options.no_index: | |
return | |
# Otherwise, check if we're using the latest version of pip available. | |
session = self._build_session( | |
options, | |
retries=0, | |
timeout=min(5, options.timeout) | |
) | |
with session: | |
pip_self_version_check(session, options) | |
KEEPABLE_TEMPDIR_TYPES = [ | |
tempdir_kinds.BUILD_ENV, | |
tempdir_kinds.EPHEM_WHEEL_CACHE, | |
tempdir_kinds.REQ_BUILD, | |
] | |
def with_cleanup(func): | |
# type: (Any) -> Any | |
"""Decorator for common logic related to managing temporary | |
directories. | |
""" | |
def configure_tempdir_registry(registry): | |
# type: (TempDirectoryTypeRegistry) -> None | |
for t in KEEPABLE_TEMPDIR_TYPES: | |
registry.set_delete(t, False) | |
def wrapper(self, options, args): | |
# type: (RequirementCommand, Values, List[Any]) -> Optional[int] | |
assert self.tempdir_registry is not None | |
if options.no_clean: | |
configure_tempdir_registry(self.tempdir_registry) | |
try: | |
return func(self, options, args) | |
except PreviousBuildDirError: | |
# This kind of conflict can occur when the user passes an explicit | |
# build directory with a pre-existing folder. In that case we do | |
# not want to accidentally remove it. | |
configure_tempdir_registry(self.tempdir_registry) | |
raise | |
return wrapper | |
class RequirementCommand(IndexGroupCommand): | |
def __init__(self, *args, **kw): | |
# type: (Any, Any) -> None | |
super(RequirementCommand, self).__init__(*args, **kw) | |
self.cmd_opts.add_option(cmdoptions.no_clean()) | |
@staticmethod | |
def make_requirement_preparer( | |
temp_build_dir, # type: TempDirectory | |
options, # type: Values | |
req_tracker, # type: RequirementTracker | |
session, # type: PipSession | |
finder, # type: PackageFinder | |
use_user_site, # type: bool | |
download_dir=None, # type: str | |
wheel_download_dir=None, # type: str | |
): | |
# type: (...) -> RequirementPreparer | |
""" | |
Create a RequirementPreparer instance for the given parameters. | |
""" | |
downloader = Downloader(session, progress_bar=options.progress_bar) | |
temp_build_dir_path = temp_build_dir.path | |
assert temp_build_dir_path is not None | |
return RequirementPreparer( | |
build_dir=temp_build_dir_path, | |
src_dir=options.src_dir, | |
download_dir=download_dir, | |
wheel_download_dir=wheel_download_dir, | |
build_isolation=options.build_isolation, | |
req_tracker=req_tracker, | |
downloader=downloader, | |
finder=finder, | |
require_hashes=options.require_hashes, | |
use_user_site=use_user_site, | |
) | |
@staticmethod | |
def make_resolver( | |
preparer, # type: RequirementPreparer | |
finder, # type: PackageFinder | |
options, # type: Values | |
wheel_cache=None, # type: Optional[WheelCache] | |
use_user_site=False, # type: bool | |
ignore_installed=True, # type: bool | |
ignore_requires_python=False, # type: bool | |
force_reinstall=False, # type: bool | |
upgrade_strategy="to-satisfy-only", # type: str | |
use_pep517=None, # type: Optional[bool] | |
py_version_info=None # type: Optional[Tuple[int, ...]] | |
): | |
# type: (...) -> BaseResolver | |
""" | |
Create a Resolver instance for the given parameters. | |
""" | |
make_install_req = partial( | |
install_req_from_req_string, | |
isolated=options.isolated_mode, | |
use_pep517=use_pep517, | |
) | |
# The long import name and duplicated invocation is needed to convince | |
# Mypy into correctly typechecking. Otherwise it would complain the | |
# "Resolver" class being redefined. | |
if 'resolver' in options.unstable_features: | |
import pip._internal.resolution.resolvelib.resolver | |
return pip._internal.resolution.resolvelib.resolver.Resolver( | |
preparer=preparer, | |
finder=finder, | |
wheel_cache=wheel_cache, | |
make_install_req=make_install_req, | |
use_user_site=use_user_site, | |
ignore_dependencies=options.ignore_dependencies, | |
ignore_installed=ignore_installed, | |
ignore_requires_python=ignore_requires_python, | |
force_reinstall=force_reinstall, | |
upgrade_strategy=upgrade_strategy, | |
py_version_info=py_version_info, | |
) | |
import pip._internal.resolution.legacy.resolver | |
return pip._internal.resolution.legacy.resolver.Resolver( | |
preparer=preparer, | |
finder=finder, | |
wheel_cache=wheel_cache, | |
make_install_req=make_install_req, | |
use_user_site=use_user_site, | |
ignore_dependencies=options.ignore_dependencies, | |
ignore_installed=ignore_installed, | |
ignore_requires_python=ignore_requires_python, | |
force_reinstall=force_reinstall, | |
upgrade_strategy=upgrade_strategy, | |
py_version_info=py_version_info, | |
) | |
def get_requirements( | |
self, | |
args, # type: List[str] | |
options, # type: Values | |
finder, # type: PackageFinder | |
session, # type: PipSession | |
check_supported_wheels=True, # type: bool | |
): | |
# type: (...) -> List[InstallRequirement] | |
""" | |
Parse command-line arguments into the corresponding requirements. | |
""" | |
requirement_set = RequirementSet( | |
check_supported_wheels=check_supported_wheels | |
) | |
for filename in options.constraints: | |
for parsed_req in parse_requirements( | |
filename, | |
constraint=True, finder=finder, options=options, | |
session=session): | |
req_to_add = install_req_from_parsed_requirement( | |
parsed_req, | |
isolated=options.isolated_mode, | |
) | |
req_to_add.is_direct = True | |
requirement_set.add_requirement(req_to_add) | |
for req in args: | |
req_to_add = install_req_from_line( | |
req, None, isolated=options.isolated_mode, | |
use_pep517=options.use_pep517, | |
) | |
req_to_add.is_direct = True | |
requirement_set.add_requirement(req_to_add) | |
for req in options.editables: | |
req_to_add = install_req_from_editable( | |
req, | |
isolated=options.isolated_mode, | |
use_pep517=options.use_pep517, | |
) | |
req_to_add.is_direct = True | |
requirement_set.add_requirement(req_to_add) | |
# NOTE: options.require_hashes may be set if --require-hashes is True | |
for filename in options.requirements: | |
for parsed_req in parse_requirements( | |
filename, | |
finder=finder, options=options, session=session): | |
req_to_add = install_req_from_parsed_requirement( | |
parsed_req, | |
isolated=options.isolated_mode, | |
use_pep517=options.use_pep517 | |
) | |
req_to_add.is_direct = True | |
requirement_set.add_requirement(req_to_add) | |
# If any requirement has hash options, enable hash checking. | |
requirements = requirement_set.all_requirements | |
if any(req.has_hash_options for req in requirements): | |
options.require_hashes = True | |
if not (args or options.editables or options.requirements): | |
opts = {'name': self.name} | |
if options.find_links: | |
raise CommandError( | |
'You must give at least one requirement to {name} ' | |
'(maybe you meant "pip {name} {links}"?)'.format( | |
**dict(opts, links=' '.join(options.find_links)))) | |
else: | |
raise CommandError( | |
'You must give at least one requirement to {name} ' | |
'(see "pip help {name}")'.format(**opts)) | |
return requirements | |
@staticmethod | |
def trace_basic_info(finder): | |
# type: (PackageFinder) -> None | |
""" | |
Trace basic information about the provided objects. | |
""" | |
# Display where finder is looking for packages | |
search_scope = finder.search_scope | |
locations = search_scope.get_formatted_locations() | |
if locations: | |
logger.info(locations) | |
def _build_package_finder( | |
self, | |
options, # type: Values | |
session, # type: PipSession | |
target_python=None, # type: Optional[TargetPython] | |
ignore_requires_python=None, # type: Optional[bool] | |
): | |
# type: (...) -> PackageFinder | |
""" | |
Create a package finder appropriate to this requirement command. | |
:param ignore_requires_python: Whether to ignore incompatible | |
"Requires-Python" values in links. Defaults to False. | |
""" | |
link_collector = make_link_collector(session, options=options) | |
selection_prefs = SelectionPreferences( | |
allow_yanked=True, | |
format_control=options.format_control, | |
allow_all_prereleases=options.pre, | |
prefer_binary=options.prefer_binary, | |
ignore_requires_python=ignore_requires_python, | |
) | |
return PackageFinder.create( | |
link_collector=link_collector, | |
selection_prefs=selection_prefs, | |
target_python=target_python, | |
) |
from __future__ import absolute_import, division | |
import contextlib | |
import itertools | |
import logging | |
import sys | |
import time | |
from pip._vendor.progress import HIDE_CURSOR, SHOW_CURSOR | |
from pip._internal.utils.compat import WINDOWS | |
from pip._internal.utils.logging import get_indentation | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Iterator, IO | |
logger = logging.getLogger(__name__) | |
class SpinnerInterface(object): | |
def spin(self): | |
# type: () -> None | |
raise NotImplementedError() | |
def finish(self, final_status): | |
# type: (str) -> None | |
raise NotImplementedError() | |
class InteractiveSpinner(SpinnerInterface): | |
def __init__(self, message, file=None, spin_chars="-\\|/", | |
# Empirically, 8 updates/second looks nice | |
min_update_interval_seconds=0.125): | |
# type: (str, IO[str], str, float) -> None | |
self._message = message | |
if file is None: | |
file = sys.stdout | |
self._file = file | |
self._rate_limiter = RateLimiter(min_update_interval_seconds) | |
self._finished = False | |
self._spin_cycle = itertools.cycle(spin_chars) | |
self._file.write(" " * get_indentation() + self._message + " ... ") | |
self._width = 0 | |
def _write(self, status): | |
# type: (str) -> None | |
assert not self._finished | |
# Erase what we wrote before by backspacing to the beginning, writing | |
# spaces to overwrite the old text, and then backspacing again | |
backup = "\b" * self._width | |
self._file.write(backup + " " * self._width + backup) | |
# Now we have a blank slate to add our status | |
self._file.write(status) | |
self._width = len(status) | |
self._file.flush() | |
self._rate_limiter.reset() | |
def spin(self): | |
# type: () -> None | |
if self._finished: | |
return | |
if not self._rate_limiter.ready(): | |
return | |
self._write(next(self._spin_cycle)) | |
def finish(self, final_status): | |
# type: (str) -> None | |
if self._finished: | |
return | |
self._write(final_status) | |
self._file.write("\n") | |
self._file.flush() | |
self._finished = True | |
# Used for dumb terminals, non-interactive installs (no tty), etc. | |
# We still print updates occasionally (once every 60 seconds by default) to | |
# act as a keep-alive for systems like Travis-CI that take lack-of-output as | |
# an indication that a task has frozen. | |
class NonInteractiveSpinner(SpinnerInterface): | |
def __init__(self, message, min_update_interval_seconds=60): | |
# type: (str, float) -> None | |
self._message = message | |
self._finished = False | |
self._rate_limiter = RateLimiter(min_update_interval_seconds) | |
self._update("started") | |
def _update(self, status): | |
# type: (str) -> None | |
assert not self._finished | |
self._rate_limiter.reset() | |
logger.info("%s: %s", self._message, status) | |
def spin(self): | |
# type: () -> None | |
if self._finished: | |
return | |
if not self._rate_limiter.ready(): | |
return | |
self._update("still running...") | |
def finish(self, final_status): | |
# type: (str) -> None | |
if self._finished: | |
return | |
self._update( | |
"finished with status '{final_status}'".format(**locals())) | |
self._finished = True | |
class RateLimiter(object): | |
def __init__(self, min_update_interval_seconds): | |
# type: (float) -> None | |
self._min_update_interval_seconds = min_update_interval_seconds | |
self._last_update = 0 # type: float | |
def ready(self): | |
# type: () -> bool | |
now = time.time() | |
delta = now - self._last_update | |
return delta >= self._min_update_interval_seconds | |
def reset(self): | |
# type: () -> None | |
self._last_update = time.time() | |
@contextlib.contextmanager | |
def open_spinner(message): | |
# type: (str) -> Iterator[SpinnerInterface] | |
# Interactive spinner goes directly to sys.stdout rather than being routed | |
# through the logging system, but it acts like it has level INFO, | |
# i.e. it's only displayed if we're at level INFO or better. | |
# Non-interactive spinner goes through the logging system, so it is always | |
# in sync with logging configuration. | |
if sys.stdout.isatty() and logger.getEffectiveLevel() <= logging.INFO: | |
spinner = InteractiveSpinner(message) # type: SpinnerInterface | |
else: | |
spinner = NonInteractiveSpinner(message) | |
try: | |
with hidden_cursor(sys.stdout): | |
yield spinner | |
except KeyboardInterrupt: | |
spinner.finish("canceled") | |
raise | |
except Exception: | |
spinner.finish("error") | |
raise | |
else: | |
spinner.finish("done") | |
@contextlib.contextmanager | |
def hidden_cursor(file): | |
# type: (IO[str]) -> Iterator[None] | |
# The Windows terminal does not support the hide/show cursor ANSI codes, | |
# even via colorama. So don't even try. | |
if WINDOWS: | |
yield | |
# We don't want to clutter the output with control characters if we're | |
# writing to a file, or if the user is running with --quiet. | |
# See https://github.com/pypa/pip/issues/3418 | |
elif not file.isatty() or logger.getEffectiveLevel() > logging.INFO: | |
yield | |
else: | |
file.write(HIDE_CURSOR) | |
try: | |
yield | |
finally: | |
file.write(SHOW_CURSOR) |
from __future__ import absolute_import | |
SUCCESS = 0 | |
ERROR = 1 | |
UNKNOWN_ERROR = 2 | |
VIRTUALENV_NOT_FOUND = 3 | |
PREVIOUS_BUILD_DIR_ERROR = 4 | |
NO_MATCHES_FOUND = 23 |
""" | |
Package containing all pip commands | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
# There is currently a bug in python/typeshed mentioned at | |
# https://github.com/python/typeshed/issues/3906 which causes the | |
# return type of difflib.get_close_matches to be reported | |
# as List[Sequence[str]] whereas it should have been List[str] | |
from __future__ import absolute_import | |
import importlib | |
from collections import OrderedDict, namedtuple | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any | |
from pip._internal.cli.base_command import Command | |
CommandInfo = namedtuple('CommandInfo', 'module_path, class_name, summary') | |
# The ordering matters for help display. | |
# Also, even though the module path starts with the same | |
# "pip._internal.commands" prefix in each case, we include the full path | |
# because it makes testing easier (specifically when modifying commands_dict | |
# in test setup / teardown by adding info for a FakeCommand class defined | |
# in a test-related module). | |
# Finally, we need to pass an iterable of pairs here rather than a dict | |
# so that the ordering won't be lost when using Python 2.7. | |
commands_dict = OrderedDict([ | |
('install', CommandInfo( | |
'pip._internal.commands.install', 'InstallCommand', | |
'Install packages.', | |
)), | |
('download', CommandInfo( | |
'pip._internal.commands.download', 'DownloadCommand', | |
'Download packages.', | |
)), | |
('uninstall', CommandInfo( | |
'pip._internal.commands.uninstall', 'UninstallCommand', | |
'Uninstall packages.', | |
)), | |
('freeze', CommandInfo( | |
'pip._internal.commands.freeze', 'FreezeCommand', | |
'Output installed packages in requirements format.', | |
)), | |
('list', CommandInfo( | |
'pip._internal.commands.list', 'ListCommand', | |
'List installed packages.', | |
)), | |
('show', CommandInfo( | |
'pip._internal.commands.show', 'ShowCommand', | |
'Show information about installed packages.', | |
)), | |
('check', CommandInfo( | |
'pip._internal.commands.check', 'CheckCommand', | |
'Verify installed packages have compatible dependencies.', | |
)), | |
('config', CommandInfo( | |
'pip._internal.commands.configuration', 'ConfigurationCommand', | |
'Manage local and global configuration.', | |
)), | |
('search', CommandInfo( | |
'pip._internal.commands.search', 'SearchCommand', | |
'Search PyPI for packages.', | |
)), | |
('cache', CommandInfo( | |
'pip._internal.commands.cache', 'CacheCommand', | |
"Inspect and manage pip's wheel cache.", | |
)), | |
('wheel', CommandInfo( | |
'pip._internal.commands.wheel', 'WheelCommand', | |
'Build wheels from your requirements.', | |
)), | |
('hash', CommandInfo( | |
'pip._internal.commands.hash', 'HashCommand', | |
'Compute hashes of package archives.', | |
)), | |
('completion', CommandInfo( | |
'pip._internal.commands.completion', 'CompletionCommand', | |
'A helper command used for command completion.', | |
)), | |
('debug', CommandInfo( | |
'pip._internal.commands.debug', 'DebugCommand', | |
'Show information useful for debugging.', | |
)), | |
('help', CommandInfo( | |
'pip._internal.commands.help', 'HelpCommand', | |
'Show help for commands.', | |
)), | |
]) # type: OrderedDict[str, CommandInfo] | |
def create_command(name, **kwargs): | |
# type: (str, **Any) -> Command | |
""" | |
Create an instance of the Command class with the given name. | |
""" | |
module_path, class_name, summary = commands_dict[name] | |
module = importlib.import_module(module_path) | |
command_class = getattr(module, class_name) | |
command = command_class(name=name, summary=summary, **kwargs) | |
return command | |
def get_similar_commands(name): | |
"""Command name auto-correct.""" | |
from difflib import get_close_matches | |
name = name.lower() | |
close_commands = get_close_matches(name, commands_dict.keys()) | |
if close_commands: | |
return close_commands[0] | |
else: | |
return False |
from __future__ import absolute_import | |
import logging | |
import os | |
import textwrap | |
import pip._internal.utils.filesystem as filesystem | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.status_codes import ERROR, SUCCESS | |
from pip._internal.exceptions import CommandError, PipError | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from optparse import Values | |
from typing import Any, List | |
logger = logging.getLogger(__name__) | |
class CacheCommand(Command): | |
""" | |
Inspect and manage pip's wheel cache. | |
Subcommands: | |
dir: Show the cache directory. | |
info: Show information about the cache. | |
list: List filenames of packages stored in the cache. | |
remove: Remove one or more package from the cache. | |
purge: Remove all items from the cache. | |
<pattern> can be a glob expression or a package name. | |
""" | |
ignore_require_venv = True | |
usage = """ | |
%prog dir | |
%prog info | |
%prog list [<pattern>] | |
%prog remove <pattern> | |
%prog purge | |
""" | |
def run(self, options, args): | |
# type: (Values, List[Any]) -> int | |
handlers = { | |
"dir": self.get_cache_dir, | |
"info": self.get_cache_info, | |
"list": self.list_cache_items, | |
"remove": self.remove_cache_items, | |
"purge": self.purge_cache, | |
} | |
if not options.cache_dir: | |
logger.error("pip cache commands can not " | |
"function since cache is disabled.") | |
return ERROR | |
# Determine action | |
if not args or args[0] not in handlers: | |
logger.error("Need an action ({}) to perform.".format( | |
", ".join(sorted(handlers))) | |
) | |
return ERROR | |
action = args[0] | |
# Error handling happens here, not in the action-handlers. | |
try: | |
handlers[action](options, args[1:]) | |
except PipError as e: | |
logger.error(e.args[0]) | |
return ERROR | |
return SUCCESS | |
def get_cache_dir(self, options, args): | |
# type: (Values, List[Any]) -> None | |
if args: | |
raise CommandError('Too many arguments') | |
logger.info(options.cache_dir) | |
def get_cache_info(self, options, args): | |
# type: (Values, List[Any]) -> None | |
if args: | |
raise CommandError('Too many arguments') | |
num_packages = len(self._find_wheels(options, '*')) | |
cache_location = self._wheels_cache_dir(options) | |
cache_size = filesystem.format_directory_size(cache_location) | |
message = textwrap.dedent(""" | |
Location: {location} | |
Size: {size} | |
Number of wheels: {package_count} | |
""").format( | |
location=cache_location, | |
package_count=num_packages, | |
size=cache_size, | |
).strip() | |
logger.info(message) | |
def list_cache_items(self, options, args): | |
# type: (Values, List[Any]) -> None | |
if len(args) > 1: | |
raise CommandError('Too many arguments') | |
if args: | |
pattern = args[0] | |
else: | |
pattern = '*' | |
files = self._find_wheels(options, pattern) | |
if not files: | |
logger.info('Nothing cached.') | |
return | |
results = [] | |
for filename in files: | |
wheel = os.path.basename(filename) | |
size = filesystem.format_file_size(filename) | |
results.append(' - {} ({})'.format(wheel, size)) | |
logger.info('Cache contents:\n') | |
logger.info('\n'.join(sorted(results))) | |
def remove_cache_items(self, options, args): | |
# type: (Values, List[Any]) -> None | |
if len(args) > 1: | |
raise CommandError('Too many arguments') | |
if not args: | |
raise CommandError('Please provide a pattern') | |
files = self._find_wheels(options, args[0]) | |
if not files: | |
raise CommandError('No matching packages') | |
for filename in files: | |
os.unlink(filename) | |
logger.debug('Removed %s', filename) | |
logger.info('Files removed: %s', len(files)) | |
def purge_cache(self, options, args): | |
# type: (Values, List[Any]) -> None | |
if args: | |
raise CommandError('Too many arguments') | |
return self.remove_cache_items(options, ['*']) | |
def _wheels_cache_dir(self, options): | |
# type: (Values) -> str | |
return os.path.join(options.cache_dir, 'wheels') | |
def _find_wheels(self, options, pattern): | |
# type: (Values, str) -> List[str] | |
wheel_dir = self._wheels_cache_dir(options) | |
# The wheel filename format, as specified in PEP 427, is: | |
# {distribution}-{version}(-{build})?-{python}-{abi}-{platform}.whl | |
# | |
# Additionally, non-alphanumeric values in the distribution are | |
# normalized to underscores (_), meaning hyphens can never occur | |
# before `-{version}`. | |
# | |
# Given that information: | |
# - If the pattern we're given contains a hyphen (-), the user is | |
# providing at least the version. Thus, we can just append `*.whl` | |
# to match the rest of it. | |
# - If the pattern we're given doesn't contain a hyphen (-), the | |
# user is only providing the name. Thus, we append `-*.whl` to | |
# match the hyphen before the version, followed by anything else. | |
# | |
# PEP 427: https://www.python.org/dev/peps/pep-0427/ | |
pattern = pattern + ("*.whl" if "-" in pattern else "-*.whl") | |
return filesystem.find_files(wheel_dir, pattern) |
import logging | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.status_codes import ERROR, SUCCESS | |
from pip._internal.operations.check import ( | |
check_package_set, | |
create_package_set_from_installed, | |
) | |
from pip._internal.utils.misc import write_output | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
logger = logging.getLogger(__name__) | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Any | |
from optparse import Values | |
class CheckCommand(Command): | |
"""Verify installed packages have compatible dependencies.""" | |
usage = """ | |
%prog [options]""" | |
def run(self, options, args): | |
# type: (Values, List[Any]) -> int | |
package_set, parsing_probs = create_package_set_from_installed() | |
missing, conflicting = check_package_set(package_set) | |
for project_name in missing: | |
version = package_set[project_name].version | |
for dependency in missing[project_name]: | |
write_output( | |
"%s %s requires %s, which is not installed.", | |
project_name, version, dependency[0], | |
) | |
for project_name in conflicting: | |
version = package_set[project_name].version | |
for dep_name, dep_version, req in conflicting[project_name]: | |
write_output( | |
"%s %s has requirement %s, but you have %s %s.", | |
project_name, version, req, dep_name, dep_version, | |
) | |
if missing or conflicting or parsing_probs: | |
return ERROR | |
else: | |
write_output("No broken requirements found.") | |
return SUCCESS |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import sys | |
import textwrap | |
from pip._internal.cli.base_command import Command | |
from pip._internal.utils.misc import get_prog | |
BASE_COMPLETION = """ | |
# pip {shell} completion start{script}# pip {shell} completion end | |
""" | |
COMPLETION_SCRIPTS = { | |
'bash': """ | |
_pip_completion() | |
{{ | |
COMPREPLY=( $( COMP_WORDS="${{COMP_WORDS[*]}}" \\ | |
COMP_CWORD=$COMP_CWORD \\ | |
PIP_AUTO_COMPLETE=1 $1 2>/dev/null ) ) | |
}} | |
complete -o default -F _pip_completion {prog} | |
""", | |
'zsh': """ | |
function _pip_completion {{ | |
local words cword | |
read -Ac words | |
read -cn cword | |
reply=( $( COMP_WORDS="$words[*]" \\ | |
COMP_CWORD=$(( cword-1 )) \\ | |
PIP_AUTO_COMPLETE=1 $words[1] 2>/dev/null )) | |
}} | |
compctl -K _pip_completion {prog} | |
""", | |
'fish': """ | |
function __fish_complete_pip | |
set -lx COMP_WORDS (commandline -o) "" | |
set -lx COMP_CWORD ( \\ | |
math (contains -i -- (commandline -t) $COMP_WORDS)-1 \\ | |
) | |
set -lx PIP_AUTO_COMPLETE 1 | |
string split \\ -- (eval $COMP_WORDS[1]) | |
end | |
complete -fa "(__fish_complete_pip)" -c {prog} | |
""", | |
} | |
class CompletionCommand(Command): | |
"""A helper command to be used for command completion.""" | |
ignore_require_venv = True | |
def __init__(self, *args, **kw): | |
super(CompletionCommand, self).__init__(*args, **kw) | |
cmd_opts = self.cmd_opts | |
cmd_opts.add_option( | |
'--bash', '-b', | |
action='store_const', | |
const='bash', | |
dest='shell', | |
help='Emit completion code for bash') | |
cmd_opts.add_option( | |
'--zsh', '-z', | |
action='store_const', | |
const='zsh', | |
dest='shell', | |
help='Emit completion code for zsh') | |
cmd_opts.add_option( | |
'--fish', '-f', | |
action='store_const', | |
const='fish', | |
dest='shell', | |
help='Emit completion code for fish') | |
self.parser.insert_option_group(0, cmd_opts) | |
def run(self, options, args): | |
"""Prints the completion code of the given shell""" | |
shells = COMPLETION_SCRIPTS.keys() | |
shell_options = ['--' + shell for shell in sorted(shells)] | |
if options.shell in shells: | |
script = textwrap.dedent( | |
COMPLETION_SCRIPTS.get(options.shell, '').format( | |
prog=get_prog()) | |
) | |
print(BASE_COMPLETION.format(script=script, shell=options.shell)) | |
else: | |
sys.stderr.write( | |
'ERROR: You must pass {}\n' .format(' or '.join(shell_options)) | |
) |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
import logging | |
import os | |
import subprocess | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.status_codes import ERROR, SUCCESS | |
from pip._internal.configuration import ( | |
Configuration, | |
get_configuration_files, | |
kinds, | |
) | |
from pip._internal.exceptions import PipError | |
from pip._internal.utils.misc import get_prog, write_output | |
logger = logging.getLogger(__name__) | |
class ConfigurationCommand(Command): | |
"""Manage local and global configuration. | |
Subcommands: | |
list: List the active configuration (or from the file specified) | |
edit: Edit the configuration file in an editor | |
get: Get the value associated with name | |
set: Set the name=value | |
unset: Unset the value associated with name | |
If none of --user, --global and --site are passed, a virtual | |
environment configuration file is used if one is active and the file | |
exists. Otherwise, all modifications happen on the to the user file by | |
default. | |
""" | |
ignore_require_venv = True | |
usage = """ | |
%prog [<file-option>] list | |
%prog [<file-option>] [--editor <editor-path>] edit | |
%prog [<file-option>] get name | |
%prog [<file-option>] set name value | |
%prog [<file-option>] unset name | |
""" | |
def __init__(self, *args, **kwargs): | |
super(ConfigurationCommand, self).__init__(*args, **kwargs) | |
self.configuration = None | |
self.cmd_opts.add_option( | |
'--editor', | |
dest='editor', | |
action='store', | |
default=None, | |
help=( | |
'Editor to use to edit the file. Uses VISUAL or EDITOR ' | |
'environment variables if not provided.' | |
) | |
) | |
self.cmd_opts.add_option( | |
'--global', | |
dest='global_file', | |
action='store_true', | |
default=False, | |
help='Use the system-wide configuration file only' | |
) | |
self.cmd_opts.add_option( | |
'--user', | |
dest='user_file', | |
action='store_true', | |
default=False, | |
help='Use the user configuration file only' | |
) | |
self.cmd_opts.add_option( | |
'--site', | |
dest='site_file', | |
action='store_true', | |
default=False, | |
help='Use the current environment configuration file only' | |
) | |
self.parser.insert_option_group(0, self.cmd_opts) | |
def run(self, options, args): | |
handlers = { | |
"list": self.list_values, | |
"edit": self.open_in_editor, | |
"get": self.get_name, | |
"set": self.set_name_value, | |
"unset": self.unset_name | |
} | |
# Determine action | |
if not args or args[0] not in handlers: | |
logger.error("Need an action ({}) to perform.".format( | |
", ".join(sorted(handlers))) | |
) | |
return ERROR | |
action = args[0] | |
# Determine which configuration files are to be loaded | |
# Depends on whether the command is modifying. | |
try: | |
load_only = self._determine_file( | |
options, need_value=(action in ["get", "set", "unset", "edit"]) | |
) | |
except PipError as e: | |
logger.error(e.args[0]) | |
return ERROR | |
# Load a new configuration | |
self.configuration = Configuration( | |
isolated=options.isolated_mode, load_only=load_only | |
) | |
self.configuration.load() | |
# Error handling happens here, not in the action-handlers. | |
try: | |
handlers[action](options, args[1:]) | |
except PipError as e: | |
logger.error(e.args[0]) | |
return ERROR | |
return SUCCESS | |
def _determine_file(self, options, need_value): | |
file_options = [key for key, value in ( | |
(kinds.USER, options.user_file), | |
(kinds.GLOBAL, options.global_file), | |
(kinds.SITE, options.site_file), | |
) if value] | |
if not file_options: | |
if not need_value: | |
return None | |
# Default to user, unless there's a site file. | |
elif any( | |
os.path.exists(site_config_file) | |
for site_config_file in get_configuration_files()[kinds.SITE] | |
): | |
return kinds.SITE | |
else: | |
return kinds.USER | |
elif len(file_options) == 1: | |
return file_options[0] | |
raise PipError( | |
"Need exactly one file to operate upon " | |
"(--user, --site, --global) to perform." | |
) | |
def list_values(self, options, args): | |
self._get_n_args(args, "list", n=0) | |
for key, value in sorted(self.configuration.items()): | |
write_output("%s=%r", key, value) | |
def get_name(self, options, args): | |
key = self._get_n_args(args, "get [name]", n=1) | |
value = self.configuration.get_value(key) | |
write_output("%s", value) | |
def set_name_value(self, options, args): | |
key, value = self._get_n_args(args, "set [name] [value]", n=2) | |
self.configuration.set_value(key, value) | |
self._save_configuration() | |
def unset_name(self, options, args): | |
key = self._get_n_args(args, "unset [name]", n=1) | |
self.configuration.unset_value(key) | |
self._save_configuration() | |
def open_in_editor(self, options, args): | |
editor = self._determine_editor(options) | |
fname = self.configuration.get_file_to_edit() | |
if fname is None: | |
raise PipError("Could not determine appropriate file.") | |
try: | |
subprocess.check_call([editor, fname]) | |
except subprocess.CalledProcessError as e: | |
raise PipError( | |
"Editor Subprocess exited with exit code {}" | |
.format(e.returncode) | |
) | |
def _get_n_args(self, args, example, n): | |
"""Helper to make sure the command got the right number of arguments | |
""" | |
if len(args) != n: | |
msg = ( | |
'Got unexpected number of arguments, expected {}. ' | |
'(example: "{} config {}")' | |
).format(n, get_prog(), example) | |
raise PipError(msg) | |
if n == 1: | |
return args[0] | |
else: | |
return args | |
def _save_configuration(self): | |
# We successfully ran a modifying command. Need to save the | |
# configuration. | |
try: | |
self.configuration.save() | |
except Exception: | |
logger.error( | |
"Unable to save configuration. Please report this as a bug.", | |
exc_info=1 | |
) | |
raise PipError("Internal Error.") | |
def _determine_editor(self, options): | |
if options.editor is not None: | |
return options.editor | |
elif "VISUAL" in os.environ: | |
return os.environ["VISUAL"] | |
elif "EDITOR" in os.environ: | |
return os.environ["EDITOR"] | |
else: | |
raise PipError("Could not determine editor to use.") |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import locale | |
import logging | |
import os | |
import sys | |
import pip._vendor | |
from pip._vendor import pkg_resources | |
from pip._vendor.certifi import where | |
from pip import __file__ as pip_location | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.cmdoptions import make_target_python | |
from pip._internal.cli.status_codes import SUCCESS | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import get_pip_version | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from types import ModuleType | |
from typing import Any, List, Optional, Dict | |
from optparse import Values | |
logger = logging.getLogger(__name__) | |
def show_value(name, value): | |
# type: (str, Optional[str]) -> None | |
logger.info('{}: {}'.format(name, value)) | |
def show_sys_implementation(): | |
# type: () -> None | |
logger.info('sys.implementation:') | |
if hasattr(sys, 'implementation'): | |
implementation = sys.implementation # type: ignore | |
implementation_name = implementation.name | |
else: | |
implementation_name = '' | |
with indent_log(): | |
show_value('name', implementation_name) | |
def create_vendor_txt_map(): | |
# type: () -> Dict[str, str] | |
vendor_txt_path = os.path.join( | |
os.path.dirname(pip_location), | |
'_vendor', | |
'vendor.txt' | |
) | |
with open(vendor_txt_path) as f: | |
# Purge non version specifying lines. | |
# Also, remove any space prefix or suffixes (including comments). | |
lines = [line.strip().split(' ', 1)[0] | |
for line in f.readlines() if '==' in line] | |
# Transform into "module" -> version dict. | |
return dict(line.split('==', 1) for line in lines) # type: ignore | |
def get_module_from_module_name(module_name): | |
# type: (str) -> ModuleType | |
# Module name can be uppercase in vendor.txt for some reason... | |
module_name = module_name.lower() | |
# PATCH: setuptools is actually only pkg_resources. | |
if module_name == 'setuptools': | |
module_name = 'pkg_resources' | |
__import__( | |
'pip._vendor.{}'.format(module_name), | |
globals(), | |
locals(), | |
level=0 | |
) | |
return getattr(pip._vendor, module_name) | |
def get_vendor_version_from_module(module_name): | |
# type: (str) -> str | |
module = get_module_from_module_name(module_name) | |
version = getattr(module, '__version__', None) | |
if not version: | |
# Try to find version in debundled module info | |
pkg_set = pkg_resources.WorkingSet( | |
[os.path.dirname(getattr(module, '__file__'))] | |
) | |
package = pkg_set.find(pkg_resources.Requirement.parse(module_name)) | |
version = getattr(package, 'version', None) | |
return version | |
def show_actual_vendor_versions(vendor_txt_versions): | |
# type: (Dict[str, str]) -> None | |
# Logs the actual version and print extra info | |
# if there is a conflict or if the actual version could not be imported. | |
for module_name, expected_version in vendor_txt_versions.items(): | |
extra_message = '' | |
actual_version = get_vendor_version_from_module(module_name) | |
if not actual_version: | |
extra_message = ' (Unable to locate actual module version, using'\ | |
' vendor.txt specified version)' | |
actual_version = expected_version | |
elif actual_version != expected_version: | |
extra_message = ' (CONFLICT: vendor.txt suggests version should'\ | |
' be {})'.format(expected_version) | |
logger.info( | |
'{name}=={actual}{extra}'.format( | |
name=module_name, | |
actual=actual_version, | |
extra=extra_message | |
) | |
) | |
def show_vendor_versions(): | |
# type: () -> None | |
logger.info('vendored library versions:') | |
vendor_txt_versions = create_vendor_txt_map() | |
with indent_log(): | |
show_actual_vendor_versions(vendor_txt_versions) | |
def show_tags(options): | |
# type: (Values) -> None | |
tag_limit = 10 | |
target_python = make_target_python(options) | |
tags = target_python.get_tags() | |
# Display the target options that were explicitly provided. | |
formatted_target = target_python.format_given() | |
suffix = '' | |
if formatted_target: | |
suffix = ' (target: {})'.format(formatted_target) | |
msg = 'Compatible tags: {}{}'.format(len(tags), suffix) | |
logger.info(msg) | |
if options.verbose < 1 and len(tags) > tag_limit: | |
tags_limited = True | |
tags = tags[:tag_limit] | |
else: | |
tags_limited = False | |
with indent_log(): | |
for tag in tags: | |
logger.info(str(tag)) | |
if tags_limited: | |
msg = ( | |
'...\n' | |
'[First {tag_limit} tags shown. Pass --verbose to show all.]' | |
).format(tag_limit=tag_limit) | |
logger.info(msg) | |
def ca_bundle_info(config): | |
levels = set() | |
for key, value in config.items(): | |
levels.add(key.split('.')[0]) | |
if not levels: | |
return "Not specified" | |
levels_that_override_global = ['install', 'wheel', 'download'] | |
global_overriding_level = [ | |
level for level in levels if level in levels_that_override_global | |
] | |
if not global_overriding_level: | |
return 'global' | |
if 'global' in levels: | |
levels.remove('global') | |
return ", ".join(levels) | |
class DebugCommand(Command): | |
""" | |
Display debug information. | |
""" | |
usage = """ | |
%prog <options>""" | |
ignore_require_venv = True | |
def __init__(self, *args, **kw): | |
super(DebugCommand, self).__init__(*args, **kw) | |
cmd_opts = self.cmd_opts | |
cmdoptions.add_target_python_options(cmd_opts) | |
self.parser.insert_option_group(0, cmd_opts) | |
self.parser.config.load() | |
def run(self, options, args): | |
# type: (Values, List[Any]) -> int | |
logger.warning( | |
"This command is only meant for debugging. " | |
"Do not use this with automation for parsing and getting these " | |
"details, since the output and options of this command may " | |
"change without notice." | |
) | |
show_value('pip version', get_pip_version()) | |
show_value('sys.version', sys.version) | |
show_value('sys.executable', sys.executable) | |
show_value('sys.getdefaultencoding', sys.getdefaultencoding()) | |
show_value('sys.getfilesystemencoding', sys.getfilesystemencoding()) | |
show_value( | |
'locale.getpreferredencoding', locale.getpreferredencoding(), | |
) | |
show_value('sys.platform', sys.platform) | |
show_sys_implementation() | |
show_value("'cert' config value", ca_bundle_info(self.parser.config)) | |
show_value("REQUESTS_CA_BUNDLE", os.environ.get('REQUESTS_CA_BUNDLE')) | |
show_value("CURL_CA_BUNDLE", os.environ.get('CURL_CA_BUNDLE')) | |
show_value("pip._vendor.certifi.where()", where()) | |
show_value("pip._vendor.DEBUNDLED", pip._vendor.DEBUNDLED) | |
show_vendor_versions() | |
show_tags(options) | |
return SUCCESS |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.cmdoptions import make_target_python | |
from pip._internal.cli.req_command import RequirementCommand, with_cleanup | |
from pip._internal.req.req_tracker import get_requirement_tracker | |
from pip._internal.utils.misc import ensure_dir, normalize_path, write_output | |
from pip._internal.utils.temp_dir import TempDirectory | |
logger = logging.getLogger(__name__) | |
class DownloadCommand(RequirementCommand): | |
""" | |
Download packages from: | |
- PyPI (and other indexes) using requirement specifiers. | |
- VCS project urls. | |
- Local project directories. | |
- Local or remote source archives. | |
pip also supports downloading from "requirements files", which provide | |
an easy way to specify a whole environment to be downloaded. | |
""" | |
usage = """ | |
%prog [options] <requirement specifier> [package-index-options] ... | |
%prog [options] -r <requirements file> [package-index-options] ... | |
%prog [options] <vcs project url> ... | |
%prog [options] <local project path> ... | |
%prog [options] <archive url/path> ...""" | |
def __init__(self, *args, **kw): | |
super(DownloadCommand, self).__init__(*args, **kw) | |
cmd_opts = self.cmd_opts | |
cmd_opts.add_option(cmdoptions.constraints()) | |
cmd_opts.add_option(cmdoptions.requirements()) | |
cmd_opts.add_option(cmdoptions.build_dir()) | |
cmd_opts.add_option(cmdoptions.no_deps()) | |
cmd_opts.add_option(cmdoptions.global_options()) | |
cmd_opts.add_option(cmdoptions.no_binary()) | |
cmd_opts.add_option(cmdoptions.only_binary()) | |
cmd_opts.add_option(cmdoptions.prefer_binary()) | |
cmd_opts.add_option(cmdoptions.src()) | |
cmd_opts.add_option(cmdoptions.pre()) | |
cmd_opts.add_option(cmdoptions.require_hashes()) | |
cmd_opts.add_option(cmdoptions.progress_bar()) | |
cmd_opts.add_option(cmdoptions.no_build_isolation()) | |
cmd_opts.add_option(cmdoptions.use_pep517()) | |
cmd_opts.add_option(cmdoptions.no_use_pep517()) | |
cmd_opts.add_option( | |
'-d', '--dest', '--destination-dir', '--destination-directory', | |
dest='download_dir', | |
metavar='dir', | |
default=os.curdir, | |
help=("Download packages into <dir>."), | |
) | |
cmdoptions.add_target_python_options(cmd_opts) | |
index_opts = cmdoptions.make_option_group( | |
cmdoptions.index_group, | |
self.parser, | |
) | |
self.parser.insert_option_group(0, index_opts) | |
self.parser.insert_option_group(0, cmd_opts) | |
@with_cleanup | |
def run(self, options, args): | |
options.ignore_installed = True | |
# editable doesn't really make sense for `pip download`, but the bowels | |
# of the RequirementSet code require that property. | |
options.editables = [] | |
cmdoptions.check_dist_restriction(options) | |
options.download_dir = normalize_path(options.download_dir) | |
ensure_dir(options.download_dir) | |
session = self.get_default_session(options) | |
target_python = make_target_python(options) | |
finder = self._build_package_finder( | |
options=options, | |
session=session, | |
target_python=target_python, | |
) | |
build_delete = (not (options.no_clean or options.build_dir)) | |
req_tracker = self.enter_context(get_requirement_tracker()) | |
directory = TempDirectory( | |
options.build_dir, | |
delete=build_delete, | |
kind="download", | |
globally_managed=True, | |
) | |
reqs = self.get_requirements(args, options, finder, session) | |
preparer = self.make_requirement_preparer( | |
temp_build_dir=directory, | |
options=options, | |
req_tracker=req_tracker, | |
session=session, | |
finder=finder, | |
download_dir=options.download_dir, | |
use_user_site=False, | |
) | |
resolver = self.make_resolver( | |
preparer=preparer, | |
finder=finder, | |
options=options, | |
py_version_info=options.python_version, | |
) | |
self.trace_basic_info(finder) | |
requirement_set = resolver.resolve( | |
reqs, check_supported_wheels=True | |
) | |
downloaded = ' '.join([ | |
req.name for req in requirement_set.requirements.values() | |
if req.successfully_downloaded | |
]) | |
if downloaded: | |
write_output('Successfully downloaded %s', downloaded) | |
return requirement_set |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import sys | |
from pip._internal.cache import WheelCache | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.base_command import Command | |
from pip._internal.models.format_control import FormatControl | |
from pip._internal.operations.freeze import freeze | |
from pip._internal.utils.compat import stdlib_pkgs | |
DEV_PKGS = {'pip', 'setuptools', 'distribute', 'wheel'} | |
class FreezeCommand(Command): | |
""" | |
Output installed packages in requirements format. | |
packages are listed in a case-insensitive sorted order. | |
""" | |
usage = """ | |
%prog [options]""" | |
log_streams = ("ext://sys.stderr", "ext://sys.stderr") | |
def __init__(self, *args, **kw): | |
super(FreezeCommand, self).__init__(*args, **kw) | |
self.cmd_opts.add_option( | |
'-r', '--requirement', | |
dest='requirements', | |
action='append', | |
default=[], | |
metavar='file', | |
help="Use the order in the given requirements file and its " | |
"comments when generating output. This option can be " | |
"used multiple times.") | |
self.cmd_opts.add_option( | |
'-f', '--find-links', | |
dest='find_links', | |
action='append', | |
default=[], | |
metavar='URL', | |
help='URL for finding packages, which will be added to the ' | |
'output.') | |
self.cmd_opts.add_option( | |
'-l', '--local', | |
dest='local', | |
action='store_true', | |
default=False, | |
help='If in a virtualenv that has global access, do not output ' | |
'globally-installed packages.') | |
self.cmd_opts.add_option( | |
'--user', | |
dest='user', | |
action='store_true', | |
default=False, | |
help='Only output packages installed in user-site.') | |
self.cmd_opts.add_option(cmdoptions.list_path()) | |
self.cmd_opts.add_option( | |
'--all', | |
dest='freeze_all', | |
action='store_true', | |
help='Do not skip these packages in the output:' | |
' {}'.format(', '.join(DEV_PKGS))) | |
self.cmd_opts.add_option( | |
'--exclude-editable', | |
dest='exclude_editable', | |
action='store_true', | |
help='Exclude editable package from output.') | |
self.parser.insert_option_group(0, self.cmd_opts) | |
def run(self, options, args): | |
format_control = FormatControl(set(), set()) | |
wheel_cache = WheelCache(options.cache_dir, format_control) | |
skip = set(stdlib_pkgs) | |
if not options.freeze_all: | |
skip.update(DEV_PKGS) | |
cmdoptions.check_list_path_option(options) | |
freeze_kwargs = dict( | |
requirement=options.requirements, | |
find_links=options.find_links, | |
local_only=options.local, | |
user_only=options.user, | |
paths=options.path, | |
isolated=options.isolated_mode, | |
wheel_cache=wheel_cache, | |
skip=skip, | |
exclude_editable=options.exclude_editable, | |
) | |
for line in freeze(**freeze_kwargs): | |
sys.stdout.write(line + '\n') |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import hashlib | |
import logging | |
import sys | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.status_codes import ERROR | |
from pip._internal.utils.hashes import FAVORITE_HASH, STRONG_HASHES | |
from pip._internal.utils.misc import read_chunks, write_output | |
logger = logging.getLogger(__name__) | |
class HashCommand(Command): | |
""" | |
Compute a hash of a local package archive. | |
These can be used with --hash in a requirements file to do repeatable | |
installs. | |
""" | |
usage = '%prog [options] <file> ...' | |
ignore_require_venv = True | |
def __init__(self, *args, **kw): | |
super(HashCommand, self).__init__(*args, **kw) | |
self.cmd_opts.add_option( | |
'-a', '--algorithm', | |
dest='algorithm', | |
choices=STRONG_HASHES, | |
action='store', | |
default=FAVORITE_HASH, | |
help='The hash algorithm to use: one of {}'.format( | |
', '.join(STRONG_HASHES))) | |
self.parser.insert_option_group(0, self.cmd_opts) | |
def run(self, options, args): | |
if not args: | |
self.parser.print_usage(sys.stderr) | |
return ERROR | |
algorithm = options.algorithm | |
for path in args: | |
write_output('%s:\n--hash=%s:%s', | |
path, algorithm, _hash_of_file(path, algorithm)) | |
def _hash_of_file(path, algorithm): | |
"""Return the hash digest of a file.""" | |
with open(path, 'rb') as archive: | |
hash = hashlib.new(algorithm) | |
for chunk in read_chunks(archive): | |
hash.update(chunk) | |
return hash.hexdigest() |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.status_codes import SUCCESS | |
from pip._internal.exceptions import CommandError | |
class HelpCommand(Command): | |
"""Show help for commands""" | |
usage = """ | |
%prog <command>""" | |
ignore_require_venv = True | |
def run(self, options, args): | |
from pip._internal.commands import ( | |
commands_dict, create_command, get_similar_commands, | |
) | |
try: | |
# 'pip help' with no args is handled by pip.__init__.parseopt() | |
cmd_name = args[0] # the command we need help for | |
except IndexError: | |
return SUCCESS | |
if cmd_name not in commands_dict: | |
guess = get_similar_commands(cmd_name) | |
msg = ['unknown command "{}"'.format(cmd_name)] | |
if guess: | |
msg.append('maybe you meant "{}"'.format(guess)) | |
raise CommandError(' - '.join(msg)) | |
command = create_command(cmd_name) | |
command.parser.print_help() | |
return SUCCESS |
# The following comment should be removed at some point in the future. | |
# It's included for now because without it InstallCommand.run() has a | |
# couple errors where we have to know req.name is str rather than | |
# Optional[str] for the InstallRequirement req. | |
# mypy: strict-optional=False | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import errno | |
import logging | |
import operator | |
import os | |
import shutil | |
import site | |
from optparse import SUPPRESS_HELP | |
from pip._vendor import pkg_resources | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.cache import WheelCache | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.cmdoptions import make_target_python | |
from pip._internal.cli.req_command import RequirementCommand, with_cleanup | |
from pip._internal.cli.status_codes import ERROR, SUCCESS | |
from pip._internal.exceptions import CommandError, InstallationError | |
from pip._internal.locations import distutils_scheme | |
from pip._internal.operations.check import check_install_conflicts | |
from pip._internal.req import install_given_reqs | |
from pip._internal.req.req_tracker import get_requirement_tracker | |
from pip._internal.utils.deprecation import deprecated | |
from pip._internal.utils.distutils_args import parse_distutils_args | |
from pip._internal.utils.filesystem import test_writable_dir | |
from pip._internal.utils.misc import ( | |
ensure_dir, | |
get_installed_version, | |
protect_pip_from_modification_on_windows, | |
write_output, | |
) | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.virtualenv import virtualenv_no_global | |
from pip._internal.wheel_builder import build, should_build_for_install_command | |
if MYPY_CHECK_RUNNING: | |
from optparse import Values | |
from typing import Any, Iterable, List, Optional | |
from pip._internal.models.format_control import FormatControl | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.wheel_builder import BinaryAllowedPredicate | |
logger = logging.getLogger(__name__) | |
def get_check_binary_allowed(format_control): | |
# type: (FormatControl) -> BinaryAllowedPredicate | |
def check_binary_allowed(req): | |
# type: (InstallRequirement) -> bool | |
if req.use_pep517: | |
return True | |
canonical_name = canonicalize_name(req.name) | |
allowed_formats = format_control.get_allowed_formats(canonical_name) | |
return "binary" in allowed_formats | |
return check_binary_allowed | |
class InstallCommand(RequirementCommand): | |
""" | |
Install packages from: | |
- PyPI (and other indexes) using requirement specifiers. | |
- VCS project urls. | |
- Local project directories. | |
- Local or remote source archives. | |
pip also supports installing from "requirements files", which provide | |
an easy way to specify a whole environment to be installed. | |
""" | |
usage = """ | |
%prog [options] <requirement specifier> [package-index-options] ... | |
%prog [options] -r <requirements file> [package-index-options] ... | |
%prog [options] [-e] <vcs project url> ... | |
%prog [options] [-e] <local project path> ... | |
%prog [options] <archive url/path> ...""" | |
def __init__(self, *args, **kw): | |
super(InstallCommand, self).__init__(*args, **kw) | |
cmd_opts = self.cmd_opts | |
cmd_opts.add_option(cmdoptions.requirements()) | |
cmd_opts.add_option(cmdoptions.constraints()) | |
cmd_opts.add_option(cmdoptions.no_deps()) | |
cmd_opts.add_option(cmdoptions.pre()) | |
cmd_opts.add_option(cmdoptions.editable()) | |
cmd_opts.add_option( | |
'-t', '--target', | |
dest='target_dir', | |
metavar='dir', | |
default=None, | |
help='Install packages into <dir>. ' | |
'By default this will not replace existing files/folders in ' | |
'<dir>. Use --upgrade to replace existing packages in <dir> ' | |
'with new versions.' | |
) | |
cmdoptions.add_target_python_options(cmd_opts) | |
cmd_opts.add_option( | |
'--user', | |
dest='use_user_site', | |
action='store_true', | |
help="Install to the Python user install directory for your " | |
"platform. Typically ~/.local/, or %APPDATA%\\Python on " | |
"Windows. (See the Python documentation for site.USER_BASE " | |
"for full details.)") | |
cmd_opts.add_option( | |
'--no-user', | |
dest='use_user_site', | |
action='store_false', | |
help=SUPPRESS_HELP) | |
cmd_opts.add_option( | |
'--root', | |
dest='root_path', | |
metavar='dir', | |
default=None, | |
help="Install everything relative to this alternate root " | |
"directory.") | |
cmd_opts.add_option( | |
'--prefix', | |
dest='prefix_path', | |
metavar='dir', | |
default=None, | |
help="Installation prefix where lib, bin and other top-level " | |
"folders are placed") | |
cmd_opts.add_option(cmdoptions.build_dir()) | |
cmd_opts.add_option(cmdoptions.src()) | |
cmd_opts.add_option( | |
'-U', '--upgrade', | |
dest='upgrade', | |
action='store_true', | |
help='Upgrade all specified packages to the newest available ' | |
'version. The handling of dependencies depends on the ' | |
'upgrade-strategy used.' | |
) | |
cmd_opts.add_option( | |
'--upgrade-strategy', | |
dest='upgrade_strategy', | |
default='only-if-needed', | |
choices=['only-if-needed', 'eager'], | |
help='Determines how dependency upgrading should be handled ' | |
'[default: %default]. ' | |
'"eager" - dependencies are upgraded regardless of ' | |
'whether the currently installed version satisfies the ' | |
'requirements of the upgraded package(s). ' | |
'"only-if-needed" - are upgraded only when they do not ' | |
'satisfy the requirements of the upgraded package(s).' | |
) | |
cmd_opts.add_option( | |
'--force-reinstall', | |
dest='force_reinstall', | |
action='store_true', | |
help='Reinstall all packages even if they are already ' | |
'up-to-date.') | |
cmd_opts.add_option( | |
'-I', '--ignore-installed', | |
dest='ignore_installed', | |
action='store_true', | |
help='Ignore the installed packages, overwriting them. ' | |
'This can break your system if the existing package ' | |
'is of a different version or was installed ' | |
'with a different package manager!' | |
) | |
cmd_opts.add_option(cmdoptions.ignore_requires_python()) | |
cmd_opts.add_option(cmdoptions.no_build_isolation()) | |
cmd_opts.add_option(cmdoptions.use_pep517()) | |
cmd_opts.add_option(cmdoptions.no_use_pep517()) | |
cmd_opts.add_option(cmdoptions.install_options()) | |
cmd_opts.add_option(cmdoptions.global_options()) | |
cmd_opts.add_option( | |
"--compile", | |
action="store_true", | |
dest="compile", | |
default=True, | |
help="Compile Python source files to bytecode", | |
) | |
cmd_opts.add_option( | |
"--no-compile", | |
action="store_false", | |
dest="compile", | |
help="Do not compile Python source files to bytecode", | |
) | |
cmd_opts.add_option( | |
"--no-warn-script-location", | |
action="store_false", | |
dest="warn_script_location", | |
default=True, | |
help="Do not warn when installing scripts outside PATH", | |
) | |
cmd_opts.add_option( | |
"--no-warn-conflicts", | |
action="store_false", | |
dest="warn_about_conflicts", | |
default=True, | |
help="Do not warn about broken dependencies", | |
) | |
cmd_opts.add_option(cmdoptions.no_binary()) | |
cmd_opts.add_option(cmdoptions.only_binary()) | |
cmd_opts.add_option(cmdoptions.prefer_binary()) | |
cmd_opts.add_option(cmdoptions.require_hashes()) | |
cmd_opts.add_option(cmdoptions.progress_bar()) | |
index_opts = cmdoptions.make_option_group( | |
cmdoptions.index_group, | |
self.parser, | |
) | |
self.parser.insert_option_group(0, index_opts) | |
self.parser.insert_option_group(0, cmd_opts) | |
@with_cleanup | |
def run(self, options, args): | |
# type: (Values, List[Any]) -> int | |
if options.use_user_site and options.target_dir is not None: | |
raise CommandError("Can not combine '--user' and '--target'") | |
cmdoptions.check_install_build_global(options) | |
upgrade_strategy = "to-satisfy-only" | |
if options.upgrade: | |
upgrade_strategy = options.upgrade_strategy | |
cmdoptions.check_dist_restriction(options, check_target=True) | |
install_options = options.install_options or [] | |
options.use_user_site = decide_user_install( | |
options.use_user_site, | |
prefix_path=options.prefix_path, | |
target_dir=options.target_dir, | |
root_path=options.root_path, | |
isolated_mode=options.isolated_mode, | |
) | |
target_temp_dir = None # type: Optional[TempDirectory] | |
target_temp_dir_path = None # type: Optional[str] | |
if options.target_dir: | |
options.ignore_installed = True | |
options.target_dir = os.path.abspath(options.target_dir) | |
if (os.path.exists(options.target_dir) and not | |
os.path.isdir(options.target_dir)): | |
raise CommandError( | |
"Target path exists but is not a directory, will not " | |
"continue." | |
) | |
# Create a target directory for using with the target option | |
target_temp_dir = TempDirectory(kind="target") | |
target_temp_dir_path = target_temp_dir.path | |
global_options = options.global_options or [] | |
session = self.get_default_session(options) | |
target_python = make_target_python(options) | |
finder = self._build_package_finder( | |
options=options, | |
session=session, | |
target_python=target_python, | |
ignore_requires_python=options.ignore_requires_python, | |
) | |
build_delete = (not (options.no_clean or options.build_dir)) | |
wheel_cache = WheelCache(options.cache_dir, options.format_control) | |
req_tracker = self.enter_context(get_requirement_tracker()) | |
directory = TempDirectory( | |
options.build_dir, | |
delete=build_delete, | |
kind="install", | |
globally_managed=True, | |
) | |
try: | |
reqs = self.get_requirements( | |
args, options, finder, session, | |
check_supported_wheels=not options.target_dir, | |
) | |
warn_deprecated_install_options( | |
reqs, options.install_options | |
) | |
preparer = self.make_requirement_preparer( | |
temp_build_dir=directory, | |
options=options, | |
req_tracker=req_tracker, | |
session=session, | |
finder=finder, | |
use_user_site=options.use_user_site, | |
) | |
resolver = self.make_resolver( | |
preparer=preparer, | |
finder=finder, | |
options=options, | |
wheel_cache=wheel_cache, | |
use_user_site=options.use_user_site, | |
ignore_installed=options.ignore_installed, | |
ignore_requires_python=options.ignore_requires_python, | |
force_reinstall=options.force_reinstall, | |
upgrade_strategy=upgrade_strategy, | |
use_pep517=options.use_pep517, | |
) | |
self.trace_basic_info(finder) | |
requirement_set = resolver.resolve( | |
reqs, check_supported_wheels=not options.target_dir | |
) | |
try: | |
pip_req = requirement_set.get_requirement("pip") | |
except KeyError: | |
modifying_pip = None | |
else: | |
# If we're not replacing an already installed pip, | |
# we're not modifying it. | |
modifying_pip = pip_req.satisfied_by is None | |
protect_pip_from_modification_on_windows( | |
modifying_pip=modifying_pip | |
) | |
check_binary_allowed = get_check_binary_allowed( | |
finder.format_control | |
) | |
reqs_to_build = [ | |
r for r in requirement_set.requirements.values() | |
if should_build_for_install_command( | |
r, check_binary_allowed | |
) | |
] | |
_, build_failures = build( | |
reqs_to_build, | |
wheel_cache=wheel_cache, | |
build_options=[], | |
global_options=[], | |
) | |
# If we're using PEP 517, we cannot do a direct install | |
# so we fail here. | |
# We don't care about failures building legacy | |
# requirements, as we'll fall through to a direct | |
# install for those. | |
pep517_build_failures = [ | |
r for r in build_failures if r.use_pep517 | |
] | |
if pep517_build_failures: | |
raise InstallationError( | |
"Could not build wheels for {} which use" | |
" PEP 517 and cannot be installed directly".format( | |
", ".join(r.name for r in pep517_build_failures))) | |
to_install = resolver.get_installation_order( | |
requirement_set | |
) | |
# Consistency Checking of the package set we're installing. | |
should_warn_about_conflicts = ( | |
not options.ignore_dependencies and | |
options.warn_about_conflicts | |
) | |
if should_warn_about_conflicts: | |
self._warn_about_conflicts(to_install) | |
# Don't warn about script install locations if | |
# --target has been specified | |
warn_script_location = options.warn_script_location | |
if options.target_dir: | |
warn_script_location = False | |
installed = install_given_reqs( | |
to_install, | |
install_options, | |
global_options, | |
root=options.root_path, | |
home=target_temp_dir_path, | |
prefix=options.prefix_path, | |
pycompile=options.compile, | |
warn_script_location=warn_script_location, | |
use_user_site=options.use_user_site, | |
) | |
lib_locations = get_lib_location_guesses( | |
user=options.use_user_site, | |
home=target_temp_dir_path, | |
root=options.root_path, | |
prefix=options.prefix_path, | |
isolated=options.isolated_mode, | |
) | |
working_set = pkg_resources.WorkingSet(lib_locations) | |
installed.sort(key=operator.attrgetter('name')) | |
items = [] | |
for result in installed: | |
item = result.name | |
try: | |
installed_version = get_installed_version( | |
result.name, working_set=working_set | |
) | |
if installed_version: | |
item += '-' + installed_version | |
except Exception: | |
pass | |
items.append(item) | |
installed_desc = ' '.join(items) | |
if installed_desc: | |
write_output( | |
'Successfully installed %s', installed_desc, | |
) | |
except EnvironmentError as error: | |
show_traceback = (self.verbosity >= 1) | |
message = create_env_error_message( | |
error, show_traceback, options.use_user_site, | |
) | |
logger.error(message, exc_info=show_traceback) | |
return ERROR | |
if options.target_dir: | |
self._handle_target_dir( | |
options.target_dir, target_temp_dir, options.upgrade | |
) | |
return SUCCESS | |
def _handle_target_dir(self, target_dir, target_temp_dir, upgrade): | |
ensure_dir(target_dir) | |
# Checking both purelib and platlib directories for installed | |
# packages to be moved to target directory | |
lib_dir_list = [] | |
with target_temp_dir: | |
# Checking both purelib and platlib directories for installed | |
# packages to be moved to target directory | |
scheme = distutils_scheme('', home=target_temp_dir.path) | |
purelib_dir = scheme['purelib'] | |
platlib_dir = scheme['platlib'] | |
data_dir = scheme['data'] | |
if os.path.exists(purelib_dir): | |
lib_dir_list.append(purelib_dir) | |
if os.path.exists(platlib_dir) and platlib_dir != purelib_dir: | |
lib_dir_list.append(platlib_dir) | |
if os.path.exists(data_dir): | |
lib_dir_list.append(data_dir) | |
for lib_dir in lib_dir_list: | |
for item in os.listdir(lib_dir): | |
if lib_dir == data_dir: | |
ddir = os.path.join(data_dir, item) | |
if any(s.startswith(ddir) for s in lib_dir_list[:-1]): | |
continue | |
target_item_dir = os.path.join(target_dir, item) | |
if os.path.exists(target_item_dir): | |
if not upgrade: | |
logger.warning( | |
'Target directory %s already exists. Specify ' | |
'--upgrade to force replacement.', | |
target_item_dir | |
) | |
continue | |
if os.path.islink(target_item_dir): | |
logger.warning( | |
'Target directory %s already exists and is ' | |
'a link. pip will not automatically replace ' | |
'links, please remove if replacement is ' | |
'desired.', | |
target_item_dir | |
) | |
continue | |
if os.path.isdir(target_item_dir): | |
shutil.rmtree(target_item_dir) | |
else: | |
os.remove(target_item_dir) | |
shutil.move( | |
os.path.join(lib_dir, item), | |
target_item_dir | |
) | |
def _warn_about_conflicts(self, to_install): | |
try: | |
package_set, _dep_info = check_install_conflicts(to_install) | |
except Exception: | |
logger.error("Error checking for conflicts.", exc_info=True) | |
return | |
missing, conflicting = _dep_info | |
# NOTE: There is some duplication here from pip check | |
for project_name in missing: | |
version = package_set[project_name][0] | |
for dependency in missing[project_name]: | |
logger.critical( | |
"%s %s requires %s, which is not installed.", | |
project_name, version, dependency[1], | |
) | |
for project_name in conflicting: | |
version = package_set[project_name][0] | |
for dep_name, dep_version, req in conflicting[project_name]: | |
logger.critical( | |
"%s %s has requirement %s, but you'll have %s %s which is " | |
"incompatible.", | |
project_name, version, req, dep_name, dep_version, | |
) | |
def get_lib_location_guesses(*args, **kwargs): | |
scheme = distutils_scheme('', *args, **kwargs) | |
return [scheme['purelib'], scheme['platlib']] | |
def site_packages_writable(**kwargs): | |
return all( | |
test_writable_dir(d) for d in set(get_lib_location_guesses(**kwargs)) | |
) | |
def decide_user_install( | |
use_user_site, # type: Optional[bool] | |
prefix_path=None, # type: Optional[str] | |
target_dir=None, # type: Optional[str] | |
root_path=None, # type: Optional[str] | |
isolated_mode=False, # type: bool | |
): | |
# type: (...) -> bool | |
"""Determine whether to do a user install based on the input options. | |
If use_user_site is False, no additional checks are done. | |
If use_user_site is True, it is checked for compatibility with other | |
options. | |
If use_user_site is None, the default behaviour depends on the environment, | |
which is provided by the other arguments. | |
""" | |
# In some cases (config from tox), use_user_site can be set to an integer | |
# rather than a bool, which 'use_user_site is False' wouldn't catch. | |
if (use_user_site is not None) and (not use_user_site): | |
logger.debug("Non-user install by explicit request") | |
return False | |
if use_user_site: | |
if prefix_path: | |
raise CommandError( | |
"Can not combine '--user' and '--prefix' as they imply " | |
"different installation locations" | |
) | |
if virtualenv_no_global(): | |
raise InstallationError( | |
"Can not perform a '--user' install. User site-packages " | |
"are not visible in this virtualenv." | |
) | |
logger.debug("User install by explicit request") | |
return True | |
# If we are here, user installs have not been explicitly requested/avoided | |
assert use_user_site is None | |
# user install incompatible with --prefix/--target | |
if prefix_path or target_dir: | |
logger.debug("Non-user install due to --prefix or --target option") | |
return False | |
# If user installs are not enabled, choose a non-user install | |
if not site.ENABLE_USER_SITE: | |
logger.debug("Non-user install because user site-packages disabled") | |
return False | |
# If we have permission for a non-user install, do that, | |
# otherwise do a user install. | |
if site_packages_writable(root=root_path, isolated=isolated_mode): | |
logger.debug("Non-user install because site-packages writeable") | |
return False | |
logger.info("Defaulting to user installation because normal site-packages " | |
"is not writeable") | |
return True | |
def warn_deprecated_install_options(requirements, options): | |
# type: (List[InstallRequirement], Optional[List[str]]) -> None | |
"""If any location-changing --install-option arguments were passed for | |
requirements or on the command-line, then show a deprecation warning. | |
""" | |
def format_options(option_names): | |
# type: (Iterable[str]) -> List[str] | |
return ["--{}".format(name.replace("_", "-")) for name in option_names] | |
offenders = [] | |
for requirement in requirements: | |
install_options = requirement.install_options | |
location_options = parse_distutils_args(install_options) | |
if location_options: | |
offenders.append( | |
"{!r} from {}".format( | |
format_options(location_options.keys()), requirement | |
) | |
) | |
if options: | |
location_options = parse_distutils_args(options) | |
if location_options: | |
offenders.append( | |
"{!r} from command line".format( | |
format_options(location_options.keys()) | |
) | |
) | |
if not offenders: | |
return | |
deprecated( | |
reason=( | |
"Location-changing options found in --install-option: {}. " | |
"This configuration may cause unexpected behavior and is " | |
"unsupported.".format( | |
"; ".join(offenders) | |
) | |
), | |
replacement=( | |
"using pip-level options like --user, --prefix, --root, and " | |
"--target" | |
), | |
gone_in="20.2", | |
issue=7309, | |
) | |
def create_env_error_message(error, show_traceback, using_user_site): | |
"""Format an error message for an EnvironmentError | |
It may occur anytime during the execution of the install command. | |
""" | |
parts = [] | |
# Mention the error if we are not going to show a traceback | |
parts.append("Could not install packages due to an EnvironmentError") | |
if not show_traceback: | |
parts.append(": ") | |
parts.append(str(error)) | |
else: | |
parts.append(".") | |
# Spilt the error indication from a helper message (if any) | |
parts[-1] += "\n" | |
# Suggest useful actions to the user: | |
# (1) using user site-packages or (2) verifying the permissions | |
if error.errno == errno.EACCES: | |
user_option_part = "Consider using the `--user` option" | |
permissions_part = "Check the permissions" | |
if not using_user_site: | |
parts.extend([ | |
user_option_part, " or ", | |
permissions_part.lower(), | |
]) | |
else: | |
parts.append(permissions_part) | |
parts.append(".\n") | |
return "".join(parts).strip() + "\n" |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import json | |
import logging | |
from pip._vendor import six | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.req_command import IndexGroupCommand | |
from pip._internal.exceptions import CommandError | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.models.selection_prefs import SelectionPreferences | |
from pip._internal.self_outdated_check import make_link_collector | |
from pip._internal.utils.misc import ( | |
dist_is_editable, | |
get_installed_distributions, | |
tabulate, | |
write_output, | |
) | |
from pip._internal.utils.packaging import get_installer | |
logger = logging.getLogger(__name__) | |
class ListCommand(IndexGroupCommand): | |
""" | |
List installed packages, including editables. | |
Packages are listed in a case-insensitive sorted order. | |
""" | |
usage = """ | |
%prog [options]""" | |
def __init__(self, *args, **kw): | |
super(ListCommand, self).__init__(*args, **kw) | |
cmd_opts = self.cmd_opts | |
cmd_opts.add_option( | |
'-o', '--outdated', | |
action='store_true', | |
default=False, | |
help='List outdated packages') | |
cmd_opts.add_option( | |
'-u', '--uptodate', | |
action='store_true', | |
default=False, | |
help='List uptodate packages') | |
cmd_opts.add_option( | |
'-e', '--editable', | |
action='store_true', | |
default=False, | |
help='List editable projects.') | |
cmd_opts.add_option( | |
'-l', '--local', | |
action='store_true', | |
default=False, | |
help=('If in a virtualenv that has global access, do not list ' | |
'globally-installed packages.'), | |
) | |
self.cmd_opts.add_option( | |
'--user', | |
dest='user', | |
action='store_true', | |
default=False, | |
help='Only output packages installed in user-site.') | |
cmd_opts.add_option(cmdoptions.list_path()) | |
cmd_opts.add_option( | |
'--pre', | |
action='store_true', | |
default=False, | |
help=("Include pre-release and development versions. By default, " | |
"pip only finds stable versions."), | |
) | |
cmd_opts.add_option( | |
'--format', | |
action='store', | |
dest='list_format', | |
default="columns", | |
choices=('columns', 'freeze', 'json'), | |
help="Select the output format among: columns (default), freeze, " | |
"or json", | |
) | |
cmd_opts.add_option( | |
'--not-required', | |
action='store_true', | |
dest='not_required', | |
help="List packages that are not dependencies of " | |
"installed packages.", | |
) | |
cmd_opts.add_option( | |
'--exclude-editable', | |
action='store_false', | |
dest='include_editable', | |
help='Exclude editable package from output.', | |
) | |
cmd_opts.add_option( | |
'--include-editable', | |
action='store_true', | |
dest='include_editable', | |
help='Include editable package from output.', | |
default=True, | |
) | |
index_opts = cmdoptions.make_option_group( | |
cmdoptions.index_group, self.parser | |
) | |
self.parser.insert_option_group(0, index_opts) | |
self.parser.insert_option_group(0, cmd_opts) | |
def _build_package_finder(self, options, session): | |
""" | |
Create a package finder appropriate to this list command. | |
""" | |
link_collector = make_link_collector(session, options=options) | |
# Pass allow_yanked=False to ignore yanked versions. | |
selection_prefs = SelectionPreferences( | |
allow_yanked=False, | |
allow_all_prereleases=options.pre, | |
) | |
return PackageFinder.create( | |
link_collector=link_collector, | |
selection_prefs=selection_prefs, | |
) | |
def run(self, options, args): | |
if options.outdated and options.uptodate: | |
raise CommandError( | |
"Options --outdated and --uptodate cannot be combined.") | |
cmdoptions.check_list_path_option(options) | |
packages = get_installed_distributions( | |
local_only=options.local, | |
user_only=options.user, | |
editables_only=options.editable, | |
include_editables=options.include_editable, | |
paths=options.path, | |
) | |
# get_not_required must be called firstly in order to find and | |
# filter out all dependencies correctly. Otherwise a package | |
# can't be identified as requirement because some parent packages | |
# could be filtered out before. | |
if options.not_required: | |
packages = self.get_not_required(packages, options) | |
if options.outdated: | |
packages = self.get_outdated(packages, options) | |
elif options.uptodate: | |
packages = self.get_uptodate(packages, options) | |
self.output_package_listing(packages, options) | |
def get_outdated(self, packages, options): | |
return [ | |
dist for dist in self.iter_packages_latest_infos(packages, options) | |
if dist.latest_version > dist.parsed_version | |
] | |
def get_uptodate(self, packages, options): | |
return [ | |
dist for dist in self.iter_packages_latest_infos(packages, options) | |
if dist.latest_version == dist.parsed_version | |
] | |
def get_not_required(self, packages, options): | |
dep_keys = set() | |
for dist in packages: | |
dep_keys.update(requirement.key for requirement in dist.requires()) | |
return {pkg for pkg in packages if pkg.key not in dep_keys} | |
def iter_packages_latest_infos(self, packages, options): | |
with self._build_session(options) as session: | |
finder = self._build_package_finder(options, session) | |
def latest_info(dist): | |
typ = 'unknown' | |
all_candidates = finder.find_all_candidates(dist.key) | |
if not options.pre: | |
# Remove prereleases | |
all_candidates = [candidate for candidate in all_candidates | |
if not candidate.version.is_prerelease] | |
evaluator = finder.make_candidate_evaluator( | |
project_name=dist.project_name, | |
) | |
best_candidate = evaluator.sort_best_candidate(all_candidates) | |
if best_candidate is None: | |
return None | |
remote_version = best_candidate.version | |
if best_candidate.link.is_wheel: | |
typ = 'wheel' | |
else: | |
typ = 'sdist' | |
# This is dirty but makes the rest of the code much cleaner | |
dist.latest_version = remote_version | |
dist.latest_filetype = typ | |
return dist | |
for dist in map(latest_info, packages): | |
if dist is not None: | |
yield dist | |
def output_package_listing(self, packages, options): | |
packages = sorted( | |
packages, | |
key=lambda dist: dist.project_name.lower(), | |
) | |
if options.list_format == 'columns' and packages: | |
data, header = format_for_columns(packages, options) | |
self.output_package_listing_columns(data, header) | |
elif options.list_format == 'freeze': | |
for dist in packages: | |
if options.verbose >= 1: | |
write_output("%s==%s (%s)", dist.project_name, | |
dist.version, dist.location) | |
else: | |
write_output("%s==%s", dist.project_name, dist.version) | |
elif options.list_format == 'json': | |
write_output(format_for_json(packages, options)) | |
def output_package_listing_columns(self, data, header): | |
# insert the header first: we need to know the size of column names | |
if len(data) > 0: | |
data.insert(0, header) | |
pkg_strings, sizes = tabulate(data) | |
# Create and add a separator. | |
if len(data) > 0: | |
pkg_strings.insert(1, " ".join(map(lambda x: '-' * x, sizes))) | |
for val in pkg_strings: | |
write_output(val) | |
def format_for_columns(pkgs, options): | |
""" | |
Convert the package data into something usable | |
by output_package_listing_columns. | |
""" | |
running_outdated = options.outdated | |
# Adjust the header for the `pip list --outdated` case. | |
if running_outdated: | |
header = ["Package", "Version", "Latest", "Type"] | |
else: | |
header = ["Package", "Version"] | |
data = [] | |
if options.verbose >= 1 or any(dist_is_editable(x) for x in pkgs): | |
header.append("Location") | |
if options.verbose >= 1: | |
header.append("Installer") | |
for proj in pkgs: | |
# if we're working on the 'outdated' list, separate out the | |
# latest_version and type | |
row = [proj.project_name, proj.version] | |
if running_outdated: | |
row.append(proj.latest_version) | |
row.append(proj.latest_filetype) | |
if options.verbose >= 1 or dist_is_editable(proj): | |
row.append(proj.location) | |
if options.verbose >= 1: | |
row.append(get_installer(proj)) | |
data.append(row) | |
return data, header | |
def format_for_json(packages, options): | |
data = [] | |
for dist in packages: | |
info = { | |
'name': dist.project_name, | |
'version': six.text_type(dist.version), | |
} | |
if options.verbose >= 1: | |
info['location'] = dist.location | |
info['installer'] = get_installer(dist) | |
if options.outdated: | |
info['latest_version'] = six.text_type(dist.latest_version) | |
info['latest_filetype'] = dist.latest_filetype | |
data.append(info) | |
return json.dumps(data) |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import sys | |
import textwrap | |
from collections import OrderedDict | |
from pip._vendor import pkg_resources | |
from pip._vendor.packaging.version import parse as parse_version | |
# NOTE: XMLRPC Client is not annotated in typeshed as on 2017-07-17, which is | |
# why we ignore the type on this import | |
from pip._vendor.six.moves import xmlrpc_client # type: ignore | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.req_command import SessionCommandMixin | |
from pip._internal.cli.status_codes import NO_MATCHES_FOUND, SUCCESS | |
from pip._internal.exceptions import CommandError | |
from pip._internal.models.index import PyPI | |
from pip._internal.network.xmlrpc import PipXmlrpcTransport | |
from pip._internal.utils.compat import get_terminal_size | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import write_output | |
logger = logging.getLogger(__name__) | |
class SearchCommand(Command, SessionCommandMixin): | |
"""Search for PyPI packages whose name or summary contains <query>.""" | |
usage = """ | |
%prog [options] <query>""" | |
ignore_require_venv = True | |
def __init__(self, *args, **kw): | |
super(SearchCommand, self).__init__(*args, **kw) | |
self.cmd_opts.add_option( | |
'-i', '--index', | |
dest='index', | |
metavar='URL', | |
default=PyPI.pypi_url, | |
help='Base URL of Python Package Index (default %default)') | |
self.parser.insert_option_group(0, self.cmd_opts) | |
def run(self, options, args): | |
if not args: | |
raise CommandError('Missing required argument (search query).') | |
query = args | |
pypi_hits = self.search(query, options) | |
hits = transform_hits(pypi_hits) | |
terminal_width = None | |
if sys.stdout.isatty(): | |
terminal_width = get_terminal_size()[0] | |
print_results(hits, terminal_width=terminal_width) | |
if pypi_hits: | |
return SUCCESS | |
return NO_MATCHES_FOUND | |
def search(self, query, options): | |
index_url = options.index | |
session = self.get_default_session(options) | |
transport = PipXmlrpcTransport(index_url, session) | |
pypi = xmlrpc_client.ServerProxy(index_url, transport) | |
hits = pypi.search({'name': query, 'summary': query}, 'or') | |
return hits | |
def transform_hits(hits): | |
""" | |
The list from pypi is really a list of versions. We want a list of | |
packages with the list of versions stored inline. This converts the | |
list from pypi into one we can use. | |
""" | |
packages = OrderedDict() | |
for hit in hits: | |
name = hit['name'] | |
summary = hit['summary'] | |
version = hit['version'] | |
if name not in packages.keys(): | |
packages[name] = { | |
'name': name, | |
'summary': summary, | |
'versions': [version], | |
} | |
else: | |
packages[name]['versions'].append(version) | |
# if this is the highest version, replace summary and score | |
if version == highest_version(packages[name]['versions']): | |
packages[name]['summary'] = summary | |
return list(packages.values()) | |
def print_results(hits, name_column_width=None, terminal_width=None): | |
if not hits: | |
return | |
if name_column_width is None: | |
name_column_width = max([ | |
len(hit['name']) + len(highest_version(hit.get('versions', ['-']))) | |
for hit in hits | |
]) + 4 | |
installed_packages = [p.project_name for p in pkg_resources.working_set] | |
for hit in hits: | |
name = hit['name'] | |
summary = hit['summary'] or '' | |
latest = highest_version(hit.get('versions', ['-'])) | |
if terminal_width is not None: | |
target_width = terminal_width - name_column_width - 5 | |
if target_width > 10: | |
# wrap and indent summary to fit terminal | |
summary = textwrap.wrap(summary, target_width) | |
summary = ('\n' + ' ' * (name_column_width + 3)).join(summary) | |
line = '{name_latest:{name_column_width}} - {summary}'.format( | |
name_latest='{name} ({latest})'.format(**locals()), | |
**locals()) | |
try: | |
write_output(line) | |
if name in installed_packages: | |
dist = pkg_resources.get_distribution(name) | |
with indent_log(): | |
if dist.version == latest: | |
write_output('INSTALLED: %s (latest)', dist.version) | |
else: | |
write_output('INSTALLED: %s', dist.version) | |
if parse_version(latest).pre: | |
write_output('LATEST: %s (pre-release; install' | |
' with "pip install --pre")', latest) | |
else: | |
write_output('LATEST: %s', latest) | |
except UnicodeEncodeError: | |
pass | |
def highest_version(versions): | |
return max(versions, key=parse_version) |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
from email.parser import FeedParser | |
from pip._vendor import pkg_resources | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.status_codes import ERROR, SUCCESS | |
from pip._internal.utils.misc import write_output | |
logger = logging.getLogger(__name__) | |
class ShowCommand(Command): | |
""" | |
Show information about one or more installed packages. | |
The output is in RFC-compliant mail header format. | |
""" | |
usage = """ | |
%prog [options] <package> ...""" | |
ignore_require_venv = True | |
def __init__(self, *args, **kw): | |
super(ShowCommand, self).__init__(*args, **kw) | |
self.cmd_opts.add_option( | |
'-f', '--files', | |
dest='files', | |
action='store_true', | |
default=False, | |
help='Show the full list of installed files for each package.') | |
self.parser.insert_option_group(0, self.cmd_opts) | |
def run(self, options, args): | |
if not args: | |
logger.warning('ERROR: Please provide a package name or names.') | |
return ERROR | |
query = args | |
results = search_packages_info(query) | |
if not print_results( | |
results, list_files=options.files, verbose=options.verbose): | |
return ERROR | |
return SUCCESS | |
def search_packages_info(query): | |
""" | |
Gather details from installed distributions. Print distribution name, | |
version, location, and installed files. Installed files requires a | |
pip generated 'installed-files.txt' in the distributions '.egg-info' | |
directory. | |
""" | |
installed = {} | |
for p in pkg_resources.working_set: | |
installed[canonicalize_name(p.project_name)] = p | |
query_names = [canonicalize_name(name) for name in query] | |
missing = sorted( | |
[name for name, pkg in zip(query, query_names) if pkg not in installed] | |
) | |
if missing: | |
logger.warning('Package(s) not found: %s', ', '.join(missing)) | |
def get_requiring_packages(package_name): | |
canonical_name = canonicalize_name(package_name) | |
return [ | |
pkg.project_name for pkg in pkg_resources.working_set | |
if canonical_name in | |
[canonicalize_name(required.name) for required in | |
pkg.requires()] | |
] | |
for dist in [installed[pkg] for pkg in query_names if pkg in installed]: | |
package = { | |
'name': dist.project_name, | |
'version': dist.version, | |
'location': dist.location, | |
'requires': [dep.project_name for dep in dist.requires()], | |
'required_by': get_requiring_packages(dist.project_name) | |
} | |
file_list = None | |
metadata = None | |
if isinstance(dist, pkg_resources.DistInfoDistribution): | |
# RECORDs should be part of .dist-info metadatas | |
if dist.has_metadata('RECORD'): | |
lines = dist.get_metadata_lines('RECORD') | |
paths = [l.split(',')[0] for l in lines] | |
paths = [os.path.join(dist.location, p) for p in paths] | |
file_list = [os.path.relpath(p, dist.location) for p in paths] | |
if dist.has_metadata('METADATA'): | |
metadata = dist.get_metadata('METADATA') | |
else: | |
# Otherwise use pip's log for .egg-info's | |
if dist.has_metadata('installed-files.txt'): | |
paths = dist.get_metadata_lines('installed-files.txt') | |
paths = [os.path.join(dist.egg_info, p) for p in paths] | |
file_list = [os.path.relpath(p, dist.location) for p in paths] | |
if dist.has_metadata('PKG-INFO'): | |
metadata = dist.get_metadata('PKG-INFO') | |
if dist.has_metadata('entry_points.txt'): | |
entry_points = dist.get_metadata_lines('entry_points.txt') | |
package['entry_points'] = entry_points | |
if dist.has_metadata('INSTALLER'): | |
for line in dist.get_metadata_lines('INSTALLER'): | |
if line.strip(): | |
package['installer'] = line.strip() | |
break | |
# @todo: Should pkg_resources.Distribution have a | |
# `get_pkg_info` method? | |
feed_parser = FeedParser() | |
feed_parser.feed(metadata) | |
pkg_info_dict = feed_parser.close() | |
for key in ('metadata-version', 'summary', | |
'home-page', 'author', 'author-email', 'license'): | |
package[key] = pkg_info_dict.get(key) | |
# It looks like FeedParser cannot deal with repeated headers | |
classifiers = [] | |
for line in metadata.splitlines(): | |
if line.startswith('Classifier: '): | |
classifiers.append(line[len('Classifier: '):]) | |
package['classifiers'] = classifiers | |
if file_list: | |
package['files'] = sorted(file_list) | |
yield package | |
def print_results(distributions, list_files=False, verbose=False): | |
""" | |
Print the information from installed distributions found. | |
""" | |
results_printed = False | |
for i, dist in enumerate(distributions): | |
results_printed = True | |
if i > 0: | |
write_output("---") | |
write_output("Name: %s", dist.get('name', '')) | |
write_output("Version: %s", dist.get('version', '')) | |
write_output("Summary: %s", dist.get('summary', '')) | |
write_output("Home-page: %s", dist.get('home-page', '')) | |
write_output("Author: %s", dist.get('author', '')) | |
write_output("Author-email: %s", dist.get('author-email', '')) | |
write_output("License: %s", dist.get('license', '')) | |
write_output("Location: %s", dist.get('location', '')) | |
write_output("Requires: %s", ', '.join(dist.get('requires', []))) | |
write_output("Required-by: %s", ', '.join(dist.get('required_by', []))) | |
if verbose: | |
write_output("Metadata-Version: %s", | |
dist.get('metadata-version', '')) | |
write_output("Installer: %s", dist.get('installer', '')) | |
write_output("Classifiers:") | |
for classifier in dist.get('classifiers', []): | |
write_output(" %s", classifier) | |
write_output("Entry-points:") | |
for entry in dist.get('entry_points', []): | |
write_output(" %s", entry.strip()) | |
if list_files: | |
write_output("Files:") | |
for line in dist.get('files', []): | |
write_output(" %s", line.strip()) | |
if "files" not in dist: | |
write_output("Cannot locate installed-files.txt") | |
return results_printed |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.cli.base_command import Command | |
from pip._internal.cli.req_command import SessionCommandMixin | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.req import parse_requirements | |
from pip._internal.req.constructors import ( | |
install_req_from_line, | |
install_req_from_parsed_requirement, | |
) | |
from pip._internal.utils.misc import protect_pip_from_modification_on_windows | |
class UninstallCommand(Command, SessionCommandMixin): | |
""" | |
Uninstall packages. | |
pip is able to uninstall most installed packages. Known exceptions are: | |
- Pure distutils packages installed with ``python setup.py install``, which | |
leave behind no metadata to determine what files were installed. | |
- Script wrappers installed by ``python setup.py develop``. | |
""" | |
usage = """ | |
%prog [options] <package> ... | |
%prog [options] -r <requirements file> ...""" | |
def __init__(self, *args, **kw): | |
super(UninstallCommand, self).__init__(*args, **kw) | |
self.cmd_opts.add_option( | |
'-r', '--requirement', | |
dest='requirements', | |
action='append', | |
default=[], | |
metavar='file', | |
help='Uninstall all the packages listed in the given requirements ' | |
'file. This option can be used multiple times.', | |
) | |
self.cmd_opts.add_option( | |
'-y', '--yes', | |
dest='yes', | |
action='store_true', | |
help="Don't ask for confirmation of uninstall deletions.") | |
self.parser.insert_option_group(0, self.cmd_opts) | |
def run(self, options, args): | |
session = self.get_default_session(options) | |
reqs_to_uninstall = {} | |
for name in args: | |
req = install_req_from_line( | |
name, isolated=options.isolated_mode, | |
) | |
if req.name: | |
reqs_to_uninstall[canonicalize_name(req.name)] = req | |
for filename in options.requirements: | |
for parsed_req in parse_requirements( | |
filename, | |
options=options, | |
session=session): | |
req = install_req_from_parsed_requirement( | |
parsed_req, | |
isolated=options.isolated_mode | |
) | |
if req.name: | |
reqs_to_uninstall[canonicalize_name(req.name)] = req | |
if not reqs_to_uninstall: | |
raise InstallationError( | |
'You must give at least one requirement to {self.name} (see ' | |
'"pip help {self.name}")'.format(**locals()) | |
) | |
protect_pip_from_modification_on_windows( | |
modifying_pip="pip" in reqs_to_uninstall | |
) | |
for req in reqs_to_uninstall.values(): | |
uninstall_pathset = req.uninstall( | |
auto_confirm=options.yes, verbose=self.verbosity > 0, | |
) | |
if uninstall_pathset: | |
uninstall_pathset.commit() |
# -*- coding: utf-8 -*- | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
import shutil | |
from pip._internal.cache import WheelCache | |
from pip._internal.cli import cmdoptions | |
from pip._internal.cli.req_command import RequirementCommand, with_cleanup | |
from pip._internal.exceptions import CommandError | |
from pip._internal.req.req_tracker import get_requirement_tracker | |
from pip._internal.utils.misc import ensure_dir, normalize_path | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.wheel_builder import build, should_build_for_wheel_command | |
if MYPY_CHECK_RUNNING: | |
from optparse import Values | |
from typing import Any, List | |
logger = logging.getLogger(__name__) | |
class WheelCommand(RequirementCommand): | |
""" | |
Build Wheel archives for your requirements and dependencies. | |
Wheel is a built-package format, and offers the advantage of not | |
recompiling your software during every install. For more details, see the | |
wheel docs: https://wheel.readthedocs.io/en/latest/ | |
Requirements: setuptools>=0.8, and wheel. | |
'pip wheel' uses the bdist_wheel setuptools extension from the wheel | |
package to build individual wheels. | |
""" | |
usage = """ | |
%prog [options] <requirement specifier> ... | |
%prog [options] -r <requirements file> ... | |
%prog [options] [-e] <vcs project url> ... | |
%prog [options] [-e] <local project path> ... | |
%prog [options] <archive url/path> ...""" | |
def __init__(self, *args, **kw): | |
super(WheelCommand, self).__init__(*args, **kw) | |
cmd_opts = self.cmd_opts | |
cmd_opts.add_option( | |
'-w', '--wheel-dir', | |
dest='wheel_dir', | |
metavar='dir', | |
default=os.curdir, | |
help=("Build wheels into <dir>, where the default is the " | |
"current working directory."), | |
) | |
cmd_opts.add_option(cmdoptions.no_binary()) | |
cmd_opts.add_option(cmdoptions.only_binary()) | |
cmd_opts.add_option(cmdoptions.prefer_binary()) | |
cmd_opts.add_option( | |
'--build-option', | |
dest='build_options', | |
metavar='options', | |
action='append', | |
help="Extra arguments to be supplied to 'setup.py bdist_wheel'.", | |
) | |
cmd_opts.add_option(cmdoptions.no_build_isolation()) | |
cmd_opts.add_option(cmdoptions.use_pep517()) | |
cmd_opts.add_option(cmdoptions.no_use_pep517()) | |
cmd_opts.add_option(cmdoptions.constraints()) | |
cmd_opts.add_option(cmdoptions.editable()) | |
cmd_opts.add_option(cmdoptions.requirements()) | |
cmd_opts.add_option(cmdoptions.src()) | |
cmd_opts.add_option(cmdoptions.ignore_requires_python()) | |
cmd_opts.add_option(cmdoptions.no_deps()) | |
cmd_opts.add_option(cmdoptions.build_dir()) | |
cmd_opts.add_option(cmdoptions.progress_bar()) | |
cmd_opts.add_option( | |
'--global-option', | |
dest='global_options', | |
action='append', | |
metavar='options', | |
help="Extra global options to be supplied to the setup.py " | |
"call before the 'bdist_wheel' command.") | |
cmd_opts.add_option( | |
'--pre', | |
action='store_true', | |
default=False, | |
help=("Include pre-release and development versions. By default, " | |
"pip only finds stable versions."), | |
) | |
cmd_opts.add_option(cmdoptions.require_hashes()) | |
index_opts = cmdoptions.make_option_group( | |
cmdoptions.index_group, | |
self.parser, | |
) | |
self.parser.insert_option_group(0, index_opts) | |
self.parser.insert_option_group(0, cmd_opts) | |
@with_cleanup | |
def run(self, options, args): | |
# type: (Values, List[Any]) -> None | |
cmdoptions.check_install_build_global(options) | |
session = self.get_default_session(options) | |
finder = self._build_package_finder(options, session) | |
build_delete = (not (options.no_clean or options.build_dir)) | |
wheel_cache = WheelCache(options.cache_dir, options.format_control) | |
options.wheel_dir = normalize_path(options.wheel_dir) | |
ensure_dir(options.wheel_dir) | |
req_tracker = self.enter_context(get_requirement_tracker()) | |
directory = TempDirectory( | |
options.build_dir, | |
delete=build_delete, | |
kind="wheel", | |
globally_managed=True, | |
) | |
reqs = self.get_requirements(args, options, finder, session) | |
preparer = self.make_requirement_preparer( | |
temp_build_dir=directory, | |
options=options, | |
req_tracker=req_tracker, | |
session=session, | |
finder=finder, | |
wheel_download_dir=options.wheel_dir, | |
use_user_site=False, | |
) | |
resolver = self.make_resolver( | |
preparer=preparer, | |
finder=finder, | |
options=options, | |
wheel_cache=wheel_cache, | |
ignore_requires_python=options.ignore_requires_python, | |
use_pep517=options.use_pep517, | |
) | |
self.trace_basic_info(finder) | |
requirement_set = resolver.resolve( | |
reqs, check_supported_wheels=True | |
) | |
reqs_to_build = [ | |
r for r in requirement_set.requirements.values() | |
if should_build_for_wheel_command(r) | |
] | |
# build wheels | |
build_successes, build_failures = build( | |
reqs_to_build, | |
wheel_cache=wheel_cache, | |
build_options=options.build_options or [], | |
global_options=options.global_options or [], | |
) | |
for req in build_successes: | |
assert req.link and req.link.is_wheel | |
assert req.local_file_path | |
# copy from cache to target directory | |
try: | |
shutil.copy(req.local_file_path, options.wheel_dir) | |
except OSError as e: | |
logger.warning( | |
"Building wheel for %s failed: %s", | |
req.name, e, | |
) | |
build_failures.append(req) | |
if len(build_failures) != 0: | |
raise CommandError( | |
"Failed to build one or more wheels" | |
) |
"""Configuration management setup | |
Some terminology: | |
- name | |
As written in config files. | |
- value | |
Value associated with a name | |
- key | |
Name combined with it's section (section.name) | |
- variant | |
A single word describing where the configuration key-value pair came from | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
import locale | |
import logging | |
import os | |
import sys | |
from pip._vendor.six.moves import configparser | |
from pip._internal.exceptions import ( | |
ConfigurationError, | |
ConfigurationFileCouldNotBeLoaded, | |
) | |
from pip._internal.utils import appdirs | |
from pip._internal.utils.compat import WINDOWS, expanduser | |
from pip._internal.utils.misc import ensure_dir, enum | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Dict, Iterable, List, NewType, Optional, Tuple | |
) | |
RawConfigParser = configparser.RawConfigParser # Shorthand | |
Kind = NewType("Kind", str) | |
logger = logging.getLogger(__name__) | |
# NOTE: Maybe use the optionx attribute to normalize keynames. | |
def _normalize_name(name): | |
# type: (str) -> str | |
"""Make a name consistent regardless of source (environment or file) | |
""" | |
name = name.lower().replace('_', '-') | |
if name.startswith('--'): | |
name = name[2:] # only prefer long opts | |
return name | |
def _disassemble_key(name): | |
# type: (str) -> List[str] | |
if "." not in name: | |
error_message = ( | |
"Key does not contain dot separated section and key. " | |
"Perhaps you wanted to use 'global.{}' instead?" | |
).format(name) | |
raise ConfigurationError(error_message) | |
return name.split(".", 1) | |
# The kinds of configurations there are. | |
kinds = enum( | |
USER="user", # User Specific | |
GLOBAL="global", # System Wide | |
SITE="site", # [Virtual] Environment Specific | |
ENV="env", # from PIP_CONFIG_FILE | |
ENV_VAR="env-var", # from Environment Variables | |
) | |
CONFIG_BASENAME = 'pip.ini' if WINDOWS else 'pip.conf' | |
def get_configuration_files(): | |
# type: () -> Dict[Kind, List[str]] | |
global_config_files = [ | |
os.path.join(path, CONFIG_BASENAME) | |
for path in appdirs.site_config_dirs('pip') | |
] | |
site_config_file = os.path.join(sys.prefix, CONFIG_BASENAME) | |
legacy_config_file = os.path.join( | |
expanduser('~'), | |
'pip' if WINDOWS else '.pip', | |
CONFIG_BASENAME, | |
) | |
new_config_file = os.path.join( | |
appdirs.user_config_dir("pip"), CONFIG_BASENAME | |
) | |
return { | |
kinds.GLOBAL: global_config_files, | |
kinds.SITE: [site_config_file], | |
kinds.USER: [legacy_config_file, new_config_file], | |
} | |
class Configuration(object): | |
"""Handles management of configuration. | |
Provides an interface to accessing and managing configuration files. | |
This class converts provides an API that takes "section.key-name" style | |
keys and stores the value associated with it as "key-name" under the | |
section "section". | |
This allows for a clean interface wherein the both the section and the | |
key-name are preserved in an easy to manage form in the configuration files | |
and the data stored is also nice. | |
""" | |
def __init__(self, isolated, load_only=None): | |
# type: (bool, Kind) -> None | |
super(Configuration, self).__init__() | |
_valid_load_only = [kinds.USER, kinds.GLOBAL, kinds.SITE, None] | |
if load_only not in _valid_load_only: | |
raise ConfigurationError( | |
"Got invalid value for load_only - should be one of {}".format( | |
", ".join(map(repr, _valid_load_only[:-1])) | |
) | |
) | |
self.isolated = isolated # type: bool | |
self.load_only = load_only # type: Optional[Kind] | |
# The order here determines the override order. | |
self._override_order = [ | |
kinds.GLOBAL, kinds.USER, kinds.SITE, kinds.ENV, kinds.ENV_VAR | |
] | |
self._ignore_env_names = ["version", "help"] | |
# Because we keep track of where we got the data from | |
self._parsers = { | |
variant: [] for variant in self._override_order | |
} # type: Dict[Kind, List[Tuple[str, RawConfigParser]]] | |
self._config = { | |
variant: {} for variant in self._override_order | |
} # type: Dict[Kind, Dict[str, Any]] | |
self._modified_parsers = [] # type: List[Tuple[str, RawConfigParser]] | |
def load(self): | |
# type: () -> None | |
"""Loads configuration from configuration files and environment | |
""" | |
self._load_config_files() | |
if not self.isolated: | |
self._load_environment_vars() | |
def get_file_to_edit(self): | |
# type: () -> Optional[str] | |
"""Returns the file with highest priority in configuration | |
""" | |
assert self.load_only is not None, \ | |
"Need to be specified a file to be editing" | |
try: | |
return self._get_parser_to_modify()[0] | |
except IndexError: | |
return None | |
def items(self): | |
# type: () -> Iterable[Tuple[str, Any]] | |
"""Returns key-value pairs like dict.items() representing the loaded | |
configuration | |
""" | |
return self._dictionary.items() | |
def get_value(self, key): | |
# type: (str) -> Any | |
"""Get a value from the configuration. | |
""" | |
try: | |
return self._dictionary[key] | |
except KeyError: | |
raise ConfigurationError("No such key - {}".format(key)) | |
def set_value(self, key, value): | |
# type: (str, Any) -> None | |
"""Modify a value in the configuration. | |
""" | |
self._ensure_have_load_only() | |
fname, parser = self._get_parser_to_modify() | |
if parser is not None: | |
section, name = _disassemble_key(key) | |
# Modify the parser and the configuration | |
if not parser.has_section(section): | |
parser.add_section(section) | |
parser.set(section, name, value) | |
self._config[self.load_only][key] = value | |
self._mark_as_modified(fname, parser) | |
def unset_value(self, key): | |
# type: (str) -> None | |
"""Unset a value in the configuration. | |
""" | |
self._ensure_have_load_only() | |
if key not in self._config[self.load_only]: | |
raise ConfigurationError("No such key - {}".format(key)) | |
fname, parser = self._get_parser_to_modify() | |
if parser is not None: | |
section, name = _disassemble_key(key) | |
# Remove the key in the parser | |
modified_something = False | |
if parser.has_section(section): | |
# Returns whether the option was removed or not | |
modified_something = parser.remove_option(section, name) | |
if modified_something: | |
# name removed from parser, section may now be empty | |
section_iter = iter(parser.items(section)) | |
try: | |
val = next(section_iter) | |
except StopIteration: | |
val = None | |
if val is None: | |
parser.remove_section(section) | |
self._mark_as_modified(fname, parser) | |
else: | |
raise ConfigurationError( | |
"Fatal Internal error [id=1]. Please report as a bug." | |
) | |
del self._config[self.load_only][key] | |
def save(self): | |
# type: () -> None | |
"""Save the current in-memory state. | |
""" | |
self._ensure_have_load_only() | |
for fname, parser in self._modified_parsers: | |
logger.info("Writing to %s", fname) | |
# Ensure directory exists. | |
ensure_dir(os.path.dirname(fname)) | |
with open(fname, "w") as f: | |
parser.write(f) | |
# | |
# Private routines | |
# | |
def _ensure_have_load_only(self): | |
# type: () -> None | |
if self.load_only is None: | |
raise ConfigurationError("Needed a specific file to be modifying.") | |
logger.debug("Will be working with %s variant only", self.load_only) | |
@property | |
def _dictionary(self): | |
# type: () -> Dict[str, Any] | |
"""A dictionary representing the loaded configuration. | |
""" | |
# NOTE: Dictionaries are not populated if not loaded. So, conditionals | |
# are not needed here. | |
retval = {} | |
for variant in self._override_order: | |
retval.update(self._config[variant]) | |
return retval | |
def _load_config_files(self): | |
# type: () -> None | |
"""Loads configuration from configuration files | |
""" | |
config_files = dict(self._iter_config_files()) | |
if config_files[kinds.ENV][0:1] == [os.devnull]: | |
logger.debug( | |
"Skipping loading configuration files due to " | |
"environment's PIP_CONFIG_FILE being os.devnull" | |
) | |
return | |
for variant, files in config_files.items(): | |
for fname in files: | |
# If there's specific variant set in `load_only`, load only | |
# that variant, not the others. | |
if self.load_only is not None and variant != self.load_only: | |
logger.debug( | |
"Skipping file '%s' (variant: %s)", fname, variant | |
) | |
continue | |
parser = self._load_file(variant, fname) | |
# Keeping track of the parsers used | |
self._parsers[variant].append((fname, parser)) | |
def _load_file(self, variant, fname): | |
# type: (Kind, str) -> RawConfigParser | |
logger.debug("For variant '%s', will try loading '%s'", variant, fname) | |
parser = self._construct_parser(fname) | |
for section in parser.sections(): | |
items = parser.items(section) | |
self._config[variant].update(self._normalized_keys(section, items)) | |
return parser | |
def _construct_parser(self, fname): | |
# type: (str) -> RawConfigParser | |
parser = configparser.RawConfigParser() | |
# If there is no such file, don't bother reading it but create the | |
# parser anyway, to hold the data. | |
# Doing this is useful when modifying and saving files, where we don't | |
# need to construct a parser. | |
if os.path.exists(fname): | |
try: | |
parser.read(fname) | |
except UnicodeDecodeError: | |
# See https://github.com/pypa/pip/issues/4963 | |
raise ConfigurationFileCouldNotBeLoaded( | |
reason="contains invalid {} characters".format( | |
locale.getpreferredencoding(False) | |
), | |
fname=fname, | |
) | |
except configparser.Error as error: | |
# See https://github.com/pypa/pip/issues/4893 | |
raise ConfigurationFileCouldNotBeLoaded(error=error) | |
return parser | |
def _load_environment_vars(self): | |
# type: () -> None | |
"""Loads configuration from environment variables | |
""" | |
self._config[kinds.ENV_VAR].update( | |
self._normalized_keys(":env:", self._get_environ_vars()) | |
) | |
def _normalized_keys(self, section, items): | |
# type: (str, Iterable[Tuple[str, Any]]) -> Dict[str, Any] | |
"""Normalizes items to construct a dictionary with normalized keys. | |
This routine is where the names become keys and are made the same | |
regardless of source - configuration files or environment. | |
""" | |
normalized = {} | |
for name, val in items: | |
key = section + "." + _normalize_name(name) | |
normalized[key] = val | |
return normalized | |
def _get_environ_vars(self): | |
# type: () -> Iterable[Tuple[str, str]] | |
"""Returns a generator with all environmental vars with prefix PIP_""" | |
for key, val in os.environ.items(): | |
should_be_yielded = ( | |
key.startswith("PIP_") and | |
key[4:].lower() not in self._ignore_env_names | |
) | |
if should_be_yielded: | |
yield key[4:].lower(), val | |
# XXX: This is patched in the tests. | |
def _iter_config_files(self): | |
# type: () -> Iterable[Tuple[Kind, List[str]]] | |
"""Yields variant and configuration files associated with it. | |
This should be treated like items of a dictionary. | |
""" | |
# SMELL: Move the conditions out of this function | |
# environment variables have the lowest priority | |
config_file = os.environ.get('PIP_CONFIG_FILE', None) | |
if config_file is not None: | |
yield kinds.ENV, [config_file] | |
else: | |
yield kinds.ENV, [] | |
config_files = get_configuration_files() | |
# at the base we have any global configuration | |
yield kinds.GLOBAL, config_files[kinds.GLOBAL] | |
# per-user configuration next | |
should_load_user_config = not self.isolated and not ( | |
config_file and os.path.exists(config_file) | |
) | |
if should_load_user_config: | |
# The legacy config file is overridden by the new config file | |
yield kinds.USER, config_files[kinds.USER] | |
# finally virtualenv configuration first trumping others | |
yield kinds.SITE, config_files[kinds.SITE] | |
def _get_parser_to_modify(self): | |
# type: () -> Tuple[str, RawConfigParser] | |
# Determine which parser to modify | |
parsers = self._parsers[self.load_only] | |
if not parsers: | |
# This should not happen if everything works correctly. | |
raise ConfigurationError( | |
"Fatal Internal error [id=2]. Please report as a bug." | |
) | |
# Use the highest priority parser. | |
return parsers[-1] | |
# XXX: This is patched in the tests. | |
def _mark_as_modified(self, fname, parser): | |
# type: (str, RawConfigParser) -> None | |
file_parser_tuple = (fname, parser) | |
if file_parser_tuple not in self._modified_parsers: | |
self._modified_parsers.append(file_parser_tuple) | |
def __repr__(self): | |
# type: () -> str | |
return "{}({!r})".format(self.__class__.__name__, self._dictionary) |
from pip._internal.distributions.sdist import SourceDistribution | |
from pip._internal.distributions.wheel import WheelDistribution | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from pip._internal.distributions.base import AbstractDistribution | |
from pip._internal.req.req_install import InstallRequirement | |
def make_distribution_for_install_requirement(install_req): | |
# type: (InstallRequirement) -> AbstractDistribution | |
"""Returns a Distribution for the given InstallRequirement | |
""" | |
# Editable requirements will always be source distributions. They use the | |
# legacy logic until we create a modern standard for them. | |
if install_req.editable: | |
return SourceDistribution(install_req) | |
# If it's a wheel, it's a WheelDistribution | |
if install_req.is_wheel: | |
return WheelDistribution(install_req) | |
# Otherwise, a SourceDistribution | |
return SourceDistribution(install_req) |
import abc | |
from pip._vendor.six import add_metaclass | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional | |
from pip._vendor.pkg_resources import Distribution | |
from pip._internal.req import InstallRequirement | |
from pip._internal.index.package_finder import PackageFinder | |
@add_metaclass(abc.ABCMeta) | |
class AbstractDistribution(object): | |
"""A base class for handling installable artifacts. | |
The requirements for anything installable are as follows: | |
- we must be able to determine the requirement name | |
(or we can't correctly handle the non-upgrade case). | |
- for packages with setup requirements, we must also be able | |
to determine their requirements without installing additional | |
packages (for the same reason as run-time dependencies) | |
- we must be able to create a Distribution object exposing the | |
above metadata. | |
""" | |
def __init__(self, req): | |
# type: (InstallRequirement) -> None | |
super(AbstractDistribution, self).__init__() | |
self.req = req | |
@abc.abstractmethod | |
def get_pkg_resources_distribution(self): | |
# type: () -> Optional[Distribution] | |
raise NotImplementedError() | |
@abc.abstractmethod | |
def prepare_distribution_metadata(self, finder, build_isolation): | |
# type: (PackageFinder, bool) -> None | |
raise NotImplementedError() |
from pip._internal.distributions.base import AbstractDistribution | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional | |
from pip._vendor.pkg_resources import Distribution | |
from pip._internal.index.package_finder import PackageFinder | |
class InstalledDistribution(AbstractDistribution): | |
"""Represents an installed package. | |
This does not need any preparation as the required information has already | |
been computed. | |
""" | |
def get_pkg_resources_distribution(self): | |
# type: () -> Optional[Distribution] | |
return self.req.satisfied_by | |
def prepare_distribution_metadata(self, finder, build_isolation): | |
# type: (PackageFinder, bool) -> None | |
pass |
import logging | |
from pip._internal.build_env import BuildEnvironment | |
from pip._internal.distributions.base import AbstractDistribution | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.utils.subprocess import runner_with_spinner_message | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Set, Tuple | |
from pip._vendor.pkg_resources import Distribution | |
from pip._internal.index.package_finder import PackageFinder | |
logger = logging.getLogger(__name__) | |
class SourceDistribution(AbstractDistribution): | |
"""Represents a source distribution. | |
The preparation step for these needs metadata for the packages to be | |
generated, either using PEP 517 or using the legacy `setup.py egg_info`. | |
""" | |
def get_pkg_resources_distribution(self): | |
# type: () -> Distribution | |
return self.req.get_dist() | |
def prepare_distribution_metadata(self, finder, build_isolation): | |
# type: (PackageFinder, bool) -> None | |
# Load pyproject.toml, to determine whether PEP 517 is to be used | |
self.req.load_pyproject_toml() | |
# Set up the build isolation, if this requirement should be isolated | |
should_isolate = self.req.use_pep517 and build_isolation | |
if should_isolate: | |
self._setup_isolation(finder) | |
self.req.prepare_metadata() | |
def _setup_isolation(self, finder): | |
# type: (PackageFinder) -> None | |
def _raise_conflicts(conflicting_with, conflicting_reqs): | |
# type: (str, Set[Tuple[str, str]]) -> None | |
format_string = ( | |
"Some build dependencies for {requirement} " | |
"conflict with {conflicting_with}: {description}." | |
) | |
error_message = format_string.format( | |
requirement=self.req, | |
conflicting_with=conflicting_with, | |
description=', '.join( | |
'{} is incompatible with {}'.format(installed, wanted) | |
for installed, wanted in sorted(conflicting) | |
) | |
) | |
raise InstallationError(error_message) | |
# Isolate in a BuildEnvironment and install the build-time | |
# requirements. | |
pyproject_requires = self.req.pyproject_requires | |
assert pyproject_requires is not None | |
self.req.build_env = BuildEnvironment() | |
self.req.build_env.install_requirements( | |
finder, pyproject_requires, 'overlay', | |
"Installing build dependencies" | |
) | |
conflicting, missing = self.req.build_env.check_requirements( | |
self.req.requirements_to_check | |
) | |
if conflicting: | |
_raise_conflicts("PEP 517/518 supported requirements", | |
conflicting) | |
if missing: | |
logger.warning( | |
"Missing build requirements in pyproject.toml for %s.", | |
self.req, | |
) | |
logger.warning( | |
"The project does not specify a build backend, and " | |
"pip cannot fall back to setuptools without %s.", | |
" and ".join(map(repr, sorted(missing))) | |
) | |
# Install any extra build dependencies that the backend requests. | |
# This must be done in a second pass, as the pyproject.toml | |
# dependencies must be installed before we can call the backend. | |
with self.req.build_env: | |
runner = runner_with_spinner_message( | |
"Getting requirements to build wheel" | |
) | |
backend = self.req.pep517_backend | |
assert backend is not None | |
with backend.subprocess_runner(runner): | |
reqs = backend.get_requires_for_build_wheel() | |
conflicting, missing = self.req.build_env.check_requirements(reqs) | |
if conflicting: | |
_raise_conflicts("the backend dependencies", conflicting) | |
self.req.build_env.install_requirements( | |
finder, missing, 'normal', | |
"Installing backend dependencies" | |
) |
from zipfile import ZipFile | |
from pip._internal.distributions.base import AbstractDistribution | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.wheel import pkg_resources_distribution_for_wheel | |
if MYPY_CHECK_RUNNING: | |
from pip._vendor.pkg_resources import Distribution | |
from pip._internal.index.package_finder import PackageFinder | |
class WheelDistribution(AbstractDistribution): | |
"""Represents a wheel distribution. | |
This does not need any preparation as wheels can be directly unpacked. | |
""" | |
def get_pkg_resources_distribution(self): | |
# type: () -> Distribution | |
"""Loads the metadata from the wheel file into memory and returns a | |
Distribution that uses it, not relying on the wheel file or | |
requirement. | |
""" | |
# Set as part of preparation during download. | |
assert self.req.local_file_path | |
# Wheels are never unnamed. | |
assert self.req.name | |
with ZipFile(self.req.local_file_path, allowZip64=True) as z: | |
return pkg_resources_distribution_for_wheel( | |
z, self.req.name, self.req.local_file_path | |
) | |
def prepare_distribution_metadata(self, finder, build_isolation): | |
# type: (PackageFinder, bool) -> None | |
pass |
"""Exceptions used throughout package""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
from itertools import chain, groupby, repeat | |
from pip._vendor.six import iteritems | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional | |
from pip._vendor.pkg_resources import Distribution | |
from pip._internal.req.req_install import InstallRequirement | |
class PipError(Exception): | |
"""Base pip exception""" | |
class ConfigurationError(PipError): | |
"""General exception in configuration""" | |
class InstallationError(PipError): | |
"""General exception during installation""" | |
class UninstallationError(PipError): | |
"""General exception during uninstallation""" | |
class NoneMetadataError(PipError): | |
""" | |
Raised when accessing "METADATA" or "PKG-INFO" metadata for a | |
pip._vendor.pkg_resources.Distribution object and | |
`dist.has_metadata('METADATA')` returns True but | |
`dist.get_metadata('METADATA')` returns None (and similarly for | |
"PKG-INFO"). | |
""" | |
def __init__(self, dist, metadata_name): | |
# type: (Distribution, str) -> None | |
""" | |
:param dist: A Distribution object. | |
:param metadata_name: The name of the metadata being accessed | |
(can be "METADATA" or "PKG-INFO"). | |
""" | |
self.dist = dist | |
self.metadata_name = metadata_name | |
def __str__(self): | |
# type: () -> str | |
# Use `dist` in the error message because its stringification | |
# includes more information, like the version and location. | |
return ( | |
'None {} metadata found for distribution: {}'.format( | |
self.metadata_name, self.dist, | |
) | |
) | |
class DistributionNotFound(InstallationError): | |
"""Raised when a distribution cannot be found to satisfy a requirement""" | |
class RequirementsFileParseError(InstallationError): | |
"""Raised when a general error occurs parsing a requirements file line.""" | |
class BestVersionAlreadyInstalled(PipError): | |
"""Raised when the most up-to-date version of a package is already | |
installed.""" | |
class BadCommand(PipError): | |
"""Raised when virtualenv or a command is not found""" | |
class CommandError(PipError): | |
"""Raised when there is an error in command-line arguments""" | |
class PreviousBuildDirError(PipError): | |
"""Raised when there's a previous conflicting build directory""" | |
class InvalidWheelFilename(InstallationError): | |
"""Invalid wheel filename.""" | |
class UnsupportedWheel(InstallationError): | |
"""Unsupported wheel.""" | |
class HashErrors(InstallationError): | |
"""Multiple HashError instances rolled into one for reporting""" | |
def __init__(self): | |
self.errors = [] | |
def append(self, error): | |
self.errors.append(error) | |
def __str__(self): | |
lines = [] | |
self.errors.sort(key=lambda e: e.order) | |
for cls, errors_of_cls in groupby(self.errors, lambda e: e.__class__): | |
lines.append(cls.head) | |
lines.extend(e.body() for e in errors_of_cls) | |
if lines: | |
return '\n'.join(lines) | |
def __nonzero__(self): | |
return bool(self.errors) | |
def __bool__(self): | |
return self.__nonzero__() | |
class HashError(InstallationError): | |
""" | |
A failure to verify a package against known-good hashes | |
:cvar order: An int sorting hash exception classes by difficulty of | |
recovery (lower being harder), so the user doesn't bother fretting | |
about unpinned packages when he has deeper issues, like VCS | |
dependencies, to deal with. Also keeps error reports in a | |
deterministic order. | |
:cvar head: A section heading for display above potentially many | |
exceptions of this kind | |
:ivar req: The InstallRequirement that triggered this error. This is | |
pasted on after the exception is instantiated, because it's not | |
typically available earlier. | |
""" | |
req = None # type: Optional[InstallRequirement] | |
head = '' | |
def body(self): | |
"""Return a summary of me for display under the heading. | |
This default implementation simply prints a description of the | |
triggering requirement. | |
:param req: The InstallRequirement that provoked this error, with | |
its link already populated by the resolver's _populate_link(). | |
""" | |
return ' {}'.format(self._requirement_name()) | |
def __str__(self): | |
return '{}\n{}'.format(self.head, self.body()) | |
def _requirement_name(self): | |
"""Return a description of the requirement that triggered me. | |
This default implementation returns long description of the req, with | |
line numbers | |
""" | |
return str(self.req) if self.req else 'unknown package' | |
class VcsHashUnsupported(HashError): | |
"""A hash was provided for a version-control-system-based requirement, but | |
we don't have a method for hashing those.""" | |
order = 0 | |
head = ("Can't verify hashes for these requirements because we don't " | |
"have a way to hash version control repositories:") | |
class DirectoryUrlHashUnsupported(HashError): | |
"""A hash was provided for a version-control-system-based requirement, but | |
we don't have a method for hashing those.""" | |
order = 1 | |
head = ("Can't verify hashes for these file:// requirements because they " | |
"point to directories:") | |
class HashMissing(HashError): | |
"""A hash was needed for a requirement but is absent.""" | |
order = 2 | |
head = ('Hashes are required in --require-hashes mode, but they are ' | |
'missing from some requirements. Here is a list of those ' | |
'requirements along with the hashes their downloaded archives ' | |
'actually had. Add lines like these to your requirements files to ' | |
'prevent tampering. (If you did not enable --require-hashes ' | |
'manually, note that it turns on automatically when any package ' | |
'has a hash.)') | |
def __init__(self, gotten_hash): | |
""" | |
:param gotten_hash: The hash of the (possibly malicious) archive we | |
just downloaded | |
""" | |
self.gotten_hash = gotten_hash | |
def body(self): | |
# Dodge circular import. | |
from pip._internal.utils.hashes import FAVORITE_HASH | |
package = None | |
if self.req: | |
# In the case of URL-based requirements, display the original URL | |
# seen in the requirements file rather than the package name, | |
# so the output can be directly copied into the requirements file. | |
package = (self.req.original_link if self.req.original_link | |
# In case someone feeds something downright stupid | |
# to InstallRequirement's constructor. | |
else getattr(self.req, 'req', None)) | |
return ' {} --hash={}:{}'.format(package or 'unknown package', | |
FAVORITE_HASH, | |
self.gotten_hash) | |
class HashUnpinned(HashError): | |
"""A requirement had a hash specified but was not pinned to a specific | |
version.""" | |
order = 3 | |
head = ('In --require-hashes mode, all requirements must have their ' | |
'versions pinned with ==. These do not:') | |
class HashMismatch(HashError): | |
""" | |
Distribution file hash values don't match. | |
:ivar package_name: The name of the package that triggered the hash | |
mismatch. Feel free to write to this after the exception is raise to | |
improve its error message. | |
""" | |
order = 4 | |
head = ('THESE PACKAGES DO NOT MATCH THE HASHES FROM THE REQUIREMENTS ' | |
'FILE. If you have updated the package versions, please update ' | |
'the hashes. Otherwise, examine the package contents carefully; ' | |
'someone may have tampered with them.') | |
def __init__(self, allowed, gots): | |
""" | |
:param allowed: A dict of algorithm names pointing to lists of allowed | |
hex digests | |
:param gots: A dict of algorithm names pointing to hashes we | |
actually got from the files under suspicion | |
""" | |
self.allowed = allowed | |
self.gots = gots | |
def body(self): | |
return ' {}:\n{}'.format(self._requirement_name(), | |
self._hash_comparison()) | |
def _hash_comparison(self): | |
""" | |
Return a comparison of actual and expected hash values. | |
Example:: | |
Expected sha256 abcdeabcdeabcdeabcdeabcdeabcdeabcdeabcdeabcde | |
or 123451234512345123451234512345123451234512345 | |
Got bcdefbcdefbcdefbcdefbcdefbcdefbcdefbcdefbcdef | |
""" | |
def hash_then_or(hash_name): | |
# For now, all the decent hashes have 6-char names, so we can get | |
# away with hard-coding space literals. | |
return chain([hash_name], repeat(' or')) | |
lines = [] | |
for hash_name, expecteds in iteritems(self.allowed): | |
prefix = hash_then_or(hash_name) | |
lines.extend((' Expected {} {}'.format(next(prefix), e)) | |
for e in expecteds) | |
lines.append(' Got {}\n'.format( | |
self.gots[hash_name].hexdigest())) | |
return '\n'.join(lines) | |
class UnsupportedPythonVersion(InstallationError): | |
"""Unsupported python version according to Requires-Python package | |
metadata.""" | |
class ConfigurationFileCouldNotBeLoaded(ConfigurationError): | |
"""When there are errors while loading a configuration file | |
""" | |
def __init__(self, reason="could not be loaded", fname=None, error=None): | |
super(ConfigurationFileCouldNotBeLoaded, self).__init__(error) | |
self.reason = reason | |
self.fname = fname | |
self.error = error | |
def __str__(self): | |
if self.fname is not None: | |
message_part = " in {}.".format(self.fname) | |
else: | |
assert self.error is not None | |
message_part = ".\n{}\n".format(self.error.message) | |
return "Configuration file {}{}".format(self.reason, message_part) |
"""Index interaction code | |
""" |
""" | |
The main purpose of this module is to expose LinkCollector.collect_links(). | |
""" | |
import cgi | |
import functools | |
import itertools | |
import logging | |
import mimetypes | |
import os | |
import re | |
from collections import OrderedDict | |
from pip._vendor import html5lib, requests | |
from pip._vendor.distlib.compat import unescape | |
from pip._vendor.requests.exceptions import HTTPError, RetryError, SSLError | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._vendor.six.moves.urllib import request as urllib_request | |
from pip._internal.models.link import Link | |
from pip._internal.utils.filetypes import ARCHIVE_EXTENSIONS | |
from pip._internal.utils.misc import pairwise, redact_auth_from_url | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import path_to_url, url_to_path | |
from pip._internal.vcs import is_url, vcs | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Callable, Iterable, List, MutableMapping, Optional, | |
Protocol, Sequence, Tuple, TypeVar, Union, | |
) | |
import xml.etree.ElementTree | |
from pip._vendor.requests import Response | |
from pip._internal.models.search_scope import SearchScope | |
from pip._internal.network.session import PipSession | |
HTMLElement = xml.etree.ElementTree.Element | |
ResponseHeaders = MutableMapping[str, str] | |
# Used in the @lru_cache polyfill. | |
F = TypeVar('F') | |
class LruCache(Protocol): | |
def __call__(self, maxsize=None): | |
# type: (Optional[int]) -> Callable[[F], F] | |
raise NotImplementedError | |
logger = logging.getLogger(__name__) | |
# Fallback to noop_lru_cache in Python 2 | |
# TODO: this can be removed when python 2 support is dropped! | |
def noop_lru_cache(maxsize=None): | |
# type: (Optional[int]) -> Callable[[F], F] | |
def _wrapper(f): | |
# type: (F) -> F | |
return f | |
return _wrapper | |
_lru_cache = getattr(functools, "lru_cache", noop_lru_cache) # type: LruCache | |
def _match_vcs_scheme(url): | |
# type: (str) -> Optional[str] | |
"""Look for VCS schemes in the URL. | |
Returns the matched VCS scheme, or None if there's no match. | |
""" | |
for scheme in vcs.schemes: | |
if url.lower().startswith(scheme) and url[len(scheme)] in '+:': | |
return scheme | |
return None | |
def _is_url_like_archive(url): | |
# type: (str) -> bool | |
"""Return whether the URL looks like an archive. | |
""" | |
filename = Link(url).filename | |
for bad_ext in ARCHIVE_EXTENSIONS: | |
if filename.endswith(bad_ext): | |
return True | |
return False | |
class _NotHTML(Exception): | |
def __init__(self, content_type, request_desc): | |
# type: (str, str) -> None | |
super(_NotHTML, self).__init__(content_type, request_desc) | |
self.content_type = content_type | |
self.request_desc = request_desc | |
def _ensure_html_header(response): | |
# type: (Response) -> None | |
"""Check the Content-Type header to ensure the response contains HTML. | |
Raises `_NotHTML` if the content type is not text/html. | |
""" | |
content_type = response.headers.get("Content-Type", "") | |
if not content_type.lower().startswith("text/html"): | |
raise _NotHTML(content_type, response.request.method) | |
class _NotHTTP(Exception): | |
pass | |
def _ensure_html_response(url, session): | |
# type: (str, PipSession) -> None | |
"""Send a HEAD request to the URL, and ensure the response contains HTML. | |
Raises `_NotHTTP` if the URL is not available for a HEAD request, or | |
`_NotHTML` if the content type is not text/html. | |
""" | |
scheme, netloc, path, query, fragment = urllib_parse.urlsplit(url) | |
if scheme not in {'http', 'https'}: | |
raise _NotHTTP() | |
resp = session.head(url, allow_redirects=True) | |
resp.raise_for_status() | |
_ensure_html_header(resp) | |
def _get_html_response(url, session): | |
# type: (str, PipSession) -> Response | |
"""Access an HTML page with GET, and return the response. | |
This consists of three parts: | |
1. If the URL looks suspiciously like an archive, send a HEAD first to | |
check the Content-Type is HTML, to avoid downloading a large file. | |
Raise `_NotHTTP` if the content type cannot be determined, or | |
`_NotHTML` if it is not HTML. | |
2. Actually perform the request. Raise HTTP exceptions on network failures. | |
3. Check the Content-Type header to make sure we got HTML, and raise | |
`_NotHTML` otherwise. | |
""" | |
if _is_url_like_archive(url): | |
_ensure_html_response(url, session=session) | |
logger.debug('Getting page %s', redact_auth_from_url(url)) | |
resp = session.get( | |
url, | |
headers={ | |
"Accept": "text/html", | |
# We don't want to blindly returned cached data for | |
# /simple/, because authors generally expecting that | |
# twine upload && pip install will function, but if | |
# they've done a pip install in the last ~10 minutes | |
# it won't. Thus by setting this to zero we will not | |
# blindly use any cached data, however the benefit of | |
# using max-age=0 instead of no-cache, is that we will | |
# still support conditional requests, so we will still | |
# minimize traffic sent in cases where the page hasn't | |
# changed at all, we will just always incur the round | |
# trip for the conditional GET now instead of only | |
# once per 10 minutes. | |
# For more information, please see pypa/pip#5670. | |
"Cache-Control": "max-age=0", | |
}, | |
) | |
resp.raise_for_status() | |
# The check for archives above only works if the url ends with | |
# something that looks like an archive. However that is not a | |
# requirement of an url. Unless we issue a HEAD request on every | |
# url we cannot know ahead of time for sure if something is HTML | |
# or not. However we can check after we've downloaded it. | |
_ensure_html_header(resp) | |
return resp | |
def _get_encoding_from_headers(headers): | |
# type: (ResponseHeaders) -> Optional[str] | |
"""Determine if we have any encoding information in our headers. | |
""" | |
if headers and "Content-Type" in headers: | |
content_type, params = cgi.parse_header(headers["Content-Type"]) | |
if "charset" in params: | |
return params['charset'] | |
return None | |
def _determine_base_url(document, page_url): | |
# type: (HTMLElement, str) -> str | |
"""Determine the HTML document's base URL. | |
This looks for a ``<base>`` tag in the HTML document. If present, its href | |
attribute denotes the base URL of anchor tags in the document. If there is | |
no such tag (or if it does not have a valid href attribute), the HTML | |
file's URL is used as the base URL. | |
:param document: An HTML document representation. The current | |
implementation expects the result of ``html5lib.parse()``. | |
:param page_url: The URL of the HTML document. | |
""" | |
for base in document.findall(".//base"): | |
href = base.get("href") | |
if href is not None: | |
return href | |
return page_url | |
def _clean_url_path_part(part): | |
# type: (str) -> str | |
""" | |
Clean a "part" of a URL path (i.e. after splitting on "@" characters). | |
""" | |
# We unquote prior to quoting to make sure nothing is double quoted. | |
return urllib_parse.quote(urllib_parse.unquote(part)) | |
def _clean_file_url_path(part): | |
# type: (str) -> str | |
""" | |
Clean the first part of a URL path that corresponds to a local | |
filesystem path (i.e. the first part after splitting on "@" characters). | |
""" | |
# We unquote prior to quoting to make sure nothing is double quoted. | |
# Also, on Windows the path part might contain a drive letter which | |
# should not be quoted. On Linux where drive letters do not | |
# exist, the colon should be quoted. We rely on urllib.request | |
# to do the right thing here. | |
return urllib_request.pathname2url(urllib_request.url2pathname(part)) | |
# percent-encoded: / | |
_reserved_chars_re = re.compile('(@|%2F)', re.IGNORECASE) | |
def _clean_url_path(path, is_local_path): | |
# type: (str, bool) -> str | |
""" | |
Clean the path portion of a URL. | |
""" | |
if is_local_path: | |
clean_func = _clean_file_url_path | |
else: | |
clean_func = _clean_url_path_part | |
# Split on the reserved characters prior to cleaning so that | |
# revision strings in VCS URLs are properly preserved. | |
parts = _reserved_chars_re.split(path) | |
cleaned_parts = [] | |
for to_clean, reserved in pairwise(itertools.chain(parts, [''])): | |
cleaned_parts.append(clean_func(to_clean)) | |
# Normalize %xx escapes (e.g. %2f -> %2F) | |
cleaned_parts.append(reserved.upper()) | |
return ''.join(cleaned_parts) | |
def _clean_link(url): | |
# type: (str) -> str | |
""" | |
Make sure a link is fully quoted. | |
For example, if ' ' occurs in the URL, it will be replaced with "%20", | |
and without double-quoting other characters. | |
""" | |
# Split the URL into parts according to the general structure | |
# `scheme://netloc/path;parameters?query#fragment`. | |
result = urllib_parse.urlparse(url) | |
# If the netloc is empty, then the URL refers to a local filesystem path. | |
is_local_path = not result.netloc | |
path = _clean_url_path(result.path, is_local_path=is_local_path) | |
return urllib_parse.urlunparse(result._replace(path=path)) | |
def _create_link_from_element( | |
anchor, # type: HTMLElement | |
page_url, # type: str | |
base_url, # type: str | |
): | |
# type: (...) -> Optional[Link] | |
""" | |
Convert an anchor element in a simple repository page to a Link. | |
""" | |
href = anchor.get("href") | |
if not href: | |
return None | |
url = _clean_link(urllib_parse.urljoin(base_url, href)) | |
pyrequire = anchor.get('data-requires-python') | |
pyrequire = unescape(pyrequire) if pyrequire else None | |
yanked_reason = anchor.get('data-yanked') | |
if yanked_reason: | |
# This is a unicode string in Python 2 (and 3). | |
yanked_reason = unescape(yanked_reason) | |
link = Link( | |
url, | |
comes_from=page_url, | |
requires_python=pyrequire, | |
yanked_reason=yanked_reason, | |
) | |
return link | |
class CacheablePageContent(object): | |
def __init__(self, page): | |
# type: (HTMLPage) -> None | |
assert page.cache_link_parsing | |
self.page = page | |
def __eq__(self, other): | |
# type: (object) -> bool | |
return (isinstance(other, type(self)) and | |
self.page.url == other.page.url) | |
def __hash__(self): | |
# type: () -> int | |
return hash(self.page.url) | |
def with_cached_html_pages( | |
fn, # type: Callable[[HTMLPage], Iterable[Link]] | |
): | |
# type: (...) -> Callable[[HTMLPage], List[Link]] | |
""" | |
Given a function that parses an Iterable[Link] from an HTMLPage, cache the | |
function's result (keyed by CacheablePageContent), unless the HTMLPage | |
`page` has `page.cache_link_parsing == False`. | |
""" | |
@_lru_cache(maxsize=None) | |
def wrapper(cacheable_page): | |
# type: (CacheablePageContent) -> List[Link] | |
return list(fn(cacheable_page.page)) | |
@functools.wraps(fn) | |
def wrapper_wrapper(page): | |
# type: (HTMLPage) -> List[Link] | |
if page.cache_link_parsing: | |
return wrapper(CacheablePageContent(page)) | |
return list(fn(page)) | |
return wrapper_wrapper | |
@with_cached_html_pages | |
def parse_links(page): | |
# type: (HTMLPage) -> Iterable[Link] | |
""" | |
Parse an HTML document, and yield its anchor elements as Link objects. | |
""" | |
document = html5lib.parse( | |
page.content, | |
transport_encoding=page.encoding, | |
namespaceHTMLElements=False, | |
) | |
url = page.url | |
base_url = _determine_base_url(document, url) | |
for anchor in document.findall(".//a"): | |
link = _create_link_from_element( | |
anchor, | |
page_url=url, | |
base_url=base_url, | |
) | |
if link is None: | |
continue | |
yield link | |
class HTMLPage(object): | |
"""Represents one page, along with its URL""" | |
def __init__( | |
self, | |
content, # type: bytes | |
encoding, # type: Optional[str] | |
url, # type: str | |
cache_link_parsing=True, # type: bool | |
): | |
# type: (...) -> None | |
""" | |
:param encoding: the encoding to decode the given content. | |
:param url: the URL from which the HTML was downloaded. | |
:param cache_link_parsing: whether links parsed from this page's url | |
should be cached. PyPI index urls should | |
have this set to False, for example. | |
""" | |
self.content = content | |
self.encoding = encoding | |
self.url = url | |
self.cache_link_parsing = cache_link_parsing | |
def __str__(self): | |
# type: () -> str | |
return redact_auth_from_url(self.url) | |
def _handle_get_page_fail( | |
link, # type: Link | |
reason, # type: Union[str, Exception] | |
meth=None # type: Optional[Callable[..., None]] | |
): | |
# type: (...) -> None | |
if meth is None: | |
meth = logger.debug | |
meth("Could not fetch URL %s: %s - skipping", link, reason) | |
def _make_html_page(response, cache_link_parsing=True): | |
# type: (Response, bool) -> HTMLPage | |
encoding = _get_encoding_from_headers(response.headers) | |
return HTMLPage( | |
response.content, | |
encoding=encoding, | |
url=response.url, | |
cache_link_parsing=cache_link_parsing) | |
def _get_html_page(link, session=None): | |
# type: (Link, Optional[PipSession]) -> Optional[HTMLPage] | |
if session is None: | |
raise TypeError( | |
"_get_html_page() missing 1 required keyword argument: 'session'" | |
) | |
url = link.url.split('#', 1)[0] | |
# Check for VCS schemes that do not support lookup as web pages. | |
vcs_scheme = _match_vcs_scheme(url) | |
if vcs_scheme: | |
logger.debug('Cannot look at %s URL %s', vcs_scheme, link) | |
return None | |
# Tack index.html onto file:// URLs that point to directories | |
scheme, _, path, _, _, _ = urllib_parse.urlparse(url) | |
if (scheme == 'file' and os.path.isdir(urllib_request.url2pathname(path))): | |
# add trailing slash if not present so urljoin doesn't trim | |
# final segment | |
if not url.endswith('/'): | |
url += '/' | |
url = urllib_parse.urljoin(url, 'index.html') | |
logger.debug(' file: URL is directory, getting %s', url) | |
try: | |
resp = _get_html_response(url, session=session) | |
except _NotHTTP: | |
logger.debug( | |
'Skipping page %s because it looks like an archive, and cannot ' | |
'be checked by HEAD.', link, | |
) | |
except _NotHTML as exc: | |
logger.debug( | |
'Skipping page %s because the %s request got Content-Type: %s', | |
link, exc.request_desc, exc.content_type, | |
) | |
except HTTPError as exc: | |
_handle_get_page_fail(link, exc) | |
except RetryError as exc: | |
_handle_get_page_fail(link, exc) | |
except SSLError as exc: | |
reason = "There was a problem confirming the ssl certificate: " | |
reason += str(exc) | |
_handle_get_page_fail(link, reason, meth=logger.info) | |
except requests.ConnectionError as exc: | |
_handle_get_page_fail(link, "connection error: {}".format(exc)) | |
except requests.Timeout: | |
_handle_get_page_fail(link, "timed out") | |
else: | |
return _make_html_page(resp, | |
cache_link_parsing=link.cache_link_parsing) | |
return None | |
def _remove_duplicate_links(links): | |
# type: (Iterable[Link]) -> List[Link] | |
""" | |
Return a list of links, with duplicates removed and ordering preserved. | |
""" | |
# We preserve the ordering when removing duplicates because we can. | |
return list(OrderedDict.fromkeys(links)) | |
def group_locations(locations, expand_dir=False): | |
# type: (Sequence[str], bool) -> Tuple[List[str], List[str]] | |
""" | |
Divide a list of locations into two groups: "files" (archives) and "urls." | |
:return: A pair of lists (files, urls). | |
""" | |
files = [] | |
urls = [] | |
# puts the url for the given file path into the appropriate list | |
def sort_path(path): | |
# type: (str) -> None | |
url = path_to_url(path) | |
if mimetypes.guess_type(url, strict=False)[0] == 'text/html': | |
urls.append(url) | |
else: | |
files.append(url) | |
for url in locations: | |
is_local_path = os.path.exists(url) | |
is_file_url = url.startswith('file:') | |
if is_local_path or is_file_url: | |
if is_local_path: | |
path = url | |
else: | |
path = url_to_path(url) | |
if os.path.isdir(path): | |
if expand_dir: | |
path = os.path.realpath(path) | |
for item in os.listdir(path): | |
sort_path(os.path.join(path, item)) | |
elif is_file_url: | |
urls.append(url) | |
else: | |
logger.warning( | |
"Path '{0}' is ignored: " | |
"it is a directory.".format(path), | |
) | |
elif os.path.isfile(path): | |
sort_path(path) | |
else: | |
logger.warning( | |
"Url '%s' is ignored: it is neither a file " | |
"nor a directory.", url, | |
) | |
elif is_url(url): | |
# Only add url with clear scheme | |
urls.append(url) | |
else: | |
logger.warning( | |
"Url '%s' is ignored. It is either a non-existing " | |
"path or lacks a specific scheme.", url, | |
) | |
return files, urls | |
class CollectedLinks(object): | |
""" | |
Encapsulates the return value of a call to LinkCollector.collect_links(). | |
The return value includes both URLs to project pages containing package | |
links, as well as individual package Link objects collected from other | |
sources. | |
This info is stored separately as: | |
(1) links from the configured file locations, | |
(2) links from the configured find_links, and | |
(3) urls to HTML project pages, as described by the PEP 503 simple | |
repository API. | |
""" | |
def __init__( | |
self, | |
files, # type: List[Link] | |
find_links, # type: List[Link] | |
project_urls, # type: List[Link] | |
): | |
# type: (...) -> None | |
""" | |
:param files: Links from file locations. | |
:param find_links: Links from find_links. | |
:param project_urls: URLs to HTML project pages, as described by | |
the PEP 503 simple repository API. | |
""" | |
self.files = files | |
self.find_links = find_links | |
self.project_urls = project_urls | |
class LinkCollector(object): | |
""" | |
Responsible for collecting Link objects from all configured locations, | |
making network requests as needed. | |
The class's main method is its collect_links() method. | |
""" | |
def __init__( | |
self, | |
session, # type: PipSession | |
search_scope, # type: SearchScope | |
): | |
# type: (...) -> None | |
self.search_scope = search_scope | |
self.session = session | |
@property | |
def find_links(self): | |
# type: () -> List[str] | |
return self.search_scope.find_links | |
def fetch_page(self, location): | |
# type: (Link) -> Optional[HTMLPage] | |
""" | |
Fetch an HTML page containing package links. | |
""" | |
return _get_html_page(location, session=self.session) | |
def collect_links(self, project_name): | |
# type: (str) -> CollectedLinks | |
"""Find all available links for the given project name. | |
:return: All the Link objects (unfiltered), as a CollectedLinks object. | |
""" | |
search_scope = self.search_scope | |
index_locations = search_scope.get_index_urls_locations(project_name) | |
index_file_loc, index_url_loc = group_locations(index_locations) | |
fl_file_loc, fl_url_loc = group_locations( | |
self.find_links, expand_dir=True, | |
) | |
file_links = [ | |
Link(url) for url in itertools.chain(index_file_loc, fl_file_loc) | |
] | |
# We trust every directly linked archive in find_links | |
find_link_links = [Link(url, '-f') for url in self.find_links] | |
# We trust every url that the user has given us whether it was given | |
# via --index-url or --find-links. | |
# We want to filter out anything that does not have a secure origin. | |
url_locations = [ | |
link for link in itertools.chain( | |
# Mark PyPI indices as "cache_link_parsing == False" -- this | |
# will avoid caching the result of parsing the page for links. | |
(Link(url, cache_link_parsing=False) for url in index_url_loc), | |
(Link(url) for url in fl_url_loc), | |
) | |
if self.session.is_secure_origin(link) | |
] | |
url_locations = _remove_duplicate_links(url_locations) | |
lines = [ | |
'{} location(s) to search for versions of {}:'.format( | |
len(url_locations), project_name, | |
), | |
] | |
for link in url_locations: | |
lines.append('* {}'.format(link)) | |
logger.debug('\n'.join(lines)) | |
return CollectedLinks( | |
files=file_links, | |
find_links=find_link_links, | |
project_urls=url_locations, | |
) |
"""Routines related to PyPI, indexes""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import logging | |
import re | |
from pip._vendor.packaging import specifiers | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.packaging.version import parse as parse_version | |
from pip._internal.exceptions import ( | |
BestVersionAlreadyInstalled, | |
DistributionNotFound, | |
InvalidWheelFilename, | |
UnsupportedWheel, | |
) | |
from pip._internal.index.collector import parse_links | |
from pip._internal.models.candidate import InstallationCandidate | |
from pip._internal.models.format_control import FormatControl | |
from pip._internal.models.link import Link | |
from pip._internal.models.selection_prefs import SelectionPreferences | |
from pip._internal.models.target_python import TargetPython | |
from pip._internal.models.wheel import Wheel | |
from pip._internal.utils.filetypes import WHEEL_EXTENSION | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import build_netloc | |
from pip._internal.utils.packaging import check_requires_python | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.unpacking import SUPPORTED_EXTENSIONS | |
from pip._internal.utils.urls import url_to_path | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
FrozenSet, Iterable, List, Optional, Set, Text, Tuple, Union, | |
) | |
from pip._vendor.packaging.tags import Tag | |
from pip._vendor.packaging.version import _BaseVersion | |
from pip._internal.index.collector import LinkCollector | |
from pip._internal.models.search_scope import SearchScope | |
from pip._internal.req import InstallRequirement | |
from pip._internal.utils.hashes import Hashes | |
BuildTag = Union[Tuple[()], Tuple[int, str]] | |
CandidateSortingKey = ( | |
Tuple[int, int, int, _BaseVersion, BuildTag, Optional[int]] | |
) | |
__all__ = ['FormatControl', 'BestCandidateResult', 'PackageFinder'] | |
logger = logging.getLogger(__name__) | |
def _check_link_requires_python( | |
link, # type: Link | |
version_info, # type: Tuple[int, int, int] | |
ignore_requires_python=False, # type: bool | |
): | |
# type: (...) -> bool | |
""" | |
Return whether the given Python version is compatible with a link's | |
"Requires-Python" value. | |
:param version_info: A 3-tuple of ints representing the Python | |
major-minor-micro version to check. | |
:param ignore_requires_python: Whether to ignore the "Requires-Python" | |
value if the given Python version isn't compatible. | |
""" | |
try: | |
is_compatible = check_requires_python( | |
link.requires_python, version_info=version_info, | |
) | |
except specifiers.InvalidSpecifier: | |
logger.debug( | |
"Ignoring invalid Requires-Python (%r) for link: %s", | |
link.requires_python, link, | |
) | |
else: | |
if not is_compatible: | |
version = '.'.join(map(str, version_info)) | |
if not ignore_requires_python: | |
logger.debug( | |
'Link requires a different Python (%s not in: %r): %s', | |
version, link.requires_python, link, | |
) | |
return False | |
logger.debug( | |
'Ignoring failed Requires-Python check (%s not in: %r) ' | |
'for link: %s', | |
version, link.requires_python, link, | |
) | |
return True | |
class LinkEvaluator(object): | |
""" | |
Responsible for evaluating links for a particular project. | |
""" | |
_py_version_re = re.compile(r'-py([123]\.?[0-9]?)$') | |
# Don't include an allow_yanked default value to make sure each call | |
# site considers whether yanked releases are allowed. This also causes | |
# that decision to be made explicit in the calling code, which helps | |
# people when reading the code. | |
def __init__( | |
self, | |
project_name, # type: str | |
canonical_name, # type: str | |
formats, # type: FrozenSet[str] | |
target_python, # type: TargetPython | |
allow_yanked, # type: bool | |
ignore_requires_python=None, # type: Optional[bool] | |
): | |
# type: (...) -> None | |
""" | |
:param project_name: The user supplied package name. | |
:param canonical_name: The canonical package name. | |
:param formats: The formats allowed for this package. Should be a set | |
with 'binary' or 'source' or both in it. | |
:param target_python: The target Python interpreter to use when | |
evaluating link compatibility. This is used, for example, to | |
check wheel compatibility, as well as when checking the Python | |
version, e.g. the Python version embedded in a link filename | |
(or egg fragment) and against an HTML link's optional PEP 503 | |
"data-requires-python" attribute. | |
:param allow_yanked: Whether files marked as yanked (in the sense | |
of PEP 592) are permitted to be candidates for install. | |
:param ignore_requires_python: Whether to ignore incompatible | |
PEP 503 "data-requires-python" values in HTML links. Defaults | |
to False. | |
""" | |
if ignore_requires_python is None: | |
ignore_requires_python = False | |
self._allow_yanked = allow_yanked | |
self._canonical_name = canonical_name | |
self._ignore_requires_python = ignore_requires_python | |
self._formats = formats | |
self._target_python = target_python | |
self.project_name = project_name | |
def evaluate_link(self, link): | |
# type: (Link) -> Tuple[bool, Optional[Text]] | |
""" | |
Determine whether a link is a candidate for installation. | |
:return: A tuple (is_candidate, result), where `result` is (1) a | |
version string if `is_candidate` is True, and (2) if | |
`is_candidate` is False, an optional string to log the reason | |
the link fails to qualify. | |
""" | |
version = None | |
if link.is_yanked and not self._allow_yanked: | |
reason = link.yanked_reason or '<none given>' | |
# Mark this as a unicode string to prevent "UnicodeEncodeError: | |
# 'ascii' codec can't encode character" in Python 2 when | |
# the reason contains non-ascii characters. | |
return (False, u'yanked for reason: {}'.format(reason)) | |
if link.egg_fragment: | |
egg_info = link.egg_fragment | |
ext = link.ext | |
else: | |
egg_info, ext = link.splitext() | |
if not ext: | |
return (False, 'not a file') | |
if ext not in SUPPORTED_EXTENSIONS: | |
return (False, 'unsupported archive format: {}'.format(ext)) | |
if "binary" not in self._formats and ext == WHEEL_EXTENSION: | |
reason = 'No binaries permitted for {}'.format( | |
self.project_name) | |
return (False, reason) | |
if "macosx10" in link.path and ext == '.zip': | |
return (False, 'macosx10 one') | |
if ext == WHEEL_EXTENSION: | |
try: | |
wheel = Wheel(link.filename) | |
except InvalidWheelFilename: | |
return (False, 'invalid wheel filename') | |
if canonicalize_name(wheel.name) != self._canonical_name: | |
reason = 'wrong project name (not {})'.format( | |
self.project_name) | |
return (False, reason) | |
supported_tags = self._target_python.get_tags() | |
if not wheel.supported(supported_tags): | |
# Include the wheel's tags in the reason string to | |
# simplify troubleshooting compatibility issues. | |
file_tags = wheel.get_formatted_file_tags() | |
reason = ( | |
"none of the wheel's tags match: {}".format( | |
', '.join(file_tags) | |
) | |
) | |
return (False, reason) | |
version = wheel.version | |
# This should be up by the self.ok_binary check, but see issue 2700. | |
if "source" not in self._formats and ext != WHEEL_EXTENSION: | |
reason = 'No sources permitted for {}'.format(self.project_name) | |
return (False, reason) | |
if not version: | |
version = _extract_version_from_fragment( | |
egg_info, self._canonical_name, | |
) | |
if not version: | |
reason = 'Missing project version for {}'.format(self.project_name) | |
return (False, reason) | |
match = self._py_version_re.search(version) | |
if match: | |
version = version[:match.start()] | |
py_version = match.group(1) | |
if py_version != self._target_python.py_version: | |
return (False, 'Python version is incorrect') | |
supports_python = _check_link_requires_python( | |
link, version_info=self._target_python.py_version_info, | |
ignore_requires_python=self._ignore_requires_python, | |
) | |
if not supports_python: | |
# Return None for the reason text to suppress calling | |
# _log_skipped_link(). | |
return (False, None) | |
logger.debug('Found link %s, version: %s', link, version) | |
return (True, version) | |
def filter_unallowed_hashes( | |
candidates, # type: List[InstallationCandidate] | |
hashes, # type: Hashes | |
project_name, # type: str | |
): | |
# type: (...) -> List[InstallationCandidate] | |
""" | |
Filter out candidates whose hashes aren't allowed, and return a new | |
list of candidates. | |
If at least one candidate has an allowed hash, then all candidates with | |
either an allowed hash or no hash specified are returned. Otherwise, | |
the given candidates are returned. | |
Including the candidates with no hash specified when there is a match | |
allows a warning to be logged if there is a more preferred candidate | |
with no hash specified. Returning all candidates in the case of no | |
matches lets pip report the hash of the candidate that would otherwise | |
have been installed (e.g. permitting the user to more easily update | |
their requirements file with the desired hash). | |
""" | |
if not hashes: | |
logger.debug( | |
'Given no hashes to check %s links for project %r: ' | |
'discarding no candidates', | |
len(candidates), | |
project_name, | |
) | |
# Make sure we're not returning back the given value. | |
return list(candidates) | |
matches_or_no_digest = [] | |
# Collect the non-matches for logging purposes. | |
non_matches = [] | |
match_count = 0 | |
for candidate in candidates: | |
link = candidate.link | |
if not link.has_hash: | |
pass | |
elif link.is_hash_allowed(hashes=hashes): | |
match_count += 1 | |
else: | |
non_matches.append(candidate) | |
continue | |
matches_or_no_digest.append(candidate) | |
if match_count: | |
filtered = matches_or_no_digest | |
else: | |
# Make sure we're not returning back the given value. | |
filtered = list(candidates) | |
if len(filtered) == len(candidates): | |
discard_message = 'discarding no candidates' | |
else: | |
discard_message = 'discarding {} non-matches:\n {}'.format( | |
len(non_matches), | |
'\n '.join(str(candidate.link) for candidate in non_matches) | |
) | |
logger.debug( | |
'Checked %s links for project %r against %s hashes ' | |
'(%s matches, %s no digest): %s', | |
len(candidates), | |
project_name, | |
hashes.digest_count, | |
match_count, | |
len(matches_or_no_digest) - match_count, | |
discard_message | |
) | |
return filtered | |
class CandidatePreferences(object): | |
""" | |
Encapsulates some of the preferences for filtering and sorting | |
InstallationCandidate objects. | |
""" | |
def __init__( | |
self, | |
prefer_binary=False, # type: bool | |
allow_all_prereleases=False, # type: bool | |
): | |
# type: (...) -> None | |
""" | |
:param allow_all_prereleases: Whether to allow all pre-releases. | |
""" | |
self.allow_all_prereleases = allow_all_prereleases | |
self.prefer_binary = prefer_binary | |
class BestCandidateResult(object): | |
"""A collection of candidates, returned by `PackageFinder.find_best_candidate`. | |
This class is only intended to be instantiated by CandidateEvaluator's | |
`compute_best_candidate()` method. | |
""" | |
def __init__( | |
self, | |
candidates, # type: List[InstallationCandidate] | |
applicable_candidates, # type: List[InstallationCandidate] | |
best_candidate, # type: Optional[InstallationCandidate] | |
): | |
# type: (...) -> None | |
""" | |
:param candidates: A sequence of all available candidates found. | |
:param applicable_candidates: The applicable candidates. | |
:param best_candidate: The most preferred candidate found, or None | |
if no applicable candidates were found. | |
""" | |
assert set(applicable_candidates) <= set(candidates) | |
if best_candidate is None: | |
assert not applicable_candidates | |
else: | |
assert best_candidate in applicable_candidates | |
self._applicable_candidates = applicable_candidates | |
self._candidates = candidates | |
self.best_candidate = best_candidate | |
def iter_all(self): | |
# type: () -> Iterable[InstallationCandidate] | |
"""Iterate through all candidates. | |
""" | |
return iter(self._candidates) | |
def iter_applicable(self): | |
# type: () -> Iterable[InstallationCandidate] | |
"""Iterate through the applicable candidates. | |
""" | |
return iter(self._applicable_candidates) | |
class CandidateEvaluator(object): | |
""" | |
Responsible for filtering and sorting candidates for installation based | |
on what tags are valid. | |
""" | |
@classmethod | |
def create( | |
cls, | |
project_name, # type: str | |
target_python=None, # type: Optional[TargetPython] | |
prefer_binary=False, # type: bool | |
allow_all_prereleases=False, # type: bool | |
specifier=None, # type: Optional[specifiers.BaseSpecifier] | |
hashes=None, # type: Optional[Hashes] | |
): | |
# type: (...) -> CandidateEvaluator | |
"""Create a CandidateEvaluator object. | |
:param target_python: The target Python interpreter to use when | |
checking compatibility. If None (the default), a TargetPython | |
object will be constructed from the running Python. | |
:param specifier: An optional object implementing `filter` | |
(e.g. `packaging.specifiers.SpecifierSet`) to filter applicable | |
versions. | |
:param hashes: An optional collection of allowed hashes. | |
""" | |
if target_python is None: | |
target_python = TargetPython() | |
if specifier is None: | |
specifier = specifiers.SpecifierSet() | |
supported_tags = target_python.get_tags() | |
return cls( | |
project_name=project_name, | |
supported_tags=supported_tags, | |
specifier=specifier, | |
prefer_binary=prefer_binary, | |
allow_all_prereleases=allow_all_prereleases, | |
hashes=hashes, | |
) | |
def __init__( | |
self, | |
project_name, # type: str | |
supported_tags, # type: List[Tag] | |
specifier, # type: specifiers.BaseSpecifier | |
prefer_binary=False, # type: bool | |
allow_all_prereleases=False, # type: bool | |
hashes=None, # type: Optional[Hashes] | |
): | |
# type: (...) -> None | |
""" | |
:param supported_tags: The PEP 425 tags supported by the target | |
Python in order of preference (most preferred first). | |
""" | |
self._allow_all_prereleases = allow_all_prereleases | |
self._hashes = hashes | |
self._prefer_binary = prefer_binary | |
self._project_name = project_name | |
self._specifier = specifier | |
self._supported_tags = supported_tags | |
def get_applicable_candidates( | |
self, | |
candidates, # type: List[InstallationCandidate] | |
): | |
# type: (...) -> List[InstallationCandidate] | |
""" | |
Return the applicable candidates from a list of candidates. | |
""" | |
# Using None infers from the specifier instead. | |
allow_prereleases = self._allow_all_prereleases or None | |
specifier = self._specifier | |
versions = { | |
str(v) for v in specifier.filter( | |
# We turn the version object into a str here because otherwise | |
# when we're debundled but setuptools isn't, Python will see | |
# packaging.version.Version and | |
# pkg_resources._vendor.packaging.version.Version as different | |
# types. This way we'll use a str as a common data interchange | |
# format. If we stop using the pkg_resources provided specifier | |
# and start using our own, we can drop the cast to str(). | |
(str(c.version) for c in candidates), | |
prereleases=allow_prereleases, | |
) | |
} | |
# Again, converting version to str to deal with debundling. | |
applicable_candidates = [ | |
c for c in candidates if str(c.version) in versions | |
] | |
filtered_applicable_candidates = filter_unallowed_hashes( | |
candidates=applicable_candidates, | |
hashes=self._hashes, | |
project_name=self._project_name, | |
) | |
return sorted(filtered_applicable_candidates, key=self._sort_key) | |
def _sort_key(self, candidate): | |
# type: (InstallationCandidate) -> CandidateSortingKey | |
""" | |
Function to pass as the `key` argument to a call to sorted() to sort | |
InstallationCandidates by preference. | |
Returns a tuple such that tuples sorting as greater using Python's | |
default comparison operator are more preferred. | |
The preference is as follows: | |
First and foremost, candidates with allowed (matching) hashes are | |
always preferred over candidates without matching hashes. This is | |
because e.g. if the only candidate with an allowed hash is yanked, | |
we still want to use that candidate. | |
Second, excepting hash considerations, candidates that have been | |
yanked (in the sense of PEP 592) are always less preferred than | |
candidates that haven't been yanked. Then: | |
If not finding wheels, they are sorted by version only. | |
If finding wheels, then the sort order is by version, then: | |
1. existing installs | |
2. wheels ordered via Wheel.support_index_min(self._supported_tags) | |
3. source archives | |
If prefer_binary was set, then all wheels are sorted above sources. | |
Note: it was considered to embed this logic into the Link | |
comparison operators, but then different sdist links | |
with the same version, would have to be considered equal | |
""" | |
valid_tags = self._supported_tags | |
support_num = len(valid_tags) | |
build_tag = () # type: BuildTag | |
binary_preference = 0 | |
link = candidate.link | |
if link.is_wheel: | |
# can raise InvalidWheelFilename | |
wheel = Wheel(link.filename) | |
if not wheel.supported(valid_tags): | |
raise UnsupportedWheel( | |
"{} is not a supported wheel for this platform. It " | |
"can't be sorted.".format(wheel.filename) | |
) | |
if self._prefer_binary: | |
binary_preference = 1 | |
pri = -(wheel.support_index_min(valid_tags)) | |
if wheel.build_tag is not None: | |
match = re.match(r'^(\d+)(.*)$', wheel.build_tag) | |
build_tag_groups = match.groups() | |
build_tag = (int(build_tag_groups[0]), build_tag_groups[1]) | |
else: # sdist | |
pri = -(support_num) | |
has_allowed_hash = int(link.is_hash_allowed(self._hashes)) | |
yank_value = -1 * int(link.is_yanked) # -1 for yanked. | |
return ( | |
has_allowed_hash, yank_value, binary_preference, candidate.version, | |
build_tag, pri, | |
) | |
def sort_best_candidate( | |
self, | |
candidates, # type: List[InstallationCandidate] | |
): | |
# type: (...) -> Optional[InstallationCandidate] | |
""" | |
Return the best candidate per the instance's sort order, or None if | |
no candidate is acceptable. | |
""" | |
if not candidates: | |
return None | |
best_candidate = max(candidates, key=self._sort_key) | |
# Log a warning per PEP 592 if necessary before returning. | |
link = best_candidate.link | |
if link.is_yanked: | |
reason = link.yanked_reason or '<none given>' | |
msg = ( | |
# Mark this as a unicode string to prevent | |
# "UnicodeEncodeError: 'ascii' codec can't encode character" | |
# in Python 2 when the reason contains non-ascii characters. | |
u'The candidate selected for download or install is a ' | |
'yanked version: {candidate}\n' | |
'Reason for being yanked: {reason}' | |
).format(candidate=best_candidate, reason=reason) | |
logger.warning(msg) | |
return best_candidate | |
def compute_best_candidate( | |
self, | |
candidates, # type: List[InstallationCandidate] | |
): | |
# type: (...) -> BestCandidateResult | |
""" | |
Compute and return a `BestCandidateResult` instance. | |
""" | |
applicable_candidates = self.get_applicable_candidates(candidates) | |
best_candidate = self.sort_best_candidate(applicable_candidates) | |
return BestCandidateResult( | |
candidates, | |
applicable_candidates=applicable_candidates, | |
best_candidate=best_candidate, | |
) | |
class PackageFinder(object): | |
"""This finds packages. | |
This is meant to match easy_install's technique for looking for | |
packages, by reading pages and looking for appropriate links. | |
""" | |
def __init__( | |
self, | |
link_collector, # type: LinkCollector | |
target_python, # type: TargetPython | |
allow_yanked, # type: bool | |
format_control=None, # type: Optional[FormatControl] | |
candidate_prefs=None, # type: CandidatePreferences | |
ignore_requires_python=None, # type: Optional[bool] | |
): | |
# type: (...) -> None | |
""" | |
This constructor is primarily meant to be used by the create() class | |
method and from tests. | |
:param format_control: A FormatControl object, used to control | |
the selection of source packages / binary packages when consulting | |
the index and links. | |
:param candidate_prefs: Options to use when creating a | |
CandidateEvaluator object. | |
""" | |
if candidate_prefs is None: | |
candidate_prefs = CandidatePreferences() | |
format_control = format_control or FormatControl(set(), set()) | |
self._allow_yanked = allow_yanked | |
self._candidate_prefs = candidate_prefs | |
self._ignore_requires_python = ignore_requires_python | |
self._link_collector = link_collector | |
self._target_python = target_python | |
self.format_control = format_control | |
# These are boring links that have already been logged somehow. | |
self._logged_links = set() # type: Set[Link] | |
# Don't include an allow_yanked default value to make sure each call | |
# site considers whether yanked releases are allowed. This also causes | |
# that decision to be made explicit in the calling code, which helps | |
# people when reading the code. | |
@classmethod | |
def create( | |
cls, | |
link_collector, # type: LinkCollector | |
selection_prefs, # type: SelectionPreferences | |
target_python=None, # type: Optional[TargetPython] | |
): | |
# type: (...) -> PackageFinder | |
"""Create a PackageFinder. | |
:param selection_prefs: The candidate selection preferences, as a | |
SelectionPreferences object. | |
:param target_python: The target Python interpreter to use when | |
checking compatibility. If None (the default), a TargetPython | |
object will be constructed from the running Python. | |
""" | |
if target_python is None: | |
target_python = TargetPython() | |
candidate_prefs = CandidatePreferences( | |
prefer_binary=selection_prefs.prefer_binary, | |
allow_all_prereleases=selection_prefs.allow_all_prereleases, | |
) | |
return cls( | |
candidate_prefs=candidate_prefs, | |
link_collector=link_collector, | |
target_python=target_python, | |
allow_yanked=selection_prefs.allow_yanked, | |
format_control=selection_prefs.format_control, | |
ignore_requires_python=selection_prefs.ignore_requires_python, | |
) | |
@property | |
def search_scope(self): | |
# type: () -> SearchScope | |
return self._link_collector.search_scope | |
@search_scope.setter | |
def search_scope(self, search_scope): | |
# type: (SearchScope) -> None | |
self._link_collector.search_scope = search_scope | |
@property | |
def find_links(self): | |
# type: () -> List[str] | |
return self._link_collector.find_links | |
@property | |
def index_urls(self): | |
# type: () -> List[str] | |
return self.search_scope.index_urls | |
@property | |
def trusted_hosts(self): | |
# type: () -> Iterable[str] | |
for host_port in self._link_collector.session.pip_trusted_origins: | |
yield build_netloc(*host_port) | |
@property | |
def allow_all_prereleases(self): | |
# type: () -> bool | |
return self._candidate_prefs.allow_all_prereleases | |
def set_allow_all_prereleases(self): | |
# type: () -> None | |
self._candidate_prefs.allow_all_prereleases = True | |
def make_link_evaluator(self, project_name): | |
# type: (str) -> LinkEvaluator | |
canonical_name = canonicalize_name(project_name) | |
formats = self.format_control.get_allowed_formats(canonical_name) | |
return LinkEvaluator( | |
project_name=project_name, | |
canonical_name=canonical_name, | |
formats=formats, | |
target_python=self._target_python, | |
allow_yanked=self._allow_yanked, | |
ignore_requires_python=self._ignore_requires_python, | |
) | |
def _sort_links(self, links): | |
# type: (Iterable[Link]) -> List[Link] | |
""" | |
Returns elements of links in order, non-egg links first, egg links | |
second, while eliminating duplicates | |
""" | |
eggs, no_eggs = [], [] | |
seen = set() # type: Set[Link] | |
for link in links: | |
if link not in seen: | |
seen.add(link) | |
if link.egg_fragment: | |
eggs.append(link) | |
else: | |
no_eggs.append(link) | |
return no_eggs + eggs | |
def _log_skipped_link(self, link, reason): | |
# type: (Link, Text) -> None | |
if link not in self._logged_links: | |
# Mark this as a unicode string to prevent "UnicodeEncodeError: | |
# 'ascii' codec can't encode character" in Python 2 when | |
# the reason contains non-ascii characters. | |
# Also, put the link at the end so the reason is more visible | |
# and because the link string is usually very long. | |
logger.debug(u'Skipping link: %s: %s', reason, link) | |
self._logged_links.add(link) | |
def get_install_candidate(self, link_evaluator, link): | |
# type: (LinkEvaluator, Link) -> Optional[InstallationCandidate] | |
""" | |
If the link is a candidate for install, convert it to an | |
InstallationCandidate and return it. Otherwise, return None. | |
""" | |
is_candidate, result = link_evaluator.evaluate_link(link) | |
if not is_candidate: | |
if result: | |
self._log_skipped_link(link, reason=result) | |
return None | |
return InstallationCandidate( | |
name=link_evaluator.project_name, | |
link=link, | |
# Convert the Text result to str since InstallationCandidate | |
# accepts str. | |
version=str(result), | |
) | |
def evaluate_links(self, link_evaluator, links): | |
# type: (LinkEvaluator, Iterable[Link]) -> List[InstallationCandidate] | |
""" | |
Convert links that are candidates to InstallationCandidate objects. | |
""" | |
candidates = [] | |
for link in self._sort_links(links): | |
candidate = self.get_install_candidate(link_evaluator, link) | |
if candidate is not None: | |
candidates.append(candidate) | |
return candidates | |
def process_project_url(self, project_url, link_evaluator): | |
# type: (Link, LinkEvaluator) -> List[InstallationCandidate] | |
logger.debug( | |
'Fetching project page and analyzing links: %s', project_url, | |
) | |
html_page = self._link_collector.fetch_page(project_url) | |
if html_page is None: | |
return [] | |
page_links = list(parse_links(html_page)) | |
with indent_log(): | |
package_links = self.evaluate_links( | |
link_evaluator, | |
links=page_links, | |
) | |
return package_links | |
def find_all_candidates(self, project_name): | |
# type: (str) -> List[InstallationCandidate] | |
"""Find all available InstallationCandidate for project_name | |
This checks index_urls and find_links. | |
All versions found are returned as an InstallationCandidate list. | |
See LinkEvaluator.evaluate_link() for details on which files | |
are accepted. | |
""" | |
collected_links = self._link_collector.collect_links(project_name) | |
link_evaluator = self.make_link_evaluator(project_name) | |
find_links_versions = self.evaluate_links( | |
link_evaluator, | |
links=collected_links.find_links, | |
) | |
page_versions = [] | |
for project_url in collected_links.project_urls: | |
package_links = self.process_project_url( | |
project_url, link_evaluator=link_evaluator, | |
) | |
page_versions.extend(package_links) | |
file_versions = self.evaluate_links( | |
link_evaluator, | |
links=collected_links.files, | |
) | |
if file_versions: | |
file_versions.sort(reverse=True) | |
logger.debug( | |
'Local files found: %s', | |
', '.join([ | |
url_to_path(candidate.link.url) | |
for candidate in file_versions | |
]) | |
) | |
# This is an intentional priority ordering | |
return file_versions + find_links_versions + page_versions | |
def make_candidate_evaluator( | |
self, | |
project_name, # type: str | |
specifier=None, # type: Optional[specifiers.BaseSpecifier] | |
hashes=None, # type: Optional[Hashes] | |
): | |
# type: (...) -> CandidateEvaluator | |
"""Create a CandidateEvaluator object to use. | |
""" | |
candidate_prefs = self._candidate_prefs | |
return CandidateEvaluator.create( | |
project_name=project_name, | |
target_python=self._target_python, | |
prefer_binary=candidate_prefs.prefer_binary, | |
allow_all_prereleases=candidate_prefs.allow_all_prereleases, | |
specifier=specifier, | |
hashes=hashes, | |
) | |
def find_best_candidate( | |
self, | |
project_name, # type: str | |
specifier=None, # type: Optional[specifiers.BaseSpecifier] | |
hashes=None, # type: Optional[Hashes] | |
): | |
# type: (...) -> BestCandidateResult | |
"""Find matches for the given project and specifier. | |
:param specifier: An optional object implementing `filter` | |
(e.g. `packaging.specifiers.SpecifierSet`) to filter applicable | |
versions. | |
:return: A `BestCandidateResult` instance. | |
""" | |
candidates = self.find_all_candidates(project_name) | |
candidate_evaluator = self.make_candidate_evaluator( | |
project_name=project_name, | |
specifier=specifier, | |
hashes=hashes, | |
) | |
return candidate_evaluator.compute_best_candidate(candidates) | |
def find_requirement(self, req, upgrade): | |
# type: (InstallRequirement, bool) -> Optional[Link] | |
"""Try to find a Link matching req | |
Expects req, an InstallRequirement and upgrade, a boolean | |
Returns a Link if found, | |
Raises DistributionNotFound or BestVersionAlreadyInstalled otherwise | |
""" | |
hashes = req.hashes(trust_internet=False) | |
best_candidate_result = self.find_best_candidate( | |
req.name, specifier=req.specifier, hashes=hashes, | |
) | |
best_candidate = best_candidate_result.best_candidate | |
installed_version = None # type: Optional[_BaseVersion] | |
if req.satisfied_by is not None: | |
installed_version = parse_version(req.satisfied_by.version) | |
def _format_versions(cand_iter): | |
# type: (Iterable[InstallationCandidate]) -> str | |
# This repeated parse_version and str() conversion is needed to | |
# handle different vendoring sources from pip and pkg_resources. | |
# If we stop using the pkg_resources provided specifier and start | |
# using our own, we can drop the cast to str(). | |
return ", ".join(sorted( | |
{str(c.version) for c in cand_iter}, | |
key=parse_version, | |
)) or "none" | |
if installed_version is None and best_candidate is None: | |
logger.critical( | |
'Could not find a version that satisfies the requirement %s ' | |
'(from versions: %s)', | |
req, | |
_format_versions(best_candidate_result.iter_all()), | |
) | |
raise DistributionNotFound( | |
'No matching distribution found for {}'.format( | |
req) | |
) | |
best_installed = False | |
if installed_version and ( | |
best_candidate is None or | |
best_candidate.version <= installed_version): | |
best_installed = True | |
if not upgrade and installed_version is not None: | |
if best_installed: | |
logger.debug( | |
'Existing installed version (%s) is most up-to-date and ' | |
'satisfies requirement', | |
installed_version, | |
) | |
else: | |
logger.debug( | |
'Existing installed version (%s) satisfies requirement ' | |
'(most up-to-date version is %s)', | |
installed_version, | |
best_candidate.version, | |
) | |
return None | |
if best_installed: | |
# We have an existing version, and its the best version | |
logger.debug( | |
'Installed version (%s) is most up-to-date (past versions: ' | |
'%s)', | |
installed_version, | |
_format_versions(best_candidate_result.iter_applicable()), | |
) | |
raise BestVersionAlreadyInstalled | |
logger.debug( | |
'Using version %s (newest of versions: %s)', | |
best_candidate.version, | |
_format_versions(best_candidate_result.iter_applicable()), | |
) | |
return best_candidate.link | |
def _find_name_version_sep(fragment, canonical_name): | |
# type: (str, str) -> int | |
"""Find the separator's index based on the package's canonical name. | |
:param fragment: A <package>+<version> filename "fragment" (stem) or | |
egg fragment. | |
:param canonical_name: The package's canonical name. | |
This function is needed since the canonicalized name does not necessarily | |
have the same length as the egg info's name part. An example:: | |
>>> fragment = 'foo__bar-1.0' | |
>>> canonical_name = 'foo-bar' | |
>>> _find_name_version_sep(fragment, canonical_name) | |
8 | |
""" | |
# Project name and version must be separated by one single dash. Find all | |
# occurrences of dashes; if the string in front of it matches the canonical | |
# name, this is the one separating the name and version parts. | |
for i, c in enumerate(fragment): | |
if c != "-": | |
continue | |
if canonicalize_name(fragment[:i]) == canonical_name: | |
return i | |
raise ValueError("{} does not match {}".format(fragment, canonical_name)) | |
def _extract_version_from_fragment(fragment, canonical_name): | |
# type: (str, str) -> Optional[str] | |
"""Parse the version string from a <package>+<version> filename | |
"fragment" (stem) or egg fragment. | |
:param fragment: The string to parse. E.g. foo-2.1 | |
:param canonical_name: The canonicalized name of the package this | |
belongs to. | |
""" | |
try: | |
version_start = _find_name_version_sep(fragment, canonical_name) + 1 | |
except ValueError: | |
return None | |
version = fragment[version_start:] | |
if not version: | |
return None | |
return version |
"""Locations where we look for configs, install stuff, etc""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import os | |
import os.path | |
import platform | |
import site | |
import sys | |
import sysconfig | |
from distutils import sysconfig as distutils_sysconfig | |
from distutils.command.install import SCHEME_KEYS # type: ignore | |
from distutils.command.install import install as distutils_install_command | |
from pip._internal.models.scheme import Scheme | |
from pip._internal.utils import appdirs | |
from pip._internal.utils.compat import WINDOWS | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING, cast | |
from pip._internal.utils.virtualenv import running_under_virtualenv | |
if MYPY_CHECK_RUNNING: | |
from typing import Dict, List, Optional, Union | |
from distutils.cmd import Command as DistutilsCommand | |
# Application Directories | |
USER_CACHE_DIR = appdirs.user_cache_dir("pip") | |
def get_major_minor_version(): | |
# type: () -> str | |
""" | |
Return the major-minor version of the current Python as a string, e.g. | |
"3.7" or "3.10". | |
""" | |
return '{}.{}'.format(*sys.version_info) | |
def get_src_prefix(): | |
# type: () -> str | |
if running_under_virtualenv(): | |
src_prefix = os.path.join(sys.prefix, 'src') | |
else: | |
# FIXME: keep src in cwd for now (it is not a temporary folder) | |
try: | |
src_prefix = os.path.join(os.getcwd(), 'src') | |
except OSError: | |
# In case the current working directory has been renamed or deleted | |
sys.exit( | |
"The folder you are executing pip from can no longer be found." | |
) | |
# under macOS + virtualenv sys.prefix is not properly resolved | |
# it is something like /path/to/python/bin/.. | |
return os.path.abspath(src_prefix) | |
# FIXME doesn't account for venv linked to global site-packages | |
site_packages = sysconfig.get_path("purelib") # type: Optional[str] | |
# This is because of a bug in PyPy's sysconfig module, see | |
# https://bitbucket.org/pypy/pypy/issues/2506/sysconfig-returns-incorrect-paths | |
# for more information. | |
if platform.python_implementation().lower() == "pypy": | |
site_packages = distutils_sysconfig.get_python_lib() | |
try: | |
# Use getusersitepackages if this is present, as it ensures that the | |
# value is initialised properly. | |
user_site = site.getusersitepackages() | |
except AttributeError: | |
user_site = site.USER_SITE | |
if WINDOWS: | |
bin_py = os.path.join(sys.prefix, 'Scripts') | |
bin_user = os.path.join(user_site, 'Scripts') | |
# buildout uses 'bin' on Windows too? | |
if not os.path.exists(bin_py): | |
bin_py = os.path.join(sys.prefix, 'bin') | |
bin_user = os.path.join(user_site, 'bin') | |
else: | |
bin_py = os.path.join(sys.prefix, 'bin') | |
bin_user = os.path.join(user_site, 'bin') | |
# Forcing to use /usr/local/bin for standard macOS framework installs | |
# Also log to ~/Library/Logs/ for use with the Console.app log viewer | |
if sys.platform[:6] == 'darwin' and sys.prefix[:16] == '/System/Library/': | |
bin_py = '/usr/local/bin' | |
def distutils_scheme( | |
dist_name, user=False, home=None, root=None, isolated=False, prefix=None | |
): | |
# type:(str, bool, str, str, bool, str) -> Dict[str, str] | |
""" | |
Return a distutils install scheme | |
""" | |
from distutils.dist import Distribution | |
dist_args = {'name': dist_name} # type: Dict[str, Union[str, List[str]]] | |
if isolated: | |
dist_args["script_args"] = ["--no-user-cfg"] | |
d = Distribution(dist_args) | |
d.parse_config_files() | |
obj = None # type: Optional[DistutilsCommand] | |
obj = d.get_command_obj('install', create=True) | |
assert obj is not None | |
i = cast(distutils_install_command, obj) | |
# NOTE: setting user or home has the side-effect of creating the home dir | |
# or user base for installations during finalize_options() | |
# ideally, we'd prefer a scheme class that has no side-effects. | |
assert not (user and prefix), "user={} prefix={}".format(user, prefix) | |
assert not (home and prefix), "home={} prefix={}".format(home, prefix) | |
i.user = user or i.user | |
if user or home: | |
i.prefix = "" | |
i.prefix = prefix or i.prefix | |
i.home = home or i.home | |
i.root = root or i.root | |
i.finalize_options() | |
scheme = {} | |
for key in SCHEME_KEYS: | |
scheme[key] = getattr(i, 'install_' + key) | |
# install_lib specified in setup.cfg should install *everything* | |
# into there (i.e. it takes precedence over both purelib and | |
# platlib). Note, i.install_lib is *always* set after | |
# finalize_options(); we only want to override here if the user | |
# has explicitly requested it hence going back to the config | |
if 'install_lib' in d.get_option_dict('install'): | |
scheme.update(dict(purelib=i.install_lib, platlib=i.install_lib)) | |
if running_under_virtualenv(): | |
scheme['headers'] = os.path.join( | |
sys.prefix, | |
'include', | |
'site', | |
'python{}'.format(get_major_minor_version()), | |
dist_name, | |
) | |
if root is not None: | |
path_no_drive = os.path.splitdrive( | |
os.path.abspath(scheme["headers"]))[1] | |
scheme["headers"] = os.path.join( | |
root, | |
path_no_drive[1:], | |
) | |
return scheme | |
def get_scheme( | |
dist_name, # type: str | |
user=False, # type: bool | |
home=None, # type: Optional[str] | |
root=None, # type: Optional[str] | |
isolated=False, # type: bool | |
prefix=None, # type: Optional[str] | |
): | |
# type: (...) -> Scheme | |
""" | |
Get the "scheme" corresponding to the input parameters. The distutils | |
documentation provides the context for the available schemes: | |
https://docs.python.org/3/install/index.html#alternate-installation | |
:param dist_name: the name of the package to retrieve the scheme for, used | |
in the headers scheme path | |
:param user: indicates to use the "user" scheme | |
:param home: indicates to use the "home" scheme and provides the base | |
directory for the same | |
:param root: root under which other directories are re-based | |
:param isolated: equivalent to --no-user-cfg, i.e. do not consider | |
~/.pydistutils.cfg (posix) or ~/pydistutils.cfg (non-posix) for | |
scheme paths | |
:param prefix: indicates to use the "prefix" scheme and provides the | |
base directory for the same | |
""" | |
scheme = distutils_scheme( | |
dist_name, user, home, root, isolated, prefix | |
) | |
return Scheme( | |
platlib=scheme["platlib"], | |
purelib=scheme["purelib"], | |
headers=scheme["headers"], | |
scripts=scheme["scripts"], | |
data=scheme["data"], | |
) |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, List | |
def main(args=None): | |
# type: (Optional[List[str]]) -> int | |
"""This is preserved for old console scripts that may still be referencing | |
it. | |
For additional details, see https://github.com/pypa/pip/issues/7498. | |
""" | |
from pip._internal.utils.entrypoints import _wrapper | |
return _wrapper(args) |
"""A package that contains models that represent entities. | |
""" |
from pip._vendor.packaging.version import parse as parse_version | |
from pip._internal.utils.models import KeyBasedCompareMixin | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from pip._vendor.packaging.version import _BaseVersion | |
from pip._internal.models.link import Link | |
class InstallationCandidate(KeyBasedCompareMixin): | |
"""Represents a potential "candidate" for installation. | |
""" | |
def __init__(self, name, version, link): | |
# type: (str, str, Link) -> None | |
self.name = name | |
self.version = parse_version(version) # type: _BaseVersion | |
self.link = link | |
super(InstallationCandidate, self).__init__( | |
key=(self.name, self.version, self.link), | |
defining_class=InstallationCandidate | |
) | |
def __repr__(self): | |
# type: () -> str | |
return "<InstallationCandidate({!r}, {!r}, {!r})>".format( | |
self.name, self.version, self.link, | |
) | |
def __str__(self): | |
# type: () -> str | |
return '{!r} candidate (version {} at {})'.format( | |
self.name, self.version, self.link, | |
) |
""" PEP 610 """ | |
import json | |
import re | |
from pip._vendor import six | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Dict, Iterable, Optional, Type, TypeVar, Union | |
) | |
T = TypeVar("T") | |
DIRECT_URL_METADATA_NAME = "direct_url.json" | |
ENV_VAR_RE = re.compile(r"^\$\{[A-Za-z0-9-_]+\}(:\$\{[A-Za-z0-9-_]+\})?$") | |
__all__ = [ | |
"DirectUrl", | |
"DirectUrlValidationError", | |
"DirInfo", | |
"ArchiveInfo", | |
"VcsInfo", | |
] | |
class DirectUrlValidationError(Exception): | |
pass | |
def _get(d, expected_type, key, default=None): | |
# type: (Dict[str, Any], Type[T], str, Optional[T]) -> Optional[T] | |
"""Get value from dictionary and verify expected type.""" | |
if key not in d: | |
return default | |
value = d[key] | |
if six.PY2 and expected_type is str: | |
expected_type = six.string_types # type: ignore | |
if not isinstance(value, expected_type): | |
raise DirectUrlValidationError( | |
"{!r} has unexpected type for {} (expected {})".format( | |
value, key, expected_type | |
) | |
) | |
return value | |
def _get_required(d, expected_type, key, default=None): | |
# type: (Dict[str, Any], Type[T], str, Optional[T]) -> T | |
value = _get(d, expected_type, key, default) | |
if value is None: | |
raise DirectUrlValidationError("{} must have a value".format(key)) | |
return value | |
def _exactly_one_of(infos): | |
# type: (Iterable[Optional[InfoType]]) -> InfoType | |
infos = [info for info in infos if info is not None] | |
if not infos: | |
raise DirectUrlValidationError( | |
"missing one of archive_info, dir_info, vcs_info" | |
) | |
if len(infos) > 1: | |
raise DirectUrlValidationError( | |
"more than one of archive_info, dir_info, vcs_info" | |
) | |
assert infos[0] is not None | |
return infos[0] | |
def _filter_none(**kwargs): | |
# type: (Any) -> Dict[str, Any] | |
"""Make dict excluding None values.""" | |
return {k: v for k, v in kwargs.items() if v is not None} | |
class VcsInfo(object): | |
name = "vcs_info" | |
def __init__( | |
self, | |
vcs, # type: str | |
commit_id, # type: str | |
requested_revision=None, # type: Optional[str] | |
resolved_revision=None, # type: Optional[str] | |
resolved_revision_type=None, # type: Optional[str] | |
): | |
self.vcs = vcs | |
self.requested_revision = requested_revision | |
self.commit_id = commit_id | |
self.resolved_revision = resolved_revision | |
self.resolved_revision_type = resolved_revision_type | |
@classmethod | |
def _from_dict(cls, d): | |
# type: (Optional[Dict[str, Any]]) -> Optional[VcsInfo] | |
if d is None: | |
return None | |
return cls( | |
vcs=_get_required(d, str, "vcs"), | |
commit_id=_get_required(d, str, "commit_id"), | |
requested_revision=_get(d, str, "requested_revision"), | |
resolved_revision=_get(d, str, "resolved_revision"), | |
resolved_revision_type=_get(d, str, "resolved_revision_type"), | |
) | |
def _to_dict(self): | |
# type: () -> Dict[str, Any] | |
return _filter_none( | |
vcs=self.vcs, | |
requested_revision=self.requested_revision, | |
commit_id=self.commit_id, | |
resolved_revision=self.resolved_revision, | |
resolved_revision_type=self.resolved_revision_type, | |
) | |
class ArchiveInfo(object): | |
name = "archive_info" | |
def __init__( | |
self, | |
hash=None, # type: Optional[str] | |
): | |
self.hash = hash | |
@classmethod | |
def _from_dict(cls, d): | |
# type: (Optional[Dict[str, Any]]) -> Optional[ArchiveInfo] | |
if d is None: | |
return None | |
return cls(hash=_get(d, str, "hash")) | |
def _to_dict(self): | |
# type: () -> Dict[str, Any] | |
return _filter_none(hash=self.hash) | |
class DirInfo(object): | |
name = "dir_info" | |
def __init__( | |
self, | |
editable=False, # type: bool | |
): | |
self.editable = editable | |
@classmethod | |
def _from_dict(cls, d): | |
# type: (Optional[Dict[str, Any]]) -> Optional[DirInfo] | |
if d is None: | |
return None | |
return cls( | |
editable=_get_required(d, bool, "editable", default=False) | |
) | |
def _to_dict(self): | |
# type: () -> Dict[str, Any] | |
return _filter_none(editable=self.editable or None) | |
if MYPY_CHECK_RUNNING: | |
InfoType = Union[ArchiveInfo, DirInfo, VcsInfo] | |
class DirectUrl(object): | |
def __init__( | |
self, | |
url, # type: str | |
info, # type: InfoType | |
subdirectory=None, # type: Optional[str] | |
): | |
self.url = url | |
self.info = info | |
self.subdirectory = subdirectory | |
def _remove_auth_from_netloc(self, netloc): | |
# type: (str) -> str | |
if "@" not in netloc: | |
return netloc | |
user_pass, netloc_no_user_pass = netloc.split("@", 1) | |
if ( | |
isinstance(self.info, VcsInfo) and | |
self.info.vcs == "git" and | |
user_pass == "git" | |
): | |
return netloc | |
if ENV_VAR_RE.match(user_pass): | |
return netloc | |
return netloc_no_user_pass | |
@property | |
def redacted_url(self): | |
# type: () -> str | |
"""url with user:password part removed unless it is formed with | |
environment variables as specified in PEP 610, or it is ``git`` | |
in the case of a git URL. | |
""" | |
purl = urllib_parse.urlsplit(self.url) | |
netloc = self._remove_auth_from_netloc(purl.netloc) | |
surl = urllib_parse.urlunsplit( | |
(purl.scheme, netloc, purl.path, purl.query, purl.fragment) | |
) | |
return surl | |
def validate(self): | |
# type: () -> None | |
self.from_dict(self.to_dict()) | |
@classmethod | |
def from_dict(cls, d): | |
# type: (Dict[str, Any]) -> DirectUrl | |
return DirectUrl( | |
url=_get_required(d, str, "url"), | |
subdirectory=_get(d, str, "subdirectory"), | |
info=_exactly_one_of( | |
[ | |
ArchiveInfo._from_dict(_get(d, dict, "archive_info")), | |
DirInfo._from_dict(_get(d, dict, "dir_info")), | |
VcsInfo._from_dict(_get(d, dict, "vcs_info")), | |
] | |
), | |
) | |
def to_dict(self): | |
# type: () -> Dict[str, Any] | |
res = _filter_none( | |
url=self.redacted_url, | |
subdirectory=self.subdirectory, | |
) | |
res[self.info.name] = self.info._to_dict() | |
return res | |
@classmethod | |
def from_json(cls, s): | |
# type: (str) -> DirectUrl | |
return cls.from_dict(json.loads(s)) | |
def to_json(self): | |
# type: () -> str | |
return json.dumps(self.to_dict(), sort_keys=True) |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.exceptions import CommandError | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Set, FrozenSet | |
class FormatControl(object): | |
"""Helper for managing formats from which a package can be installed. | |
""" | |
def __init__(self, no_binary=None, only_binary=None): | |
# type: (Optional[Set[str]], Optional[Set[str]]) -> None | |
if no_binary is None: | |
no_binary = set() | |
if only_binary is None: | |
only_binary = set() | |
self.no_binary = no_binary | |
self.only_binary = only_binary | |
def __eq__(self, other): | |
# type: (object) -> bool | |
return self.__dict__ == other.__dict__ | |
def __ne__(self, other): | |
# type: (object) -> bool | |
return not self.__eq__(other) | |
def __repr__(self): | |
# type: () -> str | |
return "{}({}, {})".format( | |
self.__class__.__name__, | |
self.no_binary, | |
self.only_binary | |
) | |
@staticmethod | |
def handle_mutual_excludes(value, target, other): | |
# type: (str, Optional[Set[str]], Optional[Set[str]]) -> None | |
if value.startswith('-'): | |
raise CommandError( | |
"--no-binary / --only-binary option requires 1 argument." | |
) | |
new = value.split(',') | |
while ':all:' in new: | |
other.clear() | |
target.clear() | |
target.add(':all:') | |
del new[:new.index(':all:') + 1] | |
# Without a none, we want to discard everything as :all: covers it | |
if ':none:' not in new: | |
return | |
for name in new: | |
if name == ':none:': | |
target.clear() | |
continue | |
name = canonicalize_name(name) | |
other.discard(name) | |
target.add(name) | |
def get_allowed_formats(self, canonical_name): | |
# type: (str) -> FrozenSet[str] | |
result = {"binary", "source"} | |
if canonical_name in self.only_binary: | |
result.discard('source') | |
elif canonical_name in self.no_binary: | |
result.discard('binary') | |
elif ':all:' in self.only_binary: | |
result.discard('source') | |
elif ':all:' in self.no_binary: | |
result.discard('binary') | |
return frozenset(result) | |
def disallow_binaries(self): | |
# type: () -> None | |
self.handle_mutual_excludes( | |
':all:', self.no_binary, self.only_binary, | |
) |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
class PackageIndex(object): | |
"""Represents a Package Index and provides easier access to endpoints | |
""" | |
def __init__(self, url, file_storage_domain): | |
# type: (str, str) -> None | |
super(PackageIndex, self).__init__() | |
self.url = url | |
self.netloc = urllib_parse.urlsplit(url).netloc | |
self.simple_url = self._url_for_path('simple') | |
self.pypi_url = self._url_for_path('pypi') | |
# This is part of a temporary hack used to block installs of PyPI | |
# packages which depend on external urls only necessary until PyPI can | |
# block such packages themselves | |
self.file_storage_domain = file_storage_domain | |
def _url_for_path(self, path): | |
# type: (str) -> str | |
return urllib_parse.urljoin(self.url, path) | |
PyPI = PackageIndex( | |
'https://pypi.org/', file_storage_domain='files.pythonhosted.org' | |
) | |
TestPyPI = PackageIndex( | |
'https://test.pypi.org/', file_storage_domain='test-files.pythonhosted.org' | |
) |
import os | |
import posixpath | |
import re | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._internal.utils.filetypes import WHEEL_EXTENSION | |
from pip._internal.utils.misc import ( | |
redact_auth_from_url, | |
split_auth_from_netloc, | |
splitext, | |
) | |
from pip._internal.utils.models import KeyBasedCompareMixin | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import path_to_url, url_to_path | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Text, Tuple, Union | |
from pip._internal.index.collector import HTMLPage | |
from pip._internal.utils.hashes import Hashes | |
class Link(KeyBasedCompareMixin): | |
"""Represents a parsed link from a Package Index's simple URL | |
""" | |
def __init__( | |
self, | |
url, # type: str | |
comes_from=None, # type: Optional[Union[str, HTMLPage]] | |
requires_python=None, # type: Optional[str] | |
yanked_reason=None, # type: Optional[Text] | |
cache_link_parsing=True, # type: bool | |
): | |
# type: (...) -> None | |
""" | |
:param url: url of the resource pointed to (href of the link) | |
:param comes_from: instance of HTMLPage where the link was found, | |
or string. | |
:param requires_python: String containing the `Requires-Python` | |
metadata field, specified in PEP 345. This may be specified by | |
a data-requires-python attribute in the HTML link tag, as | |
described in PEP 503. | |
:param yanked_reason: the reason the file has been yanked, if the | |
file has been yanked, or None if the file hasn't been yanked. | |
This is the value of the "data-yanked" attribute, if present, in | |
a simple repository HTML link. If the file has been yanked but | |
no reason was provided, this should be the empty string. See | |
PEP 592 for more information and the specification. | |
:param cache_link_parsing: A flag that is used elsewhere to determine | |
whether resources retrieved from this link | |
should be cached. PyPI index urls should | |
generally have this set to False, for | |
example. | |
""" | |
# url can be a UNC windows share | |
if url.startswith('\\\\'): | |
url = path_to_url(url) | |
self._parsed_url = urllib_parse.urlsplit(url) | |
# Store the url as a private attribute to prevent accidentally | |
# trying to set a new value. | |
self._url = url | |
self.comes_from = comes_from | |
self.requires_python = requires_python if requires_python else None | |
self.yanked_reason = yanked_reason | |
super(Link, self).__init__(key=url, defining_class=Link) | |
self.cache_link_parsing = cache_link_parsing | |
def __str__(self): | |
# type: () -> str | |
if self.requires_python: | |
rp = ' (requires-python:{})'.format(self.requires_python) | |
else: | |
rp = '' | |
if self.comes_from: | |
return '{} (from {}){}'.format( | |
redact_auth_from_url(self._url), self.comes_from, rp) | |
else: | |
return redact_auth_from_url(str(self._url)) | |
def __repr__(self): | |
# type: () -> str | |
return '<Link {}>'.format(self) | |
@property | |
def url(self): | |
# type: () -> str | |
return self._url | |
@property | |
def filename(self): | |
# type: () -> str | |
path = self.path.rstrip('/') | |
name = posixpath.basename(path) | |
if not name: | |
# Make sure we don't leak auth information if the netloc | |
# includes a username and password. | |
netloc, user_pass = split_auth_from_netloc(self.netloc) | |
return netloc | |
name = urllib_parse.unquote(name) | |
assert name, ( | |
'URL {self._url!r} produced no filename'.format(**locals())) | |
return name | |
@property | |
def file_path(self): | |
# type: () -> str | |
return url_to_path(self.url) | |
@property | |
def scheme(self): | |
# type: () -> str | |
return self._parsed_url.scheme | |
@property | |
def netloc(self): | |
# type: () -> str | |
""" | |
This can contain auth information. | |
""" | |
return self._parsed_url.netloc | |
@property | |
def path(self): | |
# type: () -> str | |
return urllib_parse.unquote(self._parsed_url.path) | |
def splitext(self): | |
# type: () -> Tuple[str, str] | |
return splitext(posixpath.basename(self.path.rstrip('/'))) | |
@property | |
def ext(self): | |
# type: () -> str | |
return self.splitext()[1] | |
@property | |
def url_without_fragment(self): | |
# type: () -> str | |
scheme, netloc, path, query, fragment = self._parsed_url | |
return urllib_parse.urlunsplit((scheme, netloc, path, query, None)) | |
_egg_fragment_re = re.compile(r'[#&]egg=([^&]*)') | |
@property | |
def egg_fragment(self): | |
# type: () -> Optional[str] | |
match = self._egg_fragment_re.search(self._url) | |
if not match: | |
return None | |
return match.group(1) | |
_subdirectory_fragment_re = re.compile(r'[#&]subdirectory=([^&]*)') | |
@property | |
def subdirectory_fragment(self): | |
# type: () -> Optional[str] | |
match = self._subdirectory_fragment_re.search(self._url) | |
if not match: | |
return None | |
return match.group(1) | |
_hash_re = re.compile( | |
r'(sha1|sha224|sha384|sha256|sha512|md5)=([a-f0-9]+)' | |
) | |
@property | |
def hash(self): | |
# type: () -> Optional[str] | |
match = self._hash_re.search(self._url) | |
if match: | |
return match.group(2) | |
return None | |
@property | |
def hash_name(self): | |
# type: () -> Optional[str] | |
match = self._hash_re.search(self._url) | |
if match: | |
return match.group(1) | |
return None | |
@property | |
def show_url(self): | |
# type: () -> str | |
return posixpath.basename(self._url.split('#', 1)[0].split('?', 1)[0]) | |
@property | |
def is_file(self): | |
# type: () -> bool | |
return self.scheme == 'file' | |
def is_existing_dir(self): | |
# type: () -> bool | |
return self.is_file and os.path.isdir(self.file_path) | |
@property | |
def is_wheel(self): | |
# type: () -> bool | |
return self.ext == WHEEL_EXTENSION | |
@property | |
def is_vcs(self): | |
# type: () -> bool | |
from pip._internal.vcs import vcs | |
return self.scheme in vcs.all_schemes | |
@property | |
def is_yanked(self): | |
# type: () -> bool | |
return self.yanked_reason is not None | |
@property | |
def has_hash(self): | |
# type: () -> bool | |
return self.hash_name is not None | |
def is_hash_allowed(self, hashes): | |
# type: (Optional[Hashes]) -> bool | |
""" | |
Return True if the link has a hash and it is allowed. | |
""" | |
if hashes is None or not self.has_hash: | |
return False | |
# Assert non-None so mypy knows self.hash_name and self.hash are str. | |
assert self.hash_name is not None | |
assert self.hash is not None | |
return hashes.is_hash_allowed(self.hash_name, hex_digest=self.hash) |
""" | |
For types associated with installation schemes. | |
For a general overview of available schemes and their context, see | |
https://docs.python.org/3/install/index.html#alternate-installation. | |
""" | |
class Scheme(object): | |
"""A Scheme holds paths which are used as the base directories for | |
artifacts associated with a Python package. | |
""" | |
def __init__( | |
self, | |
platlib, # type: str | |
purelib, # type: str | |
headers, # type: str | |
scripts, # type: str | |
data, # type: str | |
): | |
self.platlib = platlib | |
self.purelib = purelib | |
self.headers = headers | |
self.scripts = scripts | |
self.data = data |
import itertools | |
import logging | |
import os | |
import posixpath | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._internal.models.index import PyPI | |
from pip._internal.utils.compat import has_tls | |
from pip._internal.utils.misc import normalize_path, redact_auth_from_url | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List | |
logger = logging.getLogger(__name__) | |
class SearchScope(object): | |
""" | |
Encapsulates the locations that pip is configured to search. | |
""" | |
@classmethod | |
def create( | |
cls, | |
find_links, # type: List[str] | |
index_urls, # type: List[str] | |
): | |
# type: (...) -> SearchScope | |
""" | |
Create a SearchScope object after normalizing the `find_links`. | |
""" | |
# Build find_links. If an argument starts with ~, it may be | |
# a local file relative to a home directory. So try normalizing | |
# it and if it exists, use the normalized version. | |
# This is deliberately conservative - it might be fine just to | |
# blindly normalize anything starting with a ~... | |
built_find_links = [] # type: List[str] | |
for link in find_links: | |
if link.startswith('~'): | |
new_link = normalize_path(link) | |
if os.path.exists(new_link): | |
link = new_link | |
built_find_links.append(link) | |
# If we don't have TLS enabled, then WARN if anyplace we're looking | |
# relies on TLS. | |
if not has_tls(): | |
for link in itertools.chain(index_urls, built_find_links): | |
parsed = urllib_parse.urlparse(link) | |
if parsed.scheme == 'https': | |
logger.warning( | |
'pip is configured with locations that require ' | |
'TLS/SSL, however the ssl module in Python is not ' | |
'available.' | |
) | |
break | |
return cls( | |
find_links=built_find_links, | |
index_urls=index_urls, | |
) | |
def __init__( | |
self, | |
find_links, # type: List[str] | |
index_urls, # type: List[str] | |
): | |
# type: (...) -> None | |
self.find_links = find_links | |
self.index_urls = index_urls | |
def get_formatted_locations(self): | |
# type: () -> str | |
lines = [] | |
redacted_index_urls = [] | |
if self.index_urls and self.index_urls != [PyPI.simple_url]: | |
for url in self.index_urls: | |
redacted_index_url = redact_auth_from_url(url) | |
# Parse the URL | |
purl = urllib_parse.urlsplit(redacted_index_url) | |
# URL is generally invalid if scheme and netloc is missing | |
# there are issues with Python and URL parsing, so this test | |
# is a bit crude. See bpo-20271, bpo-23505. Python doesn't | |
# always parse invalid URLs correctly - it should raise | |
# exceptions for malformed URLs | |
if not purl.scheme and not purl.netloc: | |
logger.warning( | |
'The index url "{}" seems invalid, ' | |
'please provide a scheme.'.format(redacted_index_url)) | |
redacted_index_urls.append(redacted_index_url) | |
lines.append('Looking in indexes: {}'.format( | |
', '.join(redacted_index_urls))) | |
if self.find_links: | |
lines.append( | |
'Looking in links: {}'.format(', '.join( | |
redact_auth_from_url(url) for url in self.find_links)) | |
) | |
return '\n'.join(lines) | |
def get_index_urls_locations(self, project_name): | |
# type: (str) -> List[str] | |
"""Returns the locations found via self.index_urls | |
Checks the url_name on the main (first in the list) index and | |
use this url_name to produce all locations | |
""" | |
def mkurl_pypi_url(url): | |
# type: (str) -> str | |
loc = posixpath.join( | |
url, | |
urllib_parse.quote(canonicalize_name(project_name))) | |
# For maximum compatibility with easy_install, ensure the path | |
# ends in a trailing slash. Although this isn't in the spec | |
# (and PyPI can handle it without the slash) some other index | |
# implementations might break if they relied on easy_install's | |
# behavior. | |
if not loc.endswith('/'): | |
loc = loc + '/' | |
return loc | |
return [mkurl_pypi_url(url) for url in self.index_urls] |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional | |
from pip._internal.models.format_control import FormatControl | |
class SelectionPreferences(object): | |
""" | |
Encapsulates the candidate selection preferences for downloading | |
and installing files. | |
""" | |
# Don't include an allow_yanked default value to make sure each call | |
# site considers whether yanked releases are allowed. This also causes | |
# that decision to be made explicit in the calling code, which helps | |
# people when reading the code. | |
def __init__( | |
self, | |
allow_yanked, # type: bool | |
allow_all_prereleases=False, # type: bool | |
format_control=None, # type: Optional[FormatControl] | |
prefer_binary=False, # type: bool | |
ignore_requires_python=None, # type: Optional[bool] | |
): | |
# type: (...) -> None | |
"""Create a SelectionPreferences object. | |
:param allow_yanked: Whether files marked as yanked (in the sense | |
of PEP 592) are permitted to be candidates for install. | |
:param format_control: A FormatControl object or None. Used to control | |
the selection of source packages / binary packages when consulting | |
the index and links. | |
:param prefer_binary: Whether to prefer an old, but valid, binary | |
dist over a new source dist. | |
:param ignore_requires_python: Whether to ignore incompatible | |
"Requires-Python" values in links. Defaults to False. | |
""" | |
if ignore_requires_python is None: | |
ignore_requires_python = False | |
self.allow_yanked = allow_yanked | |
self.allow_all_prereleases = allow_all_prereleases | |
self.format_control = format_control | |
self.prefer_binary = prefer_binary | |
self.ignore_requires_python = ignore_requires_python |
import sys | |
from pip._internal.utils.compatibility_tags import ( | |
get_supported, | |
version_info_to_nodot, | |
) | |
from pip._internal.utils.misc import normalize_version_info | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional, Tuple | |
from pip._vendor.packaging.tags import Tag | |
class TargetPython(object): | |
""" | |
Encapsulates the properties of a Python interpreter one is targeting | |
for a package install, download, etc. | |
""" | |
def __init__( | |
self, | |
platform=None, # type: Optional[str] | |
py_version_info=None, # type: Optional[Tuple[int, ...]] | |
abi=None, # type: Optional[str] | |
implementation=None, # type: Optional[str] | |
): | |
# type: (...) -> None | |
""" | |
:param platform: A string or None. If None, searches for packages | |
that are supported by the current system. Otherwise, will find | |
packages that can be built on the platform passed in. These | |
packages will only be downloaded for distribution: they will | |
not be built locally. | |
:param py_version_info: An optional tuple of ints representing the | |
Python version information to use (e.g. `sys.version_info[:3]`). | |
This can have length 1, 2, or 3 when provided. | |
:param abi: A string or None. This is passed to compatibility_tags.py's | |
get_supported() function as is. | |
:param implementation: A string or None. This is passed to | |
compatibility_tags.py's get_supported() function as is. | |
""" | |
# Store the given py_version_info for when we call get_supported(). | |
self._given_py_version_info = py_version_info | |
if py_version_info is None: | |
py_version_info = sys.version_info[:3] | |
else: | |
py_version_info = normalize_version_info(py_version_info) | |
py_version = '.'.join(map(str, py_version_info[:2])) | |
self.abi = abi | |
self.implementation = implementation | |
self.platform = platform | |
self.py_version = py_version | |
self.py_version_info = py_version_info | |
# This is used to cache the return value of get_tags(). | |
self._valid_tags = None # type: Optional[List[Tag]] | |
def format_given(self): | |
# type: () -> str | |
""" | |
Format the given, non-None attributes for display. | |
""" | |
display_version = None | |
if self._given_py_version_info is not None: | |
display_version = '.'.join( | |
str(part) for part in self._given_py_version_info | |
) | |
key_values = [ | |
('platform', self.platform), | |
('version_info', display_version), | |
('abi', self.abi), | |
('implementation', self.implementation), | |
] | |
return ' '.join( | |
'{}={!r}'.format(key, value) for key, value in key_values | |
if value is not None | |
) | |
def get_tags(self): | |
# type: () -> List[Tag] | |
""" | |
Return the supported PEP 425 tags to check wheel candidates against. | |
The tags are returned in order of preference (most preferred first). | |
""" | |
if self._valid_tags is None: | |
# Pass versions=None if no py_version_info was given since | |
# versions=None uses special default logic. | |
py_version_info = self._given_py_version_info | |
if py_version_info is None: | |
version = None | |
else: | |
version = version_info_to_nodot(py_version_info) | |
tags = get_supported( | |
version=version, | |
platform=self.platform, | |
abi=self.abi, | |
impl=self.implementation, | |
) | |
self._valid_tags = tags | |
return self._valid_tags |
"""Represents a wheel file and provides access to the various parts of the | |
name that have meaning. | |
""" | |
import re | |
from pip._vendor.packaging.tags import Tag | |
from pip._internal.exceptions import InvalidWheelFilename | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List | |
class Wheel(object): | |
"""A wheel file""" | |
wheel_file_re = re.compile( | |
r"""^(?P<namever>(?P<name>.+?)-(?P<ver>.*?)) | |
((-(?P<build>\d[^-]*?))?-(?P<pyver>.+?)-(?P<abi>.+?)-(?P<plat>.+?) | |
\.whl|\.dist-info)$""", | |
re.VERBOSE | |
) | |
def __init__(self, filename): | |
# type: (str) -> None | |
""" | |
:raises InvalidWheelFilename: when the filename is invalid for a wheel | |
""" | |
wheel_info = self.wheel_file_re.match(filename) | |
if not wheel_info: | |
raise InvalidWheelFilename( | |
"{} is not a valid wheel filename.".format(filename) | |
) | |
self.filename = filename | |
self.name = wheel_info.group('name').replace('_', '-') | |
# we'll assume "_" means "-" due to wheel naming scheme | |
# (https://github.com/pypa/pip/issues/1150) | |
self.version = wheel_info.group('ver').replace('_', '-') | |
self.build_tag = wheel_info.group('build') | |
self.pyversions = wheel_info.group('pyver').split('.') | |
self.abis = wheel_info.group('abi').split('.') | |
self.plats = wheel_info.group('plat').split('.') | |
# All the tag combinations from this file | |
self.file_tags = { | |
Tag(x, y, z) for x in self.pyversions | |
for y in self.abis for z in self.plats | |
} | |
def get_formatted_file_tags(self): | |
# type: () -> List[str] | |
"""Return the wheel's tags as a sorted list of strings.""" | |
return sorted(str(tag) for tag in self.file_tags) | |
def support_index_min(self, tags): | |
# type: (List[Tag]) -> int | |
"""Return the lowest index that one of the wheel's file_tag combinations | |
achieves in the given list of supported tags. | |
For example, if there are 8 supported tags and one of the file tags | |
is first in the list, then return 0. | |
:param tags: the PEP 425 tags to check the wheel against, in order | |
with most preferred first. | |
:raises ValueError: If none of the wheel's file tags match one of | |
the supported tags. | |
""" | |
return min(tags.index(tag) for tag in self.file_tags if tag in tags) | |
def supported(self, tags): | |
# type: (List[Tag]) -> bool | |
"""Return whether the wheel is compatible with one of the given tags. | |
:param tags: the PEP 425 tags to check the wheel against. | |
""" | |
return not self.file_tags.isdisjoint(tags) |
"""Contains purely network-related utilities. | |
""" |
"""Network Authentication Helpers | |
Contains interface (MultiDomainBasicAuth) and associated glue code for | |
providing credentials in the context of network requests. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
import logging | |
from pip._vendor.requests.auth import AuthBase, HTTPBasicAuth | |
from pip._vendor.requests.utils import get_netrc_auth | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._internal.utils.misc import ( | |
ask, | |
ask_input, | |
ask_password, | |
remove_auth_from_url, | |
split_auth_netloc_from_url, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from optparse import Values | |
from typing import Dict, Optional, Tuple | |
from pip._internal.vcs.versioncontrol import AuthInfo | |
Credentials = Tuple[str, str, str] | |
logger = logging.getLogger(__name__) | |
try: | |
import keyring # noqa | |
except ImportError: | |
keyring = None | |
except Exception as exc: | |
logger.warning( | |
"Keyring is skipped due to an exception: %s", str(exc), | |
) | |
keyring = None | |
def get_keyring_auth(url, username): | |
"""Return the tuple auth for a given url from keyring.""" | |
if not url or not keyring: | |
return None | |
try: | |
try: | |
get_credential = keyring.get_credential | |
except AttributeError: | |
pass | |
else: | |
logger.debug("Getting credentials from keyring for %s", url) | |
cred = get_credential(url, username) | |
if cred is not None: | |
return cred.username, cred.password | |
return None | |
if username: | |
logger.debug("Getting password from keyring for %s", url) | |
password = keyring.get_password(url, username) | |
if password: | |
return username, password | |
except Exception as exc: | |
logger.warning( | |
"Keyring is skipped due to an exception: %s", str(exc), | |
) | |
class MultiDomainBasicAuth(AuthBase): | |
def __init__(self, prompting=True, index_urls=None): | |
# type: (bool, Optional[Values]) -> None | |
self.prompting = prompting | |
self.index_urls = index_urls | |
self.passwords = {} # type: Dict[str, AuthInfo] | |
# When the user is prompted to enter credentials and keyring is | |
# available, we will offer to save them. If the user accepts, | |
# this value is set to the credentials they entered. After the | |
# request authenticates, the caller should call | |
# ``save_credentials`` to save these. | |
self._credentials_to_save = None # type: Optional[Credentials] | |
def _get_index_url(self, url): | |
"""Return the original index URL matching the requested URL. | |
Cached or dynamically generated credentials may work against | |
the original index URL rather than just the netloc. | |
The provided url should have had its username and password | |
removed already. If the original index url had credentials then | |
they will be included in the return value. | |
Returns None if no matching index was found, or if --no-index | |
was specified by the user. | |
""" | |
if not url or not self.index_urls: | |
return None | |
for u in self.index_urls: | |
prefix = remove_auth_from_url(u).rstrip("/") + "/" | |
if url.startswith(prefix): | |
return u | |
def _get_new_credentials(self, original_url, allow_netrc=True, | |
allow_keyring=True): | |
"""Find and return credentials for the specified URL.""" | |
# Split the credentials and netloc from the url. | |
url, netloc, url_user_password = split_auth_netloc_from_url( | |
original_url, | |
) | |
# Start with the credentials embedded in the url | |
username, password = url_user_password | |
if username is not None and password is not None: | |
logger.debug("Found credentials in url for %s", netloc) | |
return url_user_password | |
# Find a matching index url for this request | |
index_url = self._get_index_url(url) | |
if index_url: | |
# Split the credentials from the url. | |
index_info = split_auth_netloc_from_url(index_url) | |
if index_info: | |
index_url, _, index_url_user_password = index_info | |
logger.debug("Found index url %s", index_url) | |
# If an index URL was found, try its embedded credentials | |
if index_url and index_url_user_password[0] is not None: | |
username, password = index_url_user_password | |
if username is not None and password is not None: | |
logger.debug("Found credentials in index url for %s", netloc) | |
return index_url_user_password | |
# Get creds from netrc if we still don't have them | |
if allow_netrc: | |
netrc_auth = get_netrc_auth(original_url) | |
if netrc_auth: | |
logger.debug("Found credentials in netrc for %s", netloc) | |
return netrc_auth | |
# If we don't have a password and keyring is available, use it. | |
if allow_keyring: | |
# The index url is more specific than the netloc, so try it first | |
kr_auth = ( | |
get_keyring_auth(index_url, username) or | |
get_keyring_auth(netloc, username) | |
) | |
if kr_auth: | |
logger.debug("Found credentials in keyring for %s", netloc) | |
return kr_auth | |
return username, password | |
def _get_url_and_credentials(self, original_url): | |
"""Return the credentials to use for the provided URL. | |
If allowed, netrc and keyring may be used to obtain the | |
correct credentials. | |
Returns (url_without_credentials, username, password). Note | |
that even if the original URL contains credentials, this | |
function may return a different username and password. | |
""" | |
url, netloc, _ = split_auth_netloc_from_url(original_url) | |
# Use any stored credentials that we have for this netloc | |
username, password = self.passwords.get(netloc, (None, None)) | |
if username is None and password is None: | |
# No stored credentials. Acquire new credentials without prompting | |
# the user. (e.g. from netrc, keyring, or the URL itself) | |
username, password = self._get_new_credentials(original_url) | |
if username is not None or password is not None: | |
# Convert the username and password if they're None, so that | |
# this netloc will show up as "cached" in the conditional above. | |
# Further, HTTPBasicAuth doesn't accept None, so it makes sense to | |
# cache the value that is going to be used. | |
username = username or "" | |
password = password or "" | |
# Store any acquired credentials. | |
self.passwords[netloc] = (username, password) | |
assert ( | |
# Credentials were found | |
(username is not None and password is not None) or | |
# Credentials were not found | |
(username is None and password is None) | |
), "Could not load credentials from url: {}".format(original_url) | |
return url, username, password | |
def __call__(self, req): | |
# Get credentials for this request | |
url, username, password = self._get_url_and_credentials(req.url) | |
# Set the url of the request to the url without any credentials | |
req.url = url | |
if username is not None and password is not None: | |
# Send the basic auth with this request | |
req = HTTPBasicAuth(username, password)(req) | |
# Attach a hook to handle 401 responses | |
req.register_hook("response", self.handle_401) | |
return req | |
# Factored out to allow for easy patching in tests | |
def _prompt_for_password(self, netloc): | |
username = ask_input("User for {}: ".format(netloc)) | |
if not username: | |
return None, None | |
auth = get_keyring_auth(netloc, username) | |
if auth: | |
return auth[0], auth[1], False | |
password = ask_password("Password: ") | |
return username, password, True | |
# Factored out to allow for easy patching in tests | |
def _should_save_password_to_keyring(self): | |
if not keyring: | |
return False | |
return ask("Save credentials to keyring [y/N]: ", ["y", "n"]) == "y" | |
def handle_401(self, resp, **kwargs): | |
# We only care about 401 responses, anything else we want to just | |
# pass through the actual response | |
if resp.status_code != 401: | |
return resp | |
# We are not able to prompt the user so simply return the response | |
if not self.prompting: | |
return resp | |
parsed = urllib_parse.urlparse(resp.url) | |
# Prompt the user for a new username and password | |
username, password, save = self._prompt_for_password(parsed.netloc) | |
# Store the new username and password to use for future requests | |
self._credentials_to_save = None | |
if username is not None and password is not None: | |
self.passwords[parsed.netloc] = (username, password) | |
# Prompt to save the password to keyring | |
if save and self._should_save_password_to_keyring(): | |
self._credentials_to_save = (parsed.netloc, username, password) | |
# Consume content and release the original connection to allow our new | |
# request to reuse the same one. | |
resp.content | |
resp.raw.release_conn() | |
# Add our new username and password to the request | |
req = HTTPBasicAuth(username or "", password or "")(resp.request) | |
req.register_hook("response", self.warn_on_401) | |
# On successful request, save the credentials that were used to | |
# keyring. (Note that if the user responded "no" above, this member | |
# is not set and nothing will be saved.) | |
if self._credentials_to_save: | |
req.register_hook("response", self.save_credentials) | |
# Send our new request | |
new_resp = resp.connection.send(req, **kwargs) | |
new_resp.history.append(resp) | |
return new_resp | |
def warn_on_401(self, resp, **kwargs): | |
"""Response callback to warn about incorrect credentials.""" | |
if resp.status_code == 401: | |
logger.warning( | |
'401 Error, Credentials not correct for %s', resp.request.url, | |
) | |
def save_credentials(self, resp, **kwargs): | |
"""Response callback to save credentials on success.""" | |
assert keyring is not None, "should never reach here without keyring" | |
if not keyring: | |
return | |
creds = self._credentials_to_save | |
self._credentials_to_save = None | |
if creds and resp.status_code < 400: | |
try: | |
logger.info('Saving credentials to keyring') | |
keyring.set_password(*creds) | |
except Exception: | |
logger.exception('Failed to save credentials') |
"""HTTP cache implementation. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
import os | |
from contextlib import contextmanager | |
from pip._vendor.cachecontrol.cache import BaseCache | |
from pip._vendor.cachecontrol.caches import FileCache | |
from pip._vendor.requests.models import Response | |
from pip._internal.utils.filesystem import adjacent_tmp_file, replace | |
from pip._internal.utils.misc import ensure_dir | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional | |
def is_from_cache(response): | |
# type: (Response) -> bool | |
return getattr(response, "from_cache", False) | |
@contextmanager | |
def suppressed_cache_errors(): | |
"""If we can't access the cache then we can just skip caching and process | |
requests as if caching wasn't enabled. | |
""" | |
try: | |
yield | |
except (OSError, IOError): | |
pass | |
class SafeFileCache(BaseCache): | |
""" | |
A file based cache which is safe to use even when the target directory may | |
not be accessible or writable. | |
""" | |
def __init__(self, directory): | |
# type: (str) -> None | |
assert directory is not None, "Cache directory must not be None." | |
super(SafeFileCache, self).__init__() | |
self.directory = directory | |
def _get_cache_path(self, name): | |
# type: (str) -> str | |
# From cachecontrol.caches.file_cache.FileCache._fn, brought into our | |
# class for backwards-compatibility and to avoid using a non-public | |
# method. | |
hashed = FileCache.encode(name) | |
parts = list(hashed[:5]) + [hashed] | |
return os.path.join(self.directory, *parts) | |
def get(self, key): | |
# type: (str) -> Optional[bytes] | |
path = self._get_cache_path(key) | |
with suppressed_cache_errors(): | |
with open(path, 'rb') as f: | |
return f.read() | |
def set(self, key, value): | |
# type: (str, bytes) -> None | |
path = self._get_cache_path(key) | |
with suppressed_cache_errors(): | |
ensure_dir(os.path.dirname(path)) | |
with adjacent_tmp_file(path) as f: | |
f.write(value) | |
replace(f.name, path) | |
def delete(self, key): | |
# type: (str) -> None | |
path = self._get_cache_path(key) | |
with suppressed_cache_errors(): | |
os.remove(path) |
"""Download files with progress indicators. | |
""" | |
import cgi | |
import logging | |
import mimetypes | |
import os | |
from pip._vendor import requests | |
from pip._vendor.requests.models import CONTENT_CHUNK_SIZE | |
from pip._internal.cli.progress_bars import DownloadProgressProvider | |
from pip._internal.models.index import PyPI | |
from pip._internal.network.cache import is_from_cache | |
from pip._internal.network.utils import response_chunks | |
from pip._internal.utils.misc import ( | |
format_size, | |
redact_auth_from_url, | |
splitext, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Iterable, Optional | |
from pip._vendor.requests.models import Response | |
from pip._internal.models.link import Link | |
from pip._internal.network.session import PipSession | |
logger = logging.getLogger(__name__) | |
def _get_http_response_size(resp): | |
# type: (Response) -> Optional[int] | |
try: | |
return int(resp.headers['content-length']) | |
except (ValueError, KeyError, TypeError): | |
return None | |
def _prepare_download( | |
resp, # type: Response | |
link, # type: Link | |
progress_bar # type: str | |
): | |
# type: (...) -> Iterable[bytes] | |
total_length = _get_http_response_size(resp) | |
if link.netloc == PyPI.file_storage_domain: | |
url = link.show_url | |
else: | |
url = link.url_without_fragment | |
logged_url = redact_auth_from_url(url) | |
if total_length: | |
logged_url = '{} ({})'.format(logged_url, format_size(total_length)) | |
if is_from_cache(resp): | |
logger.info("Using cached %s", logged_url) | |
else: | |
logger.info("Downloading %s", logged_url) | |
if logger.getEffectiveLevel() > logging.INFO: | |
show_progress = False | |
elif is_from_cache(resp): | |
show_progress = False | |
elif not total_length: | |
show_progress = True | |
elif total_length > (40 * 1000): | |
show_progress = True | |
else: | |
show_progress = False | |
chunks = response_chunks(resp, CONTENT_CHUNK_SIZE) | |
if not show_progress: | |
return chunks | |
return DownloadProgressProvider( | |
progress_bar, max=total_length | |
)(chunks) | |
def sanitize_content_filename(filename): | |
# type: (str) -> str | |
""" | |
Sanitize the "filename" value from a Content-Disposition header. | |
""" | |
return os.path.basename(filename) | |
def parse_content_disposition(content_disposition, default_filename): | |
# type: (str, str) -> str | |
""" | |
Parse the "filename" value from a Content-Disposition header, and | |
return the default filename if the result is empty. | |
""" | |
_type, params = cgi.parse_header(content_disposition) | |
filename = params.get('filename') | |
if filename: | |
# We need to sanitize the filename to prevent directory traversal | |
# in case the filename contains ".." path parts. | |
filename = sanitize_content_filename(filename) | |
return filename or default_filename | |
def _get_http_response_filename(resp, link): | |
# type: (Response, Link) -> str | |
"""Get an ideal filename from the given HTTP response, falling back to | |
the link filename if not provided. | |
""" | |
filename = link.filename # fallback | |
# Have a look at the Content-Disposition header for a better guess | |
content_disposition = resp.headers.get('content-disposition') | |
if content_disposition: | |
filename = parse_content_disposition(content_disposition, filename) | |
ext = splitext(filename)[1] # type: Optional[str] | |
if not ext: | |
ext = mimetypes.guess_extension( | |
resp.headers.get('content-type', '') | |
) | |
if ext: | |
filename += ext | |
if not ext and link.url != resp.url: | |
ext = os.path.splitext(resp.url)[1] | |
if ext: | |
filename += ext | |
return filename | |
def _http_get_download(session, link): | |
# type: (PipSession, Link) -> Response | |
target_url = link.url.split('#', 1)[0] | |
resp = session.get( | |
target_url, | |
# We use Accept-Encoding: identity here because requests | |
# defaults to accepting compressed responses. This breaks in | |
# a variety of ways depending on how the server is configured. | |
# - Some servers will notice that the file isn't a compressible | |
# file and will leave the file alone and with an empty | |
# Content-Encoding | |
# - Some servers will notice that the file is already | |
# compressed and will leave the file alone and will add a | |
# Content-Encoding: gzip header | |
# - Some servers won't notice anything at all and will take | |
# a file that's already been compressed and compress it again | |
# and set the Content-Encoding: gzip header | |
# By setting this to request only the identity encoding We're | |
# hoping to eliminate the third case. Hopefully there does not | |
# exist a server which when given a file will notice it is | |
# already compressed and that you're not asking for a | |
# compressed file and will then decompress it before sending | |
# because if that's the case I don't think it'll ever be | |
# possible to make this work. | |
headers={"Accept-Encoding": "identity"}, | |
stream=True, | |
) | |
resp.raise_for_status() | |
return resp | |
class Download(object): | |
def __init__( | |
self, | |
response, # type: Response | |
filename, # type: str | |
chunks, # type: Iterable[bytes] | |
): | |
# type: (...) -> None | |
self.response = response | |
self.filename = filename | |
self.chunks = chunks | |
class Downloader(object): | |
def __init__( | |
self, | |
session, # type: PipSession | |
progress_bar, # type: str | |
): | |
# type: (...) -> None | |
self._session = session | |
self._progress_bar = progress_bar | |
def __call__(self, link): | |
# type: (Link) -> Download | |
try: | |
resp = _http_get_download(self._session, link) | |
except requests.HTTPError as e: | |
logger.critical( | |
"HTTP error %s while getting %s", e.response.status_code, link | |
) | |
raise | |
return Download( | |
resp, | |
_get_http_response_filename(resp, link), | |
_prepare_download(resp, link, self._progress_bar), | |
) |
"""PipSession and supporting code, containing all pip-specific | |
network request configuration and behavior. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
import email.utils | |
import json | |
import logging | |
import mimetypes | |
import os | |
import platform | |
import sys | |
import warnings | |
from pip._vendor import requests, six, urllib3 | |
from pip._vendor.cachecontrol import CacheControlAdapter | |
from pip._vendor.requests.adapters import BaseAdapter, HTTPAdapter | |
from pip._vendor.requests.models import Response | |
from pip._vendor.requests.structures import CaseInsensitiveDict | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._vendor.urllib3.exceptions import InsecureRequestWarning | |
from pip import __version__ | |
from pip._internal.network.auth import MultiDomainBasicAuth | |
from pip._internal.network.cache import SafeFileCache | |
# Import ssl from compat so the initial import occurs in only one place. | |
from pip._internal.utils.compat import has_tls, ipaddress | |
from pip._internal.utils.glibc import libc_ver | |
from pip._internal.utils.misc import ( | |
build_url_from_netloc, | |
get_installed_version, | |
parse_netloc, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import url_to_path | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Iterator, List, Optional, Tuple, Union, | |
) | |
from pip._internal.models.link import Link | |
SecureOrigin = Tuple[str, str, Optional[Union[int, str]]] | |
logger = logging.getLogger(__name__) | |
# Ignore warning raised when using --trusted-host. | |
warnings.filterwarnings("ignore", category=InsecureRequestWarning) | |
SECURE_ORIGINS = [ | |
# protocol, hostname, port | |
# Taken from Chrome's list of secure origins (See: http://bit.ly/1qrySKC) | |
("https", "*", "*"), | |
("*", "localhost", "*"), | |
("*", "127.0.0.0/8", "*"), | |
("*", "::1/128", "*"), | |
("file", "*", None), | |
# ssh is always secure. | |
("ssh", "*", "*"), | |
] # type: List[SecureOrigin] | |
# These are environment variables present when running under various | |
# CI systems. For each variable, some CI systems that use the variable | |
# are indicated. The collection was chosen so that for each of a number | |
# of popular systems, at least one of the environment variables is used. | |
# This list is used to provide some indication of and lower bound for | |
# CI traffic to PyPI. Thus, it is okay if the list is not comprehensive. | |
# For more background, see: https://github.com/pypa/pip/issues/5499 | |
CI_ENVIRONMENT_VARIABLES = ( | |
# Azure Pipelines | |
'BUILD_BUILDID', | |
# Jenkins | |
'BUILD_ID', | |
# AppVeyor, CircleCI, Codeship, Gitlab CI, Shippable, Travis CI | |
'CI', | |
# Explicit environment variable. | |
'PIP_IS_CI', | |
) | |
def looks_like_ci(): | |
# type: () -> bool | |
""" | |
Return whether it looks like pip is running under CI. | |
""" | |
# We don't use the method of checking for a tty (e.g. using isatty()) | |
# because some CI systems mimic a tty (e.g. Travis CI). Thus that | |
# method doesn't provide definitive information in either direction. | |
return any(name in os.environ for name in CI_ENVIRONMENT_VARIABLES) | |
def user_agent(): | |
""" | |
Return a string representing the user agent. | |
""" | |
data = { | |
"installer": {"name": "pip", "version": __version__}, | |
"python": platform.python_version(), | |
"implementation": { | |
"name": platform.python_implementation(), | |
}, | |
} | |
if data["implementation"]["name"] == 'CPython': | |
data["implementation"]["version"] = platform.python_version() | |
elif data["implementation"]["name"] == 'PyPy': | |
if sys.pypy_version_info.releaselevel == 'final': | |
pypy_version_info = sys.pypy_version_info[:3] | |
else: | |
pypy_version_info = sys.pypy_version_info | |
data["implementation"]["version"] = ".".join( | |
[str(x) for x in pypy_version_info] | |
) | |
elif data["implementation"]["name"] == 'Jython': | |
# Complete Guess | |
data["implementation"]["version"] = platform.python_version() | |
elif data["implementation"]["name"] == 'IronPython': | |
# Complete Guess | |
data["implementation"]["version"] = platform.python_version() | |
if sys.platform.startswith("linux"): | |
from pip._vendor import distro | |
distro_infos = dict(filter( | |
lambda x: x[1], | |
zip(["name", "version", "id"], distro.linux_distribution()), | |
)) | |
libc = dict(filter( | |
lambda x: x[1], | |
zip(["lib", "version"], libc_ver()), | |
)) | |
if libc: | |
distro_infos["libc"] = libc | |
if distro_infos: | |
data["distro"] = distro_infos | |
if sys.platform.startswith("darwin") and platform.mac_ver()[0]: | |
data["distro"] = {"name": "macOS", "version": platform.mac_ver()[0]} | |
if platform.system(): | |
data.setdefault("system", {})["name"] = platform.system() | |
if platform.release(): | |
data.setdefault("system", {})["release"] = platform.release() | |
if platform.machine(): | |
data["cpu"] = platform.machine() | |
if has_tls(): | |
import _ssl as ssl | |
data["openssl_version"] = ssl.OPENSSL_VERSION | |
setuptools_version = get_installed_version("setuptools") | |
if setuptools_version is not None: | |
data["setuptools_version"] = setuptools_version | |
# Use None rather than False so as not to give the impression that | |
# pip knows it is not being run under CI. Rather, it is a null or | |
# inconclusive result. Also, we include some value rather than no | |
# value to make it easier to know that the check has been run. | |
data["ci"] = True if looks_like_ci() else None | |
user_data = os.environ.get("PIP_USER_AGENT_USER_DATA") | |
if user_data is not None: | |
data["user_data"] = user_data | |
return "{data[installer][name]}/{data[installer][version]} {json}".format( | |
data=data, | |
json=json.dumps(data, separators=(",", ":"), sort_keys=True), | |
) | |
class LocalFSAdapter(BaseAdapter): | |
def send(self, request, stream=None, timeout=None, verify=None, cert=None, | |
proxies=None): | |
pathname = url_to_path(request.url) | |
resp = Response() | |
resp.status_code = 200 | |
resp.url = request.url | |
try: | |
stats = os.stat(pathname) | |
except OSError as exc: | |
resp.status_code = 404 | |
resp.raw = exc | |
else: | |
modified = email.utils.formatdate(stats.st_mtime, usegmt=True) | |
content_type = mimetypes.guess_type(pathname)[0] or "text/plain" | |
resp.headers = CaseInsensitiveDict({ | |
"Content-Type": content_type, | |
"Content-Length": stats.st_size, | |
"Last-Modified": modified, | |
}) | |
resp.raw = open(pathname, "rb") | |
resp.close = resp.raw.close | |
return resp | |
def close(self): | |
pass | |
class InsecureHTTPAdapter(HTTPAdapter): | |
def cert_verify(self, conn, url, verify, cert): | |
super(InsecureHTTPAdapter, self).cert_verify( | |
conn=conn, url=url, verify=False, cert=cert | |
) | |
class InsecureCacheControlAdapter(CacheControlAdapter): | |
def cert_verify(self, conn, url, verify, cert): | |
super(InsecureCacheControlAdapter, self).cert_verify( | |
conn=conn, url=url, verify=False, cert=cert | |
) | |
class PipSession(requests.Session): | |
timeout = None # type: Optional[int] | |
def __init__(self, *args, **kwargs): | |
""" | |
:param trusted_hosts: Domains not to emit warnings for when not using | |
HTTPS. | |
""" | |
retries = kwargs.pop("retries", 0) | |
cache = kwargs.pop("cache", None) | |
trusted_hosts = kwargs.pop("trusted_hosts", []) # type: List[str] | |
index_urls = kwargs.pop("index_urls", None) | |
super(PipSession, self).__init__(*args, **kwargs) | |
# Namespace the attribute with "pip_" just in case to prevent | |
# possible conflicts with the base class. | |
self.pip_trusted_origins = [] # type: List[Tuple[str, Optional[int]]] | |
# Attach our User Agent to the request | |
self.headers["User-Agent"] = user_agent() | |
# Attach our Authentication handler to the session | |
self.auth = MultiDomainBasicAuth(index_urls=index_urls) | |
# Create our urllib3.Retry instance which will allow us to customize | |
# how we handle retries. | |
retries = urllib3.Retry( | |
# Set the total number of retries that a particular request can | |
# have. | |
total=retries, | |
# A 503 error from PyPI typically means that the Fastly -> Origin | |
# connection got interrupted in some way. A 503 error in general | |
# is typically considered a transient error so we'll go ahead and | |
# retry it. | |
# A 500 may indicate transient error in Amazon S3 | |
# A 520 or 527 - may indicate transient error in CloudFlare | |
status_forcelist=[500, 503, 520, 527], | |
# Add a small amount of back off between failed requests in | |
# order to prevent hammering the service. | |
backoff_factor=0.25, | |
) | |
# Our Insecure HTTPAdapter disables HTTPS validation. It does not | |
# support caching so we'll use it for all http:// URLs. | |
# If caching is disabled, we will also use it for | |
# https:// hosts that we've marked as ignoring | |
# TLS errors for (trusted-hosts). | |
insecure_adapter = InsecureHTTPAdapter(max_retries=retries) | |
# We want to _only_ cache responses on securely fetched origins or when | |
# the host is specified as trusted. We do this because | |
# we can't validate the response of an insecurely/untrusted fetched | |
# origin, and we don't want someone to be able to poison the cache and | |
# require manual eviction from the cache to fix it. | |
if cache: | |
secure_adapter = CacheControlAdapter( | |
cache=SafeFileCache(cache), | |
max_retries=retries, | |
) | |
self._trusted_host_adapter = InsecureCacheControlAdapter( | |
cache=SafeFileCache(cache), | |
max_retries=retries, | |
) | |
else: | |
secure_adapter = HTTPAdapter(max_retries=retries) | |
self._trusted_host_adapter = insecure_adapter | |
self.mount("https://", secure_adapter) | |
self.mount("http://", insecure_adapter) | |
# Enable file:// urls | |
self.mount("file://", LocalFSAdapter()) | |
for host in trusted_hosts: | |
self.add_trusted_host(host, suppress_logging=True) | |
def add_trusted_host(self, host, source=None, suppress_logging=False): | |
# type: (str, Optional[str], bool) -> None | |
""" | |
:param host: It is okay to provide a host that has previously been | |
added. | |
:param source: An optional source string, for logging where the host | |
string came from. | |
""" | |
if not suppress_logging: | |
msg = 'adding trusted host: {!r}'.format(host) | |
if source is not None: | |
msg += ' (from {})'.format(source) | |
logger.info(msg) | |
host_port = parse_netloc(host) | |
if host_port not in self.pip_trusted_origins: | |
self.pip_trusted_origins.append(host_port) | |
self.mount( | |
build_url_from_netloc(host) + '/', | |
self._trusted_host_adapter | |
) | |
if not host_port[1]: | |
# Mount wildcard ports for the same host. | |
self.mount( | |
build_url_from_netloc(host) + ':', | |
self._trusted_host_adapter | |
) | |
def iter_secure_origins(self): | |
# type: () -> Iterator[SecureOrigin] | |
for secure_origin in SECURE_ORIGINS: | |
yield secure_origin | |
for host, port in self.pip_trusted_origins: | |
yield ('*', host, '*' if port is None else port) | |
def is_secure_origin(self, location): | |
# type: (Link) -> bool | |
# Determine if this url used a secure transport mechanism | |
parsed = urllib_parse.urlparse(str(location)) | |
origin_protocol, origin_host, origin_port = ( | |
parsed.scheme, parsed.hostname, parsed.port, | |
) | |
# The protocol to use to see if the protocol matches. | |
# Don't count the repository type as part of the protocol: in | |
# cases such as "git+ssh", only use "ssh". (I.e., Only verify against | |
# the last scheme.) | |
origin_protocol = origin_protocol.rsplit('+', 1)[-1] | |
# Determine if our origin is a secure origin by looking through our | |
# hardcoded list of secure origins, as well as any additional ones | |
# configured on this PackageFinder instance. | |
for secure_origin in self.iter_secure_origins(): | |
secure_protocol, secure_host, secure_port = secure_origin | |
if origin_protocol != secure_protocol and secure_protocol != "*": | |
continue | |
try: | |
addr = ipaddress.ip_address( | |
None | |
if origin_host is None | |
else six.ensure_text(origin_host) | |
) | |
network = ipaddress.ip_network( | |
six.ensure_text(secure_host) | |
) | |
except ValueError: | |
# We don't have both a valid address or a valid network, so | |
# we'll check this origin against hostnames. | |
if ( | |
origin_host and | |
origin_host.lower() != secure_host.lower() and | |
secure_host != "*" | |
): | |
continue | |
else: | |
# We have a valid address and network, so see if the address | |
# is contained within the network. | |
if addr not in network: | |
continue | |
# Check to see if the port matches. | |
if ( | |
origin_port != secure_port and | |
secure_port != "*" and | |
secure_port is not None | |
): | |
continue | |
# If we've gotten here, then this origin matches the current | |
# secure origin and we should return True | |
return True | |
# If we've gotten to this point, then the origin isn't secure and we | |
# will not accept it as a valid location to search. We will however | |
# log a warning that we are ignoring it. | |
logger.warning( | |
"The repository located at %s is not a trusted or secure host and " | |
"is being ignored. If this repository is available via HTTPS we " | |
"recommend you use HTTPS instead, otherwise you may silence " | |
"this warning and allow it anyway with '--trusted-host %s'.", | |
origin_host, | |
origin_host, | |
) | |
return False | |
def request(self, method, url, *args, **kwargs): | |
# Allow setting a default timeout on a session | |
kwargs.setdefault("timeout", self.timeout) | |
# Dispatch the actual request | |
return super(PipSession, self).request(method, url, *args, **kwargs) |
from pip._vendor.requests.models import CONTENT_CHUNK_SIZE, Response | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Iterator | |
def response_chunks(response, chunk_size=CONTENT_CHUNK_SIZE): | |
# type: (Response, int) -> Iterator[bytes] | |
"""Given a requests Response, provide the data chunks. | |
""" | |
try: | |
# Special case for urllib3. | |
for chunk in response.raw.stream( | |
chunk_size, | |
# We use decode_content=False here because we don't | |
# want urllib3 to mess with the raw bytes we get | |
# from the server. If we decompress inside of | |
# urllib3 then we cannot verify the checksum | |
# because the checksum will be of the compressed | |
# file. This breakage will only occur if the | |
# server adds a Content-Encoding header, which | |
# depends on how the server was configured: | |
# - Some servers will notice that the file isn't a | |
# compressible file and will leave the file alone | |
# and with an empty Content-Encoding | |
# - Some servers will notice that the file is | |
# already compressed and will leave the file | |
# alone and will add a Content-Encoding: gzip | |
# header | |
# - Some servers won't notice anything at all and | |
# will take a file that's already been compressed | |
# and compress it again and set the | |
# Content-Encoding: gzip header | |
# | |
# By setting this not to decode automatically we | |
# hope to eliminate problems with the second case. | |
decode_content=False, | |
): | |
yield chunk | |
except AttributeError: | |
# Standard file-like object. | |
while True: | |
chunk = response.raw.read(chunk_size) | |
if not chunk: | |
break | |
yield chunk |
"""xmlrpclib.Transport implementation | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
import logging | |
from pip._vendor import requests | |
# NOTE: XMLRPC Client is not annotated in typeshed as on 2017-07-17, which is | |
# why we ignore the type on this import | |
from pip._vendor.six.moves import xmlrpc_client # type: ignore | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
logger = logging.getLogger(__name__) | |
class PipXmlrpcTransport(xmlrpc_client.Transport): | |
"""Provide a `xmlrpclib.Transport` implementation via a `PipSession` | |
object. | |
""" | |
def __init__(self, index_url, session, use_datetime=False): | |
xmlrpc_client.Transport.__init__(self, use_datetime) | |
index_parts = urllib_parse.urlparse(index_url) | |
self._scheme = index_parts.scheme | |
self._session = session | |
def request(self, host, handler, request_body, verbose=False): | |
parts = (self._scheme, host, handler, None, None, None) | |
url = urllib_parse.urlunparse(parts) | |
try: | |
headers = {'Content-Type': 'text/xml'} | |
response = self._session.post(url, data=request_body, | |
headers=headers, stream=True) | |
response.raise_for_status() | |
self.verbose = verbose | |
return self.parse_response(response.raw) | |
except requests.HTTPError as exc: | |
logger.critical( | |
"HTTP error %s while getting %s", | |
exc.response.status_code, url, | |
) | |
raise |
"""Metadata generation logic for source distributions. | |
""" | |
import logging | |
import os | |
from pip._internal.utils.subprocess import runner_with_spinner_message | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from pip._internal.build_env import BuildEnvironment | |
from pip._vendor.pep517.wrappers import Pep517HookCaller | |
logger = logging.getLogger(__name__) | |
def generate_metadata(build_env, backend): | |
# type: (BuildEnvironment, Pep517HookCaller) -> str | |
"""Generate metadata using mechanisms described in PEP 517. | |
Returns the generated metadata directory. | |
""" | |
metadata_tmpdir = TempDirectory( | |
kind="modern-metadata", globally_managed=True | |
) | |
metadata_dir = metadata_tmpdir.path | |
with build_env: | |
# Note that Pep517HookCaller implements a fallback for | |
# prepare_metadata_for_build_wheel, so we don't have to | |
# consider the possibility that this hook doesn't exist. | |
runner = runner_with_spinner_message("Preparing wheel metadata") | |
with backend.subprocess_runner(runner): | |
distinfo_dir = backend.prepare_metadata_for_build_wheel( | |
metadata_dir | |
) | |
return os.path.join(metadata_dir, distinfo_dir) |
"""Metadata generation logic for legacy source distributions. | |
""" | |
import logging | |
import os | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.utils.setuptools_build import make_setuptools_egg_info_args | |
from pip._internal.utils.subprocess import call_subprocess | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from pip._internal.build_env import BuildEnvironment | |
logger = logging.getLogger(__name__) | |
def _find_egg_info(directory): | |
# type: (str) -> str | |
"""Find an .egg-info subdirectory in `directory`. | |
""" | |
filenames = [ | |
f for f in os.listdir(directory) if f.endswith(".egg-info") | |
] | |
if not filenames: | |
raise InstallationError( | |
"No .egg-info directory found in {}".format(directory) | |
) | |
if len(filenames) > 1: | |
raise InstallationError( | |
"More than one .egg-info directory found in {}".format( | |
directory | |
) | |
) | |
return os.path.join(directory, filenames[0]) | |
def generate_metadata( | |
build_env, # type: BuildEnvironment | |
setup_py_path, # type: str | |
source_dir, # type: str | |
isolated, # type: bool | |
details, # type: str | |
): | |
# type: (...) -> str | |
"""Generate metadata using setup.py-based defacto mechanisms. | |
Returns the generated metadata directory. | |
""" | |
logger.debug( | |
'Running setup.py (path:%s) egg_info for package %s', | |
setup_py_path, details, | |
) | |
egg_info_dir = TempDirectory( | |
kind="pip-egg-info", globally_managed=True | |
).path | |
args = make_setuptools_egg_info_args( | |
setup_py_path, | |
egg_info_dir=egg_info_dir, | |
no_user_config=isolated, | |
) | |
with build_env: | |
call_subprocess( | |
args, | |
cwd=source_dir, | |
command_desc='python setup.py egg_info', | |
) | |
# Return the .egg-info directory. | |
return _find_egg_info(egg_info_dir) |
import logging | |
import os | |
from pip._internal.utils.subprocess import runner_with_spinner_message | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional | |
from pip._vendor.pep517.wrappers import Pep517HookCaller | |
logger = logging.getLogger(__name__) | |
def build_wheel_pep517( | |
name, # type: str | |
backend, # type: Pep517HookCaller | |
metadata_directory, # type: str | |
build_options, # type: List[str] | |
tempd, # type: str | |
): | |
# type: (...) -> Optional[str] | |
"""Build one InstallRequirement using the PEP 517 build process. | |
Returns path to wheel if successfully built. Otherwise, returns None. | |
""" | |
assert metadata_directory is not None | |
if build_options: | |
# PEP 517 does not support --build-options | |
logger.error('Cannot build wheel for %s using PEP 517 when ' | |
'--build-option is present' % (name,)) | |
return None | |
try: | |
logger.debug('Destination directory: %s', tempd) | |
runner = runner_with_spinner_message( | |
'Building wheel for {} (PEP 517)'.format(name) | |
) | |
with backend.subprocess_runner(runner): | |
wheel_name = backend.build_wheel( | |
tempd, | |
metadata_directory=metadata_directory, | |
) | |
except Exception: | |
logger.error('Failed building wheel for %s', name) | |
return None | |
return os.path.join(tempd, wheel_name) |
import logging | |
import os.path | |
from pip._internal.cli.spinners import open_spinner | |
from pip._internal.utils.setuptools_build import ( | |
make_setuptools_bdist_wheel_args, | |
) | |
from pip._internal.utils.subprocess import ( | |
LOG_DIVIDER, | |
call_subprocess, | |
format_command_args, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional, Text | |
logger = logging.getLogger(__name__) | |
def format_command_result( | |
command_args, # type: List[str] | |
command_output, # type: Text | |
): | |
# type: (...) -> str | |
"""Format command information for logging.""" | |
command_desc = format_command_args(command_args) | |
text = 'Command arguments: {}\n'.format(command_desc) | |
if not command_output: | |
text += 'Command output: None' | |
elif logger.getEffectiveLevel() > logging.DEBUG: | |
text += 'Command output: [use --verbose to show]' | |
else: | |
if not command_output.endswith('\n'): | |
command_output += '\n' | |
text += 'Command output:\n{}{}'.format(command_output, LOG_DIVIDER) | |
return text | |
def get_legacy_build_wheel_path( | |
names, # type: List[str] | |
temp_dir, # type: str | |
name, # type: str | |
command_args, # type: List[str] | |
command_output, # type: Text | |
): | |
# type: (...) -> Optional[str] | |
"""Return the path to the wheel in the temporary build directory.""" | |
# Sort for determinism. | |
names = sorted(names) | |
if not names: | |
msg = ( | |
'Legacy build of wheel for {!r} created no files.\n' | |
).format(name) | |
msg += format_command_result(command_args, command_output) | |
logger.warning(msg) | |
return None | |
if len(names) > 1: | |
msg = ( | |
'Legacy build of wheel for {!r} created more than one file.\n' | |
'Filenames (choosing first): {}\n' | |
).format(name, names) | |
msg += format_command_result(command_args, command_output) | |
logger.warning(msg) | |
return os.path.join(temp_dir, names[0]) | |
def build_wheel_legacy( | |
name, # type: str | |
setup_py_path, # type: str | |
source_dir, # type: str | |
global_options, # type: List[str] | |
build_options, # type: List[str] | |
tempd, # type: str | |
): | |
# type: (...) -> Optional[str] | |
"""Build one unpacked package using the "legacy" build process. | |
Returns path to wheel if successfully built. Otherwise, returns None. | |
""" | |
wheel_args = make_setuptools_bdist_wheel_args( | |
setup_py_path, | |
global_options=global_options, | |
build_options=build_options, | |
destination_dir=tempd, | |
) | |
spin_message = 'Building wheel for {} (setup.py)'.format(name) | |
with open_spinner(spin_message) as spinner: | |
logger.debug('Destination directory: %s', tempd) | |
try: | |
output = call_subprocess( | |
wheel_args, | |
cwd=source_dir, | |
spinner=spinner, | |
) | |
except Exception: | |
spinner.finish("error") | |
logger.error('Failed building wheel for %s', name) | |
return None | |
names = os.listdir(tempd) | |
wheel_path = get_legacy_build_wheel_path( | |
names=names, | |
temp_dir=tempd, | |
name=name, | |
command_args=wheel_args, | |
command_output=output, | |
) | |
return wheel_path |
"""Validation of dependencies of packages | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
# mypy: disallow-untyped-defs=False | |
import logging | |
from collections import namedtuple | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.pkg_resources import RequirementParseError | |
from pip._internal.distributions import ( | |
make_distribution_for_install_requirement, | |
) | |
from pip._internal.utils.misc import get_installed_distributions | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
logger = logging.getLogger(__name__) | |
if MYPY_CHECK_RUNNING: | |
from pip._internal.req.req_install import InstallRequirement | |
from typing import ( | |
Any, Callable, Dict, Optional, Set, Tuple, List | |
) | |
# Shorthands | |
PackageSet = Dict[str, 'PackageDetails'] | |
Missing = Tuple[str, Any] | |
Conflicting = Tuple[str, str, Any] | |
MissingDict = Dict[str, List[Missing]] | |
ConflictingDict = Dict[str, List[Conflicting]] | |
CheckResult = Tuple[MissingDict, ConflictingDict] | |
PackageDetails = namedtuple('PackageDetails', ['version', 'requires']) | |
def create_package_set_from_installed(**kwargs): | |
# type: (**Any) -> Tuple[PackageSet, bool] | |
"""Converts a list of distributions into a PackageSet. | |
""" | |
# Default to using all packages installed on the system | |
if kwargs == {}: | |
kwargs = {"local_only": False, "skip": ()} | |
package_set = {} | |
problems = False | |
for dist in get_installed_distributions(**kwargs): | |
name = canonicalize_name(dist.project_name) | |
try: | |
package_set[name] = PackageDetails(dist.version, dist.requires()) | |
except RequirementParseError as e: | |
# Don't crash on broken metadata | |
logger.warning("Error parsing requirements for %s: %s", name, e) | |
problems = True | |
return package_set, problems | |
def check_package_set(package_set, should_ignore=None): | |
# type: (PackageSet, Optional[Callable[[str], bool]]) -> CheckResult | |
"""Check if a package set is consistent | |
If should_ignore is passed, it should be a callable that takes a | |
package name and returns a boolean. | |
""" | |
if should_ignore is None: | |
def should_ignore(name): | |
return False | |
missing = {} | |
conflicting = {} | |
for package_name in package_set: | |
# Info about dependencies of package_name | |
missing_deps = set() # type: Set[Missing] | |
conflicting_deps = set() # type: Set[Conflicting] | |
if should_ignore(package_name): | |
continue | |
for req in package_set[package_name].requires: | |
name = canonicalize_name(req.project_name) # type: str | |
# Check if it's missing | |
if name not in package_set: | |
missed = True | |
if req.marker is not None: | |
missed = req.marker.evaluate() | |
if missed: | |
missing_deps.add((name, req)) | |
continue | |
# Check if there's a conflict | |
version = package_set[name].version # type: str | |
if not req.specifier.contains(version, prereleases=True): | |
conflicting_deps.add((name, version, req)) | |
if missing_deps: | |
missing[package_name] = sorted(missing_deps, key=str) | |
if conflicting_deps: | |
conflicting[package_name] = sorted(conflicting_deps, key=str) | |
return missing, conflicting | |
def check_install_conflicts(to_install): | |
# type: (List[InstallRequirement]) -> Tuple[PackageSet, CheckResult] | |
"""For checking if the dependency graph would be consistent after \ | |
installing given requirements | |
""" | |
# Start from the current state | |
package_set, _ = create_package_set_from_installed() | |
# Install packages | |
would_be_installed = _simulate_installation_of(to_install, package_set) | |
# Only warn about directly-dependent packages; create a whitelist of them | |
whitelist = _create_whitelist(would_be_installed, package_set) | |
return ( | |
package_set, | |
check_package_set( | |
package_set, should_ignore=lambda name: name not in whitelist | |
) | |
) | |
def _simulate_installation_of(to_install, package_set): | |
# type: (List[InstallRequirement], PackageSet) -> Set[str] | |
"""Computes the version of packages after installing to_install. | |
""" | |
# Keep track of packages that were installed | |
installed = set() | |
# Modify it as installing requirement_set would (assuming no errors) | |
for inst_req in to_install: | |
abstract_dist = make_distribution_for_install_requirement(inst_req) | |
dist = abstract_dist.get_pkg_resources_distribution() | |
name = canonicalize_name(dist.key) | |
package_set[name] = PackageDetails(dist.version, dist.requires()) | |
installed.add(name) | |
return installed | |
def _create_whitelist(would_be_installed, package_set): | |
# type: (Set[str], PackageSet) -> Set[str] | |
packages_affected = set(would_be_installed) | |
for package_name in package_set: | |
if package_name in packages_affected: | |
continue | |
for req in package_set[package_name].requires: | |
if canonicalize_name(req.name) in packages_affected: | |
packages_affected.add(package_name) | |
break | |
return packages_affected |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import collections | |
import logging | |
import os | |
from pip._vendor import six | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.pkg_resources import RequirementParseError | |
from pip._internal.exceptions import BadCommand, InstallationError | |
from pip._internal.req.constructors import ( | |
install_req_from_editable, | |
install_req_from_line, | |
) | |
from pip._internal.req.req_file import COMMENT_RE | |
from pip._internal.utils.direct_url_helpers import ( | |
direct_url_as_pep440_direct_reference, | |
dist_get_direct_url, | |
) | |
from pip._internal.utils.misc import ( | |
dist_is_editable, | |
get_installed_distributions, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Iterator, Optional, List, Container, Set, Dict, Tuple, Iterable, Union | |
) | |
from pip._internal.cache import WheelCache | |
from pip._vendor.pkg_resources import ( | |
Distribution, Requirement | |
) | |
RequirementInfo = Tuple[Optional[Union[str, Requirement]], bool, List[str]] | |
logger = logging.getLogger(__name__) | |
def freeze( | |
requirement=None, # type: Optional[List[str]] | |
find_links=None, # type: Optional[List[str]] | |
local_only=None, # type: Optional[bool] | |
user_only=None, # type: Optional[bool] | |
paths=None, # type: Optional[List[str]] | |
isolated=False, # type: bool | |
wheel_cache=None, # type: Optional[WheelCache] | |
exclude_editable=False, # type: bool | |
skip=() # type: Container[str] | |
): | |
# type: (...) -> Iterator[str] | |
find_links = find_links or [] | |
for link in find_links: | |
yield '-f {}'.format(link) | |
installations = {} # type: Dict[str, FrozenRequirement] | |
for dist in get_installed_distributions(local_only=local_only, | |
skip=(), | |
user_only=user_only, | |
paths=paths): | |
try: | |
req = FrozenRequirement.from_dist(dist) | |
except RequirementParseError as exc: | |
# We include dist rather than dist.project_name because the | |
# dist string includes more information, like the version and | |
# location. We also include the exception message to aid | |
# troubleshooting. | |
logger.warning( | |
'Could not generate requirement for distribution %r: %s', | |
dist, exc | |
) | |
continue | |
if exclude_editable and req.editable: | |
continue | |
installations[req.canonical_name] = req | |
if requirement: | |
# the options that don't get turned into an InstallRequirement | |
# should only be emitted once, even if the same option is in multiple | |
# requirements files, so we need to keep track of what has been emitted | |
# so that we don't emit it again if it's seen again | |
emitted_options = set() # type: Set[str] | |
# keep track of which files a requirement is in so that we can | |
# give an accurate warning if a requirement appears multiple times. | |
req_files = collections.defaultdict(list) # type: Dict[str, List[str]] | |
for req_file_path in requirement: | |
with open(req_file_path) as req_file: | |
for line in req_file: | |
if (not line.strip() or | |
line.strip().startswith('#') or | |
line.startswith(( | |
'-r', '--requirement', | |
'-Z', '--always-unzip', | |
'-f', '--find-links', | |
'-i', '--index-url', | |
'--pre', | |
'--trusted-host', | |
'--process-dependency-links', | |
'--extra-index-url'))): | |
line = line.rstrip() | |
if line not in emitted_options: | |
emitted_options.add(line) | |
yield line | |
continue | |
if line.startswith('-e') or line.startswith('--editable'): | |
if line.startswith('-e'): | |
line = line[2:].strip() | |
else: | |
line = line[len('--editable'):].strip().lstrip('=') | |
line_req = install_req_from_editable( | |
line, | |
isolated=isolated, | |
) | |
else: | |
line_req = install_req_from_line( | |
COMMENT_RE.sub('', line).strip(), | |
isolated=isolated, | |
) | |
if not line_req.name: | |
logger.info( | |
"Skipping line in requirement file [%s] because " | |
"it's not clear what it would install: %s", | |
req_file_path, line.strip(), | |
) | |
logger.info( | |
" (add #egg=PackageName to the URL to avoid" | |
" this warning)" | |
) | |
else: | |
line_req_canonical_name = canonicalize_name( | |
line_req.name) | |
if line_req_canonical_name not in installations: | |
# either it's not installed, or it is installed | |
# but has been processed already | |
if not req_files[line_req.name]: | |
logger.warning( | |
"Requirement file [%s] contains %s, but " | |
"package %r is not installed", | |
req_file_path, | |
COMMENT_RE.sub('', line).strip(), | |
line_req.name | |
) | |
else: | |
req_files[line_req.name].append(req_file_path) | |
else: | |
yield str(installations[ | |
line_req_canonical_name]).rstrip() | |
del installations[line_req_canonical_name] | |
req_files[line_req.name].append(req_file_path) | |
# Warn about requirements that were included multiple times (in a | |
# single requirements file or in different requirements files). | |
for name, files in six.iteritems(req_files): | |
if len(files) > 1: | |
logger.warning("Requirement %s included multiple times [%s]", | |
name, ', '.join(sorted(set(files)))) | |
yield( | |
'## The following requirements were added by ' | |
'pip freeze:' | |
) | |
for installation in sorted( | |
installations.values(), key=lambda x: x.name.lower()): | |
if installation.canonical_name not in skip: | |
yield str(installation).rstrip() | |
def get_requirement_info(dist): | |
# type: (Distribution) -> RequirementInfo | |
""" | |
Compute and return values (req, editable, comments) for use in | |
FrozenRequirement.from_dist(). | |
""" | |
if not dist_is_editable(dist): | |
return (None, False, []) | |
location = os.path.normcase(os.path.abspath(dist.location)) | |
from pip._internal.vcs import vcs, RemoteNotFoundError | |
vcs_backend = vcs.get_backend_for_dir(location) | |
if vcs_backend is None: | |
req = dist.as_requirement() | |
logger.debug( | |
'No VCS found for editable requirement "%s" in: %r', req, | |
location, | |
) | |
comments = [ | |
'# Editable install with no version control ({})'.format(req) | |
] | |
return (location, True, comments) | |
try: | |
req = vcs_backend.get_src_requirement(location, dist.project_name) | |
except RemoteNotFoundError: | |
req = dist.as_requirement() | |
comments = [ | |
'# Editable {} install with no remote ({})'.format( | |
type(vcs_backend).__name__, req, | |
) | |
] | |
return (location, True, comments) | |
except BadCommand: | |
logger.warning( | |
'cannot determine version of editable source in %s ' | |
'(%s command not found in path)', | |
location, | |
vcs_backend.name, | |
) | |
return (None, True, []) | |
except InstallationError as exc: | |
logger.warning( | |
"Error when trying to get requirement for VCS system %s, " | |
"falling back to uneditable format", exc | |
) | |
else: | |
if req is not None: | |
return (req, True, []) | |
logger.warning( | |
'Could not determine repository location of %s', location | |
) | |
comments = ['## !! Could not determine repository location'] | |
return (None, False, comments) | |
class FrozenRequirement(object): | |
def __init__(self, name, req, editable, comments=()): | |
# type: (str, Union[str, Requirement], bool, Iterable[str]) -> None | |
self.name = name | |
self.canonical_name = canonicalize_name(name) | |
self.req = req | |
self.editable = editable | |
self.comments = comments | |
@classmethod | |
def from_dist(cls, dist): | |
# type: (Distribution) -> FrozenRequirement | |
# TODO `get_requirement_info` is taking care of editable requirements. | |
# TODO This should be refactored when we will add detection of | |
# editable that provide .dist-info metadata. | |
req, editable, comments = get_requirement_info(dist) | |
if req is None and not editable: | |
# if PEP 610 metadata is present, attempt to use it | |
direct_url = dist_get_direct_url(dist) | |
if direct_url: | |
req = direct_url_as_pep440_direct_reference( | |
direct_url, dist.project_name | |
) | |
comments = [] | |
if req is None: | |
# name==version requirement | |
req = dist.as_requirement() | |
return cls(dist.project_name, req, editable, comments=comments) | |
def __str__(self): | |
req = self.req | |
if self.editable: | |
req = '-e {}'.format(req) | |
return '\n'.join(list(self.comments) + [str(req)]) + '\n' |
"""For modules related to installing packages. | |
""" |
"""Legacy editable installation process, i.e. `setup.py develop`. | |
""" | |
import logging | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.setuptools_build import make_setuptools_develop_args | |
from pip._internal.utils.subprocess import call_subprocess | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional, Sequence | |
from pip._internal.build_env import BuildEnvironment | |
logger = logging.getLogger(__name__) | |
def install_editable( | |
install_options, # type: List[str] | |
global_options, # type: Sequence[str] | |
prefix, # type: Optional[str] | |
home, # type: Optional[str] | |
use_user_site, # type: bool | |
name, # type: str | |
setup_py_path, # type: str | |
isolated, # type: bool | |
build_env, # type: BuildEnvironment | |
unpacked_source_directory, # type: str | |
): | |
# type: (...) -> None | |
"""Install a package in editable mode. Most arguments are pass-through | |
to setuptools. | |
""" | |
logger.info('Running setup.py develop for %s', name) | |
args = make_setuptools_develop_args( | |
setup_py_path, | |
global_options=global_options, | |
install_options=install_options, | |
no_user_config=isolated, | |
prefix=prefix, | |
home=home, | |
use_user_site=use_user_site, | |
) | |
with indent_log(): | |
with build_env: | |
call_subprocess( | |
args, | |
cwd=unpacked_source_directory, | |
) |
"""Legacy installation process, i.e. `setup.py install`. | |
""" | |
import logging | |
import os | |
import sys | |
from distutils.util import change_root | |
from pip._internal.utils.deprecation import deprecated | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import ensure_dir | |
from pip._internal.utils.setuptools_build import make_setuptools_install_args | |
from pip._internal.utils.subprocess import runner_with_spinner_message | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional, Sequence | |
from pip._internal.build_env import BuildEnvironment | |
from pip._internal.models.scheme import Scheme | |
logger = logging.getLogger(__name__) | |
class LegacyInstallFailure(Exception): | |
def __init__(self): | |
# type: () -> None | |
self.parent = sys.exc_info() | |
def install( | |
install_options, # type: List[str] | |
global_options, # type: Sequence[str] | |
root, # type: Optional[str] | |
home, # type: Optional[str] | |
prefix, # type: Optional[str] | |
use_user_site, # type: bool | |
pycompile, # type: bool | |
scheme, # type: Scheme | |
setup_py_path, # type: str | |
isolated, # type: bool | |
req_name, # type: str | |
build_env, # type: BuildEnvironment | |
unpacked_source_directory, # type: str | |
req_description, # type: str | |
): | |
# type: (...) -> bool | |
header_dir = scheme.headers | |
with TempDirectory(kind="record") as temp_dir: | |
try: | |
record_filename = os.path.join(temp_dir.path, 'install-record.txt') | |
install_args = make_setuptools_install_args( | |
setup_py_path, | |
global_options=global_options, | |
install_options=install_options, | |
record_filename=record_filename, | |
root=root, | |
prefix=prefix, | |
header_dir=header_dir, | |
home=home, | |
use_user_site=use_user_site, | |
no_user_config=isolated, | |
pycompile=pycompile, | |
) | |
runner = runner_with_spinner_message( | |
"Running setup.py install for {}".format(req_name) | |
) | |
with indent_log(), build_env: | |
runner( | |
cmd=install_args, | |
cwd=unpacked_source_directory, | |
) | |
if not os.path.exists(record_filename): | |
logger.debug('Record file %s not found', record_filename) | |
# Signal to the caller that we didn't install the new package | |
return False | |
except Exception: | |
# Signal to the caller that we didn't install the new package | |
raise LegacyInstallFailure | |
# At this point, we have successfully installed the requirement. | |
# We intentionally do not use any encoding to read the file because | |
# setuptools writes the file using distutils.file_util.write_file, | |
# which does not specify an encoding. | |
with open(record_filename) as f: | |
record_lines = f.read().splitlines() | |
def prepend_root(path): | |
# type: (str) -> str | |
if root is None or not os.path.isabs(path): | |
return path | |
else: | |
return change_root(root, path) | |
for line in record_lines: | |
directory = os.path.dirname(line) | |
if directory.endswith('.egg-info'): | |
egg_info_dir = prepend_root(directory) | |
break | |
else: | |
deprecated( | |
reason=( | |
"{} did not indicate that it installed an " | |
".egg-info directory. Only setup.py projects " | |
"generating .egg-info directories are supported." | |
).format(req_description), | |
replacement=( | |
"for maintainers: updating the setup.py of {0}. " | |
"For users: contact the maintainers of {0} to let " | |
"them know to update their setup.py.".format( | |
req_name | |
) | |
), | |
gone_in="20.2", | |
issue=6998, | |
) | |
# FIXME: put the record somewhere | |
return True | |
new_lines = [] | |
for line in record_lines: | |
filename = line.strip() | |
if os.path.isdir(filename): | |
filename += os.path.sep | |
new_lines.append( | |
os.path.relpath(prepend_root(filename), egg_info_dir) | |
) | |
new_lines.sort() | |
ensure_dir(egg_info_dir) | |
inst_files_path = os.path.join(egg_info_dir, 'installed-files.txt') | |
with open(inst_files_path, 'w') as f: | |
f.write('\n'.join(new_lines) + '\n') | |
return True |
"""Support for installing and building the "wheel" binary package format. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import collections | |
import compileall | |
import contextlib | |
import csv | |
import logging | |
import os.path | |
import re | |
import shutil | |
import stat | |
import sys | |
import warnings | |
from base64 import urlsafe_b64encode | |
from itertools import starmap | |
from zipfile import ZipFile | |
from pip._vendor import pkg_resources | |
from pip._vendor.distlib.scripts import ScriptMaker | |
from pip._vendor.distlib.util import get_export_entry | |
from pip._vendor.six import StringIO | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.locations import get_major_minor_version | |
from pip._internal.models.direct_url import DIRECT_URL_METADATA_NAME, DirectUrl | |
from pip._internal.utils.filesystem import adjacent_tmp_file, replace | |
from pip._internal.utils.misc import captured_stdout, ensure_dir, hash_file | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.unpacking import current_umask, unpack_file | |
from pip._internal.utils.wheel import parse_wheel | |
if MYPY_CHECK_RUNNING: | |
from email.message import Message | |
from typing import ( | |
Dict, List, Optional, Sequence, Tuple, Any, | |
Iterable, Iterator, Callable, Set, | |
) | |
from pip._internal.models.scheme import Scheme | |
from pip._internal.utils.filesystem import NamedTemporaryFileResult | |
InstalledCSVRow = Tuple[str, ...] | |
logger = logging.getLogger(__name__) | |
def normpath(src, p): | |
# type: (str, str) -> str | |
return os.path.relpath(src, p).replace(os.path.sep, '/') | |
def rehash(path, blocksize=1 << 20): | |
# type: (str, int) -> Tuple[str, str] | |
"""Return (encoded_digest, length) for path using hashlib.sha256()""" | |
h, length = hash_file(path, blocksize) | |
digest = 'sha256=' + urlsafe_b64encode( | |
h.digest() | |
).decode('latin1').rstrip('=') | |
# unicode/str python2 issues | |
return (digest, str(length)) # type: ignore | |
def csv_io_kwargs(mode): | |
# type: (str) -> Dict[str, Any] | |
"""Return keyword arguments to properly open a CSV file | |
in the given mode. | |
""" | |
if sys.version_info.major < 3: | |
return {'mode': '{}b'.format(mode)} | |
else: | |
return {'mode': mode, 'newline': ''} | |
def fix_script(path): | |
# type: (str) -> Optional[bool] | |
"""Replace #!python with #!/path/to/python | |
Return True if file was changed. | |
""" | |
# XXX RECORD hashes will need to be updated | |
if os.path.isfile(path): | |
with open(path, 'rb') as script: | |
firstline = script.readline() | |
if not firstline.startswith(b'#!python'): | |
return False | |
exename = sys.executable.encode(sys.getfilesystemencoding()) | |
firstline = b'#!' + exename + os.linesep.encode("ascii") | |
rest = script.read() | |
with open(path, 'wb') as script: | |
script.write(firstline) | |
script.write(rest) | |
return True | |
return None | |
def wheel_root_is_purelib(metadata): | |
# type: (Message) -> bool | |
return metadata.get("Root-Is-Purelib", "").lower() == "true" | |
def get_entrypoints(filename): | |
# type: (str) -> Tuple[Dict[str, str], Dict[str, str]] | |
if not os.path.exists(filename): | |
return {}, {} | |
# This is done because you can pass a string to entry_points wrappers which | |
# means that they may or may not be valid INI files. The attempt here is to | |
# strip leading and trailing whitespace in order to make them valid INI | |
# files. | |
with open(filename) as fp: | |
data = StringIO() | |
for line in fp: | |
data.write(line.strip()) | |
data.write("\n") | |
data.seek(0) | |
# get the entry points and then the script names | |
entry_points = pkg_resources.EntryPoint.parse_map(data) | |
console = entry_points.get('console_scripts', {}) | |
gui = entry_points.get('gui_scripts', {}) | |
def _split_ep(s): | |
# type: (pkg_resources.EntryPoint) -> Tuple[str, str] | |
"""get the string representation of EntryPoint, | |
remove space and split on '=' | |
""" | |
split_parts = str(s).replace(" ", "").split("=") | |
return split_parts[0], split_parts[1] | |
# convert the EntryPoint objects into strings with module:function | |
console = dict(_split_ep(v) for v in console.values()) | |
gui = dict(_split_ep(v) for v in gui.values()) | |
return console, gui | |
def message_about_scripts_not_on_PATH(scripts): | |
# type: (Sequence[str]) -> Optional[str] | |
"""Determine if any scripts are not on PATH and format a warning. | |
Returns a warning message if one or more scripts are not on PATH, | |
otherwise None. | |
""" | |
if not scripts: | |
return None | |
# Group scripts by the path they were installed in | |
grouped_by_dir = collections.defaultdict(set) # type: Dict[str, Set[str]] | |
for destfile in scripts: | |
parent_dir = os.path.dirname(destfile) | |
script_name = os.path.basename(destfile) | |
grouped_by_dir[parent_dir].add(script_name) | |
# We don't want to warn for directories that are on PATH. | |
not_warn_dirs = [ | |
os.path.normcase(i).rstrip(os.sep) for i in | |
os.environ.get("PATH", "").split(os.pathsep) | |
] | |
# If an executable sits with sys.executable, we don't warn for it. | |
# This covers the case of venv invocations without activating the venv. | |
not_warn_dirs.append(os.path.normcase(os.path.dirname(sys.executable))) | |
warn_for = { | |
parent_dir: scripts for parent_dir, scripts in grouped_by_dir.items() | |
if os.path.normcase(parent_dir) not in not_warn_dirs | |
} # type: Dict[str, Set[str]] | |
if not warn_for: | |
return None | |
# Format a message | |
msg_lines = [] | |
for parent_dir, dir_scripts in warn_for.items(): | |
sorted_scripts = sorted(dir_scripts) # type: List[str] | |
if len(sorted_scripts) == 1: | |
start_text = "script {} is".format(sorted_scripts[0]) | |
else: | |
start_text = "scripts {} are".format( | |
", ".join(sorted_scripts[:-1]) + " and " + sorted_scripts[-1] | |
) | |
msg_lines.append( | |
"The {} installed in '{}' which is not on PATH." | |
.format(start_text, parent_dir) | |
) | |
last_line_fmt = ( | |
"Consider adding {} to PATH or, if you prefer " | |
"to suppress this warning, use --no-warn-script-location." | |
) | |
if len(msg_lines) == 1: | |
msg_lines.append(last_line_fmt.format("this directory")) | |
else: | |
msg_lines.append(last_line_fmt.format("these directories")) | |
# Add a note if any directory starts with ~ | |
warn_for_tilde = any( | |
i[0] == "~" for i in os.environ.get("PATH", "").split(os.pathsep) if i | |
) | |
if warn_for_tilde: | |
tilde_warning_msg = ( | |
"NOTE: The current PATH contains path(s) starting with `~`, " | |
"which may not be expanded by all applications." | |
) | |
msg_lines.append(tilde_warning_msg) | |
# Returns the formatted multiline message | |
return "\n".join(msg_lines) | |
def sorted_outrows(outrows): | |
# type: (Iterable[InstalledCSVRow]) -> List[InstalledCSVRow] | |
"""Return the given rows of a RECORD file in sorted order. | |
Each row is a 3-tuple (path, hash, size) and corresponds to a record of | |
a RECORD file (see PEP 376 and PEP 427 for details). For the rows | |
passed to this function, the size can be an integer as an int or string, | |
or the empty string. | |
""" | |
# Normally, there should only be one row per path, in which case the | |
# second and third elements don't come into play when sorting. | |
# However, in cases in the wild where a path might happen to occur twice, | |
# we don't want the sort operation to trigger an error (but still want | |
# determinism). Since the third element can be an int or string, we | |
# coerce each element to a string to avoid a TypeError in this case. | |
# For additional background, see-- | |
# https://github.com/pypa/pip/issues/5868 | |
return sorted(outrows, key=lambda row: tuple(str(x) for x in row)) | |
def get_csv_rows_for_installed( | |
old_csv_rows, # type: Iterable[List[str]] | |
installed, # type: Dict[str, str] | |
changed, # type: Set[str] | |
generated, # type: List[str] | |
lib_dir, # type: str | |
): | |
# type: (...) -> List[InstalledCSVRow] | |
""" | |
:param installed: A map from archive RECORD path to installation RECORD | |
path. | |
""" | |
installed_rows = [] # type: List[InstalledCSVRow] | |
for row in old_csv_rows: | |
if len(row) > 3: | |
logger.warning( | |
'RECORD line has more than three elements: {}'.format(row) | |
) | |
# Make a copy because we are mutating the row. | |
row = list(row) | |
old_path = row[0] | |
new_path = installed.pop(old_path, old_path) | |
row[0] = new_path | |
if new_path in changed: | |
digest, length = rehash(new_path) | |
row[1] = digest | |
row[2] = length | |
installed_rows.append(tuple(row)) | |
for f in generated: | |
digest, length = rehash(f) | |
installed_rows.append((normpath(f, lib_dir), digest, str(length))) | |
for f in installed: | |
installed_rows.append((installed[f], '', '')) | |
return installed_rows | |
class MissingCallableSuffix(Exception): | |
pass | |
def _raise_for_invalid_entrypoint(specification): | |
# type: (str) -> None | |
entry = get_export_entry(specification) | |
if entry is not None and entry.suffix is None: | |
raise MissingCallableSuffix(str(entry)) | |
class PipScriptMaker(ScriptMaker): | |
def make(self, specification, options=None): | |
# type: (str, Dict[str, Any]) -> List[str] | |
_raise_for_invalid_entrypoint(specification) | |
return super(PipScriptMaker, self).make(specification, options) | |
def install_unpacked_wheel( | |
name, # type: str | |
wheeldir, # type: str | |
wheel_zip, # type: ZipFile | |
scheme, # type: Scheme | |
req_description, # type: str | |
pycompile=True, # type: bool | |
warn_script_location=True, # type: bool | |
direct_url=None, # type: Optional[DirectUrl] | |
): | |
# type: (...) -> None | |
"""Install a wheel. | |
:param name: Name of the project to install | |
:param wheeldir: Base directory of the unpacked wheel | |
:param wheel_zip: open ZipFile for wheel being installed | |
:param scheme: Distutils scheme dictating the install directories | |
:param req_description: String used in place of the requirement, for | |
logging | |
:param pycompile: Whether to byte-compile installed Python files | |
:param warn_script_location: Whether to check that scripts are installed | |
into a directory on PATH | |
:raises UnsupportedWheel: | |
* when the directory holds an unpacked wheel with incompatible | |
Wheel-Version | |
* when the .dist-info dir does not match the wheel | |
""" | |
# TODO: Investigate and break this up. | |
# TODO: Look into moving this into a dedicated class for representing an | |
# installation. | |
source = wheeldir.rstrip(os.path.sep) + os.path.sep | |
info_dir, metadata = parse_wheel(wheel_zip, name) | |
if wheel_root_is_purelib(metadata): | |
lib_dir = scheme.purelib | |
else: | |
lib_dir = scheme.platlib | |
subdirs = os.listdir(source) | |
data_dirs = [s for s in subdirs if s.endswith('.data')] | |
# Record details of the files moved | |
# installed = files copied from the wheel to the destination | |
# changed = files changed while installing (scripts #! line typically) | |
# generated = files newly generated during the install (script wrappers) | |
installed = {} # type: Dict[str, str] | |
changed = set() | |
generated = [] # type: List[str] | |
# Compile all of the pyc files that we're going to be installing | |
if pycompile: | |
with captured_stdout() as stdout: | |
with warnings.catch_warnings(): | |
warnings.filterwarnings('ignore') | |
compileall.compile_dir(source, force=True, quiet=True) | |
logger.debug(stdout.getvalue()) | |
def record_installed(srcfile, destfile, modified=False): | |
# type: (str, str, bool) -> None | |
"""Map archive RECORD paths to installation RECORD paths.""" | |
oldpath = normpath(srcfile, wheeldir) | |
newpath = normpath(destfile, lib_dir) | |
installed[oldpath] = newpath | |
if modified: | |
changed.add(destfile) | |
def clobber( | |
source, # type: str | |
dest, # type: str | |
is_base, # type: bool | |
fixer=None, # type: Optional[Callable[[str], Any]] | |
filter=None # type: Optional[Callable[[str], bool]] | |
): | |
# type: (...) -> None | |
ensure_dir(dest) # common for the 'include' path | |
for dir, subdirs, files in os.walk(source): | |
basedir = dir[len(source):].lstrip(os.path.sep) | |
destdir = os.path.join(dest, basedir) | |
if is_base and basedir == '': | |
subdirs[:] = [s for s in subdirs if not s.endswith('.data')] | |
for f in files: | |
# Skip unwanted files | |
if filter and filter(f): | |
continue | |
srcfile = os.path.join(dir, f) | |
destfile = os.path.join(dest, basedir, f) | |
# directory creation is lazy and after the file filtering above | |
# to ensure we don't install empty dirs; empty dirs can't be | |
# uninstalled. | |
ensure_dir(destdir) | |
# copyfile (called below) truncates the destination if it | |
# exists and then writes the new contents. This is fine in most | |
# cases, but can cause a segfault if pip has loaded a shared | |
# object (e.g. from pyopenssl through its vendored urllib3) | |
# Since the shared object is mmap'd an attempt to call a | |
# symbol in it will then cause a segfault. Unlinking the file | |
# allows writing of new contents while allowing the process to | |
# continue to use the old copy. | |
if os.path.exists(destfile): | |
os.unlink(destfile) | |
# We use copyfile (not move, copy, or copy2) to be extra sure | |
# that we are not moving directories over (copyfile fails for | |
# directories) as well as to ensure that we are not copying | |
# over any metadata because we want more control over what | |
# metadata we actually copy over. | |
shutil.copyfile(srcfile, destfile) | |
# Copy over the metadata for the file, currently this only | |
# includes the atime and mtime. | |
st = os.stat(srcfile) | |
if hasattr(os, "utime"): | |
os.utime(destfile, (st.st_atime, st.st_mtime)) | |
# If our file is executable, then make our destination file | |
# executable. | |
if os.access(srcfile, os.X_OK): | |
st = os.stat(srcfile) | |
permissions = ( | |
st.st_mode | stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH | |
) | |
os.chmod(destfile, permissions) | |
changed = False | |
if fixer: | |
changed = fixer(destfile) | |
record_installed(srcfile, destfile, changed) | |
clobber(source, lib_dir, True) | |
dest_info_dir = os.path.join(lib_dir, info_dir) | |
# Get the defined entry points | |
ep_file = os.path.join(dest_info_dir, 'entry_points.txt') | |
console, gui = get_entrypoints(ep_file) | |
def is_entrypoint_wrapper(name): | |
# type: (str) -> bool | |
# EP, EP.exe and EP-script.py are scripts generated for | |
# entry point EP by setuptools | |
if name.lower().endswith('.exe'): | |
matchname = name[:-4] | |
elif name.lower().endswith('-script.py'): | |
matchname = name[:-10] | |
elif name.lower().endswith(".pya"): | |
matchname = name[:-4] | |
else: | |
matchname = name | |
# Ignore setuptools-generated scripts | |
return (matchname in console or matchname in gui) | |
for datadir in data_dirs: | |
fixer = None | |
filter = None | |
for subdir in os.listdir(os.path.join(wheeldir, datadir)): | |
fixer = None | |
if subdir == 'scripts': | |
fixer = fix_script | |
filter = is_entrypoint_wrapper | |
source = os.path.join(wheeldir, datadir, subdir) | |
dest = getattr(scheme, subdir) | |
clobber(source, dest, False, fixer=fixer, filter=filter) | |
maker = PipScriptMaker(None, scheme.scripts) | |
# Ensure old scripts are overwritten. | |
# See https://github.com/pypa/pip/issues/1800 | |
maker.clobber = True | |
# Ensure we don't generate any variants for scripts because this is almost | |
# never what somebody wants. | |
# See https://bitbucket.org/pypa/distlib/issue/35/ | |
maker.variants = {''} | |
# This is required because otherwise distlib creates scripts that are not | |
# executable. | |
# See https://bitbucket.org/pypa/distlib/issue/32/ | |
maker.set_mode = True | |
scripts_to_generate = [] | |
# Special case pip and setuptools to generate versioned wrappers | |
# | |
# The issue is that some projects (specifically, pip and setuptools) use | |
# code in setup.py to create "versioned" entry points - pip2.7 on Python | |
# 2.7, pip3.3 on Python 3.3, etc. But these entry points are baked into | |
# the wheel metadata at build time, and so if the wheel is installed with | |
# a *different* version of Python the entry points will be wrong. The | |
# correct fix for this is to enhance the metadata to be able to describe | |
# such versioned entry points, but that won't happen till Metadata 2.0 is | |
# available. | |
# In the meantime, projects using versioned entry points will either have | |
# incorrect versioned entry points, or they will not be able to distribute | |
# "universal" wheels (i.e., they will need a wheel per Python version). | |
# | |
# Because setuptools and pip are bundled with _ensurepip and virtualenv, | |
# we need to use universal wheels. So, as a stopgap until Metadata 2.0, we | |
# override the versioned entry points in the wheel and generate the | |
# correct ones. This code is purely a short-term measure until Metadata 2.0 | |
# is available. | |
# | |
# To add the level of hack in this section of code, in order to support | |
# ensurepip this code will look for an ``ENSUREPIP_OPTIONS`` environment | |
# variable which will control which version scripts get installed. | |
# | |
# ENSUREPIP_OPTIONS=altinstall | |
# - Only pipX.Y and easy_install-X.Y will be generated and installed | |
# ENSUREPIP_OPTIONS=install | |
# - pipX.Y, pipX, easy_install-X.Y will be generated and installed. Note | |
# that this option is technically if ENSUREPIP_OPTIONS is set and is | |
# not altinstall | |
# DEFAULT | |
# - The default behavior is to install pip, pipX, pipX.Y, easy_install | |
# and easy_install-X.Y. | |
pip_script = console.pop('pip', None) | |
if pip_script: | |
if "ENSUREPIP_OPTIONS" not in os.environ: | |
scripts_to_generate.append('pip = ' + pip_script) | |
if os.environ.get("ENSUREPIP_OPTIONS", "") != "altinstall": | |
scripts_to_generate.append( | |
'pip{} = {}'.format(sys.version_info[0], pip_script) | |
) | |
scripts_to_generate.append( | |
'pip{} = {}'.format(get_major_minor_version(), pip_script) | |
) | |
# Delete any other versioned pip entry points | |
pip_ep = [k for k in console if re.match(r'pip(\d(\.\d)?)?$', k)] | |
for k in pip_ep: | |
del console[k] | |
easy_install_script = console.pop('easy_install', None) | |
if easy_install_script: | |
if "ENSUREPIP_OPTIONS" not in os.environ: | |
scripts_to_generate.append( | |
'easy_install = ' + easy_install_script | |
) | |
scripts_to_generate.append( | |
'easy_install-{} = {}'.format( | |
get_major_minor_version(), easy_install_script | |
) | |
) | |
# Delete any other versioned easy_install entry points | |
easy_install_ep = [ | |
k for k in console if re.match(r'easy_install(-\d\.\d)?$', k) | |
] | |
for k in easy_install_ep: | |
del console[k] | |
# Generate the console and GUI entry points specified in the wheel | |
scripts_to_generate.extend(starmap('{} = {}'.format, console.items())) | |
gui_scripts_to_generate = list(starmap('{} = {}'.format, gui.items())) | |
generated_console_scripts = [] # type: List[str] | |
try: | |
generated_console_scripts = maker.make_multiple(scripts_to_generate) | |
generated.extend(generated_console_scripts) | |
generated.extend( | |
maker.make_multiple(gui_scripts_to_generate, {'gui': True}) | |
) | |
except MissingCallableSuffix as e: | |
entry = e.args[0] | |
raise InstallationError( | |
"Invalid script entry point: {} for req: {} - A callable " | |
"suffix is required. Cf https://packaging.python.org/" | |
"specifications/entry-points/#use-for-scripts for more " | |
"information.".format(entry, req_description) | |
) | |
if warn_script_location: | |
msg = message_about_scripts_not_on_PATH(generated_console_scripts) | |
if msg is not None: | |
logger.warning(msg) | |
generated_file_mode = 0o666 & ~current_umask() | |
@contextlib.contextmanager | |
def _generate_file(path, **kwargs): | |
# type: (str, **Any) -> Iterator[NamedTemporaryFileResult] | |
with adjacent_tmp_file(path, **kwargs) as f: | |
yield f | |
os.chmod(f.name, generated_file_mode) | |
replace(f.name, path) | |
# Record pip as the installer | |
installer_path = os.path.join(dest_info_dir, 'INSTALLER') | |
with _generate_file(installer_path) as installer_file: | |
installer_file.write(b'pip\n') | |
generated.append(installer_path) | |
# Record the PEP 610 direct URL reference | |
if direct_url is not None: | |
direct_url_path = os.path.join(dest_info_dir, DIRECT_URL_METADATA_NAME) | |
with _generate_file(direct_url_path) as direct_url_file: | |
direct_url_file.write(direct_url.to_json().encode("utf-8")) | |
generated.append(direct_url_path) | |
# Record details of all files installed | |
record_path = os.path.join(dest_info_dir, 'RECORD') | |
with open(record_path, **csv_io_kwargs('r')) as record_file: | |
rows = get_csv_rows_for_installed( | |
csv.reader(record_file), | |
installed=installed, | |
changed=changed, | |
generated=generated, | |
lib_dir=lib_dir) | |
with _generate_file(record_path, **csv_io_kwargs('w')) as record_file: | |
writer = csv.writer(record_file) | |
writer.writerows(sorted_outrows(rows)) # sort to simplify testing | |
def install_wheel( | |
name, # type: str | |
wheel_path, # type: str | |
scheme, # type: Scheme | |
req_description, # type: str | |
pycompile=True, # type: bool | |
warn_script_location=True, # type: bool | |
_temp_dir_for_testing=None, # type: Optional[str] | |
direct_url=None, # type: Optional[DirectUrl] | |
): | |
# type: (...) -> None | |
with TempDirectory( | |
path=_temp_dir_for_testing, kind="unpacked-wheel" | |
) as unpacked_dir, ZipFile(wheel_path, allowZip64=True) as z: | |
unpack_file(wheel_path, unpacked_dir.path) | |
install_unpacked_wheel( | |
name=name, | |
wheeldir=unpacked_dir.path, | |
wheel_zip=z, | |
scheme=scheme, | |
req_description=req_description, | |
pycompile=pycompile, | |
warn_script_location=warn_script_location, | |
direct_url=direct_url, | |
) |
"""Prepares a distribution for installation | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
import logging | |
import mimetypes | |
import os | |
import shutil | |
from pip._vendor import requests | |
from pip._vendor.six import PY2 | |
from pip._internal.distributions import ( | |
make_distribution_for_install_requirement, | |
) | |
from pip._internal.distributions.installed import InstalledDistribution | |
from pip._internal.exceptions import ( | |
DirectoryUrlHashUnsupported, | |
HashMismatch, | |
HashUnpinned, | |
InstallationError, | |
PreviousBuildDirError, | |
VcsHashUnsupported, | |
) | |
from pip._internal.utils.filesystem import copy2_fixed | |
from pip._internal.utils.hashes import MissingHashes | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import ( | |
display_path, | |
hide_url, | |
path_to_display, | |
rmtree, | |
) | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.unpacking import unpack_file | |
from pip._internal.vcs import vcs | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Callable, List, Optional, Tuple, | |
) | |
from mypy_extensions import TypedDict | |
from pip._internal.distributions import AbstractDistribution | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.models.link import Link | |
from pip._internal.network.download import Downloader | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.req.req_tracker import RequirementTracker | |
from pip._internal.utils.hashes import Hashes | |
if PY2: | |
CopytreeKwargs = TypedDict( | |
'CopytreeKwargs', | |
{ | |
'ignore': Callable[[str, List[str]], List[str]], | |
'symlinks': bool, | |
}, | |
total=False, | |
) | |
else: | |
CopytreeKwargs = TypedDict( | |
'CopytreeKwargs', | |
{ | |
'copy_function': Callable[[str, str], None], | |
'ignore': Callable[[str, List[str]], List[str]], | |
'ignore_dangling_symlinks': bool, | |
'symlinks': bool, | |
}, | |
total=False, | |
) | |
logger = logging.getLogger(__name__) | |
def _get_prepared_distribution( | |
req, # type: InstallRequirement | |
req_tracker, # type: RequirementTracker | |
finder, # type: PackageFinder | |
build_isolation # type: bool | |
): | |
# type: (...) -> AbstractDistribution | |
"""Prepare a distribution for installation. | |
""" | |
abstract_dist = make_distribution_for_install_requirement(req) | |
with req_tracker.track(req): | |
abstract_dist.prepare_distribution_metadata(finder, build_isolation) | |
return abstract_dist | |
def unpack_vcs_link(link, location): | |
# type: (Link, str) -> None | |
vcs_backend = vcs.get_backend_for_scheme(link.scheme) | |
assert vcs_backend is not None | |
vcs_backend.unpack(location, url=hide_url(link.url)) | |
class File(object): | |
def __init__(self, path, content_type): | |
# type: (str, str) -> None | |
self.path = path | |
self.content_type = content_type | |
def get_http_url( | |
link, # type: Link | |
downloader, # type: Downloader | |
download_dir=None, # type: Optional[str] | |
hashes=None, # type: Optional[Hashes] | |
): | |
# type: (...) -> File | |
temp_dir = TempDirectory(kind="unpack", globally_managed=True) | |
# If a download dir is specified, is the file already downloaded there? | |
already_downloaded_path = None | |
if download_dir: | |
already_downloaded_path = _check_download_dir( | |
link, download_dir, hashes | |
) | |
if already_downloaded_path: | |
from_path = already_downloaded_path | |
content_type = mimetypes.guess_type(from_path)[0] | |
else: | |
# let's download to a tmp dir | |
from_path, content_type = _download_http_url( | |
link, downloader, temp_dir.path, hashes | |
) | |
return File(from_path, content_type) | |
def _copy2_ignoring_special_files(src, dest): | |
# type: (str, str) -> None | |
"""Copying special files is not supported, but as a convenience to users | |
we skip errors copying them. This supports tools that may create e.g. | |
socket files in the project source directory. | |
""" | |
try: | |
copy2_fixed(src, dest) | |
except shutil.SpecialFileError as e: | |
# SpecialFileError may be raised due to either the source or | |
# destination. If the destination was the cause then we would actually | |
# care, but since the destination directory is deleted prior to | |
# copy we ignore all of them assuming it is caused by the source. | |
logger.warning( | |
"Ignoring special file error '%s' encountered copying %s to %s.", | |
str(e), | |
path_to_display(src), | |
path_to_display(dest), | |
) | |
def _copy_source_tree(source, target): | |
# type: (str, str) -> None | |
target_abspath = os.path.abspath(target) | |
target_basename = os.path.basename(target_abspath) | |
target_dirname = os.path.dirname(target_abspath) | |
def ignore(d, names): | |
# type: (str, List[str]) -> List[str] | |
skipped = [] # type: List[str] | |
if d == source: | |
# Pulling in those directories can potentially be very slow, | |
# exclude the following directories if they appear in the top | |
# level dir (and only it). | |
# See discussion at https://github.com/pypa/pip/pull/6770 | |
skipped += ['.tox', '.nox'] | |
if os.path.abspath(d) == target_dirname: | |
# Prevent an infinite recursion if the target is in source. | |
# This can happen when TMPDIR is set to ${PWD}/... | |
# and we copy PWD to TMPDIR. | |
skipped += [target_basename] | |
return skipped | |
kwargs = dict(ignore=ignore, symlinks=True) # type: CopytreeKwargs | |
if not PY2: | |
# Python 2 does not support copy_function, so we only ignore | |
# errors on special file copy in Python 3. | |
kwargs['copy_function'] = _copy2_ignoring_special_files | |
shutil.copytree(source, target, **kwargs) | |
def get_file_url( | |
link, # type: Link | |
download_dir=None, # type: Optional[str] | |
hashes=None # type: Optional[Hashes] | |
): | |
# type: (...) -> File | |
"""Get file and optionally check its hash. | |
""" | |
# If a download dir is specified, is the file already there and valid? | |
already_downloaded_path = None | |
if download_dir: | |
already_downloaded_path = _check_download_dir( | |
link, download_dir, hashes | |
) | |
if already_downloaded_path: | |
from_path = already_downloaded_path | |
else: | |
from_path = link.file_path | |
# If --require-hashes is off, `hashes` is either empty, the | |
# link's embedded hash, or MissingHashes; it is required to | |
# match. If --require-hashes is on, we are satisfied by any | |
# hash in `hashes` matching: a URL-based or an option-based | |
# one; no internet-sourced hash will be in `hashes`. | |
if hashes: | |
hashes.check_against_path(from_path) | |
content_type = mimetypes.guess_type(from_path)[0] | |
return File(from_path, content_type) | |
def unpack_url( | |
link, # type: Link | |
location, # type: str | |
downloader, # type: Downloader | |
download_dir=None, # type: Optional[str] | |
hashes=None, # type: Optional[Hashes] | |
): | |
# type: (...) -> Optional[File] | |
"""Unpack link into location, downloading if required. | |
:param hashes: A Hashes object, one of whose embedded hashes must match, | |
or HashMismatch will be raised. If the Hashes is empty, no matches are | |
required, and unhashable types of requirements (like VCS ones, which | |
would ordinarily raise HashUnsupported) are allowed. | |
""" | |
# non-editable vcs urls | |
if link.is_vcs: | |
unpack_vcs_link(link, location) | |
return None | |
# If it's a url to a local directory | |
if link.is_existing_dir(): | |
if os.path.isdir(location): | |
rmtree(location) | |
_copy_source_tree(link.file_path, location) | |
return None | |
# file urls | |
if link.is_file: | |
file = get_file_url(link, download_dir, hashes=hashes) | |
# http urls | |
else: | |
file = get_http_url( | |
link, | |
downloader, | |
download_dir, | |
hashes=hashes, | |
) | |
# unpack the archive to the build dir location. even when only downloading | |
# archives, they have to be unpacked to parse dependencies | |
unpack_file(file.path, location, file.content_type) | |
return file | |
def _download_http_url( | |
link, # type: Link | |
downloader, # type: Downloader | |
temp_dir, # type: str | |
hashes, # type: Optional[Hashes] | |
): | |
# type: (...) -> Tuple[str, str] | |
"""Download link url into temp_dir using provided session""" | |
download = downloader(link) | |
file_path = os.path.join(temp_dir, download.filename) | |
with open(file_path, 'wb') as content_file: | |
for chunk in download.chunks: | |
content_file.write(chunk) | |
if hashes: | |
hashes.check_against_path(file_path) | |
return file_path, download.response.headers.get('content-type', '') | |
def _check_download_dir(link, download_dir, hashes): | |
# type: (Link, str, Optional[Hashes]) -> Optional[str] | |
""" Check download_dir for previously downloaded file with correct hash | |
If a correct file is found return its path else None | |
""" | |
download_path = os.path.join(download_dir, link.filename) | |
if not os.path.exists(download_path): | |
return None | |
# If already downloaded, does its hash match? | |
logger.info('File was already downloaded %s', download_path) | |
if hashes: | |
try: | |
hashes.check_against_path(download_path) | |
except HashMismatch: | |
logger.warning( | |
'Previously-downloaded file %s has bad hash. ' | |
'Re-downloading.', | |
download_path | |
) | |
os.unlink(download_path) | |
return None | |
return download_path | |
class RequirementPreparer(object): | |
"""Prepares a Requirement | |
""" | |
def __init__( | |
self, | |
build_dir, # type: str | |
download_dir, # type: Optional[str] | |
src_dir, # type: str | |
wheel_download_dir, # type: Optional[str] | |
build_isolation, # type: bool | |
req_tracker, # type: RequirementTracker | |
downloader, # type: Downloader | |
finder, # type: PackageFinder | |
require_hashes, # type: bool | |
use_user_site, # type: bool | |
): | |
# type: (...) -> None | |
super(RequirementPreparer, self).__init__() | |
self.src_dir = src_dir | |
self.build_dir = build_dir | |
self.req_tracker = req_tracker | |
self.downloader = downloader | |
self.finder = finder | |
# Where still-packed archives should be written to. If None, they are | |
# not saved, and are deleted immediately after unpacking. | |
self.download_dir = download_dir | |
# Where still-packed .whl files should be written to. If None, they are | |
# written to the download_dir parameter. Separate to download_dir to | |
# permit only keeping wheel archives for pip wheel. | |
self.wheel_download_dir = wheel_download_dir | |
# NOTE | |
# download_dir and wheel_download_dir overlap semantically and may | |
# be combined if we're willing to have non-wheel archives present in | |
# the wheelhouse output by 'pip wheel'. | |
# Is build isolation allowed? | |
self.build_isolation = build_isolation | |
# Should hash-checking be required? | |
self.require_hashes = require_hashes | |
# Should install in user site-packages? | |
self.use_user_site = use_user_site | |
@property | |
def _download_should_save(self): | |
# type: () -> bool | |
if not self.download_dir: | |
return False | |
if os.path.exists(self.download_dir): | |
return True | |
logger.critical('Could not find download directory') | |
raise InstallationError( | |
"Could not find or access download directory '{}'" | |
.format(self.download_dir)) | |
def prepare_linked_requirement( | |
self, | |
req, # type: InstallRequirement | |
): | |
# type: (...) -> AbstractDistribution | |
"""Prepare a requirement that would be obtained from req.link | |
""" | |
assert req.link | |
link = req.link | |
# TODO: Breakup into smaller functions | |
if link.scheme == 'file': | |
path = link.file_path | |
logger.info('Processing %s', display_path(path)) | |
else: | |
logger.info('Collecting %s', req.req or req) | |
download_dir = self.download_dir | |
if link.is_wheel and self.wheel_download_dir: | |
# when doing 'pip wheel` we download wheels to a | |
# dedicated dir. | |
download_dir = self.wheel_download_dir | |
if link.is_wheel: | |
if download_dir: | |
# When downloading, we only unpack wheels to get | |
# metadata. | |
autodelete_unpacked = True | |
else: | |
# When installing a wheel, we use the unpacked | |
# wheel. | |
autodelete_unpacked = False | |
else: | |
# We always delete unpacked sdists after pip runs. | |
autodelete_unpacked = True | |
with indent_log(): | |
# Since source_dir is only set for editable requirements. | |
assert req.source_dir is None | |
req.ensure_has_source_dir(self.build_dir, autodelete_unpacked) | |
# If a checkout exists, it's unwise to keep going. version | |
# inconsistencies are logged later, but do not fail the | |
# installation. | |
# FIXME: this won't upgrade when there's an existing | |
# package unpacked in `req.source_dir` | |
if os.path.exists(os.path.join(req.source_dir, 'setup.py')): | |
raise PreviousBuildDirError( | |
"pip can't proceed with requirements '{}' due to a" | |
" pre-existing build directory ({}). This is " | |
"likely due to a previous installation that failed" | |
". pip is being responsible and not assuming it " | |
"can delete this. Please delete it and try again." | |
.format(req, req.source_dir) | |
) | |
# Now that we have the real link, we can tell what kind of | |
# requirements we have and raise some more informative errors | |
# than otherwise. (For example, we can raise VcsHashUnsupported | |
# for a VCS URL rather than HashMissing.) | |
if self.require_hashes: | |
# We could check these first 2 conditions inside | |
# unpack_url and save repetition of conditions, but then | |
# we would report less-useful error messages for | |
# unhashable requirements, complaining that there's no | |
# hash provided. | |
if link.is_vcs: | |
raise VcsHashUnsupported() | |
elif link.is_existing_dir(): | |
raise DirectoryUrlHashUnsupported() | |
if not req.original_link and not req.is_pinned: | |
# Unpinned packages are asking for trouble when a new | |
# version is uploaded. This isn't a security check, but | |
# it saves users a surprising hash mismatch in the | |
# future. | |
# | |
# file:/// URLs aren't pinnable, so don't complain | |
# about them not being pinned. | |
raise HashUnpinned() | |
hashes = req.hashes(trust_internet=not self.require_hashes) | |
if self.require_hashes and not hashes: | |
# Known-good hashes are missing for this requirement, so | |
# shim it with a facade object that will provoke hash | |
# computation and then raise a HashMissing exception | |
# showing the user what the hash should be. | |
hashes = MissingHashes() | |
try: | |
local_file = unpack_url( | |
link, req.source_dir, self.downloader, download_dir, | |
hashes=hashes, | |
) | |
except requests.HTTPError as exc: | |
logger.critical( | |
'Could not install requirement %s because of error %s', | |
req, | |
exc, | |
) | |
raise InstallationError( | |
'Could not install requirement {} because of HTTP ' | |
'error {} for URL {}'.format(req, exc, link) | |
) | |
# For use in later processing, preserve the file path on the | |
# requirement. | |
if local_file: | |
req.local_file_path = local_file.path | |
abstract_dist = _get_prepared_distribution( | |
req, self.req_tracker, self.finder, self.build_isolation, | |
) | |
if download_dir: | |
if link.is_existing_dir(): | |
logger.info('Link is a directory, ignoring download_dir') | |
elif local_file: | |
download_location = os.path.join( | |
download_dir, link.filename | |
) | |
if not os.path.exists(download_location): | |
shutil.copy(local_file.path, download_location) | |
logger.info( | |
'Saved %s', display_path(download_location) | |
) | |
if self._download_should_save: | |
# Make a .zip of the source_dir we already created. | |
if link.is_vcs: | |
req.archive(self.download_dir) | |
return abstract_dist | |
def prepare_editable_requirement( | |
self, | |
req, # type: InstallRequirement | |
): | |
# type: (...) -> AbstractDistribution | |
"""Prepare an editable requirement | |
""" | |
assert req.editable, "cannot prepare a non-editable req as editable" | |
logger.info('Obtaining %s', req) | |
with indent_log(): | |
if self.require_hashes: | |
raise InstallationError( | |
'The editable requirement {} cannot be installed when ' | |
'requiring hashes, because there is no single file to ' | |
'hash.'.format(req) | |
) | |
req.ensure_has_source_dir(self.src_dir) | |
req.update_editable(not self._download_should_save) | |
abstract_dist = _get_prepared_distribution( | |
req, self.req_tracker, self.finder, self.build_isolation, | |
) | |
if self._download_should_save: | |
req.archive(self.download_dir) | |
req.check_if_exists(self.use_user_site) | |
return abstract_dist | |
def prepare_installed_requirement( | |
self, | |
req, # type: InstallRequirement | |
skip_reason # type: str | |
): | |
# type: (...) -> AbstractDistribution | |
"""Prepare an already-installed requirement | |
""" | |
assert req.satisfied_by, "req should have been satisfied but isn't" | |
assert skip_reason is not None, ( | |
"did not get skip reason skipped but req.satisfied_by " | |
"is set to {}".format(req.satisfied_by) | |
) | |
logger.info( | |
'Requirement %s: %s (%s)', | |
skip_reason, req, req.satisfied_by.version | |
) | |
with indent_log(): | |
if self.require_hashes: | |
logger.debug( | |
'Since it is already installed, we are trusting this ' | |
'package without checking its hash. To ensure a ' | |
'completely repeatable environment, install into an ' | |
'empty virtualenv.' | |
) | |
abstract_dist = InstalledDistribution(req) | |
return abstract_dist |
from __future__ import absolute_import | |
import io | |
import os | |
import sys | |
from collections import namedtuple | |
from pip._vendor import six, toml | |
from pip._vendor.packaging.requirements import InvalidRequirement, Requirement | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Optional, List | |
def _is_list_of_str(obj): | |
# type: (Any) -> bool | |
return ( | |
isinstance(obj, list) and | |
all(isinstance(item, six.string_types) for item in obj) | |
) | |
def make_pyproject_path(unpacked_source_directory): | |
# type: (str) -> str | |
path = os.path.join(unpacked_source_directory, 'pyproject.toml') | |
# Python2 __file__ should not be unicode | |
if six.PY2 and isinstance(path, six.text_type): | |
path = path.encode(sys.getfilesystemencoding()) | |
return path | |
BuildSystemDetails = namedtuple('BuildSystemDetails', [ | |
'requires', 'backend', 'check', 'backend_path' | |
]) | |
def load_pyproject_toml( | |
use_pep517, # type: Optional[bool] | |
pyproject_toml, # type: str | |
setup_py, # type: str | |
req_name # type: str | |
): | |
# type: (...) -> Optional[BuildSystemDetails] | |
"""Load the pyproject.toml file. | |
Parameters: | |
use_pep517 - Has the user requested PEP 517 processing? None | |
means the user hasn't explicitly specified. | |
pyproject_toml - Location of the project's pyproject.toml file | |
setup_py - Location of the project's setup.py file | |
req_name - The name of the requirement we're processing (for | |
error reporting) | |
Returns: | |
None if we should use the legacy code path, otherwise a tuple | |
( | |
requirements from pyproject.toml, | |
name of PEP 517 backend, | |
requirements we should check are installed after setting | |
up the build environment | |
directory paths to import the backend from (backend-path), | |
relative to the project root. | |
) | |
""" | |
has_pyproject = os.path.isfile(pyproject_toml) | |
has_setup = os.path.isfile(setup_py) | |
if has_pyproject: | |
with io.open(pyproject_toml, encoding="utf-8") as f: | |
pp_toml = toml.load(f) | |
build_system = pp_toml.get("build-system") | |
else: | |
build_system = None | |
# The following cases must use PEP 517 | |
# We check for use_pep517 being non-None and falsey because that means | |
# the user explicitly requested --no-use-pep517. The value 0 as | |
# opposed to False can occur when the value is provided via an | |
# environment variable or config file option (due to the quirk of | |
# strtobool() returning an integer in pip's configuration code). | |
if has_pyproject and not has_setup: | |
if use_pep517 is not None and not use_pep517: | |
raise InstallationError( | |
"Disabling PEP 517 processing is invalid: " | |
"project does not have a setup.py" | |
) | |
use_pep517 = True | |
elif build_system and "build-backend" in build_system: | |
if use_pep517 is not None and not use_pep517: | |
raise InstallationError( | |
"Disabling PEP 517 processing is invalid: " | |
"project specifies a build backend of {} " | |
"in pyproject.toml".format( | |
build_system["build-backend"] | |
) | |
) | |
use_pep517 = True | |
# If we haven't worked out whether to use PEP 517 yet, | |
# and the user hasn't explicitly stated a preference, | |
# we do so if the project has a pyproject.toml file. | |
elif use_pep517 is None: | |
use_pep517 = has_pyproject | |
# At this point, we know whether we're going to use PEP 517. | |
assert use_pep517 is not None | |
# If we're using the legacy code path, there is nothing further | |
# for us to do here. | |
if not use_pep517: | |
return None | |
if build_system is None: | |
# Either the user has a pyproject.toml with no build-system | |
# section, or the user has no pyproject.toml, but has opted in | |
# explicitly via --use-pep517. | |
# In the absence of any explicit backend specification, we | |
# assume the setuptools backend that most closely emulates the | |
# traditional direct setup.py execution, and require wheel and | |
# a version of setuptools that supports that backend. | |
build_system = { | |
"requires": ["setuptools>=40.8.0", "wheel"], | |
"build-backend": "setuptools.build_meta:__legacy__", | |
} | |
# If we're using PEP 517, we have build system information (either | |
# from pyproject.toml, or defaulted by the code above). | |
# Note that at this point, we do not know if the user has actually | |
# specified a backend, though. | |
assert build_system is not None | |
# Ensure that the build-system section in pyproject.toml conforms | |
# to PEP 518. | |
error_template = ( | |
"{package} has a pyproject.toml file that does not comply " | |
"with PEP 518: {reason}" | |
) | |
# Specifying the build-system table but not the requires key is invalid | |
if "requires" not in build_system: | |
raise InstallationError( | |
error_template.format(package=req_name, reason=( | |
"it has a 'build-system' table but not " | |
"'build-system.requires' which is mandatory in the table" | |
)) | |
) | |
# Error out if requires is not a list of strings | |
requires = build_system["requires"] | |
if not _is_list_of_str(requires): | |
raise InstallationError(error_template.format( | |
package=req_name, | |
reason="'build-system.requires' is not a list of strings.", | |
)) | |
# Each requirement must be valid as per PEP 508 | |
for requirement in requires: | |
try: | |
Requirement(requirement) | |
except InvalidRequirement: | |
raise InstallationError( | |
error_template.format( | |
package=req_name, | |
reason=( | |
"'build-system.requires' contains an invalid " | |
"requirement: {!r}".format(requirement) | |
), | |
) | |
) | |
backend = build_system.get("build-backend") | |
backend_path = build_system.get("backend-path", []) | |
check = [] # type: List[str] | |
if backend is None: | |
# If the user didn't specify a backend, we assume they want to use | |
# the setuptools backend. But we can't be sure they have included | |
# a version of setuptools which supplies the backend, or wheel | |
# (which is needed by the backend) in their requirements. So we | |
# make a note to check that those requirements are present once | |
# we have set up the environment. | |
# This is quite a lot of work to check for a very specific case. But | |
# the problem is, that case is potentially quite common - projects that | |
# adopted PEP 518 early for the ability to specify requirements to | |
# execute setup.py, but never considered needing to mention the build | |
# tools themselves. The original PEP 518 code had a similar check (but | |
# implemented in a different way). | |
backend = "setuptools.build_meta:__legacy__" | |
check = ["setuptools>=40.8.0", "wheel"] | |
return BuildSystemDetails(requires, backend, check, backend_path) |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import logging | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from .req_file import parse_requirements | |
from .req_install import InstallRequirement | |
from .req_set import RequirementSet | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, List, Sequence | |
__all__ = [ | |
"RequirementSet", "InstallRequirement", | |
"parse_requirements", "install_given_reqs", | |
] | |
logger = logging.getLogger(__name__) | |
class InstallationResult(object): | |
def __init__(self, name): | |
# type: (str) -> None | |
self.name = name | |
def __repr__(self): | |
# type: () -> str | |
return "InstallationResult(name={!r})".format(self.name) | |
def install_given_reqs( | |
to_install, # type: List[InstallRequirement] | |
install_options, # type: List[str] | |
global_options=(), # type: Sequence[str] | |
*args, # type: Any | |
**kwargs # type: Any | |
): | |
# type: (...) -> List[InstallationResult] | |
""" | |
Install everything in the given list. | |
(to be called after having downloaded and unpacked the packages) | |
""" | |
if to_install: | |
logger.info( | |
'Installing collected packages: %s', | |
', '.join([req.name for req in to_install]), | |
) | |
installed = [] | |
with indent_log(): | |
for requirement in to_install: | |
if requirement.should_reinstall: | |
logger.info('Attempting uninstall: %s', requirement.name) | |
with indent_log(): | |
uninstalled_pathset = requirement.uninstall( | |
auto_confirm=True | |
) | |
try: | |
requirement.install( | |
install_options, | |
global_options, | |
*args, | |
**kwargs | |
) | |
except Exception: | |
should_rollback = ( | |
requirement.should_reinstall and | |
not requirement.install_succeeded | |
) | |
# if install did not succeed, rollback previous uninstall | |
if should_rollback: | |
uninstalled_pathset.rollback() | |
raise | |
else: | |
should_commit = ( | |
requirement.should_reinstall and | |
requirement.install_succeeded | |
) | |
if should_commit: | |
uninstalled_pathset.commit() | |
installed.append(InstallationResult(requirement.name)) | |
return installed |
"""Backing implementation for InstallRequirement's various constructors | |
The idea here is that these formed a major chunk of InstallRequirement's size | |
so, moving them and support code dedicated to them outside of that class | |
helps creates for better understandability for the rest of the code. | |
These are meant to be used elsewhere within pip to create instances of | |
InstallRequirement. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
import logging | |
import os | |
import re | |
from pip._vendor.packaging.markers import Marker | |
from pip._vendor.packaging.requirements import InvalidRequirement, Requirement | |
from pip._vendor.packaging.specifiers import Specifier | |
from pip._vendor.pkg_resources import RequirementParseError, parse_requirements | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.models.index import PyPI, TestPyPI | |
from pip._internal.models.link import Link | |
from pip._internal.models.wheel import Wheel | |
from pip._internal.pyproject import make_pyproject_path | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.utils.filetypes import ARCHIVE_EXTENSIONS | |
from pip._internal.utils.misc import is_installable_dir, splitext | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import path_to_url | |
from pip._internal.vcs import is_url, vcs | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Dict, Optional, Set, Tuple, Union, | |
) | |
from pip._internal.req.req_file import ParsedRequirement | |
__all__ = [ | |
"install_req_from_editable", "install_req_from_line", | |
"parse_editable" | |
] | |
logger = logging.getLogger(__name__) | |
operators = Specifier._operators.keys() | |
def is_archive_file(name): | |
# type: (str) -> bool | |
"""Return True if `name` is a considered as an archive file.""" | |
ext = splitext(name)[1].lower() | |
if ext in ARCHIVE_EXTENSIONS: | |
return True | |
return False | |
def _strip_extras(path): | |
# type: (str) -> Tuple[str, Optional[str]] | |
m = re.match(r'^(.+)(\[[^\]]+\])$', path) | |
extras = None | |
if m: | |
path_no_extras = m.group(1) | |
extras = m.group(2) | |
else: | |
path_no_extras = path | |
return path_no_extras, extras | |
def convert_extras(extras): | |
# type: (Optional[str]) -> Set[str] | |
if not extras: | |
return set() | |
return Requirement("placeholder" + extras.lower()).extras | |
def parse_editable(editable_req): | |
# type: (str) -> Tuple[Optional[str], str, Optional[Set[str]]] | |
"""Parses an editable requirement into: | |
- a requirement name | |
- an URL | |
- extras | |
- editable options | |
Accepted requirements: | |
svn+http://blahblah@rev#egg=Foobar[baz]&subdirectory=version_subdir | |
.[some_extra] | |
""" | |
url = editable_req | |
# If a file path is specified with extras, strip off the extras. | |
url_no_extras, extras = _strip_extras(url) | |
if os.path.isdir(url_no_extras): | |
if not os.path.exists(os.path.join(url_no_extras, 'setup.py')): | |
msg = ( | |
'File "setup.py" not found. Directory cannot be installed ' | |
'in editable mode: {}'.format(os.path.abspath(url_no_extras)) | |
) | |
pyproject_path = make_pyproject_path(url_no_extras) | |
if os.path.isfile(pyproject_path): | |
msg += ( | |
'\n(A "pyproject.toml" file was found, but editable ' | |
'mode currently requires a setup.py based build.)' | |
) | |
raise InstallationError(msg) | |
# Treating it as code that has already been checked out | |
url_no_extras = path_to_url(url_no_extras) | |
if url_no_extras.lower().startswith('file:'): | |
package_name = Link(url_no_extras).egg_fragment | |
if extras: | |
return ( | |
package_name, | |
url_no_extras, | |
Requirement("placeholder" + extras.lower()).extras, | |
) | |
else: | |
return package_name, url_no_extras, None | |
for version_control in vcs: | |
if url.lower().startswith('{}:'.format(version_control)): | |
url = '{}+{}'.format(version_control, url) | |
break | |
if '+' not in url: | |
raise InstallationError( | |
'{} is not a valid editable requirement. ' | |
'It should either be a path to a local project or a VCS URL ' | |
'(beginning with svn+, git+, hg+, or bzr+).'.format(editable_req) | |
) | |
vc_type = url.split('+', 1)[0].lower() | |
if not vcs.get_backend(vc_type): | |
backends = ", ".join([bends.name + '+URL' for bends in vcs.backends]) | |
error_message = "For --editable={}, " \ | |
"only {} are currently supported".format( | |
editable_req, backends) | |
raise InstallationError(error_message) | |
package_name = Link(url).egg_fragment | |
if not package_name: | |
raise InstallationError( | |
"Could not detect requirement name for '{}', please specify one " | |
"with #egg=your_package_name".format(editable_req) | |
) | |
return package_name, url, None | |
def deduce_helpful_msg(req): | |
# type: (str) -> str | |
"""Returns helpful msg in case requirements file does not exist, | |
or cannot be parsed. | |
:params req: Requirements file path | |
""" | |
msg = "" | |
if os.path.exists(req): | |
msg = " It does exist." | |
# Try to parse and check if it is a requirements file. | |
try: | |
with open(req, 'r') as fp: | |
# parse first line only | |
next(parse_requirements(fp.read())) | |
msg += ( | |
"The argument you provided " | |
"({}) appears to be a" | |
" requirements file. If that is the" | |
" case, use the '-r' flag to install" | |
" the packages specified within it." | |
).format(req) | |
except RequirementParseError: | |
logger.debug("Cannot parse '{}' as requirements \ | |
file".format(req), exc_info=True) | |
else: | |
msg += " File '{}' does not exist.".format(req) | |
return msg | |
class RequirementParts(object): | |
def __init__( | |
self, | |
requirement, # type: Optional[Requirement] | |
link, # type: Optional[Link] | |
markers, # type: Optional[Marker] | |
extras, # type: Set[str] | |
): | |
self.requirement = requirement | |
self.link = link | |
self.markers = markers | |
self.extras = extras | |
def parse_req_from_editable(editable_req): | |
# type: (str) -> RequirementParts | |
name, url, extras_override = parse_editable(editable_req) | |
if name is not None: | |
try: | |
req = Requirement(name) | |
except InvalidRequirement: | |
raise InstallationError("Invalid requirement: '{}'".format(name)) | |
else: | |
req = None | |
link = Link(url) | |
return RequirementParts(req, link, None, extras_override) | |
# ---- The actual constructors follow ---- | |
def install_req_from_editable( | |
editable_req, # type: str | |
comes_from=None, # type: Optional[Union[InstallRequirement, str]] | |
use_pep517=None, # type: Optional[bool] | |
isolated=False, # type: bool | |
options=None, # type: Optional[Dict[str, Any]] | |
constraint=False # type: bool | |
): | |
# type: (...) -> InstallRequirement | |
parts = parse_req_from_editable(editable_req) | |
return InstallRequirement( | |
parts.requirement, | |
comes_from=comes_from, | |
editable=True, | |
link=parts.link, | |
constraint=constraint, | |
use_pep517=use_pep517, | |
isolated=isolated, | |
install_options=options.get("install_options", []) if options else [], | |
global_options=options.get("global_options", []) if options else [], | |
hash_options=options.get("hashes", {}) if options else {}, | |
extras=parts.extras, | |
) | |
def _looks_like_path(name): | |
# type: (str) -> bool | |
"""Checks whether the string "looks like" a path on the filesystem. | |
This does not check whether the target actually exists, only judge from the | |
appearance. | |
Returns true if any of the following conditions is true: | |
* a path separator is found (either os.path.sep or os.path.altsep); | |
* a dot is found (which represents the current directory). | |
""" | |
if os.path.sep in name: | |
return True | |
if os.path.altsep is not None and os.path.altsep in name: | |
return True | |
if name.startswith("."): | |
return True | |
return False | |
def _get_url_from_path(path, name): | |
# type: (str, str) -> str | |
""" | |
First, it checks whether a provided path is an installable directory | |
(e.g. it has a setup.py). If it is, returns the path. | |
If false, check if the path is an archive file (such as a .whl). | |
The function checks if the path is a file. If false, if the path has | |
an @, it will treat it as a PEP 440 URL requirement and return the path. | |
""" | |
if _looks_like_path(name) and os.path.isdir(path): | |
if is_installable_dir(path): | |
return path_to_url(path) | |
raise InstallationError( | |
"Directory {name!r} is not installable. Neither 'setup.py' " | |
"nor 'pyproject.toml' found.".format(**locals()) | |
) | |
if not is_archive_file(path): | |
return None | |
if os.path.isfile(path): | |
return path_to_url(path) | |
urlreq_parts = name.split('@', 1) | |
if len(urlreq_parts) >= 2 and not _looks_like_path(urlreq_parts[0]): | |
# If the path contains '@' and the part before it does not look | |
# like a path, try to treat it as a PEP 440 URL req instead. | |
return None | |
logger.warning( | |
'Requirement %r looks like a filename, but the ' | |
'file does not exist', | |
name | |
) | |
return path_to_url(path) | |
def parse_req_from_line(name, line_source): | |
# type: (str, Optional[str]) -> RequirementParts | |
if is_url(name): | |
marker_sep = '; ' | |
else: | |
marker_sep = ';' | |
if marker_sep in name: | |
name, markers_as_string = name.split(marker_sep, 1) | |
markers_as_string = markers_as_string.strip() | |
if not markers_as_string: | |
markers = None | |
else: | |
markers = Marker(markers_as_string) | |
else: | |
markers = None | |
name = name.strip() | |
req_as_string = None | |
path = os.path.normpath(os.path.abspath(name)) | |
link = None | |
extras_as_string = None | |
if is_url(name): | |
link = Link(name) | |
else: | |
p, extras_as_string = _strip_extras(path) | |
url = _get_url_from_path(p, name) | |
if url is not None: | |
link = Link(url) | |
# it's a local file, dir, or url | |
if link: | |
# Handle relative file URLs | |
if link.scheme == 'file' and re.search(r'\.\./', link.url): | |
link = Link( | |
path_to_url(os.path.normpath(os.path.abspath(link.path)))) | |
# wheel file | |
if link.is_wheel: | |
wheel = Wheel(link.filename) # can raise InvalidWheelFilename | |
req_as_string = "{wheel.name}=={wheel.version}".format(**locals()) | |
else: | |
# set the req to the egg fragment. when it's not there, this | |
# will become an 'unnamed' requirement | |
req_as_string = link.egg_fragment | |
# a requirement specifier | |
else: | |
req_as_string = name | |
extras = convert_extras(extras_as_string) | |
def with_source(text): | |
# type: (str) -> str | |
if not line_source: | |
return text | |
return '{} (from {})'.format(text, line_source) | |
if req_as_string is not None: | |
try: | |
req = Requirement(req_as_string) | |
except InvalidRequirement: | |
if os.path.sep in req_as_string: | |
add_msg = "It looks like a path." | |
add_msg += deduce_helpful_msg(req_as_string) | |
elif ('=' in req_as_string and | |
not any(op in req_as_string for op in operators)): | |
add_msg = "= is not a valid operator. Did you mean == ?" | |
else: | |
add_msg = '' | |
msg = with_source( | |
'Invalid requirement: {!r}'.format(req_as_string) | |
) | |
if add_msg: | |
msg += '\nHint: {}'.format(add_msg) | |
raise InstallationError(msg) | |
else: | |
req = None | |
return RequirementParts(req, link, markers, extras) | |
def install_req_from_line( | |
name, # type: str | |
comes_from=None, # type: Optional[Union[str, InstallRequirement]] | |
use_pep517=None, # type: Optional[bool] | |
isolated=False, # type: bool | |
options=None, # type: Optional[Dict[str, Any]] | |
constraint=False, # type: bool | |
line_source=None, # type: Optional[str] | |
): | |
# type: (...) -> InstallRequirement | |
"""Creates an InstallRequirement from a name, which might be a | |
requirement, directory containing 'setup.py', filename, or URL. | |
:param line_source: An optional string describing where the line is from, | |
for logging purposes in case of an error. | |
""" | |
parts = parse_req_from_line(name, line_source) | |
return InstallRequirement( | |
parts.requirement, comes_from, link=parts.link, markers=parts.markers, | |
use_pep517=use_pep517, isolated=isolated, | |
install_options=options.get("install_options", []) if options else [], | |
global_options=options.get("global_options", []) if options else [], | |
hash_options=options.get("hashes", {}) if options else {}, | |
constraint=constraint, | |
extras=parts.extras, | |
) | |
def install_req_from_req_string( | |
req_string, # type: str | |
comes_from=None, # type: Optional[InstallRequirement] | |
isolated=False, # type: bool | |
use_pep517=None # type: Optional[bool] | |
): | |
# type: (...) -> InstallRequirement | |
try: | |
req = Requirement(req_string) | |
except InvalidRequirement: | |
raise InstallationError("Invalid requirement: '{}'".format(req_string)) | |
domains_not_allowed = [ | |
PyPI.file_storage_domain, | |
TestPyPI.file_storage_domain, | |
] | |
if (req.url and comes_from and comes_from.link and | |
comes_from.link.netloc in domains_not_allowed): | |
# Explicitly disallow pypi packages that depend on external urls | |
raise InstallationError( | |
"Packages installed from PyPI cannot depend on packages " | |
"which are not also hosted on PyPI.\n" | |
"{} depends on {} ".format(comes_from.name, req) | |
) | |
return InstallRequirement( | |
req, comes_from, isolated=isolated, use_pep517=use_pep517 | |
) | |
def install_req_from_parsed_requirement( | |
parsed_req, # type: ParsedRequirement | |
isolated=False, # type: bool | |
use_pep517=None # type: Optional[bool] | |
): | |
# type: (...) -> InstallRequirement | |
if parsed_req.is_editable: | |
req = install_req_from_editable( | |
parsed_req.requirement, | |
comes_from=parsed_req.comes_from, | |
use_pep517=use_pep517, | |
constraint=parsed_req.constraint, | |
isolated=isolated, | |
) | |
else: | |
req = install_req_from_line( | |
parsed_req.requirement, | |
comes_from=parsed_req.comes_from, | |
use_pep517=use_pep517, | |
isolated=isolated, | |
options=parsed_req.options, | |
constraint=parsed_req.constraint, | |
line_source=parsed_req.line_source, | |
) | |
return req |
""" | |
Requirements file parsing | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import optparse | |
import os | |
import re | |
import shlex | |
import sys | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._internal.cli import cmdoptions | |
from pip._internal.exceptions import ( | |
InstallationError, | |
RequirementsFileParseError, | |
) | |
from pip._internal.models.search_scope import SearchScope | |
from pip._internal.utils.encoding import auto_decode | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import get_url_scheme | |
if MYPY_CHECK_RUNNING: | |
from optparse import Values | |
from typing import ( | |
Any, Callable, Dict, Iterator, List, NoReturn, Optional, Text, Tuple, | |
) | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.network.session import PipSession | |
ReqFileLines = Iterator[Tuple[int, Text]] | |
LineParser = Callable[[Text], Tuple[str, Values]] | |
__all__ = ['parse_requirements'] | |
SCHEME_RE = re.compile(r'^(http|https|file):', re.I) | |
COMMENT_RE = re.compile(r'(^|\s+)#.*$') | |
# Matches environment variable-style values in '${MY_VARIABLE_1}' with the | |
# variable name consisting of only uppercase letters, digits or the '_' | |
# (underscore). This follows the POSIX standard defined in IEEE Std 1003.1, | |
# 2013 Edition. | |
ENV_VAR_RE = re.compile(r'(?P<var>\$\{(?P<name>[A-Z0-9_]+)\})') | |
SUPPORTED_OPTIONS = [ | |
cmdoptions.index_url, | |
cmdoptions.extra_index_url, | |
cmdoptions.no_index, | |
cmdoptions.constraints, | |
cmdoptions.requirements, | |
cmdoptions.editable, | |
cmdoptions.find_links, | |
cmdoptions.no_binary, | |
cmdoptions.only_binary, | |
cmdoptions.require_hashes, | |
cmdoptions.pre, | |
cmdoptions.trusted_host, | |
cmdoptions.always_unzip, # Deprecated | |
] # type: List[Callable[..., optparse.Option]] | |
# options to be passed to requirements | |
SUPPORTED_OPTIONS_REQ = [ | |
cmdoptions.install_options, | |
cmdoptions.global_options, | |
cmdoptions.hash, | |
] # type: List[Callable[..., optparse.Option]] | |
# the 'dest' string values | |
SUPPORTED_OPTIONS_REQ_DEST = [str(o().dest) for o in SUPPORTED_OPTIONS_REQ] | |
class ParsedRequirement(object): | |
def __init__( | |
self, | |
requirement, # type:str | |
is_editable, # type: bool | |
comes_from, # type: str | |
constraint, # type: bool | |
options=None, # type: Optional[Dict[str, Any]] | |
line_source=None, # type: Optional[str] | |
): | |
# type: (...) -> None | |
self.requirement = requirement | |
self.is_editable = is_editable | |
self.comes_from = comes_from | |
self.options = options | |
self.constraint = constraint | |
self.line_source = line_source | |
class ParsedLine(object): | |
def __init__( | |
self, | |
filename, # type: str | |
lineno, # type: int | |
comes_from, # type: str | |
args, # type: str | |
opts, # type: Values | |
constraint, # type: bool | |
): | |
# type: (...) -> None | |
self.filename = filename | |
self.lineno = lineno | |
self.comes_from = comes_from | |
self.opts = opts | |
self.constraint = constraint | |
if args: | |
self.is_requirement = True | |
self.is_editable = False | |
self.requirement = args | |
elif opts.editables: | |
self.is_requirement = True | |
self.is_editable = True | |
# We don't support multiple -e on one line | |
self.requirement = opts.editables[0] | |
else: | |
self.is_requirement = False | |
def parse_requirements( | |
filename, # type: str | |
session, # type: PipSession | |
finder=None, # type: Optional[PackageFinder] | |
comes_from=None, # type: Optional[str] | |
options=None, # type: Optional[optparse.Values] | |
constraint=False, # type: bool | |
): | |
# type: (...) -> Iterator[ParsedRequirement] | |
"""Parse a requirements file and yield InstallRequirement instances. | |
:param filename: Path or url of requirements file. | |
:param session: PipSession instance. | |
:param finder: Instance of pip.index.PackageFinder. | |
:param comes_from: Origin description of requirements. | |
:param options: cli options. | |
:param constraint: If true, parsing a constraint file rather than | |
requirements file. | |
""" | |
line_parser = get_line_parser(finder) | |
parser = RequirementsFileParser(session, line_parser, comes_from) | |
for parsed_line in parser.parse(filename, constraint): | |
parsed_req = handle_line( | |
parsed_line, | |
options=options, | |
finder=finder, | |
session=session | |
) | |
if parsed_req is not None: | |
yield parsed_req | |
def preprocess(content): | |
# type: (Text) -> ReqFileLines | |
"""Split, filter, and join lines, and return a line iterator | |
:param content: the content of the requirements file | |
""" | |
lines_enum = enumerate(content.splitlines(), start=1) # type: ReqFileLines | |
lines_enum = join_lines(lines_enum) | |
lines_enum = ignore_comments(lines_enum) | |
lines_enum = expand_env_variables(lines_enum) | |
return lines_enum | |
def handle_requirement_line( | |
line, # type: ParsedLine | |
options=None, # type: Optional[optparse.Values] | |
): | |
# type: (...) -> ParsedRequirement | |
# preserve for the nested code path | |
line_comes_from = '{} {} (line {})'.format( | |
'-c' if line.constraint else '-r', line.filename, line.lineno, | |
) | |
assert line.is_requirement | |
if line.is_editable: | |
# For editable requirements, we don't support per-requirement | |
# options, so just return the parsed requirement. | |
return ParsedRequirement( | |
requirement=line.requirement, | |
is_editable=line.is_editable, | |
comes_from=line_comes_from, | |
constraint=line.constraint, | |
) | |
else: | |
if options: | |
# Disable wheels if the user has specified build options | |
cmdoptions.check_install_build_global(options, line.opts) | |
# get the options that apply to requirements | |
req_options = {} | |
for dest in SUPPORTED_OPTIONS_REQ_DEST: | |
if dest in line.opts.__dict__ and line.opts.__dict__[dest]: | |
req_options[dest] = line.opts.__dict__[dest] | |
line_source = 'line {} of {}'.format(line.lineno, line.filename) | |
return ParsedRequirement( | |
requirement=line.requirement, | |
is_editable=line.is_editable, | |
comes_from=line_comes_from, | |
constraint=line.constraint, | |
options=req_options, | |
line_source=line_source, | |
) | |
def handle_option_line( | |
opts, # type: Values | |
filename, # type: str | |
lineno, # type: int | |
finder=None, # type: Optional[PackageFinder] | |
options=None, # type: Optional[optparse.Values] | |
session=None, # type: Optional[PipSession] | |
): | |
# type: (...) -> None | |
# percolate hash-checking option upward | |
if opts.require_hashes: | |
options.require_hashes = opts.require_hashes | |
# set finder options | |
elif finder: | |
find_links = finder.find_links | |
index_urls = finder.index_urls | |
if opts.index_url: | |
index_urls = [opts.index_url] | |
if opts.no_index is True: | |
index_urls = [] | |
if opts.extra_index_urls: | |
index_urls.extend(opts.extra_index_urls) | |
if opts.find_links: | |
# FIXME: it would be nice to keep track of the source | |
# of the find_links: support a find-links local path | |
# relative to a requirements file. | |
value = opts.find_links[0] | |
req_dir = os.path.dirname(os.path.abspath(filename)) | |
relative_to_reqs_file = os.path.join(req_dir, value) | |
if os.path.exists(relative_to_reqs_file): | |
value = relative_to_reqs_file | |
find_links.append(value) | |
search_scope = SearchScope( | |
find_links=find_links, | |
index_urls=index_urls, | |
) | |
finder.search_scope = search_scope | |
if opts.pre: | |
finder.set_allow_all_prereleases() | |
if session: | |
for host in opts.trusted_hosts or []: | |
source = 'line {} of {}'.format(lineno, filename) | |
session.add_trusted_host(host, source=source) | |
def handle_line( | |
line, # type: ParsedLine | |
options=None, # type: Optional[optparse.Values] | |
finder=None, # type: Optional[PackageFinder] | |
session=None, # type: Optional[PipSession] | |
): | |
# type: (...) -> Optional[ParsedRequirement] | |
"""Handle a single parsed requirements line; This can result in | |
creating/yielding requirements, or updating the finder. | |
:param line: The parsed line to be processed. | |
:param options: CLI options. | |
:param finder: The finder - updated by non-requirement lines. | |
:param session: The session - updated by non-requirement lines. | |
Returns a ParsedRequirement object if the line is a requirement line, | |
otherwise returns None. | |
For lines that contain requirements, the only options that have an effect | |
are from SUPPORTED_OPTIONS_REQ, and they are scoped to the | |
requirement. Other options from SUPPORTED_OPTIONS may be present, but are | |
ignored. | |
For lines that do not contain requirements, the only options that have an | |
effect are from SUPPORTED_OPTIONS. Options from SUPPORTED_OPTIONS_REQ may | |
be present, but are ignored. These lines may contain multiple options | |
(although our docs imply only one is supported), and all our parsed and | |
affect the finder. | |
""" | |
if line.is_requirement: | |
parsed_req = handle_requirement_line(line, options) | |
return parsed_req | |
else: | |
handle_option_line( | |
line.opts, | |
line.filename, | |
line.lineno, | |
finder, | |
options, | |
session, | |
) | |
return None | |
class RequirementsFileParser(object): | |
def __init__( | |
self, | |
session, # type: PipSession | |
line_parser, # type: LineParser | |
comes_from, # type: str | |
): | |
# type: (...) -> None | |
self._session = session | |
self._line_parser = line_parser | |
self._comes_from = comes_from | |
def parse(self, filename, constraint): | |
# type: (str, bool) -> Iterator[ParsedLine] | |
"""Parse a given file, yielding parsed lines. | |
""" | |
for line in self._parse_and_recurse(filename, constraint): | |
yield line | |
def _parse_and_recurse(self, filename, constraint): | |
# type: (str, bool) -> Iterator[ParsedLine] | |
for line in self._parse_file(filename, constraint): | |
if ( | |
not line.is_requirement and | |
(line.opts.requirements or line.opts.constraints) | |
): | |
# parse a nested requirements file | |
if line.opts.requirements: | |
req_path = line.opts.requirements[0] | |
nested_constraint = False | |
else: | |
req_path = line.opts.constraints[0] | |
nested_constraint = True | |
# original file is over http | |
if SCHEME_RE.search(filename): | |
# do a url join so relative paths work | |
req_path = urllib_parse.urljoin(filename, req_path) | |
# original file and nested file are paths | |
elif not SCHEME_RE.search(req_path): | |
# do a join so relative paths work | |
req_path = os.path.join( | |
os.path.dirname(filename), req_path, | |
) | |
for inner_line in self._parse_and_recurse( | |
req_path, nested_constraint, | |
): | |
yield inner_line | |
else: | |
yield line | |
def _parse_file(self, filename, constraint): | |
# type: (str, bool) -> Iterator[ParsedLine] | |
_, content = get_file_content( | |
filename, self._session, comes_from=self._comes_from | |
) | |
lines_enum = preprocess(content) | |
for line_number, line in lines_enum: | |
try: | |
args_str, opts = self._line_parser(line) | |
except OptionParsingError as e: | |
# add offending line | |
msg = 'Invalid requirement: {}\n{}'.format(line, e.msg) | |
raise RequirementsFileParseError(msg) | |
yield ParsedLine( | |
filename, | |
line_number, | |
self._comes_from, | |
args_str, | |
opts, | |
constraint, | |
) | |
def get_line_parser(finder): | |
# type: (Optional[PackageFinder]) -> LineParser | |
def parse_line(line): | |
# type: (Text) -> Tuple[str, Values] | |
# Build new parser for each line since it accumulates appendable | |
# options. | |
parser = build_parser() | |
defaults = parser.get_default_values() | |
defaults.index_url = None | |
if finder: | |
defaults.format_control = finder.format_control | |
args_str, options_str = break_args_options(line) | |
# Prior to 2.7.3, shlex cannot deal with unicode entries | |
if sys.version_info < (2, 7, 3): | |
# https://github.com/python/mypy/issues/1174 | |
options_str = options_str.encode('utf8') # type: ignore | |
# https://github.com/python/mypy/issues/1174 | |
opts, _ = parser.parse_args( | |
shlex.split(options_str), defaults) # type: ignore | |
return args_str, opts | |
return parse_line | |
def break_args_options(line): | |
# type: (Text) -> Tuple[str, Text] | |
"""Break up the line into an args and options string. We only want to shlex | |
(and then optparse) the options, not the args. args can contain markers | |
which are corrupted by shlex. | |
""" | |
tokens = line.split(' ') | |
args = [] | |
options = tokens[:] | |
for token in tokens: | |
if token.startswith('-') or token.startswith('--'): | |
break | |
else: | |
args.append(token) | |
options.pop(0) | |
return ' '.join(args), ' '.join(options) # type: ignore | |
class OptionParsingError(Exception): | |
def __init__(self, msg): | |
# type: (str) -> None | |
self.msg = msg | |
def build_parser(): | |
# type: () -> optparse.OptionParser | |
""" | |
Return a parser for parsing requirement lines | |
""" | |
parser = optparse.OptionParser(add_help_option=False) | |
option_factories = SUPPORTED_OPTIONS + SUPPORTED_OPTIONS_REQ | |
for option_factory in option_factories: | |
option = option_factory() | |
parser.add_option(option) | |
# By default optparse sys.exits on parsing errors. We want to wrap | |
# that in our own exception. | |
def parser_exit(self, msg): | |
# type: (Any, str) -> NoReturn | |
raise OptionParsingError(msg) | |
# NOTE: mypy disallows assigning to a method | |
# https://github.com/python/mypy/issues/2427 | |
parser.exit = parser_exit # type: ignore | |
return parser | |
def join_lines(lines_enum): | |
# type: (ReqFileLines) -> ReqFileLines | |
"""Joins a line ending in '\' with the previous line (except when following | |
comments). The joined line takes on the index of the first line. | |
""" | |
primary_line_number = None | |
new_line = [] # type: List[Text] | |
for line_number, line in lines_enum: | |
if not line.endswith('\\') or COMMENT_RE.match(line): | |
if COMMENT_RE.match(line): | |
# this ensures comments are always matched later | |
line = ' ' + line | |
if new_line: | |
new_line.append(line) | |
yield primary_line_number, ''.join(new_line) | |
new_line = [] | |
else: | |
yield line_number, line | |
else: | |
if not new_line: | |
primary_line_number = line_number | |
new_line.append(line.strip('\\')) | |
# last line contains \ | |
if new_line: | |
yield primary_line_number, ''.join(new_line) | |
# TODO: handle space after '\'. | |
def ignore_comments(lines_enum): | |
# type: (ReqFileLines) -> ReqFileLines | |
""" | |
Strips comments and filter empty lines. | |
""" | |
for line_number, line in lines_enum: | |
line = COMMENT_RE.sub('', line) | |
line = line.strip() | |
if line: | |
yield line_number, line | |
def expand_env_variables(lines_enum): | |
# type: (ReqFileLines) -> ReqFileLines | |
"""Replace all environment variables that can be retrieved via `os.getenv`. | |
The only allowed format for environment variables defined in the | |
requirement file is `${MY_VARIABLE_1}` to ensure two things: | |
1. Strings that contain a `$` aren't accidentally (partially) expanded. | |
2. Ensure consistency across platforms for requirement files. | |
These points are the result of a discussion on the `github pull | |
request #3514 <https://github.com/pypa/pip/pull/3514>`_. | |
Valid characters in variable names follow the `POSIX standard | |
<http://pubs.opengroup.org/onlinepubs/9699919799/>`_ and are limited | |
to uppercase letter, digits and the `_` (underscore). | |
""" | |
for line_number, line in lines_enum: | |
for env_var, var_name in ENV_VAR_RE.findall(line): | |
value = os.getenv(var_name) | |
if not value: | |
continue | |
line = line.replace(env_var, value) | |
yield line_number, line | |
def get_file_content(url, session, comes_from=None): | |
# type: (str, PipSession, Optional[str]) -> Tuple[str, Text] | |
"""Gets the content of a file; it may be a filename, file: URL, or | |
http: URL. Returns (location, content). Content is unicode. | |
Respects # -*- coding: declarations on the retrieved files. | |
:param url: File path or url. | |
:param session: PipSession instance. | |
:param comes_from: Origin description of requirements. | |
""" | |
scheme = get_url_scheme(url) | |
if scheme in ['http', 'https']: | |
# FIXME: catch some errors | |
resp = session.get(url) | |
resp.raise_for_status() | |
return resp.url, resp.text | |
elif scheme == 'file': | |
if comes_from and comes_from.startswith('http'): | |
raise InstallationError( | |
'Requirements file {} references URL {}, ' | |
'which is local'.format(comes_from, url) | |
) | |
path = url.split(':', 1)[1] | |
path = path.replace('\\', '/') | |
match = _url_slash_drive_re.match(path) | |
if match: | |
path = match.group(1) + ':' + path.split('|', 1)[1] | |
path = urllib_parse.unquote(path) | |
if path.startswith('/'): | |
path = '/' + path.lstrip('/') | |
url = path | |
try: | |
with open(url, 'rb') as f: | |
content = auto_decode(f.read()) | |
except IOError as exc: | |
raise InstallationError( | |
'Could not open requirements file: {}'.format(exc) | |
) | |
return url, content | |
_url_slash_drive_re = re.compile(r'/*([a-z])\|', re.I) |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
import shutil | |
import sys | |
import zipfile | |
from pip._vendor import pkg_resources, six | |
from pip._vendor.packaging.requirements import Requirement | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.packaging.version import Version | |
from pip._vendor.packaging.version import parse as parse_version | |
from pip._vendor.pep517.wrappers import Pep517HookCaller | |
from pip._internal.build_env import NoOpBuildEnvironment | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.locations import get_scheme | |
from pip._internal.models.link import Link | |
from pip._internal.operations.build.metadata import generate_metadata | |
from pip._internal.operations.build.metadata_legacy import \ | |
generate_metadata as generate_metadata_legacy | |
from pip._internal.operations.install.editable_legacy import \ | |
install_editable as install_editable_legacy | |
from pip._internal.operations.install.legacy import LegacyInstallFailure | |
from pip._internal.operations.install.legacy import install as install_legacy | |
from pip._internal.operations.install.wheel import install_wheel | |
from pip._internal.pyproject import load_pyproject_toml, make_pyproject_path | |
from pip._internal.req.req_uninstall import UninstallPathSet | |
from pip._internal.utils.deprecation import deprecated | |
from pip._internal.utils.direct_url_helpers import direct_url_from_link | |
from pip._internal.utils.hashes import Hashes | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import ( | |
ask_path_exists, | |
backup_dir, | |
display_path, | |
dist_in_site_packages, | |
dist_in_usersite, | |
get_installed_version, | |
hide_url, | |
redact_auth_from_url, | |
) | |
from pip._internal.utils.packaging import get_metadata | |
from pip._internal.utils.temp_dir import TempDirectory, tempdir_kinds | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.virtualenv import running_under_virtualenv | |
from pip._internal.vcs import vcs | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Dict, Iterable, List, Optional, Sequence, Union, | |
) | |
from pip._internal.build_env import BuildEnvironment | |
from pip._vendor.pkg_resources import Distribution | |
from pip._vendor.packaging.specifiers import SpecifierSet | |
from pip._vendor.packaging.markers import Marker | |
logger = logging.getLogger(__name__) | |
def _get_dist(metadata_directory): | |
# type: (str) -> Distribution | |
"""Return a pkg_resources.Distribution for the provided | |
metadata directory. | |
""" | |
dist_dir = metadata_directory.rstrip(os.sep) | |
# Build a PathMetadata object, from path to metadata. :wink: | |
base_dir, dist_dir_name = os.path.split(dist_dir) | |
metadata = pkg_resources.PathMetadata(base_dir, dist_dir) | |
# Determine the correct Distribution object type. | |
if dist_dir.endswith(".egg-info"): | |
dist_cls = pkg_resources.Distribution | |
dist_name = os.path.splitext(dist_dir_name)[0] | |
else: | |
assert dist_dir.endswith(".dist-info") | |
dist_cls = pkg_resources.DistInfoDistribution | |
dist_name = os.path.splitext(dist_dir_name)[0].split("-")[0] | |
return dist_cls( | |
base_dir, | |
project_name=dist_name, | |
metadata=metadata, | |
) | |
class InstallRequirement(object): | |
""" | |
Represents something that may be installed later on, may have information | |
about where to fetch the relevant requirement and also contains logic for | |
installing the said requirement. | |
""" | |
def __init__( | |
self, | |
req, # type: Optional[Requirement] | |
comes_from, # type: Optional[Union[str, InstallRequirement]] | |
editable=False, # type: bool | |
link=None, # type: Optional[Link] | |
markers=None, # type: Optional[Marker] | |
use_pep517=None, # type: Optional[bool] | |
isolated=False, # type: bool | |
install_options=None, # type: Optional[List[str]] | |
global_options=None, # type: Optional[List[str]] | |
hash_options=None, # type: Optional[Dict[str, List[str]]] | |
constraint=False, # type: bool | |
extras=() # type: Iterable[str] | |
): | |
# type: (...) -> None | |
assert req is None or isinstance(req, Requirement), req | |
self.req = req | |
self.comes_from = comes_from | |
self.constraint = constraint | |
self.editable = editable | |
# source_dir is the local directory where the linked requirement is | |
# located, or unpacked. In case unpacking is needed, creating and | |
# populating source_dir is done by the RequirementPreparer. Note this | |
# is not necessarily the directory where pyproject.toml or setup.py is | |
# located - that one is obtained via unpacked_source_directory. | |
self.source_dir = None # type: Optional[str] | |
if self.editable: | |
assert link | |
if link.is_file: | |
self.source_dir = os.path.normpath( | |
os.path.abspath(link.file_path) | |
) | |
if link is None and req and req.url: | |
# PEP 508 URL requirement | |
link = Link(req.url) | |
self.link = self.original_link = link | |
self.original_link_is_in_wheel_cache = False | |
# Path to any downloaded or already-existing package. | |
self.local_file_path = None # type: Optional[str] | |
if self.link and self.link.is_file: | |
self.local_file_path = self.link.file_path | |
if extras: | |
self.extras = extras | |
elif req: | |
self.extras = { | |
pkg_resources.safe_extra(extra) for extra in req.extras | |
} | |
else: | |
self.extras = set() | |
if markers is None and req: | |
markers = req.marker | |
self.markers = markers | |
# This holds the pkg_resources.Distribution object if this requirement | |
# is already available: | |
self.satisfied_by = None # type: Optional[Distribution] | |
# Whether the installation process should try to uninstall an existing | |
# distribution before installing this requirement. | |
self.should_reinstall = False | |
# Temporary build location | |
self._temp_build_dir = None # type: Optional[TempDirectory] | |
# Set to True after successful installation | |
self.install_succeeded = None # type: Optional[bool] | |
# Supplied options | |
self.install_options = install_options if install_options else [] | |
self.global_options = global_options if global_options else [] | |
self.hash_options = hash_options if hash_options else {} | |
# Set to True after successful preparation of this requirement | |
self.prepared = False | |
self.is_direct = False | |
# Set by the legacy resolver when the requirement has been downloaded | |
# TODO: This introduces a strong coupling between the resolver and the | |
# requirement (the coupling was previously between the resolver | |
# and the requirement set). This should be refactored to allow | |
# the requirement to decide for itself when it has been | |
# successfully downloaded - but that is more tricky to get right, | |
# se we are making the change in stages. | |
self.successfully_downloaded = False | |
self.isolated = isolated | |
self.build_env = NoOpBuildEnvironment() # type: BuildEnvironment | |
# For PEP 517, the directory where we request the project metadata | |
# gets stored. We need this to pass to build_wheel, so the backend | |
# can ensure that the wheel matches the metadata (see the PEP for | |
# details). | |
self.metadata_directory = None # type: Optional[str] | |
# The static build requirements (from pyproject.toml) | |
self.pyproject_requires = None # type: Optional[List[str]] | |
# Build requirements that we will check are available | |
self.requirements_to_check = [] # type: List[str] | |
# The PEP 517 backend we should use to build the project | |
self.pep517_backend = None # type: Optional[Pep517HookCaller] | |
# Are we using PEP 517 for this requirement? | |
# After pyproject.toml has been loaded, the only valid values are True | |
# and False. Before loading, None is valid (meaning "use the default"). | |
# Setting an explicit value before loading pyproject.toml is supported, | |
# but after loading this flag should be treated as read only. | |
self.use_pep517 = use_pep517 | |
def __str__(self): | |
# type: () -> str | |
if self.req: | |
s = str(self.req) | |
if self.link: | |
s += ' from {}'.format(redact_auth_from_url(self.link.url)) | |
elif self.link: | |
s = redact_auth_from_url(self.link.url) | |
else: | |
s = '<InstallRequirement>' | |
if self.satisfied_by is not None: | |
s += ' in {}'.format(display_path(self.satisfied_by.location)) | |
if self.comes_from: | |
if isinstance(self.comes_from, six.string_types): | |
comes_from = self.comes_from # type: Optional[str] | |
else: | |
comes_from = self.comes_from.from_path() | |
if comes_from: | |
s += ' (from {})'.format(comes_from) | |
return s | |
def __repr__(self): | |
# type: () -> str | |
return '<{} object: {} editable={!r}>'.format( | |
self.__class__.__name__, str(self), self.editable) | |
def format_debug(self): | |
# type: () -> str | |
"""An un-tested helper for getting state, for debugging. | |
""" | |
attributes = vars(self) | |
names = sorted(attributes) | |
state = ( | |
"{}={!r}".format(attr, attributes[attr]) for attr in sorted(names) | |
) | |
return '<{name} object: {{{state}}}>'.format( | |
name=self.__class__.__name__, | |
state=", ".join(state), | |
) | |
# Things that are valid for all kinds of requirements? | |
@property | |
def name(self): | |
# type: () -> Optional[str] | |
if self.req is None: | |
return None | |
return six.ensure_str(pkg_resources.safe_name(self.req.name)) | |
@property | |
def specifier(self): | |
# type: () -> SpecifierSet | |
return self.req.specifier | |
@property | |
def is_pinned(self): | |
# type: () -> bool | |
"""Return whether I am pinned to an exact version. | |
For example, some-package==1.2 is pinned; some-package>1.2 is not. | |
""" | |
specifiers = self.specifier | |
return (len(specifiers) == 1 and | |
next(iter(specifiers)).operator in {'==', '==='}) | |
@property | |
def installed_version(self): | |
# type: () -> Optional[str] | |
return get_installed_version(self.name) | |
def match_markers(self, extras_requested=None): | |
# type: (Optional[Iterable[str]]) -> bool | |
if not extras_requested: | |
# Provide an extra to safely evaluate the markers | |
# without matching any extra | |
extras_requested = ('',) | |
if self.markers is not None: | |
return any( | |
self.markers.evaluate({'extra': extra}) | |
for extra in extras_requested) | |
else: | |
return True | |
@property | |
def has_hash_options(self): | |
# type: () -> bool | |
"""Return whether any known-good hashes are specified as options. | |
These activate --require-hashes mode; hashes specified as part of a | |
URL do not. | |
""" | |
return bool(self.hash_options) | |
def hashes(self, trust_internet=True): | |
# type: (bool) -> Hashes | |
"""Return a hash-comparer that considers my option- and URL-based | |
hashes to be known-good. | |
Hashes in URLs--ones embedded in the requirements file, not ones | |
downloaded from an index server--are almost peers with ones from | |
flags. They satisfy --require-hashes (whether it was implicitly or | |
explicitly activated) but do not activate it. md5 and sha224 are not | |
allowed in flags, which should nudge people toward good algos. We | |
always OR all hashes together, even ones from URLs. | |
:param trust_internet: Whether to trust URL-based (#md5=...) hashes | |
downloaded from the internet, as by populate_link() | |
""" | |
good_hashes = self.hash_options.copy() | |
link = self.link if trust_internet else self.original_link | |
if link and link.hash: | |
good_hashes.setdefault(link.hash_name, []).append(link.hash) | |
return Hashes(good_hashes) | |
def from_path(self): | |
# type: () -> Optional[str] | |
"""Format a nice indicator to show where this "comes from" | |
""" | |
if self.req is None: | |
return None | |
s = str(self.req) | |
if self.comes_from: | |
if isinstance(self.comes_from, six.string_types): | |
comes_from = self.comes_from | |
else: | |
comes_from = self.comes_from.from_path() | |
if comes_from: | |
s += '->' + comes_from | |
return s | |
def ensure_build_location(self, build_dir, autodelete): | |
# type: (str, bool) -> str | |
assert build_dir is not None | |
if self._temp_build_dir is not None: | |
assert self._temp_build_dir.path | |
return self._temp_build_dir.path | |
if self.req is None: | |
# Some systems have /tmp as a symlink which confuses custom | |
# builds (such as numpy). Thus, we ensure that the real path | |
# is returned. | |
self._temp_build_dir = TempDirectory( | |
kind=tempdir_kinds.REQ_BUILD, globally_managed=True | |
) | |
return self._temp_build_dir.path | |
if self.editable: | |
name = self.name.lower() | |
else: | |
name = self.name | |
# FIXME: Is there a better place to create the build_dir? (hg and bzr | |
# need this) | |
if not os.path.exists(build_dir): | |
logger.debug('Creating directory %s', build_dir) | |
os.makedirs(build_dir) | |
actual_build_dir = os.path.join(build_dir, name) | |
# `None` indicates that we respect the globally-configured deletion | |
# settings, which is what we actually want when auto-deleting. | |
delete_arg = None if autodelete else False | |
return TempDirectory( | |
path=actual_build_dir, | |
delete=delete_arg, | |
kind=tempdir_kinds.REQ_BUILD, | |
globally_managed=True, | |
).path | |
def _set_requirement(self): | |
# type: () -> None | |
"""Set requirement after generating metadata. | |
""" | |
assert self.req is None | |
assert self.metadata is not None | |
assert self.source_dir is not None | |
# Construct a Requirement object from the generated metadata | |
if isinstance(parse_version(self.metadata["Version"]), Version): | |
op = "==" | |
else: | |
op = "===" | |
self.req = Requirement( | |
"".join([ | |
self.metadata["Name"], | |
op, | |
self.metadata["Version"], | |
]) | |
) | |
def warn_on_mismatching_name(self): | |
# type: () -> None | |
metadata_name = canonicalize_name(self.metadata["Name"]) | |
if canonicalize_name(self.req.name) == metadata_name: | |
# Everything is fine. | |
return | |
# If we're here, there's a mismatch. Log a warning about it. | |
logger.warning( | |
'Generating metadata for package %s ' | |
'produced metadata for project name %s. Fix your ' | |
'#egg=%s fragments.', | |
self.name, metadata_name, self.name | |
) | |
self.req = Requirement(metadata_name) | |
def check_if_exists(self, use_user_site): | |
# type: (bool) -> None | |
"""Find an installed distribution that satisfies or conflicts | |
with this requirement, and set self.satisfied_by or | |
self.should_reinstall appropriately. | |
""" | |
if self.req is None: | |
return | |
# get_distribution() will resolve the entire list of requirements | |
# anyway, and we've already determined that we need the requirement | |
# in question, so strip the marker so that we don't try to | |
# evaluate it. | |
no_marker = Requirement(str(self.req)) | |
no_marker.marker = None | |
try: | |
self.satisfied_by = pkg_resources.get_distribution(str(no_marker)) | |
except pkg_resources.DistributionNotFound: | |
return | |
except pkg_resources.VersionConflict: | |
existing_dist = pkg_resources.get_distribution( | |
self.req.name | |
) | |
if use_user_site: | |
if dist_in_usersite(existing_dist): | |
self.should_reinstall = True | |
elif (running_under_virtualenv() and | |
dist_in_site_packages(existing_dist)): | |
raise InstallationError( | |
"Will not install to the user site because it will " | |
"lack sys.path precedence to {} in {}".format( | |
existing_dist.project_name, existing_dist.location) | |
) | |
else: | |
self.should_reinstall = True | |
else: | |
if self.editable and self.satisfied_by: | |
self.should_reinstall = True | |
# when installing editables, nothing pre-existing should ever | |
# satisfy | |
self.satisfied_by = None | |
# Things valid for wheels | |
@property | |
def is_wheel(self): | |
# type: () -> bool | |
if not self.link: | |
return False | |
return self.link.is_wheel | |
# Things valid for sdists | |
@property | |
def unpacked_source_directory(self): | |
# type: () -> str | |
return os.path.join( | |
self.source_dir, | |
self.link and self.link.subdirectory_fragment or '') | |
@property | |
def setup_py_path(self): | |
# type: () -> str | |
assert self.source_dir, "No source dir for {}".format(self) | |
setup_py = os.path.join(self.unpacked_source_directory, 'setup.py') | |
# Python2 __file__ should not be unicode | |
if six.PY2 and isinstance(setup_py, six.text_type): | |
setup_py = setup_py.encode(sys.getfilesystemencoding()) | |
return setup_py | |
@property | |
def pyproject_toml_path(self): | |
# type: () -> str | |
assert self.source_dir, "No source dir for {}".format(self) | |
return make_pyproject_path(self.unpacked_source_directory) | |
def load_pyproject_toml(self): | |
# type: () -> None | |
"""Load the pyproject.toml file. | |
After calling this routine, all of the attributes related to PEP 517 | |
processing for this requirement have been set. In particular, the | |
use_pep517 attribute can be used to determine whether we should | |
follow the PEP 517 or legacy (setup.py) code path. | |
""" | |
pyproject_toml_data = load_pyproject_toml( | |
self.use_pep517, | |
self.pyproject_toml_path, | |
self.setup_py_path, | |
str(self) | |
) | |
if pyproject_toml_data is None: | |
self.use_pep517 = False | |
return | |
self.use_pep517 = True | |
requires, backend, check, backend_path = pyproject_toml_data | |
self.requirements_to_check = check | |
self.pyproject_requires = requires | |
self.pep517_backend = Pep517HookCaller( | |
self.unpacked_source_directory, backend, backend_path=backend_path, | |
) | |
def _generate_metadata(self): | |
# type: () -> str | |
"""Invokes metadata generator functions, with the required arguments. | |
""" | |
if not self.use_pep517: | |
assert self.unpacked_source_directory | |
return generate_metadata_legacy( | |
build_env=self.build_env, | |
setup_py_path=self.setup_py_path, | |
source_dir=self.unpacked_source_directory, | |
isolated=self.isolated, | |
details=self.name or "from {}".format(self.link) | |
) | |
assert self.pep517_backend is not None | |
return generate_metadata( | |
build_env=self.build_env, | |
backend=self.pep517_backend, | |
) | |
def prepare_metadata(self): | |
# type: () -> None | |
"""Ensure that project metadata is available. | |
Under PEP 517, call the backend hook to prepare the metadata. | |
Under legacy processing, call setup.py egg-info. | |
""" | |
assert self.source_dir | |
with indent_log(): | |
self.metadata_directory = self._generate_metadata() | |
# Act on the newly generated metadata, based on the name and version. | |
if not self.name: | |
self._set_requirement() | |
else: | |
self.warn_on_mismatching_name() | |
self.assert_source_matches_version() | |
@property | |
def metadata(self): | |
# type: () -> Any | |
if not hasattr(self, '_metadata'): | |
self._metadata = get_metadata(self.get_dist()) | |
return self._metadata | |
def get_dist(self): | |
# type: () -> Distribution | |
return _get_dist(self.metadata_directory) | |
def assert_source_matches_version(self): | |
# type: () -> None | |
assert self.source_dir | |
version = self.metadata['version'] | |
if self.req.specifier and version not in self.req.specifier: | |
logger.warning( | |
'Requested %s, but installing version %s', | |
self, | |
version, | |
) | |
else: | |
logger.debug( | |
'Source in %s has version %s, which satisfies requirement %s', | |
display_path(self.source_dir), | |
version, | |
self, | |
) | |
# For both source distributions and editables | |
def ensure_has_source_dir(self, parent_dir, autodelete=False): | |
# type: (str, bool) -> None | |
"""Ensure that a source_dir is set. | |
This will create a temporary build dir if the name of the requirement | |
isn't known yet. | |
:param parent_dir: The ideal pip parent_dir for the source_dir. | |
Generally src_dir for editables and build_dir for sdists. | |
:return: self.source_dir | |
""" | |
if self.source_dir is None: | |
self.source_dir = self.ensure_build_location( | |
parent_dir, autodelete | |
) | |
# For editable installations | |
def update_editable(self, obtain=True): | |
# type: (bool) -> None | |
if not self.link: | |
logger.debug( | |
"Cannot update repository at %s; repository location is " | |
"unknown", | |
self.source_dir, | |
) | |
return | |
assert self.editable | |
assert self.source_dir | |
if self.link.scheme == 'file': | |
# Static paths don't get updated | |
return | |
assert '+' in self.link.url, \ | |
"bad url: {self.link.url!r}".format(**locals()) | |
vc_type, url = self.link.url.split('+', 1) | |
vcs_backend = vcs.get_backend(vc_type) | |
if vcs_backend: | |
if not self.link.is_vcs: | |
reason = ( | |
"This form of VCS requirement is being deprecated: {}." | |
).format( | |
self.link.url | |
) | |
replacement = None | |
if self.link.url.startswith("git+git@"): | |
replacement = ( | |
"git+https://git@example.com/..., " | |
"git+ssh://git@example.com/..., " | |
"or the insecure git+git://git@example.com/..." | |
) | |
deprecated(reason, replacement, gone_in="21.0", issue=7554) | |
hidden_url = hide_url(self.link.url) | |
if obtain: | |
vcs_backend.obtain(self.source_dir, url=hidden_url) | |
else: | |
vcs_backend.export(self.source_dir, url=hidden_url) | |
else: | |
assert 0, ( | |
'Unexpected version control type (in {}): {}'.format( | |
self.link, vc_type)) | |
# Top-level Actions | |
def uninstall(self, auto_confirm=False, verbose=False): | |
# type: (bool, bool) -> Optional[UninstallPathSet] | |
""" | |
Uninstall the distribution currently satisfying this requirement. | |
Prompts before removing or modifying files unless | |
``auto_confirm`` is True. | |
Refuses to delete or modify files outside of ``sys.prefix`` - | |
thus uninstallation within a virtual environment can only | |
modify that virtual environment, even if the virtualenv is | |
linked to global site-packages. | |
""" | |
assert self.req | |
try: | |
dist = pkg_resources.get_distribution(self.req.name) | |
except pkg_resources.DistributionNotFound: | |
logger.warning("Skipping %s as it is not installed.", self.name) | |
return None | |
else: | |
logger.info('Found existing installation: %s', dist) | |
uninstalled_pathset = UninstallPathSet.from_dist(dist) | |
uninstalled_pathset.remove(auto_confirm, verbose) | |
return uninstalled_pathset | |
def _get_archive_name(self, path, parentdir, rootdir): | |
# type: (str, str, str) -> str | |
def _clean_zip_name(name, prefix): | |
# type: (str, str) -> str | |
assert name.startswith(prefix + os.path.sep), ( | |
"name {name!r} doesn't start with prefix {prefix!r}" | |
.format(**locals()) | |
) | |
name = name[len(prefix) + 1:] | |
name = name.replace(os.path.sep, '/') | |
return name | |
path = os.path.join(parentdir, path) | |
name = _clean_zip_name(path, rootdir) | |
return self.name + '/' + name | |
def archive(self, build_dir): | |
# type: (str) -> None | |
"""Saves archive to provided build_dir. | |
Used for saving downloaded VCS requirements as part of `pip download`. | |
""" | |
assert self.source_dir | |
create_archive = True | |
archive_name = '{}-{}.zip'.format(self.name, self.metadata["version"]) | |
archive_path = os.path.join(build_dir, archive_name) | |
if os.path.exists(archive_path): | |
response = ask_path_exists( | |
'The file {} exists. (i)gnore, (w)ipe, ' | |
'(b)ackup, (a)bort '.format( | |
display_path(archive_path)), | |
('i', 'w', 'b', 'a')) | |
if response == 'i': | |
create_archive = False | |
elif response == 'w': | |
logger.warning('Deleting %s', display_path(archive_path)) | |
os.remove(archive_path) | |
elif response == 'b': | |
dest_file = backup_dir(archive_path) | |
logger.warning( | |
'Backing up %s to %s', | |
display_path(archive_path), | |
display_path(dest_file), | |
) | |
shutil.move(archive_path, dest_file) | |
elif response == 'a': | |
sys.exit(-1) | |
if not create_archive: | |
return | |
zip_output = zipfile.ZipFile( | |
archive_path, 'w', zipfile.ZIP_DEFLATED, allowZip64=True, | |
) | |
with zip_output: | |
dir = os.path.normcase( | |
os.path.abspath(self.unpacked_source_directory) | |
) | |
for dirpath, dirnames, filenames in os.walk(dir): | |
for dirname in dirnames: | |
dir_arcname = self._get_archive_name( | |
dirname, parentdir=dirpath, rootdir=dir, | |
) | |
zipdir = zipfile.ZipInfo(dir_arcname + '/') | |
zipdir.external_attr = 0x1ED << 16 # 0o755 | |
zip_output.writestr(zipdir, '') | |
for filename in filenames: | |
file_arcname = self._get_archive_name( | |
filename, parentdir=dirpath, rootdir=dir, | |
) | |
filename = os.path.join(dirpath, filename) | |
zip_output.write(filename, file_arcname) | |
logger.info('Saved %s', display_path(archive_path)) | |
def install( | |
self, | |
install_options, # type: List[str] | |
global_options=None, # type: Optional[Sequence[str]] | |
root=None, # type: Optional[str] | |
home=None, # type: Optional[str] | |
prefix=None, # type: Optional[str] | |
warn_script_location=True, # type: bool | |
use_user_site=False, # type: bool | |
pycompile=True # type: bool | |
): | |
# type: (...) -> None | |
scheme = get_scheme( | |
self.name, | |
user=use_user_site, | |
home=home, | |
root=root, | |
isolated=self.isolated, | |
prefix=prefix, | |
) | |
global_options = global_options if global_options is not None else [] | |
if self.editable: | |
install_editable_legacy( | |
install_options, | |
global_options, | |
prefix=prefix, | |
home=home, | |
use_user_site=use_user_site, | |
name=self.name, | |
setup_py_path=self.setup_py_path, | |
isolated=self.isolated, | |
build_env=self.build_env, | |
unpacked_source_directory=self.unpacked_source_directory, | |
) | |
self.install_succeeded = True | |
return | |
if self.is_wheel: | |
assert self.local_file_path | |
direct_url = None | |
if self.original_link: | |
direct_url = direct_url_from_link( | |
self.original_link, | |
self.source_dir, | |
self.original_link_is_in_wheel_cache, | |
) | |
install_wheel( | |
self.name, | |
self.local_file_path, | |
scheme=scheme, | |
req_description=str(self.req), | |
pycompile=pycompile, | |
warn_script_location=warn_script_location, | |
direct_url=direct_url, | |
) | |
self.install_succeeded = True | |
return | |
# TODO: Why don't we do this for editable installs? | |
# Extend the list of global and install options passed on to | |
# the setup.py call with the ones from the requirements file. | |
# Options specified in requirements file override those | |
# specified on the command line, since the last option given | |
# to setup.py is the one that is used. | |
global_options = list(global_options) + self.global_options | |
install_options = list(install_options) + self.install_options | |
try: | |
success = install_legacy( | |
install_options=install_options, | |
global_options=global_options, | |
root=root, | |
home=home, | |
prefix=prefix, | |
use_user_site=use_user_site, | |
pycompile=pycompile, | |
scheme=scheme, | |
setup_py_path=self.setup_py_path, | |
isolated=self.isolated, | |
req_name=self.name, | |
build_env=self.build_env, | |
unpacked_source_directory=self.unpacked_source_directory, | |
req_description=str(self.req), | |
) | |
except LegacyInstallFailure as exc: | |
self.install_succeeded = False | |
six.reraise(*exc.parent) | |
except Exception: | |
self.install_succeeded = True | |
raise | |
self.install_succeeded = success |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import logging | |
from collections import OrderedDict | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.models.wheel import Wheel | |
from pip._internal.utils import compatibility_tags | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Dict, Iterable, List, Optional, Tuple | |
from pip._internal.req.req_install import InstallRequirement | |
logger = logging.getLogger(__name__) | |
class RequirementSet(object): | |
def __init__(self, check_supported_wheels=True): | |
# type: (bool) -> None | |
"""Create a RequirementSet. | |
""" | |
self.requirements = OrderedDict() # type: Dict[str, InstallRequirement] # noqa: E501 | |
self.check_supported_wheels = check_supported_wheels | |
self.unnamed_requirements = [] # type: List[InstallRequirement] | |
def __str__(self): | |
# type: () -> str | |
requirements = sorted( | |
(req for req in self.requirements.values() if not req.comes_from), | |
key=lambda req: canonicalize_name(req.name), | |
) | |
return ' '.join(str(req.req) for req in requirements) | |
def __repr__(self): | |
# type: () -> str | |
requirements = sorted( | |
self.requirements.values(), | |
key=lambda req: canonicalize_name(req.name), | |
) | |
format_string = '<{classname} object; {count} requirement(s): {reqs}>' | |
return format_string.format( | |
classname=self.__class__.__name__, | |
count=len(requirements), | |
reqs=', '.join(str(req.req) for req in requirements), | |
) | |
def add_unnamed_requirement(self, install_req): | |
# type: (InstallRequirement) -> None | |
assert not install_req.name | |
self.unnamed_requirements.append(install_req) | |
def add_named_requirement(self, install_req): | |
# type: (InstallRequirement) -> None | |
assert install_req.name | |
project_name = canonicalize_name(install_req.name) | |
self.requirements[project_name] = install_req | |
def add_requirement( | |
self, | |
install_req, # type: InstallRequirement | |
parent_req_name=None, # type: Optional[str] | |
extras_requested=None # type: Optional[Iterable[str]] | |
): | |
# type: (...) -> Tuple[List[InstallRequirement], Optional[InstallRequirement]] # noqa: E501 | |
"""Add install_req as a requirement to install. | |
:param parent_req_name: The name of the requirement that needed this | |
added. The name is used because when multiple unnamed requirements | |
resolve to the same name, we could otherwise end up with dependency | |
links that point outside the Requirements set. parent_req must | |
already be added. Note that None implies that this is a user | |
supplied requirement, vs an inferred one. | |
:param extras_requested: an iterable of extras used to evaluate the | |
environment markers. | |
:return: Additional requirements to scan. That is either [] if | |
the requirement is not applicable, or [install_req] if the | |
requirement is applicable and has just been added. | |
""" | |
# If the markers do not match, ignore this requirement. | |
if not install_req.match_markers(extras_requested): | |
logger.info( | |
"Ignoring %s: markers '%s' don't match your environment", | |
install_req.name, install_req.markers, | |
) | |
return [], None | |
# If the wheel is not supported, raise an error. | |
# Should check this after filtering out based on environment markers to | |
# allow specifying different wheels based on the environment/OS, in a | |
# single requirements file. | |
if install_req.link and install_req.link.is_wheel: | |
wheel = Wheel(install_req.link.filename) | |
tags = compatibility_tags.get_supported() | |
if (self.check_supported_wheels and not wheel.supported(tags)): | |
raise InstallationError( | |
"{} is not a supported wheel on this platform.".format( | |
wheel.filename) | |
) | |
# This next bit is really a sanity check. | |
assert install_req.is_direct == (parent_req_name is None), ( | |
"a direct req shouldn't have a parent and also, " | |
"a non direct req should have a parent" | |
) | |
# Unnamed requirements are scanned again and the requirement won't be | |
# added as a dependency until after scanning. | |
if not install_req.name: | |
self.add_unnamed_requirement(install_req) | |
return [install_req], None | |
try: | |
existing_req = self.get_requirement(install_req.name) | |
except KeyError: | |
existing_req = None | |
has_conflicting_requirement = ( | |
parent_req_name is None and | |
existing_req and | |
not existing_req.constraint and | |
existing_req.extras == install_req.extras and | |
existing_req.req.specifier != install_req.req.specifier | |
) | |
if has_conflicting_requirement: | |
raise InstallationError( | |
"Double requirement given: {} (already in {}, name={!r})" | |
.format(install_req, existing_req, install_req.name) | |
) | |
# When no existing requirement exists, add the requirement as a | |
# dependency and it will be scanned again after. | |
if not existing_req: | |
self.add_named_requirement(install_req) | |
# We'd want to rescan this requirement later | |
return [install_req], install_req | |
# Assume there's no need to scan, and that we've already | |
# encountered this for scanning. | |
if install_req.constraint or not existing_req.constraint: | |
return [], existing_req | |
does_not_satisfy_constraint = ( | |
install_req.link and | |
not ( | |
existing_req.link and | |
install_req.link.path == existing_req.link.path | |
) | |
) | |
if does_not_satisfy_constraint: | |
raise InstallationError( | |
"Could not satisfy constraints for '{}': " | |
"installation from path or url cannot be " | |
"constrained to a version".format(install_req.name) | |
) | |
# If we're now installing a constraint, mark the existing | |
# object for real installation. | |
existing_req.constraint = False | |
existing_req.extras = tuple(sorted( | |
set(existing_req.extras) | set(install_req.extras) | |
)) | |
logger.debug( | |
"Setting %s extras to: %s", | |
existing_req, existing_req.extras, | |
) | |
# Return the existing requirement for addition to the parent and | |
# scanning again. | |
return [existing_req], existing_req | |
def has_requirement(self, name): | |
# type: (str) -> bool | |
project_name = canonicalize_name(name) | |
return ( | |
project_name in self.requirements and | |
not self.requirements[project_name].constraint | |
) | |
def get_requirement(self, name): | |
# type: (str) -> InstallRequirement | |
project_name = canonicalize_name(name) | |
if project_name in self.requirements: | |
return self.requirements[project_name] | |
raise KeyError("No project with the name {name!r}".format(**locals())) | |
@property | |
def all_requirements(self): | |
# type: () -> List[InstallRequirement] | |
return self.unnamed_requirements + list(self.requirements.values()) |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import contextlib | |
import errno | |
import hashlib | |
import logging | |
import os | |
from pip._vendor import contextlib2 | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from types import TracebackType | |
from typing import Dict, Iterator, Optional, Set, Type, Union | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.models.link import Link | |
logger = logging.getLogger(__name__) | |
@contextlib.contextmanager | |
def update_env_context_manager(**changes): | |
# type: (str) -> Iterator[None] | |
target = os.environ | |
# Save values from the target and change them. | |
non_existent_marker = object() | |
saved_values = {} # type: Dict[str, Union[object, str]] | |
for name, new_value in changes.items(): | |
try: | |
saved_values[name] = target[name] | |
except KeyError: | |
saved_values[name] = non_existent_marker | |
target[name] = new_value | |
try: | |
yield | |
finally: | |
# Restore original values in the target. | |
for name, original_value in saved_values.items(): | |
if original_value is non_existent_marker: | |
del target[name] | |
else: | |
assert isinstance(original_value, str) # for mypy | |
target[name] = original_value | |
@contextlib.contextmanager | |
def get_requirement_tracker(): | |
# type: () -> Iterator[RequirementTracker] | |
root = os.environ.get('PIP_REQ_TRACKER') | |
with contextlib2.ExitStack() as ctx: | |
if root is None: | |
root = ctx.enter_context( | |
TempDirectory(kind='req-tracker') | |
).path | |
ctx.enter_context(update_env_context_manager(PIP_REQ_TRACKER=root)) | |
logger.debug("Initialized build tracking at %s", root) | |
with RequirementTracker(root) as tracker: | |
yield tracker | |
class RequirementTracker(object): | |
def __init__(self, root): | |
# type: (str) -> None | |
self._root = root | |
self._entries = set() # type: Set[InstallRequirement] | |
logger.debug("Created build tracker: %s", self._root) | |
def __enter__(self): | |
# type: () -> RequirementTracker | |
logger.debug("Entered build tracker: %s", self._root) | |
return self | |
def __exit__( | |
self, | |
exc_type, # type: Optional[Type[BaseException]] | |
exc_val, # type: Optional[BaseException] | |
exc_tb # type: Optional[TracebackType] | |
): | |
# type: (...) -> None | |
self.cleanup() | |
def _entry_path(self, link): | |
# type: (Link) -> str | |
hashed = hashlib.sha224(link.url_without_fragment.encode()).hexdigest() | |
return os.path.join(self._root, hashed) | |
def add(self, req): | |
# type: (InstallRequirement) -> None | |
"""Add an InstallRequirement to build tracking. | |
""" | |
# Get the file to write information about this requirement. | |
entry_path = self._entry_path(req.link) | |
# Try reading from the file. If it exists and can be read from, a build | |
# is already in progress, so a LookupError is raised. | |
try: | |
with open(entry_path) as fp: | |
contents = fp.read() | |
except IOError as e: | |
# if the error is anything other than "file does not exist", raise. | |
if e.errno != errno.ENOENT: | |
raise | |
else: | |
message = '{} is already being built: {}'.format( | |
req.link, contents) | |
raise LookupError(message) | |
# If we're here, req should really not be building already. | |
assert req not in self._entries | |
# Start tracking this requirement. | |
with open(entry_path, 'w') as fp: | |
fp.write(str(req)) | |
self._entries.add(req) | |
logger.debug('Added %s to build tracker %r', req, self._root) | |
def remove(self, req): | |
# type: (InstallRequirement) -> None | |
"""Remove an InstallRequirement from build tracking. | |
""" | |
# Delete the created file and the corresponding entries. | |
os.unlink(self._entry_path(req.link)) | |
self._entries.remove(req) | |
logger.debug('Removed %s from build tracker %r', req, self._root) | |
def cleanup(self): | |
# type: () -> None | |
for req in set(self._entries): | |
self.remove(req) | |
logger.debug("Removed build tracker: %r", self._root) | |
@contextlib.contextmanager | |
def track(self, req): | |
# type: (InstallRequirement) -> Iterator[None] | |
self.add(req) | |
yield | |
self.remove(req) |
from __future__ import absolute_import | |
import csv | |
import functools | |
import logging | |
import os | |
import sys | |
import sysconfig | |
from pip._vendor import pkg_resources | |
from pip._internal.exceptions import UninstallationError | |
from pip._internal.locations import bin_py, bin_user | |
from pip._internal.utils.compat import WINDOWS, cache_from_source, uses_pycache | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import ( | |
FakeFile, | |
ask, | |
dist_in_usersite, | |
dist_is_local, | |
egg_link_path, | |
is_local, | |
normalize_path, | |
renames, | |
rmtree, | |
) | |
from pip._internal.utils.temp_dir import AdjacentTempDirectory, TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Callable, Dict, Iterable, Iterator, List, Optional, Set, Tuple, | |
) | |
from pip._vendor.pkg_resources import Distribution | |
logger = logging.getLogger(__name__) | |
def _script_names(dist, script_name, is_gui): | |
# type: (Distribution, str, bool) -> List[str] | |
"""Create the fully qualified name of the files created by | |
{console,gui}_scripts for the given ``dist``. | |
Returns the list of file names | |
""" | |
if dist_in_usersite(dist): | |
bin_dir = bin_user | |
else: | |
bin_dir = bin_py | |
exe_name = os.path.join(bin_dir, script_name) | |
paths_to_remove = [exe_name] | |
if WINDOWS: | |
paths_to_remove.append(exe_name + '.exe') | |
paths_to_remove.append(exe_name + '.exe.manifest') | |
if is_gui: | |
paths_to_remove.append(exe_name + '-script.pyw') | |
else: | |
paths_to_remove.append(exe_name + '-script.py') | |
return paths_to_remove | |
def _unique(fn): | |
# type: (Callable[..., Iterator[Any]]) -> Callable[..., Iterator[Any]] | |
@functools.wraps(fn) | |
def unique(*args, **kw): | |
# type: (Any, Any) -> Iterator[Any] | |
seen = set() # type: Set[Any] | |
for item in fn(*args, **kw): | |
if item not in seen: | |
seen.add(item) | |
yield item | |
return unique | |
@_unique | |
def uninstallation_paths(dist): | |
# type: (Distribution) -> Iterator[str] | |
""" | |
Yield all the uninstallation paths for dist based on RECORD-without-.py[co] | |
Yield paths to all the files in RECORD. For each .py file in RECORD, add | |
the .pyc and .pyo in the same directory. | |
UninstallPathSet.add() takes care of the __pycache__ .py[co]. | |
""" | |
r = csv.reader(FakeFile(dist.get_metadata_lines('RECORD'))) | |
for row in r: | |
path = os.path.join(dist.location, row[0]) | |
yield path | |
if path.endswith('.py'): | |
dn, fn = os.path.split(path) | |
base = fn[:-3] | |
path = os.path.join(dn, base + '.pyc') | |
yield path | |
path = os.path.join(dn, base + '.pyo') | |
yield path | |
def compact(paths): | |
# type: (Iterable[str]) -> Set[str] | |
"""Compact a path set to contain the minimal number of paths | |
necessary to contain all paths in the set. If /a/path/ and | |
/a/path/to/a/file.txt are both in the set, leave only the | |
shorter path.""" | |
sep = os.path.sep | |
short_paths = set() # type: Set[str] | |
for path in sorted(paths, key=len): | |
should_skip = any( | |
path.startswith(shortpath.rstrip("*")) and | |
path[len(shortpath.rstrip("*").rstrip(sep))] == sep | |
for shortpath in short_paths | |
) | |
if not should_skip: | |
short_paths.add(path) | |
return short_paths | |
def compress_for_rename(paths): | |
# type: (Iterable[str]) -> Set[str] | |
"""Returns a set containing the paths that need to be renamed. | |
This set may include directories when the original sequence of paths | |
included every file on disk. | |
""" | |
case_map = dict((os.path.normcase(p), p) for p in paths) | |
remaining = set(case_map) | |
unchecked = sorted(set(os.path.split(p)[0] | |
for p in case_map.values()), key=len) | |
wildcards = set() # type: Set[str] | |
def norm_join(*a): | |
# type: (str) -> str | |
return os.path.normcase(os.path.join(*a)) | |
for root in unchecked: | |
if any(os.path.normcase(root).startswith(w) | |
for w in wildcards): | |
# This directory has already been handled. | |
continue | |
all_files = set() # type: Set[str] | |
all_subdirs = set() # type: Set[str] | |
for dirname, subdirs, files in os.walk(root): | |
all_subdirs.update(norm_join(root, dirname, d) | |
for d in subdirs) | |
all_files.update(norm_join(root, dirname, f) | |
for f in files) | |
# If all the files we found are in our remaining set of files to | |
# remove, then remove them from the latter set and add a wildcard | |
# for the directory. | |
if not (all_files - remaining): | |
remaining.difference_update(all_files) | |
wildcards.add(root + os.sep) | |
return set(map(case_map.__getitem__, remaining)) | wildcards | |
def compress_for_output_listing(paths): | |
# type: (Iterable[str]) -> Tuple[Set[str], Set[str]] | |
"""Returns a tuple of 2 sets of which paths to display to user | |
The first set contains paths that would be deleted. Files of a package | |
are not added and the top-level directory of the package has a '*' added | |
at the end - to signify that all it's contents are removed. | |
The second set contains files that would have been skipped in the above | |
folders. | |
""" | |
will_remove = set(paths) | |
will_skip = set() | |
# Determine folders and files | |
folders = set() | |
files = set() | |
for path in will_remove: | |
if path.endswith(".pyc"): | |
continue | |
if path.endswith("__init__.py") or ".dist-info" in path: | |
folders.add(os.path.dirname(path)) | |
files.add(path) | |
# probably this one https://github.com/python/mypy/issues/390 | |
_normcased_files = set(map(os.path.normcase, files)) # type: ignore | |
folders = compact(folders) | |
# This walks the tree using os.walk to not miss extra folders | |
# that might get added. | |
for folder in folders: | |
for dirpath, _, dirfiles in os.walk(folder): | |
for fname in dirfiles: | |
if fname.endswith(".pyc"): | |
continue | |
file_ = os.path.join(dirpath, fname) | |
if (os.path.isfile(file_) and | |
os.path.normcase(file_) not in _normcased_files): | |
# We are skipping this file. Add it to the set. | |
will_skip.add(file_) | |
will_remove = files | { | |
os.path.join(folder, "*") for folder in folders | |
} | |
return will_remove, will_skip | |
class StashedUninstallPathSet(object): | |
"""A set of file rename operations to stash files while | |
tentatively uninstalling them.""" | |
def __init__(self): | |
# type: () -> None | |
# Mapping from source file root to [Adjacent]TempDirectory | |
# for files under that directory. | |
self._save_dirs = {} # type: Dict[str, TempDirectory] | |
# (old path, new path) tuples for each move that may need | |
# to be undone. | |
self._moves = [] # type: List[Tuple[str, str]] | |
def _get_directory_stash(self, path): | |
# type: (str) -> str | |
"""Stashes a directory. | |
Directories are stashed adjacent to their original location if | |
possible, or else moved/copied into the user's temp dir.""" | |
try: | |
save_dir = AdjacentTempDirectory(path) # type: TempDirectory | |
except OSError: | |
save_dir = TempDirectory(kind="uninstall") | |
self._save_dirs[os.path.normcase(path)] = save_dir | |
return save_dir.path | |
def _get_file_stash(self, path): | |
# type: (str) -> str | |
"""Stashes a file. | |
If no root has been provided, one will be created for the directory | |
in the user's temp directory.""" | |
path = os.path.normcase(path) | |
head, old_head = os.path.dirname(path), None | |
save_dir = None | |
while head != old_head: | |
try: | |
save_dir = self._save_dirs[head] | |
break | |
except KeyError: | |
pass | |
head, old_head = os.path.dirname(head), head | |
else: | |
# Did not find any suitable root | |
head = os.path.dirname(path) | |
save_dir = TempDirectory(kind='uninstall') | |
self._save_dirs[head] = save_dir | |
relpath = os.path.relpath(path, head) | |
if relpath and relpath != os.path.curdir: | |
return os.path.join(save_dir.path, relpath) | |
return save_dir.path | |
def stash(self, path): | |
# type: (str) -> str | |
"""Stashes the directory or file and returns its new location. | |
Handle symlinks as files to avoid modifying the symlink targets. | |
""" | |
path_is_dir = os.path.isdir(path) and not os.path.islink(path) | |
if path_is_dir: | |
new_path = self._get_directory_stash(path) | |
else: | |
new_path = self._get_file_stash(path) | |
self._moves.append((path, new_path)) | |
if (path_is_dir and os.path.isdir(new_path)): | |
# If we're moving a directory, we need to | |
# remove the destination first or else it will be | |
# moved to inside the existing directory. | |
# We just created new_path ourselves, so it will | |
# be removable. | |
os.rmdir(new_path) | |
renames(path, new_path) | |
return new_path | |
def commit(self): | |
# type: () -> None | |
"""Commits the uninstall by removing stashed files.""" | |
for _, save_dir in self._save_dirs.items(): | |
save_dir.cleanup() | |
self._moves = [] | |
self._save_dirs = {} | |
def rollback(self): | |
# type: () -> None | |
"""Undoes the uninstall by moving stashed files back.""" | |
for p in self._moves: | |
logger.info("Moving to %s\n from %s", *p) | |
for new_path, path in self._moves: | |
try: | |
logger.debug('Replacing %s from %s', new_path, path) | |
if os.path.isfile(new_path) or os.path.islink(new_path): | |
os.unlink(new_path) | |
elif os.path.isdir(new_path): | |
rmtree(new_path) | |
renames(path, new_path) | |
except OSError as ex: | |
logger.error("Failed to restore %s", new_path) | |
logger.debug("Exception: %s", ex) | |
self.commit() | |
@property | |
def can_rollback(self): | |
# type: () -> bool | |
return bool(self._moves) | |
class UninstallPathSet(object): | |
"""A set of file paths to be removed in the uninstallation of a | |
requirement.""" | |
def __init__(self, dist): | |
# type: (Distribution) -> None | |
self.paths = set() # type: Set[str] | |
self._refuse = set() # type: Set[str] | |
self.pth = {} # type: Dict[str, UninstallPthEntries] | |
self.dist = dist | |
self._moved_paths = StashedUninstallPathSet() | |
def _permitted(self, path): | |
# type: (str) -> bool | |
""" | |
Return True if the given path is one we are permitted to | |
remove/modify, False otherwise. | |
""" | |
return is_local(path) | |
def add(self, path): | |
# type: (str) -> None | |
head, tail = os.path.split(path) | |
# we normalize the head to resolve parent directory symlinks, but not | |
# the tail, since we only want to uninstall symlinks, not their targets | |
path = os.path.join(normalize_path(head), os.path.normcase(tail)) | |
if not os.path.exists(path): | |
return | |
if self._permitted(path): | |
self.paths.add(path) | |
else: | |
self._refuse.add(path) | |
# __pycache__ files can show up after 'installed-files.txt' is created, | |
# due to imports | |
if os.path.splitext(path)[1] == '.py' and uses_pycache: | |
self.add(cache_from_source(path)) | |
def add_pth(self, pth_file, entry): | |
# type: (str, str) -> None | |
pth_file = normalize_path(pth_file) | |
if self._permitted(pth_file): | |
if pth_file not in self.pth: | |
self.pth[pth_file] = UninstallPthEntries(pth_file) | |
self.pth[pth_file].add(entry) | |
else: | |
self._refuse.add(pth_file) | |
def remove(self, auto_confirm=False, verbose=False): | |
# type: (bool, bool) -> None | |
"""Remove paths in ``self.paths`` with confirmation (unless | |
``auto_confirm`` is True).""" | |
if not self.paths: | |
logger.info( | |
"Can't uninstall '%s'. No files were found to uninstall.", | |
self.dist.project_name, | |
) | |
return | |
dist_name_version = ( | |
self.dist.project_name + "-" + self.dist.version | |
) | |
logger.info('Uninstalling %s:', dist_name_version) | |
with indent_log(): | |
if auto_confirm or self._allowed_to_proceed(verbose): | |
moved = self._moved_paths | |
for_rename = compress_for_rename(self.paths) | |
for path in sorted(compact(for_rename)): | |
moved.stash(path) | |
logger.debug('Removing file or directory %s', path) | |
for pth in self.pth.values(): | |
pth.remove() | |
logger.info('Successfully uninstalled %s', dist_name_version) | |
def _allowed_to_proceed(self, verbose): | |
# type: (bool) -> bool | |
"""Display which files would be deleted and prompt for confirmation | |
""" | |
def _display(msg, paths): | |
# type: (str, Iterable[str]) -> None | |
if not paths: | |
return | |
logger.info(msg) | |
with indent_log(): | |
for path in sorted(compact(paths)): | |
logger.info(path) | |
if not verbose: | |
will_remove, will_skip = compress_for_output_listing(self.paths) | |
else: | |
# In verbose mode, display all the files that are going to be | |
# deleted. | |
will_remove = set(self.paths) | |
will_skip = set() | |
_display('Would remove:', will_remove) | |
_display('Would not remove (might be manually added):', will_skip) | |
_display('Would not remove (outside of prefix):', self._refuse) | |
if verbose: | |
_display('Will actually move:', compress_for_rename(self.paths)) | |
return ask('Proceed (y/n)? ', ('y', 'n')) == 'y' | |
def rollback(self): | |
# type: () -> None | |
"""Rollback the changes previously made by remove().""" | |
if not self._moved_paths.can_rollback: | |
logger.error( | |
"Can't roll back %s; was not uninstalled", | |
self.dist.project_name, | |
) | |
return | |
logger.info('Rolling back uninstall of %s', self.dist.project_name) | |
self._moved_paths.rollback() | |
for pth in self.pth.values(): | |
pth.rollback() | |
def commit(self): | |
# type: () -> None | |
"""Remove temporary save dir: rollback will no longer be possible.""" | |
self._moved_paths.commit() | |
@classmethod | |
def from_dist(cls, dist): | |
# type: (Distribution) -> UninstallPathSet | |
dist_path = normalize_path(dist.location) | |
if not dist_is_local(dist): | |
logger.info( | |
"Not uninstalling %s at %s, outside environment %s", | |
dist.key, | |
dist_path, | |
sys.prefix, | |
) | |
return cls(dist) | |
if dist_path in {p for p in {sysconfig.get_path("stdlib"), | |
sysconfig.get_path("platstdlib")} | |
if p}: | |
logger.info( | |
"Not uninstalling %s at %s, as it is in the standard library.", | |
dist.key, | |
dist_path, | |
) | |
return cls(dist) | |
paths_to_remove = cls(dist) | |
develop_egg_link = egg_link_path(dist) | |
develop_egg_link_egg_info = '{}.egg-info'.format( | |
pkg_resources.to_filename(dist.project_name)) | |
egg_info_exists = dist.egg_info and os.path.exists(dist.egg_info) | |
# Special case for distutils installed package | |
distutils_egg_info = getattr(dist._provider, 'path', None) | |
# Uninstall cases order do matter as in the case of 2 installs of the | |
# same package, pip needs to uninstall the currently detected version | |
if (egg_info_exists and dist.egg_info.endswith('.egg-info') and | |
not dist.egg_info.endswith(develop_egg_link_egg_info)): | |
# if dist.egg_info.endswith(develop_egg_link_egg_info), we | |
# are in fact in the develop_egg_link case | |
paths_to_remove.add(dist.egg_info) | |
if dist.has_metadata('installed-files.txt'): | |
for installed_file in dist.get_metadata( | |
'installed-files.txt').splitlines(): | |
path = os.path.normpath( | |
os.path.join(dist.egg_info, installed_file) | |
) | |
paths_to_remove.add(path) | |
# FIXME: need a test for this elif block | |
# occurs with --single-version-externally-managed/--record outside | |
# of pip | |
elif dist.has_metadata('top_level.txt'): | |
if dist.has_metadata('namespace_packages.txt'): | |
namespaces = dist.get_metadata('namespace_packages.txt') | |
else: | |
namespaces = [] | |
for top_level_pkg in [ | |
p for p | |
in dist.get_metadata('top_level.txt').splitlines() | |
if p and p not in namespaces]: | |
path = os.path.join(dist.location, top_level_pkg) | |
paths_to_remove.add(path) | |
paths_to_remove.add(path + '.py') | |
paths_to_remove.add(path + '.pyc') | |
paths_to_remove.add(path + '.pyo') | |
elif distutils_egg_info: | |
raise UninstallationError( | |
"Cannot uninstall {!r}. It is a distutils installed project " | |
"and thus we cannot accurately determine which files belong " | |
"to it which would lead to only a partial uninstall.".format( | |
dist.project_name, | |
) | |
) | |
elif dist.location.endswith('.egg'): | |
# package installed by easy_install | |
# We cannot match on dist.egg_name because it can slightly vary | |
# i.e. setuptools-0.6c11-py2.6.egg vs setuptools-0.6rc11-py2.6.egg | |
paths_to_remove.add(dist.location) | |
easy_install_egg = os.path.split(dist.location)[1] | |
easy_install_pth = os.path.join(os.path.dirname(dist.location), | |
'easy-install.pth') | |
paths_to_remove.add_pth(easy_install_pth, './' + easy_install_egg) | |
elif egg_info_exists and dist.egg_info.endswith('.dist-info'): | |
for path in uninstallation_paths(dist): | |
paths_to_remove.add(path) | |
elif develop_egg_link: | |
# develop egg | |
with open(develop_egg_link, 'r') as fh: | |
link_pointer = os.path.normcase(fh.readline().strip()) | |
assert (link_pointer == dist.location), ( | |
'Egg-link {} does not match installed location of {} ' | |
'(at {})'.format( | |
link_pointer, dist.project_name, dist.location) | |
) | |
paths_to_remove.add(develop_egg_link) | |
easy_install_pth = os.path.join(os.path.dirname(develop_egg_link), | |
'easy-install.pth') | |
paths_to_remove.add_pth(easy_install_pth, dist.location) | |
else: | |
logger.debug( | |
'Not sure how to uninstall: %s - Check: %s', | |
dist, dist.location, | |
) | |
# find distutils scripts= scripts | |
if dist.has_metadata('scripts') and dist.metadata_isdir('scripts'): | |
for script in dist.metadata_listdir('scripts'): | |
if dist_in_usersite(dist): | |
bin_dir = bin_user | |
else: | |
bin_dir = bin_py | |
paths_to_remove.add(os.path.join(bin_dir, script)) | |
if WINDOWS: | |
paths_to_remove.add(os.path.join(bin_dir, script) + '.bat') | |
# find console_scripts | |
_scripts_to_remove = [] | |
console_scripts = dist.get_entry_map(group='console_scripts') | |
for name in console_scripts.keys(): | |
_scripts_to_remove.extend(_script_names(dist, name, False)) | |
# find gui_scripts | |
gui_scripts = dist.get_entry_map(group='gui_scripts') | |
for name in gui_scripts.keys(): | |
_scripts_to_remove.extend(_script_names(dist, name, True)) | |
for s in _scripts_to_remove: | |
paths_to_remove.add(s) | |
return paths_to_remove | |
class UninstallPthEntries(object): | |
def __init__(self, pth_file): | |
# type: (str) -> None | |
self.file = pth_file | |
self.entries = set() # type: Set[str] | |
self._saved_lines = None # type: Optional[List[bytes]] | |
def add(self, entry): | |
# type: (str) -> None | |
entry = os.path.normcase(entry) | |
# On Windows, os.path.normcase converts the entry to use | |
# backslashes. This is correct for entries that describe absolute | |
# paths outside of site-packages, but all the others use forward | |
# slashes. | |
# os.path.splitdrive is used instead of os.path.isabs because isabs | |
# treats non-absolute paths with drive letter markings like c:foo\bar | |
# as absolute paths. It also does not recognize UNC paths if they don't | |
# have more than "\\sever\share". Valid examples: "\\server\share\" or | |
# "\\server\share\folder". Python 2.7.8+ support UNC in splitdrive. | |
if WINDOWS and not os.path.splitdrive(entry)[0]: | |
entry = entry.replace('\\', '/') | |
self.entries.add(entry) | |
def remove(self): | |
# type: () -> None | |
logger.debug('Removing pth entries from %s:', self.file) | |
# If the file doesn't exist, log a warning and return | |
if not os.path.isfile(self.file): | |
logger.warning( | |
"Cannot remove entries from nonexistent file {}".format( | |
self.file) | |
) | |
return | |
with open(self.file, 'rb') as fh: | |
# windows uses '\r\n' with py3k, but uses '\n' with py2.x | |
lines = fh.readlines() | |
self._saved_lines = lines | |
if any(b'\r\n' in line for line in lines): | |
endline = '\r\n' | |
else: | |
endline = '\n' | |
# handle missing trailing newline | |
if lines and not lines[-1].endswith(endline.encode("utf-8")): | |
lines[-1] = lines[-1] + endline.encode("utf-8") | |
for entry in self.entries: | |
try: | |
logger.debug('Removing entry: %s', entry) | |
lines.remove((entry + endline).encode("utf-8")) | |
except ValueError: | |
pass | |
with open(self.file, 'wb') as fh: | |
fh.writelines(lines) | |
def rollback(self): | |
# type: () -> bool | |
if self._saved_lines is None: | |
logger.error( | |
'Cannot roll back changes to %s, none were made', self.file | |
) | |
return False | |
logger.debug('Rolling %s back to previous state', self.file) | |
with open(self.file, 'wb') as fh: | |
fh.writelines(self._saved_lines) | |
return True |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Callable, List | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.req.req_set import RequirementSet | |
InstallRequirementProvider = Callable[ | |
[str, InstallRequirement], InstallRequirement | |
] | |
class BaseResolver(object): | |
def resolve(self, root_reqs, check_supported_wheels): | |
# type: (List[InstallRequirement], bool) -> RequirementSet | |
raise NotImplementedError() | |
def get_installation_order(self, req_set): | |
# type: (RequirementSet) -> List[InstallRequirement] | |
raise NotImplementedError() |
"""Dependency Resolution | |
The dependency resolution in pip is performed as follows: | |
for top-level requirements: | |
a. only one spec allowed per project, regardless of conflicts or not. | |
otherwise a "double requirement" exception is raised | |
b. they override sub-dependency requirements. | |
for sub-dependencies | |
a. "first found, wins" (where the order is breadth first) | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
# mypy: disallow-untyped-defs=False | |
import logging | |
import sys | |
from collections import defaultdict | |
from itertools import chain | |
from pip._vendor.packaging import specifiers | |
from pip._internal.exceptions import ( | |
BestVersionAlreadyInstalled, | |
DistributionNotFound, | |
HashError, | |
HashErrors, | |
UnsupportedPythonVersion, | |
) | |
from pip._internal.req.req_set import RequirementSet | |
from pip._internal.resolution.base import BaseResolver | |
from pip._internal.utils.compatibility_tags import get_supported | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import dist_in_usersite, normalize_version_info | |
from pip._internal.utils.packaging import ( | |
check_requires_python, | |
get_requires_python, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import DefaultDict, List, Optional, Set, Tuple | |
from pip._vendor import pkg_resources | |
from pip._internal.cache import WheelCache | |
from pip._internal.distributions import AbstractDistribution | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.operations.prepare import RequirementPreparer | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.resolution.base import InstallRequirementProvider | |
DiscoveredDependencies = DefaultDict[str, List[InstallRequirement]] | |
logger = logging.getLogger(__name__) | |
def _check_dist_requires_python( | |
dist, # type: pkg_resources.Distribution | |
version_info, # type: Tuple[int, int, int] | |
ignore_requires_python=False, # type: bool | |
): | |
# type: (...) -> None | |
""" | |
Check whether the given Python version is compatible with a distribution's | |
"Requires-Python" value. | |
:param version_info: A 3-tuple of ints representing the Python | |
major-minor-micro version to check. | |
:param ignore_requires_python: Whether to ignore the "Requires-Python" | |
value if the given Python version isn't compatible. | |
:raises UnsupportedPythonVersion: When the given Python version isn't | |
compatible. | |
""" | |
requires_python = get_requires_python(dist) | |
try: | |
is_compatible = check_requires_python( | |
requires_python, version_info=version_info, | |
) | |
except specifiers.InvalidSpecifier as exc: | |
logger.warning( | |
"Package %r has an invalid Requires-Python: %s", | |
dist.project_name, exc, | |
) | |
return | |
if is_compatible: | |
return | |
version = '.'.join(map(str, version_info)) | |
if ignore_requires_python: | |
logger.debug( | |
'Ignoring failed Requires-Python check for package %r: ' | |
'%s not in %r', | |
dist.project_name, version, requires_python, | |
) | |
return | |
raise UnsupportedPythonVersion( | |
'Package {!r} requires a different Python: {} not in {!r}'.format( | |
dist.project_name, version, requires_python, | |
)) | |
class Resolver(BaseResolver): | |
"""Resolves which packages need to be installed/uninstalled to perform \ | |
the requested operation without breaking the requirements of any package. | |
""" | |
_allowed_strategies = {"eager", "only-if-needed", "to-satisfy-only"} | |
def __init__( | |
self, | |
preparer, # type: RequirementPreparer | |
finder, # type: PackageFinder | |
wheel_cache, # type: Optional[WheelCache] | |
make_install_req, # type: InstallRequirementProvider | |
use_user_site, # type: bool | |
ignore_dependencies, # type: bool | |
ignore_installed, # type: bool | |
ignore_requires_python, # type: bool | |
force_reinstall, # type: bool | |
upgrade_strategy, # type: str | |
py_version_info=None, # type: Optional[Tuple[int, ...]] | |
): | |
# type: (...) -> None | |
super(Resolver, self).__init__() | |
assert upgrade_strategy in self._allowed_strategies | |
if py_version_info is None: | |
py_version_info = sys.version_info[:3] | |
else: | |
py_version_info = normalize_version_info(py_version_info) | |
self._py_version_info = py_version_info | |
self.preparer = preparer | |
self.finder = finder | |
self.wheel_cache = wheel_cache | |
self.upgrade_strategy = upgrade_strategy | |
self.force_reinstall = force_reinstall | |
self.ignore_dependencies = ignore_dependencies | |
self.ignore_installed = ignore_installed | |
self.ignore_requires_python = ignore_requires_python | |
self.use_user_site = use_user_site | |
self._make_install_req = make_install_req | |
self._discovered_dependencies = \ | |
defaultdict(list) # type: DiscoveredDependencies | |
def resolve(self, root_reqs, check_supported_wheels): | |
# type: (List[InstallRequirement], bool) -> RequirementSet | |
"""Resolve what operations need to be done | |
As a side-effect of this method, the packages (and their dependencies) | |
are downloaded, unpacked and prepared for installation. This | |
preparation is done by ``pip.operations.prepare``. | |
Once PyPI has static dependency metadata available, it would be | |
possible to move the preparation to become a step separated from | |
dependency resolution. | |
""" | |
requirement_set = RequirementSet( | |
check_supported_wheels=check_supported_wheels | |
) | |
for req in root_reqs: | |
requirement_set.add_requirement(req) | |
# Actually prepare the files, and collect any exceptions. Most hash | |
# exceptions cannot be checked ahead of time, because | |
# _populate_link() needs to be called before we can make decisions | |
# based on link type. | |
discovered_reqs = [] # type: List[InstallRequirement] | |
hash_errors = HashErrors() | |
for req in chain(root_reqs, discovered_reqs): | |
try: | |
discovered_reqs.extend(self._resolve_one(requirement_set, req)) | |
except HashError as exc: | |
exc.req = req | |
hash_errors.append(exc) | |
if hash_errors: | |
raise hash_errors | |
return requirement_set | |
def _is_upgrade_allowed(self, req): | |
# type: (InstallRequirement) -> bool | |
if self.upgrade_strategy == "to-satisfy-only": | |
return False | |
elif self.upgrade_strategy == "eager": | |
return True | |
else: | |
assert self.upgrade_strategy == "only-if-needed" | |
return req.is_direct | |
def _set_req_to_reinstall(self, req): | |
# type: (InstallRequirement) -> None | |
""" | |
Set a requirement to be installed. | |
""" | |
# Don't uninstall the conflict if doing a user install and the | |
# conflict is not a user install. | |
if not self.use_user_site or dist_in_usersite(req.satisfied_by): | |
req.should_reinstall = True | |
req.satisfied_by = None | |
def _check_skip_installed(self, req_to_install): | |
# type: (InstallRequirement) -> Optional[str] | |
"""Check if req_to_install should be skipped. | |
This will check if the req is installed, and whether we should upgrade | |
or reinstall it, taking into account all the relevant user options. | |
After calling this req_to_install will only have satisfied_by set to | |
None if the req_to_install is to be upgraded/reinstalled etc. Any | |
other value will be a dist recording the current thing installed that | |
satisfies the requirement. | |
Note that for vcs urls and the like we can't assess skipping in this | |
routine - we simply identify that we need to pull the thing down, | |
then later on it is pulled down and introspected to assess upgrade/ | |
reinstalls etc. | |
:return: A text reason for why it was skipped, or None. | |
""" | |
if self.ignore_installed: | |
return None | |
req_to_install.check_if_exists(self.use_user_site) | |
if not req_to_install.satisfied_by: | |
return None | |
if self.force_reinstall: | |
self._set_req_to_reinstall(req_to_install) | |
return None | |
if not self._is_upgrade_allowed(req_to_install): | |
if self.upgrade_strategy == "only-if-needed": | |
return 'already satisfied, skipping upgrade' | |
return 'already satisfied' | |
# Check for the possibility of an upgrade. For link-based | |
# requirements we have to pull the tree down and inspect to assess | |
# the version #, so it's handled way down. | |
if not req_to_install.link: | |
try: | |
self.finder.find_requirement(req_to_install, upgrade=True) | |
except BestVersionAlreadyInstalled: | |
# Then the best version is installed. | |
return 'already up-to-date' | |
except DistributionNotFound: | |
# No distribution found, so we squash the error. It will | |
# be raised later when we re-try later to do the install. | |
# Why don't we just raise here? | |
pass | |
self._set_req_to_reinstall(req_to_install) | |
return None | |
def _populate_link(self, req): | |
# type: (InstallRequirement) -> None | |
"""Ensure that if a link can be found for this, that it is found. | |
Note that req.link may still be None - if the requirement is already | |
installed and not needed to be upgraded based on the return value of | |
_is_upgrade_allowed(). | |
If preparer.require_hashes is True, don't use the wheel cache, because | |
cached wheels, always built locally, have different hashes than the | |
files downloaded from the index server and thus throw false hash | |
mismatches. Furthermore, cached wheels at present have undeterministic | |
contents due to file modification times. | |
""" | |
upgrade = self._is_upgrade_allowed(req) | |
if req.link is None: | |
req.link = self.finder.find_requirement(req, upgrade) | |
if self.wheel_cache is None or self.preparer.require_hashes: | |
return | |
cache_entry = self.wheel_cache.get_cache_entry( | |
link=req.link, | |
package_name=req.name, | |
supported_tags=get_supported(), | |
) | |
if cache_entry is not None: | |
logger.debug('Using cached wheel link: %s', cache_entry.link) | |
if req.link is req.original_link and cache_entry.persistent: | |
req.original_link_is_in_wheel_cache = True | |
req.link = cache_entry.link | |
def _get_abstract_dist_for(self, req): | |
# type: (InstallRequirement) -> AbstractDistribution | |
"""Takes a InstallRequirement and returns a single AbstractDist \ | |
representing a prepared variant of the same. | |
""" | |
if req.editable: | |
return self.preparer.prepare_editable_requirement(req) | |
# satisfied_by is only evaluated by calling _check_skip_installed, | |
# so it must be None here. | |
assert req.satisfied_by is None | |
skip_reason = self._check_skip_installed(req) | |
if req.satisfied_by: | |
return self.preparer.prepare_installed_requirement( | |
req, skip_reason | |
) | |
# We eagerly populate the link, since that's our "legacy" behavior. | |
self._populate_link(req) | |
abstract_dist = self.preparer.prepare_linked_requirement(req) | |
# NOTE | |
# The following portion is for determining if a certain package is | |
# going to be re-installed/upgraded or not and reporting to the user. | |
# This should probably get cleaned up in a future refactor. | |
# req.req is only avail after unpack for URL | |
# pkgs repeat check_if_exists to uninstall-on-upgrade | |
# (#14) | |
if not self.ignore_installed: | |
req.check_if_exists(self.use_user_site) | |
if req.satisfied_by: | |
should_modify = ( | |
self.upgrade_strategy != "to-satisfy-only" or | |
self.force_reinstall or | |
self.ignore_installed or | |
req.link.scheme == 'file' | |
) | |
if should_modify: | |
self._set_req_to_reinstall(req) | |
else: | |
logger.info( | |
'Requirement already satisfied (use --upgrade to upgrade):' | |
' %s', req, | |
) | |
return abstract_dist | |
def _resolve_one( | |
self, | |
requirement_set, # type: RequirementSet | |
req_to_install, # type: InstallRequirement | |
): | |
# type: (...) -> List[InstallRequirement] | |
"""Prepare a single requirements file. | |
:return: A list of additional InstallRequirements to also install. | |
""" | |
# Tell user what we are doing for this requirement: | |
# obtain (editable), skipping, processing (local url), collecting | |
# (remote url or package name) | |
if req_to_install.constraint or req_to_install.prepared: | |
return [] | |
req_to_install.prepared = True | |
abstract_dist = self._get_abstract_dist_for(req_to_install) | |
# Parse and return dependencies | |
dist = abstract_dist.get_pkg_resources_distribution() | |
# This will raise UnsupportedPythonVersion if the given Python | |
# version isn't compatible with the distribution's Requires-Python. | |
_check_dist_requires_python( | |
dist, version_info=self._py_version_info, | |
ignore_requires_python=self.ignore_requires_python, | |
) | |
more_reqs = [] # type: List[InstallRequirement] | |
def add_req(subreq, extras_requested): | |
sub_install_req = self._make_install_req( | |
str(subreq), | |
req_to_install, | |
) | |
parent_req_name = req_to_install.name | |
to_scan_again, add_to_parent = requirement_set.add_requirement( | |
sub_install_req, | |
parent_req_name=parent_req_name, | |
extras_requested=extras_requested, | |
) | |
if parent_req_name and add_to_parent: | |
self._discovered_dependencies[parent_req_name].append( | |
add_to_parent | |
) | |
more_reqs.extend(to_scan_again) | |
with indent_log(): | |
# We add req_to_install before its dependencies, so that we | |
# can refer to it when adding dependencies. | |
if not requirement_set.has_requirement(req_to_install.name): | |
# 'unnamed' requirements will get added here | |
# 'unnamed' requirements can only come from being directly | |
# provided by the user. | |
assert req_to_install.is_direct | |
requirement_set.add_requirement( | |
req_to_install, parent_req_name=None, | |
) | |
if not self.ignore_dependencies: | |
if req_to_install.extras: | |
logger.debug( | |
"Installing extra requirements: %r", | |
','.join(req_to_install.extras), | |
) | |
missing_requested = sorted( | |
set(req_to_install.extras) - set(dist.extras) | |
) | |
for missing in missing_requested: | |
logger.warning( | |
'%s does not provide the extra \'%s\'', | |
dist, missing | |
) | |
available_requested = sorted( | |
set(dist.extras) & set(req_to_install.extras) | |
) | |
for subreq in dist.requires(available_requested): | |
add_req(subreq, extras_requested=available_requested) | |
if not req_to_install.editable and not req_to_install.satisfied_by: | |
# XXX: --no-install leads this to report 'Successfully | |
# downloaded' for only non-editable reqs, even though we took | |
# action on them. | |
req_to_install.successfully_downloaded = True | |
return more_reqs | |
def get_installation_order(self, req_set): | |
# type: (RequirementSet) -> List[InstallRequirement] | |
"""Create the installation order. | |
The installation order is topological - requirements are installed | |
before the requiring thing. We break cycles at an arbitrary point, | |
and make no other guarantees. | |
""" | |
# The current implementation, which we may change at any point | |
# installs the user specified things in the order given, except when | |
# dependencies must come earlier to achieve topological order. | |
order = [] | |
ordered_reqs = set() # type: Set[InstallRequirement] | |
def schedule(req): | |
if req.satisfied_by or req in ordered_reqs: | |
return | |
if req.constraint: | |
return | |
ordered_reqs.add(req) | |
for dep in self._discovered_dependencies[req.name]: | |
schedule(dep) | |
order.append(req) | |
for install_req in req_set.requirements.values(): | |
schedule(install_req) | |
return order |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Sequence, Set | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._vendor.packaging.version import _BaseVersion | |
def format_name(project, extras): | |
# type: (str, Set[str]) -> str | |
if not extras: | |
return project | |
canonical_extras = sorted(canonicalize_name(e) for e in extras) | |
return "{}[{}]".format(project, ",".join(canonical_extras)) | |
class Requirement(object): | |
@property | |
def name(self): | |
# type: () -> str | |
raise NotImplementedError("Subclass should override") | |
def find_matches(self): | |
# type: () -> Sequence[Candidate] | |
raise NotImplementedError("Subclass should override") | |
def is_satisfied_by(self, candidate): | |
# type: (Candidate) -> bool | |
return False | |
class Candidate(object): | |
@property | |
def name(self): | |
# type: () -> str | |
raise NotImplementedError("Override in subclass") | |
@property | |
def version(self): | |
# type: () -> _BaseVersion | |
raise NotImplementedError("Override in subclass") | |
def get_dependencies(self): | |
# type: () -> Sequence[Requirement] | |
raise NotImplementedError("Override in subclass") | |
def get_install_requirement(self): | |
# type: () -> Optional[InstallRequirement] | |
raise NotImplementedError("Override in subclass") |
import logging | |
import sys | |
from pip._vendor.packaging.specifiers import InvalidSpecifier, SpecifierSet | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.packaging.version import Version | |
from pip._internal.req.constructors import ( | |
install_req_from_editable, | |
install_req_from_line, | |
) | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.utils.misc import normalize_version_info | |
from pip._internal.utils.packaging import get_requires_python | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from .base import Candidate, format_name | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Optional, Sequence, Set, Tuple, Union | |
from pip._vendor.packaging.version import _BaseVersion | |
from pip._vendor.pkg_resources import Distribution | |
from pip._internal.distributions import AbstractDistribution | |
from pip._internal.models.link import Link | |
from .base import Requirement | |
from .factory import Factory | |
BaseCandidate = Union[ | |
"AlreadyInstalledCandidate", | |
"EditableCandidate", | |
"LinkCandidate", | |
] | |
logger = logging.getLogger(__name__) | |
def make_install_req_from_link(link, parent): | |
# type: (Link, InstallRequirement) -> InstallRequirement | |
assert not parent.editable, "parent is editable" | |
return install_req_from_line( | |
link.url, | |
comes_from=parent.comes_from, | |
use_pep517=parent.use_pep517, | |
isolated=parent.isolated, | |
constraint=parent.constraint, | |
options=dict( | |
install_options=parent.install_options, | |
global_options=parent.global_options, | |
hashes=parent.hash_options | |
), | |
) | |
def make_install_req_from_editable(link, parent): | |
# type: (Link, InstallRequirement) -> InstallRequirement | |
assert parent.editable, "parent not editable" | |
return install_req_from_editable( | |
link.url, | |
comes_from=parent.comes_from, | |
use_pep517=parent.use_pep517, | |
isolated=parent.isolated, | |
constraint=parent.constraint, | |
options=dict( | |
install_options=parent.install_options, | |
global_options=parent.global_options, | |
hashes=parent.hash_options | |
), | |
) | |
def make_install_req_from_dist(dist, parent): | |
# type: (Distribution, InstallRequirement) -> InstallRequirement | |
ireq = install_req_from_line( | |
"{}=={}".format( | |
canonicalize_name(dist.project_name), | |
dist.parsed_version, | |
), | |
comes_from=parent.comes_from, | |
use_pep517=parent.use_pep517, | |
isolated=parent.isolated, | |
constraint=parent.constraint, | |
options=dict( | |
install_options=parent.install_options, | |
global_options=parent.global_options, | |
hashes=parent.hash_options | |
), | |
) | |
ireq.satisfied_by = dist | |
return ireq | |
class _InstallRequirementBackedCandidate(Candidate): | |
def __init__( | |
self, | |
link, # type: Link | |
ireq, # type: InstallRequirement | |
factory, # type: Factory | |
name=None, # type: Optional[str] | |
version=None, # type: Optional[_BaseVersion] | |
): | |
# type: (...) -> None | |
self.link = link | |
self._factory = factory | |
self._ireq = ireq | |
self._name = name | |
self._version = version | |
self._dist = None # type: Optional[Distribution] | |
def __repr__(self): | |
# type: () -> str | |
return "{class_name}({link!r})".format( | |
class_name=self.__class__.__name__, | |
link=str(self.link), | |
) | |
def __eq__(self, other): | |
# type: (Any) -> bool | |
if isinstance(other, self.__class__): | |
return self.link == other.link | |
return False | |
# Needed for Python 2, which does not implement this by default | |
def __ne__(self, other): | |
# type: (Any) -> bool | |
return not self.__eq__(other) | |
@property | |
def name(self): | |
# type: () -> str | |
"""The normalised name of the project the candidate refers to""" | |
if self._name is None: | |
self._name = canonicalize_name(self.dist.project_name) | |
return self._name | |
@property | |
def version(self): | |
# type: () -> _BaseVersion | |
if self._version is None: | |
self._version = self.dist.parsed_version | |
return self._version | |
def _prepare_abstract_distribution(self): | |
# type: () -> AbstractDistribution | |
raise NotImplementedError("Override in subclass") | |
def _prepare(self): | |
# type: () -> None | |
if self._dist is not None: | |
return | |
abstract_dist = self._prepare_abstract_distribution() | |
self._dist = abstract_dist.get_pkg_resources_distribution() | |
assert self._dist is not None, "Distribution already installed" | |
# TODO: Abort cleanly here, as the resolution has been | |
# based on the wrong name/version until now, and | |
# so is wrong. | |
# TODO: (Longer term) Rather than abort, reject this candidate | |
# and backtrack. This would need resolvelib support. | |
# These should be "proper" errors, not just asserts, as they | |
# can result from user errors like a requirement "foo @ URL" | |
# when the project at URL has a name of "bar" in its metadata. | |
assert ( | |
self._name is None or | |
self._name == canonicalize_name(self._dist.project_name) | |
), "Name mismatch: {!r} vs {!r}".format( | |
self._name, canonicalize_name(self._dist.project_name), | |
) | |
assert ( | |
self._version is None or | |
self._version == self._dist.parsed_version | |
), "Version mismatch: {!r} vs {!r}".format( | |
self._version, self._dist.parsed_version, | |
) | |
@property | |
def dist(self): | |
# type: () -> Distribution | |
self._prepare() | |
return self._dist | |
def _get_requires_python_specifier(self): | |
# type: () -> Optional[SpecifierSet] | |
requires_python = get_requires_python(self.dist) | |
if requires_python is None: | |
return None | |
try: | |
spec = SpecifierSet(requires_python) | |
except InvalidSpecifier as e: | |
logger.warning( | |
"Package %r has an invalid Requires-Python: %s", self.name, e, | |
) | |
return None | |
return spec | |
def get_dependencies(self): | |
# type: () -> Sequence[Requirement] | |
deps = [ | |
self._factory.make_requirement_from_spec(str(r), self._ireq) | |
for r in self.dist.requires() | |
] | |
python_dep = self._factory.make_requires_python_requirement( | |
self._get_requires_python_specifier(), | |
) | |
if python_dep: | |
deps.append(python_dep) | |
return deps | |
def get_install_requirement(self): | |
# type: () -> Optional[InstallRequirement] | |
self._prepare() | |
return self._ireq | |
class LinkCandidate(_InstallRequirementBackedCandidate): | |
def __init__( | |
self, | |
link, # type: Link | |
parent, # type: InstallRequirement | |
factory, # type: Factory | |
name=None, # type: Optional[str] | |
version=None, # type: Optional[_BaseVersion] | |
): | |
# type: (...) -> None | |
super(LinkCandidate, self).__init__( | |
link=link, | |
ireq=make_install_req_from_link(link, parent), | |
factory=factory, | |
name=name, | |
version=version, | |
) | |
def _prepare_abstract_distribution(self): | |
# type: () -> AbstractDistribution | |
return self._factory.preparer.prepare_linked_requirement(self._ireq) | |
class EditableCandidate(_InstallRequirementBackedCandidate): | |
def __init__( | |
self, | |
link, # type: Link | |
parent, # type: InstallRequirement | |
factory, # type: Factory | |
name=None, # type: Optional[str] | |
version=None, # type: Optional[_BaseVersion] | |
): | |
# type: (...) -> None | |
super(EditableCandidate, self).__init__( | |
link=link, | |
ireq=make_install_req_from_editable(link, parent), | |
factory=factory, | |
name=name, | |
version=version, | |
) | |
def _prepare_abstract_distribution(self): | |
# type: () -> AbstractDistribution | |
return self._factory.preparer.prepare_editable_requirement(self._ireq) | |
class AlreadyInstalledCandidate(Candidate): | |
def __init__( | |
self, | |
dist, # type: Distribution | |
parent, # type: InstallRequirement | |
factory, # type: Factory | |
): | |
# type: (...) -> None | |
self.dist = dist | |
self._ireq = make_install_req_from_dist(dist, parent) | |
self._factory = factory | |
# This is just logging some messages, so we can do it eagerly. | |
# The returned dist would be exactly the same as self.dist because we | |
# set satisfied_by in make_install_req_from_dist. | |
# TODO: Supply reason based on force_reinstall and upgrade_strategy. | |
skip_reason = "already satisfied" | |
factory.preparer.prepare_installed_requirement(self._ireq, skip_reason) | |
def __repr__(self): | |
# type: () -> str | |
return "{class_name}({distribution!r})".format( | |
class_name=self.__class__.__name__, | |
distribution=self.dist, | |
) | |
def __eq__(self, other): | |
# type: (Any) -> bool | |
if isinstance(other, self.__class__): | |
return self.name == other.name and self.version == other.version | |
return False | |
# Needed for Python 2, which does not implement this by default | |
def __ne__(self, other): | |
# type: (Any) -> bool | |
return not self.__eq__(other) | |
@property | |
def name(self): | |
# type: () -> str | |
return canonicalize_name(self.dist.project_name) | |
@property | |
def version(self): | |
# type: () -> _BaseVersion | |
return self.dist.parsed_version | |
def get_dependencies(self): | |
# type: () -> Sequence[Requirement] | |
return [ | |
self._factory.make_requirement_from_spec(str(r), self._ireq) | |
for r in self.dist.requires() | |
] | |
def get_install_requirement(self): | |
# type: () -> Optional[InstallRequirement] | |
return None | |
class ExtrasCandidate(Candidate): | |
"""A candidate that has 'extras', indicating additional dependencies. | |
Requirements can be for a project with dependencies, something like | |
foo[extra]. The extras don't affect the project/version being installed | |
directly, but indicate that we need additional dependencies. We model that | |
by having an artificial ExtrasCandidate that wraps the "base" candidate. | |
The ExtrasCandidate differs from the base in the following ways: | |
1. It has a unique name, of the form foo[extra]. This causes the resolver | |
to treat it as a separate node in the dependency graph. | |
2. When we're getting the candidate's dependencies, | |
a) We specify that we want the extra dependencies as well. | |
b) We add a dependency on the base candidate (matching the name and | |
version). See below for why this is needed. | |
3. We return None for the underlying InstallRequirement, as the base | |
candidate will provide it, and we don't want to end up with duplicates. | |
The dependency on the base candidate is needed so that the resolver can't | |
decide that it should recommend foo[extra1] version 1.0 and foo[extra2] | |
version 2.0. Having those candidates depend on foo=1.0 and foo=2.0 | |
respectively forces the resolver to recognise that this is a conflict. | |
""" | |
def __init__( | |
self, | |
base, # type: BaseCandidate | |
extras, # type: Set[str] | |
): | |
# type: (...) -> None | |
self.base = base | |
self.extras = extras | |
def __repr__(self): | |
# type: () -> str | |
return "{class_name}(base={base!r}, extras={extras!r})".format( | |
class_name=self.__class__.__name__, | |
base=self.base, | |
extras=self.extras, | |
) | |
def __eq__(self, other): | |
# type: (Any) -> bool | |
if isinstance(other, self.__class__): | |
return self.base == other.base and self.extras == other.extras | |
return False | |
# Needed for Python 2, which does not implement this by default | |
def __ne__(self, other): | |
# type: (Any) -> bool | |
return not self.__eq__(other) | |
@property | |
def name(self): | |
# type: () -> str | |
"""The normalised name of the project the candidate refers to""" | |
return format_name(self.base.name, self.extras) | |
@property | |
def version(self): | |
# type: () -> _BaseVersion | |
return self.base.version | |
def get_dependencies(self): | |
# type: () -> Sequence[Requirement] | |
factory = self.base._factory | |
# The user may have specified extras that the candidate doesn't | |
# support. We ignore any unsupported extras here. | |
valid_extras = self.extras.intersection(self.base.dist.extras) | |
invalid_extras = self.extras.difference(self.base.dist.extras) | |
if invalid_extras: | |
logger.warning( | |
"Invalid extras specified in %s: %s", | |
self.name, | |
','.join(sorted(invalid_extras)) | |
) | |
deps = [ | |
factory.make_requirement_from_spec(str(r), self.base._ireq) | |
for r in self.base.dist.requires(valid_extras) | |
] | |
# Add a dependency on the exact base. | |
# (See note 2b in the class docstring) | |
spec = "{}=={}".format(self.base.name, self.base.version) | |
deps.append(factory.make_requirement_from_spec(spec, self.base._ireq)) | |
return deps | |
def get_install_requirement(self): | |
# type: () -> Optional[InstallRequirement] | |
# We don't return anything here, because we always | |
# depend on the base candidate, and we'll get the | |
# install requirement from that. | |
return None | |
class RequiresPythonCandidate(Candidate): | |
def __init__(self, py_version_info): | |
# type: (Optional[Tuple[int, ...]]) -> None | |
if py_version_info is not None: | |
version_info = normalize_version_info(py_version_info) | |
else: | |
version_info = sys.version_info[:3] | |
self._version = Version(".".join(str(c) for c in version_info)) | |
# We don't need to implement __eq__() and __ne__() since there is always | |
# only one RequiresPythonCandidate in a resolution, i.e. the host Python. | |
# The built-in object.__eq__() and object.__ne__() do exactly what we want. | |
@property | |
def name(self): | |
# type: () -> str | |
# Avoid conflicting with the PyPI package "Python". | |
return "<Python fom Requires-Python>" | |
@property | |
def version(self): | |
# type: () -> _BaseVersion | |
return self._version | |
def get_dependencies(self): | |
# type: () -> Sequence[Requirement] | |
return [] | |
def get_install_requirement(self): | |
# type: () -> Optional[InstallRequirement] | |
return None |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.exceptions import ( | |
InstallationError, | |
UnsupportedPythonVersion, | |
) | |
from pip._internal.utils.misc import get_installed_distributions | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from .candidates import ( | |
AlreadyInstalledCandidate, | |
EditableCandidate, | |
ExtrasCandidate, | |
LinkCandidate, | |
RequiresPythonCandidate, | |
) | |
from .requirements import ( | |
ExplicitRequirement, | |
RequiresPythonRequirement, | |
SpecifierRequirement, | |
) | |
if MYPY_CHECK_RUNNING: | |
from typing import Dict, Iterator, Optional, Set, Tuple, TypeVar | |
from pip._vendor.packaging.specifiers import SpecifierSet | |
from pip._vendor.packaging.version import _BaseVersion | |
from pip._vendor.pkg_resources import Distribution | |
from pip._vendor.resolvelib import ResolutionImpossible | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.models.link import Link | |
from pip._internal.operations.prepare import RequirementPreparer | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.resolution.base import InstallRequirementProvider | |
from .base import Candidate, Requirement | |
from .candidates import BaseCandidate | |
C = TypeVar("C") | |
Cache = Dict[Link, C] | |
class Factory(object): | |
def __init__( | |
self, | |
finder, # type: PackageFinder | |
preparer, # type: RequirementPreparer | |
make_install_req, # type: InstallRequirementProvider | |
force_reinstall, # type: bool | |
ignore_installed, # type: bool | |
ignore_requires_python, # type: bool | |
py_version_info=None, # type: Optional[Tuple[int, ...]] | |
): | |
# type: (...) -> None | |
self.finder = finder | |
self.preparer = preparer | |
self._python_candidate = RequiresPythonCandidate(py_version_info) | |
self._make_install_req_from_spec = make_install_req | |
self._force_reinstall = force_reinstall | |
self._ignore_requires_python = ignore_requires_python | |
self._link_candidate_cache = {} # type: Cache[LinkCandidate] | |
self._editable_candidate_cache = {} # type: Cache[EditableCandidate] | |
if not ignore_installed: | |
self._installed_dists = { | |
canonicalize_name(dist.project_name): dist | |
for dist in get_installed_distributions() | |
} | |
else: | |
self._installed_dists = {} | |
def _make_candidate_from_dist( | |
self, | |
dist, # type: Distribution | |
extras, # type: Set[str] | |
parent, # type: InstallRequirement | |
): | |
# type: (...) -> Candidate | |
base = AlreadyInstalledCandidate(dist, parent, factory=self) | |
if extras: | |
return ExtrasCandidate(base, extras) | |
return base | |
def _make_candidate_from_link( | |
self, | |
link, # type: Link | |
extras, # type: Set[str] | |
parent, # type: InstallRequirement | |
name=None, # type: Optional[str] | |
version=None, # type: Optional[_BaseVersion] | |
): | |
# type: (...) -> Candidate | |
# TODO: Check already installed candidate, and use it if the link and | |
# editable flag match. | |
if parent.editable: | |
if link not in self._editable_candidate_cache: | |
self._editable_candidate_cache[link] = EditableCandidate( | |
link, parent, factory=self, name=name, version=version, | |
) | |
base = self._editable_candidate_cache[link] # type: BaseCandidate | |
else: | |
if link not in self._link_candidate_cache: | |
self._link_candidate_cache[link] = LinkCandidate( | |
link, parent, factory=self, name=name, version=version, | |
) | |
base = self._link_candidate_cache[link] | |
if extras: | |
return ExtrasCandidate(base, extras) | |
return base | |
def iter_found_candidates(self, ireq, extras): | |
# type: (InstallRequirement, Set[str]) -> Iterator[Candidate] | |
name = canonicalize_name(ireq.req.name) | |
if not self._force_reinstall: | |
installed_dist = self._installed_dists.get(name) | |
else: | |
installed_dist = None | |
found = self.finder.find_best_candidate( | |
project_name=ireq.req.name, | |
specifier=ireq.req.specifier, | |
hashes=ireq.hashes(trust_internet=False), | |
) | |
for ican in found.iter_applicable(): | |
if (installed_dist is not None and | |
installed_dist.parsed_version == ican.version): | |
continue | |
yield self._make_candidate_from_link( | |
link=ican.link, | |
extras=extras, | |
parent=ireq, | |
name=name, | |
version=ican.version, | |
) | |
# Return installed distribution if it matches the specifier. This is | |
# done last so the resolver will prefer it over downloading links. | |
if (installed_dist is not None and | |
installed_dist.parsed_version in ireq.req.specifier): | |
yield self._make_candidate_from_dist( | |
dist=installed_dist, | |
extras=extras, | |
parent=ireq, | |
) | |
def make_requirement_from_install_req(self, ireq): | |
# type: (InstallRequirement) -> Requirement | |
if ireq.link: | |
# TODO: Get name and version from ireq, if possible? | |
# Specifically, this might be needed in "name @ URL" | |
# syntax - need to check where that syntax is handled. | |
cand = self._make_candidate_from_link( | |
ireq.link, extras=set(), parent=ireq, | |
) | |
return ExplicitRequirement(cand) | |
return SpecifierRequirement(ireq, factory=self) | |
def make_requirement_from_spec(self, specifier, comes_from): | |
# type: (str, InstallRequirement) -> Requirement | |
ireq = self._make_install_req_from_spec(specifier, comes_from) | |
return self.make_requirement_from_install_req(ireq) | |
def make_requires_python_requirement(self, specifier): | |
# type: (Optional[SpecifierSet]) -> Optional[Requirement] | |
if self._ignore_requires_python or specifier is None: | |
return None | |
return RequiresPythonRequirement(specifier, self._python_candidate) | |
def should_reinstall(self, candidate): | |
# type: (Candidate) -> bool | |
# TODO: Are there more cases this needs to return True? Editable? | |
return candidate.name in self._installed_dists | |
def _report_requires_python_error( | |
self, | |
requirement, # type: RequiresPythonRequirement | |
parent, # type: Candidate | |
): | |
# type: (...) -> UnsupportedPythonVersion | |
template = ( | |
"Package {package!r} requires a different Python: " | |
"{version} not in {specifier!r}" | |
) | |
message = template.format( | |
package=parent.name, | |
version=self._python_candidate.version, | |
specifier=str(requirement.specifier), | |
) | |
return UnsupportedPythonVersion(message) | |
def get_installation_error(self, e): | |
# type: (ResolutionImpossible) -> Optional[InstallationError] | |
for cause in e.causes: | |
if isinstance(cause.requirement, RequiresPythonRequirement): | |
return self._report_requires_python_error( | |
cause.requirement, | |
cause.parent, | |
) | |
return None |
from pip._vendor.resolvelib.providers import AbstractProvider | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Optional, Sequence, Tuple, Union | |
from pip._internal.req.req_install import InstallRequirement | |
from .base import Requirement, Candidate | |
from .factory import Factory | |
class PipProvider(AbstractProvider): | |
def __init__( | |
self, | |
factory, # type: Factory | |
ignore_dependencies, # type: bool | |
): | |
# type: (...) -> None | |
self._factory = factory | |
self._ignore_dependencies = ignore_dependencies | |
def get_install_requirement(self, c): | |
# type: (Candidate) -> Optional[InstallRequirement] | |
return c.get_install_requirement() | |
def identify(self, dependency): | |
# type: (Union[Requirement, Candidate]) -> str | |
return dependency.name | |
def get_preference( | |
self, | |
resolution, # type: Optional[Candidate] | |
candidates, # type: Sequence[Candidate] | |
information # type: Sequence[Tuple[Requirement, Candidate]] | |
): | |
# type: (...) -> Any | |
# Use the "usual" value for now | |
return len(candidates) | |
def find_matches(self, requirement): | |
# type: (Requirement) -> Sequence[Candidate] | |
return requirement.find_matches() | |
def is_satisfied_by(self, requirement, candidate): | |
# type: (Requirement, Candidate) -> bool | |
return requirement.is_satisfied_by(candidate) | |
def get_dependencies(self, candidate): | |
# type: (Candidate) -> Sequence[Requirement] | |
if self._ignore_dependencies: | |
return [] | |
return candidate.get_dependencies() |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from .base import Requirement, format_name | |
if MYPY_CHECK_RUNNING: | |
from typing import Sequence | |
from pip._vendor.packaging.specifiers import SpecifierSet | |
from pip._internal.req.req_install import InstallRequirement | |
from .base import Candidate | |
from .factory import Factory | |
class ExplicitRequirement(Requirement): | |
def __init__(self, candidate): | |
# type: (Candidate) -> None | |
self.candidate = candidate | |
def __repr__(self): | |
# type: () -> str | |
return "{class_name}({candidate!r})".format( | |
class_name=self.__class__.__name__, | |
candidate=self.candidate, | |
) | |
@property | |
def name(self): | |
# type: () -> str | |
# No need to canonicalise - the candidate did this | |
return self.candidate.name | |
def find_matches(self): | |
# type: () -> Sequence[Candidate] | |
return [self.candidate] | |
def is_satisfied_by(self, candidate): | |
# type: (Candidate) -> bool | |
return candidate == self.candidate | |
class SpecifierRequirement(Requirement): | |
def __init__(self, ireq, factory): | |
# type: (InstallRequirement, Factory) -> None | |
assert ireq.link is None, "This is a link, not a specifier" | |
self._ireq = ireq | |
self._factory = factory | |
self.extras = ireq.req.extras | |
def __str__(self): | |
# type: () -> str | |
return str(self._ireq.req) | |
def __repr__(self): | |
# type: () -> str | |
return "{class_name}({requirement!r})".format( | |
class_name=self.__class__.__name__, | |
requirement=str(self._ireq.req), | |
) | |
@property | |
def name(self): | |
# type: () -> str | |
canonical_name = canonicalize_name(self._ireq.req.name) | |
return format_name(canonical_name, self.extras) | |
def find_matches(self): | |
# type: () -> Sequence[Candidate] | |
it = self._factory.iter_found_candidates(self._ireq, self.extras) | |
return list(it) | |
def is_satisfied_by(self, candidate): | |
# type: (Candidate) -> bool | |
assert candidate.name == self.name, \ | |
"Internal issue: Candidate is not for this requirement " \ | |
" {} vs {}".format(candidate.name, self.name) | |
# We can safely always allow prereleases here since PackageFinder | |
# already implements the prerelease logic, and would have filtered out | |
# prerelease candidates if the user does not expect them. | |
spec = self._ireq.req.specifier | |
return spec.contains(candidate.version, prereleases=True) | |
class RequiresPythonRequirement(Requirement): | |
"""A requirement representing Requires-Python metadata. | |
""" | |
def __init__(self, specifier, match): | |
# type: (SpecifierSet, Candidate) -> None | |
self.specifier = specifier | |
self._candidate = match | |
def __repr__(self): | |
# type: () -> str | |
return "{class_name}({specifier!r})".format( | |
class_name=self.__class__.__name__, | |
specifier=str(self.specifier), | |
) | |
@property | |
def name(self): | |
# type: () -> str | |
return self._candidate.name | |
def find_matches(self): | |
# type: () -> Sequence[Candidate] | |
if self._candidate.version in self.specifier: | |
return [self._candidate] | |
return [] | |
def is_satisfied_by(self, candidate): | |
# type: (Candidate) -> bool | |
assert candidate.name == self._candidate.name, "Not Python candidate" | |
# We can safely always allow prereleases here since PackageFinder | |
# already implements the prerelease logic, and would have filtered out | |
# prerelease candidates if the user does not expect them. | |
return self.specifier.contains(candidate.version, prereleases=True) |
import functools | |
import logging | |
from pip._vendor import six | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.resolvelib import BaseReporter, ResolutionImpossible | |
from pip._vendor.resolvelib import Resolver as RLResolver | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.req.req_set import RequirementSet | |
from pip._internal.resolution.base import BaseResolver | |
from pip._internal.resolution.resolvelib.provider import PipProvider | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from .factory import Factory | |
if MYPY_CHECK_RUNNING: | |
from typing import Dict, List, Optional, Tuple | |
from pip._vendor.resolvelib.resolvers import Result | |
from pip._internal.cache import WheelCache | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.operations.prepare import RequirementPreparer | |
from pip._internal.req.req_install import InstallRequirement | |
from pip._internal.resolution.base import InstallRequirementProvider | |
logger = logging.getLogger(__name__) | |
class Resolver(BaseResolver): | |
def __init__( | |
self, | |
preparer, # type: RequirementPreparer | |
finder, # type: PackageFinder | |
wheel_cache, # type: Optional[WheelCache] | |
make_install_req, # type: InstallRequirementProvider | |
use_user_site, # type: bool | |
ignore_dependencies, # type: bool | |
ignore_installed, # type: bool | |
ignore_requires_python, # type: bool | |
force_reinstall, # type: bool | |
upgrade_strategy, # type: str | |
py_version_info=None, # type: Optional[Tuple[int, ...]] | |
): | |
super(Resolver, self).__init__() | |
self.factory = Factory( | |
finder=finder, | |
preparer=preparer, | |
make_install_req=make_install_req, | |
force_reinstall=force_reinstall, | |
ignore_installed=ignore_installed, | |
ignore_requires_python=ignore_requires_python, | |
py_version_info=py_version_info, | |
) | |
self.ignore_dependencies = ignore_dependencies | |
self._result = None # type: Optional[Result] | |
def resolve(self, root_reqs, check_supported_wheels): | |
# type: (List[InstallRequirement], bool) -> RequirementSet | |
# FIXME: Implement constraints. | |
if any(r.constraint for r in root_reqs): | |
raise InstallationError("Constraints are not yet supported.") | |
provider = PipProvider( | |
factory=self.factory, | |
ignore_dependencies=self.ignore_dependencies, | |
) | |
reporter = BaseReporter() | |
resolver = RLResolver(provider, reporter) | |
requirements = [ | |
self.factory.make_requirement_from_install_req(r) | |
for r in root_reqs | |
] | |
try: | |
self._result = resolver.resolve(requirements) | |
except ResolutionImpossible as e: | |
error = self.factory.get_installation_error(e) | |
if not error: | |
# TODO: This needs fixing, we need to look at the | |
# factory.get_installation_error infrastructure, as that | |
# doesn't really allow for the logger.critical calls I'm | |
# using here. | |
for req, parent in e.causes: | |
logger.critical( | |
"Could not find a version that satisfies " + | |
"the requirement " + | |
str(req) + | |
("" if parent is None else " (from {})".format( | |
parent.name | |
)) | |
) | |
raise InstallationError( | |
"No matching distribution found for " + | |
", ".join([r.name for r, _ in e.causes]) | |
) | |
raise | |
six.raise_from(error, e) | |
req_set = RequirementSet(check_supported_wheels=check_supported_wheels) | |
for candidate in self._result.mapping.values(): | |
ireq = provider.get_install_requirement(candidate) | |
if ireq is None: | |
continue | |
ireq.should_reinstall = self.factory.should_reinstall(candidate) | |
req_set.add_named_requirement(ireq) | |
return req_set | |
def get_installation_order(self, req_set): | |
# type: (RequirementSet) -> List[InstallRequirement] | |
"""Create a list that orders given requirements for installation. | |
The returned list should contain all requirements in ``req_set``, | |
so the caller can loop through it and have a requirement installed | |
before the requiring thing. | |
The current implementation walks the resolved dependency graph, and | |
make sure every node has a greater "weight" than all its parents. | |
""" | |
assert self._result is not None, "must call resolve() first" | |
weights = {} # type: Dict[Optional[str], int] | |
graph = self._result.graph | |
key_count = len(self._result.mapping) + 1 # Packages plus sentinal. | |
while len(weights) < key_count: | |
progressed = False | |
for key in graph: | |
if key in weights: | |
continue | |
parents = list(graph.iter_parents(key)) | |
if not all(p in weights for p in parents): | |
continue | |
if parents: | |
weight = max(weights[p] for p in parents) + 1 | |
else: | |
weight = 0 | |
weights[key] = weight | |
progressed = True | |
# FIXME: This check will fail if there are unbreakable cycles. | |
# Implement something to forcifully break them up to continue. | |
if not progressed: | |
raise InstallationError( | |
"Could not determine installation order due to cicular " | |
"dependency." | |
) | |
sorted_items = sorted( | |
req_set.requirements.items(), | |
key=functools.partial(_req_set_item_sorter, weights=weights), | |
reverse=True, | |
) | |
return [ireq for _, ireq in sorted_items] | |
def _req_set_item_sorter( | |
item, # type: Tuple[str, InstallRequirement] | |
weights, # type: Dict[Optional[str], int] | |
): | |
# type: (...) -> Tuple[int, str] | |
"""Key function used to sort install requirements for installation. | |
Based on the "weight" mapping calculated in ``get_installation_order()``. | |
The canonical package name is returned as the second member as a tie- | |
breaker to ensure the result is predictable, which is useful in tests. | |
""" | |
name = canonicalize_name(item[0]) | |
return weights[name], name |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import datetime | |
import hashlib | |
import json | |
import logging | |
import os.path | |
import sys | |
from pip._vendor import pkg_resources | |
from pip._vendor.packaging import version as packaging_version | |
from pip._vendor.six import ensure_binary | |
from pip._internal.index.collector import LinkCollector | |
from pip._internal.index.package_finder import PackageFinder | |
from pip._internal.models.search_scope import SearchScope | |
from pip._internal.models.selection_prefs import SelectionPreferences | |
from pip._internal.utils.filesystem import ( | |
adjacent_tmp_file, | |
check_path_owner, | |
replace, | |
) | |
from pip._internal.utils.misc import ( | |
ensure_dir, | |
get_installed_version, | |
redact_auth_from_url, | |
) | |
from pip._internal.utils.packaging import get_installer | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
import optparse | |
from optparse import Values | |
from typing import Any, Dict, Text, Union | |
from pip._internal.network.session import PipSession | |
SELFCHECK_DATE_FMT = "%Y-%m-%dT%H:%M:%SZ" | |
logger = logging.getLogger(__name__) | |
def make_link_collector( | |
session, # type: PipSession | |
options, # type: Values | |
suppress_no_index=False, # type: bool | |
): | |
# type: (...) -> LinkCollector | |
""" | |
:param session: The Session to use to make requests. | |
:param suppress_no_index: Whether to ignore the --no-index option | |
when constructing the SearchScope object. | |
""" | |
index_urls = [options.index_url] + options.extra_index_urls | |
if options.no_index and not suppress_no_index: | |
logger.debug( | |
'Ignoring indexes: %s', | |
','.join(redact_auth_from_url(url) for url in index_urls), | |
) | |
index_urls = [] | |
# Make sure find_links is a list before passing to create(). | |
find_links = options.find_links or [] | |
search_scope = SearchScope.create( | |
find_links=find_links, index_urls=index_urls, | |
) | |
link_collector = LinkCollector(session=session, search_scope=search_scope) | |
return link_collector | |
def _get_statefile_name(key): | |
# type: (Union[str, Text]) -> str | |
key_bytes = ensure_binary(key) | |
name = hashlib.sha224(key_bytes).hexdigest() | |
return name | |
class SelfCheckState(object): | |
def __init__(self, cache_dir): | |
# type: (str) -> None | |
self.state = {} # type: Dict[str, Any] | |
self.statefile_path = None | |
# Try to load the existing state | |
if cache_dir: | |
self.statefile_path = os.path.join( | |
cache_dir, "selfcheck", _get_statefile_name(self.key) | |
) | |
try: | |
with open(self.statefile_path) as statefile: | |
self.state = json.load(statefile) | |
except (IOError, ValueError, KeyError): | |
# Explicitly suppressing exceptions, since we don't want to | |
# error out if the cache file is invalid. | |
pass | |
@property | |
def key(self): | |
return sys.prefix | |
def save(self, pypi_version, current_time): | |
# type: (str, datetime.datetime) -> None | |
# If we do not have a path to cache in, don't bother saving. | |
if not self.statefile_path: | |
return | |
# Check to make sure that we own the directory | |
if not check_path_owner(os.path.dirname(self.statefile_path)): | |
return | |
# Now that we've ensured the directory is owned by this user, we'll go | |
# ahead and make sure that all our directories are created. | |
ensure_dir(os.path.dirname(self.statefile_path)) | |
state = { | |
# Include the key so it's easy to tell which pip wrote the | |
# file. | |
"key": self.key, | |
"last_check": current_time.strftime(SELFCHECK_DATE_FMT), | |
"pypi_version": pypi_version, | |
} | |
text = json.dumps(state, sort_keys=True, separators=(",", ":")) | |
with adjacent_tmp_file(self.statefile_path) as f: | |
f.write(ensure_binary(text)) | |
try: | |
# Since we have a prefix-specific state file, we can just | |
# overwrite whatever is there, no need to check. | |
replace(f.name, self.statefile_path) | |
except OSError: | |
# Best effort. | |
pass | |
def was_installed_by_pip(pkg): | |
# type: (str) -> bool | |
"""Checks whether pkg was installed by pip | |
This is used not to display the upgrade message when pip is in fact | |
installed by system package manager, such as dnf on Fedora. | |
""" | |
try: | |
dist = pkg_resources.get_distribution(pkg) | |
return "pip" == get_installer(dist) | |
except pkg_resources.DistributionNotFound: | |
return False | |
def pip_self_version_check(session, options): | |
# type: (PipSession, optparse.Values) -> None | |
"""Check for an update for pip. | |
Limit the frequency of checks to once per week. State is stored either in | |
the active virtualenv or in the user's USER_CACHE_DIR keyed off the prefix | |
of the pip script path. | |
""" | |
installed_version = get_installed_version("pip") | |
if not installed_version: | |
return | |
pip_version = packaging_version.parse(installed_version) | |
pypi_version = None | |
try: | |
state = SelfCheckState(cache_dir=options.cache_dir) | |
current_time = datetime.datetime.utcnow() | |
# Determine if we need to refresh the state | |
if "last_check" in state.state and "pypi_version" in state.state: | |
last_check = datetime.datetime.strptime( | |
state.state["last_check"], | |
SELFCHECK_DATE_FMT | |
) | |
if (current_time - last_check).total_seconds() < 7 * 24 * 60 * 60: | |
pypi_version = state.state["pypi_version"] | |
# Refresh the version if we need to or just see if we need to warn | |
if pypi_version is None: | |
# Lets use PackageFinder to see what the latest pip version is | |
link_collector = make_link_collector( | |
session, | |
options=options, | |
suppress_no_index=True, | |
) | |
# Pass allow_yanked=False so we don't suggest upgrading to a | |
# yanked version. | |
selection_prefs = SelectionPreferences( | |
allow_yanked=False, | |
allow_all_prereleases=False, # Explicitly set to False | |
) | |
finder = PackageFinder.create( | |
link_collector=link_collector, | |
selection_prefs=selection_prefs, | |
) | |
best_candidate = finder.find_best_candidate("pip").best_candidate | |
if best_candidate is None: | |
return | |
pypi_version = str(best_candidate.version) | |
# save that we've performed a check | |
state.save(pypi_version, current_time) | |
remote_version = packaging_version.parse(pypi_version) | |
local_version_is_older = ( | |
pip_version < remote_version and | |
pip_version.base_version != remote_version.base_version and | |
was_installed_by_pip('pip') | |
) | |
# Determine if our pypi_version is older | |
if not local_version_is_older: | |
return | |
# We cannot tell how the current pip is available in the current | |
# command context, so be pragmatic here and suggest the command | |
# that's always available. This does not accommodate spaces in | |
# `sys.executable`. | |
pip_cmd = "{} -m pip".format(sys.executable) | |
logger.warning( | |
"You are using pip version %s; however, version %s is " | |
"available.\nYou should consider upgrading via the " | |
"'%s install --upgrade pip' command.", | |
pip_version, pypi_version, pip_cmd | |
) | |
except Exception: | |
logger.debug( | |
"There was an error checking the latest version of pip", | |
exc_info=True, | |
) |
""" | |
This code wraps the vendored appdirs module to so the return values are | |
compatible for the current pip code base. | |
The intention is to rewrite current usages gradually, keeping the tests pass, | |
and eventually drop this after all usages are changed. | |
""" | |
from __future__ import absolute_import | |
import os | |
from pip._vendor import appdirs as _appdirs | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List | |
def user_cache_dir(appname): | |
# type: (str) -> str | |
return _appdirs.user_cache_dir(appname, appauthor=False) | |
def user_config_dir(appname, roaming=True): | |
# type: (str, bool) -> str | |
path = _appdirs.user_config_dir(appname, appauthor=False, roaming=roaming) | |
if _appdirs.system == "darwin" and not os.path.isdir(path): | |
path = os.path.expanduser('~/.config/') | |
if appname: | |
path = os.path.join(path, appname) | |
return path | |
# for the discussion regarding site_config_dir locations | |
# see <https://github.com/pypa/pip/issues/1733> | |
def site_config_dirs(appname): | |
# type: (str) -> List[str] | |
dirval = _appdirs.site_config_dir(appname, appauthor=False, multipath=True) | |
if _appdirs.system not in ["win32", "darwin"]: | |
# always look in /etc directly as well | |
return dirval.split(os.pathsep) + ['/etc'] | |
return [dirval] |
"""Stuff that differs in different Python versions and platform | |
distributions.""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import, division | |
import codecs | |
import locale | |
import logging | |
import os | |
import shutil | |
import sys | |
from pip._vendor.six import PY2, text_type | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Text, Tuple, Union | |
try: | |
import ipaddress | |
except ImportError: | |
try: | |
from pip._vendor import ipaddress # type: ignore | |
except ImportError: | |
import ipaddr as ipaddress # type: ignore | |
ipaddress.ip_address = ipaddress.IPAddress # type: ignore | |
ipaddress.ip_network = ipaddress.IPNetwork # type: ignore | |
__all__ = [ | |
"ipaddress", "uses_pycache", "console_to_str", | |
"get_path_uid", "stdlib_pkgs", "WINDOWS", "samefile", "get_terminal_size", | |
] | |
logger = logging.getLogger(__name__) | |
if PY2: | |
import imp | |
try: | |
cache_from_source = imp.cache_from_source # type: ignore | |
except AttributeError: | |
# does not use __pycache__ | |
cache_from_source = None | |
uses_pycache = cache_from_source is not None | |
else: | |
uses_pycache = True | |
from importlib.util import cache_from_source | |
if PY2: | |
# In Python 2.7, backslashreplace exists | |
# but does not support use for decoding. | |
# We implement our own replace handler for this | |
# situation, so that we can consistently use | |
# backslash replacement for all versions. | |
def backslashreplace_decode_fn(err): | |
raw_bytes = (err.object[i] for i in range(err.start, err.end)) | |
# Python 2 gave us characters - convert to numeric bytes | |
raw_bytes = (ord(b) for b in raw_bytes) | |
return u"".join(map(u"\\x{:x}".format, raw_bytes)), err.end | |
codecs.register_error( | |
"backslashreplace_decode", | |
backslashreplace_decode_fn, | |
) | |
backslashreplace_decode = "backslashreplace_decode" | |
else: | |
backslashreplace_decode = "backslashreplace" | |
def has_tls(): | |
# type: () -> bool | |
try: | |
import _ssl # noqa: F401 # ignore unused | |
return True | |
except ImportError: | |
pass | |
from pip._vendor.urllib3.util import IS_PYOPENSSL | |
return IS_PYOPENSSL | |
def str_to_display(data, desc=None): | |
# type: (Union[bytes, Text], Optional[str]) -> Text | |
""" | |
For display or logging purposes, convert a bytes object (or text) to | |
text (e.g. unicode in Python 2) safe for output. | |
:param desc: An optional phrase describing the input data, for use in | |
the log message if a warning is logged. Defaults to "Bytes object". | |
This function should never error out and so can take a best effort | |
approach. It is okay to be lossy if needed since the return value is | |
just for display. | |
We assume the data is in the locale preferred encoding. If it won't | |
decode properly, we warn the user but decode as best we can. | |
We also ensure that the output can be safely written to standard output | |
without encoding errors. | |
""" | |
if isinstance(data, text_type): | |
return data | |
# Otherwise, data is a bytes object (str in Python 2). | |
# First, get the encoding we assume. This is the preferred | |
# encoding for the locale, unless that is not found, or | |
# it is ASCII, in which case assume UTF-8 | |
encoding = locale.getpreferredencoding() | |
if (not encoding) or codecs.lookup(encoding).name == "ascii": | |
encoding = "utf-8" | |
# Now try to decode the data - if we fail, warn the user and | |
# decode with replacement. | |
try: | |
decoded_data = data.decode(encoding) | |
except UnicodeDecodeError: | |
if desc is None: | |
desc = 'Bytes object' | |
msg_format = '{} does not appear to be encoded as %s'.format(desc) | |
logger.warning(msg_format, encoding) | |
decoded_data = data.decode(encoding, errors=backslashreplace_decode) | |
# Make sure we can print the output, by encoding it to the output | |
# encoding with replacement of unencodable characters, and then | |
# decoding again. | |
# We use stderr's encoding because it's less likely to be | |
# redirected and if we don't find an encoding we skip this | |
# step (on the assumption that output is wrapped by something | |
# that won't fail). | |
# The double getattr is to deal with the possibility that we're | |
# being called in a situation where sys.__stderr__ doesn't exist, | |
# or doesn't have an encoding attribute. Neither of these cases | |
# should occur in normal pip use, but there's no harm in checking | |
# in case people use pip in (unsupported) unusual situations. | |
output_encoding = getattr(getattr(sys, "__stderr__", None), | |
"encoding", None) | |
if output_encoding: | |
output_encoded = decoded_data.encode( | |
output_encoding, | |
errors="backslashreplace" | |
) | |
decoded_data = output_encoded.decode(output_encoding) | |
return decoded_data | |
def console_to_str(data): | |
# type: (bytes) -> Text | |
"""Return a string, safe for output, of subprocess output. | |
""" | |
return str_to_display(data, desc='Subprocess output') | |
def get_path_uid(path): | |
# type: (str) -> int | |
""" | |
Return path's uid. | |
Does not follow symlinks: | |
https://github.com/pypa/pip/pull/935#discussion_r5307003 | |
Placed this function in compat due to differences on AIX and | |
Jython, that should eventually go away. | |
:raises OSError: When path is a symlink or can't be read. | |
""" | |
if hasattr(os, 'O_NOFOLLOW'): | |
fd = os.open(path, os.O_RDONLY | os.O_NOFOLLOW) | |
file_uid = os.fstat(fd).st_uid | |
os.close(fd) | |
else: # AIX and Jython | |
# WARNING: time of check vulnerability, but best we can do w/o NOFOLLOW | |
if not os.path.islink(path): | |
# older versions of Jython don't have `os.fstat` | |
file_uid = os.stat(path).st_uid | |
else: | |
# raise OSError for parity with os.O_NOFOLLOW above | |
raise OSError( | |
"{} is a symlink; Will not return uid for symlinks".format( | |
path) | |
) | |
return file_uid | |
def expanduser(path): | |
# type: (str) -> str | |
""" | |
Expand ~ and ~user constructions. | |
Includes a workaround for https://bugs.python.org/issue14768 | |
""" | |
expanded = os.path.expanduser(path) | |
if path.startswith('~/') and expanded.startswith('//'): | |
expanded = expanded[1:] | |
return expanded | |
# packages in the stdlib that may have installation metadata, but should not be | |
# considered 'installed'. this theoretically could be determined based on | |
# dist.location (py27:`sysconfig.get_paths()['stdlib']`, | |
# py26:sysconfig.get_config_vars('LIBDEST')), but fear platform variation may | |
# make this ineffective, so hard-coding | |
stdlib_pkgs = {"python", "wsgiref", "argparse"} | |
# windows detection, covers cpython and ironpython | |
WINDOWS = (sys.platform.startswith("win") or | |
(sys.platform == 'cli' and os.name == 'nt')) | |
def samefile(file1, file2): | |
# type: (str, str) -> bool | |
"""Provide an alternative for os.path.samefile on Windows/Python2""" | |
if hasattr(os.path, 'samefile'): | |
return os.path.samefile(file1, file2) | |
else: | |
path1 = os.path.normcase(os.path.abspath(file1)) | |
path2 = os.path.normcase(os.path.abspath(file2)) | |
return path1 == path2 | |
if hasattr(shutil, 'get_terminal_size'): | |
def get_terminal_size(): | |
# type: () -> Tuple[int, int] | |
""" | |
Returns a tuple (x, y) representing the width(x) and the height(y) | |
in characters of the terminal window. | |
""" | |
return tuple(shutil.get_terminal_size()) # type: ignore | |
else: | |
def get_terminal_size(): | |
# type: () -> Tuple[int, int] | |
""" | |
Returns a tuple (x, y) representing the width(x) and the height(y) | |
in characters of the terminal window. | |
""" | |
def ioctl_GWINSZ(fd): | |
try: | |
import fcntl | |
import termios | |
import struct | |
cr = struct.unpack_from( | |
'hh', | |
fcntl.ioctl(fd, termios.TIOCGWINSZ, '12345678') | |
) | |
except Exception: | |
return None | |
if cr == (0, 0): | |
return None | |
return cr | |
cr = ioctl_GWINSZ(0) or ioctl_GWINSZ(1) or ioctl_GWINSZ(2) | |
if not cr: | |
if sys.platform != "win32": | |
try: | |
fd = os.open(os.ctermid(), os.O_RDONLY) | |
cr = ioctl_GWINSZ(fd) | |
os.close(fd) | |
except Exception: | |
pass | |
if not cr: | |
cr = (os.environ.get('LINES', 25), os.environ.get('COLUMNS', 80)) | |
return int(cr[1]), int(cr[0]) |
""" | |
A module that implements tooling to enable easy warnings about deprecations. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import warnings | |
from pip._vendor.packaging.version import parse | |
from pip import __version__ as current_version | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Optional | |
DEPRECATION_MSG_PREFIX = "DEPRECATION: " | |
class PipDeprecationWarning(Warning): | |
pass | |
_original_showwarning = None # type: Any | |
# Warnings <-> Logging Integration | |
def _showwarning(message, category, filename, lineno, file=None, line=None): | |
if file is not None: | |
if _original_showwarning is not None: | |
_original_showwarning( | |
message, category, filename, lineno, file, line, | |
) | |
elif issubclass(category, PipDeprecationWarning): | |
# We use a specially named logger which will handle all of the | |
# deprecation messages for pip. | |
logger = logging.getLogger("pip._internal.deprecations") | |
logger.warning(message) | |
else: | |
_original_showwarning( | |
message, category, filename, lineno, file, line, | |
) | |
def install_warning_logger(): | |
# type: () -> None | |
# Enable our Deprecation Warnings | |
warnings.simplefilter("default", PipDeprecationWarning, append=True) | |
global _original_showwarning | |
if _original_showwarning is None: | |
_original_showwarning = warnings.showwarning | |
warnings.showwarning = _showwarning | |
def deprecated(reason, replacement, gone_in, issue=None): | |
# type: (str, Optional[str], Optional[str], Optional[int]) -> None | |
"""Helper to deprecate existing functionality. | |
reason: | |
Textual reason shown to the user about why this functionality has | |
been deprecated. | |
replacement: | |
Textual suggestion shown to the user about what alternative | |
functionality they can use. | |
gone_in: | |
The version of pip does this functionality should get removed in. | |
Raises errors if pip's current version is greater than or equal to | |
this. | |
issue: | |
Issue number on the tracker that would serve as a useful place for | |
users to find related discussion and provide feedback. | |
Always pass replacement, gone_in and issue as keyword arguments for clarity | |
at the call site. | |
""" | |
# Construct a nice message. | |
# This is eagerly formatted as we want it to get logged as if someone | |
# typed this entire message out. | |
sentences = [ | |
(reason, DEPRECATION_MSG_PREFIX + "{}"), | |
(gone_in, "pip {} will remove support for this functionality."), | |
(replacement, "A possible replacement is {}."), | |
(issue, ( | |
"You can find discussion regarding this at " | |
"https://github.com/pypa/pip/issues/{}." | |
)), | |
] | |
message = " ".join( | |
template.format(val) for val, template in sentences if val is not None | |
) | |
# Raise as an error if it has to be removed. | |
if gone_in is not None and parse(current_version) >= parse(gone_in): | |
raise PipDeprecationWarning(message) | |
warnings.warn(message, category=PipDeprecationWarning, stacklevel=2) |
import logging | |
from pip._internal.models.direct_url import ( | |
DIRECT_URL_METADATA_NAME, | |
ArchiveInfo, | |
DirectUrl, | |
DirectUrlValidationError, | |
DirInfo, | |
VcsInfo, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.vcs import vcs | |
try: | |
from json import JSONDecodeError | |
except ImportError: | |
# PY2 | |
JSONDecodeError = ValueError # type: ignore | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional | |
from pip._internal.models.link import Link | |
from pip._vendor.pkg_resources import Distribution | |
logger = logging.getLogger(__name__) | |
def direct_url_as_pep440_direct_reference(direct_url, name): | |
# type: (DirectUrl, str) -> str | |
"""Convert a DirectUrl to a pip requirement string.""" | |
direct_url.validate() # if invalid, this is a pip bug | |
requirement = name + " @ " | |
fragments = [] | |
if isinstance(direct_url.info, VcsInfo): | |
requirement += "{}+{}@{}".format( | |
direct_url.info.vcs, direct_url.url, direct_url.info.commit_id | |
) | |
elif isinstance(direct_url.info, ArchiveInfo): | |
requirement += direct_url.url | |
if direct_url.info.hash: | |
fragments.append(direct_url.info.hash) | |
else: | |
assert isinstance(direct_url.info, DirInfo) | |
# pip should never reach this point for editables, since | |
# pip freeze inspects the editable project location to produce | |
# the requirement string | |
assert not direct_url.info.editable | |
requirement += direct_url.url | |
if direct_url.subdirectory: | |
fragments.append("subdirectory=" + direct_url.subdirectory) | |
if fragments: | |
requirement += "#" + "&".join(fragments) | |
return requirement | |
def direct_url_from_link(link, source_dir=None, link_is_in_wheel_cache=False): | |
# type: (Link, Optional[str], bool) -> DirectUrl | |
if link.is_vcs: | |
vcs_backend = vcs.get_backend_for_scheme(link.scheme) | |
assert vcs_backend | |
url, requested_revision, _ = ( | |
vcs_backend.get_url_rev_and_auth(link.url_without_fragment) | |
) | |
# For VCS links, we need to find out and add commit_id. | |
if link_is_in_wheel_cache: | |
# If the requested VCS link corresponds to a cached | |
# wheel, it means the requested revision was an | |
# immutable commit hash, otherwise it would not have | |
# been cached. In that case we don't have a source_dir | |
# with the VCS checkout. | |
assert requested_revision | |
commit_id = requested_revision | |
else: | |
# If the wheel was not in cache, it means we have | |
# had to checkout from VCS to build and we have a source_dir | |
# which we can inspect to find out the commit id. | |
assert source_dir | |
commit_id = vcs_backend.get_revision(source_dir) | |
return DirectUrl( | |
url=url, | |
info=VcsInfo( | |
vcs=vcs_backend.name, | |
commit_id=commit_id, | |
requested_revision=requested_revision, | |
), | |
subdirectory=link.subdirectory_fragment, | |
) | |
elif link.is_existing_dir(): | |
return DirectUrl( | |
url=link.url_without_fragment, | |
info=DirInfo(), | |
subdirectory=link.subdirectory_fragment, | |
) | |
else: | |
hash = None | |
hash_name = link.hash_name | |
if hash_name: | |
hash = "{}={}".format(hash_name, link.hash) | |
return DirectUrl( | |
url=link.url_without_fragment, | |
info=ArchiveInfo(hash=hash), | |
subdirectory=link.subdirectory_fragment, | |
) | |
def dist_get_direct_url(dist): | |
# type: (Distribution) -> Optional[DirectUrl] | |
"""Obtain a DirectUrl from a pkg_resource.Distribution. | |
Returns None if the distribution has no `direct_url.json` metadata, | |
or if `direct_url.json` is invalid. | |
""" | |
if not dist.has_metadata(DIRECT_URL_METADATA_NAME): | |
return None | |
try: | |
return DirectUrl.from_json(dist.get_metadata(DIRECT_URL_METADATA_NAME)) | |
except ( | |
DirectUrlValidationError, | |
JSONDecodeError, | |
UnicodeDecodeError | |
) as e: | |
logger.warning( | |
"Error parsing %s for %s: %s", | |
DIRECT_URL_METADATA_NAME, | |
dist.project_name, | |
e, | |
) | |
return None |
from distutils.errors import DistutilsArgError | |
from distutils.fancy_getopt import FancyGetopt | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Dict, List | |
_options = [ | |
("exec-prefix=", None, ""), | |
("home=", None, ""), | |
("install-base=", None, ""), | |
("install-data=", None, ""), | |
("install-headers=", None, ""), | |
("install-lib=", None, ""), | |
("install-platlib=", None, ""), | |
("install-purelib=", None, ""), | |
("install-scripts=", None, ""), | |
("prefix=", None, ""), | |
("root=", None, ""), | |
("user", None, ""), | |
] | |
# typeshed doesn't permit Tuple[str, None, str], see python/typeshed#3469. | |
_distutils_getopt = FancyGetopt(_options) # type: ignore | |
def parse_distutils_args(args): | |
# type: (List[str]) -> Dict[str, str] | |
"""Parse provided arguments, returning an object that has the | |
matched arguments. | |
Any unknown arguments are ignored. | |
""" | |
result = {} | |
for arg in args: | |
try: | |
_, match = _distutils_getopt.getopt(args=[arg]) | |
except DistutilsArgError: | |
# We don't care about any other options, which here may be | |
# considered unrecognized since our option list is not | |
# exhaustive. | |
pass | |
else: | |
result.update(match.__dict__) | |
return result |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
import codecs | |
import locale | |
import re | |
import sys | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Tuple, Text | |
BOMS = [ | |
(codecs.BOM_UTF8, 'utf-8'), | |
(codecs.BOM_UTF16, 'utf-16'), | |
(codecs.BOM_UTF16_BE, 'utf-16-be'), | |
(codecs.BOM_UTF16_LE, 'utf-16-le'), | |
(codecs.BOM_UTF32, 'utf-32'), | |
(codecs.BOM_UTF32_BE, 'utf-32-be'), | |
(codecs.BOM_UTF32_LE, 'utf-32-le'), | |
] # type: List[Tuple[bytes, Text]] | |
ENCODING_RE = re.compile(br'coding[:=]\s*([-\w.]+)') | |
def auto_decode(data): | |
# type: (bytes) -> Text | |
"""Check a bytes string for a BOM to correctly detect the encoding | |
Fallback to locale.getpreferredencoding(False) like open() on Python3""" | |
for bom, encoding in BOMS: | |
if data.startswith(bom): | |
return data[len(bom):].decode(encoding) | |
# Lets check the first two lines as in PEP263 | |
for line in data.split(b'\n')[:2]: | |
if line[0:1] == b'#' and ENCODING_RE.search(line): | |
encoding = ENCODING_RE.search(line).groups()[0].decode('ascii') | |
return data.decode(encoding) | |
return data.decode( | |
locale.getpreferredencoding(False) or sys.getdefaultencoding(), | |
) |
import sys | |
from pip._internal.cli.main import main | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, List | |
def _wrapper(args=None): | |
# type: (Optional[List[str]]) -> int | |
"""Central wrapper for all old entrypoints. | |
Historically pip has had several entrypoints defined. Because of issues | |
arising from PATH, sys.path, multiple Pythons, their interactions, and most | |
of them having a pip installed, users suffer every time an entrypoint gets | |
moved. | |
To alleviate this pain, and provide a mechanism for warning users and | |
directing them to an appropriate place for help, we now define all of | |
our old entrypoints as wrappers for the current one. | |
""" | |
sys.stderr.write( | |
"WARNING: pip is being invoked by an old script wrapper. This will " | |
"fail in a future version of pip.\n" | |
"Please see https://github.com/pypa/pip/issues/5599 for advice on " | |
"fixing the underlying issue.\n" | |
"To avoid this problem you can invoke Python with '-m pip' instead of " | |
"running pip directly.\n" | |
) | |
return main(args) |
import errno | |
import fnmatch | |
import os | |
import os.path | |
import random | |
import shutil | |
import stat | |
import sys | |
from contextlib import contextmanager | |
from tempfile import NamedTemporaryFile | |
# NOTE: retrying is not annotated in typeshed as on 2017-07-17, which is | |
# why we ignore the type on this import. | |
from pip._vendor.retrying import retry # type: ignore | |
from pip._vendor.six import PY2 | |
from pip._internal.utils.compat import get_path_uid | |
from pip._internal.utils.misc import format_size | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING, cast | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, BinaryIO, Iterator, List, Union | |
class NamedTemporaryFileResult(BinaryIO): | |
@property | |
def file(self): | |
# type: () -> BinaryIO | |
pass | |
def check_path_owner(path): | |
# type: (str) -> bool | |
# If we don't have a way to check the effective uid of this process, then | |
# we'll just assume that we own the directory. | |
if sys.platform == "win32" or not hasattr(os, "geteuid"): | |
return True | |
assert os.path.isabs(path) | |
previous = None | |
while path != previous: | |
if os.path.lexists(path): | |
# Check if path is writable by current user. | |
if os.geteuid() == 0: | |
# Special handling for root user in order to handle properly | |
# cases where users use sudo without -H flag. | |
try: | |
path_uid = get_path_uid(path) | |
except OSError: | |
return False | |
return path_uid == 0 | |
else: | |
return os.access(path, os.W_OK) | |
else: | |
previous, path = path, os.path.dirname(path) | |
return False # assume we don't own the path | |
def copy2_fixed(src, dest): | |
# type: (str, str) -> None | |
"""Wrap shutil.copy2() but map errors copying socket files to | |
SpecialFileError as expected. | |
See also https://bugs.python.org/issue37700. | |
""" | |
try: | |
shutil.copy2(src, dest) | |
except (OSError, IOError): | |
for f in [src, dest]: | |
try: | |
is_socket_file = is_socket(f) | |
except OSError: | |
# An error has already occurred. Another error here is not | |
# a problem and we can ignore it. | |
pass | |
else: | |
if is_socket_file: | |
raise shutil.SpecialFileError( | |
"`{f}` is a socket".format(**locals())) | |
raise | |
def is_socket(path): | |
# type: (str) -> bool | |
return stat.S_ISSOCK(os.lstat(path).st_mode) | |
@contextmanager | |
def adjacent_tmp_file(path, **kwargs): | |
# type: (str, **Any) -> Iterator[NamedTemporaryFileResult] | |
"""Return a file-like object pointing to a tmp file next to path. | |
The file is created securely and is ensured to be written to disk | |
after the context reaches its end. | |
kwargs will be passed to tempfile.NamedTemporaryFile to control | |
the way the temporary file will be opened. | |
""" | |
with NamedTemporaryFile( | |
delete=False, | |
dir=os.path.dirname(path), | |
prefix=os.path.basename(path), | |
suffix='.tmp', | |
**kwargs | |
) as f: | |
result = cast('NamedTemporaryFileResult', f) | |
try: | |
yield result | |
finally: | |
result.file.flush() | |
os.fsync(result.file.fileno()) | |
_replace_retry = retry(stop_max_delay=1000, wait_fixed=250) | |
if PY2: | |
@_replace_retry | |
def replace(src, dest): | |
# type: (str, str) -> None | |
try: | |
os.rename(src, dest) | |
except OSError: | |
os.remove(dest) | |
os.rename(src, dest) | |
else: | |
replace = _replace_retry(os.replace) | |
# test_writable_dir and _test_writable_dir_win are copied from Flit, | |
# with the author's agreement to also place them under pip's license. | |
def test_writable_dir(path): | |
# type: (str) -> bool | |
"""Check if a directory is writable. | |
Uses os.access() on POSIX, tries creating files on Windows. | |
""" | |
# If the directory doesn't exist, find the closest parent that does. | |
while not os.path.isdir(path): | |
parent = os.path.dirname(path) | |
if parent == path: | |
break # Should never get here, but infinite loops are bad | |
path = parent | |
if os.name == 'posix': | |
return os.access(path, os.W_OK) | |
return _test_writable_dir_win(path) | |
def _test_writable_dir_win(path): | |
# type: (str) -> bool | |
# os.access doesn't work on Windows: http://bugs.python.org/issue2528 | |
# and we can't use tempfile: http://bugs.python.org/issue22107 | |
basename = 'accesstest_deleteme_fishfingers_custard_' | |
alphabet = 'abcdefghijklmnopqrstuvwxyz0123456789' | |
for i in range(10): | |
name = basename + ''.join(random.choice(alphabet) for _ in range(6)) | |
file = os.path.join(path, name) | |
try: | |
fd = os.open(file, os.O_RDWR | os.O_CREAT | os.O_EXCL) | |
# Python 2 doesn't support FileExistsError and PermissionError. | |
except OSError as e: | |
# exception FileExistsError | |
if e.errno == errno.EEXIST: | |
continue | |
# exception PermissionError | |
if e.errno == errno.EPERM or e.errno == errno.EACCES: | |
# This could be because there's a directory with the same name. | |
# But it's highly unlikely there's a directory called that, | |
# so we'll assume it's because the parent dir is not writable. | |
return False | |
raise | |
else: | |
os.close(fd) | |
os.unlink(file) | |
return True | |
# This should never be reached | |
raise EnvironmentError( | |
'Unexpected condition testing for writable directory' | |
) | |
def find_files(path, pattern): | |
# type: (str, str) -> List[str] | |
"""Returns a list of absolute paths of files beneath path, recursively, | |
with filenames which match the UNIX-style shell glob pattern.""" | |
result = [] # type: List[str] | |
for root, dirs, files in os.walk(path): | |
matches = fnmatch.filter(files, pattern) | |
result.extend(os.path.join(root, f) for f in matches) | |
return result | |
def file_size(path): | |
# type: (str) -> Union[int, float] | |
# If it's a symlink, return 0. | |
if os.path.islink(path): | |
return 0 | |
return os.path.getsize(path) | |
def format_file_size(path): | |
# type: (str) -> str | |
return format_size(file_size(path)) | |
def directory_size(path): | |
# type: (str) -> Union[int, float] | |
size = 0.0 | |
for root, _dirs, files in os.walk(path): | |
for filename in files: | |
file_path = os.path.join(root, filename) | |
size += file_size(file_path) | |
return size | |
def format_directory_size(path): | |
# type: (str) -> str | |
return format_size(directory_size(path)) |
"""Filetype information. | |
""" | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Tuple | |
WHEEL_EXTENSION = '.whl' | |
BZ2_EXTENSIONS = ('.tar.bz2', '.tbz') # type: Tuple[str, ...] | |
XZ_EXTENSIONS = ('.tar.xz', '.txz', '.tlz', | |
'.tar.lz', '.tar.lzma') # type: Tuple[str, ...] | |
ZIP_EXTENSIONS = ('.zip', WHEEL_EXTENSION) # type: Tuple[str, ...] | |
TAR_EXTENSIONS = ('.tar.gz', '.tgz', '.tar') # type: Tuple[str, ...] | |
ARCHIVE_EXTENSIONS = ( | |
ZIP_EXTENSIONS + BZ2_EXTENSIONS + TAR_EXTENSIONS + XZ_EXTENSIONS | |
) |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import os | |
import sys | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Tuple | |
def glibc_version_string(): | |
# type: () -> Optional[str] | |
"Returns glibc version string, or None if not using glibc." | |
return glibc_version_string_confstr() or glibc_version_string_ctypes() | |
def glibc_version_string_confstr(): | |
# type: () -> Optional[str] | |
"Primary implementation of glibc_version_string using os.confstr." | |
# os.confstr is quite a bit faster than ctypes.DLL. It's also less likely | |
# to be broken or missing. This strategy is used in the standard library | |
# platform module: | |
# https://github.com/python/cpython/blob/fcf1d003bf4f0100c9d0921ff3d70e1127ca1b71/Lib/platform.py#L175-L183 | |
if sys.platform == "win32": | |
return None | |
try: | |
# os.confstr("CS_GNU_LIBC_VERSION") returns a string like "glibc 2.17": | |
_, version = os.confstr("CS_GNU_LIBC_VERSION").split() | |
except (AttributeError, OSError, ValueError): | |
# os.confstr() or CS_GNU_LIBC_VERSION not available (or a bad value)... | |
return None | |
return version | |
def glibc_version_string_ctypes(): | |
# type: () -> Optional[str] | |
"Fallback implementation of glibc_version_string using ctypes." | |
try: | |
import ctypes | |
except ImportError: | |
return None | |
# ctypes.CDLL(None) internally calls dlopen(NULL), and as the dlopen | |
# manpage says, "If filename is NULL, then the returned handle is for the | |
# main program". This way we can let the linker do the work to figure out | |
# which libc our process is actually using. | |
process_namespace = ctypes.CDLL(None) | |
try: | |
gnu_get_libc_version = process_namespace.gnu_get_libc_version | |
except AttributeError: | |
# Symbol doesn't exist -> therefore, we are not linked to | |
# glibc. | |
return None | |
# Call gnu_get_libc_version, which returns a string like "2.5" | |
gnu_get_libc_version.restype = ctypes.c_char_p | |
version_str = gnu_get_libc_version() | |
# py2 / py3 compatibility: | |
if not isinstance(version_str, str): | |
version_str = version_str.decode("ascii") | |
return version_str | |
# platform.libc_ver regularly returns completely nonsensical glibc | |
# versions. E.g. on my computer, platform says: | |
# | |
# ~$ python2.7 -c 'import platform; print(platform.libc_ver())' | |
# ('glibc', '2.7') | |
# ~$ python3.5 -c 'import platform; print(platform.libc_ver())' | |
# ('glibc', '2.9') | |
# | |
# But the truth is: | |
# | |
# ~$ ldd --version | |
# ldd (Debian GLIBC 2.22-11) 2.22 | |
# | |
# This is unfortunate, because it means that the linehaul data on libc | |
# versions that was generated by pip 8.1.2 and earlier is useless and | |
# misleading. Solution: instead of using platform, use our code that actually | |
# works. | |
def libc_ver(): | |
# type: () -> Tuple[str, str] | |
"""Try to determine the glibc version | |
Returns a tuple of strings (lib, version) which default to empty strings | |
in case the lookup fails. | |
""" | |
glibc_version = glibc_version_string() | |
if glibc_version is None: | |
return ("", "") | |
else: | |
return ("glibc", glibc_version) |
from __future__ import absolute_import | |
import hashlib | |
from pip._vendor.six import iteritems, iterkeys, itervalues | |
from pip._internal.exceptions import ( | |
HashMismatch, | |
HashMissing, | |
InstallationError, | |
) | |
from pip._internal.utils.misc import read_chunks | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Dict, List, BinaryIO, NoReturn, Iterator | |
) | |
from pip._vendor.six import PY3 | |
if PY3: | |
from hashlib import _Hash | |
else: | |
from hashlib import _hash as _Hash | |
# The recommended hash algo of the moment. Change this whenever the state of | |
# the art changes; it won't hurt backward compatibility. | |
FAVORITE_HASH = 'sha256' | |
# Names of hashlib algorithms allowed by the --hash option and ``pip hash`` | |
# Currently, those are the ones at least as collision-resistant as sha256. | |
STRONG_HASHES = ['sha256', 'sha384', 'sha512'] | |
class Hashes(object): | |
"""A wrapper that builds multiple hashes at once and checks them against | |
known-good values | |
""" | |
def __init__(self, hashes=None): | |
# type: (Dict[str, List[str]]) -> None | |
""" | |
:param hashes: A dict of algorithm names pointing to lists of allowed | |
hex digests | |
""" | |
self._allowed = {} if hashes is None else hashes | |
@property | |
def digest_count(self): | |
# type: () -> int | |
return sum(len(digests) for digests in self._allowed.values()) | |
def is_hash_allowed( | |
self, | |
hash_name, # type: str | |
hex_digest, # type: str | |
): | |
# type: (...) -> bool | |
"""Return whether the given hex digest is allowed.""" | |
return hex_digest in self._allowed.get(hash_name, []) | |
def check_against_chunks(self, chunks): | |
# type: (Iterator[bytes]) -> None | |
"""Check good hashes against ones built from iterable of chunks of | |
data. | |
Raise HashMismatch if none match. | |
""" | |
gots = {} | |
for hash_name in iterkeys(self._allowed): | |
try: | |
gots[hash_name] = hashlib.new(hash_name) | |
except (ValueError, TypeError): | |
raise InstallationError( | |
'Unknown hash name: {}'.format(hash_name) | |
) | |
for chunk in chunks: | |
for hash in itervalues(gots): | |
hash.update(chunk) | |
for hash_name, got in iteritems(gots): | |
if got.hexdigest() in self._allowed[hash_name]: | |
return | |
self._raise(gots) | |
def _raise(self, gots): | |
# type: (Dict[str, _Hash]) -> NoReturn | |
raise HashMismatch(self._allowed, gots) | |
def check_against_file(self, file): | |
# type: (BinaryIO) -> None | |
"""Check good hashes against a file-like object | |
Raise HashMismatch if none match. | |
""" | |
return self.check_against_chunks(read_chunks(file)) | |
def check_against_path(self, path): | |
# type: (str) -> None | |
with open(path, 'rb') as file: | |
return self.check_against_file(file) | |
def __nonzero__(self): | |
# type: () -> bool | |
"""Return whether I know any known-good hashes.""" | |
return bool(self._allowed) | |
def __bool__(self): | |
# type: () -> bool | |
return self.__nonzero__() | |
class MissingHashes(Hashes): | |
"""A workalike for Hashes used when we're missing a hash for a requirement | |
It computes the actual hash of the requirement and raises a HashMissing | |
exception showing it to the user. | |
""" | |
def __init__(self): | |
# type: () -> None | |
"""Don't offer the ``hashes`` kwarg.""" | |
# Pass our favorite hash in to generate a "gotten hash". With the | |
# empty list, it will never match, so an error will always raise. | |
super(MissingHashes, self).__init__(hashes={FAVORITE_HASH: []}) | |
def _raise(self, gots): | |
# type: (Dict[str, _Hash]) -> NoReturn | |
raise HashMissing(gots[FAVORITE_HASH].hexdigest()) |
"""A helper module that injects SecureTransport, on import. | |
The import should be done as early as possible, to ensure all requests and | |
sessions (or whatever) are created after injecting SecureTransport. | |
Note that we only do the injection on macOS, when the linked OpenSSL is too | |
old to handle TLSv1.2. | |
""" | |
import sys | |
def inject_securetransport(): | |
# type: () -> None | |
# Only relevant on macOS | |
if sys.platform != "darwin": | |
return | |
try: | |
import ssl | |
except ImportError: | |
return | |
# Checks for OpenSSL 1.0.1 | |
if ssl.OPENSSL_VERSION_NUMBER >= 0x1000100f: | |
return | |
try: | |
from pip._vendor.urllib3.contrib import securetransport | |
except (ImportError, OSError): | |
return | |
securetransport.inject_into_urllib3() | |
inject_securetransport() |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import contextlib | |
import errno | |
import logging | |
import logging.handlers | |
import os | |
import sys | |
from logging import Filter, getLogger | |
from pip._vendor.six import PY2 | |
from pip._internal.utils.compat import WINDOWS | |
from pip._internal.utils.deprecation import DEPRECATION_MSG_PREFIX | |
from pip._internal.utils.misc import ensure_dir | |
try: | |
import threading | |
except ImportError: | |
import dummy_threading as threading # type: ignore | |
try: | |
# Use "import as" and set colorama in the else clause to avoid mypy | |
# errors and get the following correct revealed type for colorama: | |
# `Union[_importlib_modulespec.ModuleType, None]` | |
# Otherwise, we get an error like the following in the except block: | |
# > Incompatible types in assignment (expression has type "None", | |
# variable has type Module) | |
# TODO: eliminate the need to use "import as" once mypy addresses some | |
# of its issues with conditional imports. Here is an umbrella issue: | |
# https://github.com/python/mypy/issues/1297 | |
from pip._vendor import colorama as _colorama | |
# Lots of different errors can come from this, including SystemError and | |
# ImportError. | |
except Exception: | |
colorama = None | |
else: | |
# Import Fore explicitly rather than accessing below as colorama.Fore | |
# to avoid the following error running mypy: | |
# > Module has no attribute "Fore" | |
# TODO: eliminate the need to import Fore once mypy addresses some of its | |
# issues with conditional imports. This particular case could be an | |
# instance of the following issue (but also see the umbrella issue above): | |
# https://github.com/python/mypy/issues/3500 | |
from pip._vendor.colorama import Fore | |
colorama = _colorama | |
_log_state = threading.local() | |
subprocess_logger = getLogger('pip.subprocessor') | |
class BrokenStdoutLoggingError(Exception): | |
""" | |
Raised if BrokenPipeError occurs for the stdout stream while logging. | |
""" | |
pass | |
# BrokenPipeError does not exist in Python 2 and, in addition, manifests | |
# differently in Windows and non-Windows. | |
if WINDOWS: | |
# In Windows, a broken pipe can show up as EINVAL rather than EPIPE: | |
# https://bugs.python.org/issue19612 | |
# https://bugs.python.org/issue30418 | |
if PY2: | |
def _is_broken_pipe_error(exc_class, exc): | |
"""See the docstring for non-Windows Python 3 below.""" | |
return (exc_class is IOError and | |
exc.errno in (errno.EINVAL, errno.EPIPE)) | |
else: | |
# In Windows, a broken pipe IOError became OSError in Python 3. | |
def _is_broken_pipe_error(exc_class, exc): | |
"""See the docstring for non-Windows Python 3 below.""" | |
return ((exc_class is BrokenPipeError) or # noqa: F821 | |
(exc_class is OSError and | |
exc.errno in (errno.EINVAL, errno.EPIPE))) | |
elif PY2: | |
def _is_broken_pipe_error(exc_class, exc): | |
"""See the docstring for non-Windows Python 3 below.""" | |
return (exc_class is IOError and exc.errno == errno.EPIPE) | |
else: | |
# Then we are in the non-Windows Python 3 case. | |
def _is_broken_pipe_error(exc_class, exc): | |
""" | |
Return whether an exception is a broken pipe error. | |
Args: | |
exc_class: an exception class. | |
exc: an exception instance. | |
""" | |
return (exc_class is BrokenPipeError) # noqa: F821 | |
@contextlib.contextmanager | |
def indent_log(num=2): | |
""" | |
A context manager which will cause the log output to be indented for any | |
log messages emitted inside it. | |
""" | |
# For thread-safety | |
_log_state.indentation = get_indentation() | |
_log_state.indentation += num | |
try: | |
yield | |
finally: | |
_log_state.indentation -= num | |
def get_indentation(): | |
return getattr(_log_state, 'indentation', 0) | |
class IndentingFormatter(logging.Formatter): | |
def __init__(self, *args, **kwargs): | |
""" | |
A logging.Formatter that obeys the indent_log() context manager. | |
:param add_timestamp: A bool indicating output lines should be prefixed | |
with their record's timestamp. | |
""" | |
self.add_timestamp = kwargs.pop("add_timestamp", False) | |
super(IndentingFormatter, self).__init__(*args, **kwargs) | |
def get_message_start(self, formatted, levelno): | |
""" | |
Return the start of the formatted log message (not counting the | |
prefix to add to each line). | |
""" | |
if levelno < logging.WARNING: | |
return '' | |
if formatted.startswith(DEPRECATION_MSG_PREFIX): | |
# Then the message already has a prefix. We don't want it to | |
# look like "WARNING: DEPRECATION: ...." | |
return '' | |
if levelno < logging.ERROR: | |
return 'WARNING: ' | |
return 'ERROR: ' | |
def format(self, record): | |
""" | |
Calls the standard formatter, but will indent all of the log message | |
lines by our current indentation level. | |
""" | |
formatted = super(IndentingFormatter, self).format(record) | |
message_start = self.get_message_start(formatted, record.levelno) | |
formatted = message_start + formatted | |
prefix = '' | |
if self.add_timestamp: | |
# TODO: Use Formatter.default_time_format after dropping PY2. | |
t = self.formatTime(record, "%Y-%m-%dT%H:%M:%S") | |
prefix = '{t},{record.msecs:03.0f} '.format(**locals()) | |
prefix += " " * get_indentation() | |
formatted = "".join([ | |
prefix + line | |
for line in formatted.splitlines(True) | |
]) | |
return formatted | |
def _color_wrap(*colors): | |
def wrapped(inp): | |
return "".join(list(colors) + [inp, colorama.Style.RESET_ALL]) | |
return wrapped | |
class ColorizedStreamHandler(logging.StreamHandler): | |
# Don't build up a list of colors if we don't have colorama | |
if colorama: | |
COLORS = [ | |
# This needs to be in order from highest logging level to lowest. | |
(logging.ERROR, _color_wrap(Fore.RED)), | |
(logging.WARNING, _color_wrap(Fore.YELLOW)), | |
] | |
else: | |
COLORS = [] | |
def __init__(self, stream=None, no_color=None): | |
logging.StreamHandler.__init__(self, stream) | |
self._no_color = no_color | |
if WINDOWS and colorama: | |
self.stream = colorama.AnsiToWin32(self.stream) | |
def _using_stdout(self): | |
""" | |
Return whether the handler is using sys.stdout. | |
""" | |
if WINDOWS and colorama: | |
# Then self.stream is an AnsiToWin32 object. | |
return self.stream.wrapped is sys.stdout | |
return self.stream is sys.stdout | |
def should_color(self): | |
# Don't colorize things if we do not have colorama or if told not to | |
if not colorama or self._no_color: | |
return False | |
real_stream = ( | |
self.stream if not isinstance(self.stream, colorama.AnsiToWin32) | |
else self.stream.wrapped | |
) | |
# If the stream is a tty we should color it | |
if hasattr(real_stream, "isatty") and real_stream.isatty(): | |
return True | |
# If we have an ANSI term we should color it | |
if os.environ.get("TERM") == "ANSI": | |
return True | |
# If anything else we should not color it | |
return False | |
def format(self, record): | |
msg = logging.StreamHandler.format(self, record) | |
if self.should_color(): | |
for level, color in self.COLORS: | |
if record.levelno >= level: | |
msg = color(msg) | |
break | |
return msg | |
# The logging module says handleError() can be customized. | |
def handleError(self, record): | |
exc_class, exc = sys.exc_info()[:2] | |
# If a broken pipe occurred while calling write() or flush() on the | |
# stdout stream in logging's Handler.emit(), then raise our special | |
# exception so we can handle it in main() instead of logging the | |
# broken pipe error and continuing. | |
if (exc_class and self._using_stdout() and | |
_is_broken_pipe_error(exc_class, exc)): | |
raise BrokenStdoutLoggingError() | |
return super(ColorizedStreamHandler, self).handleError(record) | |
class BetterRotatingFileHandler(logging.handlers.RotatingFileHandler): | |
def _open(self): | |
ensure_dir(os.path.dirname(self.baseFilename)) | |
return logging.handlers.RotatingFileHandler._open(self) | |
class MaxLevelFilter(Filter): | |
def __init__(self, level): | |
self.level = level | |
def filter(self, record): | |
return record.levelno < self.level | |
class ExcludeLoggerFilter(Filter): | |
""" | |
A logging Filter that excludes records from a logger (or its children). | |
""" | |
def filter(self, record): | |
# The base Filter class allows only records from a logger (or its | |
# children). | |
return not super(ExcludeLoggerFilter, self).filter(record) | |
def setup_logging(verbosity, no_color, user_log_file): | |
"""Configures and sets up all of the logging | |
Returns the requested logging level, as its integer value. | |
""" | |
# Determine the level to be logging at. | |
if verbosity >= 1: | |
level = "DEBUG" | |
elif verbosity == -1: | |
level = "WARNING" | |
elif verbosity == -2: | |
level = "ERROR" | |
elif verbosity <= -3: | |
level = "CRITICAL" | |
else: | |
level = "INFO" | |
level_number = getattr(logging, level) | |
# The "root" logger should match the "console" level *unless* we also need | |
# to log to a user log file. | |
include_user_log = user_log_file is not None | |
if include_user_log: | |
additional_log_file = user_log_file | |
root_level = "DEBUG" | |
else: | |
additional_log_file = "/dev/null" | |
root_level = level | |
# Disable any logging besides WARNING unless we have DEBUG level logging | |
# enabled for vendored libraries. | |
vendored_log_level = "WARNING" if level in ["INFO", "ERROR"] else "DEBUG" | |
# Shorthands for clarity | |
log_streams = { | |
"stdout": "ext://sys.stdout", | |
"stderr": "ext://sys.stderr", | |
} | |
handler_classes = { | |
"stream": "pip._internal.utils.logging.ColorizedStreamHandler", | |
"file": "pip._internal.utils.logging.BetterRotatingFileHandler", | |
} | |
handlers = ["console", "console_errors", "console_subprocess"] + ( | |
["user_log"] if include_user_log else [] | |
) | |
logging.config.dictConfig({ | |
"version": 1, | |
"disable_existing_loggers": False, | |
"filters": { | |
"exclude_warnings": { | |
"()": "pip._internal.utils.logging.MaxLevelFilter", | |
"level": logging.WARNING, | |
}, | |
"restrict_to_subprocess": { | |
"()": "logging.Filter", | |
"name": subprocess_logger.name, | |
}, | |
"exclude_subprocess": { | |
"()": "pip._internal.utils.logging.ExcludeLoggerFilter", | |
"name": subprocess_logger.name, | |
}, | |
}, | |
"formatters": { | |
"indent": { | |
"()": IndentingFormatter, | |
"format": "%(message)s", | |
}, | |
"indent_with_timestamp": { | |
"()": IndentingFormatter, | |
"format": "%(message)s", | |
"add_timestamp": True, | |
}, | |
}, | |
"handlers": { | |
"console": { | |
"level": level, | |
"class": handler_classes["stream"], | |
"no_color": no_color, | |
"stream": log_streams["stdout"], | |
"filters": ["exclude_subprocess", "exclude_warnings"], | |
"formatter": "indent", | |
}, | |
"console_errors": { | |
"level": "WARNING", | |
"class": handler_classes["stream"], | |
"no_color": no_color, | |
"stream": log_streams["stderr"], | |
"filters": ["exclude_subprocess"], | |
"formatter": "indent", | |
}, | |
# A handler responsible for logging to the console messages | |
# from the "subprocessor" logger. | |
"console_subprocess": { | |
"level": level, | |
"class": handler_classes["stream"], | |
"no_color": no_color, | |
"stream": log_streams["stderr"], | |
"filters": ["restrict_to_subprocess"], | |
"formatter": "indent", | |
}, | |
"user_log": { | |
"level": "DEBUG", | |
"class": handler_classes["file"], | |
"filename": additional_log_file, | |
"delay": True, | |
"formatter": "indent_with_timestamp", | |
}, | |
}, | |
"root": { | |
"level": root_level, | |
"handlers": handlers, | |
}, | |
"loggers": { | |
"pip._vendor": { | |
"level": vendored_log_level | |
} | |
}, | |
}) | |
return level_number |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import contextlib | |
import errno | |
import getpass | |
import hashlib | |
import io | |
import logging | |
import os | |
import posixpath | |
import shutil | |
import stat | |
import sys | |
from collections import deque | |
from pip._vendor import pkg_resources | |
# NOTE: retrying is not annotated in typeshed as on 2017-07-17, which is | |
# why we ignore the type on this import. | |
from pip._vendor.retrying import retry # type: ignore | |
from pip._vendor.six import PY2, text_type | |
from pip._vendor.six.moves import input, map, zip_longest | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._vendor.six.moves.urllib.parse import unquote as urllib_unquote | |
from pip import __version__ | |
from pip._internal.exceptions import CommandError | |
from pip._internal.locations import ( | |
get_major_minor_version, | |
site_packages, | |
user_site, | |
) | |
from pip._internal.utils.compat import ( | |
WINDOWS, | |
expanduser, | |
stdlib_pkgs, | |
str_to_display, | |
) | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING, cast | |
from pip._internal.utils.virtualenv import ( | |
running_under_virtualenv, | |
virtualenv_no_global, | |
) | |
if PY2: | |
from io import BytesIO as StringIO | |
else: | |
from io import StringIO | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, AnyStr, Container, Iterable, Iterator, List, Optional, Text, | |
Tuple, Union, | |
) | |
from pip._vendor.pkg_resources import Distribution | |
VersionInfo = Tuple[int, int, int] | |
__all__ = ['rmtree', 'display_path', 'backup_dir', | |
'ask', 'splitext', | |
'format_size', 'is_installable_dir', | |
'normalize_path', | |
'renames', 'get_prog', | |
'captured_stdout', 'ensure_dir', | |
'get_installed_version', 'remove_auth_from_url'] | |
logger = logging.getLogger(__name__) | |
def get_pip_version(): | |
# type: () -> str | |
pip_pkg_dir = os.path.join(os.path.dirname(__file__), "..", "..") | |
pip_pkg_dir = os.path.abspath(pip_pkg_dir) | |
return ( | |
'pip {} from {} (python {})'.format( | |
__version__, pip_pkg_dir, get_major_minor_version(), | |
) | |
) | |
def normalize_version_info(py_version_info): | |
# type: (Tuple[int, ...]) -> Tuple[int, int, int] | |
""" | |
Convert a tuple of ints representing a Python version to one of length | |
three. | |
:param py_version_info: a tuple of ints representing a Python version, | |
or None to specify no version. The tuple can have any length. | |
:return: a tuple of length three if `py_version_info` is non-None. | |
Otherwise, return `py_version_info` unchanged (i.e. None). | |
""" | |
if len(py_version_info) < 3: | |
py_version_info += (3 - len(py_version_info)) * (0,) | |
elif len(py_version_info) > 3: | |
py_version_info = py_version_info[:3] | |
return cast('VersionInfo', py_version_info) | |
def ensure_dir(path): | |
# type: (AnyStr) -> None | |
"""os.path.makedirs without EEXIST.""" | |
try: | |
os.makedirs(path) | |
except OSError as e: | |
# Windows can raise spurious ENOTEMPTY errors. See #6426. | |
if e.errno != errno.EEXIST and e.errno != errno.ENOTEMPTY: | |
raise | |
def get_prog(): | |
# type: () -> str | |
try: | |
prog = os.path.basename(sys.argv[0]) | |
if prog in ('__main__.py', '-c'): | |
return "{} -m pip".format(sys.executable) | |
else: | |
return prog | |
except (AttributeError, TypeError, IndexError): | |
pass | |
return 'pip' | |
# Retry every half second for up to 3 seconds | |
@retry(stop_max_delay=3000, wait_fixed=500) | |
def rmtree(dir, ignore_errors=False): | |
# type: (str, bool) -> None | |
shutil.rmtree(dir, ignore_errors=ignore_errors, | |
onerror=rmtree_errorhandler) | |
def rmtree_errorhandler(func, path, exc_info): | |
"""On Windows, the files in .svn are read-only, so when rmtree() tries to | |
remove them, an exception is thrown. We catch that here, remove the | |
read-only attribute, and hopefully continue without problems.""" | |
try: | |
has_attr_readonly = not (os.stat(path).st_mode & stat.S_IWRITE) | |
except (IOError, OSError): | |
# it's equivalent to os.path.exists | |
return | |
if has_attr_readonly: | |
# convert to read/write | |
os.chmod(path, stat.S_IWRITE) | |
# use the original function to repeat the operation | |
func(path) | |
return | |
else: | |
raise | |
def path_to_display(path): | |
# type: (Optional[Union[str, Text]]) -> Optional[Text] | |
""" | |
Convert a bytes (or text) path to text (unicode in Python 2) for display | |
and logging purposes. | |
This function should never error out. Also, this function is mainly needed | |
for Python 2 since in Python 3 str paths are already text. | |
""" | |
if path is None: | |
return None | |
if isinstance(path, text_type): | |
return path | |
# Otherwise, path is a bytes object (str in Python 2). | |
try: | |
display_path = path.decode(sys.getfilesystemencoding(), 'strict') | |
except UnicodeDecodeError: | |
# Include the full bytes to make troubleshooting easier, even though | |
# it may not be very human readable. | |
if PY2: | |
# Convert the bytes to a readable str representation using | |
# repr(), and then convert the str to unicode. | |
# Also, we add the prefix "b" to the repr() return value both | |
# to make the Python 2 output look like the Python 3 output, and | |
# to signal to the user that this is a bytes representation. | |
display_path = str_to_display('b{!r}'.format(path)) | |
else: | |
# Silence the "F821 undefined name 'ascii'" flake8 error since | |
# in Python 3 ascii() is a built-in. | |
display_path = ascii(path) # noqa: F821 | |
return display_path | |
def display_path(path): | |
# type: (Union[str, Text]) -> str | |
"""Gives the display value for a given path, making it relative to cwd | |
if possible.""" | |
path = os.path.normcase(os.path.abspath(path)) | |
if sys.version_info[0] == 2: | |
path = path.decode(sys.getfilesystemencoding(), 'replace') | |
path = path.encode(sys.getdefaultencoding(), 'replace') | |
if path.startswith(os.getcwd() + os.path.sep): | |
path = '.' + path[len(os.getcwd()):] | |
return path | |
def backup_dir(dir, ext='.bak'): | |
# type: (str, str) -> str | |
"""Figure out the name of a directory to back up the given dir to | |
(adding .bak, .bak2, etc)""" | |
n = 1 | |
extension = ext | |
while os.path.exists(dir + extension): | |
n += 1 | |
extension = ext + str(n) | |
return dir + extension | |
def ask_path_exists(message, options): | |
# type: (str, Iterable[str]) -> str | |
for action in os.environ.get('PIP_EXISTS_ACTION', '').split(): | |
if action in options: | |
return action | |
return ask(message, options) | |
def _check_no_input(message): | |
# type: (str) -> None | |
"""Raise an error if no input is allowed.""" | |
if os.environ.get('PIP_NO_INPUT'): | |
raise Exception( | |
'No input was expected ($PIP_NO_INPUT set); question: {}'.format( | |
message) | |
) | |
def ask(message, options): | |
# type: (str, Iterable[str]) -> str | |
"""Ask the message interactively, with the given possible responses""" | |
while 1: | |
_check_no_input(message) | |
response = input(message) | |
response = response.strip().lower() | |
if response not in options: | |
print( | |
'Your response ({!r}) was not one of the expected responses: ' | |
'{}'.format(response, ', '.join(options)) | |
) | |
else: | |
return response | |
def ask_input(message): | |
# type: (str) -> str | |
"""Ask for input interactively.""" | |
_check_no_input(message) | |
return input(message) | |
def ask_password(message): | |
# type: (str) -> str | |
"""Ask for a password interactively.""" | |
_check_no_input(message) | |
return getpass.getpass(message) | |
def format_size(bytes): | |
# type: (float) -> str | |
if bytes > 1000 * 1000: | |
return '{:.1f} MB'.format(bytes / 1000.0 / 1000) | |
elif bytes > 10 * 1000: | |
return '{} kB'.format(int(bytes / 1000)) | |
elif bytes > 1000: | |
return '{:.1f} kB'.format(bytes / 1000.0) | |
else: | |
return '{} bytes'.format(int(bytes)) | |
def tabulate(rows): | |
# type: (Iterable[Iterable[Any]]) -> Tuple[List[str], List[int]] | |
"""Return a list of formatted rows and a list of column sizes. | |
For example:: | |
>>> tabulate([['foobar', 2000], [0xdeadbeef]]) | |
(['foobar 2000', '3735928559'], [10, 4]) | |
""" | |
rows = [tuple(map(str, row)) for row in rows] | |
sizes = [max(map(len, col)) for col in zip_longest(*rows, fillvalue='')] | |
table = [" ".join(map(str.ljust, row, sizes)).rstrip() for row in rows] | |
return table, sizes | |
def is_installable_dir(path): | |
# type: (str) -> bool | |
"""Is path is a directory containing setup.py or pyproject.toml? | |
""" | |
if not os.path.isdir(path): | |
return False | |
setup_py = os.path.join(path, 'setup.py') | |
if os.path.isfile(setup_py): | |
return True | |
pyproject_toml = os.path.join(path, 'pyproject.toml') | |
if os.path.isfile(pyproject_toml): | |
return True | |
return False | |
def read_chunks(file, size=io.DEFAULT_BUFFER_SIZE): | |
"""Yield pieces of data from a file-like object until EOF.""" | |
while True: | |
chunk = file.read(size) | |
if not chunk: | |
break | |
yield chunk | |
def normalize_path(path, resolve_symlinks=True): | |
# type: (str, bool) -> str | |
""" | |
Convert a path to its canonical, case-normalized, absolute version. | |
""" | |
path = expanduser(path) | |
if resolve_symlinks: | |
path = os.path.realpath(path) | |
else: | |
path = os.path.abspath(path) | |
return os.path.normcase(path) | |
def splitext(path): | |
# type: (str) -> Tuple[str, str] | |
"""Like os.path.splitext, but take off .tar too""" | |
base, ext = posixpath.splitext(path) | |
if base.lower().endswith('.tar'): | |
ext = base[-4:] + ext | |
base = base[:-4] | |
return base, ext | |
def renames(old, new): | |
# type: (str, str) -> None | |
"""Like os.renames(), but handles renaming across devices.""" | |
# Implementation borrowed from os.renames(). | |
head, tail = os.path.split(new) | |
if head and tail and not os.path.exists(head): | |
os.makedirs(head) | |
shutil.move(old, new) | |
head, tail = os.path.split(old) | |
if head and tail: | |
try: | |
os.removedirs(head) | |
except OSError: | |
pass | |
def is_local(path): | |
# type: (str) -> bool | |
""" | |
Return True if path is within sys.prefix, if we're running in a virtualenv. | |
If we're not in a virtualenv, all paths are considered "local." | |
Caution: this function assumes the head of path has been normalized | |
with normalize_path. | |
""" | |
if not running_under_virtualenv(): | |
return True | |
return path.startswith(normalize_path(sys.prefix)) | |
def dist_is_local(dist): | |
# type: (Distribution) -> bool | |
""" | |
Return True if given Distribution object is installed locally | |
(i.e. within current virtualenv). | |
Always True if we're not in a virtualenv. | |
""" | |
return is_local(dist_location(dist)) | |
def dist_in_usersite(dist): | |
# type: (Distribution) -> bool | |
""" | |
Return True if given Distribution is installed in user site. | |
""" | |
return dist_location(dist).startswith(normalize_path(user_site)) | |
def dist_in_site_packages(dist): | |
# type: (Distribution) -> bool | |
""" | |
Return True if given Distribution is installed in | |
sysconfig.get_python_lib(). | |
""" | |
return dist_location(dist).startswith(normalize_path(site_packages)) | |
def dist_is_editable(dist): | |
# type: (Distribution) -> bool | |
""" | |
Return True if given Distribution is an editable install. | |
""" | |
for path_item in sys.path: | |
egg_link = os.path.join(path_item, dist.project_name + '.egg-link') | |
if os.path.isfile(egg_link): | |
return True | |
return False | |
def get_installed_distributions( | |
local_only=True, # type: bool | |
skip=stdlib_pkgs, # type: Container[str] | |
include_editables=True, # type: bool | |
editables_only=False, # type: bool | |
user_only=False, # type: bool | |
paths=None # type: Optional[List[str]] | |
): | |
# type: (...) -> List[Distribution] | |
""" | |
Return a list of installed Distribution objects. | |
If ``local_only`` is True (default), only return installations | |
local to the current virtualenv, if in a virtualenv. | |
``skip`` argument is an iterable of lower-case project names to | |
ignore; defaults to stdlib_pkgs | |
If ``include_editables`` is False, don't report editables. | |
If ``editables_only`` is True , only report editables. | |
If ``user_only`` is True , only report installations in the user | |
site directory. | |
If ``paths`` is set, only report the distributions present at the | |
specified list of locations. | |
""" | |
if paths: | |
working_set = pkg_resources.WorkingSet(paths) | |
else: | |
working_set = pkg_resources.working_set | |
if local_only: | |
local_test = dist_is_local | |
else: | |
def local_test(d): | |
return True | |
if include_editables: | |
def editable_test(d): | |
return True | |
else: | |
def editable_test(d): | |
return not dist_is_editable(d) | |
if editables_only: | |
def editables_only_test(d): | |
return dist_is_editable(d) | |
else: | |
def editables_only_test(d): | |
return True | |
if user_only: | |
user_test = dist_in_usersite | |
else: | |
def user_test(d): | |
return True | |
return [d for d in working_set | |
if local_test(d) and | |
d.key not in skip and | |
editable_test(d) and | |
editables_only_test(d) and | |
user_test(d) | |
] | |
def egg_link_path(dist): | |
# type: (Distribution) -> Optional[str] | |
""" | |
Return the path for the .egg-link file if it exists, otherwise, None. | |
There's 3 scenarios: | |
1) not in a virtualenv | |
try to find in site.USER_SITE, then site_packages | |
2) in a no-global virtualenv | |
try to find in site_packages | |
3) in a yes-global virtualenv | |
try to find in site_packages, then site.USER_SITE | |
(don't look in global location) | |
For #1 and #3, there could be odd cases, where there's an egg-link in 2 | |
locations. | |
This method will just return the first one found. | |
""" | |
sites = [] | |
if running_under_virtualenv(): | |
sites.append(site_packages) | |
if not virtualenv_no_global() and user_site: | |
sites.append(user_site) | |
else: | |
if user_site: | |
sites.append(user_site) | |
sites.append(site_packages) | |
for site in sites: | |
egglink = os.path.join(site, dist.project_name) + '.egg-link' | |
if os.path.isfile(egglink): | |
return egglink | |
return None | |
def dist_location(dist): | |
# type: (Distribution) -> str | |
""" | |
Get the site-packages location of this distribution. Generally | |
this is dist.location, except in the case of develop-installed | |
packages, where dist.location is the source code location, and we | |
want to know where the egg-link file is. | |
The returned location is normalized (in particular, with symlinks removed). | |
""" | |
egg_link = egg_link_path(dist) | |
if egg_link: | |
return normalize_path(egg_link) | |
return normalize_path(dist.location) | |
def write_output(msg, *args): | |
# type: (str, str) -> None | |
logger.info(msg, *args) | |
class FakeFile(object): | |
"""Wrap a list of lines in an object with readline() to make | |
ConfigParser happy.""" | |
def __init__(self, lines): | |
self._gen = (l for l in lines) | |
def readline(self): | |
try: | |
try: | |
return next(self._gen) | |
except NameError: | |
return self._gen.next() | |
except StopIteration: | |
return '' | |
def __iter__(self): | |
return self._gen | |
class StreamWrapper(StringIO): | |
@classmethod | |
def from_stream(cls, orig_stream): | |
cls.orig_stream = orig_stream | |
return cls() | |
# compileall.compile_dir() needs stdout.encoding to print to stdout | |
@property | |
def encoding(self): | |
return self.orig_stream.encoding | |
@contextlib.contextmanager | |
def captured_output(stream_name): | |
"""Return a context manager used by captured_stdout/stdin/stderr | |
that temporarily replaces the sys stream *stream_name* with a StringIO. | |
Taken from Lib/support/__init__.py in the CPython repo. | |
""" | |
orig_stdout = getattr(sys, stream_name) | |
setattr(sys, stream_name, StreamWrapper.from_stream(orig_stdout)) | |
try: | |
yield getattr(sys, stream_name) | |
finally: | |
setattr(sys, stream_name, orig_stdout) | |
def captured_stdout(): | |
"""Capture the output of sys.stdout: | |
with captured_stdout() as stdout: | |
print('hello') | |
self.assertEqual(stdout.getvalue(), 'hello\n') | |
Taken from Lib/support/__init__.py in the CPython repo. | |
""" | |
return captured_output('stdout') | |
def captured_stderr(): | |
""" | |
See captured_stdout(). | |
""" | |
return captured_output('stderr') | |
class cached_property(object): | |
"""A property that is only computed once per instance and then replaces | |
itself with an ordinary attribute. Deleting the attribute resets the | |
property. | |
Source: https://github.com/bottlepy/bottle/blob/0.11.5/bottle.py#L175 | |
""" | |
def __init__(self, func): | |
self.__doc__ = getattr(func, '__doc__') | |
self.func = func | |
def __get__(self, obj, cls): | |
if obj is None: | |
# We're being accessed from the class itself, not from an object | |
return self | |
value = obj.__dict__[self.func.__name__] = self.func(obj) | |
return value | |
def get_installed_version(dist_name, working_set=None): | |
"""Get the installed version of dist_name avoiding pkg_resources cache""" | |
# Create a requirement that we'll look for inside of setuptools. | |
req = pkg_resources.Requirement.parse(dist_name) | |
if working_set is None: | |
# We want to avoid having this cached, so we need to construct a new | |
# working set each time. | |
working_set = pkg_resources.WorkingSet() | |
# Get the installed distribution from our working set | |
dist = working_set.find(req) | |
# Check to see if we got an installed distribution or not, if we did | |
# we want to return it's version. | |
return dist.version if dist else None | |
def consume(iterator): | |
"""Consume an iterable at C speed.""" | |
deque(iterator, maxlen=0) | |
# Simulates an enum | |
def enum(*sequential, **named): | |
enums = dict(zip(sequential, range(len(sequential))), **named) | |
reverse = {value: key for key, value in enums.items()} | |
enums['reverse_mapping'] = reverse | |
return type('Enum', (), enums) | |
def build_netloc(host, port): | |
# type: (str, Optional[int]) -> str | |
""" | |
Build a netloc from a host-port pair | |
""" | |
if port is None: | |
return host | |
if ':' in host: | |
# Only wrap host with square brackets when it is IPv6 | |
host = '[{}]'.format(host) | |
return '{}:{}'.format(host, port) | |
def build_url_from_netloc(netloc, scheme='https'): | |
# type: (str, str) -> str | |
""" | |
Build a full URL from a netloc. | |
""" | |
if netloc.count(':') >= 2 and '@' not in netloc and '[' not in netloc: | |
# It must be a bare IPv6 address, so wrap it with brackets. | |
netloc = '[{}]'.format(netloc) | |
return '{}://{}'.format(scheme, netloc) | |
def parse_netloc(netloc): | |
# type: (str) -> Tuple[str, Optional[int]] | |
""" | |
Return the host-port pair from a netloc. | |
""" | |
url = build_url_from_netloc(netloc) | |
parsed = urllib_parse.urlparse(url) | |
return parsed.hostname, parsed.port | |
def split_auth_from_netloc(netloc): | |
""" | |
Parse out and remove the auth information from a netloc. | |
Returns: (netloc, (username, password)). | |
""" | |
if '@' not in netloc: | |
return netloc, (None, None) | |
# Split from the right because that's how urllib.parse.urlsplit() | |
# behaves if more than one @ is present (which can be checked using | |
# the password attribute of urlsplit()'s return value). | |
auth, netloc = netloc.rsplit('@', 1) | |
if ':' in auth: | |
# Split from the left because that's how urllib.parse.urlsplit() | |
# behaves if more than one : is present (which again can be checked | |
# using the password attribute of the return value) | |
user_pass = auth.split(':', 1) | |
else: | |
user_pass = auth, None | |
user_pass = tuple( | |
None if x is None else urllib_unquote(x) for x in user_pass | |
) | |
return netloc, user_pass | |
def redact_netloc(netloc): | |
# type: (str) -> str | |
""" | |
Replace the sensitive data in a netloc with "****", if it exists. | |
For example: | |
- "user:pass@example.com" returns "user:****@example.com" | |
- "accesstoken@example.com" returns "****@example.com" | |
""" | |
netloc, (user, password) = split_auth_from_netloc(netloc) | |
if user is None: | |
return netloc | |
if password is None: | |
user = '****' | |
password = '' | |
else: | |
user = urllib_parse.quote(user) | |
password = ':****' | |
return '{user}{password}@{netloc}'.format(user=user, | |
password=password, | |
netloc=netloc) | |
def _transform_url(url, transform_netloc): | |
"""Transform and replace netloc in a url. | |
transform_netloc is a function taking the netloc and returning a | |
tuple. The first element of this tuple is the new netloc. The | |
entire tuple is returned. | |
Returns a tuple containing the transformed url as item 0 and the | |
original tuple returned by transform_netloc as item 1. | |
""" | |
purl = urllib_parse.urlsplit(url) | |
netloc_tuple = transform_netloc(purl.netloc) | |
# stripped url | |
url_pieces = ( | |
purl.scheme, netloc_tuple[0], purl.path, purl.query, purl.fragment | |
) | |
surl = urllib_parse.urlunsplit(url_pieces) | |
return surl, netloc_tuple | |
def _get_netloc(netloc): | |
return split_auth_from_netloc(netloc) | |
def _redact_netloc(netloc): | |
return (redact_netloc(netloc),) | |
def split_auth_netloc_from_url(url): | |
# type: (str) -> Tuple[str, str, Tuple[str, str]] | |
""" | |
Parse a url into separate netloc, auth, and url with no auth. | |
Returns: (url_without_auth, netloc, (username, password)) | |
""" | |
url_without_auth, (netloc, auth) = _transform_url(url, _get_netloc) | |
return url_without_auth, netloc, auth | |
def remove_auth_from_url(url): | |
# type: (str) -> str | |
"""Return a copy of url with 'username:password@' removed.""" | |
# username/pass params are passed to subversion through flags | |
# and are not recognized in the url. | |
return _transform_url(url, _get_netloc)[0] | |
def redact_auth_from_url(url): | |
# type: (str) -> str | |
"""Replace the password in a given url with ****.""" | |
return _transform_url(url, _redact_netloc)[0] | |
class HiddenText(object): | |
def __init__( | |
self, | |
secret, # type: str | |
redacted, # type: str | |
): | |
# type: (...) -> None | |
self.secret = secret | |
self.redacted = redacted | |
def __repr__(self): | |
# type: (...) -> str | |
return '<HiddenText {!r}>'.format(str(self)) | |
def __str__(self): | |
# type: (...) -> str | |
return self.redacted | |
# This is useful for testing. | |
def __eq__(self, other): | |
# type: (Any) -> bool | |
if type(self) != type(other): | |
return False | |
# The string being used for redaction doesn't also have to match, | |
# just the raw, original string. | |
return (self.secret == other.secret) | |
# We need to provide an explicit __ne__ implementation for Python 2. | |
# TODO: remove this when we drop PY2 support. | |
def __ne__(self, other): | |
# type: (Any) -> bool | |
return not self == other | |
def hide_value(value): | |
# type: (str) -> HiddenText | |
return HiddenText(value, redacted='****') | |
def hide_url(url): | |
# type: (str) -> HiddenText | |
redacted = redact_auth_from_url(url) | |
return HiddenText(url, redacted=redacted) | |
def protect_pip_from_modification_on_windows(modifying_pip): | |
# type: (bool) -> None | |
"""Protection of pip.exe from modification on Windows | |
On Windows, any operation modifying pip should be run as: | |
python -m pip ... | |
""" | |
pip_names = [ | |
"pip.exe", | |
"pip{}.exe".format(sys.version_info[0]), | |
"pip{}.{}.exe".format(*sys.version_info[:2]) | |
] | |
# See https://github.com/pypa/pip/issues/1299 for more discussion | |
should_show_use_python_msg = ( | |
modifying_pip and | |
WINDOWS and | |
os.path.basename(sys.argv[0]) in pip_names | |
) | |
if should_show_use_python_msg: | |
new_command = [ | |
sys.executable, "-m", "pip" | |
] + sys.argv[1:] | |
raise CommandError( | |
'To modify pip, please run the following command:\n{}' | |
.format(" ".join(new_command)) | |
) | |
def is_console_interactive(): | |
# type: () -> bool | |
"""Is this console interactive? | |
""" | |
return sys.stdin is not None and sys.stdin.isatty() | |
def hash_file(path, blocksize=1 << 20): | |
# type: (str, int) -> Tuple[Any, int] | |
"""Return (hash, length) for path using hashlib.sha256() | |
""" | |
h = hashlib.sha256() | |
length = 0 | |
with open(path, 'rb') as f: | |
for block in read_chunks(f, size=blocksize): | |
length += len(block) | |
h.update(block) | |
return h, length | |
def is_wheel_installed(): | |
""" | |
Return whether the wheel package is installed. | |
""" | |
try: | |
import wheel # noqa: F401 | |
except ImportError: | |
return False | |
return True | |
def pairwise(iterable): | |
# type: (Iterable[Any]) -> Iterator[Tuple[Any, Any]] | |
""" | |
Return paired elements. | |
For example: | |
s -> (s0, s1), (s2, s3), (s4, s5), ... | |
""" | |
iterable = iter(iterable) | |
return zip_longest(iterable, iterable) |
"""Utilities for defining models | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
import operator | |
class KeyBasedCompareMixin(object): | |
"""Provides comparison capabilities that is based on a key | |
""" | |
def __init__(self, key, defining_class): | |
self._compare_key = key | |
self._defining_class = defining_class | |
def __hash__(self): | |
return hash(self._compare_key) | |
def __lt__(self, other): | |
return self._compare(other, operator.__lt__) | |
def __le__(self, other): | |
return self._compare(other, operator.__le__) | |
def __gt__(self, other): | |
return self._compare(other, operator.__gt__) | |
def __ge__(self, other): | |
return self._compare(other, operator.__ge__) | |
def __eq__(self, other): | |
return self._compare(other, operator.__eq__) | |
def __ne__(self, other): | |
return self._compare(other, operator.__ne__) | |
def _compare(self, other, method): | |
if not isinstance(other, self._defining_class): | |
return NotImplemented | |
return method(self._compare_key, other._compare_key) |
from __future__ import absolute_import | |
import logging | |
from email.parser import FeedParser | |
from pip._vendor import pkg_resources | |
from pip._vendor.packaging import specifiers, version | |
from pip._internal.exceptions import NoneMetadataError | |
from pip._internal.utils.misc import display_path | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Tuple | |
from email.message import Message | |
from pip._vendor.pkg_resources import Distribution | |
logger = logging.getLogger(__name__) | |
def check_requires_python(requires_python, version_info): | |
# type: (Optional[str], Tuple[int, ...]) -> bool | |
""" | |
Check if the given Python version matches a "Requires-Python" specifier. | |
:param version_info: A 3-tuple of ints representing a Python | |
major-minor-micro version to check (e.g. `sys.version_info[:3]`). | |
:return: `True` if the given Python version satisfies the requirement. | |
Otherwise, return `False`. | |
:raises InvalidSpecifier: If `requires_python` has an invalid format. | |
""" | |
if requires_python is None: | |
# The package provides no information | |
return True | |
requires_python_specifier = specifiers.SpecifierSet(requires_python) | |
python_version = version.parse('.'.join(map(str, version_info))) | |
return python_version in requires_python_specifier | |
def get_metadata(dist): | |
# type: (Distribution) -> Message | |
""" | |
:raises NoneMetadataError: if the distribution reports `has_metadata()` | |
True but `get_metadata()` returns None. | |
""" | |
metadata_name = 'METADATA' | |
if (isinstance(dist, pkg_resources.DistInfoDistribution) and | |
dist.has_metadata(metadata_name)): | |
metadata = dist.get_metadata(metadata_name) | |
elif dist.has_metadata('PKG-INFO'): | |
metadata_name = 'PKG-INFO' | |
metadata = dist.get_metadata(metadata_name) | |
else: | |
logger.warning("No metadata found in %s", display_path(dist.location)) | |
metadata = '' | |
if metadata is None: | |
raise NoneMetadataError(dist, metadata_name) | |
feed_parser = FeedParser() | |
# The following line errors out if with a "NoneType" TypeError if | |
# passed metadata=None. | |
feed_parser.feed(metadata) | |
return feed_parser.close() | |
def get_requires_python(dist): | |
# type: (pkg_resources.Distribution) -> Optional[str] | |
""" | |
Return the "Requires-Python" metadata for a distribution, or None | |
if not present. | |
""" | |
pkg_info_dict = get_metadata(dist) | |
requires_python = pkg_info_dict.get('Requires-Python') | |
if requires_python is not None: | |
# Convert to a str to satisfy the type checker, since requires_python | |
# can be a Header object. | |
requires_python = str(requires_python) | |
return requires_python | |
def get_installer(dist): | |
# type: (Distribution) -> str | |
if dist.has_metadata('INSTALLER'): | |
for line in dist.get_metadata_lines('INSTALLER'): | |
if line.strip(): | |
return line.strip() | |
return '' |
from pip._vendor.pkg_resources import yield_lines | |
from pip._vendor.six import ensure_str | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Dict, Iterable, List | |
class DictMetadata(object): | |
"""IMetadataProvider that reads metadata files from a dictionary. | |
""" | |
def __init__(self, metadata): | |
# type: (Dict[str, bytes]) -> None | |
self._metadata = metadata | |
def has_metadata(self, name): | |
# type: (str) -> bool | |
return name in self._metadata | |
def get_metadata(self, name): | |
# type: (str) -> str | |
try: | |
return ensure_str(self._metadata[name]) | |
except UnicodeDecodeError as e: | |
# Mirrors handling done in pkg_resources.NullProvider. | |
e.reason += " in {} file".format(name) | |
raise | |
def get_metadata_lines(self, name): | |
# type: (str) -> Iterable[str] | |
return yield_lines(self.get_metadata(name)) | |
def metadata_isdir(self, name): | |
# type: (str) -> bool | |
return False | |
def metadata_listdir(self, name): | |
# type: (str) -> List[str] | |
return [] | |
def run_script(self, script_name, namespace): | |
# type: (str, str) -> None | |
pass |
import sys | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional, Sequence | |
# Shim to wrap setup.py invocation with setuptools | |
# | |
# We set sys.argv[0] to the path to the underlying setup.py file so | |
# setuptools / distutils don't take the path to the setup.py to be "-c" when | |
# invoking via the shim. This avoids e.g. the following manifest_maker | |
# warning: "warning: manifest_maker: standard file '-c' not found". | |
_SETUPTOOLS_SHIM = ( | |
"import sys, setuptools, tokenize; sys.argv[0] = {0!r}; __file__={0!r};" | |
"f=getattr(tokenize, 'open', open)(__file__);" | |
"code=f.read().replace('\\r\\n', '\\n');" | |
"f.close();" | |
"exec(compile(code, __file__, 'exec'))" | |
) | |
def make_setuptools_shim_args( | |
setup_py_path, # type: str | |
global_options=None, # type: Sequence[str] | |
no_user_config=False, # type: bool | |
unbuffered_output=False # type: bool | |
): | |
# type: (...) -> List[str] | |
""" | |
Get setuptools command arguments with shim wrapped setup file invocation. | |
:param setup_py_path: The path to setup.py to be wrapped. | |
:param global_options: Additional global options. | |
:param no_user_config: If True, disables personal user configuration. | |
:param unbuffered_output: If True, adds the unbuffered switch to the | |
argument list. | |
""" | |
args = [sys.executable] | |
if unbuffered_output: | |
args += ["-u"] | |
args += ["-c", _SETUPTOOLS_SHIM.format(setup_py_path)] | |
if global_options: | |
args += global_options | |
if no_user_config: | |
args += ["--no-user-cfg"] | |
return args | |
def make_setuptools_bdist_wheel_args( | |
setup_py_path, # type: str | |
global_options, # type: Sequence[str] | |
build_options, # type: Sequence[str] | |
destination_dir, # type: str | |
): | |
# type: (...) -> List[str] | |
# NOTE: Eventually, we'd want to also -S to the flags here, when we're | |
# isolating. Currently, it breaks Python in virtualenvs, because it | |
# relies on site.py to find parts of the standard library outside the | |
# virtualenv. | |
args = make_setuptools_shim_args( | |
setup_py_path, | |
global_options=global_options, | |
unbuffered_output=True | |
) | |
args += ["bdist_wheel", "-d", destination_dir] | |
args += build_options | |
return args | |
def make_setuptools_clean_args( | |
setup_py_path, # type: str | |
global_options, # type: Sequence[str] | |
): | |
# type: (...) -> List[str] | |
args = make_setuptools_shim_args( | |
setup_py_path, | |
global_options=global_options, | |
unbuffered_output=True | |
) | |
args += ["clean", "--all"] | |
return args | |
def make_setuptools_develop_args( | |
setup_py_path, # type: str | |
global_options, # type: Sequence[str] | |
install_options, # type: Sequence[str] | |
no_user_config, # type: bool | |
prefix, # type: Optional[str] | |
home, # type: Optional[str] | |
use_user_site, # type: bool | |
): | |
# type: (...) -> List[str] | |
assert not (use_user_site and prefix) | |
args = make_setuptools_shim_args( | |
setup_py_path, | |
global_options=global_options, | |
no_user_config=no_user_config, | |
) | |
args += ["develop", "--no-deps"] | |
args += install_options | |
if prefix: | |
args += ["--prefix", prefix] | |
if home is not None: | |
args += ["--home", home] | |
if use_user_site: | |
args += ["--user", "--prefix="] | |
return args | |
def make_setuptools_egg_info_args( | |
setup_py_path, # type: str | |
egg_info_dir, # type: Optional[str] | |
no_user_config, # type: bool | |
): | |
# type: (...) -> List[str] | |
args = make_setuptools_shim_args( | |
setup_py_path, no_user_config=no_user_config | |
) | |
args += ["egg_info"] | |
if egg_info_dir: | |
args += ["--egg-base", egg_info_dir] | |
return args | |
def make_setuptools_install_args( | |
setup_py_path, # type: str | |
global_options, # type: Sequence[str] | |
install_options, # type: Sequence[str] | |
record_filename, # type: str | |
root, # type: Optional[str] | |
prefix, # type: Optional[str] | |
header_dir, # type: Optional[str] | |
home, # type: Optional[str] | |
use_user_site, # type: bool | |
no_user_config, # type: bool | |
pycompile # type: bool | |
): | |
# type: (...) -> List[str] | |
assert not (use_user_site and prefix) | |
assert not (use_user_site and root) | |
args = make_setuptools_shim_args( | |
setup_py_path, | |
global_options=global_options, | |
no_user_config=no_user_config, | |
unbuffered_output=True | |
) | |
args += ["install", "--record", record_filename] | |
args += ["--single-version-externally-managed"] | |
if root is not None: | |
args += ["--root", root] | |
if prefix is not None: | |
args += ["--prefix", prefix] | |
if home is not None: | |
args += ["--home", home] | |
if use_user_site: | |
args += ["--user", "--prefix="] | |
if pycompile: | |
args += ["--compile"] | |
else: | |
args += ["--no-compile"] | |
if header_dir: | |
args += ["--install-headers", header_dir] | |
args += install_options | |
return args |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
import subprocess | |
from pip._vendor.six.moves import shlex_quote | |
from pip._internal.cli.spinners import SpinnerInterface, open_spinner | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.utils.compat import console_to_str, str_to_display | |
from pip._internal.utils.logging import subprocess_logger | |
from pip._internal.utils.misc import HiddenText, path_to_display | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Callable, Iterable, List, Mapping, Optional, Text, Union, | |
) | |
CommandArgs = List[Union[str, HiddenText]] | |
LOG_DIVIDER = '----------------------------------------' | |
def make_command(*args): | |
# type: (Union[str, HiddenText, CommandArgs]) -> CommandArgs | |
""" | |
Create a CommandArgs object. | |
""" | |
command_args = [] # type: CommandArgs | |
for arg in args: | |
# Check for list instead of CommandArgs since CommandArgs is | |
# only known during type-checking. | |
if isinstance(arg, list): | |
command_args.extend(arg) | |
else: | |
# Otherwise, arg is str or HiddenText. | |
command_args.append(arg) | |
return command_args | |
def format_command_args(args): | |
# type: (Union[List[str], CommandArgs]) -> str | |
""" | |
Format command arguments for display. | |
""" | |
# For HiddenText arguments, display the redacted form by calling str(). | |
# Also, we don't apply str() to arguments that aren't HiddenText since | |
# this can trigger a UnicodeDecodeError in Python 2 if the argument | |
# has type unicode and includes a non-ascii character. (The type | |
# checker doesn't ensure the annotations are correct in all cases.) | |
return ' '.join( | |
shlex_quote(str(arg)) if isinstance(arg, HiddenText) | |
else shlex_quote(arg) for arg in args | |
) | |
def reveal_command_args(args): | |
# type: (Union[List[str], CommandArgs]) -> List[str] | |
""" | |
Return the arguments in their raw, unredacted form. | |
""" | |
return [ | |
arg.secret if isinstance(arg, HiddenText) else arg for arg in args | |
] | |
def make_subprocess_output_error( | |
cmd_args, # type: Union[List[str], CommandArgs] | |
cwd, # type: Optional[str] | |
lines, # type: List[Text] | |
exit_status, # type: int | |
): | |
# type: (...) -> Text | |
""" | |
Create and return the error message to use to log a subprocess error | |
with command output. | |
:param lines: A list of lines, each ending with a newline. | |
""" | |
command = format_command_args(cmd_args) | |
# Convert `command` and `cwd` to text (unicode in Python 2) so we can use | |
# them as arguments in the unicode format string below. This avoids | |
# "UnicodeDecodeError: 'ascii' codec can't decode byte ..." in Python 2 | |
# if either contains a non-ascii character. | |
command_display = str_to_display(command, desc='command bytes') | |
cwd_display = path_to_display(cwd) | |
# We know the joined output value ends in a newline. | |
output = ''.join(lines) | |
msg = ( | |
# Use a unicode string to avoid "UnicodeEncodeError: 'ascii' | |
# codec can't encode character ..." in Python 2 when a format | |
# argument (e.g. `output`) has a non-ascii character. | |
u'Command errored out with exit status {exit_status}:\n' | |
' command: {command_display}\n' | |
' cwd: {cwd_display}\n' | |
'Complete output ({line_count} lines):\n{output}{divider}' | |
).format( | |
exit_status=exit_status, | |
command_display=command_display, | |
cwd_display=cwd_display, | |
line_count=len(lines), | |
output=output, | |
divider=LOG_DIVIDER, | |
) | |
return msg | |
def call_subprocess( | |
cmd, # type: Union[List[str], CommandArgs] | |
show_stdout=False, # type: bool | |
cwd=None, # type: Optional[str] | |
on_returncode='raise', # type: str | |
extra_ok_returncodes=None, # type: Optional[Iterable[int]] | |
command_desc=None, # type: Optional[str] | |
extra_environ=None, # type: Optional[Mapping[str, Any]] | |
unset_environ=None, # type: Optional[Iterable[str]] | |
spinner=None, # type: Optional[SpinnerInterface] | |
log_failed_cmd=True # type: Optional[bool] | |
): | |
# type: (...) -> Text | |
""" | |
Args: | |
show_stdout: if true, use INFO to log the subprocess's stderr and | |
stdout streams. Otherwise, use DEBUG. Defaults to False. | |
extra_ok_returncodes: an iterable of integer return codes that are | |
acceptable, in addition to 0. Defaults to None, which means []. | |
unset_environ: an iterable of environment variable names to unset | |
prior to calling subprocess.Popen(). | |
log_failed_cmd: if false, failed commands are not logged, only raised. | |
""" | |
if extra_ok_returncodes is None: | |
extra_ok_returncodes = [] | |
if unset_environ is None: | |
unset_environ = [] | |
# Most places in pip use show_stdout=False. What this means is-- | |
# | |
# - We connect the child's output (combined stderr and stdout) to a | |
# single pipe, which we read. | |
# - We log this output to stderr at DEBUG level as it is received. | |
# - If DEBUG logging isn't enabled (e.g. if --verbose logging wasn't | |
# requested), then we show a spinner so the user can still see the | |
# subprocess is in progress. | |
# - If the subprocess exits with an error, we log the output to stderr | |
# at ERROR level if it hasn't already been displayed to the console | |
# (e.g. if --verbose logging wasn't enabled). This way we don't log | |
# the output to the console twice. | |
# | |
# If show_stdout=True, then the above is still done, but with DEBUG | |
# replaced by INFO. | |
if show_stdout: | |
# Then log the subprocess output at INFO level. | |
log_subprocess = subprocess_logger.info | |
used_level = logging.INFO | |
else: | |
# Then log the subprocess output using DEBUG. This also ensures | |
# it will be logged to the log file (aka user_log), if enabled. | |
log_subprocess = subprocess_logger.debug | |
used_level = logging.DEBUG | |
# Whether the subprocess will be visible in the console. | |
showing_subprocess = subprocess_logger.getEffectiveLevel() <= used_level | |
# Only use the spinner if we're not showing the subprocess output | |
# and we have a spinner. | |
use_spinner = not showing_subprocess and spinner is not None | |
if command_desc is None: | |
command_desc = format_command_args(cmd) | |
log_subprocess("Running command %s", command_desc) | |
env = os.environ.copy() | |
if extra_environ: | |
env.update(extra_environ) | |
for name in unset_environ: | |
env.pop(name, None) | |
try: | |
proc = subprocess.Popen( | |
# Convert HiddenText objects to the underlying str. | |
reveal_command_args(cmd), | |
stderr=subprocess.STDOUT, stdin=subprocess.PIPE, | |
stdout=subprocess.PIPE, cwd=cwd, env=env, | |
) | |
proc.stdin.close() | |
except Exception as exc: | |
if log_failed_cmd: | |
subprocess_logger.critical( | |
"Error %s while executing command %s", exc, command_desc, | |
) | |
raise | |
all_output = [] | |
while True: | |
# The "line" value is a unicode string in Python 2. | |
line = console_to_str(proc.stdout.readline()) | |
if not line: | |
break | |
line = line.rstrip() | |
all_output.append(line + '\n') | |
# Show the line immediately. | |
log_subprocess(line) | |
# Update the spinner. | |
if use_spinner: | |
spinner.spin() | |
try: | |
proc.wait() | |
finally: | |
if proc.stdout: | |
proc.stdout.close() | |
proc_had_error = ( | |
proc.returncode and proc.returncode not in extra_ok_returncodes | |
) | |
if use_spinner: | |
if proc_had_error: | |
spinner.finish("error") | |
else: | |
spinner.finish("done") | |
if proc_had_error: | |
if on_returncode == 'raise': | |
if not showing_subprocess and log_failed_cmd: | |
# Then the subprocess streams haven't been logged to the | |
# console yet. | |
msg = make_subprocess_output_error( | |
cmd_args=cmd, | |
cwd=cwd, | |
lines=all_output, | |
exit_status=proc.returncode, | |
) | |
subprocess_logger.error(msg) | |
exc_msg = ( | |
'Command errored out with exit status {}: {} ' | |
'Check the logs for full command output.' | |
).format(proc.returncode, command_desc) | |
raise InstallationError(exc_msg) | |
elif on_returncode == 'warn': | |
subprocess_logger.warning( | |
'Command "{}" had error code {} in {}'.format( | |
command_desc, proc.returncode, cwd) | |
) | |
elif on_returncode == 'ignore': | |
pass | |
else: | |
raise ValueError('Invalid value: on_returncode={!r}'.format( | |
on_returncode)) | |
return ''.join(all_output) | |
def runner_with_spinner_message(message): | |
# type: (str) -> Callable[..., None] | |
"""Provide a subprocess_runner that shows a spinner message. | |
Intended for use with for pep517's Pep517HookCaller. Thus, the runner has | |
an API that matches what's expected by Pep517HookCaller.subprocess_runner. | |
""" | |
def runner( | |
cmd, # type: List[str] | |
cwd=None, # type: Optional[str] | |
extra_environ=None # type: Optional[Mapping[str, Any]] | |
): | |
# type: (...) -> None | |
with open_spinner(message) as spinner: | |
call_subprocess( | |
cmd, | |
cwd=cwd, | |
extra_environ=extra_environ, | |
spinner=spinner, | |
) | |
return runner |
from __future__ import absolute_import | |
import errno | |
import itertools | |
import logging | |
import os.path | |
import tempfile | |
from contextlib import contextmanager | |
from pip._vendor.contextlib2 import ExitStack | |
from pip._internal.utils.misc import enum, rmtree | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Any, Dict, Iterator, Optional, TypeVar, Union | |
_T = TypeVar('_T', bound='TempDirectory') | |
logger = logging.getLogger(__name__) | |
# Kinds of temporary directories. Only needed for ones that are | |
# globally-managed. | |
tempdir_kinds = enum( | |
BUILD_ENV="build-env", | |
EPHEM_WHEEL_CACHE="ephem-wheel-cache", | |
REQ_BUILD="req-build", | |
) | |
_tempdir_manager = None # type: Optional[ExitStack] | |
@contextmanager | |
def global_tempdir_manager(): | |
# type: () -> Iterator[None] | |
global _tempdir_manager | |
with ExitStack() as stack: | |
old_tempdir_manager, _tempdir_manager = _tempdir_manager, stack | |
try: | |
yield | |
finally: | |
_tempdir_manager = old_tempdir_manager | |
class TempDirectoryTypeRegistry(object): | |
"""Manages temp directory behavior | |
""" | |
def __init__(self): | |
# type: () -> None | |
self._should_delete = {} # type: Dict[str, bool] | |
def set_delete(self, kind, value): | |
# type: (str, bool) -> None | |
"""Indicate whether a TempDirectory of the given kind should be | |
auto-deleted. | |
""" | |
self._should_delete[kind] = value | |
def get_delete(self, kind): | |
# type: (str) -> bool | |
"""Get configured auto-delete flag for a given TempDirectory type, | |
default True. | |
""" | |
return self._should_delete.get(kind, True) | |
_tempdir_registry = None # type: Optional[TempDirectoryTypeRegistry] | |
@contextmanager | |
def tempdir_registry(): | |
# type: () -> Iterator[TempDirectoryTypeRegistry] | |
"""Provides a scoped global tempdir registry that can be used to dictate | |
whether directories should be deleted. | |
""" | |
global _tempdir_registry | |
old_tempdir_registry = _tempdir_registry | |
_tempdir_registry = TempDirectoryTypeRegistry() | |
try: | |
yield _tempdir_registry | |
finally: | |
_tempdir_registry = old_tempdir_registry | |
class _Default(object): | |
pass | |
_default = _Default() | |
class TempDirectory(object): | |
"""Helper class that owns and cleans up a temporary directory. | |
This class can be used as a context manager or as an OO representation of a | |
temporary directory. | |
Attributes: | |
path | |
Location to the created temporary directory | |
delete | |
Whether the directory should be deleted when exiting | |
(when used as a contextmanager) | |
Methods: | |
cleanup() | |
Deletes the temporary directory | |
When used as a context manager, if the delete attribute is True, on | |
exiting the context the temporary directory is deleted. | |
""" | |
def __init__( | |
self, | |
path=None, # type: Optional[str] | |
delete=_default, # type: Union[bool, None, _Default] | |
kind="temp", # type: str | |
globally_managed=False, # type: bool | |
): | |
super(TempDirectory, self).__init__() | |
if delete is _default: | |
if path is not None: | |
# If we were given an explicit directory, resolve delete option | |
# now. | |
delete = False | |
else: | |
# Otherwise, we wait until cleanup and see what | |
# tempdir_registry says. | |
delete = None | |
if path is None: | |
path = self._create(kind) | |
self._path = path | |
self._deleted = False | |
self.delete = delete | |
self.kind = kind | |
if globally_managed: | |
assert _tempdir_manager is not None | |
_tempdir_manager.enter_context(self) | |
@property | |
def path(self): | |
# type: () -> str | |
assert not self._deleted, ( | |
"Attempted to access deleted path: {}".format(self._path) | |
) | |
return self._path | |
def __repr__(self): | |
# type: () -> str | |
return "<{} {!r}>".format(self.__class__.__name__, self.path) | |
def __enter__(self): | |
# type: (_T) -> _T | |
return self | |
def __exit__(self, exc, value, tb): | |
# type: (Any, Any, Any) -> None | |
if self.delete is not None: | |
delete = self.delete | |
elif _tempdir_registry: | |
delete = _tempdir_registry.get_delete(self.kind) | |
else: | |
delete = True | |
if delete: | |
self.cleanup() | |
def _create(self, kind): | |
# type: (str) -> str | |
"""Create a temporary directory and store its path in self.path | |
""" | |
# We realpath here because some systems have their default tmpdir | |
# symlinked to another directory. This tends to confuse build | |
# scripts, so we canonicalize the path by traversing potential | |
# symlinks here. | |
path = os.path.realpath( | |
tempfile.mkdtemp(prefix="pip-{}-".format(kind)) | |
) | |
logger.debug("Created temporary directory: {}".format(path)) | |
return path | |
def cleanup(self): | |
# type: () -> None | |
"""Remove the temporary directory created and reset state | |
""" | |
self._deleted = True | |
if os.path.exists(self._path): | |
rmtree(self._path) | |
class AdjacentTempDirectory(TempDirectory): | |
"""Helper class that creates a temporary directory adjacent to a real one. | |
Attributes: | |
original | |
The original directory to create a temp directory for. | |
path | |
After calling create() or entering, contains the full | |
path to the temporary directory. | |
delete | |
Whether the directory should be deleted when exiting | |
(when used as a contextmanager) | |
""" | |
# The characters that may be used to name the temp directory | |
# We always prepend a ~ and then rotate through these until | |
# a usable name is found. | |
# pkg_resources raises a different error for .dist-info folder | |
# with leading '-' and invalid metadata | |
LEADING_CHARS = "-~.=%0123456789" | |
def __init__(self, original, delete=None): | |
# type: (str, Optional[bool]) -> None | |
self.original = original.rstrip('/\\') | |
super(AdjacentTempDirectory, self).__init__(delete=delete) | |
@classmethod | |
def _generate_names(cls, name): | |
# type: (str) -> Iterator[str] | |
"""Generates a series of temporary names. | |
The algorithm replaces the leading characters in the name | |
with ones that are valid filesystem characters, but are not | |
valid package names (for both Python and pip definitions of | |
package). | |
""" | |
for i in range(1, len(name)): | |
for candidate in itertools.combinations_with_replacement( | |
cls.LEADING_CHARS, i - 1): | |
new_name = '~' + ''.join(candidate) + name[i:] | |
if new_name != name: | |
yield new_name | |
# If we make it this far, we will have to make a longer name | |
for i in range(len(cls.LEADING_CHARS)): | |
for candidate in itertools.combinations_with_replacement( | |
cls.LEADING_CHARS, i): | |
new_name = '~' + ''.join(candidate) + name | |
if new_name != name: | |
yield new_name | |
def _create(self, kind): | |
# type: (str) -> str | |
root, name = os.path.split(self.original) | |
for candidate in self._generate_names(name): | |
path = os.path.join(root, candidate) | |
try: | |
os.mkdir(path) | |
except OSError as ex: | |
# Continue if the name exists already | |
if ex.errno != errno.EEXIST: | |
raise | |
else: | |
path = os.path.realpath(path) | |
break | |
else: | |
# Final fallback on the default behavior. | |
path = os.path.realpath( | |
tempfile.mkdtemp(prefix="pip-{}-".format(kind)) | |
) | |
logger.debug("Created temporary directory: {}".format(path)) | |
return path |
"""For neatly implementing static typing in pip. | |
`mypy` - the static type analysis tool we use - uses the `typing` module, which | |
provides core functionality fundamental to mypy's functioning. | |
Generally, `typing` would be imported at runtime and used in that fashion - | |
it acts as a no-op at runtime and does not have any run-time overhead by | |
design. | |
As it turns out, `typing` is not vendorable - it uses separate sources for | |
Python 2/Python 3. Thus, this codebase can not expect it to be present. | |
To work around this, mypy allows the typing import to be behind a False-y | |
optional to prevent it from running at runtime and type-comments can be used | |
to remove the need for the types to be accessible directly during runtime. | |
This module provides the False-y guard in a nicely named fashion so that a | |
curious maintainer can reach here to read this. | |
In pip, all static-typing related imports should be guarded as follows: | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import ... | |
Ref: https://github.com/python/mypy/issues/3216 | |
""" | |
MYPY_CHECK_RUNNING = False | |
if MYPY_CHECK_RUNNING: | |
from typing import cast | |
else: | |
# typing's cast() is needed at runtime, but we don't want to import typing. | |
# Thus, we use a dummy no-op version, which we tell mypy to ignore. | |
def cast(type_, value): # type: ignore | |
return value |
"""Utilities related archives. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
import shutil | |
import stat | |
import tarfile | |
import zipfile | |
from pip._internal.exceptions import InstallationError | |
from pip._internal.utils.filetypes import ( | |
BZ2_EXTENSIONS, | |
TAR_EXTENSIONS, | |
XZ_EXTENSIONS, | |
ZIP_EXTENSIONS, | |
) | |
from pip._internal.utils.misc import ensure_dir | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Iterable, List, Optional, Text, Union | |
logger = logging.getLogger(__name__) | |
SUPPORTED_EXTENSIONS = ZIP_EXTENSIONS + TAR_EXTENSIONS | |
try: | |
import bz2 # noqa | |
SUPPORTED_EXTENSIONS += BZ2_EXTENSIONS | |
except ImportError: | |
logger.debug('bz2 module is not available') | |
try: | |
# Only for Python 3.3+ | |
import lzma # noqa | |
SUPPORTED_EXTENSIONS += XZ_EXTENSIONS | |
except ImportError: | |
logger.debug('lzma module is not available') | |
def current_umask(): | |
"""Get the current umask which involves having to set it temporarily.""" | |
mask = os.umask(0) | |
os.umask(mask) | |
return mask | |
def split_leading_dir(path): | |
# type: (Union[str, Text]) -> List[Union[str, Text]] | |
path = path.lstrip('/').lstrip('\\') | |
if ( | |
'/' in path and ( | |
('\\' in path and path.find('/') < path.find('\\')) or | |
'\\' not in path | |
) | |
): | |
return path.split('/', 1) | |
elif '\\' in path: | |
return path.split('\\', 1) | |
else: | |
return [path, ''] | |
def has_leading_dir(paths): | |
# type: (Iterable[Union[str, Text]]) -> bool | |
"""Returns true if all the paths have the same leading path name | |
(i.e., everything is in one subdirectory in an archive)""" | |
common_prefix = None | |
for path in paths: | |
prefix, rest = split_leading_dir(path) | |
if not prefix: | |
return False | |
elif common_prefix is None: | |
common_prefix = prefix | |
elif prefix != common_prefix: | |
return False | |
return True | |
def is_within_directory(directory, target): | |
# type: ((Union[str, Text]), (Union[str, Text])) -> bool | |
""" | |
Return true if the absolute path of target is within the directory | |
""" | |
abs_directory = os.path.abspath(directory) | |
abs_target = os.path.abspath(target) | |
prefix = os.path.commonprefix([abs_directory, abs_target]) | |
return prefix == abs_directory | |
def unzip_file(filename, location, flatten=True): | |
# type: (str, str, bool) -> None | |
""" | |
Unzip the file (with path `filename`) to the destination `location`. All | |
files are written based on system defaults and umask (i.e. permissions are | |
not preserved), except that regular file members with any execute | |
permissions (user, group, or world) have "chmod +x" applied after being | |
written. Note that for windows, any execute changes using os.chmod are | |
no-ops per the python docs. | |
""" | |
ensure_dir(location) | |
zipfp = open(filename, 'rb') | |
try: | |
zip = zipfile.ZipFile(zipfp, allowZip64=True) | |
leading = has_leading_dir(zip.namelist()) and flatten | |
for info in zip.infolist(): | |
name = info.filename | |
fn = name | |
if leading: | |
fn = split_leading_dir(name)[1] | |
fn = os.path.join(location, fn) | |
dir = os.path.dirname(fn) | |
if not is_within_directory(location, fn): | |
message = ( | |
'The zip file ({}) has a file ({}) trying to install ' | |
'outside target directory ({})' | |
) | |
raise InstallationError(message.format(filename, fn, location)) | |
if fn.endswith('/') or fn.endswith('\\'): | |
# A directory | |
ensure_dir(fn) | |
else: | |
ensure_dir(dir) | |
# Don't use read() to avoid allocating an arbitrarily large | |
# chunk of memory for the file's content | |
fp = zip.open(name) | |
try: | |
with open(fn, 'wb') as destfp: | |
shutil.copyfileobj(fp, destfp) | |
finally: | |
fp.close() | |
mode = info.external_attr >> 16 | |
# if mode and regular file and any execute permissions for | |
# user/group/world? | |
if mode and stat.S_ISREG(mode) and mode & 0o111: | |
# make dest file have execute for user/group/world | |
# (chmod +x) no-op on windows per python docs | |
os.chmod(fn, (0o777 - current_umask() | 0o111)) | |
finally: | |
zipfp.close() | |
def untar_file(filename, location): | |
# type: (str, str) -> None | |
""" | |
Untar the file (with path `filename`) to the destination `location`. | |
All files are written based on system defaults and umask (i.e. permissions | |
are not preserved), except that regular file members with any execute | |
permissions (user, group, or world) have "chmod +x" applied after being | |
written. Note that for windows, any execute changes using os.chmod are | |
no-ops per the python docs. | |
""" | |
ensure_dir(location) | |
if filename.lower().endswith('.gz') or filename.lower().endswith('.tgz'): | |
mode = 'r:gz' | |
elif filename.lower().endswith(BZ2_EXTENSIONS): | |
mode = 'r:bz2' | |
elif filename.lower().endswith(XZ_EXTENSIONS): | |
mode = 'r:xz' | |
elif filename.lower().endswith('.tar'): | |
mode = 'r' | |
else: | |
logger.warning( | |
'Cannot determine compression type for file %s', filename, | |
) | |
mode = 'r:*' | |
tar = tarfile.open(filename, mode) | |
try: | |
leading = has_leading_dir([ | |
member.name for member in tar.getmembers() | |
]) | |
for member in tar.getmembers(): | |
fn = member.name | |
if leading: | |
# https://github.com/python/mypy/issues/1174 | |
fn = split_leading_dir(fn)[1] # type: ignore | |
path = os.path.join(location, fn) | |
if not is_within_directory(location, path): | |
message = ( | |
'The tar file ({}) has a file ({}) trying to install ' | |
'outside target directory ({})' | |
) | |
raise InstallationError( | |
message.format(filename, path, location) | |
) | |
if member.isdir(): | |
ensure_dir(path) | |
elif member.issym(): | |
try: | |
# https://github.com/python/typeshed/issues/2673 | |
tar._extract_member(member, path) # type: ignore | |
except Exception as exc: | |
# Some corrupt tar files seem to produce this | |
# (specifically bad symlinks) | |
logger.warning( | |
'In the tar file %s the member %s is invalid: %s', | |
filename, member.name, exc, | |
) | |
continue | |
else: | |
try: | |
fp = tar.extractfile(member) | |
except (KeyError, AttributeError) as exc: | |
# Some corrupt tar files seem to produce this | |
# (specifically bad symlinks) | |
logger.warning( | |
'In the tar file %s the member %s is invalid: %s', | |
filename, member.name, exc, | |
) | |
continue | |
ensure_dir(os.path.dirname(path)) | |
with open(path, 'wb') as destfp: | |
shutil.copyfileobj(fp, destfp) | |
fp.close() | |
# Update the timestamp (useful for cython compiled files) | |
# https://github.com/python/typeshed/issues/2673 | |
tar.utime(member, path) # type: ignore | |
# member have any execute permissions for user/group/world? | |
if member.mode & 0o111: | |
# make dest file have execute for user/group/world | |
# no-op on windows per python docs | |
os.chmod(path, (0o777 - current_umask() | 0o111)) | |
finally: | |
tar.close() | |
def unpack_file( | |
filename, # type: str | |
location, # type: str | |
content_type=None, # type: Optional[str] | |
): | |
# type: (...) -> None | |
filename = os.path.realpath(filename) | |
if ( | |
content_type == 'application/zip' or | |
filename.lower().endswith(ZIP_EXTENSIONS) or | |
zipfile.is_zipfile(filename) | |
): | |
unzip_file( | |
filename, | |
location, | |
flatten=not filename.endswith('.whl') | |
) | |
elif ( | |
content_type == 'application/x-gzip' or | |
tarfile.is_tarfile(filename) or | |
filename.lower().endswith( | |
TAR_EXTENSIONS + BZ2_EXTENSIONS + XZ_EXTENSIONS | |
) | |
): | |
untar_file(filename, location) | |
else: | |
# FIXME: handle? | |
# FIXME: magic signatures? | |
logger.critical( | |
'Cannot unpack file %s (downloaded from %s, content-type: %s); ' | |
'cannot detect archive format', | |
filename, location, content_type, | |
) | |
raise InstallationError( | |
'Cannot determine archive format of {}'.format(location) | |
) |
import os | |
import sys | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._vendor.six.moves.urllib import request as urllib_request | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Text, Union | |
def get_url_scheme(url): | |
# type: (Union[str, Text]) -> Optional[Text] | |
if ':' not in url: | |
return None | |
return url.split(':', 1)[0].lower() | |
def path_to_url(path): | |
# type: (Union[str, Text]) -> str | |
""" | |
Convert a path to a file: URL. The path will be made absolute and have | |
quoted path parts. | |
""" | |
path = os.path.normpath(os.path.abspath(path)) | |
url = urllib_parse.urljoin('file:', urllib_request.pathname2url(path)) | |
return url | |
def url_to_path(url): | |
# type: (str) -> str | |
""" | |
Convert a file: URL to a path. | |
""" | |
assert url.startswith('file:'), ( | |
"You can only turn file: urls into filenames (not {url!r})" | |
.format(**locals())) | |
_, netloc, path, _, _ = urllib_parse.urlsplit(url) | |
if not netloc or netloc == 'localhost': | |
# According to RFC 8089, same as empty authority. | |
netloc = '' | |
elif sys.platform == 'win32': | |
# If we have a UNC path, prepend UNC share notation. | |
netloc = '\\\\' + netloc | |
else: | |
raise ValueError( | |
'non-local file URIs are not supported on this platform: {url!r}' | |
.format(**locals()) | |
) | |
path = urllib_request.url2pathname(netloc + path) | |
return path |
from __future__ import absolute_import | |
import logging | |
import os | |
import re | |
import site | |
import sys | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from typing import List, Optional | |
logger = logging.getLogger(__name__) | |
_INCLUDE_SYSTEM_SITE_PACKAGES_REGEX = re.compile( | |
r"include-system-site-packages\s*=\s*(?P<value>true|false)" | |
) | |
def _running_under_venv(): | |
# type: () -> bool | |
"""Checks if sys.base_prefix and sys.prefix match. | |
This handles PEP 405 compliant virtual environments. | |
""" | |
return sys.prefix != getattr(sys, "base_prefix", sys.prefix) | |
def _running_under_regular_virtualenv(): | |
# type: () -> bool | |
"""Checks if sys.real_prefix is set. | |
This handles virtual environments created with pypa's virtualenv. | |
""" | |
# pypa/virtualenv case | |
return hasattr(sys, 'real_prefix') | |
def running_under_virtualenv(): | |
# type: () -> bool | |
"""Return True if we're running inside a virtualenv, False otherwise. | |
""" | |
return _running_under_venv() or _running_under_regular_virtualenv() | |
def _get_pyvenv_cfg_lines(): | |
# type: () -> Optional[List[str]] | |
"""Reads {sys.prefix}/pyvenv.cfg and returns its contents as list of lines | |
Returns None, if it could not read/access the file. | |
""" | |
pyvenv_cfg_file = os.path.join(sys.prefix, 'pyvenv.cfg') | |
try: | |
with open(pyvenv_cfg_file) as f: | |
return f.read().splitlines() # avoids trailing newlines | |
except IOError: | |
return None | |
def _no_global_under_venv(): | |
# type: () -> bool | |
"""Check `{sys.prefix}/pyvenv.cfg` for system site-packages inclusion | |
PEP 405 specifies that when system site-packages are not supposed to be | |
visible from a virtual environment, `pyvenv.cfg` must contain the following | |
line: | |
include-system-site-packages = false | |
Additionally, log a warning if accessing the file fails. | |
""" | |
cfg_lines = _get_pyvenv_cfg_lines() | |
if cfg_lines is None: | |
# We're not in a "sane" venv, so assume there is no system | |
# site-packages access (since that's PEP 405's default state). | |
logger.warning( | |
"Could not access 'pyvenv.cfg' despite a virtual environment " | |
"being active. Assuming global site-packages is not accessible " | |
"in this environment." | |
) | |
return True | |
for line in cfg_lines: | |
match = _INCLUDE_SYSTEM_SITE_PACKAGES_REGEX.match(line) | |
if match is not None and match.group('value') == 'false': | |
return True | |
return False | |
def _no_global_under_regular_virtualenv(): | |
# type: () -> bool | |
"""Check if "no-global-site-packages.txt" exists beside site.py | |
This mirrors logic in pypa/virtualenv for determining whether system | |
site-packages are visible in the virtual environment. | |
""" | |
site_mod_dir = os.path.dirname(os.path.abspath(site.__file__)) | |
no_global_site_packages_file = os.path.join( | |
site_mod_dir, 'no-global-site-packages.txt', | |
) | |
return os.path.exists(no_global_site_packages_file) | |
def virtualenv_no_global(): | |
# type: () -> bool | |
"""Returns a boolean, whether running in venv with no system site-packages. | |
""" | |
# PEP 405 compliance needs to be checked first since virtualenv >=20 would | |
# return True for both checks, but is only able to use the PEP 405 config. | |
if _running_under_venv(): | |
return _no_global_under_venv() | |
if _running_under_regular_virtualenv(): | |
return _no_global_under_regular_virtualenv() | |
return False |
"""Support functions for working with wheel files. | |
""" | |
from __future__ import absolute_import | |
import logging | |
from email.parser import Parser | |
from zipfile import ZipFile | |
from pip._vendor.packaging.utils import canonicalize_name | |
from pip._vendor.pkg_resources import DistInfoDistribution | |
from pip._vendor.six import PY2, ensure_str | |
from pip._internal.exceptions import UnsupportedWheel | |
from pip._internal.utils.pkg_resources import DictMetadata | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
if MYPY_CHECK_RUNNING: | |
from email.message import Message | |
from typing import Dict, Tuple | |
from pip._vendor.pkg_resources import Distribution | |
if PY2: | |
from zipfile import BadZipfile as BadZipFile | |
else: | |
from zipfile import BadZipFile | |
VERSION_COMPATIBLE = (1, 0) | |
logger = logging.getLogger(__name__) | |
class WheelMetadata(DictMetadata): | |
"""Metadata provider that maps metadata decoding exceptions to our | |
internal exception type. | |
""" | |
def __init__(self, metadata, wheel_name): | |
# type: (Dict[str, bytes], str) -> None | |
super(WheelMetadata, self).__init__(metadata) | |
self._wheel_name = wheel_name | |
def get_metadata(self, name): | |
# type: (str) -> str | |
try: | |
return super(WheelMetadata, self).get_metadata(name) | |
except UnicodeDecodeError as e: | |
# Augment the default error with the origin of the file. | |
raise UnsupportedWheel( | |
"Error decoding metadata for {}: {}".format( | |
self._wheel_name, e | |
) | |
) | |
def pkg_resources_distribution_for_wheel(wheel_zip, name, location): | |
# type: (ZipFile, str, str) -> Distribution | |
"""Get a pkg_resources distribution given a wheel. | |
:raises UnsupportedWheel: on any errors | |
""" | |
info_dir, _ = parse_wheel(wheel_zip, name) | |
metadata_files = [ | |
p for p in wheel_zip.namelist() if p.startswith("{}/".format(info_dir)) | |
] | |
metadata_text = {} # type: Dict[str, bytes] | |
for path in metadata_files: | |
# If a flag is set, namelist entries may be unicode in Python 2. | |
# We coerce them to native str type to match the types used in the rest | |
# of the code. This cannot fail because unicode can always be encoded | |
# with UTF-8. | |
full_path = ensure_str(path) | |
_, metadata_name = full_path.split("/", 1) | |
try: | |
metadata_text[metadata_name] = read_wheel_metadata_file( | |
wheel_zip, full_path | |
) | |
except UnsupportedWheel as e: | |
raise UnsupportedWheel( | |
"{} has an invalid wheel, {}".format(name, str(e)) | |
) | |
metadata = WheelMetadata(metadata_text, location) | |
return DistInfoDistribution( | |
location=location, metadata=metadata, project_name=name | |
) | |
def parse_wheel(wheel_zip, name): | |
# type: (ZipFile, str) -> Tuple[str, Message] | |
"""Extract information from the provided wheel, ensuring it meets basic | |
standards. | |
Returns the name of the .dist-info directory and the parsed WHEEL metadata. | |
""" | |
try: | |
info_dir = wheel_dist_info_dir(wheel_zip, name) | |
metadata = wheel_metadata(wheel_zip, info_dir) | |
version = wheel_version(metadata) | |
except UnsupportedWheel as e: | |
raise UnsupportedWheel( | |
"{} has an invalid wheel, {}".format(name, str(e)) | |
) | |
check_compatibility(version, name) | |
return info_dir, metadata | |
def wheel_dist_info_dir(source, name): | |
# type: (ZipFile, str) -> str | |
"""Returns the name of the contained .dist-info directory. | |
Raises AssertionError or UnsupportedWheel if not found, >1 found, or | |
it doesn't match the provided name. | |
""" | |
# Zip file path separators must be / | |
subdirs = list(set(p.split("/")[0] for p in source.namelist())) | |
info_dirs = [s for s in subdirs if s.endswith('.dist-info')] | |
if not info_dirs: | |
raise UnsupportedWheel(".dist-info directory not found") | |
if len(info_dirs) > 1: | |
raise UnsupportedWheel( | |
"multiple .dist-info directories found: {}".format( | |
", ".join(info_dirs) | |
) | |
) | |
info_dir = info_dirs[0] | |
info_dir_name = canonicalize_name(info_dir) | |
canonical_name = canonicalize_name(name) | |
if not info_dir_name.startswith(canonical_name): | |
raise UnsupportedWheel( | |
".dist-info directory {!r} does not start with {!r}".format( | |
info_dir, canonical_name | |
) | |
) | |
# Zip file paths can be unicode or str depending on the zip entry flags, | |
# so normalize it. | |
return ensure_str(info_dir) | |
def read_wheel_metadata_file(source, path): | |
# type: (ZipFile, str) -> bytes | |
try: | |
return source.read(path) | |
# BadZipFile for general corruption, KeyError for missing entry, | |
# and RuntimeError for password-protected files | |
except (BadZipFile, KeyError, RuntimeError) as e: | |
raise UnsupportedWheel( | |
"could not read {!r} file: {!r}".format(path, e) | |
) | |
def wheel_metadata(source, dist_info_dir): | |
# type: (ZipFile, str) -> Message | |
"""Return the WHEEL metadata of an extracted wheel, if possible. | |
Otherwise, raise UnsupportedWheel. | |
""" | |
path = "{}/WHEEL".format(dist_info_dir) | |
# Zip file path separators must be / | |
wheel_contents = read_wheel_metadata_file(source, path) | |
try: | |
wheel_text = ensure_str(wheel_contents) | |
except UnicodeDecodeError as e: | |
raise UnsupportedWheel("error decoding {!r}: {!r}".format(path, e)) | |
# FeedParser (used by Parser) does not raise any exceptions. The returned | |
# message may have .defects populated, but for backwards-compatibility we | |
# currently ignore them. | |
return Parser().parsestr(wheel_text) | |
def wheel_version(wheel_data): | |
# type: (Message) -> Tuple[int, ...] | |
"""Given WHEEL metadata, return the parsed Wheel-Version. | |
Otherwise, raise UnsupportedWheel. | |
""" | |
version_text = wheel_data["Wheel-Version"] | |
if version_text is None: | |
raise UnsupportedWheel("WHEEL is missing Wheel-Version") | |
version = version_text.strip() | |
try: | |
return tuple(map(int, version.split('.'))) | |
except ValueError: | |
raise UnsupportedWheel("invalid Wheel-Version: {!r}".format(version)) | |
def check_compatibility(version, name): | |
# type: (Tuple[int, ...], str) -> None | |
"""Raises errors or warns if called with an incompatible Wheel-Version. | |
pip should refuse to install a Wheel-Version that's a major series | |
ahead of what it's compatible with (e.g 2.0 > 1.1); and warn when | |
installing a version only minor version ahead (e.g 1.2 > 1.1). | |
version: a 2-tuple representing a Wheel-Version (Major, Minor) | |
name: name of wheel or package to raise exception about | |
:raises UnsupportedWheel: when an incompatible Wheel-Version is given | |
""" | |
if version[0] > VERSION_COMPATIBLE[0]: | |
raise UnsupportedWheel( | |
"{}'s Wheel-Version ({}) is not compatible with this version " | |
"of pip".format(name, '.'.join(map(str, version))) | |
) | |
elif version > VERSION_COMPATIBLE: | |
logger.warning( | |
'Installing from a newer Wheel-Version (%s)', | |
'.'.join(map(str, version)), | |
) |
# Expose a limited set of classes and functions so callers outside of | |
# the vcs package don't need to import deeper than `pip._internal.vcs`. | |
# (The test directory and imports protected by MYPY_CHECK_RUNNING may | |
# still need to import from a vcs sub-package.) | |
# Import all vcs modules to register each VCS in the VcsSupport object. | |
import pip._internal.vcs.bazaar | |
import pip._internal.vcs.git | |
import pip._internal.vcs.mercurial | |
import pip._internal.vcs.subversion # noqa: F401 | |
from pip._internal.vcs.versioncontrol import ( # noqa: F401 | |
RemoteNotFoundError, | |
is_url, | |
make_vcs_requirement_url, | |
vcs, | |
) |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._internal.utils.misc import display_path, rmtree | |
from pip._internal.utils.subprocess import make_command | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import path_to_url | |
from pip._internal.vcs.versioncontrol import VersionControl, vcs | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Tuple | |
from pip._internal.utils.misc import HiddenText | |
from pip._internal.vcs.versioncontrol import AuthInfo, RevOptions | |
logger = logging.getLogger(__name__) | |
class Bazaar(VersionControl): | |
name = 'bzr' | |
dirname = '.bzr' | |
repo_name = 'branch' | |
schemes = ( | |
'bzr', 'bzr+http', 'bzr+https', 'bzr+ssh', 'bzr+sftp', 'bzr+ftp', | |
'bzr+lp', | |
) | |
def __init__(self, *args, **kwargs): | |
super(Bazaar, self).__init__(*args, **kwargs) | |
# This is only needed for python <2.7.5 | |
# Register lp but do not expose as a scheme to support bzr+lp. | |
if getattr(urllib_parse, 'uses_fragment', None): | |
urllib_parse.uses_fragment.extend(['lp']) | |
@staticmethod | |
def get_base_rev_args(rev): | |
return ['-r', rev] | |
def export(self, location, url): | |
# type: (str, HiddenText) -> None | |
""" | |
Export the Bazaar repository at the url to the destination location | |
""" | |
# Remove the location to make sure Bazaar can export it correctly | |
if os.path.exists(location): | |
rmtree(location) | |
url, rev_options = self.get_url_rev_options(url) | |
self.run_command( | |
make_command('export', location, url, rev_options.to_args()), | |
show_stdout=False, | |
) | |
def fetch_new(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
rev_display = rev_options.to_display() | |
logger.info( | |
'Checking out %s%s to %s', | |
url, | |
rev_display, | |
display_path(dest), | |
) | |
cmd_args = ( | |
make_command('branch', '-q', rev_options.to_args(), url, dest) | |
) | |
self.run_command(cmd_args) | |
def switch(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
self.run_command(make_command('switch', url), cwd=dest) | |
def update(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
cmd_args = make_command('pull', '-q', rev_options.to_args()) | |
self.run_command(cmd_args, cwd=dest) | |
@classmethod | |
def get_url_rev_and_auth(cls, url): | |
# type: (str) -> Tuple[str, Optional[str], AuthInfo] | |
# hotfix the URL scheme after removing bzr+ from bzr+ssh:// readd it | |
url, rev, user_pass = super(Bazaar, cls).get_url_rev_and_auth(url) | |
if url.startswith('ssh://'): | |
url = 'bzr+' + url | |
return url, rev, user_pass | |
@classmethod | |
def get_remote_url(cls, location): | |
urls = cls.run_command(['info'], show_stdout=False, cwd=location) | |
for line in urls.splitlines(): | |
line = line.strip() | |
for x in ('checkout of branch: ', | |
'parent branch: '): | |
if line.startswith(x): | |
repo = line.split(x)[1] | |
if cls._is_local_repository(repo): | |
return path_to_url(repo) | |
return repo | |
return None | |
@classmethod | |
def get_revision(cls, location): | |
revision = cls.run_command( | |
['revno'], show_stdout=False, cwd=location, | |
) | |
return revision.splitlines()[-1] | |
@classmethod | |
def is_commit_id_equal(cls, dest, name): | |
"""Always assume the versions don't match""" | |
return False | |
vcs.register(Bazaar) |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os.path | |
import re | |
from pip._vendor.packaging.version import parse as parse_version | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._vendor.six.moves.urllib import request as urllib_request | |
from pip._internal.exceptions import BadCommand, InstallationError | |
from pip._internal.utils.misc import display_path, hide_url | |
from pip._internal.utils.subprocess import make_command | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.vcs.versioncontrol import ( | |
RemoteNotFoundError, | |
VersionControl, | |
find_path_to_setup_from_repo_root, | |
vcs, | |
) | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Tuple | |
from pip._internal.utils.misc import HiddenText | |
from pip._internal.vcs.versioncontrol import AuthInfo, RevOptions | |
urlsplit = urllib_parse.urlsplit | |
urlunsplit = urllib_parse.urlunsplit | |
logger = logging.getLogger(__name__) | |
HASH_REGEX = re.compile('^[a-fA-F0-9]{40}$') | |
def looks_like_hash(sha): | |
return bool(HASH_REGEX.match(sha)) | |
class Git(VersionControl): | |
name = 'git' | |
dirname = '.git' | |
repo_name = 'clone' | |
schemes = ( | |
'git', 'git+http', 'git+https', 'git+ssh', 'git+git', 'git+file', | |
) | |
# Prevent the user's environment variables from interfering with pip: | |
# https://github.com/pypa/pip/issues/1130 | |
unset_environ = ('GIT_DIR', 'GIT_WORK_TREE') | |
default_arg_rev = 'HEAD' | |
@staticmethod | |
def get_base_rev_args(rev): | |
return [rev] | |
def is_immutable_rev_checkout(self, url, dest): | |
# type: (str, str) -> bool | |
_, rev_options = self.get_url_rev_options(hide_url(url)) | |
if not rev_options.rev: | |
return False | |
if not self.is_commit_id_equal(dest, rev_options.rev): | |
# the current commit is different from rev, | |
# which means rev was something else than a commit hash | |
return False | |
# return False in the rare case rev is both a commit hash | |
# and a tag or a branch; we don't want to cache in that case | |
# because that branch/tag could point to something else in the future | |
is_tag_or_branch = bool( | |
self.get_revision_sha(dest, rev_options.rev)[0] | |
) | |
return not is_tag_or_branch | |
def get_git_version(self): | |
VERSION_PFX = 'git version ' | |
version = self.run_command(['version'], show_stdout=False) | |
if version.startswith(VERSION_PFX): | |
version = version[len(VERSION_PFX):].split()[0] | |
else: | |
version = '' | |
# get first 3 positions of the git version because | |
# on windows it is x.y.z.windows.t, and this parses as | |
# LegacyVersion which always smaller than a Version. | |
version = '.'.join(version.split('.')[:3]) | |
return parse_version(version) | |
@classmethod | |
def get_current_branch(cls, location): | |
""" | |
Return the current branch, or None if HEAD isn't at a branch | |
(e.g. detached HEAD). | |
""" | |
# git-symbolic-ref exits with empty stdout if "HEAD" is a detached | |
# HEAD rather than a symbolic ref. In addition, the -q causes the | |
# command to exit with status code 1 instead of 128 in this case | |
# and to suppress the message to stderr. | |
args = ['symbolic-ref', '-q', 'HEAD'] | |
output = cls.run_command( | |
args, extra_ok_returncodes=(1, ), show_stdout=False, cwd=location, | |
) | |
ref = output.strip() | |
if ref.startswith('refs/heads/'): | |
return ref[len('refs/heads/'):] | |
return None | |
def export(self, location, url): | |
# type: (str, HiddenText) -> None | |
"""Export the Git repository at the url to the destination location""" | |
if not location.endswith('/'): | |
location = location + '/' | |
with TempDirectory(kind="export") as temp_dir: | |
self.unpack(temp_dir.path, url=url) | |
self.run_command( | |
['checkout-index', '-a', '-f', '--prefix', location], | |
show_stdout=False, cwd=temp_dir.path | |
) | |
@classmethod | |
def get_revision_sha(cls, dest, rev): | |
""" | |
Return (sha_or_none, is_branch), where sha_or_none is a commit hash | |
if the revision names a remote branch or tag, otherwise None. | |
Args: | |
dest: the repository directory. | |
rev: the revision name. | |
""" | |
# Pass rev to pre-filter the list. | |
output = cls.run_command(['show-ref', rev], cwd=dest, | |
show_stdout=False, on_returncode='ignore') | |
refs = {} | |
for line in output.strip().splitlines(): | |
try: | |
sha, ref = line.split() | |
except ValueError: | |
# Include the offending line to simplify troubleshooting if | |
# this error ever occurs. | |
raise ValueError('unexpected show-ref line: {!r}'.format(line)) | |
refs[ref] = sha | |
branch_ref = 'refs/remotes/origin/{}'.format(rev) | |
tag_ref = 'refs/tags/{}'.format(rev) | |
sha = refs.get(branch_ref) | |
if sha is not None: | |
return (sha, True) | |
sha = refs.get(tag_ref) | |
return (sha, False) | |
@classmethod | |
def resolve_revision(cls, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> RevOptions | |
""" | |
Resolve a revision to a new RevOptions object with the SHA1 of the | |
branch, tag, or ref if found. | |
Args: | |
rev_options: a RevOptions object. | |
""" | |
rev = rev_options.arg_rev | |
# The arg_rev property's implementation for Git ensures that the | |
# rev return value is always non-None. | |
assert rev is not None | |
sha, is_branch = cls.get_revision_sha(dest, rev) | |
if sha is not None: | |
rev_options = rev_options.make_new(sha) | |
rev_options.branch_name = rev if is_branch else None | |
return rev_options | |
# Do not show a warning for the common case of something that has | |
# the form of a Git commit hash. | |
if not looks_like_hash(rev): | |
logger.warning( | |
"Did not find branch or tag '%s', assuming revision or ref.", | |
rev, | |
) | |
if not rev.startswith('refs/'): | |
return rev_options | |
# If it looks like a ref, we have to fetch it explicitly. | |
cls.run_command( | |
make_command('fetch', '-q', url, rev_options.to_args()), | |
cwd=dest, | |
) | |
# Change the revision to the SHA of the ref we fetched | |
sha = cls.get_revision(dest, rev='FETCH_HEAD') | |
rev_options = rev_options.make_new(sha) | |
return rev_options | |
@classmethod | |
def is_commit_id_equal(cls, dest, name): | |
""" | |
Return whether the current commit hash equals the given name. | |
Args: | |
dest: the repository directory. | |
name: a string name. | |
""" | |
if not name: | |
# Then avoid an unnecessary subprocess call. | |
return False | |
return cls.get_revision(dest) == name | |
def fetch_new(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
rev_display = rev_options.to_display() | |
logger.info('Cloning %s%s to %s', url, rev_display, display_path(dest)) | |
self.run_command(make_command('clone', '-q', url, dest)) | |
if rev_options.rev: | |
# Then a specific revision was requested. | |
rev_options = self.resolve_revision(dest, url, rev_options) | |
branch_name = getattr(rev_options, 'branch_name', None) | |
if branch_name is None: | |
# Only do a checkout if the current commit id doesn't match | |
# the requested revision. | |
if not self.is_commit_id_equal(dest, rev_options.rev): | |
cmd_args = make_command( | |
'checkout', '-q', rev_options.to_args(), | |
) | |
self.run_command(cmd_args, cwd=dest) | |
elif self.get_current_branch(dest) != branch_name: | |
# Then a specific branch was requested, and that branch | |
# is not yet checked out. | |
track_branch = 'origin/{}'.format(branch_name) | |
cmd_args = [ | |
'checkout', '-b', branch_name, '--track', track_branch, | |
] | |
self.run_command(cmd_args, cwd=dest) | |
#: repo may contain submodules | |
self.update_submodules(dest) | |
def switch(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
self.run_command( | |
make_command('config', 'remote.origin.url', url), | |
cwd=dest, | |
) | |
cmd_args = make_command('checkout', '-q', rev_options.to_args()) | |
self.run_command(cmd_args, cwd=dest) | |
self.update_submodules(dest) | |
def update(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
# First fetch changes from the default remote | |
if self.get_git_version() >= parse_version('1.9.0'): | |
# fetch tags in addition to everything else | |
self.run_command(['fetch', '-q', '--tags'], cwd=dest) | |
else: | |
self.run_command(['fetch', '-q'], cwd=dest) | |
# Then reset to wanted revision (maybe even origin/master) | |
rev_options = self.resolve_revision(dest, url, rev_options) | |
cmd_args = make_command('reset', '--hard', '-q', rev_options.to_args()) | |
self.run_command(cmd_args, cwd=dest) | |
#: update submodules | |
self.update_submodules(dest) | |
@classmethod | |
def get_remote_url(cls, location): | |
""" | |
Return URL of the first remote encountered. | |
Raises RemoteNotFoundError if the repository does not have a remote | |
url configured. | |
""" | |
# We need to pass 1 for extra_ok_returncodes since the command | |
# exits with return code 1 if there are no matching lines. | |
stdout = cls.run_command( | |
['config', '--get-regexp', r'remote\..*\.url'], | |
extra_ok_returncodes=(1, ), show_stdout=False, cwd=location, | |
) | |
remotes = stdout.splitlines() | |
try: | |
found_remote = remotes[0] | |
except IndexError: | |
raise RemoteNotFoundError | |
for remote in remotes: | |
if remote.startswith('remote.origin.url '): | |
found_remote = remote | |
break | |
url = found_remote.split(' ')[1] | |
return url.strip() | |
@classmethod | |
def get_revision(cls, location, rev=None): | |
if rev is None: | |
rev = 'HEAD' | |
current_rev = cls.run_command( | |
['rev-parse', rev], show_stdout=False, cwd=location, | |
) | |
return current_rev.strip() | |
@classmethod | |
def get_subdirectory(cls, location): | |
""" | |
Return the path to setup.py, relative to the repo root. | |
Return None if setup.py is in the repo root. | |
""" | |
# find the repo root | |
git_dir = cls.run_command( | |
['rev-parse', '--git-dir'], | |
show_stdout=False, cwd=location).strip() | |
if not os.path.isabs(git_dir): | |
git_dir = os.path.join(location, git_dir) | |
repo_root = os.path.abspath(os.path.join(git_dir, '..')) | |
return find_path_to_setup_from_repo_root(location, repo_root) | |
@classmethod | |
def get_url_rev_and_auth(cls, url): | |
# type: (str) -> Tuple[str, Optional[str], AuthInfo] | |
""" | |
Prefixes stub URLs like 'user@hostname:user/repo.git' with 'ssh://'. | |
That's required because although they use SSH they sometimes don't | |
work with a ssh:// scheme (e.g. GitHub). But we need a scheme for | |
parsing. Hence we remove it again afterwards and return it as a stub. | |
""" | |
# Works around an apparent Git bug | |
# (see https://article.gmane.org/gmane.comp.version-control.git/146500) | |
scheme, netloc, path, query, fragment = urlsplit(url) | |
if scheme.endswith('file'): | |
initial_slashes = path[:-len(path.lstrip('/'))] | |
newpath = ( | |
initial_slashes + | |
urllib_request.url2pathname(path) | |
.replace('\\', '/').lstrip('/') | |
) | |
url = urlunsplit((scheme, netloc, newpath, query, fragment)) | |
after_plus = scheme.find('+') + 1 | |
url = scheme[:after_plus] + urlunsplit( | |
(scheme[after_plus:], netloc, newpath, query, fragment), | |
) | |
if '://' not in url: | |
assert 'file:' not in url | |
url = url.replace('git+', 'git+ssh://') | |
url, rev, user_pass = super(Git, cls).get_url_rev_and_auth(url) | |
url = url.replace('ssh://', '') | |
else: | |
url, rev, user_pass = super(Git, cls).get_url_rev_and_auth(url) | |
return url, rev, user_pass | |
@classmethod | |
def update_submodules(cls, location): | |
if not os.path.exists(os.path.join(location, '.gitmodules')): | |
return | |
cls.run_command( | |
['submodule', 'update', '--init', '--recursive', '-q'], | |
cwd=location, | |
) | |
@classmethod | |
def get_repository_root(cls, location): | |
loc = super(Git, cls).get_repository_root(location) | |
if loc: | |
return loc | |
try: | |
r = cls.run_command( | |
['rev-parse', '--show-toplevel'], | |
cwd=location, | |
show_stdout=False, | |
on_returncode='raise', | |
log_failed_cmd=False, | |
) | |
except BadCommand: | |
logger.debug("could not determine if %s is under git control " | |
"because git is not available", location) | |
return None | |
except InstallationError: | |
return None | |
return os.path.normpath(r.rstrip('\r\n')) | |
vcs.register(Git) |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
from pip._vendor.six.moves import configparser | |
from pip._internal.exceptions import BadCommand, InstallationError | |
from pip._internal.utils.misc import display_path | |
from pip._internal.utils.subprocess import make_command | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import path_to_url | |
from pip._internal.vcs.versioncontrol import ( | |
VersionControl, | |
find_path_to_setup_from_repo_root, | |
vcs, | |
) | |
if MYPY_CHECK_RUNNING: | |
from pip._internal.utils.misc import HiddenText | |
from pip._internal.vcs.versioncontrol import RevOptions | |
logger = logging.getLogger(__name__) | |
class Mercurial(VersionControl): | |
name = 'hg' | |
dirname = '.hg' | |
repo_name = 'clone' | |
schemes = ( | |
'hg', 'hg+file', 'hg+http', 'hg+https', 'hg+ssh', 'hg+static-http', | |
) | |
@staticmethod | |
def get_base_rev_args(rev): | |
return [rev] | |
def export(self, location, url): | |
# type: (str, HiddenText) -> None | |
"""Export the Hg repository at the url to the destination location""" | |
with TempDirectory(kind="export") as temp_dir: | |
self.unpack(temp_dir.path, url=url) | |
self.run_command( | |
['archive', location], show_stdout=False, cwd=temp_dir.path | |
) | |
def fetch_new(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
rev_display = rev_options.to_display() | |
logger.info( | |
'Cloning hg %s%s to %s', | |
url, | |
rev_display, | |
display_path(dest), | |
) | |
self.run_command(make_command('clone', '--noupdate', '-q', url, dest)) | |
self.run_command( | |
make_command('update', '-q', rev_options.to_args()), | |
cwd=dest, | |
) | |
def switch(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
repo_config = os.path.join(dest, self.dirname, 'hgrc') | |
config = configparser.RawConfigParser() | |
try: | |
config.read(repo_config) | |
config.set('paths', 'default', url.secret) | |
with open(repo_config, 'w') as config_file: | |
config.write(config_file) | |
except (OSError, configparser.NoSectionError) as exc: | |
logger.warning( | |
'Could not switch Mercurial repository to %s: %s', url, exc, | |
) | |
else: | |
cmd_args = make_command('update', '-q', rev_options.to_args()) | |
self.run_command(cmd_args, cwd=dest) | |
def update(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
self.run_command(['pull', '-q'], cwd=dest) | |
cmd_args = make_command('update', '-q', rev_options.to_args()) | |
self.run_command(cmd_args, cwd=dest) | |
@classmethod | |
def get_remote_url(cls, location): | |
url = cls.run_command( | |
['showconfig', 'paths.default'], | |
show_stdout=False, cwd=location).strip() | |
if cls._is_local_repository(url): | |
url = path_to_url(url) | |
return url.strip() | |
@classmethod | |
def get_revision(cls, location): | |
""" | |
Return the repository-local changeset revision number, as an integer. | |
""" | |
current_revision = cls.run_command( | |
['parents', '--template={rev}'], | |
show_stdout=False, cwd=location).strip() | |
return current_revision | |
@classmethod | |
def get_requirement_revision(cls, location): | |
""" | |
Return the changeset identification hash, as a 40-character | |
hexadecimal string | |
""" | |
current_rev_hash = cls.run_command( | |
['parents', '--template={node}'], | |
show_stdout=False, cwd=location).strip() | |
return current_rev_hash | |
@classmethod | |
def is_commit_id_equal(cls, dest, name): | |
"""Always assume the versions don't match""" | |
return False | |
@classmethod | |
def get_subdirectory(cls, location): | |
""" | |
Return the path to setup.py, relative to the repo root. | |
Return None if setup.py is in the repo root. | |
""" | |
# find the repo root | |
repo_root = cls.run_command( | |
['root'], show_stdout=False, cwd=location).strip() | |
if not os.path.isabs(repo_root): | |
repo_root = os.path.abspath(os.path.join(location, repo_root)) | |
return find_path_to_setup_from_repo_root(location, repo_root) | |
@classmethod | |
def get_repository_root(cls, location): | |
loc = super(Mercurial, cls).get_repository_root(location) | |
if loc: | |
return loc | |
try: | |
r = cls.run_command( | |
['root'], | |
cwd=location, | |
show_stdout=False, | |
on_returncode='raise', | |
log_failed_cmd=False, | |
) | |
except BadCommand: | |
logger.debug("could not determine if %s is under hg control " | |
"because hg is not available", location) | |
return None | |
except InstallationError: | |
return None | |
return os.path.normpath(r.rstrip('\r\n')) | |
vcs.register(Mercurial) |
# The following comment should be removed at some point in the future. | |
# mypy: disallow-untyped-defs=False | |
from __future__ import absolute_import | |
import logging | |
import os | |
import re | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import ( | |
display_path, | |
is_console_interactive, | |
rmtree, | |
split_auth_from_netloc, | |
) | |
from pip._internal.utils.subprocess import make_command | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.vcs.versioncontrol import VersionControl, vcs | |
_svn_xml_url_re = re.compile('url="([^"]+)"') | |
_svn_rev_re = re.compile(r'committed-rev="(\d+)"') | |
_svn_info_xml_rev_re = re.compile(r'\s*revision="(\d+)"') | |
_svn_info_xml_url_re = re.compile(r'<url>(.*)</url>') | |
if MYPY_CHECK_RUNNING: | |
from typing import Optional, Tuple | |
from pip._internal.utils.subprocess import CommandArgs | |
from pip._internal.utils.misc import HiddenText | |
from pip._internal.vcs.versioncontrol import AuthInfo, RevOptions | |
logger = logging.getLogger(__name__) | |
class Subversion(VersionControl): | |
name = 'svn' | |
dirname = '.svn' | |
repo_name = 'checkout' | |
schemes = ('svn', 'svn+ssh', 'svn+http', 'svn+https', 'svn+svn') | |
@classmethod | |
def should_add_vcs_url_prefix(cls, remote_url): | |
return True | |
@staticmethod | |
def get_base_rev_args(rev): | |
return ['-r', rev] | |
@classmethod | |
def get_revision(cls, location): | |
""" | |
Return the maximum revision for all files under a given location | |
""" | |
# Note: taken from setuptools.command.egg_info | |
revision = 0 | |
for base, dirs, files in os.walk(location): | |
if cls.dirname not in dirs: | |
dirs[:] = [] | |
continue # no sense walking uncontrolled subdirs | |
dirs.remove(cls.dirname) | |
entries_fn = os.path.join(base, cls.dirname, 'entries') | |
if not os.path.exists(entries_fn): | |
# FIXME: should we warn? | |
continue | |
dirurl, localrev = cls._get_svn_url_rev(base) | |
if base == location: | |
base = dirurl + '/' # save the root url | |
elif not dirurl or not dirurl.startswith(base): | |
dirs[:] = [] | |
continue # not part of the same svn tree, skip it | |
revision = max(revision, localrev) | |
return revision | |
@classmethod | |
def get_netloc_and_auth(cls, netloc, scheme): | |
""" | |
This override allows the auth information to be passed to svn via the | |
--username and --password options instead of via the URL. | |
""" | |
if scheme == 'ssh': | |
# The --username and --password options can't be used for | |
# svn+ssh URLs, so keep the auth information in the URL. | |
return super(Subversion, cls).get_netloc_and_auth(netloc, scheme) | |
return split_auth_from_netloc(netloc) | |
@classmethod | |
def get_url_rev_and_auth(cls, url): | |
# type: (str) -> Tuple[str, Optional[str], AuthInfo] | |
# hotfix the URL scheme after removing svn+ from svn+ssh:// readd it | |
url, rev, user_pass = super(Subversion, cls).get_url_rev_and_auth(url) | |
if url.startswith('ssh://'): | |
url = 'svn+' + url | |
return url, rev, user_pass | |
@staticmethod | |
def make_rev_args(username, password): | |
# type: (Optional[str], Optional[HiddenText]) -> CommandArgs | |
extra_args = [] # type: CommandArgs | |
if username: | |
extra_args += ['--username', username] | |
if password: | |
extra_args += ['--password', password] | |
return extra_args | |
@classmethod | |
def get_remote_url(cls, location): | |
# In cases where the source is in a subdirectory, not alongside | |
# setup.py we have to look up in the location until we find a real | |
# setup.py | |
orig_location = location | |
while not os.path.exists(os.path.join(location, 'setup.py')): | |
last_location = location | |
location = os.path.dirname(location) | |
if location == last_location: | |
# We've traversed up to the root of the filesystem without | |
# finding setup.py | |
logger.warning( | |
"Could not find setup.py for directory %s (tried all " | |
"parent directories)", | |
orig_location, | |
) | |
return None | |
return cls._get_svn_url_rev(location)[0] | |
@classmethod | |
def _get_svn_url_rev(cls, location): | |
from pip._internal.exceptions import InstallationError | |
entries_path = os.path.join(location, cls.dirname, 'entries') | |
if os.path.exists(entries_path): | |
with open(entries_path) as f: | |
data = f.read() | |
else: # subversion >= 1.7 does not have the 'entries' file | |
data = '' | |
if (data.startswith('8') or | |
data.startswith('9') or | |
data.startswith('10')): | |
data = list(map(str.splitlines, data.split('\n\x0c\n'))) | |
del data[0][0] # get rid of the '8' | |
url = data[0][3] | |
revs = [int(d[9]) for d in data if len(d) > 9 and d[9]] + [0] | |
elif data.startswith('<?xml'): | |
match = _svn_xml_url_re.search(data) | |
if not match: | |
raise ValueError( | |
'Badly formatted data: {data!r}'.format(**locals())) | |
url = match.group(1) # get repository URL | |
revs = [int(m.group(1)) for m in _svn_rev_re.finditer(data)] + [0] | |
else: | |
try: | |
# subversion >= 1.7 | |
# Note that using get_remote_call_options is not necessary here | |
# because `svn info` is being run against a local directory. | |
# We don't need to worry about making sure interactive mode | |
# is being used to prompt for passwords, because passwords | |
# are only potentially needed for remote server requests. | |
xml = cls.run_command( | |
['info', '--xml', location], | |
show_stdout=False, | |
) | |
url = _svn_info_xml_url_re.search(xml).group(1) | |
revs = [ | |
int(m.group(1)) for m in _svn_info_xml_rev_re.finditer(xml) | |
] | |
except InstallationError: | |
url, revs = None, [] | |
if revs: | |
rev = max(revs) | |
else: | |
rev = 0 | |
return url, rev | |
@classmethod | |
def is_commit_id_equal(cls, dest, name): | |
"""Always assume the versions don't match""" | |
return False | |
def __init__(self, use_interactive=None): | |
# type: (bool) -> None | |
if use_interactive is None: | |
use_interactive = is_console_interactive() | |
self.use_interactive = use_interactive | |
# This member is used to cache the fetched version of the current | |
# ``svn`` client. | |
# Special value definitions: | |
# None: Not evaluated yet. | |
# Empty tuple: Could not parse version. | |
self._vcs_version = None # type: Optional[Tuple[int, ...]] | |
super(Subversion, self).__init__() | |
def call_vcs_version(self): | |
# type: () -> Tuple[int, ...] | |
"""Query the version of the currently installed Subversion client. | |
:return: A tuple containing the parts of the version information or | |
``()`` if the version returned from ``svn`` could not be parsed. | |
:raises: BadCommand: If ``svn`` is not installed. | |
""" | |
# Example versions: | |
# svn, version 1.10.3 (r1842928) | |
# compiled Feb 25 2019, 14:20:39 on x86_64-apple-darwin17.0.0 | |
# svn, version 1.7.14 (r1542130) | |
# compiled Mar 28 2018, 08:49:13 on x86_64-pc-linux-gnu | |
version_prefix = 'svn, version ' | |
version = self.run_command(['--version'], show_stdout=False) | |
if not version.startswith(version_prefix): | |
return () | |
version = version[len(version_prefix):].split()[0] | |
version_list = version.split('.') | |
try: | |
parsed_version = tuple(map(int, version_list)) | |
except ValueError: | |
return () | |
return parsed_version | |
def get_vcs_version(self): | |
# type: () -> Tuple[int, ...] | |
"""Return the version of the currently installed Subversion client. | |
If the version of the Subversion client has already been queried, | |
a cached value will be used. | |
:return: A tuple containing the parts of the version information or | |
``()`` if the version returned from ``svn`` could not be parsed. | |
:raises: BadCommand: If ``svn`` is not installed. | |
""" | |
if self._vcs_version is not None: | |
# Use cached version, if available. | |
# If parsing the version failed previously (empty tuple), | |
# do not attempt to parse it again. | |
return self._vcs_version | |
vcs_version = self.call_vcs_version() | |
self._vcs_version = vcs_version | |
return vcs_version | |
def get_remote_call_options(self): | |
# type: () -> CommandArgs | |
"""Return options to be used on calls to Subversion that contact the server. | |
These options are applicable for the following ``svn`` subcommands used | |
in this class. | |
- checkout | |
- export | |
- switch | |
- update | |
:return: A list of command line arguments to pass to ``svn``. | |
""" | |
if not self.use_interactive: | |
# --non-interactive switch is available since Subversion 0.14.4. | |
# Subversion < 1.8 runs in interactive mode by default. | |
return ['--non-interactive'] | |
svn_version = self.get_vcs_version() | |
# By default, Subversion >= 1.8 runs in non-interactive mode if | |
# stdin is not a TTY. Since that is how pip invokes SVN, in | |
# call_subprocess(), pip must pass --force-interactive to ensure | |
# the user can be prompted for a password, if required. | |
# SVN added the --force-interactive option in SVN 1.8. Since | |
# e.g. RHEL/CentOS 7, which is supported until 2024, ships with | |
# SVN 1.7, pip should continue to support SVN 1.7. Therefore, pip | |
# can't safely add the option if the SVN version is < 1.8 (or unknown). | |
if svn_version >= (1, 8): | |
return ['--force-interactive'] | |
return [] | |
def export(self, location, url): | |
# type: (str, HiddenText) -> None | |
"""Export the svn repository at the url to the destination location""" | |
url, rev_options = self.get_url_rev_options(url) | |
logger.info('Exporting svn repository %s to %s', url, location) | |
with indent_log(): | |
if os.path.exists(location): | |
# Subversion doesn't like to check out over an existing | |
# directory --force fixes this, but was only added in svn 1.5 | |
rmtree(location) | |
cmd_args = make_command( | |
'export', self.get_remote_call_options(), | |
rev_options.to_args(), url, location, | |
) | |
self.run_command(cmd_args, show_stdout=False) | |
def fetch_new(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
rev_display = rev_options.to_display() | |
logger.info( | |
'Checking out %s%s to %s', | |
url, | |
rev_display, | |
display_path(dest), | |
) | |
cmd_args = make_command( | |
'checkout', '-q', self.get_remote_call_options(), | |
rev_options.to_args(), url, dest, | |
) | |
self.run_command(cmd_args) | |
def switch(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
cmd_args = make_command( | |
'switch', self.get_remote_call_options(), rev_options.to_args(), | |
url, dest, | |
) | |
self.run_command(cmd_args) | |
def update(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
cmd_args = make_command( | |
'update', self.get_remote_call_options(), rev_options.to_args(), | |
dest, | |
) | |
self.run_command(cmd_args) | |
vcs.register(Subversion) |
"""Handles all VCS (version control) support""" | |
from __future__ import absolute_import | |
import errno | |
import logging | |
import os | |
import shutil | |
import sys | |
from pip._vendor import pkg_resources | |
from pip._vendor.six.moves.urllib import parse as urllib_parse | |
from pip._internal.exceptions import BadCommand, InstallationError | |
from pip._internal.utils.compat import samefile | |
from pip._internal.utils.misc import ( | |
ask_path_exists, | |
backup_dir, | |
display_path, | |
hide_url, | |
hide_value, | |
rmtree, | |
) | |
from pip._internal.utils.subprocess import call_subprocess, make_command | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import get_url_scheme | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Dict, Iterable, Iterator, List, Mapping, Optional, Text, Tuple, | |
Type, Union | |
) | |
from pip._internal.cli.spinners import SpinnerInterface | |
from pip._internal.utils.misc import HiddenText | |
from pip._internal.utils.subprocess import CommandArgs | |
AuthInfo = Tuple[Optional[str], Optional[str]] | |
__all__ = ['vcs'] | |
logger = logging.getLogger(__name__) | |
def is_url(name): | |
# type: (Union[str, Text]) -> bool | |
""" | |
Return true if the name looks like a URL. | |
""" | |
scheme = get_url_scheme(name) | |
if scheme is None: | |
return False | |
return scheme in ['http', 'https', 'file', 'ftp'] + vcs.all_schemes | |
def make_vcs_requirement_url(repo_url, rev, project_name, subdir=None): | |
# type: (str, str, str, Optional[str]) -> str | |
""" | |
Return the URL for a VCS requirement. | |
Args: | |
repo_url: the remote VCS url, with any needed VCS prefix (e.g. "git+"). | |
project_name: the (unescaped) project name. | |
""" | |
egg_project_name = pkg_resources.to_filename(project_name) | |
req = '{}@{}#egg={}'.format(repo_url, rev, egg_project_name) | |
if subdir: | |
req += '&subdirectory={}'.format(subdir) | |
return req | |
def find_path_to_setup_from_repo_root(location, repo_root): | |
# type: (str, str) -> Optional[str] | |
""" | |
Find the path to `setup.py` by searching up the filesystem from `location`. | |
Return the path to `setup.py` relative to `repo_root`. | |
Return None if `setup.py` is in `repo_root` or cannot be found. | |
""" | |
# find setup.py | |
orig_location = location | |
while not os.path.exists(os.path.join(location, 'setup.py')): | |
last_location = location | |
location = os.path.dirname(location) | |
if location == last_location: | |
# We've traversed up to the root of the filesystem without | |
# finding setup.py | |
logger.warning( | |
"Could not find setup.py for directory %s (tried all " | |
"parent directories)", | |
orig_location, | |
) | |
return None | |
if samefile(repo_root, location): | |
return None | |
return os.path.relpath(location, repo_root) | |
class RemoteNotFoundError(Exception): | |
pass | |
class RevOptions(object): | |
""" | |
Encapsulates a VCS-specific revision to install, along with any VCS | |
install options. | |
Instances of this class should be treated as if immutable. | |
""" | |
def __init__( | |
self, | |
vc_class, # type: Type[VersionControl] | |
rev=None, # type: Optional[str] | |
extra_args=None, # type: Optional[CommandArgs] | |
): | |
# type: (...) -> None | |
""" | |
Args: | |
vc_class: a VersionControl subclass. | |
rev: the name of the revision to install. | |
extra_args: a list of extra options. | |
""" | |
if extra_args is None: | |
extra_args = [] | |
self.extra_args = extra_args | |
self.rev = rev | |
self.vc_class = vc_class | |
self.branch_name = None # type: Optional[str] | |
def __repr__(self): | |
# type: () -> str | |
return '<RevOptions {}: rev={!r}>'.format(self.vc_class.name, self.rev) | |
@property | |
def arg_rev(self): | |
# type: () -> Optional[str] | |
if self.rev is None: | |
return self.vc_class.default_arg_rev | |
return self.rev | |
def to_args(self): | |
# type: () -> CommandArgs | |
""" | |
Return the VCS-specific command arguments. | |
""" | |
args = [] # type: CommandArgs | |
rev = self.arg_rev | |
if rev is not None: | |
args += self.vc_class.get_base_rev_args(rev) | |
args += self.extra_args | |
return args | |
def to_display(self): | |
# type: () -> str | |
if not self.rev: | |
return '' | |
return ' (to revision {})'.format(self.rev) | |
def make_new(self, rev): | |
# type: (str) -> RevOptions | |
""" | |
Make a copy of the current instance, but with a new rev. | |
Args: | |
rev: the name of the revision for the new object. | |
""" | |
return self.vc_class.make_rev_options(rev, extra_args=self.extra_args) | |
class VcsSupport(object): | |
_registry = {} # type: Dict[str, VersionControl] | |
schemes = ['ssh', 'git', 'hg', 'bzr', 'sftp', 'svn'] | |
def __init__(self): | |
# type: () -> None | |
# Register more schemes with urlparse for various version control | |
# systems | |
urllib_parse.uses_netloc.extend(self.schemes) | |
# Python >= 2.7.4, 3.3 doesn't have uses_fragment | |
if getattr(urllib_parse, 'uses_fragment', None): | |
urllib_parse.uses_fragment.extend(self.schemes) | |
super(VcsSupport, self).__init__() | |
def __iter__(self): | |
# type: () -> Iterator[str] | |
return self._registry.__iter__() | |
@property | |
def backends(self): | |
# type: () -> List[VersionControl] | |
return list(self._registry.values()) | |
@property | |
def dirnames(self): | |
# type: () -> List[str] | |
return [backend.dirname for backend in self.backends] | |
@property | |
def all_schemes(self): | |
# type: () -> List[str] | |
schemes = [] # type: List[str] | |
for backend in self.backends: | |
schemes.extend(backend.schemes) | |
return schemes | |
def register(self, cls): | |
# type: (Type[VersionControl]) -> None | |
if not hasattr(cls, 'name'): | |
logger.warning('Cannot register VCS %s', cls.__name__) | |
return | |
if cls.name not in self._registry: | |
self._registry[cls.name] = cls() | |
logger.debug('Registered VCS backend: %s', cls.name) | |
def unregister(self, name): | |
# type: (str) -> None | |
if name in self._registry: | |
del self._registry[name] | |
def get_backend_for_dir(self, location): | |
# type: (str) -> Optional[VersionControl] | |
""" | |
Return a VersionControl object if a repository of that type is found | |
at the given directory. | |
""" | |
vcs_backends = {} | |
for vcs_backend in self._registry.values(): | |
repo_path = vcs_backend.get_repository_root(location) | |
if not repo_path: | |
continue | |
logger.debug('Determine that %s uses VCS: %s', | |
location, vcs_backend.name) | |
vcs_backends[repo_path] = vcs_backend | |
if not vcs_backends: | |
return None | |
# Choose the VCS in the inner-most directory. Since all repository | |
# roots found here would be either `location` or one of its | |
# parents, the longest path should have the most path components, | |
# i.e. the backend representing the inner-most repository. | |
inner_most_repo_path = max(vcs_backends, key=len) | |
return vcs_backends[inner_most_repo_path] | |
def get_backend_for_scheme(self, scheme): | |
# type: (str) -> Optional[VersionControl] | |
""" | |
Return a VersionControl object or None. | |
""" | |
for vcs_backend in self._registry.values(): | |
if scheme in vcs_backend.schemes: | |
return vcs_backend | |
return None | |
def get_backend(self, name): | |
# type: (str) -> Optional[VersionControl] | |
""" | |
Return a VersionControl object or None. | |
""" | |
name = name.lower() | |
return self._registry.get(name) | |
vcs = VcsSupport() | |
class VersionControl(object): | |
name = '' | |
dirname = '' | |
repo_name = '' | |
# List of supported schemes for this Version Control | |
schemes = () # type: Tuple[str, ...] | |
# Iterable of environment variable names to pass to call_subprocess(). | |
unset_environ = () # type: Tuple[str, ...] | |
default_arg_rev = None # type: Optional[str] | |
@classmethod | |
def should_add_vcs_url_prefix(cls, remote_url): | |
# type: (str) -> bool | |
""" | |
Return whether the vcs prefix (e.g. "git+") should be added to a | |
repository's remote url when used in a requirement. | |
""" | |
return not remote_url.lower().startswith('{}:'.format(cls.name)) | |
@classmethod | |
def get_subdirectory(cls, location): | |
# type: (str) -> Optional[str] | |
""" | |
Return the path to setup.py, relative to the repo root. | |
Return None if setup.py is in the repo root. | |
""" | |
return None | |
@classmethod | |
def get_requirement_revision(cls, repo_dir): | |
# type: (str) -> str | |
""" | |
Return the revision string that should be used in a requirement. | |
""" | |
return cls.get_revision(repo_dir) | |
@classmethod | |
def get_src_requirement(cls, repo_dir, project_name): | |
# type: (str, str) -> Optional[str] | |
""" | |
Return the requirement string to use to redownload the files | |
currently at the given repository directory. | |
Args: | |
project_name: the (unescaped) project name. | |
The return value has a form similar to the following: | |
{repository_url}@{revision}#egg={project_name} | |
""" | |
repo_url = cls.get_remote_url(repo_dir) | |
if repo_url is None: | |
return None | |
if cls.should_add_vcs_url_prefix(repo_url): | |
repo_url = '{}+{}'.format(cls.name, repo_url) | |
revision = cls.get_requirement_revision(repo_dir) | |
subdir = cls.get_subdirectory(repo_dir) | |
req = make_vcs_requirement_url(repo_url, revision, project_name, | |
subdir=subdir) | |
return req | |
@staticmethod | |
def get_base_rev_args(rev): | |
# type: (str) -> List[str] | |
""" | |
Return the base revision arguments for a vcs command. | |
Args: | |
rev: the name of a revision to install. Cannot be None. | |
""" | |
raise NotImplementedError | |
def is_immutable_rev_checkout(self, url, dest): | |
# type: (str, str) -> bool | |
""" | |
Return true if the commit hash checked out at dest matches | |
the revision in url. | |
Always return False, if the VCS does not support immutable commit | |
hashes. | |
This method does not check if there are local uncommitted changes | |
in dest after checkout, as pip currently has no use case for that. | |
""" | |
return False | |
@classmethod | |
def make_rev_options(cls, rev=None, extra_args=None): | |
# type: (Optional[str], Optional[CommandArgs]) -> RevOptions | |
""" | |
Return a RevOptions object. | |
Args: | |
rev: the name of a revision to install. | |
extra_args: a list of extra options. | |
""" | |
return RevOptions(cls, rev, extra_args=extra_args) | |
@classmethod | |
def _is_local_repository(cls, repo): | |
# type: (str) -> bool | |
""" | |
posix absolute paths start with os.path.sep, | |
win32 ones start with drive (like c:\\folder) | |
""" | |
drive, tail = os.path.splitdrive(repo) | |
return repo.startswith(os.path.sep) or bool(drive) | |
def export(self, location, url): | |
# type: (str, HiddenText) -> None | |
""" | |
Export the repository at the url to the destination location | |
i.e. only download the files, without vcs informations | |
:param url: the repository URL starting with a vcs prefix. | |
""" | |
raise NotImplementedError | |
@classmethod | |
def get_netloc_and_auth(cls, netloc, scheme): | |
# type: (str, str) -> Tuple[str, Tuple[Optional[str], Optional[str]]] | |
""" | |
Parse the repository URL's netloc, and return the new netloc to use | |
along with auth information. | |
Args: | |
netloc: the original repository URL netloc. | |
scheme: the repository URL's scheme without the vcs prefix. | |
This is mainly for the Subversion class to override, so that auth | |
information can be provided via the --username and --password options | |
instead of through the URL. For other subclasses like Git without | |
such an option, auth information must stay in the URL. | |
Returns: (netloc, (username, password)). | |
""" | |
return netloc, (None, None) | |
@classmethod | |
def get_url_rev_and_auth(cls, url): | |
# type: (str) -> Tuple[str, Optional[str], AuthInfo] | |
""" | |
Parse the repository URL to use, and return the URL, revision, | |
and auth info to use. | |
Returns: (url, rev, (username, password)). | |
""" | |
scheme, netloc, path, query, frag = urllib_parse.urlsplit(url) | |
if '+' not in scheme: | |
raise ValueError( | |
"Sorry, {!r} is a malformed VCS url. " | |
"The format is <vcs>+<protocol>://<url>, " | |
"e.g. svn+http://myrepo/svn/MyApp#egg=MyApp".format(url) | |
) | |
# Remove the vcs prefix. | |
scheme = scheme.split('+', 1)[1] | |
netloc, user_pass = cls.get_netloc_and_auth(netloc, scheme) | |
rev = None | |
if '@' in path: | |
path, rev = path.rsplit('@', 1) | |
if not rev: | |
raise InstallationError( | |
"The URL {!r} has an empty revision (after @) " | |
"which is not supported. Include a revision after @ " | |
"or remove @ from the URL.".format(url) | |
) | |
url = urllib_parse.urlunsplit((scheme, netloc, path, query, '')) | |
return url, rev, user_pass | |
@staticmethod | |
def make_rev_args(username, password): | |
# type: (Optional[str], Optional[HiddenText]) -> CommandArgs | |
""" | |
Return the RevOptions "extra arguments" to use in obtain(). | |
""" | |
return [] | |
def get_url_rev_options(self, url): | |
# type: (HiddenText) -> Tuple[HiddenText, RevOptions] | |
""" | |
Return the URL and RevOptions object to use in obtain() and in | |
some cases export(), as a tuple (url, rev_options). | |
""" | |
secret_url, rev, user_pass = self.get_url_rev_and_auth(url.secret) | |
username, secret_password = user_pass | |
password = None # type: Optional[HiddenText] | |
if secret_password is not None: | |
password = hide_value(secret_password) | |
extra_args = self.make_rev_args(username, password) | |
rev_options = self.make_rev_options(rev, extra_args=extra_args) | |
return hide_url(secret_url), rev_options | |
@staticmethod | |
def normalize_url(url): | |
# type: (str) -> str | |
""" | |
Normalize a URL for comparison by unquoting it and removing any | |
trailing slash. | |
""" | |
return urllib_parse.unquote(url).rstrip('/') | |
@classmethod | |
def compare_urls(cls, url1, url2): | |
# type: (str, str) -> bool | |
""" | |
Compare two repo URLs for identity, ignoring incidental differences. | |
""" | |
return (cls.normalize_url(url1) == cls.normalize_url(url2)) | |
def fetch_new(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
""" | |
Fetch a revision from a repository, in the case that this is the | |
first fetch from the repository. | |
Args: | |
dest: the directory to fetch the repository to. | |
rev_options: a RevOptions object. | |
""" | |
raise NotImplementedError | |
def switch(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
""" | |
Switch the repo at ``dest`` to point to ``URL``. | |
Args: | |
rev_options: a RevOptions object. | |
""" | |
raise NotImplementedError | |
def update(self, dest, url, rev_options): | |
# type: (str, HiddenText, RevOptions) -> None | |
""" | |
Update an already-existing repo to the given ``rev_options``. | |
Args: | |
rev_options: a RevOptions object. | |
""" | |
raise NotImplementedError | |
@classmethod | |
def is_commit_id_equal(cls, dest, name): | |
# type: (str, Optional[str]) -> bool | |
""" | |
Return whether the id of the current commit equals the given name. | |
Args: | |
dest: the repository directory. | |
name: a string name. | |
""" | |
raise NotImplementedError | |
def obtain(self, dest, url): | |
# type: (str, HiddenText) -> None | |
""" | |
Install or update in editable mode the package represented by this | |
VersionControl object. | |
:param dest: the repository directory in which to install or update. | |
:param url: the repository URL starting with a vcs prefix. | |
""" | |
url, rev_options = self.get_url_rev_options(url) | |
if not os.path.exists(dest): | |
self.fetch_new(dest, url, rev_options) | |
return | |
rev_display = rev_options.to_display() | |
if self.is_repository_directory(dest): | |
existing_url = self.get_remote_url(dest) | |
if self.compare_urls(existing_url, url.secret): | |
logger.debug( | |
'%s in %s exists, and has correct URL (%s)', | |
self.repo_name.title(), | |
display_path(dest), | |
url, | |
) | |
if not self.is_commit_id_equal(dest, rev_options.rev): | |
logger.info( | |
'Updating %s %s%s', | |
display_path(dest), | |
self.repo_name, | |
rev_display, | |
) | |
self.update(dest, url, rev_options) | |
else: | |
logger.info('Skipping because already up-to-date.') | |
return | |
logger.warning( | |
'%s %s in %s exists with URL %s', | |
self.name, | |
self.repo_name, | |
display_path(dest), | |
existing_url, | |
) | |
prompt = ('(s)witch, (i)gnore, (w)ipe, (b)ackup ', | |
('s', 'i', 'w', 'b')) | |
else: | |
logger.warning( | |
'Directory %s already exists, and is not a %s %s.', | |
dest, | |
self.name, | |
self.repo_name, | |
) | |
# https://github.com/python/mypy/issues/1174 | |
prompt = ('(i)gnore, (w)ipe, (b)ackup ', # type: ignore | |
('i', 'w', 'b')) | |
logger.warning( | |
'The plan is to install the %s repository %s', | |
self.name, | |
url, | |
) | |
response = ask_path_exists('What to do? {}'.format( | |
prompt[0]), prompt[1]) | |
if response == 'a': | |
sys.exit(-1) | |
if response == 'w': | |
logger.warning('Deleting %s', display_path(dest)) | |
rmtree(dest) | |
self.fetch_new(dest, url, rev_options) | |
return | |
if response == 'b': | |
dest_dir = backup_dir(dest) | |
logger.warning( | |
'Backing up %s to %s', display_path(dest), dest_dir, | |
) | |
shutil.move(dest, dest_dir) | |
self.fetch_new(dest, url, rev_options) | |
return | |
# Do nothing if the response is "i". | |
if response == 's': | |
logger.info( | |
'Switching %s %s to %s%s', | |
self.repo_name, | |
display_path(dest), | |
url, | |
rev_display, | |
) | |
self.switch(dest, url, rev_options) | |
def unpack(self, location, url): | |
# type: (str, HiddenText) -> None | |
""" | |
Clean up current location and download the url repository | |
(and vcs infos) into location | |
:param url: the repository URL starting with a vcs prefix. | |
""" | |
if os.path.exists(location): | |
rmtree(location) | |
self.obtain(location, url=url) | |
@classmethod | |
def get_remote_url(cls, location): | |
# type: (str) -> str | |
""" | |
Return the url used at location | |
Raises RemoteNotFoundError if the repository does not have a remote | |
url configured. | |
""" | |
raise NotImplementedError | |
@classmethod | |
def get_revision(cls, location): | |
# type: (str) -> str | |
""" | |
Return the current commit id of the files at the given location. | |
""" | |
raise NotImplementedError | |
@classmethod | |
def run_command( | |
cls, | |
cmd, # type: Union[List[str], CommandArgs] | |
show_stdout=True, # type: bool | |
cwd=None, # type: Optional[str] | |
on_returncode='raise', # type: str | |
extra_ok_returncodes=None, # type: Optional[Iterable[int]] | |
command_desc=None, # type: Optional[str] | |
extra_environ=None, # type: Optional[Mapping[str, Any]] | |
spinner=None, # type: Optional[SpinnerInterface] | |
log_failed_cmd=True # type: bool | |
): | |
# type: (...) -> Text | |
""" | |
Run a VCS subcommand | |
This is simply a wrapper around call_subprocess that adds the VCS | |
command name, and checks that the VCS is available | |
""" | |
cmd = make_command(cls.name, *cmd) | |
try: | |
return call_subprocess(cmd, show_stdout, cwd, | |
on_returncode=on_returncode, | |
extra_ok_returncodes=extra_ok_returncodes, | |
command_desc=command_desc, | |
extra_environ=extra_environ, | |
unset_environ=cls.unset_environ, | |
spinner=spinner, | |
log_failed_cmd=log_failed_cmd) | |
except OSError as e: | |
# errno.ENOENT = no such file or directory | |
# In other words, the VCS executable isn't available | |
if e.errno == errno.ENOENT: | |
raise BadCommand( | |
'Cannot find command {cls.name!r} - do you have ' | |
'{cls.name!r} installed and in your ' | |
'PATH?'.format(**locals())) | |
else: | |
raise # re-raise exception if a different error occurred | |
@classmethod | |
def is_repository_directory(cls, path): | |
# type: (str) -> bool | |
""" | |
Return whether a directory path is a repository directory. | |
""" | |
logger.debug('Checking in %s for %s (%s)...', | |
path, cls.dirname, cls.name) | |
return os.path.exists(os.path.join(path, cls.dirname)) | |
@classmethod | |
def get_repository_root(cls, location): | |
# type: (str) -> Optional[str] | |
""" | |
Return the "root" (top-level) directory controlled by the vcs, | |
or `None` if the directory is not in any. | |
It is meant to be overridden to implement smarter detection | |
mechanisms for specific vcs. | |
This can do more than is_repository_directory() alone. For | |
example, the Git override checks that Git is actually available. | |
""" | |
if cls.is_repository_directory(location): | |
return location | |
return None |
"""Orchestrator for building wheels from InstallRequirements. | |
""" | |
# The following comment should be removed at some point in the future. | |
# mypy: strict-optional=False | |
import logging | |
import os.path | |
import re | |
import shutil | |
from pip._internal.models.link import Link | |
from pip._internal.operations.build.wheel import build_wheel_pep517 | |
from pip._internal.operations.build.wheel_legacy import build_wheel_legacy | |
from pip._internal.utils.logging import indent_log | |
from pip._internal.utils.misc import ensure_dir, hash_file, is_wheel_installed | |
from pip._internal.utils.setuptools_build import make_setuptools_clean_args | |
from pip._internal.utils.subprocess import call_subprocess | |
from pip._internal.utils.temp_dir import TempDirectory | |
from pip._internal.utils.typing import MYPY_CHECK_RUNNING | |
from pip._internal.utils.urls import path_to_url | |
from pip._internal.vcs import vcs | |
if MYPY_CHECK_RUNNING: | |
from typing import ( | |
Any, Callable, Iterable, List, Optional, Pattern, Tuple, | |
) | |
from pip._internal.cache import WheelCache | |
from pip._internal.req.req_install import InstallRequirement | |
BinaryAllowedPredicate = Callable[[InstallRequirement], bool] | |
BuildResult = Tuple[List[InstallRequirement], List[InstallRequirement]] | |
logger = logging.getLogger(__name__) | |
def _contains_egg_info( | |
s, _egg_info_re=re.compile(r'([a-z0-9_.]+)-([a-z0-9_.!+-]+)', re.I)): | |
# type: (str, Pattern[str]) -> bool | |
"""Determine whether the string looks like an egg_info. | |
:param s: The string to parse. E.g. foo-2.1 | |
""" | |
return bool(_egg_info_re.search(s)) | |
def _should_build( | |
req, # type: InstallRequirement | |
need_wheel, # type: bool | |
check_binary_allowed, # type: BinaryAllowedPredicate | |
): | |
# type: (...) -> bool | |
"""Return whether an InstallRequirement should be built into a wheel.""" | |
if req.constraint: | |
# never build requirements that are merely constraints | |
return False | |
if req.is_wheel: | |
if need_wheel: | |
logger.info( | |
'Skipping %s, due to already being wheel.', req.name, | |
) | |
return False | |
if need_wheel: | |
# i.e. pip wheel, not pip install | |
return True | |
# From this point, this concerns the pip install command only | |
# (need_wheel=False). | |
if req.editable or not req.source_dir: | |
return False | |
if not check_binary_allowed(req): | |
logger.info( | |
"Skipping wheel build for %s, due to binaries " | |
"being disabled for it.", req.name, | |
) | |
return False | |
if not req.use_pep517 and not is_wheel_installed(): | |
# we don't build legacy requirements if wheel is not installed | |
logger.info( | |
"Using legacy setup.py install for %s, " | |
"since package 'wheel' is not installed.", req.name, | |
) | |
return False | |
return True | |
def should_build_for_wheel_command( | |
req, # type: InstallRequirement | |
): | |
# type: (...) -> bool | |
return _should_build( | |
req, need_wheel=True, check_binary_allowed=_always_true | |
) | |
def should_build_for_install_command( | |
req, # type: InstallRequirement | |
check_binary_allowed, # type: BinaryAllowedPredicate | |
): | |
# type: (...) -> bool | |
return _should_build( | |
req, need_wheel=False, check_binary_allowed=check_binary_allowed | |
) | |
def _should_cache( | |
req, # type: InstallRequirement | |
): | |
# type: (...) -> Optional[bool] | |
""" | |
Return whether a built InstallRequirement can be stored in the persistent | |
wheel cache, assuming the wheel cache is available, and _should_build() | |
has determined a wheel needs to be built. | |
""" | |
if not should_build_for_install_command( | |
req, check_binary_allowed=_always_true | |
): | |
# never cache if pip install would not have built | |
# (editable mode, etc) | |
return False | |
if req.link and req.link.is_vcs: | |
# VCS checkout. Do not cache | |
# unless it points to an immutable commit hash. | |
assert not req.editable | |
assert req.source_dir | |
vcs_backend = vcs.get_backend_for_scheme(req.link.scheme) | |
assert vcs_backend | |
if vcs_backend.is_immutable_rev_checkout(req.link.url, req.source_dir): | |
return True | |
return False | |
base, ext = req.link.splitext() | |
if _contains_egg_info(base): | |
return True | |
# Otherwise, do not cache. | |
return False | |
def _get_cache_dir( | |
req, # type: InstallRequirement | |
wheel_cache, # type: WheelCache | |
): | |
# type: (...) -> str | |
"""Return the persistent or temporary cache directory where the built | |
wheel need to be stored. | |
""" | |
cache_available = bool(wheel_cache.cache_dir) | |
if cache_available and _should_cache(req): | |
cache_dir = wheel_cache.get_path_for_link(req.link) | |
else: | |
cache_dir = wheel_cache.get_ephem_path_for_link(req.link) | |
return cache_dir | |
def _always_true(_): | |
# type: (Any) -> bool | |
return True | |
def _build_one( | |
req, # type: InstallRequirement | |
output_dir, # type: str | |
build_options, # type: List[str] | |
global_options, # type: List[str] | |
): | |
# type: (...) -> Optional[str] | |
"""Build one wheel. | |
:return: The filename of the built wheel, or None if the build failed. | |
""" | |
try: | |
ensure_dir(output_dir) | |
except OSError as e: | |
logger.warning( | |
"Building wheel for %s failed: %s", | |
req.name, e, | |
) | |
return None | |
# Install build deps into temporary directory (PEP 518) | |
with req.build_env: | |
return _build_one_inside_env( | |
req, output_dir, build_options, global_options | |
) | |
def _build_one_inside_env( | |
req, # type: InstallRequirement | |
output_dir, # type: str | |
build_options, # type: List[str] | |
global_options, # type: List[str] | |
): | |
# type: (...) -> Optional[str] | |
with TempDirectory(kind="wheel") as temp_dir: | |
if req.use_pep517: | |
wheel_path = build_wheel_pep517( | |
name=req.name, | |
backend=req.pep517_backend, | |
metadata_directory=req.metadata_directory, | |
build_options=build_options, | |
tempd=temp_dir.path, | |
) | |
else: | |
wheel_path = build_wheel_legacy( | |
name=req.name, | |
setup_py_path=req.setup_py_path, | |
source_dir=req.unpacked_source_directory, | |
global_options=global_options, | |
build_options=build_options, | |
tempd=temp_dir.path, | |
) | |
if wheel_path is not None: | |
wheel_name = os.path.basename(wheel_path) | |
dest_path = os.path.join(output_dir, wheel_name) | |
try: | |
wheel_hash, length = hash_file(wheel_path) | |
shutil.move(wheel_path, dest_path) | |
logger.info('Created wheel for %s: ' | |
'filename=%s size=%d sha256=%s', | |
req.name, wheel_name, length, | |
wheel_hash.hexdigest()) | |
logger.info('Stored in directory: %s', output_dir) | |
return dest_path | |
except Exception as e: | |
logger.warning( | |
"Building wheel for %s failed: %s", | |
req.name, e, | |
) | |
# Ignore return, we can't do anything else useful. | |
if not req.use_pep517: | |
_clean_one_legacy(req, global_options) | |
return None | |
def _clean_one_legacy(req, global_options): | |
# type: (InstallRequirement, List[str]) -> bool | |
clean_args = make_setuptools_clean_args( | |
req.setup_py_path, | |
global_options=global_options, | |
) | |
logger.info('Running setup.py clean for %s', req.name) | |
try: | |
call_subprocess(clean_args, cwd=req.source_dir) | |
return True | |
except Exception: | |
logger.error('Failed cleaning build dir for %s', req.name) | |
return False | |
def build( | |
requirements, # type: Iterable[InstallRequirement] | |
wheel_cache, # type: WheelCache | |
build_options, # type: List[str] | |
global_options, # type: List[str] | |
): | |
# type: (...) -> BuildResult | |
"""Build wheels. | |
:return: The list of InstallRequirement that succeeded to build and | |
the list of InstallRequirement that failed to build. | |
""" | |
if not requirements: | |
return [], [] | |
# Build the wheels. | |
logger.info( | |
'Building wheels for collected packages: %s', | |
', '.join(req.name for req in requirements), | |
) | |
with indent_log(): | |
build_successes, build_failures = [], [] | |
for req in requirements: | |
cache_dir = _get_cache_dir(req, wheel_cache) | |
wheel_file = _build_one( | |
req, cache_dir, build_options, global_options | |
) | |
if wheel_file: | |
# Update the link for this. | |
req.link = Link(path_to_url(wheel_file)) | |
req.local_file_path = req.link.file_path | |
assert req.link.is_wheel | |
build_successes.append(req) | |
else: | |
build_failures.append(req) | |
# notify success/failure | |
if build_successes: | |
logger.info( | |
'Successfully built %s', | |
' '.join([req.name for req in build_successes]), | |
) | |
if build_failures: | |
logger.info( | |
'Failed to build %s', | |
' '.join([req.name for req in build_failures]), | |
) | |
# Return a list of requirements that failed to build | |
return build_successes, build_failures |
""" | |
pip._vendor is for vendoring dependencies of pip to prevent needing pip to | |
depend on something external. | |
Files inside of pip._vendor should be considered immutable and should only be | |
updated to versions from upstream. | |
""" | |
from __future__ import absolute_import | |
import glob | |
import os.path | |
import sys | |
# Downstream redistributors which have debundled our dependencies should also | |
# patch this value to be true. This will trigger the additional patching | |
# to cause things like "six" to be available as pip. | |
DEBUNDLED = False | |
# By default, look in this directory for a bunch of .whl files which we will | |
# add to the beginning of sys.path before attempting to import anything. This | |
# is done to support downstream re-distributors like Debian and Fedora who | |
# wish to create their own Wheels for our dependencies to aid in debundling. | |
WHEEL_DIR = os.path.abspath(os.path.dirname(__file__)) | |
# Define a small helper function to alias our vendored modules to the real ones | |
# if the vendored ones do not exist. This idea of this was taken from | |
# https://github.com/kennethreitz/requests/pull/2567. | |
def vendored(modulename): | |
vendored_name = "{0}.{1}".format(__name__, modulename) | |
try: | |
__import__(modulename, globals(), locals(), level=0) | |
except ImportError: | |
# We can just silently allow import failures to pass here. If we | |
# got to this point it means that ``import pip._vendor.whatever`` | |
# failed and so did ``import whatever``. Since we're importing this | |
# upfront in an attempt to alias imports, not erroring here will | |
# just mean we get a regular import error whenever pip *actually* | |
# tries to import one of these modules to use it, which actually | |
# gives us a better error message than we would have otherwise | |
# gotten. | |
pass | |
else: | |
sys.modules[vendored_name] = sys.modules[modulename] | |
base, head = vendored_name.rsplit(".", 1) | |
setattr(sys.modules[base], head, sys.modules[modulename]) | |
# If we're operating in a debundled setup, then we want to go ahead and trigger | |
# the aliasing of our vendored libraries as well as looking for wheels to add | |
# to our sys.path. This will cause all of this code to be a no-op typically | |
# however downstream redistributors can enable it in a consistent way across | |
# all platforms. | |
if DEBUNDLED: | |
# Actually look inside of WHEEL_DIR to find .whl files and add them to the | |
# front of our sys.path. | |
sys.path[:] = glob.glob(os.path.join(WHEEL_DIR, "*.whl")) + sys.path | |
# Actually alias all of our vendored dependencies. | |
vendored("appdirs") | |
vendored("cachecontrol") | |
vendored("certifi") | |
vendored("colorama") | |
vendored("contextlib2") | |
vendored("distlib") | |
vendored("distro") | |
vendored("html5lib") | |
vendored("six") | |
vendored("six.moves") | |
vendored("six.moves.urllib") | |
vendored("six.moves.urllib.parse") | |
vendored("packaging") | |
vendored("packaging.version") | |
vendored("packaging.specifiers") | |
vendored("pep517") | |
vendored("pkg_resources") | |
vendored("progress") | |
vendored("retrying") | |
vendored("requests") | |
vendored("requests.exceptions") | |
vendored("requests.packages") | |
vendored("requests.packages.urllib3") | |
vendored("requests.packages.urllib3._collections") | |
vendored("requests.packages.urllib3.connection") | |
vendored("requests.packages.urllib3.connectionpool") | |
vendored("requests.packages.urllib3.contrib") | |
vendored("requests.packages.urllib3.contrib.ntlmpool") | |
vendored("requests.packages.urllib3.contrib.pyopenssl") | |
vendored("requests.packages.urllib3.exceptions") | |
vendored("requests.packages.urllib3.fields") | |
vendored("requests.packages.urllib3.filepost") | |
vendored("requests.packages.urllib3.packages") | |
vendored("requests.packages.urllib3.packages.ordered_dict") | |
vendored("requests.packages.urllib3.packages.six") | |
vendored("requests.packages.urllib3.packages.ssl_match_hostname") | |
vendored("requests.packages.urllib3.packages.ssl_match_hostname." | |
"_implementation") | |
vendored("requests.packages.urllib3.poolmanager") | |
vendored("requests.packages.urllib3.request") | |
vendored("requests.packages.urllib3.response") | |
vendored("requests.packages.urllib3.util") | |
vendored("requests.packages.urllib3.util.connection") | |
vendored("requests.packages.urllib3.util.request") | |
vendored("requests.packages.urllib3.util.response") | |
vendored("requests.packages.urllib3.util.retry") | |
vendored("requests.packages.urllib3.util.ssl_") | |
vendored("requests.packages.urllib3.util.timeout") | |
vendored("requests.packages.urllib3.util.url") | |
vendored("resolvelib") | |
vendored("toml") | |
vendored("toml.encoder") | |
vendored("toml.decoder") | |
vendored("urllib3") |
#!/usr/bin/env python | |
# -*- coding: utf-8 -*- | |
# Copyright (c) 2005-2010 ActiveState Software Inc. | |
# Copyright (c) 2013 Eddy Petrișor | |
"""Utilities for determining application-specific dirs. | |
See <http://github.com/ActiveState/appdirs> for details and usage. | |
""" | |
# Dev Notes: | |
# - MSDN on where to store app data files: | |
# http://support.microsoft.com/default.aspx?scid=kb;en-us;310294#XSLTH3194121123120121120120 | |
# - Mac OS X: http://developer.apple.com/documentation/MacOSX/Conceptual/BPFileSystem/index.html | |
# - XDG spec for Un*x: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html | |
__version_info__ = (1, 4, 3) | |
__version__ = '.'.join(map(str, __version_info__)) | |
import sys | |
import os | |
PY3 = sys.version_info[0] == 3 | |
if PY3: | |
unicode = str | |
if sys.platform.startswith('java'): | |
import platform | |
os_name = platform.java_ver()[3][0] | |
if os_name.startswith('Windows'): # "Windows XP", "Windows 7", etc. | |
system = 'win32' | |
elif os_name.startswith('Mac'): # "Mac OS X", etc. | |
system = 'darwin' | |
else: # "Linux", "SunOS", "FreeBSD", etc. | |
# Setting this to "linux2" is not ideal, but only Windows or Mac | |
# are actually checked for and the rest of the module expects | |
# *sys.platform* style strings. | |
system = 'linux2' | |
elif sys.platform == 'cli' and os.name == 'nt': | |
# Detect Windows in IronPython to match pip._internal.utils.compat.WINDOWS | |
# Discussion: <https://github.com/pypa/pip/pull/7501> | |
system = 'win32' | |
else: | |
system = sys.platform | |
def user_data_dir(appname=None, appauthor=None, version=None, roaming=False): | |
r"""Return full path to the user-specific data dir for this application. | |
"appname" is the name of application. | |
If None, just the system directory is returned. | |
"appauthor" (only used on Windows) is the name of the | |
appauthor or distributing body for this application. Typically | |
it is the owning company name. This falls back to appname. You may | |
pass False to disable it. | |
"version" is an optional version path element to append to the | |
path. You might want to use this if you want multiple versions | |
of your app to be able to run independently. If used, this | |
would typically be "<major>.<minor>". | |
Only applied when appname is present. | |
"roaming" (boolean, default False) can be set True to use the Windows | |
roaming appdata directory. That means that for users on a Windows | |
network setup for roaming profiles, this user data will be | |
sync'd on login. See | |
<http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx> | |
for a discussion of issues. | |
Typical user data directories are: | |
Mac OS X: ~/Library/Application Support/<AppName> # or ~/.config/<AppName>, if the other does not exist | |
Unix: ~/.local/share/<AppName> # or in $XDG_DATA_HOME, if defined | |
Win XP (not roaming): C:\Documents and Settings\<username>\Application Data\<AppAuthor>\<AppName> | |
Win XP (roaming): C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName> | |
Win 7 (not roaming): C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName> | |
Win 7 (roaming): C:\Users\<username>\AppData\Roaming\<AppAuthor>\<AppName> | |
For Unix, we follow the XDG spec and support $XDG_DATA_HOME. | |
That means, by default "~/.local/share/<AppName>". | |
""" | |
if system == "win32": | |
if appauthor is None: | |
appauthor = appname | |
const = roaming and "CSIDL_APPDATA" or "CSIDL_LOCAL_APPDATA" | |
path = os.path.normpath(_get_win_folder(const)) | |
if appname: | |
if appauthor is not False: | |
path = os.path.join(path, appauthor, appname) | |
else: | |
path = os.path.join(path, appname) | |
elif system == 'darwin': | |
path = os.path.expanduser('~/Library/Application Support/') | |
if appname: | |
path = os.path.join(path, appname) | |
else: | |
path = os.getenv('XDG_DATA_HOME', os.path.expanduser("~/.local/share")) | |
if appname: | |
path = os.path.join(path, appname) | |
if appname and version: | |
path = os.path.join(path, version) | |
return path | |
def site_data_dir(appname=None, appauthor=None, version=None, multipath=False): | |
r"""Return full path to the user-shared data dir for this application. | |
"appname" is the name of application. | |
If None, just the system directory is returned. | |
"appauthor" (only used on Windows) is the name of the | |
appauthor or distributing body for this application. Typically | |
it is the owning company name. This falls back to appname. You may | |
pass False to disable it. | |
"version" is an optional version path element to append to the | |
path. You might want to use this if you want multiple versions | |
of your app to be able to run independently. If used, this | |
would typically be "<major>.<minor>". | |
Only applied when appname is present. | |
"multipath" is an optional parameter only applicable to *nix | |
which indicates that the entire list of data dirs should be | |
returned. By default, the first item from XDG_DATA_DIRS is | |
returned, or '/usr/local/share/<AppName>', | |
if XDG_DATA_DIRS is not set | |
Typical site data directories are: | |
Mac OS X: /Library/Application Support/<AppName> | |
Unix: /usr/local/share/<AppName> or /usr/share/<AppName> | |
Win XP: C:\Documents and Settings\All Users\Application Data\<AppAuthor>\<AppName> | |
Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.) | |
Win 7: C:\ProgramData\<AppAuthor>\<AppName> # Hidden, but writeable on Win 7. | |
For Unix, this is using the $XDG_DATA_DIRS[0] default. | |
WARNING: Do not use this on Windows. See the Vista-Fail note above for why. | |
""" | |
if system == "win32": | |
if appauthor is None: | |
appauthor = appname | |
path = os.path.normpath(_get_win_folder("CSIDL_COMMON_APPDATA")) | |
if appname: | |
if appauthor is not False: | |
path = os.path.join(path, appauthor, appname) | |
else: | |
path = os.path.join(path, appname) | |
elif system == 'darwin': | |
path = os.path.expanduser('/Library/Application Support') | |
if appname: | |
path = os.path.join(path, appname) | |
else: | |
# XDG default for $XDG_DATA_DIRS | |
# only first, if multipath is False | |
path = os.getenv('XDG_DATA_DIRS', | |
os.pathsep.join(['/usr/local/share', '/usr/share'])) | |
pathlist = [os.path.expanduser(x.rstrip(os.sep)) for x in path.split(os.pathsep)] | |
if appname: | |
if version: | |
appname = os.path.join(appname, version) | |
pathlist = [os.path.join(x, appname) for x in pathlist] | |
if multipath: | |
path = os.pathsep.join(pathlist) | |
else: | |
path = pathlist[0] | |
return path | |
if appname and version: | |
path = os.path.join(path, version) | |
return path | |
def user_config_dir(appname=None, appauthor=None, version=None, roaming=False): | |
r"""Return full path to the user-specific config dir for this application. | |
"appname" is the name of application. | |
If None, just the system directory is returned. | |
"appauthor" (only used on Windows) is the name of the | |
appauthor or distributing body for this application. Typically | |
it is the owning company name. This falls back to appname. You may | |
pass False to disable it. | |
"version" is an optional version path element to append to the | |
path. You might want to use this if you want multiple versions | |
of your app to be able to run independently. If used, this | |
would typically be "<major>.<minor>". | |
Only applied when appname is present. | |
"roaming" (boolean, default False) can be set True to use the Windows | |
roaming appdata directory. That means that for users on a Windows | |
network setup for roaming profiles, this user data will be | |
sync'd on login. See | |
<http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx> | |
for a discussion of issues. | |
Typical user config directories are: | |
Mac OS X: same as user_data_dir | |
Unix: ~/.config/<AppName> # or in $XDG_CONFIG_HOME, if defined | |
Win *: same as user_data_dir | |
For Unix, we follow the XDG spec and support $XDG_CONFIG_HOME. | |
That means, by default "~/.config/<AppName>". | |
""" | |
if system in ["win32", "darwin"]: | |
path = user_data_dir(appname, appauthor, None, roaming) | |
else: | |
path = os.getenv('XDG_CONFIG_HOME', os.path.expanduser("~/.config")) | |
if appname: | |
path = os.path.join(path, appname) | |
if appname and version: | |
path = os.path.join(path, version) | |
return path | |
# for the discussion regarding site_config_dir locations | |
# see <https://github.com/pypa/pip/issues/1733> | |
def site_config_dir(appname=None, appauthor=None, version=None, multipath=False): | |
r"""Return full path to the user-shared data dir for this application. | |
"appname" is the name of application. | |
If None, just the system directory is returned. | |
"appauthor" (only used on Windows) is the name of the | |
appauthor or distributing body for this application. Typically | |
it is the owning company name. This falls back to appname. You may | |
pass False to disable it. | |
"version" is an optional version path element to append to the | |
path. You might want to use this if you want multiple versions | |
of your app to be able to run independently. If used, this | |
would typically be "<major>.<minor>". | |
Only applied when appname is present. | |
"multipath" is an optional parameter only applicable to *nix | |
which indicates that the entire list of config dirs should be | |
returned. By default, the first item from XDG_CONFIG_DIRS is | |
returned, or '/etc/xdg/<AppName>', if XDG_CONFIG_DIRS is not set | |
Typical site config directories are: | |
Mac OS X: same as site_data_dir | |
Unix: /etc/xdg/<AppName> or $XDG_CONFIG_DIRS[i]/<AppName> for each value in | |
$XDG_CONFIG_DIRS | |
Win *: same as site_data_dir | |
Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.) | |
For Unix, this is using the $XDG_CONFIG_DIRS[0] default, if multipath=False | |
WARNING: Do not use this on Windows. See the Vista-Fail note above for why. | |
""" | |
if system in ["win32", "darwin"]: | |
path = site_data_dir(appname, appauthor) | |
if appname and version: | |
path = os.path.join(path, version) | |
else: | |
# XDG default for $XDG_CONFIG_DIRS (missing or empty) | |
# see <https://github.com/pypa/pip/pull/7501#discussion_r360624829> | |
# only first, if multipath is False | |
path = os.getenv('XDG_CONFIG_DIRS') or '/etc/xdg' | |
pathlist = [os.path.expanduser(x.rstrip(os.sep)) for x in path.split(os.pathsep) if x] | |
if appname: | |
if version: | |
appname = os.path.join(appname, version) | |
pathlist = [os.path.join(x, appname) for x in pathlist] | |
if multipath: | |
path = os.pathsep.join(pathlist) | |
else: | |
path = pathlist[0] | |
return path | |
def user_cache_dir(appname=None, appauthor=None, version=None, opinion=True): | |
r"""Return full path to the user-specific cache dir for this application. | |
"appname" is the name of application. | |
If None, just the system directory is returned. | |
"appauthor" (only used on Windows) is the name of the | |
appauthor or distributing body for this application. Typically | |
it is the owning company name. This falls back to appname. You may | |
pass False to disable it. | |
"version" is an optional version path element to append to the | |
path. You might want to use this if you want multiple versions | |
of your app to be able to run independently. If used, this | |
would typically be "<major>.<minor>". | |
Only applied when appname is present. | |
"opinion" (boolean) can be False to disable the appending of | |
"Cache" to the base app data dir for Windows. See | |
discussion below. | |
Typical user cache directories are: | |
Mac OS X: ~/Library/Caches/<AppName> | |
Unix: ~/.cache/<AppName> (XDG default) | |
Win XP: C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>\Cache | |
Vista: C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>\Cache | |
On Windows the only suggestion in the MSDN docs is that local settings go in | |
the `CSIDL_LOCAL_APPDATA` directory. This is identical to the non-roaming | |
app data dir (the default returned by `user_data_dir` above). Apps typically | |
put cache data somewhere *under* the given dir here. Some examples: | |
...\Mozilla\Firefox\Profiles\<ProfileName>\Cache | |
...\Acme\SuperApp\Cache\1.0 | |
OPINION: This function appends "Cache" to the `CSIDL_LOCAL_APPDATA` value. | |
This can be disabled with the `opinion=False` option. | |
""" | |
if system == "win32": | |
if appauthor is None: | |
appauthor = appname | |
path = os.path.normpath(_get_win_folder("CSIDL_LOCAL_APPDATA")) | |
# When using Python 2, return paths as bytes on Windows like we do on | |
# other operating systems. See helper function docs for more details. | |
if not PY3 and isinstance(path, unicode): | |
path = _win_path_to_bytes(path) | |
if appname: | |
if appauthor is not False: | |
path = os.path.join(path, appauthor, appname) | |
else: | |
path = os.path.join(path, appname) | |
if opinion: | |
path = os.path.join(path, "Cache") | |
elif system == 'darwin': | |
path = os.path.expanduser('~/Library/Caches') | |
if appname: | |
path = os.path.join(path, appname) | |
else: | |
path = os.getenv('XDG_CACHE_HOME', os.path.expanduser('~/.cache')) | |
if appname: | |
path = os.path.join(path, appname) | |
if appname and version: | |
path = os.path.join(path, version) | |
return path | |
def user_state_dir(appname=None, appauthor=None, version=None, roaming=False): | |
r"""Return full path to the user-specific state dir for this application. | |
"appname" is the name of application. | |
If None, just the system directory is returned. | |
"appauthor" (only used on Windows) is the name of the | |
appauthor or distributing body for this application. Typically | |
it is the owning company name. This falls back to appname. You may | |
pass False to disable it. | |
"version" is an optional version path element to append to the | |
path. You might want to use this if you want multiple versions | |
of your app to be able to run independently. If used, this | |
would typically be "<major>.<minor>". | |
Only applied when appname is present. | |
"roaming" (boolean, default False) can be set True to use the Windows | |
roaming appdata directory. That means that for users on a Windows | |
network setup for roaming profiles, this user data will be | |
sync'd on login. See | |
<http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx> | |
for a discussion of issues. | |
Typical user state directories are: | |
Mac OS X: same as user_data_dir | |
Unix: ~/.local/state/<AppName> # or in $XDG_STATE_HOME, if defined | |
Win *: same as user_data_dir | |
For Unix, we follow this Debian proposal <https://wiki.debian.org/XDGBaseDirectorySpecification#state> | |
to extend the XDG spec and support $XDG_STATE_HOME. | |
That means, by default "~/.local/state/<AppName>". | |
""" | |
if system in ["win32", "darwin"]: | |
path = user_data_dir(appname, appauthor, None, roaming) | |
else: | |
path = os.getenv('XDG_STATE_HOME', os.path.expanduser("~/.local/state")) | |
if appname: | |
path = os.path.join(path, appname) | |
if appname and version: | |
path = os.path.join(path, version) | |
return path | |
def user_log_dir(appname=None, appauthor=None, version=None, opinion=True): | |
r"""Return full path to the user-specific log dir for this application. | |
"appname" is the name of application. | |
If None, just the system directory is returned. | |
"appauthor" (only used on Windows) is the name of the | |
appauthor or distributing body for this application. Typically | |
it is the owning company name. This falls back to appname. You may | |
pass False to disable it. | |
"version" is an optional version path element to append to the | |
path. You might want to use this if you want multiple versions | |
of your app to be able to run independently. If used, this | |
would typically be "<major>.<minor>". | |
Only applied when appname is present. | |
"opinion" (boolean) can be False to disable the appending of | |
"Logs" to the base app data dir for Windows, and "log" to the | |
base cache dir for Unix. See discussion below. | |
Typical user log directories are: | |
Mac OS X: ~/Library/Logs/<AppName> | |
Unix: ~/.cache/<AppName>/log # or under $XDG_CACHE_HOME if defined | |
Win XP: C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>\Logs | |
Vista: C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>\Logs | |
On Windows the only suggestion in the MSDN docs is that local settings | |
go in the `CSIDL_LOCAL_APPDATA` directory. (Note: I'm interested in | |
examples of what some windows apps use for a logs dir.) | |
OPINION: This function appends "Logs" to the `CSIDL_LOCAL_APPDATA` | |
value for Windows and appends "log" to the user cache dir for Unix. | |
This can be disabled with the `opinion=False` option. | |
""" | |
if system == "darwin": | |
path = os.path.join( | |
os.path.expanduser('~/Library/Logs'), | |
appname) | |
elif system == "win32": | |
path = user_data_dir(appname, appauthor, version) | |
version = False | |
if opinion: | |
path = os.path.join(path, "Logs") | |
else: | |
path = user_cache_dir(appname, appauthor, version) | |
version = False | |
if opinion: | |
path = os.path.join(path, "log") | |
if appname and version: | |
path = os.path.join(path, version) | |
return path | |
class AppDirs(object): | |
"""Convenience wrapper for getting application dirs.""" | |
def __init__(self, appname=None, appauthor=None, version=None, | |
roaming=False, multipath=False): | |
self.appname = appname | |
self.appauthor = appauthor | |
self.version = version | |
self.roaming = roaming | |
self.multipath = multipath | |
@property | |
def user_data_dir(self): | |
return user_data_dir(self.appname, self.appauthor, | |
version=self.version, roaming=self.roaming) | |
@property | |
def site_data_dir(self): | |
return site_data_dir(self.appname, self.appauthor, | |
version=self.version, multipath=self.multipath) | |
@property | |
def user_config_dir(self): | |
return user_config_dir(self.appname, self.appauthor, | |
version=self.version, roaming=self.roaming) | |
@property | |
def site_config_dir(self): | |
return site_config_dir(self.appname, self.appauthor, | |
version=self.version, multipath=self.multipath) | |
@property | |
def user_cache_dir(self): | |
return user_cache_dir(self.appname, self.appauthor, | |
version=self.version) | |
@property | |
def user_state_dir(self): | |
return user_state_dir(self.appname, self.appauthor, | |
version=self.version) | |
@property | |
def user_log_dir(self): | |
return user_log_dir(self.appname, self.appauthor, | |
version=self.version) | |
#---- internal support stuff | |
def _get_win_folder_from_registry(csidl_name): | |
"""This is a fallback technique at best. I'm not sure if using the | |
registry for this guarantees us the correct answer for all CSIDL_* | |
names. | |
""" | |
if PY3: | |
import winreg as _winreg | |
else: | |
import _winreg | |
shell_folder_name = { | |
"CSIDL_APPDATA": "AppData", | |
"CSIDL_COMMON_APPDATA": "Common AppData", | |
"CSIDL_LOCAL_APPDATA": "Local AppData", | |
}[csidl_name] | |
key = _winreg.OpenKey( | |
_winreg.HKEY_CURRENT_USER, | |
r"Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders" | |
) | |
dir, type = _winreg.QueryValueEx(key, shell_folder_name) | |
return dir | |
def _get_win_folder_with_pywin32(csidl_name): | |
from win32com.shell import shellcon, shell | |
dir = shell.SHGetFolderPath(0, getattr(shellcon, csidl_name), 0, 0) | |
# Try to make this a unicode path because SHGetFolderPath does | |
# not return unicode strings when there is unicode data in the | |
# path. | |
try: | |
dir = unicode(dir) | |
# Downgrade to short path name if have highbit chars. See | |
# <http://bugs.activestate.com/show_bug.cgi?id=85099>. | |
has_high_char = False | |
for c in dir: | |
if ord(c) > 255: | |
has_high_char = True | |
break | |
if has_high_char: | |
try: | |
import win32api | |
dir = win32api.GetShortPathName(dir) | |
except ImportError: | |
pass | |
except UnicodeError: | |
pass | |
return dir | |
def _get_win_folder_with_ctypes(csidl_name): | |
import ctypes | |
csidl_const = { | |
"CSIDL_APPDATA": 26, | |
"CSIDL_COMMON_APPDATA": 35, | |
"CSIDL_LOCAL_APPDATA": 28, | |
}[csidl_name] | |
buf = ctypes.create_unicode_buffer(1024) | |
ctypes.windll.shell32.SHGetFolderPathW(None, csidl_const, None, 0, buf) | |
# Downgrade to short path name if have highbit chars. See | |
# <http://bugs.activestate.com/show_bug.cgi?id=85099>. | |
has_high_char = False | |
for c in buf: | |
if ord(c) > 255: | |
has_high_char = True | |
break | |
if has_high_char: | |
buf2 = ctypes.create_unicode_buffer(1024) | |
if ctypes.windll.kernel32.GetShortPathNameW(buf.value, buf2, 1024): | |
buf = buf2 | |
return buf.value | |
def _get_ |
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)
(Sorry about that, but we can’t show files that are this big right now.)