adds option to ignore TCL/Tk framework installs on OS X #1768

ddale · 2016-03-14T17:49:54Z

Fixes issue #950. Pillow's setup.py file incorrectly assumes if you are on OS X, you must link with a TCL/TK framework installation. Some OS X python installations (Anaconda, for example) provide their own TCL/TK installation, which results in segfaults when Pillow tries to load _imagingtk (usually observed with a call to PhotoImage). A simple mechanism is needed to instruct Pillow's setup.py file to not use the the TCL/TK Frameworks installations on OS X. This pull request provides an environment variable IGNORE_OSX_TCLTK_FRAMEWORKS which, if defined, allows setup.py to build against non-frameworks installations of TCL/TK.

hugovk · 2016-03-14T19:45:50Z

Does Anaconda define IGNORE_OSX_TCLTK_FRAMEWORKS? If not, should we ask them to? Or is there a suitable env var they already define?

ddale · 2016-03-14T19:55:53Z

Recipes for conda packages include a simple build.sh (or on windows bld.bat) script, which for trivial python packages simply contain:

$PYTHON setup.py install

The conda recipe build.sh for Pillow would simply be modified:

export IGNORE_OSX_TCLTK_FRAMEWORKS=1
$PYTHON setup.py install

I also submitted a post alerting the anaconda mailing list to this pull request, and one of the developers responded on the list that this would be a good improvement.

wiredfool · 2016-03-14T20:02:10Z

How does anaconda deal with the dynamic load at runtime if there are the two different libraries on the system?

ddale · 2016-03-14T21:23:41Z

If I install Anaconda to /opt/conda, and I run "conda install tk", it installs its own tk libraries to the /opt/conda prefix. Anaconda is configured to search this location first.

aclark4life · 2016-03-14T21:51:46Z

@ddale Definitely interested in supporting Anaconda but not convinced this is the right approach. How about a --disable-osx-tclk-framework flag? https://github.com/ddale/Pillow/blob/e9c4ee33543421130140de5ecdd3eb034a9a0649/setup.py#L123

ddale · 2016-03-14T22:05:37Z

@aclark4life I like your solution. That would work just fine for Anaconda.

aclark4life · 2016-03-14T22:08:14Z

@ddale Great! If you update your PR then we'll merge (assuming no other concerns from the @python-pillow/pillow-team )

ddale · 2016-03-14T22:13:24Z

I realize now though that I don't completely understand how to change my pull request to make use of a --disable-osx-tcltk-framework flag.

hugovk · 2016-03-14T22:15:08Z

If you want to change a PR, just commit and push into your own osx-no-tk-framework branch and this PR'll be automatically updated.

aclark4life · 2016-03-14T22:15:19Z

@ddale Try adding additional commits to your fork, else I can close this one and you can open another PR.

wiredfool · 2016-03-14T22:15:46Z

Looking at this, I'm not actually understanding how the Tcl/Tk actually work on OSX.

By the time we get to

Pillow/setup.py

Line 490 in e9c4ee3

feature.tk = "tk" + TCL_VERSION

, we've found Tcl/Tk, but I don't think we've looked in any of the /Library or /System/Library directories.

We then later go through around line

Pillow/setup.py

Line 589 in e9c4ee3

"/System/Library/Frameworks"]

we search those directories, as long as we've already found those libraries.

ddale · 2016-03-14T22:18:48Z

@aclark4life what I meant was, I don't understand how --disable-x gets propagated to what variable that I should use in the code.

aclark4life · 2016-03-14T22:22:59Z

@ddale I was picturing the disable flag could set a boolean that could then be checked where your environment check currently occurs. But it sounds like we need to sort out some bigger picture issues @wiredfool raised first.

ddale · 2016-03-14T22:23:14Z

@wiredfool I also don't understand why, on os x, after having found TCL/TK, when it is finally time to actually configure the extension module, pillow switches gears and searches for frameworks.

aclark4life · 2016-03-14T22:39:22Z

@wiredfool Possibly because symlinks from /usr/include?:

~/.../pillow/Pillow $ ll /usr/include/{tcl,tk}*
lrwxr-xr-x  1 root  wheel    72B Dec  9 14:30 /usr/include/tcl.h@ -> ../../System/Library/Frameworks/Tcl.framework/Versions/8.5/Headers/tcl.h
lrwxr-xr-x  1 root  wheel    77B Dec  9 14:30 /usr/include/tclDecls.h@ -> ../../System/Library/Frameworks/Tcl.framework/Versions/8.5/Headers/tclDecls.h
lrwxr-xr-x  1 root  wheel    81B Dec  9 14:30 /usr/include/tclPlatDecls.h@ -> ../../System/Library/Frameworks/Tcl.framework/Versions/8.5/Headers/tclPlatDecls.h
lrwxr-xr-x  1 root  wheel    79B Dec  9 14:30 /usr/include/tclTomMath.h@ -> ../../System/Library/Frameworks/Tcl.framework/Versions/8.5/Headers/tclTomMath.h
lrwxr-xr-x  1 root  wheel    84B Dec  9 14:30 /usr/include/tclTomMathDecls.h@ -> ../../System/Library/Frameworks/Tcl.framework/Versions/8.5/Headers/tclTomMathDecls.h
lrwxr-xr-x  1 root  wheel    70B Dec  9 14:30 /usr/include/tk.h@ -> ../../System/Library/Frameworks/Tk.framework/Versions/8.5/Headers/tk.h
lrwxr-xr-x  1 root  wheel    75B Dec  9 14:30 /usr/include/tkDecls.h@ -> ../../System/Library/Frameworks/Tk.framework/Versions/8.5/Headers/tkDecls.h
lrwxr-xr-x  1 root  wheel    82B Dec  9 14:30 /usr/include/tkIntXlibDecls.h@ -> ../../System/Library/Frameworks/Tk.framework/Versions/8.5/Headers/tkIntXlibDecls.h
lrwxr-xr-x  1 root  wheel    76B Dec  9 14:30 /usr/include/tkMacOSX.h@ -> ../../System/Library/Frameworks/Tk.framework/Versions/8.5/Headers/tkMacOSX.h
lrwxr-xr-x  1 root  wheel    79B Dec  9 14:30 /usr/include/tkPlatDecls.h@ -> ../../System/Library/Frameworks/Tk.framework/Versions/8.5/Headers/tkPlatDecls.h

@ddale It would not be surprising at all to discover redundancy and/or bad logic in Pillow's setup.py, unfortunately …

wiredfool · 2016-03-15T18:54:41Z

Right, so there are symlinks from /usr/lib and /usr/include into the OSX frameworks. In the absence of the framework path, these get linked anyway, as /usr/lib is one of the standard locations we look at.

If we disable that stanza completely, I still get a valid build on the mac (mavericks):

        if feature.tcl and feature.tk:
            if (False and sys.platform == "darwin" and
                os.environ.get('IGNORE_OSX_TCLTK_FRAMEWORKS', False)==False):
                # locate Tcl/Tk frameworks

yields:

Pillow 3.2.0.dev0 TEST SUMMARY 
--------------------------------------------------------------------
Python modules loaded from /Users/erics/vpy27/lib/python2.7/site-packages/Pillow-3.2.0.dev0-py2.7-macosx-10.9-x86_64.egg/PIL
Binary modules loaded from /Users/erics/.python-eggs/Pillow-3.2.0.dev0-py2.7-macosx-10.9-x86_64.egg-tmp/PIL
--------------------------------------------------------------------
--- PIL CORE support ok
--- TKINTER support ok
--- FREETYPE2 support ok
--- LITTLECMS2 support ok
*** WEBP support not installed
--- JPEG support ok
--- OPENJPEG (JPEG2000) support ok
--- ZLIB (PNG/ZIP) support ok
--- LIBTIFF support ok

And tests pass.

The framework builds were added in a commit labeled "make it work" 3b8ae97. It's an ancient @aclark4life commit, so I'm guessing the reasoning was shear hacking to make it work.

cjrh · 2016-05-02T10:40:56Z

FWIW This PR also resolves the same problem happening when using Homebrew Python 3 (3.5.1), including virtualenvs. (OS X 10.11.4).

aclark4life · 2016-05-02T11:42:54Z

@cjrh I think we're currently pondering use of the --disable-x flag instead of environment variable check.

cjrh · 2016-05-02T11:45:23Z

@aclark4life Yep I saw that.

wiredfool · 2016-05-03T20:00:04Z

Alternative version of this in #1883, using the command line flag. Can someone check that it solves their issues, as I'm not getting the conda install working here.

wiredfool · 2016-05-23T21:41:35Z

Closed in favor of #1883

wiredfool · 2016-05-31T08:36:50Z

I'd like anyone who's interested in the "Which tk library to use" saga to check out PR #1932 and let me know if it works for you.

adds option to ignore TCL/Tk framework installs on OS X

e9c4ee3

wiredfool mentioned this pull request May 3, 2016

Alternative to PR #1768 #1883

Merged

wiredfool closed this May 23, 2016

cjrh mentioned this pull request Jun 14, 2016

ImageTk.PhotoImage from PIL leads to segfault conda/conda#2471

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds option to ignore TCL/Tk framework installs on OS X #1768

adds option to ignore TCL/Tk framework installs on OS X #1768

ddale commented Mar 14, 2016

hugovk commented Mar 14, 2016

ddale commented Mar 14, 2016

wiredfool commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

ddale commented Mar 14, 2016

hugovk commented Mar 14, 2016

aclark4life commented Mar 14, 2016

wiredfool commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

wiredfool commented Mar 15, 2016

cjrh commented May 2, 2016

aclark4life commented May 2, 2016

cjrh commented May 2, 2016

wiredfool commented May 3, 2016

wiredfool commented May 23, 2016

wiredfool commented May 31, 2016

adds option to ignore TCL/Tk framework installs on OS X #1768

adds option to ignore TCL/Tk framework installs on OS X #1768

Conversation

ddale commented Mar 14, 2016

hugovk commented Mar 14, 2016

ddale commented Mar 14, 2016

wiredfool commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

ddale commented Mar 14, 2016

hugovk commented Mar 14, 2016

aclark4life commented Mar 14, 2016

wiredfool commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

ddale commented Mar 14, 2016

aclark4life commented Mar 14, 2016

wiredfool commented Mar 15, 2016

cjrh commented May 2, 2016

aclark4life commented May 2, 2016

cjrh commented May 2, 2016

wiredfool commented May 3, 2016

wiredfool commented May 23, 2016

wiredfool commented May 31, 2016