From 0567c10d685b0ee25d629d9abe0692a23880811f Mon Sep 17 00:00:00 2001 From: Jeremy Fleischman Date: Wed, 2 May 2018 10:03:05 -0700 Subject: [PATCH] When formatting a requirement, only lowercase its name. This fixes https://github.com/pypa/pipenv/issues/2113. This bug was introduced in as a band-aid fix to . Pipenv then copied that code in , and inherited this latent bug. Maybe the right fix is for pypa/packaging to lowercase the name? There's a comment here about normalizing the requirement's name, which might be what this is referring to. To test this, I invented a new, very simple python package called `depends-on-marked-package`. The setup.py for this package is just: ```python import setuptools setuptools.setup( name="depends-on-marked-package", version="0.0.1", packages=setuptools.find_packages(), install_requires=['pytz; platform_python_implementation=="CPython"'], ) ``` This is a simplified version of gevent's setup.py's install_requires upon greenlet. --- pipenv/patched/piptools/utils.py | 32 +++++++++++++++++- tests/integration/test_install_markers.py | 20 +++++++++++ ..._marked_package-0.0.1-py2.py3-none-any.whl | Bin 0 -> 1215 bytes 3 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 tests/pypi/depends-on-marked-package/depends_on_marked_package-0.0.1-py2.py3-none-any.whl diff --git a/pipenv/patched/piptools/utils.py b/pipenv/patched/piptools/utils.py index db8bb9b3ff..f3de3dd376 100644 --- a/pipenv/patched/piptools/utils.py +++ b/pipenv/patched/piptools/utils.py @@ -58,6 +58,36 @@ def make_install_requirement(name, version, extras, markers, constraint=False): constraint=constraint) +def _requirement_to_str_lowercase_name(requirement): + """ + Formats a packaging.requirements.Requirement with a lowercase name. + + This is simply a copy of + https://github.com/pypa/packaging/blob/16.8/packaging/requirements.py#L109-L124 + modified to lowercase the dependency name. + + Previously, we were invoking the original Requirement.__str__ method and + lowercasing the entire result, which would lowercase the name, *and* other, + important stuff that should not be lowercased (such as the marker). See + this issue for more information: https://github.com/pypa/pipenv/issues/2113. + """ + parts = [requirement.name.lower()] + + if requirement.extras: + parts.append("[{0}]".format(",".join(sorted(requirement.extras)))) + + if requirement.specifier: + parts.append(str(requirement.specifier)) + + if requirement.url: + parts.append("@ {0}".format(requirement.url)) + + if requirement.marker: + parts.append("; {0}".format(requirement.marker)) + + return "".join(parts) + + def format_requirement(ireq, marker=None): """ Generic formatter for pretty printing InstallRequirements to the terminal @@ -66,7 +96,7 @@ def format_requirement(ireq, marker=None): if ireq.editable: line = '-e {}'.format(ireq.link) else: - line = str(ireq.req).lower() + line = _requirement_to_str_lowercase_name(ireq.req) if marker: line = '{}; {}'.format(line, marker) diff --git a/tests/integration/test_install_markers.py b/tests/integration/test_install_markers.py index 87235d4a7e..9e3fa1d27c 100644 --- a/tests/integration/test_install_markers.py +++ b/tests/integration/test_install_markers.py @@ -33,6 +33,26 @@ def test_package_environment_markers(PipenvInstance, pypi): c = p.pipenv('run python -c "import tablib;"') assert c.return_code == 1 +@pytest.mark.markers +@flaky +def test_platform_python_implementation_marker(PipenvInstance, pypi): + """Markers should be converted during locking to help users who input this incorrectly + """ + with PipenvInstance(pypi=pypi) as p: + with open(p.pipfile_path, 'w') as f: + contents = """ +[packages] +depends-on-marked-package = "*" + """.strip() + f.write(contents) + + c = p.pipenv('install') + assert c.return_code == 0 + + # depends-on-marked-package has an install_requires of 'pytz; platform_python_implementation=="CPython"' + # Verify that that marker shows up in our lockfile unaltered. + assert p.lockfile['default']['pytz']['markers'] == "platform_python_implementation == 'CPython'" + @pytest.mark.run @pytest.mark.alt diff --git a/tests/pypi/depends-on-marked-package/depends_on_marked_package-0.0.1-py2.py3-none-any.whl b/tests/pypi/depends-on-marked-package/depends_on_marked_package-0.0.1-py2.py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..d320deb3a4d39d987501a55af6abdc192c263cb4 GIT binary patch literal 1215 zcmWIWW@Zs#U|`^2SZJ`_XENJ$BW56v5s1x!I3=|pH7}(&K0hx$H?b%?H6^|vF*!Ri zJyq90&p^*mFD0|ML^m@pEnmMRzaTy*wJbG9ucV^nF%v@oin+o9f7;`L=H&sgK1t?= zd$_v#aG&?^J$sSYTUYDcne&^246YbIDDpq+t?Q+8Qh!sBhu29Ry-t1hm4O!wE*P6# zF~0JI>(qJui(hrF@oMOLojvKZDM&+8%l9dlr_c5vjTI)B&YnK+ebx8O>XuFkWtSaj zZrzZ`F0}&a#(zL;M3P&5T|*pQ977yq`)s)n8Hl)k|I>BBcBz${RR>>_RQIC3rx)#R zUwC#{MfTNt^Ny&(JwBkBj11|e+Rib`vj-ph-PpT_bxroP`U{VSjApmQ4&gIwmm zB#z6!qrH!RO#Zms;G}(V^3u~XR(B%A1*bfj>a(`?)8lFV9j1tr~mXAAW%R_r_y&$08-xgDp1%QF6)x|u!Ie|`S(42EZA#moWTj7%cTxU&i{ z#K2%lBZwk1j3CJpa4teO96g~U3}*o*0pfiCOZMpIqbDeY`F}_< YACkNRyjj^mCa?fu15m#vsGMQ|0Hc4WyZ`_I literal 0 HcmV?d00001