Python code coverage for Lib/plat-mac/bundlebuilder.py

#	count	content
1	n/a	#! /usr/bin/env python
2	n/a
3	n/a	"""\
4	n/a	bundlebuilder.py -- Tools to assemble MacOS X (application) bundles.
5	n/a
6	n/a	This module contains two classes to build so called "bundles" for
7	n/a	MacOS X. BundleBuilder is a general tool, AppBuilder is a subclass
8	n/a	specialized in building application bundles.
9	n/a
10	n/a	[Bundle\|App]Builder objects are instantiated with a bunch of keyword
11	n/a	arguments, and have a build() method that will do all the work. See
12	n/a	the class doc strings for a description of the constructor arguments.
13	n/a
14	n/a	The module contains a main program that can be used in two ways:
15	n/a
16	n/a	% python bundlebuilder.py [options] build
17	n/a	% python buildapp.py [options] build
18	n/a
19	n/a	Where "buildapp.py" is a user-supplied setup.py-like script following
20	n/a	this model:
21	n/a
22	n/a	from bundlebuilder import buildapp
23	n/a	buildapp(<lots-of-keyword-args>)
24	n/a
25	n/a	"""
26	n/a
27	n/a
28	n/a	__all__ = ["BundleBuilder", "BundleBuilderError", "AppBuilder", "buildapp"]
29	n/a
30	n/a
31	n/a	from warnings import warnpy3k
32	n/a	warnpy3k("In 3.x, the bundlebuilder module is removed.", stacklevel=2)
33	n/a
34	n/a	import sys
35	n/a	import os, errno, shutil
36	n/a	import imp, marshal
37	n/a	import re
38	n/a	from copy import deepcopy
39	n/a	import getopt
40	n/a	from plistlib import Plist
41	n/a	from types import FunctionType as function
42	n/a
43	n/a	class BundleBuilderError(Exception): pass
44	n/a
45	n/a
46	n/a	class Defaults:
47	n/a
48	n/a	"""Class attributes that don't start with an underscore and are
49	n/a	not functions or classmethods are (deep)copied to self.__dict__.
50	n/a	This allows for mutable default values.
51	n/a	"""
52	n/a
53	n/a	def __init__(self, **kwargs):
54	n/a	defaults = self._getDefaults()
55	n/a	defaults.update(kwargs)
56	n/a	self.__dict__.update(defaults)
57	n/a
58	n/a	def _getDefaults(cls):
59	n/a	defaults = {}
60	n/a	for base in cls.__bases__:
61	n/a	if hasattr(base, "_getDefaults"):
62	n/a	defaults.update(base._getDefaults())
63	n/a	for name, value in cls.__dict__.items():
64	n/a	if name[0] != "_" and not isinstance(value,
65	n/a	(function, classmethod)):
66	n/a	defaults[name] = deepcopy(value)
67	n/a	return defaults
68	n/a	_getDefaults = classmethod(_getDefaults)
69	n/a
70	n/a
71	n/a	class BundleBuilder(Defaults):
72	n/a
73	n/a	"""BundleBuilder is a barebones class for assembling bundles. It
74	n/a	knows nothing about executables or icons, it only copies files
75	n/a	and creates the PkgInfo and Info.plist files.
76	n/a	"""
77	n/a
78	n/a	# (Note that Defaults.__init__ (deep)copies these values to
79	n/a	# instance variables. Mutable defaults are therefore safe.)
80	n/a
81	n/a	# Name of the bundle, with or without extension.
82	n/a	name = None
83	n/a
84	n/a	# The property list ("plist")
85	n/a	plist = Plist(CFBundleDevelopmentRegion = "English",
86	n/a	CFBundleInfoDictionaryVersion = "6.0")
87	n/a
88	n/a	# The type of the bundle.
89	n/a	type = "BNDL"
90	n/a	# The creator code of the bundle.
91	n/a	creator = None
92	n/a
93	n/a	# the CFBundleIdentifier (this is used for the preferences file name)
94	n/a	bundle_id = None
95	n/a
96	n/a	# List of files that have to be copied to <bundle>/Contents/Resources.
97	n/a	resources = []
98	n/a
99	n/a	# List of (src, dest) tuples; dest should be a path relative to the bundle
100	n/a	# (eg. "Contents/Resources/MyStuff/SomeFile.ext).
101	n/a	files = []
102	n/a
103	n/a	# List of shared libraries (dylibs, Frameworks) to bundle with the app
104	n/a	# will be placed in Contents/Frameworks
105	n/a	libs = []
106	n/a
107	n/a	# Directory where the bundle will be assembled.
108	n/a	builddir = "build"
109	n/a
110	n/a	# Make symlinks instead copying files. This is handy during debugging, but
111	n/a	# makes the bundle non-distributable.
112	n/a	symlink = 0
113	n/a
114	n/a	# Verbosity level.
115	n/a	verbosity = 1
116	n/a
117	n/a	# Destination root directory
118	n/a	destroot = ""
119	n/a
120	n/a	def setup(self):
121	n/a	# XXX rethink self.name munging, this is brittle.
122	n/a	self.name, ext = os.path.splitext(self.name)
123	n/a	if not ext:
124	n/a	ext = ".bundle"
125	n/a	bundleextension = ext
126	n/a	# misc (derived) attributes
127	n/a	self.bundlepath = pathjoin(self.builddir, self.name + bundleextension)
128	n/a
129	n/a	plist = self.plist
130	n/a	plist.CFBundleName = self.name
131	n/a	plist.CFBundlePackageType = self.type
132	n/a	if self.creator is None:
133	n/a	if hasattr(plist, "CFBundleSignature"):
134	n/a	self.creator = plist.CFBundleSignature
135	n/a	else:
136	n/a	self.creator = "????"
137	n/a	plist.CFBundleSignature = self.creator
138	n/a	if self.bundle_id:
139	n/a	plist.CFBundleIdentifier = self.bundle_id
140	n/a	elif not hasattr(plist, "CFBundleIdentifier"):
141	n/a	plist.CFBundleIdentifier = self.name
142	n/a
143	n/a	def build(self):
144	n/a	"""Build the bundle."""
145	n/a	builddir = self.builddir
146	n/a	if builddir and not os.path.exists(builddir):
147	n/a	os.mkdir(builddir)
148	n/a	self.message("Building %s" % repr(self.bundlepath), 1)
149	n/a	if os.path.exists(self.bundlepath):
150	n/a	shutil.rmtree(self.bundlepath)
151	n/a	if os.path.exists(self.bundlepath + '~'):
152	n/a	shutil.rmtree(self.bundlepath + '~')
153	n/a	bp = self.bundlepath
154	n/a
155	n/a	# Create the app bundle in a temporary location and then
156	n/a	# rename the completed bundle. This way the Finder will
157	n/a	# never see an incomplete bundle (where it might pick up
158	n/a	# and cache the wrong meta data)
159	n/a	self.bundlepath = bp + '~'
160	n/a	try:
161	n/a	os.mkdir(self.bundlepath)
162	n/a	self.preProcess()
163	n/a	self._copyFiles()
164	n/a	self._addMetaFiles()
165	n/a	self.postProcess()
166	n/a	os.rename(self.bundlepath, bp)
167	n/a	finally:
168	n/a	self.bundlepath = bp
169	n/a	self.message("Done.", 1)
170	n/a
171	n/a	def preProcess(self):
172	n/a	"""Hook for subclasses."""
173	n/a	pass
174	n/a	def postProcess(self):
175	n/a	"""Hook for subclasses."""
176	n/a	pass
177	n/a
178	n/a	def _addMetaFiles(self):
179	n/a	contents = pathjoin(self.bundlepath, "Contents")
180	n/a	makedirs(contents)
181	n/a	#
182	n/a	# Write Contents/PkgInfo
183	n/a	assert len(self.type) == len(self.creator) == 4, \
184	n/a	"type and creator must be 4-byte strings."
185	n/a	pkginfo = pathjoin(contents, "PkgInfo")
186	n/a	f = open(pkginfo, "wb")
187	n/a	f.write(self.type + self.creator)
188	n/a	f.close()
189	n/a	#
190	n/a	# Write Contents/Info.plist
191	n/a	infoplist = pathjoin(contents, "Info.plist")
192	n/a	self.plist.write(infoplist)
193	n/a
194	n/a	def _copyFiles(self):
195	n/a	files = self.files[:]
196	n/a	for path in self.resources:
197	n/a	files.append((path, pathjoin("Contents", "Resources",
198	n/a	os.path.basename(path))))
199	n/a	for path in self.libs:
200	n/a	files.append((path, pathjoin("Contents", "Frameworks",
201	n/a	os.path.basename(path))))
202	n/a	if self.symlink:
203	n/a	self.message("Making symbolic links", 1)
204	n/a	msg = "Making symlink from"
205	n/a	else:
206	n/a	self.message("Copying files", 1)
207	n/a	msg = "Copying"
208	n/a	files.sort()
209	n/a	for src, dst in files:
210	n/a	if os.path.isdir(src):
211	n/a	self.message("%s %s/ to %s/" % (msg, src, dst), 2)
212	n/a	else:
213	n/a	self.message("%s %s to %s" % (msg, src, dst), 2)
214	n/a	dst = pathjoin(self.bundlepath, dst)
215	n/a	if self.symlink:
216	n/a	symlink(src, dst, mkdirs=1)
217	n/a	else:
218	n/a	copy(src, dst, mkdirs=1)
219	n/a
220	n/a	def message(self, msg, level=0):
221	n/a	if level <= self.verbosity:
222	n/a	indent = ""
223	n/a	if level > 1:
224	n/a	indent = (level - 1) * " "
225	n/a	sys.stderr.write(indent + msg + "\n")
226	n/a
227	n/a	def report(self):
228	n/a	# XXX something decent
229	n/a	pass
230	n/a
231	n/a
232	n/a	if __debug__:
233	n/a	PYC_EXT = ".pyc"
234	n/a	else:
235	n/a	PYC_EXT = ".pyo"
236	n/a
237	n/a	MAGIC = imp.get_magic()
238	n/a	USE_ZIPIMPORT = "zipimport" in sys.builtin_module_names
239	n/a
240	n/a	# For standalone apps, we have our own minimal site.py. We don't need
241	n/a	# all the cruft of the real site.py.
242	n/a	SITE_PY = """\
243	n/a	import sys
244	n/a	if not %(semi_standalone)s:
245	n/a	del sys.path[1:] # sys.path[0] is Contents/Resources/
246	n/a	"""
247	n/a
248	n/a	ZIP_ARCHIVE = "Modules.zip"
249	n/a	SITE_PY_ZIP = SITE_PY + ("sys.path.append(sys.path[0] + '/%s')\n" % ZIP_ARCHIVE)
250	n/a
251	n/a	def getPycData(fullname, code, ispkg):
252	n/a	if ispkg:
253	n/a	fullname += ".__init__"
254	n/a	path = fullname.replace(".", os.sep) + PYC_EXT
255	n/a	return path, MAGIC + '\0\0\0\0' + marshal.dumps(code)
256	n/a
257	n/a	#
258	n/a	# Extension modules can't be in the modules zip archive, so a placeholder
259	n/a	# is added instead, that loads the extension from a specified location.
260	n/a	#
261	n/a	EXT_LOADER = """\
262	n/a	def __load():
263	n/a	import imp, sys, os
264	n/a	for p in sys.path:
265	n/a	path = os.path.join(p, "%(filename)s")
266	n/a	if os.path.exists(path):
267	n/a	break
268	n/a	else:
269	n/a	assert 0, "file not found: %(filename)s"
270	n/a	mod = imp.load_dynamic("%(name)s", path)
271	n/a
272	n/a	__load()
273	n/a	del __load
274	n/a	"""
275	n/a
276	n/a	MAYMISS_MODULES = ['os2', 'nt', 'ntpath', 'dos', 'dospath',
277	n/a	'win32api', 'ce', '_winreg', 'nturl2path', 'sitecustomize',
278	n/a	'org.python.core', 'riscos', 'riscosenviron', 'riscospath'
279	n/a	]
280	n/a
281	n/a	STRIP_EXEC = "/usr/bin/strip"
282	n/a
283	n/a	#
284	n/a	# We're using a stock interpreter to run the app, yet we need
285	n/a	# a way to pass the Python main program to the interpreter. The
286	n/a	# bootstrapping script fires up the interpreter with the right
287	n/a	# arguments. os.execve() is used as OSX doesn't like us to
288	n/a	# start a real new process. Also, the executable name must match
289	n/a	# the CFBundleExecutable value in the Info.plist, so we lie
290	n/a	# deliberately with argv[0]. The actual Python executable is
291	n/a	# passed in an environment variable so we can "repair"
292	n/a	# sys.executable later.
293	n/a	#
294	n/a	BOOTSTRAP_SCRIPT = """\
295	n/a	#!%(hashbang)s
296	n/a
297	n/a	import sys, os
298	n/a	execdir = os.path.dirname(sys.argv[0])
299	n/a	executable = os.path.join(execdir, "%(executable)s")
300	n/a	resdir = os.path.join(os.path.dirname(execdir), "Resources")
301	n/a	libdir = os.path.join(os.path.dirname(execdir), "Frameworks")
302	n/a	mainprogram = os.path.join(resdir, "%(mainprogram)s")
303	n/a
304	n/a	if %(optimize)s:
305	n/a	sys.argv.insert(1, '-O')
306	n/a
307	n/a	sys.argv.insert(1, mainprogram)
308	n/a	if %(standalone)s or %(semi_standalone)s:
309	n/a	os.environ["PYTHONPATH"] = resdir
310	n/a	if %(standalone)s:
311	n/a	os.environ["PYTHONHOME"] = resdir
312	n/a	else:
313	n/a	pypath = os.getenv("PYTHONPATH", "")
314	n/a	if pypath:
315	n/a	pypath = ":" + pypath
316	n/a	os.environ["PYTHONPATH"] = resdir + pypath
317	n/a
318	n/a	os.environ["PYTHONEXECUTABLE"] = executable
319	n/a	os.environ["DYLD_LIBRARY_PATH"] = libdir
320	n/a	os.environ["DYLD_FRAMEWORK_PATH"] = libdir
321	n/a	os.execve(executable, sys.argv, os.environ)
322	n/a	"""
323	n/a
324	n/a
325	n/a	#
326	n/a	# Optional wrapper that converts "dropped files" into sys.argv values.
327	n/a	#
328	n/a	ARGV_EMULATOR = """\
329	n/a	import argvemulator, os
330	n/a
331	n/a	argvemulator.ArgvCollector().mainloop()
332	n/a	execfile(os.path.join(os.path.split(__file__)[0], "%(realmainprogram)s"))
333	n/a	"""
334	n/a
335	n/a	#
336	n/a	# When building a standalone app with Python.framework, we need to copy
337	n/a	# a subset from Python.framework to the bundle. The following list
338	n/a	# specifies exactly what items we'll copy.
339	n/a	#
340	n/a	PYTHONFRAMEWORKGOODIES = [
341	n/a	"Python", # the Python core library
342	n/a	"Resources/English.lproj",
343	n/a	"Resources/Info.plist",
344	n/a	]
345	n/a
346	n/a	def isFramework():
347	n/a	return sys.exec_prefix.find("Python.framework") > 0
348	n/a
349	n/a
350	n/a	LIB = os.path.join(sys.prefix, "lib", "python" + sys.version[:3])
351	n/a	SITE_PACKAGES = os.path.join(LIB, "site-packages")
352	n/a
353	n/a
354	n/a	class AppBuilder(BundleBuilder):
355	n/a
356	n/a	use_zipimport = USE_ZIPIMPORT
357	n/a
358	n/a	# Override type of the bundle.
359	n/a	type = "APPL"
360	n/a
361	n/a	# platform, name of the subfolder of Contents that contains the executable.
362	n/a	platform = "MacOS"
363	n/a
364	n/a	# A Python main program. If this argument is given, the main
365	n/a	# executable in the bundle will be a small wrapper that invokes
366	n/a	# the main program. (XXX Discuss why.)
367	n/a	mainprogram = None
368	n/a
369	n/a	# The main executable. If a Python main program is specified
370	n/a	# the executable will be copied to Resources and be invoked
371	n/a	# by the wrapper program mentioned above. Otherwise it will
372	n/a	# simply be used as the main executable.
373	n/a	executable = None
374	n/a
375	n/a	# The name of the main nib, for Cocoa apps. Must be specified
376	n/a	# when building a Cocoa app.
377	n/a	nibname = None
378	n/a
379	n/a	# The name of the icon file to be copied to Resources and used for
380	n/a	# the Finder icon.
381	n/a	iconfile = None
382	n/a
383	n/a	# Symlink the executable instead of copying it.
384	n/a	symlink_exec = 0
385	n/a
386	n/a	# If True, build standalone app.
387	n/a	standalone = 0
388	n/a
389	n/a	# If True, build semi-standalone app (only includes third-party modules).
390	n/a	semi_standalone = 0
391	n/a
392	n/a	# If set, use this for #! lines in stead of sys.executable
393	n/a	python = None
394	n/a
395	n/a	# If True, add a real main program that emulates sys.argv before calling
396	n/a	# mainprogram
397	n/a	argv_emulation = 0
398	n/a
399	n/a	# The following attributes are only used when building a standalone app.
400	n/a
401	n/a	# Exclude these modules.
402	n/a	excludeModules = []
403	n/a
404	n/a	# Include these modules.
405	n/a	includeModules = []
406	n/a
407	n/a	# Include these packages.
408	n/a	includePackages = []
409	n/a
410	n/a	# Strip binaries from debug info.
411	n/a	strip = 0
412	n/a
413	n/a	# Found Python modules: [(name, codeobject, ispkg), ...]
414	n/a	pymodules = []
415	n/a
416	n/a	# Modules that modulefinder couldn't find:
417	n/a	missingModules = []
418	n/a	maybeMissingModules = []
419	n/a
420	n/a	def setup(self):
421	n/a	if ((self.standalone or self.semi_standalone)
422	n/a	and self.mainprogram is None):
423	n/a	raise BundleBuilderError, ("must specify 'mainprogram' when "
424	n/a	"building a standalone application.")
425	n/a	if self.mainprogram is None and self.executable is None:
426	n/a	raise BundleBuilderError, ("must specify either or both of "
427	n/a	"'executable' and 'mainprogram'")
428	n/a
429	n/a	self.execdir = pathjoin("Contents", self.platform)
430	n/a
431	n/a	if self.name is not None:
432	n/a	pass
433	n/a	elif self.mainprogram is not None:
434	n/a	self.name = os.path.splitext(os.path.basename(self.mainprogram))[0]
435	n/a	elif self.executable is not None:
436	n/a	self.name = os.path.splitext(os.path.basename(self.executable))[0]
437	n/a	if self.name[-4:] != ".app":
438	n/a	self.name += ".app"
439	n/a
440	n/a	if self.executable is None:
441	n/a	if not self.standalone and not isFramework():
442	n/a	self.symlink_exec = 1
443	n/a	if self.python:
444	n/a	self.executable = self.python
445	n/a	else:
446	n/a	self.executable = sys.executable
447	n/a
448	n/a	if self.nibname:
449	n/a	self.plist.NSMainNibFile = self.nibname
450	n/a	if not hasattr(self.plist, "NSPrincipalClass"):
451	n/a	self.plist.NSPrincipalClass = "NSApplication"
452	n/a
453	n/a	if self.standalone and isFramework():
454	n/a	self.addPythonFramework()
455	n/a
456	n/a	BundleBuilder.setup(self)
457	n/a
458	n/a	self.plist.CFBundleExecutable = self.name
459	n/a
460	n/a	if self.standalone or self.semi_standalone:
461	n/a	self.findDependencies()
462	n/a
463	n/a	def preProcess(self):
464	n/a	resdir = "Contents/Resources"
465	n/a	if self.executable is not None:
466	n/a	if self.mainprogram is None:
467	n/a	execname = self.name
468	n/a	else:
469	n/a	execname = os.path.basename(self.executable)
470	n/a	execpath = pathjoin(self.execdir, execname)
471	n/a	if not self.symlink_exec:
472	n/a	self.files.append((self.destroot + self.executable, execpath))
473	n/a	self.execpath = execpath
474	n/a
475	n/a	if self.mainprogram is not None:
476	n/a	mainprogram = os.path.basename(self.mainprogram)
477	n/a	self.files.append((self.mainprogram, pathjoin(resdir, mainprogram)))
478	n/a	if self.argv_emulation:
479	n/a	# Change the main program, and create the helper main program (which
480	n/a	# does argv collection and then calls the real main).
481	n/a	# Also update the included modules (if we're creating a standalone
482	n/a	# program) and the plist
483	n/a	realmainprogram = mainprogram
484	n/a	mainprogram = '__argvemulator_' + mainprogram
485	n/a	resdirpath = pathjoin(self.bundlepath, resdir)
486	n/a	mainprogrampath = pathjoin(resdirpath, mainprogram)
487	n/a	makedirs(resdirpath)
488	n/a	open(mainprogrampath, "w").write(ARGV_EMULATOR % locals())
489	n/a	if self.standalone or self.semi_standalone:
490	n/a	self.includeModules.append("argvemulator")
491	n/a	self.includeModules.append("os")
492	n/a	if "CFBundleDocumentTypes" not in self.plist:
493	n/a	self.plist["CFBundleDocumentTypes"] = [
494	n/a	{ "CFBundleTypeOSTypes" : [
495	n/a	"****",
496	n/a	"fold",
497	n/a	"disk"],
498	n/a	"CFBundleTypeRole": "Viewer"}]
499	n/a	# Write bootstrap script
500	n/a	executable = os.path.basename(self.executable)
501	n/a	execdir = pathjoin(self.bundlepath, self.execdir)
502	n/a	bootstrappath = pathjoin(execdir, self.name)
503	n/a	makedirs(execdir)
504	n/a	if self.standalone or self.semi_standalone:
505	n/a	# XXX we're screwed when the end user has deleted
506	n/a	# /usr/bin/python
507	n/a	hashbang = "/usr/bin/python"
508	n/a	elif self.python:
509	n/a	hashbang = self.python
510	n/a	else:
511	n/a	hashbang = os.path.realpath(sys.executable)
512	n/a	standalone = self.standalone
513	n/a	semi_standalone = self.semi_standalone
514	n/a	optimize = sys.flags.optimize
515	n/a	open(bootstrappath, "w").write(BOOTSTRAP_SCRIPT % locals())
516	n/a	os.chmod(bootstrappath, 0775)
517	n/a
518	n/a	if self.iconfile is not None:
519	n/a	iconbase = os.path.basename(self.iconfile)
520	n/a	self.plist.CFBundleIconFile = iconbase
521	n/a	self.files.append((self.iconfile, pathjoin(resdir, iconbase)))
522	n/a
523	n/a	def postProcess(self):
524	n/a	if self.standalone or self.semi_standalone:
525	n/a	self.addPythonModules()
526	n/a	if self.strip and not self.symlink:
527	n/a	self.stripBinaries()
528	n/a
529	n/a	if self.symlink_exec and self.executable:
530	n/a	self.message("Symlinking executable %s to %s" % (self.executable,
531	n/a	self.execpath), 2)
532	n/a	dst = pathjoin(self.bundlepath, self.execpath)
533	n/a	makedirs(os.path.dirname(dst))
534	n/a	os.symlink(os.path.abspath(self.executable), dst)
535	n/a
536	n/a	if self.missingModules or self.maybeMissingModules:
537	n/a	self.reportMissing()
538	n/a
539	n/a	def addPythonFramework(self):
540	n/a	# If we're building a standalone app with Python.framework,
541	n/a	# include a minimal subset of Python.framework, unless
542	n/a	# Python.framework was specified manually in self.libs.
543	n/a	for lib in self.libs:
544	n/a	if os.path.basename(lib) == "Python.framework":
545	n/a	# a Python.framework was specified as a library
546	n/a	return
547	n/a
548	n/a	frameworkpath = sys.exec_prefix[:sys.exec_prefix.find(
549	n/a	"Python.framework") + len("Python.framework")]
550	n/a
551	n/a	version = sys.version[:3]
552	n/a	frameworkpath = pathjoin(frameworkpath, "Versions", version)
553	n/a	destbase = pathjoin("Contents", "Frameworks", "Python.framework",
554	n/a	"Versions", version)
555	n/a	for item in PYTHONFRAMEWORKGOODIES:
556	n/a	src = pathjoin(frameworkpath, item)
557	n/a	dst = pathjoin(destbase, item)
558	n/a	self.files.append((src, dst))
559	n/a
560	n/a	def _getSiteCode(self):
561	n/a	if self.use_zipimport:
562	n/a	return compile(SITE_PY % {"semi_standalone": self.semi_standalone},
563	n/a	"<-bundlebuilder.py->", "exec")
564	n/a
565	n/a	def addPythonModules(self):
566	n/a	self.message("Adding Python modules", 1)
567	n/a
568	n/a	if self.use_zipimport:
569	n/a	# Create a zip file containing all modules as pyc.
570	n/a	import zipfile
571	n/a	relpath = pathjoin("Contents", "Resources", ZIP_ARCHIVE)
572	n/a	abspath = pathjoin(self.bundlepath, relpath)
573	n/a	zf = zipfile.ZipFile(abspath, "w", zipfile.ZIP_DEFLATED)
574	n/a	for name, code, ispkg in self.pymodules:
575	n/a	self.message("Adding Python module %s" % name, 2)
576	n/a	path, pyc = getPycData(name, code, ispkg)
577	n/a	zf.writestr(path, pyc)
578	n/a	zf.close()
579	n/a	# add site.pyc
580	n/a	sitepath = pathjoin(self.bundlepath, "Contents", "Resources",
581	n/a	"site" + PYC_EXT)
582	n/a	writePyc(self._getSiteCode(), sitepath)
583	n/a	else:
584	n/a	# Create individual .pyc files.
585	n/a	for name, code, ispkg in self.pymodules:
586	n/a	if ispkg:
587	n/a	name += ".__init__"
588	n/a	path = name.split(".")
589	n/a	path = pathjoin("Contents", "Resources", *path) + PYC_EXT
590	n/a
591	n/a	if ispkg:
592	n/a	self.message("Adding Python package %s" % path, 2)
593	n/a	else:
594	n/a	self.message("Adding Python module %s" % path, 2)
595	n/a
596	n/a	abspath = pathjoin(self.bundlepath, path)
597	n/a	makedirs(os.path.dirname(abspath))
598	n/a	writePyc(code, abspath)
599	n/a
600	n/a	def stripBinaries(self):
601	n/a	if not os.path.exists(STRIP_EXEC):
602	n/a	self.message("Error: can't strip binaries: no strip program at "
603	n/a	"%s" % STRIP_EXEC, 0)
604	n/a	else:
605	n/a	import stat
606	n/a	self.message("Stripping binaries", 1)
607	n/a	def walk(top):
608	n/a	for name in os.listdir(top):
609	n/a	path = pathjoin(top, name)
610	n/a	if os.path.islink(path):
611	n/a	continue
612	n/a	if os.path.isdir(path):
613	n/a	walk(path)
614	n/a	else:
615	n/a	mod = os.stat(path)[stat.ST_MODE]
616	n/a	if not (mod & 0100):
617	n/a	continue
618	n/a	relpath = path[len(self.bundlepath):]
619	n/a	self.message("Stripping %s" % relpath, 2)
620	n/a	inf, outf = os.popen4("%s -S \"%s\"" %
621	n/a	(STRIP_EXEC, path))
622	n/a	output = outf.read().strip()
623	n/a	if output:
624	n/a	# usually not a real problem, like when we're
625	n/a	# trying to strip a script
626	n/a	self.message("Problem stripping %s:" % relpath, 3)
627	n/a	self.message(output, 3)
628	n/a	walk(self.bundlepath)
629	n/a
630	n/a	def findDependencies(self):
631	n/a	self.message("Finding module dependencies", 1)
632	n/a	import modulefinder
633	n/a	mf = modulefinder.ModuleFinder(excludes=self.excludeModules)
634	n/a	if self.use_zipimport:
635	n/a	# zipimport imports zlib, must add it manually
636	n/a	mf.import_hook("zlib")
637	n/a	# manually add our own site.py
638	n/a	site = mf.add_module("site")
639	n/a	site.__code__ = self._getSiteCode()
640	n/a	mf.scan_code(site.__code__, site)
641	n/a
642	n/a	# warnings.py gets imported implicitly from C
643	n/a	mf.import_hook("warnings")
644	n/a
645	n/a	includeModules = self.includeModules[:]
646	n/a	for name in self.includePackages:
647	n/a	includeModules.extend(findPackageContents(name).keys())
648	n/a	for name in includeModules:
649	n/a	try:
650	n/a	mf.import_hook(name)
651	n/a	except ImportError:
652	n/a	self.missingModules.append(name)
653	n/a
654	n/a	mf.run_script(self.mainprogram)
655	n/a	modules = mf.modules.items()
656	n/a	modules.sort()
657	n/a	for name, mod in modules:
658	n/a	path = mod.__file__
659	n/a	if path and self.semi_standalone:
660	n/a	# skip the standard library
661	n/a	if path.startswith(LIB) and not path.startswith(SITE_PACKAGES):
662	n/a	continue
663	n/a	if path and mod.__code__ is None:
664	n/a	# C extension
665	n/a	filename = os.path.basename(path)
666	n/a	pathitems = name.split(".")[:-1] + [filename]
667	n/a	dstpath = pathjoin(*pathitems)
668	n/a	if self.use_zipimport:
669	n/a	if name != "zlib":
670	n/a	# neatly pack all extension modules in a subdirectory,
671	n/a	# except zlib, since it's necessary for bootstrapping.
672	n/a	dstpath = pathjoin("ExtensionModules", dstpath)
673	n/a	# Python modules are stored in a Zip archive, but put
674	n/a	# extensions in Contents/Resources/. Add a tiny "loader"
675	n/a	# program in the Zip archive. Due to Thomas Heller.
676	n/a	source = EXT_LOADER % {"name": name, "filename": dstpath}
677	n/a	code = compile(source, "<dynloader for %s>" % name, "exec")
678	n/a	mod.__code__ = code
679	n/a	self.files.append((path, pathjoin("Contents", "Resources", dstpath)))
680	n/a	if mod.__code__ is not None:
681	n/a	ispkg = mod.__path__ is not None
682	n/a	if not self.use_zipimport or name != "site":
683	n/a	# Our site.py is doing the bootstrapping, so we must
684	n/a	# include a real .pyc file if self.use_zipimport is True.
685	n/a	self.pymodules.append((name, mod.__code__, ispkg))
686	n/a
687	n/a	if hasattr(mf, "any_missing_maybe"):
688	n/a	missing, maybe = mf.any_missing_maybe()
689	n/a	else:
690	n/a	missing = mf.any_missing()
691	n/a	maybe = []
692	n/a	self.missingModules.extend(missing)
693	n/a	self.maybeMissingModules.extend(maybe)
694	n/a
695	n/a	def reportMissing(self):
696	n/a	missing = [name for name in self.missingModules
697	n/a	if name not in MAYMISS_MODULES]
698	n/a	if self.maybeMissingModules:
699	n/a	maybe = self.maybeMissingModules
700	n/a	else:
701	n/a	maybe = [name for name in missing if "." in name]
702	n/a	missing = [name for name in missing if "." not in name]
703	n/a	missing.sort()
704	n/a	maybe.sort()
705	n/a	if maybe:
706	n/a	self.message("Warning: couldn't find the following submodules:", 1)
707	n/a	self.message(" (Note that these could be false alarms -- "
708	n/a	"it's not always", 1)
709	n/a	self.message(" possible to distinguish between \"from package "
710	n/a	"import submodule\" ", 1)
711	n/a	self.message(" and \"from package import name\")", 1)
712	n/a	for name in maybe:
713	n/a	self.message(" ? " + name, 1)
714	n/a	if missing:
715	n/a	self.message("Warning: couldn't find the following modules:", 1)
716	n/a	for name in missing:
717	n/a	self.message(" ? " + name, 1)
718	n/a
719	n/a	def report(self):
720	n/a	# XXX something decent
721	n/a	import pprint
722	n/a	pprint.pprint(self.__dict__)
723	n/a	if self.standalone or self.semi_standalone:
724	n/a	self.reportMissing()
725	n/a
726	n/a	#
727	n/a	# Utilities.
728	n/a	#
729	n/a
730	n/a	SUFFIXES = [_suf for _suf, _mode, _tp in imp.get_suffixes()]
731	n/a	identifierRE = re.compile(r"[_a-zA-z][_a-zA-Z0-9]*$")
732	n/a
733	n/a	def findPackageContents(name, searchpath=None):
734	n/a	head = name.split(".")[-1]
735	n/a	if identifierRE.match(head) is None:
736	n/a	return {}
737	n/a	try:
738	n/a	fp, path, (ext, mode, tp) = imp.find_module(head, searchpath)
739	n/a	except ImportError:
740	n/a	return {}
741	n/a	modules = {name: None}
742	n/a	if tp == imp.PKG_DIRECTORY and path:
743	n/a	files = os.listdir(path)
744	n/a	for sub in files:
745	n/a	sub, ext = os.path.splitext(sub)
746	n/a	fullname = name + "." + sub
747	n/a	if sub != "__init__" and fullname not in modules:
748	n/a	modules.update(findPackageContents(fullname, [path]))
749	n/a	return modules
750	n/a
751	n/a	def writePyc(code, path):
752	n/a	f = open(path, "wb")
753	n/a	f.write(MAGIC)
754	n/a	f.write("\0" * 4) # don't bother about a time stamp
755	n/a	marshal.dump(code, f)
756	n/a	f.close()
757	n/a
758	n/a	def copy(src, dst, mkdirs=0):
759	n/a	"""Copy a file or a directory."""
760	n/a	if mkdirs:
761	n/a	makedirs(os.path.dirname(dst))
762	n/a	if os.path.isdir(src):
763	n/a	shutil.copytree(src, dst, symlinks=1)
764	n/a	else:
765	n/a	shutil.copy2(src, dst)
766	n/a
767	n/a	def copytodir(src, dstdir):
768	n/a	"""Copy a file or a directory to an existing directory."""
769	n/a	dst = pathjoin(dstdir, os.path.basename(src))
770	n/a	copy(src, dst)
771	n/a
772	n/a	def makedirs(dir):
773	n/a	"""Make all directories leading up to 'dir' including the leaf
774	n/a	directory. Don't moan if any path element already exists."""
775	n/a	try:
776	n/a	os.makedirs(dir)
777	n/a	except OSError, why:
778	n/a	if why.errno != errno.EEXIST:
779	n/a	raise
780	n/a
781	n/a	def symlink(src, dst, mkdirs=0):
782	n/a	"""Copy a file or a directory."""
783	n/a	if not os.path.exists(src):
784	n/a	raise IOError, "No such file or directory: '%s'" % src
785	n/a	if mkdirs:
786	n/a	makedirs(os.path.dirname(dst))
787	n/a	os.symlink(os.path.abspath(src), dst)
788	n/a
789	n/a	def pathjoin(*args):
790	n/a	"""Safe wrapper for os.path.join: asserts that all but the first
791	n/a	argument are relative paths."""
792	n/a	for seg in args[1:]:
793	n/a	assert seg[0] != "/"
794	n/a	return os.path.join(*args)
795	n/a
796	n/a
797	n/a	cmdline_doc = """\
798	n/a	Usage:
799	n/a	python bundlebuilder.py [options] command
800	n/a	python mybuildscript.py [options] command
801	n/a
802	n/a	Commands:
803	n/a	build build the application
804	n/a	report print a report
805	n/a
806	n/a	Options:
807	n/a	-b, --builddir=DIR the build directory; defaults to "build"
808	n/a	-n, --name=NAME application name
809	n/a	-r, --resource=FILE extra file or folder to be copied to Resources
810	n/a	-f, --file=SRC:DST extra file or folder to be copied into the bundle;
811	n/a	DST must be a path relative to the bundle root
812	n/a	-e, --executable=FILE the executable to be used
813	n/a	-m, --mainprogram=FILE the Python main program
814	n/a	-a, --argv add a wrapper main program to create sys.argv
815	n/a	-p, --plist=FILE .plist file (default: generate one)
816	n/a	--nib=NAME main nib name
817	n/a	-c, --creator=CCCC 4-char creator code (default: '????')
818	n/a	--iconfile=FILE filename of the icon (an .icns file) to be used
819	n/a	as the Finder icon
820	n/a	--bundle-id=ID the CFBundleIdentifier, in reverse-dns format
821	n/a	(eg. org.python.BuildApplet; this is used for
822	n/a	the preferences file name)
823	n/a	-l, --link symlink files/folder instead of copying them
824	n/a	--link-exec symlink the executable instead of copying it
825	n/a	--standalone build a standalone application, which is fully
826	n/a	independent of a Python installation
827	n/a	--semi-standalone build a standalone application, which depends on
828	n/a	an installed Python, yet includes all third-party
829	n/a	modules.
830	n/a	--no-zipimport Do not copy code into a zip file
831	n/a	--python=FILE Python to use in #! line in stead of current Python
832	n/a	--lib=FILE shared library or framework to be copied into
833	n/a	the bundle
834	n/a	-x, --exclude=MODULE exclude module (with --(semi-)standalone)
835	n/a	-i, --include=MODULE include module (with --(semi-)standalone)
836	n/a	--package=PACKAGE include a whole package (with --(semi-)standalone)
837	n/a	--strip strip binaries (remove debug info)
838	n/a	-v, --verbose increase verbosity level
839	n/a	-q, --quiet decrease verbosity level
840	n/a	-h, --help print this message
841	n/a	"""
842	n/a
843	n/a	def usage(msg=None):
844	n/a	if msg:
845	n/a	print msg
846	n/a	print cmdline_doc
847	n/a	sys.exit(1)
848	n/a
849	n/a	def main(builder=None):
850	n/a	if builder is None:
851	n/a	builder = AppBuilder(verbosity=1)
852	n/a
853	n/a	shortopts = "b:n:r:f:e:m:c:p:lx:i:hvqa"
854	n/a	longopts = ("builddir=", "name=", "resource=", "file=", "executable=",
855	n/a	"mainprogram=", "creator=", "nib=", "plist=", "link",
856	n/a	"link-exec", "help", "verbose", "quiet", "argv", "standalone",
857	n/a	"exclude=", "include=", "package=", "strip", "iconfile=",
858	n/a	"lib=", "python=", "semi-standalone", "bundle-id=", "destroot="
859	n/a	"no-zipimport"
860	n/a	)
861	n/a
862	n/a	try:
863	n/a	options, args = getopt.getopt(sys.argv[1:], shortopts, longopts)
864	n/a	except getopt.error:
865	n/a	usage()
866	n/a
867	n/a	for opt, arg in options:
868	n/a	if opt in ('-b', '--builddir'):
869	n/a	builder.builddir = arg
870	n/a	elif opt in ('-n', '--name'):
871	n/a	builder.name = arg
872	n/a	elif opt in ('-r', '--resource'):
873	n/a	builder.resources.append(os.path.normpath(arg))
874	n/a	elif opt in ('-f', '--file'):
875	n/a	srcdst = arg.split(':')
876	n/a	if len(srcdst) != 2:
877	n/a	usage("-f or --file argument must be two paths, "
878	n/a	"separated by a colon")
879	n/a	builder.files.append(srcdst)
880	n/a	elif opt in ('-e', '--executable'):
881	n/a	builder.executable = arg
882	n/a	elif opt in ('-m', '--mainprogram'):
883	n/a	builder.mainprogram = arg
884	n/a	elif opt in ('-a', '--argv'):
885	n/a	builder.argv_emulation = 1
886	n/a	elif opt in ('-c', '--creator'):
887	n/a	builder.creator = arg
888	n/a	elif opt == '--bundle-id':
889	n/a	builder.bundle_id = arg
890	n/a	elif opt == '--iconfile':
891	n/a	builder.iconfile = arg
892	n/a	elif opt == "--lib":
893	n/a	builder.libs.append(os.path.normpath(arg))
894	n/a	elif opt == "--nib":
895	n/a	builder.nibname = arg
896	n/a	elif opt in ('-p', '--plist'):
897	n/a	builder.plist = Plist.fromFile(arg)
898	n/a	elif opt in ('-l', '--link'):
899	n/a	builder.symlink = 1
900	n/a	elif opt == '--link-exec':
901	n/a	builder.symlink_exec = 1
902	n/a	elif opt in ('-h', '--help'):
903	n/a	usage()
904	n/a	elif opt in ('-v', '--verbose'):
905	n/a	builder.verbosity += 1
906	n/a	elif opt in ('-q', '--quiet'):
907	n/a	builder.verbosity -= 1
908	n/a	elif opt == '--standalone':
909	n/a	builder.standalone = 1
910	n/a	elif opt == '--semi-standalone':
911	n/a	builder.semi_standalone = 1
912	n/a	elif opt == '--python':
913	n/a	builder.python = arg
914	n/a	elif opt in ('-x', '--exclude'):
915	n/a	builder.excludeModules.append(arg)
916	n/a	elif opt in ('-i', '--include'):
917	n/a	builder.includeModules.append(arg)
918	n/a	elif opt == '--package':
919	n/a	builder.includePackages.append(arg)
920	n/a	elif opt == '--strip':
921	n/a	builder.strip = 1
922	n/a	elif opt == '--destroot':
923	n/a	builder.destroot = arg
924	n/a	elif opt == '--no-zipimport':
925	n/a	builder.use_zipimport = False
926	n/a
927	n/a	if len(args) != 1:
928	n/a	usage("Must specify one command ('build', 'report' or 'help')")
929	n/a	command = args[0]
930	n/a
931	n/a	if command == "build":
932	n/a	builder.setup()
933	n/a	builder.build()
934	n/a	elif command == "report":
935	n/a	builder.setup()
936	n/a	builder.report()
937	n/a	elif command == "help":
938	n/a	usage()
939	n/a	else:
940	n/a	usage("Unknown command '%s'" % command)
941	n/a
942	n/a
943	n/a	def buildapp(**kwargs):
944	n/a	builder = AppBuilder(**kwargs)
945	n/a	main(builder)
946	n/a
947	n/a
948	n/a	if __name__ == "__main__":
949	n/a	main()