[Py3] Remove package containing entry points names with colons #3434

montefra · 2016-01-29T16:39:38Z

Entry points names containing colons are legit, or at least pkg_resources can deal with them without any issue.

Unfortunately, in python 3 pip uninstall choke on them when removing a package.
This is because ConfigParser supports by defaults also the "INI" format, in which the delimiter is a colon. This is not a problem for python 2.

This PR force the delimiter to be only = to fix this issue.

I haven't add a test as now. I should have to dig into the test suite (which is huge).
In theory would be enough to add an entry point somewhere called e.g.:

entry:point = path.to.package:function

If someone would be so kind as to point me to the correct place to add it, I would be very happy to add it and check if everything is fine.

xavfernandez · 2016-01-31T21:45:48Z

@montefra good catch.

For the test, maybe the simplest would be to write a functional test like this one:

pip/tests/functional/test_uninstall.py

Lines 35 to 54 in b681665

    
           def test_simple_uninstall_distutils(script): 
        
               """ 
        
               Test simple install and uninstall. 
        
               """ 
        
               script.scratch_path.join("distutils_install").mkdir() 
        
               pkg_path = script.scratch_path / 'distutils_install' 
        
               pkg_path.join("setup.py").write(textwrap.dedent(""" 
        
                   from distutils.core import setup 
        
                   setup( 
        
                       name='distutils-install', 
        
                       version='0.1', 
        
                   ) 
        
               """)) 
        
               result = script.run('python', pkg_path / 'setup.py', 'install') 
        
               result = script.pip('list') 
        
               assert "distutils-install (0.1)" in result.stdout 
        
               script.pip('uninstall', 'distutils_install', '-y', expect_stderr=True) 
        
               result2 = script.pip('list') 
        
               assert "distutils-install (0.1)" not in result2.stdout

Where you can define the setup.py of your project with the problematic entry_point.

montefra · 2016-02-01T06:08:18Z

@xavfernandez: thank you for the pointer. I should commit the test soon.

montefra · 2016-02-01T09:57:07Z

I have added a test.
I've added pretend to the test_requires list to be able to run py.test.
Tox run through, except for py35:

  docs: commands succeeded
  packaging: commands succeeded
  pep8: commands succeeded
ERROR:   py3pep8: InterpreterNotFound: python3.3
ERROR:   py26: InterpreterNotFound: python2.6
  py27: commands succeeded
ERROR:   py33: InterpreterNotFound: python3.3
  py34: commands succeeded
ERROR:   py35: commands failed
ERROR:   pypy: InterpreterNotFound: pypy

Python 3.5 failed with an error which is probably fault of pytest e.g.:

ERROR collecting tests/functional/test_completion.py

.tox/py35/lib/python3.5/site-packages/py/_path/local.py:650: in pyimport
    __import__(modname)
<frozen importlib._bootstrap>:969: in _find_and_load
    ???
<frozen importlib._bootstrap>:954: in _find_and_load_unlocked
    ???
<frozen importlib._bootstrap>:892: in _find_spec
    ???
<frozen importlib._bootstrap>:873: in _find_spec_legacy
    ???
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:137: in find_module
    source_stat, co = _rewrite_test(state, fn_pypath)
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:278: in _rewrite_test
    rewrite_asserts(tree)
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:336: in rewrite_asserts
    AssertionRewriter().run(mod)
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:557: in run
    new.extend(self.visit(child))
/usr/lib/python3.5/ast.py:245: in visit
    return visitor(node)
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:665: in visit_Assert
    top_condition, explanation = self.visit(assert_.test)
/usr/lib/python3.5/ast.py:245: in visit
    return visitor(node)
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:796: in visit_Compare
    left_res, left_expl = self.visit(comp.left)
/usr/lib/python3.5/ast.py:245: in visit
    return visitor(node)
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:647: in generic_visit
    return res, self.explanation_param(self.display(res))
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:584: in display
    return self.helper("saferepr", expr)
.tox/py35/lib/python3.5/site-packages/_pytest/assertion/rewrite.py:590: in helper
    return ast.Call(attr, list(args), [], None, None)
E   TypeError: Call constructor takes either 0 or 3 positional arguments

xavfernandez · 2016-02-01T21:56:46Z

tests/functional/test_uninstall.py

+    result = script.pip('install', pkg_path)
+    result = script.pip('list')
+    assert "ep-install (0.1)" in result.stdout
+    script.pip('uninstall', 'ep_install', '-y', expect_stderr=True)


Is the expect_stderr=True needed ?

Given your question, I guess no.
Who does it work? If expect_stderr=False and there is standard error, raises an error?
In this case I remove it and recommit.

If expect_stderr=False and there is standard error, raises an error?

Yes exactly, it was needed in the distutils case, because pip prints a warning in such case.

xavfernandez · 2016-02-01T22:00:13Z

Yes the pytest issue is known: it is pinned to avoid this issue pytest-dev/pytest#1083 but would need to be bumped to work on python 3.5 ...

montefra · 2016-02-01T22:13:37Z

Ok. Thank you for the pytest pointer.

montefra · 2016-02-01T22:19:41Z

@xavfernandez : I've removed it. The test goes fine on my system.

If you accept the PR, do I have to do something else (changelog, other file, ...)?
Do you want me to rebase the branch?

xavfernandez · 2016-02-01T22:23:08Z

Well a changelog would make my life easier ^^
cf https://github.com/pypa/pip/blob/develop/CHANGES.txt

The rebase is optional since there is no conflict.

montefra · 2016-02-01T22:25:57Z

@xavfernandez : I'll add an entry under **8.1.0 (unreleased)** tomorrow.

If I see that tomorrow there are conflicts, I'll rebase.

Good night

xavfernandez · 2016-02-01T22:49:47Z

@montefra thanks :)

montefra · 2016-02-02T07:59:36Z

@xavfernandez : done.

I hope that everything is fine.

xavfernandez · 2016-02-02T12:15:43Z

pip/req/req_install.py

+            if six.PY2:
+                options = {}
+            else:
+                options = {"delimiters": ('=')}


I think you meant ('=',).
Sorry I did not spot this before...

of course... Me dumm! I'm not used to use tuples. Thank for spotting it. Committing

montefra · 2016-02-02T12:50:05Z

@xavfernandez I'm about to rebase and push the commit

montefra · 2016-02-02T12:53:31Z

@xavfernandez : rebase done

[Py3] Remove package containing entry points names with colons

xavfernandez · 2016-02-02T13:39:44Z

Thanks for your patience :)

montefra · 2016-02-02T14:08:19Z

thank for accepting the PR and mostly thankd for pip.

[Py3] Remove package containing entry points names with colons

xavfernandez added the needstest label Jan 31, 2016

xavfernandez reviewed Feb 1, 2016
View reviewed changes

xavfernandez reviewed Feb 2, 2016
View reviewed changes

montefra added 6 commits February 2, 2016 13:50

Use "=" as the sole delimiter when parsing the entry point dictionary

059481c

Add pretend to list of test_requires

f469410

test uninstall of entry points with colons in name

a5a9c21

no need for expect_stderr

ab9c66e

Add Changelog entry

ba61855

Fix delimiter tuple

3c85765

montefra force-pushed the fix_uninstall_colon branch from dc33b20 to 3c85765 Compare February 2, 2016 12:52

xavfernandez added a commit that referenced this pull request Feb 2, 2016

Merge pull request #3434 from montefra/fix_uninstall_colon

3455016

[Py3] Remove package containing entry points names with colons

xavfernandez merged commit 3455016 into pypa:develop Feb 2, 2016

montefra deleted the fix_uninstall_colon branch February 2, 2016 14:08

xavfernandez removed the needstest label Feb 8, 2016

xavfernandez added this to the 8.0.3 milestone Feb 8, 2016

xavfernandez added a commit to xavfernandez/pip that referenced this pull request Feb 24, 2016

Merge pull request pypa#3434 from montefra/fix_uninstall_colon

f2b201d

[Py3] Remove package containing entry points names with colons

montefra mentioned this pull request Aug 9, 2016

Allow pip install with entrypoint names with colons #3901

Merged

lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 3, 2019

lock bot locked as resolved and limited conversation to collaborators Jun 3, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Py3] Remove package containing entry points names with colons #3434

[Py3] Remove package containing entry points names with colons #3434

montefra commented Jan 29, 2016

xavfernandez commented Jan 31, 2016

montefra commented Feb 1, 2016

montefra commented Feb 1, 2016

xavfernandez Feb 1, 2016

montefra Feb 1, 2016

xavfernandez Feb 1, 2016

xavfernandez commented Feb 1, 2016

montefra commented Feb 1, 2016

montefra commented Feb 1, 2016

xavfernandez commented Feb 1, 2016

montefra commented Feb 1, 2016

xavfernandez commented Feb 1, 2016

montefra commented Feb 2, 2016

xavfernandez Feb 2, 2016

montefra Feb 2, 2016

montefra commented Feb 2, 2016

montefra commented Feb 2, 2016

xavfernandez commented Feb 2, 2016

montefra commented Feb 2, 2016

[Py3] Remove package containing entry points names with colons #3434

[Py3] Remove package containing entry points names with colons #3434

Conversation

montefra commented Jan 29, 2016

xavfernandez commented Jan 31, 2016

montefra commented Feb 1, 2016

montefra commented Feb 1, 2016

xavfernandez Feb 1, 2016

Choose a reason for hiding this comment

montefra Feb 1, 2016

Choose a reason for hiding this comment

xavfernandez Feb 1, 2016

Choose a reason for hiding this comment

xavfernandez commented Feb 1, 2016

montefra commented Feb 1, 2016

montefra commented Feb 1, 2016

xavfernandez commented Feb 1, 2016

montefra commented Feb 1, 2016

xavfernandez commented Feb 1, 2016

montefra commented Feb 2, 2016

xavfernandez Feb 2, 2016

Choose a reason for hiding this comment

montefra Feb 2, 2016

Choose a reason for hiding this comment

montefra commented Feb 2, 2016

montefra commented Feb 2, 2016

xavfernandez commented Feb 2, 2016

montefra commented Feb 2, 2016