Bundle-python

Version 40 (Adrian Georgescu, 03/04/2018 02:45 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 40 Adrian Georgescu
brew install python (this may install python 3)
18 40 Adrian Georgescu
19 40 Adrian Georgescu
To install 2.7:
20 40 Adrian Georgescu
21 40 Adrian Georgescu
https://stackoverflow.com/questions/18671253/how-can-i-use-homebrew-to-install-both-python-2-and-3-on-mac
22 40 Adrian Georgescu
23 40 Adrian Georgescu
brew install pyenv
24 40 Adrian Georgescu
pyenv install 2.7
25 1 Saúl Ibarra Corretgé
</pre>
26 1 Saúl Ibarra Corretgé
27 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.
28 1 Saúl Ibarra Corretgé
29 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.
30 22 Adrian Georgescu
31 22 Adrian Georgescu
The Python framework is found in
32 22 Adrian Georgescu
33 22 Adrian Georgescu
<pre>
34 27 Adrian Georgescu
cp -a /usr/local/Cellar/python/2.7.12_2/Frameworks/Python.framework ~/work/blink/Distribution/Frameworks/
35 22 Adrian Georgescu
</pre>
36 22 Adrian Georgescu
37 2 Saúl Ibarra Corretgé
* Reduce the size of the Python Framework:
38 2 Saúl Ibarra Corretgé
39 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:
40 1 Saúl Ibarra Corretgé
41 1 Saúl Ibarra Corretgé
<pre>
42 27 Adrian Georgescu
cd ~/work/blink/Distribution/Frameworks//Python.framework
43 26 Adrian Georgescu
find . -name *.pyc -exec rm -r "{}" \; 
44 26 Adrian Georgescu
find . -name *.pyo -exec rm -r "{}" \; 
45 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/config/python.o
46 24 Adrian Georgescu
rm -r Versions/Current/bin
47 24 Adrian Georgescu
rm -r Versions/Current/Resources/*
48 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/test
49 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/plat-*
50 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/idlelib
51 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/curses
52 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib2to3
53 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib-tk
54 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/bsddb
55 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib-dynload/gdbm.so
56 24 Adrian Georgescu
rm -r Versions/Current/lib/python2.7/lib-dynload/readline.so
57 35 Adrian Georgescu
rm -r Versions/2.7/lib/python2.7/site-packages
58 1 Saúl Ibarra Corretgé
</pre>
59 3 Saúl Ibarra Corretgé
60 1 Saúl Ibarra Corretgé
Replace @Versions/Current/lib/python2.7/site.py@ with an empty file.
61 28 Adrian Georgescu
62 28 Adrian Georgescu
<pre>
63 38 Adrian Georgescu
rm ~/work/blink/Distribution/Frameworks//Python.framework/Versions/Current/lib/python2.7/site.py
64 38 Adrian Georgescu
touch ~/work/blink/Distribution/Frameworks//Python.framework/Versions/Current/lib/python2.7/site.py
65 28 Adrian Georgescu
</pre>
66 5 Saúl Ibarra Corretgé
67 34 Adrian Georgescu
Python Framework needs file a Info.plist file under Resources in order to be compatible with latest OSX bundle structure:
68 34 Adrian Georgescu
69 34 Adrian Georgescu
<pre>
70 34 Adrian Georgescu
cp build_scripts/PythonFramework.plist Distribution/Frameworks/Python.framework/Resources/Info.plist           
71 34 Adrian Georgescu
</pre>
72 34 Adrian Georgescu
73 34 Adrian Georgescu
74 5 Saúl Ibarra Corretgé
h2. Compiling PyObjC
75 5 Saúl Ibarra Corretgé
76 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.
77 5 Saúl Ibarra Corretgé
78 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:
79 1 Saúl Ibarra Corretgé
80 5 Saúl Ibarra Corretgé
<pre>
81 5 Saúl Ibarra Corretgé
pip install pyobjc-core
82 5 Saúl Ibarra Corretgé
pip install pyobjc
83 23 Adrian Georgescu
pip install pycrypto
84 1 Saúl Ibarra Corretgé
</pre>
85 1 Saúl Ibarra Corretgé
86 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:
87 5 Saúl Ibarra Corretgé
88 5 Saúl Ibarra Corretgé
<pre>
89 5 Saúl Ibarra Corretgé
AddressBook
90 5 Saúl Ibarra Corretgé
AppKit
91 1 Saúl Ibarra Corretgé
Cocoa
92 5 Saúl Ibarra Corretgé
CoreFoundation
93 5 Saúl Ibarra Corretgé
Foundation
94 13 Saúl Ibarra Corretgé
JavaScriptCore
95 5 Saúl Ibarra Corretgé
LaunchServices
96 1 Saúl Ibarra Corretgé
PyObjCTools
97 1 Saúl Ibarra Corretgé
Quartz
98 13 Saúl Ibarra Corretgé
ScriptingBridge
99 13 Saúl Ibarra Corretgé
StoreKit
100 1 Saúl Ibarra Corretgé
WebKit
101 8 Adrian Georgescu
objc
102 6 Saúl Ibarra Corretgé
</pre>
103 6 Saúl Ibarra Corretgé
104 1 Saúl Ibarra Corretgé
105 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):
106 20 Adrian Georgescu
107 1 Saúl Ibarra Corretgé
<pre>
108 1 Saúl Ibarra Corretgé
AVFoundation
109 1 Saúl Ibarra Corretgé
AddressBook
110 1 Saúl Ibarra Corretgé
AppKit
111 1 Saúl Ibarra Corretgé
Cocoa
112 1 Saúl Ibarra Corretgé
CoreFoundation
113 1 Saúl Ibarra Corretgé
Crypto
114 1 Saúl Ibarra Corretgé
Foundation
115 1 Saúl Ibarra Corretgé
LaunchServices
116 1 Saúl Ibarra Corretgé
PyObjCTools
117 1 Saúl Ibarra Corretgé
Quartz
118 1 Saúl Ibarra Corretgé
ScriptingBridge
119 1 Saúl Ibarra Corretgé
WebKit
120 1 Saúl Ibarra Corretgé
_cffi_backend.so
121 1 Saúl Ibarra Corretgé
_ldap.so
122 1 Saúl Ibarra Corretgé
_markerlib
123 1 Saúl Ibarra Corretgé
application
124 1 Saúl Ibarra Corretgé
cffi
125 1 Saúl Ibarra Corretgé
cjson.so
126 1 Saúl Ibarra Corretgé
cryptography
127 1 Saúl Ibarra Corretgé
cryptography-1.5.1.dist-info
128 1 Saúl Ibarra Corretgé
dateutil
129 1 Saúl Ibarra Corretgé
dns
130 1 Saúl Ibarra Corretgé
dsml.py
131 1 Saúl Ibarra Corretgé
enum
132 1 Saúl Ibarra Corretgé
eventlib
133 1 Saúl Ibarra Corretgé
formencode
134 1 Saúl Ibarra Corretgé
gmpy2.so
135 1 Saúl Ibarra Corretgé
gnutls
136 1 Saúl Ibarra Corretgé
greenlet.so
137 1 Saúl Ibarra Corretgé
idna
138 1 Saúl Ibarra Corretgé
ipaddress.py
139 1 Saúl Ibarra Corretgé
ldap
140 1 Saúl Ibarra Corretgé
ldapurl.py
141 1 Saúl Ibarra Corretgé
ldif.py
142 1 Saúl Ibarra Corretgé
lxml
143 1 Saúl Ibarra Corretgé
msrplib
144 1 Saúl Ibarra Corretgé
objc
145 1 Saúl Ibarra Corretgé
otr
146 1 Saúl Ibarra Corretgé
pkg_resources
147 1 Saúl Ibarra Corretgé
pyasn1
148 1 Saúl Ibarra Corretgé
pycparser
149 1 Saúl Ibarra Corretgé
pydispatch
150 1 Saúl Ibarra Corretgé
pytz
151 1 Saúl Ibarra Corretgé
service_identity
152 1 Saúl Ibarra Corretgé
sipsimple
153 1 Saúl Ibarra Corretgé
six.py
154 1 Saúl Ibarra Corretgé
sqlobject
155 1 Saúl Ibarra Corretgé
twisted
156 1 Saúl Ibarra Corretgé
xcaplib
157 21 Adrian Georgescu
</pre>
158 21 Adrian Georgescu
159 21 Adrian Georgescu
160 21 Adrian Georgescu
*NOTE:* The _objc_ package is located inside a _PyObjC_ directory, just copy it from there, without the parent directory.
161 21 Adrian Georgescu
162 21 Adrian Georgescu
<pre>
163 21 Adrian Georgescu
__import__('pkg_resources').declare_namespace(__name__)
164 21 Adrian Georgescu
</pre>
165 21 Adrian Georgescu
166 25 Adrian Georgescu
h2. Fix library paths
167 25 Adrian Georgescu
168 25 Adrian Georgescu
All libraries must have their relative path change to the Framework path bundled within Blink.app
169 25 Adrian Georgescu
170 25 Adrian Georgescu
<pre>
171 25 Adrian Georgescu
#!/bin/sh
172 25 Adrian Georgescu
173 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/"
174 25 Adrian Georgescu
new_path="@executable_path/../Frameworks/"
175 25 Adrian Georgescu
176 25 Adrian Georgescu
for library in $@; do
177 25 Adrian Georgescu
  install_name_tool -id $new_path$library $library
178 25 Adrian Georgescu
  dependencies=$(otool -L $library | grep $old_path | awk '{print $1}')
179 25 Adrian Georgescu
  for dependency in $dependencies; do
180 25 Adrian Georgescu
      new_basename=$(basename $dependency)
181 25 Adrian Georgescu
      new_name="$new_path$new_basename"
182 25 Adrian Georgescu
      echo $dependency $new_name $library
183 25 Adrian Georgescu
      install_name_tool -change $dependency $new_name $library
184 25 Adrian Georgescu
  done
185 1 Saúl Ibarra Corretgé
done
186 1 Saúl Ibarra Corretgé
</pre>
187 1 Saúl Ibarra Corretgé
188 1 Saúl Ibarra Corretgé
A script is available in ./build_scripts/ directory
189 1 Saúl Ibarra Corretgé
190 1 Saúl Ibarra Corretgé
<pre>
191 1 Saúl Ibarra Corretgé
./build_scripts/change_lib_names.sh Distribution/Frameworks/Python.framework/Versions/2.7/lib/python2.7/lib-dynload/*.so
192 1 Saúl Ibarra Corretgé
chmod +w Distribution/Frameworks/Python.framework/Versions/Current/Python
193 1 Saúl Ibarra Corretgé
./build_scripts/change_lib_names.sh Distribution/Frameworks/Python.framework/Versions/Current/Python
194 1 Saúl Ibarra Corretgé
</pre>
195 1 Saúl Ibarra Corretgé
196 33 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
197 33 Adrian Georgescu
198 33 Adrian Georgescu
<pre>
199 33 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
200 33 Adrian Georgescu
sos=`find ./Frameworks -name *.dylib`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
201 33 Adrian Georgescu
sos=`find ./Frameworks -name *.so`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
202 33 Adrian Georgescu
sos=`find ./Frameworks -name *.o`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
203 33 Adrian Georgescu
sos=`find ./Frameworks -name *.a`; for s in $sos; do codesign -f -s '3rd Party Mac Developer Application: AG Projects' $s; done
204 33 Adrian Georgescu
</pre>
205 33 Adrian Georgescu
206 33 Adrian Georgescu
A script is available in ./build_scripts/ directory
207 33 Adrian Georgescu
208 33 Adrian Georgescu
<pre>
209 33 Adrian Georgescu
./build_scripts/codesign.sh 
210 33 Adrian Georgescu
</pre>
211 29 Adrian Georgescu
212 21 Adrian Georgescu
h2. Module exceptions
213 21 Adrian Georgescu
214 21 Adrian Georgescu
When copying built Python modules into the distribution folder, care must be taken with the 2 following packages:
215 21 Adrian Georgescu
216 1 Saúl Ibarra Corretgé
* zope: an empty @__init__.py@ file must be created in the @zope@ directory
217 1 Saúl Ibarra Corretgé
* cryptography: the @*-dist.info@ must be copied too
218 39 Adrian Georgescu
* _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:
219 39 Adrian Georgescu
220 21 Adrian Georgescu
221 21 Adrian Georgescu
h1. Creating a sandbox (Python virtualenv)
222 21 Adrian Georgescu
223 21 Adrian Georgescu
<pre>
224 21 Adrian Georgescu
sudo easy_install pip
225 21 Adrian Georgescu
sudo pip install virtualenv virtualenvwrapper
226 21 Adrian Georgescu
</pre>
227 21 Adrian Georgescu
228 21 Adrian Georgescu
Add to ~.bashrc
229 21 Adrian Georgescu
230 21 Adrian Georgescu
<pre>
231 21 Adrian Georgescu
# Virtualenv
232 21 Adrian Georgescu
export WORKON_HOME=$HOME/.virtualenvs
233 21 Adrian Georgescu
export PIP_VIRTUALENV_BASE=$WORKON_HOME
234 21 Adrian Georgescu
export PIP_RESPECT_VIRTUALENV=true
235 21 Adrian Georgescu
export VIRTUALENVWRAPPER_SCRIPT=/usr/local/bin/virtualenvwrapper.sh
236 21 Adrian Georgescu
[[ -f /usr/local/bin/virtualenvwrapper_lazy.sh ]] && source /usr/local/bin/virtualenvwrapper_lazy.sh
237 21 Adrian Georgescu
</pre>
238 21 Adrian Georgescu
239 21 Adrian Georgescu
Creating a sandbox:
240 21 Adrian Georgescu
241 21 Adrian Georgescu
<pre>
242 21 Adrian Georgescu
mkvirtualenv -p $(which python2.7) sandbox
243 21 Adrian Georgescu
</pre>
244 21 Adrian Georgescu
245 21 Adrian Georgescu
Exiting the sandbox:
246 21 Adrian Georgescu
247 21 Adrian Georgescu
<pre>
248 21 Adrian Georgescu
deactivate
249 21 Adrian Georgescu
</pre>
250 21 Adrian Georgescu
251 21 Adrian Georgescu
Entering the sandbox:
252 21 Adrian Georgescu
253 21 Adrian Georgescu
<pre>
254 21 Adrian Georgescu
workon sandbox
255 19 Adrian Georgescu
</pre>