Skip to content
This repository

Settle on a choice for $IPYTHONDIR #1167

Closed
fperez opened this Issue December 17, 2011 · 4 comments

3 participants

Fernando Perez Min RK Bradley M. Froehle
Fernando Perez
Owner

Our environment variable used to be called IPYTHONDIR, at some point we changed to IPYTHON_DIR, but now we have code using both. We should settle on only one, and issue a warning when we find the alternative in use. We shouldn't flat out remove the other for a long time, as I suspect by now both are used in the wild and this would be gratuitous breakage for the users.

From an informal scan of projects, IPYTHONDIR seems to be more commonly used, but we should check more carefully. We should settle on the version that we find to be in widest use, to minimize unnecessary hassles for users.

Min RK
Owner

I think the IPYTHON_DIR was added in 0.11, so it's only been around for 6 months. That form is more conventional, but I'm not sure this is something worth supporting redundancy and/or breaking historical consistency. I'd be fine with dropping the new name, and returning to the old one.

Fernando Perez
Owner

I've been scanning external projects that use IPython, and all of them use IPYTHONDIR (esp. since most were developed in the 0.10 days). While I also prefer the _ form, I do think this is unnecessary breakage of user code. I think it's ok that we break things when we absolutely must, but this one probably isn't needed.

Question: should we at least update the docs in 0.12 to mention IPYTHONDIR? I don't want to touch the actual code this late in the game, but since the code supports both, right now it's just a matter of steering our userbase in one direction or another from the documentation. If we're going to flip the order in 0.13 and add a warning, it would be good to point people towards the right option as early as possible.

Bradley M. Froehle
Collaborator

I think without the underscore is fine. It also matches Python's convention, which uses PYTHONPATH, PYTHONHOME, PYTHONSTARTUP, etc.

Fernando Perez
Owner
fperez commented May 02, 2012

I'm fine with IPYTHONDIR too. If anyone takes a stab at a PR, it should have:

  • warning on detecting the _ version in use
  • visible doc update both in the configuration section and in the what's new.
Min RK minrk closed this in dbeeefd May 04, 2012
Michael Hood michaelhood referenced this issue in barnybug/iboto September 22, 2012
Merged

Change IPYTHON_DIR to IPYTHONDIR. #1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.