pipenv
pipenv copied to clipboard
pypa
Conda-specific compatibility note in documentation
I was attempting to help some visiting astronomers start using pipenv and ran into two problems with the instructions:
https://github.com/pypa/pipenv/blob/master/docs/advanced.rst#-pipenv-and-conda
The easy problem was that /path/to/anaconda… will not work if you simply copy and paste it but it's possible to miss that because while it prints “The path /foo/bar/baaz (from --python=/foo/bar/baaz) does not exist” that is buried under a lengthy traceback with the last thing people see being “TypeError: 'NoneType' object is not subscriptable”. Do you think it'd be worth a pull-request which would just end with the first message?
The more time-consuming problem was actually a Conda problem where the virtualenv creation failed with an error message early in the startup about being unable to import _io in the tempfile stdlib module, which was fixed at some point but hadn't been updated on their system. conda update python virtualenv fixed the problem but wasn't the first thing they were jumping to try. Should I contribute a brief note for the docs suggesting this more obviously?
@acdha that would be greatly appreciated -- that particular TypeError pretty much always means we couldn't find whatever your executable was, the additional information is not very helpful I would agree.
As far as the conda integration, I am not too familiar with the typical conda workflow but if you think this is a common issue I'd probably track it in the normal conda integration notes, whereas if you think it's less common it might belong in the troubleshooting documentation.
Thanks for letting us know about this and for helping out! These kinds of things always fall to the wayside but are incredibly important
I'll work on a pull request for the missing executables.
Re:Conda docs, I'm not sure I'd say it's common — I think it's the kind of situation where most people don't hit it but the ones who do can get really confused trying to search for a solution. I'll take a stab at proposing a doc update.
As an aside, it feels like the @click.option stack in cli.py has too many instances where common options are repeated. Is there a plan to split those out or should I take a stab at it?
@acdha the current plan has been focused on fixing testing infrastructure so I'm pretty sure this hasn't made it to anyone's priority list. I am very far from a click expert so my involvement with the stack in cli.py is basically minimal, if you're willing and able to consolidate we'd appreciate it for sure
@azizHakim Please be aware that the documentation is about to get major changes when this gets merged tomorrow: https://github.com/pypa/pipenv/pull/5621
Will greatly appreciate your help, but perhaps defer until after then :-)