Bundle-python

Version 21 (Adrian Georgescu, 11/03/2016 10:04 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 1 Saúl Ibarra Corretgé
 
8 7 Adrian Georgescu
h2. Building the Python Framework itself
9 1 Saúl Ibarra Corretgé
10 18 Saúl Ibarra Corretgé
* Install it using Homebrew
11 1 Saúl Ibarra Corretgé
12 1 Saúl Ibarra Corretgé
<pre>
13 18 Saúl Ibarra Corretgé
brew install python
14 1 Saúl Ibarra Corretgé
</pre>
15 1 Saúl Ibarra Corretgé
16 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.
17 1 Saúl Ibarra Corretgé
18 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.
19 13 Saúl Ibarra Corretgé
20 1 Saúl Ibarra Corretgé
21 2 Saúl Ibarra Corretgé
* Reduce the size of the Python Framework:
22 2 Saúl Ibarra Corretgé
23 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:
24 1 Saúl Ibarra Corretgé
25 1 Saúl Ibarra Corretgé
<pre>
26 12 Adrian Georgescu
*.pyc
27 3 Saúl Ibarra Corretgé
*.pyo
28 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/config/python.o
29 1 Saúl Ibarra Corretgé
Versions/Current/Mac
30 12 Adrian Georgescu
Versions/Current/bin
31 3 Saúl Ibarra Corretgé
Versions/Current/share
32 18 Saúl Ibarra Corretgé
Versions/Current/Resources/*
33 3 Saúl Ibarra Corretgé
Versions/Current/Resources/*.app
34 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/test
35 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/plat-*
36 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/idlelib
37 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/curses
38 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/lib2to3
39 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/lib-tk
40 3 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/bsddb
41 18 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/lib-dynload/gdbm.so
42 18 Saúl Ibarra Corretgé
Versions/Current/lib/python2.7/lib-dynload/readline.so
43 1 Saúl Ibarra Corretgé
</pre>
44 3 Saúl Ibarra Corretgé
45 4 Saúl Ibarra Corretgé
* Prevent system paths from being used with this bundle
46 4 Saúl Ibarra Corretgé
47 17 Saúl Ibarra Corretgé
Replace @Versions/Current/lib/python2.7/site.py@ with an empty file.
48 5 Saúl Ibarra Corretgé
49 5 Saúl Ibarra Corretgé
h2. Compiling PyObjC
50 5 Saúl Ibarra Corretgé
51 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.
52 5 Saúl Ibarra Corretgé
53 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:
54 1 Saúl Ibarra Corretgé
55 5 Saúl Ibarra Corretgé
<pre>
56 5 Saúl Ibarra Corretgé
pip install pyobjc-core
57 5 Saúl Ibarra Corretgé
pip install pyobjc
58 1 Saúl Ibarra Corretgé
</pre>
59 1 Saúl Ibarra Corretgé
60 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:
61 5 Saúl Ibarra Corretgé
62 5 Saúl Ibarra Corretgé
<pre>
63 5 Saúl Ibarra Corretgé
AddressBook
64 5 Saúl Ibarra Corretgé
AppKit
65 1 Saúl Ibarra Corretgé
Cocoa
66 5 Saúl Ibarra Corretgé
CoreFoundation
67 5 Saúl Ibarra Corretgé
Foundation
68 13 Saúl Ibarra Corretgé
JavaScriptCore
69 5 Saúl Ibarra Corretgé
LaunchServices
70 1 Saúl Ibarra Corretgé
PyObjCTools
71 1 Saúl Ibarra Corretgé
Quartz
72 13 Saúl Ibarra Corretgé
ScriptingBridge
73 13 Saúl Ibarra Corretgé
StoreKit
74 1 Saúl Ibarra Corretgé
WebKit
75 8 Adrian Georgescu
objc
76 6 Saúl Ibarra Corretgé
</pre>
77 6 Saúl Ibarra Corretgé
78 1 Saúl Ibarra Corretgé
79 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):
80 20 Adrian Georgescu
81 1 Saúl Ibarra Corretgé
<pre>
82 1 Saúl Ibarra Corretgé
AVFoundation
83 1 Saúl Ibarra Corretgé
AddressBook
84 1 Saúl Ibarra Corretgé
AppKit
85 1 Saúl Ibarra Corretgé
Cocoa
86 1 Saúl Ibarra Corretgé
CoreFoundation
87 1 Saúl Ibarra Corretgé
Crypto
88 1 Saúl Ibarra Corretgé
Foundation
89 1 Saúl Ibarra Corretgé
LaunchServices
90 1 Saúl Ibarra Corretgé
PyObjCTools
91 1 Saúl Ibarra Corretgé
Quartz
92 1 Saúl Ibarra Corretgé
ScriptingBridge
93 1 Saúl Ibarra Corretgé
WebKit
94 1 Saúl Ibarra Corretgé
_cffi_backend.so
95 1 Saúl Ibarra Corretgé
_ldap.so
96 1 Saúl Ibarra Corretgé
_markerlib
97 1 Saúl Ibarra Corretgé
application
98 1 Saúl Ibarra Corretgé
cffi
99 1 Saúl Ibarra Corretgé
cjson.so
100 1 Saúl Ibarra Corretgé
cryptography
101 1 Saúl Ibarra Corretgé
cryptography-1.5.1.dist-info
102 1 Saúl Ibarra Corretgé
dateutil
103 1 Saúl Ibarra Corretgé
dns
104 1 Saúl Ibarra Corretgé
dsml.py
105 1 Saúl Ibarra Corretgé
enum
106 1 Saúl Ibarra Corretgé
eventlib
107 1 Saúl Ibarra Corretgé
formencode
108 1 Saúl Ibarra Corretgé
gmpy2.so
109 1 Saúl Ibarra Corretgé
gnutls
110 1 Saúl Ibarra Corretgé
greenlet.so
111 1 Saúl Ibarra Corretgé
idna
112 1 Saúl Ibarra Corretgé
ipaddress.py
113 1 Saúl Ibarra Corretgé
ldap
114 1 Saúl Ibarra Corretgé
ldapurl.py
115 1 Saúl Ibarra Corretgé
ldif.py
116 1 Saúl Ibarra Corretgé
lxml
117 1 Saúl Ibarra Corretgé
msrplib
118 1 Saúl Ibarra Corretgé
objc
119 1 Saúl Ibarra Corretgé
otr
120 1 Saúl Ibarra Corretgé
pkg_resources
121 1 Saúl Ibarra Corretgé
pyasn1
122 1 Saúl Ibarra Corretgé
pycparser
123 1 Saúl Ibarra Corretgé
pydispatch
124 1 Saúl Ibarra Corretgé
pytz
125 1 Saúl Ibarra Corretgé
service_identity
126 1 Saúl Ibarra Corretgé
sipsimple
127 1 Saúl Ibarra Corretgé
six.py
128 1 Saúl Ibarra Corretgé
sqlobject
129 1 Saúl Ibarra Corretgé
twisted
130 1 Saúl Ibarra Corretgé
xcaplib
131 21 Adrian Georgescu
</pre>
132 21 Adrian Georgescu
133 21 Adrian Georgescu
134 21 Adrian Georgescu
*NOTE:* The _objc_ package is located inside a _PyObjC_ directory, just copy it from there, without the parent directory.
135 21 Adrian Georgescu
136 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:
137 21 Adrian Georgescu
138 21 Adrian Georgescu
<pre>
139 21 Adrian Georgescu
__import__('pkg_resources').declare_namespace(__name__)
140 21 Adrian Georgescu
</pre>
141 21 Adrian Georgescu
142 21 Adrian Georgescu
h2. Module exceptions
143 21 Adrian Georgescu
144 21 Adrian Georgescu
When copying built Python modules into the distribution folder, care must be taken with the 2 following packages:
145 21 Adrian Georgescu
146 21 Adrian Georgescu
* zope: an empty @__init__.py@ file must be created in the @zope@ directory
147 21 Adrian Georgescu
* cryptography: the @*-dist.info@ must be copied too
148 21 Adrian Georgescu
149 21 Adrian Georgescu
h1. Creating a sandbox (Python virtualenv)
150 21 Adrian Georgescu
151 21 Adrian Georgescu
<pre>
152 21 Adrian Georgescu
sudo easy_install pip
153 21 Adrian Georgescu
sudo pip install virtualenv virtualenvwrapper
154 21 Adrian Georgescu
</pre>
155 21 Adrian Georgescu
156 21 Adrian Georgescu
Add to ~.bashrc
157 21 Adrian Georgescu
158 21 Adrian Georgescu
<pre>
159 21 Adrian Georgescu
# Virtualenv
160 21 Adrian Georgescu
export WORKON_HOME=$HOME/.virtualenvs
161 21 Adrian Georgescu
export PIP_VIRTUALENV_BASE=$WORKON_HOME
162 21 Adrian Georgescu
export PIP_RESPECT_VIRTUALENV=true
163 21 Adrian Georgescu
export VIRTUALENVWRAPPER_SCRIPT=/usr/local/bin/virtualenvwrapper.sh
164 21 Adrian Georgescu
[[ -f /usr/local/bin/virtualenvwrapper_lazy.sh ]] && source /usr/local/bin/virtualenvwrapper_lazy.sh
165 21 Adrian Georgescu
</pre>
166 21 Adrian Georgescu
167 21 Adrian Georgescu
Creating a sandbox:
168 21 Adrian Georgescu
169 21 Adrian Georgescu
<pre>
170 21 Adrian Georgescu
mkvirtualenv -p $(which python2.7) sandbox
171 21 Adrian Georgescu
</pre>
172 21 Adrian Georgescu
173 21 Adrian Georgescu
Exiting the sandbox:
174 21 Adrian Georgescu
175 21 Adrian Georgescu
<pre>
176 21 Adrian Georgescu
deactivate
177 21 Adrian Georgescu
</pre>
178 21 Adrian Georgescu
179 21 Adrian Georgescu
Entering the sandbox:
180 21 Adrian Georgescu
181 21 Adrian Georgescu
<pre>
182 21 Adrian Georgescu
workon sandbox
183 19 Adrian Georgescu
</pre>