Pip isn't accounting for Setuptool's requirement extras

[vbabiy]

Pip's requirements parsing doesn't appear to recognize declared extras.[0] These are supposed to be used in Setuptools to provide a way to list dependencies for a particular feature.

Repeatable through the following:

$ pip install "zope.testbrowser [zope_functional_testing]"

In the above 'zope.app.testing' should have been pulled in as a dependency, because of the extra declaration in the requirements line.

Another example would be "zope.i18n [zcml]".

[0] http://peak.telecommunity.com/DevCenter/setuptools#declaring-extras-optional-features-with-their-own-dependencies

---

• Bitbucket: https://bitbucket.org/ianb/pip/issue/170
• Originally Reported By: Michael Mulich
• Originally Created At: 2010-09-27 22:20:34

[vbabiy]

Hmm, no comment?

Is supporting this planned? Is its missing considered a bug? Is there some
other way?

---

Original Comment By: Thomas Waldmann

[vbabiy]

This is also an issue for me. I started digging into the pip code a little
bit, but I'm not sure what the correct fix is.

---

Original Comment By: Dan Sully

[vbabiy]

maybe this will do it:
https://bitbucket.org/MattMaker/pip/changeset/9144e997b918

---

Original Comment By: MattMaker

[MatthewMaker]

Made some adjustments to my proposed patch, see see https://bitbucket.org/MattMaker/pip/changeset/4a967b7de7ad and https://bitbucket.org/MattMaker/pip/changeset/9c681d36b768 . Now it works with uninstalling too! (oops :) )

[dsully]

Matthew - can you fork the new pip repo on GitHub and send a pull request for your changes?

Thanks

[MatthewMaker]

forked, retested, and pull requested!

[carljm]

Fixed. Thanks @MatthewMaker for the patch, and @ssaboum for adding tests.

[poswald]

Just a quick question about this... I don't think it is documented at all and I think it should be, probably in the requirements.txt section. My question is.. does this work in all places where you could use install before? I usually tested things out locally by running pip install . while in the working directory of my project.

I added this to my setup.py:

extras_require = {
    'django':  ['Django<1.4',],
}

... but now I don't see how I could install it. I tried pip install ". [django]" with no luck. Is this format supported? Is putting something like my project [django] in a requirements.txt supported? Should I open this as a new issue?

[carljm]

@poswald Thanks for noting the lack of documentation - if you'd be willing to open an issue for that (or better, a pull request!) that'd be great.

As for the format, using myproject[extra] either from commandline or requirements file should certainly work. And from my reading of InstallRequirement.from_file and InstallRequirement.__init__ (in pip/reqs.py), it appears that extras can also be referenced from the #egg= fragment of a URL requirement (e.g. http://somesite/somepackage.tgz#egg=somepackage[extra]), though I haven't tested this. And this should also work with a local file:// URL to a directory, which might cover your use case. In any case, some experimentation here and documentation of what you find would definitely be helpful. If there are obvious gaps in the functionality, filing bugs for them would make sense (though personally I think supporting file:// URLs with an #egg= fragment is adequate, we don't need to support .[extra] - that just reads wierd.)

[poswald]

There's the documentation for it in the requirements.txt file. I only use the .[extra] format because it works and I wasn't aware that the file:/// was working.

I'll play around and open any issues if I see it isn't working as expected. Thanks!

[carljm]

Oh - I was under the impression from your previous comment that .[extra] didn't work. If it already works, great :-)