blob: c52a0ebdfcb967d3de56b5b0c414b8f29f0f2dbc [file] [log] [blame]
Andrew MacIntyrec2138af2003-12-02 12:23:07 +00001This is a port of Python 2.4 to OS/2 using the EMX development tools
Andrew MacIntyre41d97d62002-02-17 05:23:30 +00002=========================================================================
3
4What's new since the previous release
5-------------------------------------
6
Andrew MacIntyrec2138af2003-12-02 12:23:07 +00007Another day, another version...
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00008
Andrew MacIntyre41d97d62002-02-17 05:23:30 +00009
10Licenses and info about Python and EMX
11--------------------------------------
12
Andrew MacIntyrec2138af2003-12-02 12:23:07 +000013Please read the file README.Python-2.4 included in this package for
14information about Python 2.4. This file is the README file from the
15Python 2.4 source distribution available via http://www.python.org/
16and its mirrors. The file LICENCE.Python-2.4 is the text of the Licence
17from the Python 2.4 source distribution.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000018
19Note that the EMX package that this package depends on is released under
20the GNU General Public Licence. Please refer to the documentation
21accompanying the EMX Runtime libraries for more information about the
22implications of this. A copy of version 2 of the GPL is included as the
23file COPYING.gpl2.
24
25Readline and GDBM are covered by the GNU General Public Licence. I think
26Eberhard Mattes' porting changes to BSD DB v1.85 are also GPL'ed (BSD DB
27itself is BSD Licenced). ncurses and expat appear to be covered by MIT
28style licences - please refer to the source distributions for more detail.
Andrew MacIntyre3dac89e2004-10-03 08:26:36 +000029zlib is distributable under a very free license. GNU UFC is under the
30GNU LGPL (see file COPYING.lib).
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000031
32My patches to the Python-2.x source distributions, and any other packages
33used in this port, are placed in the public domain.
34
35This software is provided 'as-is', without any express or implied warranty.
36In no event will the author be held liable for any damages arising from the
37use of the software.
38
39I do hope however that it proves useful to someone.
40
41
42Other ports
43-----------
44
45There have been ports of previous versions of Python to OS/2.
46
47The best known would be that by Jeff Rush, most recently of version
481.5.2. Jeff used IBM's Visual Age C++ (v3) for his ports, and his
Andrew MacIntyrec2138af2003-12-02 12:23:07 +000049patches have been included in the Python 2.4 source distribution.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000050
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000051Andy Zabolotny implemented a port of Python v1.5.2 using the EMX
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000052development tools. His patches against the Python v1.5.2 source
53distribution have become the core of this port, and without his efforts
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000054this port wouldn't exist. Andy's port also appears to have been
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000055compiled with his port of gcc 2.95.2 to EMX, which I have but have
Andrew MacIntyrefae89532003-06-09 08:15:14 +000056chosen not to use for the binary distribution of this port (see item 16
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000057of the "YOU HAVE BEEN WARNED" section below).
58
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000059It is possible to have these earlier ports still usable after installing
60this port - see the README.os2emx.multiple_versions file, contributed by
61Dr David Mertz, for a suggested approach to achieving this.
62
63
64Software requirements
65---------------------
66
67This package requires the EMX Runtime package, available from the
68Hobbes (http://hobbes.nmsu.edu/) and LEO (http://archiv.leo.org/)
69archives of OS/2 software. I have used EMX version 0.9d fix04 in
70developing this port.
71
72My development system is running OS/2 v4 with fixpack 12.
73
743rd party software which has been linked into dynamically loaded modules:
75- ncurses (see http://dickey.his.com/ for more info, v5.2)
76- GNU Readline (Kai Uwe Rommel's port available from Hobbes or LEO, v2.1)
77- GNU GDBM (Kai Uwe Rommel's port available from Hobbes or LEO, v1.7.3)
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000078- zlib (derived from Hung-Chi Chu's port of v1.1.3, v1.1.4)
79- expat (distributed with Python, v1.95.6)
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000080- GNU UFC (Kai Uwe Rommel's port available from LEO, v2.0.4)
81
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000082
83About this port
84---------------
85
86I have attempted to make this port as complete and functional as I can,
87notwithstanding the issues in the "YOU HAVE BEEN WARNED" section below.
88
89Core components:
90
91Python.exe is linked as an a.out executable, ie using EMX method E1
92to compile & link the executable. This is so that fork() works (see
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000093"YOU HAVE BEEN WARNED" item 1).
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000094
Andrew MacIntyrec2138af2003-12-02 12:23:07 +000095Python24.dll is created as a normal OMF DLL, with an OMF import
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000096library and module definition file. There is also an a.out (.a) import
Andrew MacIntyreffcf8992002-08-18 06:28:21 +000097library to support linking the DLL to a.out executables. The DLL
98requires the EMX runtime DLLs.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +000099
100This port has been built with complete support for multithreading.
101
102Modules:
103
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000104With the exception of modules that have a significant code size, or are
105not recommended or desired for normal use, the standard modules are now
106built into the core DLL rather than configured as dynamically loadable
107modules. This is for both reasons of performance (startup time) and
108memory use (lots of small DLLs fragment the address space).
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000109
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000110I haven't yet changed the building of Python's dynamically loadable
111modules over to using the DistUtils.
112
113See "YOU HAVE BEEN WARNED" item 3 for notes about the fcntl module, and
114"YOU HAVE BEEN WARNED" item 10 for notes about the pwd and grp modules.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000115
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000116This port supports case sensitive module import semantics, matching
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000117the Windows release. This can be deactivated by setting the PYTHONCASEOK
118environment variable (the value doesn't matter) - see "YOU HAVE BEEN WARNED"
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000119item 12.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000120
121Optional modules:
122
123Where I've been able to locate the required 3rd party packages already
124ported to OS/2, I've built and included them.
125
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000126These include ncurses (_curses, _curses_panel), BSD DB (bsddb185),
Andrew MacIntyre3dac89e2004-10-03 08:26:36 +0000127GNU GDBM (gdbm, dbm), zlib (zlib), GNU Readline (readline), and GNU UFC
128(crypt).
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000129
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000130Expat is now included in the Python release sourceball, and the pyexpat
131module is always built.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000132
133I have built these modules statically linked against the 3rd party
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000134libraries. Unfortunately my attempts to use the dll version of GNU
135readline have been a dismal failure, in that when the dynamically
136linked readline module is active other modules immediately provoke a
137core dump when imported.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000138
139Only the BSD DB package (part of the BSD package distributed with EMX)
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000140needs source modifications to be used for this port, pertaining to use
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000141of errno with multithreading.
142
143The other packages, except for ncurses and zlib, needed Makefile changes
144for multithreading support but no source changes.
145
146The _curses_panel module is a potential problem - see "YOU HAVE BEEN
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000147WARNED" item 13.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000148
149Upstream source patches:
150
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000151No updates to the Python 2.4 release have become available.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000152
153Eberhard Mattes' EMXFIX04 update to his EMX 0.9d tools suite includes
154bug fixes for the BSD DB library. The bsddb module included in this
155port incorporates these fixes.
156
157Library and other distributed Python code:
158
159The Python standard library lives in the Lib directory. All the standard
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000160library code included with the Python 2.4 source distribution is included
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000161in the binary archive, with the exception of the dos-8x3 and tkinter
162subdirectories which have been omitted to reduce the size of the binary
163archive - the dos-8x3 components are unnecessary duplicates and Tkinter
164is not supported by this port (yet). All the plat-* subdirectories in the
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000165source distribution have also been omitted, except for the plat-os2emx
166subdirectory.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000167
168The Tools and Demo directories contain a collection of Python scripts.
169To reduce the size of the binary archive, the Demo/sgi, Demo/Tix,
170Demo/tkinter, Tools/audiopy and Tools/IDLE subdirectories have been
171omitted as not being supported by this port. The Misc directory has
172also been omitted.
173
174All subdirectories omitted from the binary archive can be reconstituted
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000175from the Python 2.4 source distribution, if desired.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000176
177Support for building Python extensions:
178
179The Config subdirectory contains the files describing the configuration
180of the interpreter and the Makefile, import libraries for the Python DLL,
181and the module definition file used to create the Python DLL. The
182Include subdirectory contains all the standard Python header files
183needed for building extensions.
184
185As I don't have the Visual Age C++ compiler, I've made no attempt to
186have this port support extensions built with that compiler.
187
188
189Packaging
190---------
191
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000192This port is packaged as follows:
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000193- python-2.4-os2emx-bin-03????.zip (binaries, library modules)
194- python-2.4-os2emx-src-03???? (patches+makefiles for non-Python code)
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000195
196As all the Python specific patches for the port are now part of the
197Python release tarball, only the patches and makefiles involved in
198building external libraries for optional extensions are included in
199the source archive.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000200
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000201Documentation for the Python language, as well as the Python 2.4
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000202source distibution, can be obtained from the Python website
203(http://www.python.org/) or the Python project pages at Sourceforge
204(http://sf.net/projects/python/).
205
206
207Installation
208------------
209
210Obtain and install, as per the included instructions, the EMX runtime
211package.
212
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000213Unpack this archive, preserving the subdirectories, in the root directory
214of the drive where you want Python to live.
215
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000216Add the Python directory (eg C:\Python24) to the PATH and LIBPATH
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000217variables in CONFIG.SYS.
218
219You should then set the PYTHONHOME and PYTHONPATH environment variables
220in CONFIG.SYS.
221
222PYTHONHOME should be set to Python's top level directory. PYTHONPATH
223should be set to the semicolon separated list of principal Python library
224directories.
225I use:
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000226 SET PYTHONHOME=F:/Python24
227 SET PYTHONPATH=F:/Python24/Lib;F:/Python24/Lib/plat-os2emx;
228 F:/Python24/Lib/lib-dynload;F:/Python24/Lib/site-packages
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000229
230NOTE!: the PYTHONPATH setting above is linewrapped for this document - it
231should all be on one line in CONFIG.SYS!
232
233If you wish to use the curses module, you should set the TERM and TERMINFO
234environment variables appropriately.
235
236If you don't already have ncurses installed, I have included a copy of the
237EMX subset of the Terminfo database included with the ncurses-5.2 source
238distribution. This can be used by setting the TERMINFO environment variable
239to the path of the Terminfo subdirectory below the Python home directory.
240On my system this looks like:
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000241 SET TERMINFO=F:/Python24/Terminfo
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000242
243For the TERM environment variable, I would try one of the following:
244 SET TERM=ansi
245 SET TERM=os2
246 SET TERM=window
247
248You will have to reboot your system for these changes to CONFIG.SYS to take
249effect.
250
251If you wish to compile all the included Python library modules to bytecode,
252you can change into the Python home directory and run the COMPILEALL.CMD
253batch file.
254
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000255You can execute the regression tests included with the Python 2.4 source
256distribution by changing to the Python 2.4 home directory and executing the
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000257REGRTEST.CMD batch file. The following tests are known to fail at this
258time:
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000259- test_mhlib (I don't know of any port of MH to OS/2);
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000260- test_strptime (see "YOU HAVE BEEN WARNED" item 22);
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000261- test_time (see "YOU HAVE BEEN WARNED" item 22);
262- test_posixpath (see "YOU HAVE BEEN WARNED" item 23).
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000263
264Note that some of the network related tests expect the loopback interface
265(interface "lo", with IP address 127.0.0.1) to be enabled, which from my
266experience is not the default configuration. Additionally, test_popen2
267expects the "cat" utility (such as found in ports of the GNU tools) to
268be installed.
269
270
271Building from source
272--------------------
273
274With the EMX port now checked into Python's CVS repository, the build
275infrastructure is part of the Python release sourceball.
276
277Prerequisites
278
279First and foremost, you need an operational EMX development installation -
280EMX v0.9d with fix04 (the latest at time of writing) & the gcc 2.8.1
281compiler released by Eberhard Mattes is the recommended setup.
282
283If you have a different version of gcc installed, see "YOU HAVE BEEN
284WARNED" item 16.
285
286Other items of software required:-
287
288- GNU make (I'm using v3.76.1)
289- rm, cp, mkdir from the GNU file utilities package
290- GNU find
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000291- GNU sed
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000292
293Procedure
294
2950. all changes mentioned apply to files in the PC/os2emx subdirectory
296 of the Python release source tree. make is also executed from this
297 directory, so change into this directory before proceeding.
298
2991. decide if you need to change the location of the Python installation.
300 If you wish to do this, set the value of the Makefile variable LIB_DIR
301 to the directory you wish to use for PYTHONHOME
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000302 (eg /usr/local/lib/python2.4).
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000303
304 If you want Python to find its library without the PYTHONHOME
305 environment variable set, set the value of the Makefile variable
306 FIXED_PYHOME to "yes" (uncomment the appropriate line).
307
3082. If you wish the Python executables (python.exe, pythonpm.exe & pgen.exe)
309 to be installed in a directory other than the PYTHONHOME directory, set
310 the value of the Makefile variable EXE_DIR to the appropriate directory.
311
Andrew MacIntyrec2138af2003-12-02 12:23:07 +00003123. If you wish the Python core DLL (python24.dll) to be installed in a
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000313 directory other than the directory in which the Python executables are
314 installed (by default, the PYTHONHOME directory), set the value of the
315 Makefile variable DLL_DIR to the appropriate directory. This DLL must
316 be placed in a directory on the system's LIBPATH, or that gets set
317 with BEGINLIBPATH or ENDLIBPATH.
318
3194. If you have installed any of the libraries that can be used to build
320 optional Python modules, set the value of the relevant HAVE_<package>
321 Makefile variable to "yes". The Makefile currently supports:
322
323 library Makefile variable
324 ........................................
325 zlib (1.1.4) HAVE_ZLIB
326 GNU UltraFast Crypt HAVE_UFC
327 Tcl/Tk HAVE_TCLTK (not known to work)
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000328 GNU Readline HAVE_GREADLINE
329 BSD DB (v1.85) HAVE_BSDDB
330 ncurses HAVE_NCURSES
331 GNU gdbm HAVE_GDBM
332 libbz2 HAVE_BZ2
333
334 Please note that you need to check that what you have installed
335 is compatible with Python's build options. In particular, the
336 BSD DB v1.85 library needs to be rebuilt with a source patch for
337 multithread support (doesn't change the library's reentrant status
338 but allows it to be linked to Python which is multithreaded).
339 Widely available binary packages of other librarys & DLLs are
340 not built/linked with multithread support. Beware!
341
342 Also note that the Makefile currently expects any libraries to be
343 found with the default library search path. You may need to add
344 -L switches to the LDFLAGS Makefile variable if you have installed
345 libraries in directories not in the default search path (which can
346 be controlled by the LIBRARY_PATH environment variable used by EMX).
347
3485. make
349
350 It is usually a good idea to redirect the stdout and stderr streams
351 of the make process to log files, so that you can review any messages.
352
3536. make test
354
355 This runs the Python regression tests, and completion is a sign of
356 a usable build. You should check the list of skipped modules to
357 ensure that any optional modules you selected have been built;
358 checking the list of failures against the list of known failures
359 elsewhere in this document is also prudent.
360
3617. make install
362 >>>>>> NOT YET COMPLETE <<<<<<
363
3648. change to a directory outside the Python source tree and start Python.
365 Check the version and build date to confirm satisfactory installation.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000366
367
368YOU HAVE BEEN WARNED!!
369----------------------
370
371I know about a number of nasties in this port.
372
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00003731. Eberhard Mattes, author of EMX, writes in his documentation that fork()
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000374is very inefficient in the OS/2 environment. It also requires that the
375executable be linked in a.out format rather than OMF. Use the os.exec
376and/or the os.spawn family of functions where possible.
377
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00003782. In the absence of GNU Readline, terminating the interpreter requires a
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000379control-Z (^Z) followed by a carriage return. Jeff Rush documented this
380problem in his Python 1.5.2 port. With Readline, a control-D (^D) works
381as per the standard Unix environment.
382
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00003833. EMX only has a partial implementation of fcntl(). The fcntl module
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000384in this port supports what EMX supports. If fcntl is important to you,
385please review the EMX C Library Reference (included in .INF format in the
386EMXVIEW.ZIP archive as part of the complete EMX development tools suite).
387Because of other side-effects I have modified the test_fcntl.py test
388script to deactivate the exercising of the missing functionality.
389
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00003904. the PyBSDDB3 module has been imported into the Python standard
391library, with the intent of superceding the BSDDB 1.85 module (bsddb).
392As I don't yet have a satisfactory port of Sleepcat's more recent DB
393library (3.3.x/4.0.x/4.1.x), I haven't included a binary of this
394module. I have left the Python part of the PyBSDDB package in this
395distribution for completeness.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000396
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00003975. As a consequence of the PyBSDDB3 module being imported, the former
398BSD DB (bsddb) module, linked against the DB v1.85 library from EMX,
399has been renamed bsddb185. The bsddb185 module will not be built by
400default on most platforms, but in the absence of a PyBSDDB3 module I
401have retained it in the EMX port.
402
403Version 1.85 of the DB library is widely known to have bugs, although
404some patches have become available (and are incorporated into the
405included bsddb185 module). Unless you have problems with software
406licenses which would rule out GDBM (and the dbm module because it is
407linked against the GDBM library) or need it for file format compatibility,
408you may be better off deleting it and relying on GDBM.
409
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000410Any code you have which uses the v1.85 bsddb module can be modified to
411use the renamed module by changing
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000412
413 import bsddb
414
415to
416
417 import bsddb185 as bsddb
418
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00004196. The readline module has been linked against ncurses rather than the
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000420termcap library supplied with EMX.
421
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00004227. I have configured this port to use "/" as the preferred path separator
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000423character, rather than "\" ('\\'), in line with the convention supported
424by EMX. Backslashes are still supported of course, and still appear in
425unexpected places due to outside sources that don't get normalised.
426
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00004278. While the DistUtils components are now functional, other
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000428packaging/binary handling tools and utilities such as those included in
429the Demo and Tools directories - freeze in particular - are unlikely to
430work. If you do get them going, I'd like to know about your success.
431
Andrew MacIntyre631e87f2003-04-21 14:33:04 +00004329. I haven't set out to support the [BEGIN|END]LIBPATH functionality
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000433supported by one of the earlier ports (Rush's??). If it works let me know.
434
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000043510. As a result of the limitations imposed by EMX's library routines, the
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000436standard extension module pwd only synthesises a simple passwd database,
437and the grp module cannot be supported at all.
438
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000439I have written pure Python substitutes for pwd and grp, which can process
440real passwd and group files for those applications (such as MailMan) that
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000441require more than EMX emulates. I have placed pwd.py and grp.py in
442Lib/plat-os2emx, which is usually before Lib/lib-dynload (which contains
443pwd.pyd) in the PYTHONPATH. If you have become attached to what pwd.pyd
444supports, you can put Lib/lib-dynload before Lib/plat-os2emx in PYTHONPATH
445or delete/rename pwd.py & grp.py.
446
447pwd.py & grp.py support locating their data files by looking in the
448environment for them in the following sequence:
449pwd.py: $ETC_PASSWD (%ETC_PASSWD%)
450 $ETC/passwd (%ETC%/passwd)
451 $PYTHONHOME/Etc/passwd (%PYTHONHOME%/Etc/passwd)
452grp.py: $ETC_GROUP (%ETC_GROUP%)
453 $ETC/group (%ETC%/group)
454 $PYTHONHOME/Etc/group (%PYTHONHOME%/Etc/group)
455
Andrew MacIntyreb0f5e5a2003-07-10 12:55:30 +0000456The ETC_PASSWD and ETC_GROUP environment variables are intended to allow
457support for multiple passwd/grp files, where other applications may not
458support as wide a variety of input variations (drive remappings,
459separators etc).
460
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000461Both modules support using either the ":" character (Unix standard) or
462";" (OS/2, DOS, Windows standard) field separator character, and pwd.py
463implements the following drive letter conversions for the home_directory and
464shell fields (for the ":" separator only):
465 $x -> x:
466 x; -> x:
467
Andrew MacIntyreb0f5e5a2003-07-10 12:55:30 +0000468Example versions of passwd and group are in the Etc subdirectory. The
469regression tests (test_pwd and test_grp) will fail if valid password and
470group files cannot be found, but should pass otherwise.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000471
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000472Be aware that Python's pwd & group modules are for reading password and
473group information only.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000474
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000047511. EMX's termios routines don't support all of the functionality now
476exposed by the termios module - refer to the EMX documentation to find
477out what is supported.
478
47912. The case sensitive import semantics introduced in Python 2.1 for other
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000480case insensitive but case preserving file/operating systems (Windows etc),
481have been incorporated into this port, and are active by default. Setting
482the PYTHONCASEOK environment variable (to any value) reverts to the
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000483previous (case insensitive) semantics. This can be an issue with some
484file management utilities that do not preserve the case of file and
485directory names.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000486
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000048713. Because I am statically linking ncurses, the _curses_panel
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000488module has potential problems arising from separate library data areas.
489To avoid this, I have configured the _curses_.pyd (imported as
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000490"_curses_panel") to import the ncurses symbols it needs from _curses.dll
491(which is the curses module, but with a .dll extension rather than .pyd
492so that the dynamic loader can actually import the symbols from it as a
493DLL).
494
495The site module (Lib/site.py) has code added to tweak BEGINLIBPATH so
496that _curses.dll is found when _curses_panel is imported. If you have
497problems attempting to use the _curses_panel support please let me know,
498and I'll have another look at this.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000499
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000050014. sys.platform reports "os2emx" instead of "os2". os.name still
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000501reports "os2". This change was to make it easier to distinguish between
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000502the VAC++ build (formerly maintained by Michael Muller) and the EMX build
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000503(this port), principally for DistUtils.
504
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000050515. it appears that the %W substitution in the EMX strftime() routine has
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000506an off-by-one bug. strftime was listed as passing the regression tests
507in previous releases, but this fact appears to have been an oversight in
508the regression test suite. To fix this really requires a portable
509strftime routine - I'm looking into using one from FreeBSD, but its not
510ready yet.
511
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000051216. I have successfully built this port with Andy Zabolotny's ports of
513pgcc 2.95 and gcc 3.2.1, in addition to EM's gcc 2.8.1. To use the
514bsddb185 module with the gcc 3.2.1 build, I had to recompile the DB library
515with gcc 3.2.1 - I don't know why, but trying to import the module built
516against a DB library compiled with gcc 2.8.1 would result in a SYS3175
517error.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000518
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000519I have not attempted to compile Python with any version of gcc prior to
520v2.8.1.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000521
Andrew MacIntyrebac1ea92003-07-16 13:31:11 +0000522This release sees the default optimisation change to
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000523"-O3 -fomit-frame-pointer -mprobe". This works fine too for pgcc 2.95
524but not for gcc 3.2.1.
Andrew MacIntyrebac1ea92003-07-16 13:31:11 +0000525
526With gcc 3.2.1, -O3 causes 2 unexpected test failures: test_format and
527test_unicode. Both these tests pass if -O2 is instead of -O3 with this
528compiler, and the performance difference is negligible (in contrast to
529gcc 2.8.1 and pgcc 2.95, where the performance difference between the
5302 optimisation settings approaches 10%).
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000531
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000053217. os.spawnv() and os.spawnve() expose EMX's library routines rather
533than use the emulation in os.py.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000534
535In order to make use of some of the features this makes available in
536the OS/2 environment, you should peruse the relevant EMX documentation
537(EMXLIB.INF in the EMXVIEW.ZIP archive accompanying the EMX archives
538on Hobbes or LEO). Be aware that I have exposed all the "mode" options
539supported by EMX, but there are combinations that either cannot be
540practically used by/in Python or have the potential to compromise your
541system's stability.
542
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000054318. pythonpm.exe used to be just python.exe with the WINDOWAPI linker
544option set in the pythonpm.def file. In practice, this turns out to do
545nothing useful.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000546
547I have written a replacement which wraps the Python DLL in a genuine
548Presentation Manager application. This version actually runs the
549Python interpreter in a separate thread from the PM shell, in order
550that PythonPM has a functioning message queue as good PM apps should.
551In its current state, PythonPM's window is hidden. It can be displayed,
552although it will have no content as nothing is ever written to the
553window. Only the "hide" button is available. Although the code
554has support for shutting PythonPM down when the Python interpreter is
555still busy (via the "control" menu), this is not well tested and given
556comments I've come across in EMX documentation suggesting that the
557thread killing operation has problems I would suggest caution in
558relying on this capability.
559
560PythonPM processes commandline parameters normally. The standard input,
561output and error streams are only useful if redirected, as PythonPM's
562window is not a console in any form and so cannot accept or display
563anything. This means that the -i option is ineffective.
564
565Because the Python thread doesn't create its own message queue, creating
566PM Windows and performing most PM operations is not possible from within
567this thread. How this will affect supporting PM extensions (such as
568Tkinter using a PM port of Tcl/Tk, or wxPython using the PM port of
569WxWindows) is still being researched.
570
571Note that os.fork() _DOES_NOT_WORK_ in PythonPM - SYS3175s are the result
572of trying. os.spawnv() _does_ work. PythonPM passes all regression tests
573that the standard Python interpreter (python.exe) passes, with the exception
574of test_fork1 and test_socket which both attempt to use os.fork().
575
576I very much want feedback on the performance, behaviour and utility of
577PythonPM. I would like to add a PM console capability to it, but that
578will be a non-trivial effort. I may be able to leverage the code in
579Illya Vaes' Tcl/Tk port, which would make it easier.
580
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000058119. os.chdir() uses EMX's _chdir2(), which supports changing both drive
582and directory at once. Similarly, os.getcwd() uses EMX's _getcwd()
583which returns drive as well as path.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000584
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000058520. pyconfig.h is installed in the Include subdirectory with all
586other include files.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000587
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000058821. the default build explicitly sets the number of file handles
589available to a Python process to 250. EMX default is 40, which is
590insufficient for the tempfile regression test (test_tempfile) which
591tries to create 100 temporary files.
Andrew MacIntyreffcf8992002-08-18 06:28:21 +0000592
593This setting can be overridden via the EMXOPT environment variable:
594 set EMXOPT=-h250
595is equivalent to the setting currently used. The emxbind utility (if you
596have it installed) can also be used to permanently change the setting in
597python.exe - please refer to the EMX documentation for more information.
598
Andrew MacIntyre631e87f2003-04-21 14:33:04 +000059922. a pure python strptime module is now part of the Python standard
600library, superceding a platform specific extension module. This module
601leverages the strftime module, and as a result test_strptime fails
602due to the EMX strftime bug in item 20 above.
603
Andrew MacIntyrec2138af2003-12-02 12:23:07 +000060423. test_posixpath attempts to exercise various Posix path related
605functionality. Most of the sub-tests pass, but the "ismount" and
606"samestat" subtests fail:
607- EMX provides not satisfactory mount point emulation, so "ismount"
608 cannot succeed;
609- EMX documents that successive stat() calls will produce different
610 results, so "samestat" cannot succeed.
611
612test_posixpath should skip these tests on EMX.
613
61424. I have had a report that attempting to use the Bittorrent package
615(http://bitconjurer.org/BitTorrent/) with this port causes traps not
616long after starting the download; this using the "headless" download
617script on eCS v1.1. I have not been able to duplicate this myself,
618but the indications I have suggest a failure in the 32 bit TCP/IP
619stack (v4.3.2? on eCS v1.1) - on my v4.0 FP12 system with MPTS fixpack
620WR8425 applied (16 bit TCP/IP stack v4.02), BitTorrent appears to work
621normally in testing on a 100Mbit LAN. With the curses.panel fix (see
622item 13 above), the BitTorrent curses downloader works too. I'd
623appreciate any success or failure reports with BitTorrent, though
624I've regretfully recommended that the person who reported the failure
625take this up with eCS support. Since this report, I have received a
Andrew MacIntyre3dac89e2004-10-03 08:26:36 +0000626followup which suggests that the problem may be addressed by TCP/IP
627fixes (IC35005+PJ29457, contained in NEWSTACK.ZIP in the Hobbes
628archive). I think it suffices to say that BitTorrent is a fair stress
Andrew MacIntyrec2138af2003-12-02 12:23:07 +0000629test of a system's networking capability.
630
63125. In the absence of an EMX implementation of the link() function, I've
632implemented a crude Python emulation, in the file
633Lib/plat-os2emx/_emx_link.py. This is imported into the os module, and
634becomes available as os.link() in the normal way.
635
636The emulation copies the source file in binary mode, and will fail if
637disk space is exhausted. The call fails if the target already exists.
638There are no guarantees to thread safety with this emulation - beware!
639
640The emulation was written to support a link() based file locking system
641used in GNU Mailman.
642
Andrew MacIntyreb8882002004-04-11 12:05:28 +000064326. AF_UNIX sockets, otherwise known as Unix domain sockets, are now
644supported. Unfortunately, there are some traps arising from the
645implementation in IBM's TCP/IP stack:-
646- the path name must start with '\\socket\\' ('/socket/' won't work!),
647 with the length of the full path name less than 108 characters;
648- unlike Unix, the socket endpoints don't exist in the filesystem;
649- by default, sockets are in binary mode.
650
Andrew MacIntyre3dac89e2004-10-03 08:26:36 +000065127. As of Python 2.4, the mpz, rotor and xreadlines modules have been
652dropped from the Python source tree.
653
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000654... probably other issues that I've not encountered, or don't remember :-(
655
656If you encounter other difficulties with this port, which can be
657characterised as peculiar to this port rather than to the Python release,
658I would like to hear about them. However I cannot promise to be able to do
659anything to resolve such problems. See the Contact section below...
660
661
662To do...
663--------
664
665In no particular order of apparent importance or likelihood...
666
667- support Tkinter and/or alternative GUI (wxWindows??)
668
669
670Credits
671-------
672
673In addition to people identified above, I'd like to thank:
674- the BDFL, Guido van Rossum, and crew for Python;
675- Dr David Mertz, for trying out a pre-release of this port;
676- the Python-list/comp.lang.python community;
677- John Poltorak, for input about pwd/grp.
678
679Contact
680-------
681
682Constructive feedback, negative or positive, about this port is welcome
683and should be addressed to me at the e-mail addresses below.
684
Andrew MacIntyre631e87f2003-04-21 14:33:04 +0000685I have a private mailing list for announcements of fixes & updates to
686this port. If you wish to receive such e-mail announcments, please send
687me an e-mail requesting that you be added to this list.
Andrew MacIntyre41d97d62002-02-17 05:23:30 +0000688
689Andrew MacIntyre
690E-mail: andymac@bullseye.apana.org.au, or andymac@pcug.org.au
691Web: http://www.andymac.org/
692
Andrew MacIntyre3dac89e2004-10-03 08:26:36 +00006933 October, 2004.