]>
Commit | Line | Data |
---|---|---|
1 | Building wxPython 2.8 for Development and Testing | |
2 | ================================================= | |
3 | ||
4 | This file describes how I build wxWidgets and wxPython while doing | |
5 | development and testing, and is meant to help other people that want | |
6 | to do the same thing. I'll assume that you are using either a CVS | |
7 | snapshot from http://wxWidgets.org/snapshots/, a checkout from CVS, or | |
8 | one of the released wxPython-src-2.8.* tarballs. I'll also assume that | |
9 | you know your way around your system, the compiler, etc. and most | |
10 | importantly, that you know what you are doing! ;-) | |
11 | ||
12 | If you want to also install the version of wxPython you build to be in | |
13 | your site-packages dir and be your default version of wxPython, then a | |
14 | few additional steps are needed, and you may want to use slightly | |
15 | different options. See the INSTALL_ document for more details. If | |
16 | you only use the instructions in this BUILD_ document file then you | |
17 | will end up with a separate installation of wxPython and you can | |
18 | switch back and forth between this and the release version that you | |
19 | may already have installed. | |
20 | ||
21 | .. _INSTALL: INSTALL.html | |
22 | .. _BUILD: BUILD.html | |
23 | ||
24 | If you want to make changes to any of the ``*.i`` files, (SWIG | |
25 | interface definition files,) or to regenerate the extension sources or | |
26 | renamer modules, then you will need an up to date version of SWIG, | |
27 | plus some patches. Get the sources for version 1.3.29, and then apply | |
28 | the patches in wxPython/SWIG and then build SWIG like normal. See the | |
29 | README.txt in the wxPython/SWIG dir for details about each patch and | |
30 | also info about those that may already have been applied to the SWIG | |
31 | sources. If you install this build of SWIG to a location that is not | |
32 | on the PATH (so it doesn't interfere with an existing SWIG install for | |
33 | example) then you can use a setup.py command-line option named SWIG | |
34 | set to the full path name of the executable and the wxPython build will | |
35 | use it. See below for an example. | |
36 | ||
37 | In the text below I'll use WXDIR with environment variable syntax | |
38 | (either $WXDIR or %WXDIR%) to refer to the top level directory where | |
39 | your wxWidgets and wxPython sources are located. It will equate to | |
40 | whereever you checked out the wxWidgets module from CVS, or untarred | |
41 | the wxPython-src tarball to. You can either substitute the $WXDIR text | |
42 | below with your actual dir, or set the value in the environment and | |
43 | use it just like you see it below. | |
44 | ||
45 | If you run into what appears to be compatibility issues between | |
46 | wxWidgets and wxPython while building wxPython, be sure you are using | |
47 | the wxWidgets sources included with the wxPython-src tarball or the | |
48 | CVS snapshot, and not a previously installed version or a version | |
49 | installed from one of the standard wxWidgets installers. With the | |
50 | "unstable" releases (have a odd-numbered minor release value, where | |
51 | the APIs are allowed to change) there are often significant | |
52 | differences between the W.X.Y release of wxWidgets and the W.X.Y.Z | |
53 | release of wxPython. | |
54 | ||
55 | ||
56 | ||
57 | Building on Unix-like Systems (e.g. Linux and OS X) | |
58 | --------------------------------------------------- | |
59 | ||
60 | These platforms are built almost the same way while in development | |
61 | so I'll combine the descriptions about their build process here. | |
62 | First we will build wxWidgets and install it to an out of the way | |
63 | place, then do the same for wxPython. | |
64 | ||
65 | ||
66 | 1. Create a build directory in the main wxWidgets dir, and configure | |
67 | wxWidgets. If you want to have multiple builds with different | |
68 | configure options, just use different subdirectories. I normally | |
69 | put the configure command in a script named ".configure" in each | |
70 | build dir so I can easily blow away everything in the build dir and | |
71 | rerun the script without having to remember the options I used | |
72 | before:: | |
73 | ||
74 | cd $WXDIR | |
75 | mkdir bld | |
76 | cd bld | |
77 | ../configure --prefix=/opt/wx/2.8 \ | |
78 | --with-gtk \ | |
79 | --with-gnomeprint \ | |
80 | --with-opengl \ | |
81 | --enable-debug \ | |
82 | --enable-geometry \ | |
83 | --enable-graphics_ctx \ | |
84 | --enable-sound --with-sdl \ | |
85 | --enable-mediactrl \ | |
86 | --enable-display \ | |
87 | --disable-debugreport \ | |
88 | ||
89 | ||
90 | On OS X of course you'll want to use --with-mac instead of | |
91 | --with-gtk and --with-gnomeprint. | |
92 | ||
93 | Notice that above I used a prefix option of "/opt/wx/2.8". You can | |
94 | use whatever path you want, such as a path in your HOME dir or even | |
95 | one of the standard prefix paths such as /usr or /usr/local if you | |
96 | like, but using /opt this way lets me easily have multiple versions | |
97 | and ports of wxWidgets "installed" and makes it easy to switch | |
98 | between them, without impacting any versions of wxWidgets that may | |
99 | have been installed via an RPM or whatever. For the rest of the | |
100 | steps below be sure to also substitute "/opt/wx/2.8" with whatever | |
101 | prefix you choose for your build. | |
102 | ||
103 | **NOTE**: Due to a recent change there is currently a dependency | |
104 | problem in the multilib builds of wxWidgets on OSX, so I have | |
105 | switched to using a monolithic build. That means that all of the | |
106 | core wxWidgets code is placed in in one shared library instead of | |
107 | several. wxPython can be used with either mode, so use whatever | |
108 | suits you on Linux and etc. but use monolithic on OSX. To switch | |
109 | to the monolithic build of wxWidgets just add this configure flag:: | |
110 | ||
111 | --enable-monolithic \ | |
112 | ||
113 | By default GTK 2.x will be used for the build. If you would rather | |
114 | use GTK 1.2.x for some reason then you can force configure to use | |
115 | it by changing the --with-gtk flag to specify it like this:: | |
116 | ||
117 | --with-gtk=1 \ | |
118 | ||
119 | To make the wxWidgets build be unicode enabled (strongly | |
120 | recommended unless you are building with GTK1) then add the | |
121 | following flag. When wxPython is unicode enabled then all strings | |
122 | that are passed to wx functions and methods will first be converted | |
123 | to unicode objects, and any 'strings' returned from wx functions | |
124 | and methods will actually be unicode objects.:: | |
125 | ||
126 | --enable-unicode \ | |
127 | ||
128 | If you want to use the image and zlib libraries included with | |
129 | wxWidgets instead of those already installed on your system, (for | |
130 | example, to reduce dependencies on 3rd party libraries) then you | |
131 | can add these flags to the configure command:: | |
132 | ||
133 | --with-libjpeg=builtin \ | |
134 | --with-libpng=builtin \ | |
135 | --with-libtiff=builtin \ | |
136 | --with-zlib=builtin \ | |
137 | ||
138 | ||
139 | 2. To build and install wxWidgets you could just use the "make" | |
140 | command but there are a couple other libraries besides the main | |
141 | wxWidgets libs that also need to be built so again I make a script | |
142 | to do it all for me so I don't forget anything. This time it is | |
143 | called ".make" (I use the leading "." so when I do ``rm -r *`` in | |
144 | my build dir I don't lose my scripts too.) This is what it looks | |
145 | like:: | |
146 | ||
147 | make $* \ | |
148 | && make -C contrib/src/gizmos $* \ | |
149 | && make -C contrib/src/stc $* | |
150 | ||
151 | So you just use .make as if it where make, but don't forget to set | |
152 | the execute bit on .make first!:: | |
153 | ||
154 | .make | |
155 | .make install | |
156 | ||
157 | When it's done you should have an installed set of files under | |
158 | /opt/wx/2.8 containing just wxWidgets. Now to use this version of | |
159 | wxWidgets you just need to add /opt/wx/2.8/bin to the PATH and set | |
160 | LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on OS X) to /opt/wx/2.8/lib. | |
161 | ||
162 | ||
163 | 3. I also have a script to help me build wxPython and it is checked in | |
164 | to the CVS as wxWidgets/wxPython/b, but you probably don't want to | |
165 | use it as it's very cryptic and expects that you want to run SWIG, | |
166 | so if you don't have the latest patched up version of SWIG then | |
167 | you'll probably get stuck. So in this document I'll just give the | |
168 | raw commands instead. | |
169 | ||
170 | We're not going to install the development version of wxPython with | |
171 | these commands, so it won't impact your already installed version | |
172 | of the latest release. You'll be able test with this version when | |
173 | you want to, and use the installed release version the rest of the | |
174 | time. If you want to install the development version please read | |
175 | INSTALL.txt. | |
176 | ||
177 | If you have more than one version of Python on your system then be | |
178 | sure to use the version of Python that you want to use when running | |
179 | wxPython programs to run the setup.py commands below. I'll be | |
180 | using python2.5. | |
181 | ||
182 | Make sure that the first wx-config found on the PATH is the one | |
183 | belonging to the wxWidgets that you installed above, and then | |
184 | change to the $WXDIR/wxPython dir and run the this command:: | |
185 | ||
186 | cd $WXDIR/wxPython | |
187 | python2.5 setup.py build_ext --inplace --debug | |
188 | ||
189 | If your new wx-config script is not on the PATH, or there is some | |
190 | other version of it found first, then you can add this to the | |
191 | command line to ensure your new one is used instead:: | |
192 | ||
193 | WX_CONFIG=/opt/wx/2.8/bin/wx-config | |
194 | ||
195 | By default setup.py will assume that you built wxWidgets to use | |
196 | GTK2. If you built wxWidgets to use GTK 1.2.x then you should add | |
197 | this flag to the command-line:: | |
198 | ||
199 | WXPORT=gtk | |
200 | ||
201 | Setup.py will assume by default that you are using a unicode build | |
202 | of wxWidgets. If not then you can use this flag:: | |
203 | ||
204 | UNICODE=0 | |
205 | ||
206 | If you are wanting to have the source files regenerated with swig, | |
207 | (only neccessary if you make modifications to the ``*.i`` files,) | |
208 | then you need to turn on the USE_SWIG flag and optionally tell it | |
209 | where to find the new swig executable, so add these flags:: | |
210 | ||
211 | USE_SWIG=1 SWIG=/opt/swig/bin/swig | |
212 | ||
213 | If you get errors about being unable to find libGLU, wxGLCanvas | |
214 | being undeclared, or something similar then you can add | |
215 | BUILD_GLCANVAS=0 to the setup.py command line to disable the | |
216 | building of the glcanvas module. | |
217 | ||
218 | When the setup.py command is done you should have a fully populated | |
219 | (but uninstalled) wx package located in your $WXDIR/wxPython/wx | |
220 | directory. | |
221 | ||
222 | ||
223 | 4. To run code with the development version of wxPython, just set the | |
224 | PYTHONPATH to the wxPython dir located in the source tree. For | |
225 | example:: | |
226 | ||
227 | export LD_LIBRARY_PATH=/opt/wx/2.8/lib | |
228 | export PYTHONPATH=$WXDIR/wxPython | |
229 | cd $WXDIR/wxPython/demo | |
230 | python2.5 demo.py | |
231 | ||
232 | OS X NOTE: Depending on your version of OS X and Python you may | |
233 | need to use "pythonw" on the command line to run wxPython | |
234 | applications. This version of the Python executable is part of the | |
235 | Python Framework and is allowed to interact with the display. You | |
236 | can also double click on a .py or a .pyw file from the finder | |
237 | (assuming that the PythonLauncher app is associated with these file | |
238 | extensions) and it will launch the Framework version of Python for | |
239 | you. For information about creating Applicaiton Bundles of your | |
240 | wxPython apps please see the wiki and the mail lists. | |
241 | ||
242 | SOLARIS NOTE: If you get unresolved symbol errors when importing | |
243 | wxPython and you are running on Solaris and building with gcc, then | |
244 | you may be able to work around the problem by uncommenting a bit of | |
245 | code in config.py and building again. Look for 'SunOS' in config.py | |
246 | and uncomment the block containing it. The problem is that Sun's ld | |
247 | does not automatically add libgcc to the link step. | |
248 | ||
249 | ||
250 | ||
251 | ||
252 | Building on Windows | |
253 | ------------------- | |
254 | ||
255 | The Windows builds currently require the use of Microsoft Visual C++. | |
256 | Theoretically, other compilers (such as mingw32 or the Borland | |
257 | compilers) can also be used but I've never done the work to make that | |
258 | happen. If you want to try that then first you'll want to find out if | |
259 | there are any tricks that have to be done to make Python extension | |
260 | modules using that compiler, and then make a few changes to setup.py | |
261 | to accommodate that. (And send the patches to me.) | |
262 | ||
263 | The standard Python 2.3 and earlier are built with MS Visual C 6.0 and | |
264 | so you must also build with MSVC 6 in order to be used with the stock | |
265 | python.exe. If you woudl rather use a different version of | |
266 | VisualStudio keep in mind that you'll also have to build Python and | |
267 | any other extension modules that you use with that compiler because a | |
268 | different version of the C runtime library is used. The stock Python | |
269 | 2.4 and 2.5 executables are built with MSVC 7.1, and the same rules | |
270 | apply to it. | |
271 | ||
272 | If you want to build a debuggable version of wxWidgets and wxPython you | |
273 | will need to have also built a debug version of Python and any other | |
274 | extension modules you need to use. You can tell if you have them | |
275 | already if there is a _d in the file names, for example python_d.exe | |
276 | or python25_d.dll. If you don't need to trace through the C/C++ parts | |
277 | of the code with the debugger then building the normal (or hybrid) | |
278 | version is fine, and you can use the regular python executables with | |
279 | it. | |
280 | ||
281 | Starting with 2.5.3.0 wxPython can be built for either the monlithic | |
282 | or the multi-lib wxWidgets builds. (Monolithic means that all the | |
283 | core wxWidgets code is in one DLL, and multi-lib means that the core | |
284 | code is divided into multiple DLLs.) To select which one to use | |
285 | specify the MONOLITHIC flag for both the wxWidgets build and the | |
286 | wxPython build as shown below, setting it to either 0 or 1. | |
287 | ||
288 | Just like the unix versions I also use some scripts to help me build | |
289 | wxWidgets, but I use some non-standard stuff to do it. So if you have | |
290 | bash (cygwin or probably MSYS too) or 4NT plus unix-like cat and sed | |
291 | programs then there is a copy of my wxWidgets build scripts in | |
292 | %WXDIR%\\wxPython\\distrib\\msw. Just copy them to | |
293 | %WXDIR%\\build\\msw and you can use them to do your build, otherwise | |
294 | you can do everything by hand as described below. But if you do work | |
295 | by hand and something doesn't seem to be working correctly please | |
296 | refer to the build scripts to see what may need to be done | |
297 | differently. | |
298 | ||
299 | The \*.btm files are for 4NT and the others are for bash. They are:: | |
300 | ||
301 | .make/.make.btm Builds the main lib and the needed contribs | |
302 | .mymake/.mymake.btm Builds just one lib, used by .make | |
303 | .makesetup.mk A makefile that will copy and edit setup.h | |
304 | as needed for the different types of builds | |
305 | ||
306 | Okay. Here's what you've been waiting for, the instructions! Adapt | |
307 | accordingly if you are using the bash shell. | |
308 | ||
309 | 1. Set an environment variable to the root of the wxWidgets source | |
310 | tree. This is used by the makefiles:: | |
311 | ||
312 | set WXWIN=%WXDIR% | |
313 | ||
314 | 2. Copy setup0.h to setup.h:: | |
315 | ||
316 | cd %WXDIR%\include\wx\msw | |
317 | copy setup0.h setup.h | |
318 | ||
319 | ||
320 | 3. Edit %WXDIR%\\include\\wx\\msw\\setup.h and change a few settings:: | |
321 | ||
322 | wxUSE_DEBUGREPORT 0 | |
323 | wxUSE_EXCEPTIONS 0 | |
324 | wxUSE_DIALUP_MANAGER 0 | |
325 | wxUSE_GRAPHICS_CONTEXT 1 | |
326 | wxUSE_GLCANVAS 1 | |
327 | wxUSE_POSTSCRIPT 1 | |
328 | wxUSE_DIB_FOR_BITMAP 1 | |
329 | ||
330 | ||
331 | If you are using my build scripts then a few more settings will be | |
332 | changed automatically and then a copy of setup.h is placed in a | |
333 | subdir of %WXWIN%\\lib\vc_dll. If you are doing it by hand and | |
334 | making a UNICODE build, then also change these:: | |
335 | ||
336 | wxUSE_UNICODE 1 | |
337 | wxUSE_UNICODE_MSLU 1 | |
338 | ||
339 | If you are doing a "hybrid" build (which is the same as the | |
340 | binaries that I release) then also change these:: | |
341 | ||
342 | wxUSE_MEMORY_TRACING 0 | |
343 | wxUSE_DEBUG_CONTEXT 0 | |
344 | ||
345 | ||
346 | 4. Make sure that %WXDIR%\\lib\\vc_dll directory is on the PATH. The | |
347 | wxWidgets DLLs will end up there as part of the build and so you'll | |
348 | need it on the PATH for them to be found at runtime. | |
349 | ||
350 | ||
351 | 5. Change to the %WXDIR%\\build\\msw directory | |
352 | ||
353 | cd %WXDIR%\\build\\msw | |
354 | ||
355 | ||
356 | 6. If using my scripts then use the .make.btm command to build | |
357 | wxWidgets. It needs one command-line parameter which controls what | |
358 | kind of build(s) to do. Use one of the following:: | |
359 | ||
360 | debug Build debug version | |
361 | hybrid Build hybrid version | |
362 | both Both debug and hybrid | |
363 | debug-uni Build a debug unicode library | |
364 | hybrid-uni Hybrid unicode (see the pattern yet? ;-) | |
365 | both-uni and finally both unicode libraries | |
366 | ||
367 | For example:: | |
368 | ||
369 | .make hybrid | |
370 | ||
371 | You can also pass additional command line parameters as needed and | |
372 | they will all be passed on to the nmake commands, for example to | |
373 | clean up the build:: | |
374 | ||
375 | .make hybrid clean | |
376 | ||
377 | If *not* using my scripts then you can do it by hand by directly | |
378 | executing nmake with a bunch of extra command line parameters. | |
379 | The base set are:: | |
380 | ||
381 | nmake -f makefile.vc OFFICIAL_BUILD=1 SHARED=1 MONOLITHIC=0 USE_OPENGL=1 USE_GDIPLUS=1 | |
382 | ||
383 | If doing a debug build then add:: | |
384 | ||
385 | BUILD=debug | |
386 | ||
387 | otherwise add these:: | |
388 | ||
389 | DEBUG_FLAG=1 CXXFLAGS=/D__NO_VC_CRTDBG__ WXDEBUGFLAG=h BUILD=release | |
390 | ||
391 | If doing a Unicode build then add these flags:: | |
392 | ||
393 | UNICODE=1 MSLU=1 | |
394 | ||
395 | Now, from the %WXDIR%\\build\\msw directory run nmake with your | |
396 | selection of command-line flags as described above. | |
397 | ||
398 | ||
399 | 7. When that is all done it will have built the main wxWidgets DLLs | |
400 | and also some of the contribs DLLs. There should be a ton of DLLs | |
401 | and lots of lib files and other stuff in %WXDIR%\\lib\\vc_dll. | |
402 | ||
403 | ||
404 | 8. Building wxPython on Windows is very similar to doing it for the | |
405 | unix systems. We're not going to install the development version | |
406 | of wxPython with these commands, so it won't impact your already | |
407 | installed version of the latest release. You'll be able to test | |
408 | with this version when you want to, and use the installed release | |
409 | version the rest of the time. If you ever do want to install the | |
410 | development version please refer to INSTALL.txt. | |
411 | ||
412 | Change to the %WXDIR%\\wxPython dir and run the this command, | |
413 | making sure that you use the version of python that you want to | |
414 | build for (if you have more than one on your system) and to match | |
415 | the MONOLITHIC flag with how you built wxWidgets:: | |
416 | ||
417 | cd %WXDIR%\wxPython | |
418 | python setup.py build_ext --inplace MONOLITHIC=0 | |
419 | ||
420 | If you are wanting to have the source files regenerated with swig, | |
421 | (only neccessary if you make modifications to the ``*.i`` files,) | |
422 | then you need to turn on the USE_SWIG flag and optionally tell it | |
423 | where to find the new swig executable, so add these flags:: | |
424 | ||
425 | USE_SWIG=1 SWIG=e:\\projects\\SWIG-1.2.29\\swig.exe | |
426 | ||
427 | If you built a Unicode version of wxWidgets and want to also build | |
428 | the Unicode version of wxPython then add this flag:: | |
429 | ||
430 | UNICODE=1 | |
431 | ||
432 | If you have a debug version of Python and wxWidgets and want to | |
433 | build a debug version of wxPython too, add the --debug flag to the | |
434 | command line. You should then end up with a set of ``*_d.pyd`` | |
435 | files in the wx package and you'll have to run ``python_d.exe`` to | |
436 | use them. The debug and hybrid(release) versions can coexist. | |
437 | ||
438 | When the setup.py command is done you should have fully populated | |
439 | wxPython and wx packages locally in %WXDIR%/wxPython/wxPython and | |
440 | %WXDIR%/wxPython/wx, with all the extension modules (``*.pyd`` | |
441 | files) located in the wx package. | |
442 | ||
443 | ||
444 | 9. To run code with the development version of wxPython, just set the | |
445 | PYTHONPATH to the wxPython dir in the CVS tree. For example:: | |
446 | ||
447 | set PYTHONPATH=%WXDIR%\wxPython | |
448 | cd %WXDIR\wxPython\demo | |
449 | python demo.py | |
450 | ||
451 |