Bundle-python

Version 31 (Adrian Georgescu, 11/08/2016 03:11 pm)

1 1 Saúl Ibarra Corretgé
h1. Building a Python Framework to bundle inside Blink
2 1 Saúl Ibarra Corretgé
3 1 Saúl Ibarra Corretgé
In order to avoid using the system Python a custom Framework build is needed. Using a bundled Python version will make the package bigger in size, but all package versions are controlled and not up to the environment. Also, we can use the latest Python version, with latest bugfixes and features, since Apple only updates the system Python version on every major OS release.
4 1 Saúl Ibarra Corretgé
5 13 Saúl Ibarra Corretgé
The following instructions only apply for 64bit builds, 32bit builds are no longer supported.
6 7 Adrian Georgescu
7 22 Adrian Georgescu
Blink dependencies must be installed under the following directory structure:
8 22 Adrian Georgescu
9 22 Adrian Georgescu
* Distribution/Frameworks/
10 22 Adrian Georgescu
* Distribution/Resources/lib
11 1 Saúl Ibarra Corretgé
 
12 7 Adrian Georgescu
h2. Building the Python Framework itself
13 1 Saúl Ibarra Corretgé
14 18 Saúl Ibarra Corretgé
* Install it using Homebrew
15 1 Saúl Ibarra Corretgé
16 1 Saúl Ibarra Corretgé
<pre>
17 18 Saúl Ibarra Corretgé
brew install python
18 1 Saúl Ibarra Corretgé
</pre>
19 1 Saúl Ibarra Corretgé
20 18 Saúl Ibarra Corretgé
The framework will be installed and linked with Homebrew supplied OpenSSL and SQLite versions. Those libraries will need to be copied too.
21 1 Saúl Ibarra Corretgé
22 18 Saúl Ibarra Corretgé
*NOTE*: Be careful when copying the framework around, it contains symlinks and if @cp -r@ is used the size will we doubled, use @cp -a@ instead.
23 22 Adrian Georgescu
24 22 Adrian Georgescu
The Python framework is found in
25 22 Adrian Georgescu
26 22 Adrian Georgescu
<pre>
27 27 Adrian Georgescu
cp -a /usr/local/Cellar/python/2.7.12_2/Frameworks/Python.framework ~/work/blink/Distribution/Frameworks/
28 22 Adrian Georgescu
</pre>
29 22 Adrian Georgescu
30 22 Adrian Georgescu
*NOTE*: Python.framework as well as all other libraries must be signed using command line tools. Make sure when building Blink that "Code sign on copy" option is disabled for Python.framework. This script can be used to sign all libraries and frameworks
31 22 Adrian Georgescu
32 22 Adrian Georgescu
<pre>
33 22 Adrian Georgescu
sos=`find ./Resources/lib -name *.so`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
34 22 Adrian Georgescu
sos=`find ./Frameworks -name *.dylib`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
35 22 Adrian Georgescu
sos=`find ./Frameworks -name *.so`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
36 22 Adrian Georgescu
sos=`find ./Frameworks -name *.o`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
37 22 Adrian Georgescu
sos=`find ./Frameworks -name *.a`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
38 22 Adrian Georgescu
</pre>
39 13 Saúl Ibarra Corretgé
40 1 Saúl Ibarra Corretgé
41 2 Saúl Ibarra Corretgé
* Reduce the size of the Python Framework:
42 2 Saúl Ibarra Corretgé
43 1 Saúl Ibarra Corretgé
There are a number of things that can (and must when submitting a sandbox app to Mac App Store) be removed from the framework directory to make it smaller in size:
44 1 Saúl Ibarra Corretgé
45 1 Saúl Ibarra Corretgé
<pre>
46 27 Adrian Georgescu
cd ~/work/blink/Distribution/Frameworks//Python.framework
47 26 Adrian Georgescu
find . -name *.pyc -exec rm -r "{}" \; 
48 26 Adrian Georgescu
find . -name *.pyo -exec rm -r "{}" \; 
49 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/config/python.o
50 24 Adrian Georgescu
rm -r Versions/Current/Mac
51 24 Adrian Georgescu
rm -r Versions/Current/bin
52 24 Adrian Georgescu
rm -r Versions/Current/share
53 24 Adrian Georgescu
rm -r Versions/Current/Resources/*
54 24 Adrian Georgescu
rm -r Versions/Current/Resources/*.app
55 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/test
56 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/plat-*
57 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/idlelib
58 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/curses
59 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib2to3
60 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib-tk
61 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/bsddb
62 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib-dynload/gdbm.so
63 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib-dynload/readline.so
64 1 Saúl Ibarra Corretgé
</pre>
65 3 Saúl Ibarra Corretgé
66 1 Saúl Ibarra Corretgé
Replace @Versions/Current/lib/python2.7/site.py@ with an empty file.
67 28 Adrian Georgescu
68 28 Adrian Georgescu
<pre>
69 28 Adrian Georgescu
rm Versions/Current/lib/python2.7/site.py
70 28 Adrian Georgescu
touch Versions/Current/lib/python2.7/site.py
71 28 Adrian Georgescu
</pre>
72 5 Saúl Ibarra Corretgé
73 5 Saúl Ibarra Corretgé
h2. Compiling PyObjC
74 5 Saúl Ibarra Corretgé
75 13 Saúl Ibarra Corretgé
In order to get a PyObjC version that will work with the framework created above (Python 2.7, 64bits) an equivalent Python must be used to compile it. That is, if has to be a Python 2.7 version (it doesn't have to be the exact version) and it has to be a 64bit version. The MACOSX_DEPLOYMENT_TARGET must also be set to the appropriate value.
76 5 Saúl Ibarra Corretgé
77 5 Saúl Ibarra Corretgé
PyObjcC can be installed with easy_install or pip. We install it in 2 steps to save some compilation time due to a bug in the build system:
78 1 Saúl Ibarra Corretgé
79 5 Saúl Ibarra Corretgé
<pre>
80 5 Saúl Ibarra Corretgé
pip install pyobjc-core
81 5 Saúl Ibarra Corretgé
pip install pyobjc
82 23 Adrian Georgescu
pip install pycrypto
83 1 Saúl Ibarra Corretgé
</pre>
84 1 Saúl Ibarra Corretgé
85 5 Saúl Ibarra Corretgé
When compiling PyObjC a Python package will be created for every system framework, but not all of them are needed (at the moment), so just pick the ones we use:
86 5 Saúl Ibarra Corretgé
87 5 Saúl Ibarra Corretgé
<pre>
88 5 Saúl Ibarra Corretgé
AddressBook
89 5 Saúl Ibarra Corretgé
AppKit
90 1 Saúl Ibarra Corretgé
Cocoa
91 5 Saúl Ibarra Corretgé
CoreFoundation
92 5 Saúl Ibarra Corretgé
Foundation
93 13 Saúl Ibarra Corretgé
JavaScriptCore
94 5 Saúl Ibarra Corretgé
LaunchServices
95 1 Saúl Ibarra Corretgé
PyObjCTools
96 1 Saúl Ibarra Corretgé
Quartz
97 13 Saúl Ibarra Corretgé
ScriptingBridge
98 13 Saúl Ibarra Corretgé
StoreKit
99 1 Saúl Ibarra Corretgé
WebKit
100 8 Adrian Georgescu
objc
101 6 Saúl Ibarra Corretgé
</pre>
102 6 Saúl Ibarra Corretgé
103 1 Saúl Ibarra Corretgé
104 21 Adrian Georgescu
For example this is the content of a Resources/lib bundled with Blink Cocoa as of November 3rd, 2016 (including sipsimple dependencies & all):
105 20 Adrian Georgescu
106 1 Saúl Ibarra Corretgé
<pre>
107 1 Saúl Ibarra Corretgé
AVFoundation
108 1 Saúl Ibarra Corretgé
AddressBook
109 1 Saúl Ibarra Corretgé
AppKit
110 1 Saúl Ibarra Corretgé
Cocoa
111 1 Saúl Ibarra Corretgé
CoreFoundation
112 1 Saúl Ibarra Corretgé
Crypto
113 1 Saúl Ibarra Corretgé
Foundation
114 1 Saúl Ibarra Corretgé
LaunchServices
115 1 Saúl Ibarra Corretgé
PyObjCTools
116 1 Saúl Ibarra Corretgé
Quartz
117 1 Saúl Ibarra Corretgé
ScriptingBridge
118 1 Saúl Ibarra Corretgé
WebKit
119 1 Saúl Ibarra Corretgé
_cffi_backend.so
120 1 Saúl Ibarra Corretgé
_ldap.so
121 1 Saúl Ibarra Corretgé
_markerlib
122 1 Saúl Ibarra Corretgé
application
123 1 Saúl Ibarra Corretgé
cffi
124 1 Saúl Ibarra Corretgé
cjson.so
125 1 Saúl Ibarra Corretgé
cryptography
126 1 Saúl Ibarra Corretgé
cryptography-1.5.1.dist-info
127 1 Saúl Ibarra Corretgé
dateutil
128 1 Saúl Ibarra Corretgé
dns
129 1 Saúl Ibarra Corretgé
dsml.py
130 1 Saúl Ibarra Corretgé
enum
131 1 Saúl Ibarra Corretgé
eventlib
132 1 Saúl Ibarra Corretgé
formencode
133 1 Saúl Ibarra Corretgé
gmpy2.so
134 1 Saúl Ibarra Corretgé
gnutls
135 1 Saúl Ibarra Corretgé
greenlet.so
136 1 Saúl Ibarra Corretgé
idna
137 1 Saúl Ibarra Corretgé
ipaddress.py
138 1 Saúl Ibarra Corretgé
ldap
139 1 Saúl Ibarra Corretgé
ldapurl.py
140 1 Saúl Ibarra Corretgé
ldif.py
141 1 Saúl Ibarra Corretgé
lxml
142 1 Saúl Ibarra Corretgé
msrplib
143 1 Saúl Ibarra Corretgé
objc
144 1 Saúl Ibarra Corretgé
otr
145 1 Saúl Ibarra Corretgé
pkg_resources
146 1 Saúl Ibarra Corretgé
pyasn1
147 1 Saúl Ibarra Corretgé
pycparser
148 1 Saúl Ibarra Corretgé
pydispatch
149 1 Saúl Ibarra Corretgé
pytz
150 1 Saúl Ibarra Corretgé
service_identity
151 1 Saúl Ibarra Corretgé
sipsimple
152 1 Saúl Ibarra Corretgé
six.py
153 1 Saúl Ibarra Corretgé
sqlobject
154 1 Saúl Ibarra Corretgé
twisted
155 1 Saúl Ibarra Corretgé
xcaplib
156 21 Adrian Georgescu
</pre>
157 21 Adrian Georgescu
158 21 Adrian Georgescu
159 21 Adrian Georgescu
*NOTE:* The _objc_ package is located inside a _PyObjC_ directory, just copy it from there, without the parent directory.
160 21 Adrian Georgescu
161 21 Adrian Georgescu
*NOTE:* _PyObjCTools_ is not a valid Python package, as it lacks a @__init__.py@ file, an empty one needs to be manually created with this content:
162 21 Adrian Georgescu
163 21 Adrian Georgescu
<pre>
164 21 Adrian Georgescu
__import__('pkg_resources').declare_namespace(__name__)
165 21 Adrian Georgescu
</pre>
166 21 Adrian Georgescu
167 25 Adrian Georgescu
h2. Fix library paths
168 25 Adrian Georgescu
169 25 Adrian Georgescu
All libraries must have their relative path change to the Framework path bundled within Blink.app
170 25 Adrian Georgescu
171 25 Adrian Georgescu
<pre>
172 25 Adrian Georgescu
#!/bin/sh
173 25 Adrian Georgescu
174 25 Adrian Georgescu
old_path="local/lib/\|local/Cellar/\|/usr/local/opt/libmpc/lib/\|/usr/local/opt/mpfr/lib/\|Frameworks/Frameworks/\|/Users/adigeo/work/ag-projects/video/local/lib/"
175 25 Adrian Georgescu
new_path="@executable_path/../Frameworks/"
176 25 Adrian Georgescu
177 25 Adrian Georgescu
for library in $@; do
178 25 Adrian Georgescu
  install_name_tool -id $new_path$library $library
179 25 Adrian Georgescu
  dependencies=$(otool -L $library | grep $old_path | awk '{print $1}')
180 25 Adrian Georgescu
  for dependency in $dependencies; do
181 25 Adrian Georgescu
      new_basename=$(basename $dependency)
182 25 Adrian Georgescu
      new_name="$new_path$new_basename"
183 25 Adrian Georgescu
      echo $dependency $new_name $library
184 25 Adrian Georgescu
      install_name_tool -change $dependency $new_name $library
185 25 Adrian Georgescu
  done
186 25 Adrian Georgescu
done
187 25 Adrian Georgescu
</pre>
188 25 Adrian Georgescu
189 29 Adrian Georgescu
A script is available in ./build_scripts/ directory
190 29 Adrian Georgescu
191 29 Adrian Georgescu
<pre>
192 30 Adrian Georgescu
./build_scripts/change_lib_names.sh Distribution/Frameworks/Python.framework/Versions/2.7/lib/python2.7/lib-dynload/*.so
193 31 Adrian Georgescu
./build_scripts/change_lib_names.sh Distribution/Frameworks/Python.framework/Versions/Current/Python
194 29 Adrian Georgescu
</pre>
195 29 Adrian Georgescu
196 29 Adrian Georgescu
197 21 Adrian Georgescu
h2. Module exceptions
198 21 Adrian Georgescu
199 21 Adrian Georgescu
When copying built Python modules into the distribution folder, care must be taken with the 2 following packages:
200 21 Adrian Georgescu
201 21 Adrian Georgescu
* zope: an empty @__init__.py@ file must be created in the @zope@ directory
202 21 Adrian Georgescu
* cryptography: the @*-dist.info@ must be copied too
203 21 Adrian Georgescu
204 21 Adrian Georgescu
h1. Creating a sandbox (Python virtualenv)
205 21 Adrian Georgescu
206 21 Adrian Georgescu
<pre>
207 21 Adrian Georgescu
sudo easy_install pip
208 21 Adrian Georgescu
sudo pip install virtualenv virtualenvwrapper
209 21 Adrian Georgescu
</pre>
210 21 Adrian Georgescu
211 21 Adrian Georgescu
Add to ~.bashrc
212 21 Adrian Georgescu
213 21 Adrian Georgescu
<pre>
214 21 Adrian Georgescu
# Virtualenv
215 21 Adrian Georgescu
export WORKON_HOME=$HOME/.virtualenvs
216 21 Adrian Georgescu
export PIP_VIRTUALENV_BASE=$WORKON_HOME
217 21 Adrian Georgescu
export PIP_RESPECT_VIRTUALENV=true
218 21 Adrian Georgescu
export VIRTUALENVWRAPPER_SCRIPT=/usr/local/bin/virtualenvwrapper.sh
219 21 Adrian Georgescu
[[ -f /usr/local/bin/virtualenvwrapper_lazy.sh ]] && source /usr/local/bin/virtualenvwrapper_lazy.sh
220 21 Adrian Georgescu
</pre>
221 21 Adrian Georgescu
222 21 Adrian Georgescu
Creating a sandbox:
223 21 Adrian Georgescu
224 21 Adrian Georgescu
<pre>
225 21 Adrian Georgescu
mkvirtualenv -p $(which python2.7) sandbox
226 21 Adrian Georgescu
</pre>
227 21 Adrian Georgescu
228 21 Adrian Georgescu
Exiting the sandbox:
229 21 Adrian Georgescu
230 21 Adrian Georgescu
<pre>
231 21 Adrian Georgescu
deactivate
232 21 Adrian Georgescu
</pre>
233 21 Adrian Georgescu
234 21 Adrian Georgescu
Entering the sandbox:
235 21 Adrian Georgescu
236 21 Adrian Georgescu
<pre>
237 21 Adrian Georgescu
workon sandbox
238 19 Adrian Georgescu
</pre>