blob: 9e4fc910be1f0f6b3e8718d9e882d6da5c543d49 [file] [log] [blame]
Just van Rossumad33d722002-11-21 10:23:04 +00001#! /usr/bin/env python
2
3"""\
4bundlebuilder.py -- Tools to assemble MacOS X (application) bundles.
5
Just van Rossumceeb9622002-11-21 23:19:37 +00006This module contains two classes to build so called "bundles" for
Just van Rossumad33d722002-11-21 10:23:04 +00007MacOS X. BundleBuilder is a general tool, AppBuilder is a subclass
Just van Rossumceeb9622002-11-21 23:19:37 +00008specialized in building application bundles.
Just van Rossumad33d722002-11-21 10:23:04 +00009
Just van Rossumceeb9622002-11-21 23:19:37 +000010[Bundle|App]Builder objects are instantiated with a bunch of keyword
11arguments, and have a build() method that will do all the work. See
12the class doc strings for a description of the constructor arguments.
13
14The module contains a main program that can be used in two ways:
15
16 % python bundlebuilder.py [options] build
17 % python buildapp.py [options] build
18
19Where "buildapp.py" is a user-supplied setup.py-like script following
20this model:
21
22 from bundlebuilder import buildapp
23 buildapp(<lots-of-keyword-args>)
Just van Rossumad33d722002-11-21 10:23:04 +000024
25"""
26
Just van Rossumad33d722002-11-21 10:23:04 +000027
Just van Rossumcef32882002-11-26 00:34:52 +000028__all__ = ["BundleBuilder", "BundleBuilderError", "AppBuilder", "buildapp"]
Just van Rossumad33d722002-11-21 10:23:04 +000029
30
31import sys
32import os, errno, shutil
Just van Rossumcef32882002-11-26 00:34:52 +000033import imp, marshal
34import re
Just van Rossumda302da2002-11-23 22:26:44 +000035from copy import deepcopy
Just van Rossumceeb9622002-11-21 23:19:37 +000036import getopt
Just van Rossumad33d722002-11-21 10:23:04 +000037from plistlib import Plist
Just van Rossumda302da2002-11-23 22:26:44 +000038from types import FunctionType as function
Just van Rossumad33d722002-11-21 10:23:04 +000039
Just van Rossumcef32882002-11-26 00:34:52 +000040class BundleBuilderError(Exception): pass
41
42
Just van Rossumda302da2002-11-23 22:26:44 +000043class Defaults:
44
45 """Class attributes that don't start with an underscore and are
46 not functions or classmethods are (deep)copied to self.__dict__.
47 This allows for mutable default values.
48 """
49
50 def __init__(self, **kwargs):
51 defaults = self._getDefaults()
52 defaults.update(kwargs)
53 self.__dict__.update(defaults)
54
55 def _getDefaults(cls):
56 defaults = {}
57 for name, value in cls.__dict__.items():
58 if name[0] != "_" and not isinstance(value,
59 (function, classmethod)):
60 defaults[name] = deepcopy(value)
61 for base in cls.__bases__:
62 if hasattr(base, "_getDefaults"):
63 defaults.update(base._getDefaults())
64 return defaults
65 _getDefaults = classmethod(_getDefaults)
Just van Rossumad33d722002-11-21 10:23:04 +000066
67
Just van Rossumda302da2002-11-23 22:26:44 +000068class BundleBuilder(Defaults):
Just van Rossumad33d722002-11-21 10:23:04 +000069
70 """BundleBuilder is a barebones class for assembling bundles. It
71 knows nothing about executables or icons, it only copies files
72 and creates the PkgInfo and Info.plist files.
Just van Rossumad33d722002-11-21 10:23:04 +000073 """
74
Just van Rossumda302da2002-11-23 22:26:44 +000075 # (Note that Defaults.__init__ (deep)copies these values to
76 # instance variables. Mutable defaults are therefore safe.)
77
78 # Name of the bundle, with or without extension.
79 name = None
80
81 # The property list ("plist")
82 plist = Plist(CFBundleDevelopmentRegion = "English",
83 CFBundleInfoDictionaryVersion = "6.0")
84
85 # The type of the bundle.
Jack Jansencc81b802003-03-05 14:42:18 +000086 type = "BNDL"
Just van Rossumda302da2002-11-23 22:26:44 +000087 # The creator code of the bundle.
Just van Rossume6b49022002-11-24 01:23:45 +000088 creator = None
Just van Rossumda302da2002-11-23 22:26:44 +000089
90 # List of files that have to be copied to <bundle>/Contents/Resources.
91 resources = []
92
93 # List of (src, dest) tuples; dest should be a path relative to the bundle
94 # (eg. "Contents/Resources/MyStuff/SomeFile.ext).
95 files = []
96
97 # Directory where the bundle will be assembled.
98 builddir = "build"
99
Just van Rossumda302da2002-11-23 22:26:44 +0000100 # Make symlinks instead copying files. This is handy during debugging, but
101 # makes the bundle non-distributable.
102 symlink = 0
103
104 # Verbosity level.
105 verbosity = 1
Just van Rossumad33d722002-11-21 10:23:04 +0000106
Just van Rossumceeb9622002-11-21 23:19:37 +0000107 def setup(self):
Just van Rossumda302da2002-11-23 22:26:44 +0000108 # XXX rethink self.name munging, this is brittle.
Just van Rossumceeb9622002-11-21 23:19:37 +0000109 self.name, ext = os.path.splitext(self.name)
110 if not ext:
111 ext = ".bundle"
Just van Rossumda302da2002-11-23 22:26:44 +0000112 bundleextension = ext
Just van Rossumceeb9622002-11-21 23:19:37 +0000113 # misc (derived) attributes
Just van Rossumda302da2002-11-23 22:26:44 +0000114 self.bundlepath = pathjoin(self.builddir, self.name + bundleextension)
Just van Rossumceeb9622002-11-21 23:19:37 +0000115
Just van Rossumda302da2002-11-23 22:26:44 +0000116 plist = self.plist
Just van Rossumceeb9622002-11-21 23:19:37 +0000117 plist.CFBundleName = self.name
118 plist.CFBundlePackageType = self.type
Just van Rossume6b49022002-11-24 01:23:45 +0000119 if self.creator is None:
120 if hasattr(plist, "CFBundleSignature"):
121 self.creator = plist.CFBundleSignature
122 else:
123 self.creator = "????"
Just van Rossumceeb9622002-11-21 23:19:37 +0000124 plist.CFBundleSignature = self.creator
Just van Rossum9896ea22003-01-13 23:30:04 +0000125 if not hasattr(plist, "CFBundleIdentifier"):
126 plist.CFBundleIdentifier = self.name
Just van Rossumceeb9622002-11-21 23:19:37 +0000127
Just van Rossumad33d722002-11-21 10:23:04 +0000128 def build(self):
129 """Build the bundle."""
130 builddir = self.builddir
131 if builddir and not os.path.exists(builddir):
132 os.mkdir(builddir)
133 self.message("Building %s" % repr(self.bundlepath), 1)
134 if os.path.exists(self.bundlepath):
135 shutil.rmtree(self.bundlepath)
136 os.mkdir(self.bundlepath)
137 self.preProcess()
138 self._copyFiles()
139 self._addMetaFiles()
140 self.postProcess()
Just van Rossum535ffa22002-11-29 20:06:52 +0000141 self.message("Done.", 1)
Just van Rossumad33d722002-11-21 10:23:04 +0000142
143 def preProcess(self):
144 """Hook for subclasses."""
145 pass
146 def postProcess(self):
147 """Hook for subclasses."""
148 pass
149
150 def _addMetaFiles(self):
151 contents = pathjoin(self.bundlepath, "Contents")
152 makedirs(contents)
153 #
154 # Write Contents/PkgInfo
155 assert len(self.type) == len(self.creator) == 4, \
156 "type and creator must be 4-byte strings."
157 pkginfo = pathjoin(contents, "PkgInfo")
158 f = open(pkginfo, "wb")
159 f.write(self.type + self.creator)
160 f.close()
161 #
162 # Write Contents/Info.plist
Just van Rossumad33d722002-11-21 10:23:04 +0000163 infoplist = pathjoin(contents, "Info.plist")
Just van Rossumceeb9622002-11-21 23:19:37 +0000164 self.plist.write(infoplist)
Just van Rossumad33d722002-11-21 10:23:04 +0000165
166 def _copyFiles(self):
167 files = self.files[:]
168 for path in self.resources:
169 files.append((path, pathjoin("Contents", "Resources",
170 os.path.basename(path))))
171 if self.symlink:
172 self.message("Making symbolic links", 1)
173 msg = "Making symlink from"
174 else:
175 self.message("Copying files", 1)
176 msg = "Copying"
Just van Rossumcef32882002-11-26 00:34:52 +0000177 files.sort()
Just van Rossumad33d722002-11-21 10:23:04 +0000178 for src, dst in files:
Just van Rossumceeb9622002-11-21 23:19:37 +0000179 if os.path.isdir(src):
180 self.message("%s %s/ to %s/" % (msg, src, dst), 2)
181 else:
182 self.message("%s %s to %s" % (msg, src, dst), 2)
Just van Rossumad33d722002-11-21 10:23:04 +0000183 dst = pathjoin(self.bundlepath, dst)
184 if self.symlink:
185 symlink(src, dst, mkdirs=1)
186 else:
187 copy(src, dst, mkdirs=1)
188
189 def message(self, msg, level=0):
190 if level <= self.verbosity:
Just van Rossumceeb9622002-11-21 23:19:37 +0000191 indent = ""
192 if level > 1:
193 indent = (level - 1) * " "
194 sys.stderr.write(indent + msg + "\n")
195
196 def report(self):
197 # XXX something decent
Just van Rossum74bdca82002-11-28 11:30:56 +0000198 pass
Just van Rossumad33d722002-11-21 10:23:04 +0000199
200
Just van Rossumcef32882002-11-26 00:34:52 +0000201if __debug__:
202 PYC_EXT = ".pyc"
203else:
204 PYC_EXT = ".pyo"
205
206MAGIC = imp.get_magic()
Just van Rossum109ecbf2003-01-02 13:13:01 +0000207USE_ZIPIMPORT = "zipimport" in sys.builtin_module_names
Just van Rossumcef32882002-11-26 00:34:52 +0000208
209# For standalone apps, we have our own minimal site.py. We don't need
210# all the cruft of the real site.py.
211SITE_PY = """\
212import sys
213del sys.path[1:] # sys.path[0] is Contents/Resources/
214"""
215
Just van Rossum109ecbf2003-01-02 13:13:01 +0000216if USE_ZIPIMPORT:
217 ZIP_ARCHIVE = "Modules.zip"
218 SITE_PY += "sys.path.append(sys.path[0] + '/%s')\n" % ZIP_ARCHIVE
219 def getPycData(fullname, code, ispkg):
220 if ispkg:
221 fullname += ".__init__"
222 path = fullname.replace(".", os.sep) + PYC_EXT
223 return path, MAGIC + '\0\0\0\0' + marshal.dumps(code)
Just van Rossumcef32882002-11-26 00:34:52 +0000224
Just van Rossum74bdca82002-11-28 11:30:56 +0000225SITE_CO = compile(SITE_PY, "<-bundlebuilder.py->", "exec")
Just van Rossum7322b1a2003-02-25 20:15:40 +0000226
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000227#
228# Extension modules can't be in the modules zip archive, so a placeholder
229# is added instead, that loads the extension from a specified location.
230#
Just van Rossum535ffa22002-11-29 20:06:52 +0000231EXT_LOADER = """\
Just van Rossum109ecbf2003-01-02 13:13:01 +0000232def __load():
233 import imp, sys, os
234 for p in sys.path:
235 path = os.path.join(p, "%(filename)s")
236 if os.path.exists(path):
237 break
238 else:
239 assert 0, "file not found: %(filename)s"
240 mod = imp.load_dynamic("%(name)s", path)
241
242__load()
243del __load
Just van Rossum535ffa22002-11-29 20:06:52 +0000244"""
245
Just van Rossumcef32882002-11-26 00:34:52 +0000246MAYMISS_MODULES = ['mac', 'os2', 'nt', 'ntpath', 'dos', 'dospath',
247 'win32api', 'ce', '_winreg', 'nturl2path', 'sitecustomize',
248 'org.python.core', 'riscos', 'riscosenviron', 'riscospath'
249]
250
251STRIP_EXEC = "/usr/bin/strip"
252
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000253#
254# We're using a stock interpreter to run the app, yet we need
255# a way to pass the Python main program to the interpreter. The
256# bootstrapping script fires up the interpreter with the right
257# arguments. os.execve() is used as OSX doesn't like us to
258# start a real new process. Also, the executable name must match
259# the CFBundleExecutable value in the Info.plist, so we lie
260# deliberately with argv[0]. The actual Python executable is
261# passed in an environment variable so we can "repair"
262# sys.executable later.
263#
Just van Rossum74bdca82002-11-28 11:30:56 +0000264BOOTSTRAP_SCRIPT = """\
Just van Rossum0ff7a4e2003-02-26 11:27:56 +0000265#!%(hashbang)s
Just van Rossumad33d722002-11-21 10:23:04 +0000266
Just van Rossum7322b1a2003-02-25 20:15:40 +0000267import sys, os
268execdir = os.path.dirname(sys.argv[0])
269executable = os.path.join(execdir, "%(executable)s")
270resdir = os.path.join(os.path.dirname(execdir), "Resources")
271mainprogram = os.path.join(resdir, "%(mainprogram)s")
272
273sys.argv.insert(1, mainprogram)
274os.environ["PYTHONPATH"] = resdir
275os.environ["PYTHONEXECUTABLE"] = executable
276os.execve(executable, sys.argv, os.environ)
Just van Rossumad33d722002-11-21 10:23:04 +0000277"""
278
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000279
280#
281# Optional wrapper that converts "dropped files" into sys.argv values.
282#
283ARGV_EMULATOR = """\
Jack Jansena03adde2003-02-18 23:29:46 +0000284import argvemulator, os
285
286argvemulator.ArgvCollector().mainloop()
287execfile(os.path.join(os.path.split(__file__)[0], "%(realmainprogram)s"))
288"""
Just van Rossumcef32882002-11-26 00:34:52 +0000289
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000290
Just van Rossumad33d722002-11-21 10:23:04 +0000291class AppBuilder(BundleBuilder):
292
Jack Jansencc81b802003-03-05 14:42:18 +0000293 # Override type of the bundle.
Jack Jansen620c0832003-03-05 14:44:54 +0000294 type = "APPL"
Jack Jansencc81b802003-03-05 14:42:18 +0000295
296 # platform, name of the subfolder of Contents that contains the executable.
297 platform = "MacOS"
298
Just van Rossumda302da2002-11-23 22:26:44 +0000299 # A Python main program. If this argument is given, the main
300 # executable in the bundle will be a small wrapper that invokes
301 # the main program. (XXX Discuss why.)
302 mainprogram = None
Just van Rossumceeb9622002-11-21 23:19:37 +0000303
Just van Rossumda302da2002-11-23 22:26:44 +0000304 # The main executable. If a Python main program is specified
305 # the executable will be copied to Resources and be invoked
306 # by the wrapper program mentioned above. Otherwise it will
307 # simply be used as the main executable.
308 executable = None
Just van Rossumceeb9622002-11-21 23:19:37 +0000309
Just van Rossumda302da2002-11-23 22:26:44 +0000310 # The name of the main nib, for Cocoa apps. *Must* be specified
311 # when building a Cocoa app.
312 nibname = None
Just van Rossumad33d722002-11-21 10:23:04 +0000313
Just van Rossum2aa09562003-02-01 08:34:46 +0000314 # The name of the icon file to be copied to Resources and used for
315 # the Finder icon.
316 iconfile = None
317
Just van Rossumda302da2002-11-23 22:26:44 +0000318 # Symlink the executable instead of copying it.
319 symlink_exec = 0
Just van Rossumad33d722002-11-21 10:23:04 +0000320
Just van Rossumcef32882002-11-26 00:34:52 +0000321 # If True, build standalone app.
322 standalone = 0
Jack Jansena03adde2003-02-18 23:29:46 +0000323
324 # If True, add a real main program that emulates sys.argv before calling
325 # mainprogram
326 argv_emulation = 0
Just van Rossumcef32882002-11-26 00:34:52 +0000327
328 # The following attributes are only used when building a standalone app.
329
330 # Exclude these modules.
331 excludeModules = []
332
333 # Include these modules.
334 includeModules = []
335
336 # Include these packages.
337 includePackages = []
338
339 # Strip binaries.
340 strip = 0
341
Just van Rossumcef32882002-11-26 00:34:52 +0000342 # Found Python modules: [(name, codeobject, ispkg), ...]
343 pymodules = []
344
345 # Modules that modulefinder couldn't find:
346 missingModules = []
Just van Rossum74bdca82002-11-28 11:30:56 +0000347 maybeMissingModules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000348
349 # List of all binaries (executables or shared libs), for stripping purposes
350 binaries = []
351
Just van Rossumceeb9622002-11-21 23:19:37 +0000352 def setup(self):
Just van Rossumcef32882002-11-26 00:34:52 +0000353 if self.standalone and self.mainprogram is None:
354 raise BundleBuilderError, ("must specify 'mainprogram' when "
355 "building a standalone application.")
Just van Rossumceeb9622002-11-21 23:19:37 +0000356 if self.mainprogram is None and self.executable is None:
Just van Rossumcef32882002-11-26 00:34:52 +0000357 raise BundleBuilderError, ("must specify either or both of "
Just van Rossumceeb9622002-11-21 23:19:37 +0000358 "'executable' and 'mainprogram'")
359
Jack Jansencc81b802003-03-05 14:42:18 +0000360 self.execdir = pathjoin("Contents", self.platform)
361
Just van Rossumceeb9622002-11-21 23:19:37 +0000362 if self.name is not None:
363 pass
364 elif self.mainprogram is not None:
365 self.name = os.path.splitext(os.path.basename(self.mainprogram))[0]
366 elif executable is not None:
367 self.name = os.path.splitext(os.path.basename(self.executable))[0]
368 if self.name[-4:] != ".app":
369 self.name += ".app"
Just van Rossumceeb9622002-11-21 23:19:37 +0000370
Just van Rossum74bdca82002-11-28 11:30:56 +0000371 if self.executable is None:
372 if not self.standalone:
373 self.symlink_exec = 1
374 self.executable = sys.executable
375
Just van Rossumceeb9622002-11-21 23:19:37 +0000376 if self.nibname:
377 self.plist.NSMainNibFile = self.nibname
378 if not hasattr(self.plist, "NSPrincipalClass"):
379 self.plist.NSPrincipalClass = "NSApplication"
380
381 BundleBuilder.setup(self)
382
Just van Rossum7fd69ad2002-11-22 00:08:47 +0000383 self.plist.CFBundleExecutable = self.name
Just van Rossumf7aba232002-11-22 00:31:50 +0000384
Just van Rossumcef32882002-11-26 00:34:52 +0000385 if self.standalone:
Just van Rossumcef32882002-11-26 00:34:52 +0000386 self.findDependencies()
387
Just van Rossumf7aba232002-11-22 00:31:50 +0000388 def preProcess(self):
Just van Rossumcef32882002-11-26 00:34:52 +0000389 resdir = "Contents/Resources"
Just van Rossumad33d722002-11-21 10:23:04 +0000390 if self.executable is not None:
391 if self.mainprogram is None:
Just van Rossum74bdca82002-11-28 11:30:56 +0000392 execname = self.name
Just van Rossumad33d722002-11-21 10:23:04 +0000393 else:
Just van Rossum74bdca82002-11-28 11:30:56 +0000394 execname = os.path.basename(self.executable)
395 execpath = pathjoin(self.execdir, execname)
Just van Rossum16aebf72002-11-22 11:43:10 +0000396 if not self.symlink_exec:
397 self.files.append((self.executable, execpath))
Just van Rossumcef32882002-11-26 00:34:52 +0000398 self.binaries.append(execpath)
Just van Rossumda302da2002-11-23 22:26:44 +0000399 self.execpath = execpath
Just van Rossumad33d722002-11-21 10:23:04 +0000400
401 if self.mainprogram is not None:
Just van Rossum24884f72002-11-29 21:22:33 +0000402 mainprogram = os.path.basename(self.mainprogram)
403 self.files.append((self.mainprogram, pathjoin(resdir, mainprogram)))
Jack Jansena03adde2003-02-18 23:29:46 +0000404 if self.argv_emulation:
405 # Change the main program, and create the helper main program (which
406 # does argv collection and then calls the real main).
407 # Also update the included modules (if we're creating a standalone
408 # program) and the plist
409 realmainprogram = mainprogram
410 mainprogram = '__argvemulator_' + mainprogram
411 resdirpath = pathjoin(self.bundlepath, resdir)
412 mainprogrampath = pathjoin(resdirpath, mainprogram)
413 makedirs(resdirpath)
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000414 open(mainprogrampath, "w").write(ARGV_EMULATOR % locals())
Jack Jansena03adde2003-02-18 23:29:46 +0000415 if self.standalone:
416 self.includeModules.append("argvemulator")
417 self.includeModules.append("os")
418 if not self.plist.has_key("CFBundleDocumentTypes"):
419 self.plist["CFBundleDocumentTypes"] = [
420 { "CFBundleTypeOSTypes" : [
421 "****",
422 "fold",
423 "disk"],
424 "CFBundleTypeRole": "Viewer"}]
Just van Rossum24884f72002-11-29 21:22:33 +0000425 # Write bootstrap script
Just van Rossum74bdca82002-11-28 11:30:56 +0000426 executable = os.path.basename(self.executable)
Just van Rossumad33d722002-11-21 10:23:04 +0000427 execdir = pathjoin(self.bundlepath, self.execdir)
Just van Rossum24884f72002-11-29 21:22:33 +0000428 bootstrappath = pathjoin(execdir, self.name)
Just van Rossumad33d722002-11-21 10:23:04 +0000429 makedirs(execdir)
Just van Rossum0ff7a4e2003-02-26 11:27:56 +0000430 if self.standalone:
431 # XXX we're screwed when the end user has deleted
432 # /usr/bin/python
433 hashbang = "/usr/bin/python"
434 else:
435 hashbang = sys.executable
436 while os.path.islink(hashbang):
437 hashbang = os.readlink(hashbang)
Just van Rossum24884f72002-11-29 21:22:33 +0000438 open(bootstrappath, "w").write(BOOTSTRAP_SCRIPT % locals())
439 os.chmod(bootstrappath, 0775)
Just van Rossumad33d722002-11-21 10:23:04 +0000440
Just van Rossum2aa09562003-02-01 08:34:46 +0000441 if self.iconfile is not None:
442 iconbase = os.path.basename(self.iconfile)
443 self.plist.CFBundleIconFile = iconbase
444 self.files.append((self.iconfile, pathjoin(resdir, iconbase)))
445
Just van Rossum16aebf72002-11-22 11:43:10 +0000446 def postProcess(self):
Just van Rossum888e1002002-11-30 19:56:14 +0000447 if self.standalone:
448 self.addPythonModules()
Just van Rossumcef32882002-11-26 00:34:52 +0000449 if self.strip and not self.symlink:
450 self.stripBinaries()
451
Just van Rossum16aebf72002-11-22 11:43:10 +0000452 if self.symlink_exec and self.executable:
453 self.message("Symlinking executable %s to %s" % (self.executable,
454 self.execpath), 2)
455 dst = pathjoin(self.bundlepath, self.execpath)
456 makedirs(os.path.dirname(dst))
457 os.symlink(os.path.abspath(self.executable), dst)
458
Just van Rossum74bdca82002-11-28 11:30:56 +0000459 if self.missingModules or self.maybeMissingModules:
Just van Rossumcef32882002-11-26 00:34:52 +0000460 self.reportMissing()
461
462 def addPythonModules(self):
463 self.message("Adding Python modules", 1)
Just van Rossumcef32882002-11-26 00:34:52 +0000464
Just van Rossum109ecbf2003-01-02 13:13:01 +0000465 if USE_ZIPIMPORT:
466 # Create a zip file containing all modules as pyc.
467 import zipfile
468 relpath = pathjoin("Contents", "Resources", ZIP_ARCHIVE)
Just van Rossumcef32882002-11-26 00:34:52 +0000469 abspath = pathjoin(self.bundlepath, relpath)
Just van Rossum109ecbf2003-01-02 13:13:01 +0000470 zf = zipfile.ZipFile(abspath, "w", zipfile.ZIP_DEFLATED)
471 for name, code, ispkg in self.pymodules:
472 self.message("Adding Python module %s" % name, 2)
473 path, pyc = getPycData(name, code, ispkg)
474 zf.writestr(path, pyc)
475 zf.close()
Just van Rossumcef32882002-11-26 00:34:52 +0000476 # add site.pyc
Just van Rossum535ffa22002-11-29 20:06:52 +0000477 sitepath = pathjoin(self.bundlepath, "Contents", "Resources",
478 "site" + PYC_EXT)
Just van Rossumcef32882002-11-26 00:34:52 +0000479 writePyc(SITE_CO, sitepath)
480 else:
481 # Create individual .pyc files.
Just van Rossum535ffa22002-11-29 20:06:52 +0000482 for name, code, ispkg in self.pymodules:
Just van Rossumcef32882002-11-26 00:34:52 +0000483 if ispkg:
484 name += ".__init__"
485 path = name.split(".")
Just van Rossum535ffa22002-11-29 20:06:52 +0000486 path = pathjoin("Contents", "Resources", *path) + PYC_EXT
Just van Rossumcef32882002-11-26 00:34:52 +0000487
488 if ispkg:
489 self.message("Adding Python package %s" % path, 2)
490 else:
491 self.message("Adding Python module %s" % path, 2)
492
493 abspath = pathjoin(self.bundlepath, path)
494 makedirs(os.path.dirname(abspath))
495 writePyc(code, abspath)
496
497 def stripBinaries(self):
498 if not os.path.exists(STRIP_EXEC):
499 self.message("Error: can't strip binaries: no strip program at "
500 "%s" % STRIP_EXEC, 0)
501 else:
502 self.message("Stripping binaries", 1)
503 for relpath in self.binaries:
504 self.message("Stripping %s" % relpath, 2)
505 abspath = pathjoin(self.bundlepath, relpath)
506 assert not os.path.islink(abspath)
507 rv = os.system("%s -S \"%s\"" % (STRIP_EXEC, abspath))
508
509 def findDependencies(self):
510 self.message("Finding module dependencies", 1)
511 import modulefinder
512 mf = modulefinder.ModuleFinder(excludes=self.excludeModules)
Just van Rossum109ecbf2003-01-02 13:13:01 +0000513 if USE_ZIPIMPORT:
514 # zipimport imports zlib, must add it manually
515 mf.import_hook("zlib")
Just van Rossumcef32882002-11-26 00:34:52 +0000516 # manually add our own site.py
517 site = mf.add_module("site")
518 site.__code__ = SITE_CO
519 mf.scan_code(SITE_CO, site)
520
Just van Rossum7322b1a2003-02-25 20:15:40 +0000521 # warnings.py gets imported implicitly from C
522 mf.import_hook("warnings")
523
Just van Rossumcef32882002-11-26 00:34:52 +0000524 includeModules = self.includeModules[:]
525 for name in self.includePackages:
526 includeModules.extend(findPackageContents(name).keys())
527 for name in includeModules:
528 try:
529 mf.import_hook(name)
530 except ImportError:
531 self.missingModules.append(name)
532
Just van Rossumcef32882002-11-26 00:34:52 +0000533 mf.run_script(self.mainprogram)
534 modules = mf.modules.items()
535 modules.sort()
536 for name, mod in modules:
537 if mod.__file__ and mod.__code__ is None:
538 # C extension
539 path = mod.__file__
Just van Rossum535ffa22002-11-29 20:06:52 +0000540 filename = os.path.basename(path)
Just van Rossum109ecbf2003-01-02 13:13:01 +0000541 if USE_ZIPIMPORT:
542 # Python modules are stored in a Zip archive, but put
543 # extensions in Contents/Resources/.a and add a tiny "loader"
544 # program in the Zip archive. Due to Thomas Heller.
Just van Rossum535ffa22002-11-29 20:06:52 +0000545 dstpath = pathjoin("Contents", "Resources", filename)
546 source = EXT_LOADER % {"name": name, "filename": filename}
547 code = compile(source, "<dynloader for %s>" % name, "exec")
548 mod.__code__ = code
Just van Rossumcef32882002-11-26 00:34:52 +0000549 else:
Just van Rossum535ffa22002-11-29 20:06:52 +0000550 # just copy the file
551 dstpath = name.split(".")[:-1] + [filename]
552 dstpath = pathjoin("Contents", "Resources", *dstpath)
Just van Rossumcef32882002-11-26 00:34:52 +0000553 self.files.append((path, dstpath))
Just van Rossumcef32882002-11-26 00:34:52 +0000554 self.binaries.append(dstpath)
Just van Rossum535ffa22002-11-29 20:06:52 +0000555 if mod.__code__ is not None:
Just van Rossumcef32882002-11-26 00:34:52 +0000556 ispkg = mod.__path__ is not None
Just van Rossum109ecbf2003-01-02 13:13:01 +0000557 if not USE_ZIPIMPORT or name != "site":
Just van Rossumcef32882002-11-26 00:34:52 +0000558 # Our site.py is doing the bootstrapping, so we must
Just van Rossum109ecbf2003-01-02 13:13:01 +0000559 # include a real .pyc file if USE_ZIPIMPORT is True.
Just van Rossumcef32882002-11-26 00:34:52 +0000560 self.pymodules.append((name, mod.__code__, ispkg))
561
Just van Rossum74bdca82002-11-28 11:30:56 +0000562 if hasattr(mf, "any_missing_maybe"):
563 missing, maybe = mf.any_missing_maybe()
564 else:
565 missing = mf.any_missing()
566 maybe = []
567 self.missingModules.extend(missing)
568 self.maybeMissingModules.extend(maybe)
Just van Rossumcef32882002-11-26 00:34:52 +0000569
570 def reportMissing(self):
571 missing = [name for name in self.missingModules
572 if name not in MAYMISS_MODULES]
Just van Rossum74bdca82002-11-28 11:30:56 +0000573 if self.maybeMissingModules:
574 maybe = self.maybeMissingModules
575 else:
576 maybe = [name for name in missing if "." in name]
577 missing = [name for name in missing if "." not in name]
Just van Rossumcef32882002-11-26 00:34:52 +0000578 missing.sort()
Just van Rossum74bdca82002-11-28 11:30:56 +0000579 maybe.sort()
580 if maybe:
581 self.message("Warning: couldn't find the following submodules:", 1)
582 self.message(" (Note that these could be false alarms -- "
583 "it's not always", 1)
Just van Rossumad692cc2002-11-28 18:56:50 +0000584 self.message(" possible to distinguish between \"from package "
585 "import submodule\" ", 1)
Just van Rossum74bdca82002-11-28 11:30:56 +0000586 self.message(" and \"from package import name\")", 1)
587 for name in maybe:
588 self.message(" ? " + name, 1)
Just van Rossumcef32882002-11-26 00:34:52 +0000589 if missing:
590 self.message("Warning: couldn't find the following modules:", 1)
Just van Rossum74bdca82002-11-28 11:30:56 +0000591 for name in missing:
592 self.message(" ? " + name, 1)
593
594 def report(self):
595 # XXX something decent
596 import pprint
597 pprint.pprint(self.__dict__)
598 if self.standalone:
599 self.reportMissing()
Just van Rossumcef32882002-11-26 00:34:52 +0000600
601#
602# Utilities.
603#
604
605SUFFIXES = [_suf for _suf, _mode, _tp in imp.get_suffixes()]
606identifierRE = re.compile(r"[_a-zA-z][_a-zA-Z0-9]*$")
607
608def findPackageContents(name, searchpath=None):
609 head = name.split(".")[-1]
610 if identifierRE.match(head) is None:
611 return {}
612 try:
613 fp, path, (ext, mode, tp) = imp.find_module(head, searchpath)
614 except ImportError:
615 return {}
616 modules = {name: None}
617 if tp == imp.PKG_DIRECTORY and path:
618 files = os.listdir(path)
619 for sub in files:
620 sub, ext = os.path.splitext(sub)
621 fullname = name + "." + sub
622 if sub != "__init__" and fullname not in modules:
623 modules.update(findPackageContents(fullname, [path]))
624 return modules
625
626def writePyc(code, path):
627 f = open(path, "wb")
Just van Rossumcef32882002-11-26 00:34:52 +0000628 f.write(MAGIC)
Just van Rossum109ecbf2003-01-02 13:13:01 +0000629 f.write("\0" * 4) # don't bother about a time stamp
630 marshal.dump(code, f)
Just van Rossumcef32882002-11-26 00:34:52 +0000631 f.close()
Just van Rossumad33d722002-11-21 10:23:04 +0000632
Just van Rossumad33d722002-11-21 10:23:04 +0000633def copy(src, dst, mkdirs=0):
634 """Copy a file or a directory."""
635 if mkdirs:
636 makedirs(os.path.dirname(dst))
637 if os.path.isdir(src):
638 shutil.copytree(src, dst)
639 else:
640 shutil.copy2(src, dst)
641
642def copytodir(src, dstdir):
643 """Copy a file or a directory to an existing directory."""
644 dst = pathjoin(dstdir, os.path.basename(src))
645 copy(src, dst)
646
647def makedirs(dir):
648 """Make all directories leading up to 'dir' including the leaf
649 directory. Don't moan if any path element already exists."""
650 try:
651 os.makedirs(dir)
652 except OSError, why:
653 if why.errno != errno.EEXIST:
654 raise
655
656def symlink(src, dst, mkdirs=0):
657 """Copy a file or a directory."""
Just van Rossum504377d2003-01-17 20:02:06 +0000658 if not os.path.exists(src):
659 raise IOError, "No such file or directory: '%s'" % src
Just van Rossumad33d722002-11-21 10:23:04 +0000660 if mkdirs:
661 makedirs(os.path.dirname(dst))
662 os.symlink(os.path.abspath(src), dst)
663
664def pathjoin(*args):
665 """Safe wrapper for os.path.join: asserts that all but the first
666 argument are relative paths."""
667 for seg in args[1:]:
668 assert seg[0] != "/"
669 return os.path.join(*args)
670
671
Just van Rossumceeb9622002-11-21 23:19:37 +0000672cmdline_doc = """\
673Usage:
Just van Rossumf7aba232002-11-22 00:31:50 +0000674 python bundlebuilder.py [options] command
Just van Rossumceeb9622002-11-21 23:19:37 +0000675 python mybuildscript.py [options] command
676
677Commands:
678 build build the application
679 report print a report
680
681Options:
682 -b, --builddir=DIR the build directory; defaults to "build"
683 -n, --name=NAME application name
684 -r, --resource=FILE extra file or folder to be copied to Resources
Just van Rossum7215e082003-02-25 21:00:55 +0000685 -f, --file=SRC:DST extra file or folder to be copied into the bundle;
686 DST must be a path relative to the bundle root
Just van Rossumceeb9622002-11-21 23:19:37 +0000687 -e, --executable=FILE the executable to be used
688 -m, --mainprogram=FILE the Python main program
Jack Jansena03adde2003-02-18 23:29:46 +0000689 -a, --argv add a wrapper main program to create sys.argv
Just van Rossumceeb9622002-11-21 23:19:37 +0000690 -p, --plist=FILE .plist file (default: generate one)
691 --nib=NAME main nib name
692 -c, --creator=CCCC 4-char creator code (default: '????')
Just van Rossum9af69682003-02-02 18:56:37 +0000693 --iconfile=FILE filename of the icon (an .icns file) to be used
Just van Rossum2aa09562003-02-01 08:34:46 +0000694 as the Finder icon
Just van Rossumceeb9622002-11-21 23:19:37 +0000695 -l, --link symlink files/folder instead of copying them
Just van Rossum16aebf72002-11-22 11:43:10 +0000696 --link-exec symlink the executable instead of copying it
Just van Rossumcef32882002-11-26 00:34:52 +0000697 --standalone build a standalone application, which is fully
698 independent of a Python installation
699 -x, --exclude=MODULE exclude module (with --standalone)
700 -i, --include=MODULE include module (with --standalone)
701 --package=PACKAGE include a whole package (with --standalone)
702 --strip strip binaries (remove debug info)
Just van Rossumceeb9622002-11-21 23:19:37 +0000703 -v, --verbose increase verbosity level
704 -q, --quiet decrease verbosity level
705 -h, --help print this message
706"""
707
708def usage(msg=None):
709 if msg:
710 print msg
711 print cmdline_doc
712 sys.exit(1)
713
714def main(builder=None):
715 if builder is None:
716 builder = AppBuilder(verbosity=1)
717
Jack Jansen00cbf072003-02-24 16:27:08 +0000718 shortopts = "b:n:r:f:e:m:c:p:lx:i:hvqa"
Just van Rossum7215e082003-02-25 21:00:55 +0000719 longopts = ("builddir=", "name=", "resource=", "file=", "executable=",
Just van Rossum16aebf72002-11-22 11:43:10 +0000720 "mainprogram=", "creator=", "nib=", "plist=", "link",
Jack Jansena03adde2003-02-18 23:29:46 +0000721 "link-exec", "help", "verbose", "quiet", "argv", "standalone",
Just van Rossum2aa09562003-02-01 08:34:46 +0000722 "exclude=", "include=", "package=", "strip", "iconfile=")
Just van Rossumceeb9622002-11-21 23:19:37 +0000723
724 try:
725 options, args = getopt.getopt(sys.argv[1:], shortopts, longopts)
726 except getopt.error:
727 usage()
728
729 for opt, arg in options:
730 if opt in ('-b', '--builddir'):
731 builder.builddir = arg
732 elif opt in ('-n', '--name'):
733 builder.name = arg
734 elif opt in ('-r', '--resource'):
735 builder.resources.append(arg)
Just van Rossum7215e082003-02-25 21:00:55 +0000736 elif opt in ('-f', '--file'):
Jack Jansen00cbf072003-02-24 16:27:08 +0000737 srcdst = arg.split(':')
738 if len(srcdst) != 2:
Just van Rossum49833312003-02-25 21:08:12 +0000739 usage("-f or --file argument must be two paths, "
740 "separated by a colon")
Jack Jansen00cbf072003-02-24 16:27:08 +0000741 builder.files.append(srcdst)
Just van Rossumceeb9622002-11-21 23:19:37 +0000742 elif opt in ('-e', '--executable'):
743 builder.executable = arg
744 elif opt in ('-m', '--mainprogram'):
745 builder.mainprogram = arg
Jack Jansena03adde2003-02-18 23:29:46 +0000746 elif opt in ('-a', '--argv'):
747 builder.argv_emulation = 1
Just van Rossumceeb9622002-11-21 23:19:37 +0000748 elif opt in ('-c', '--creator'):
749 builder.creator = arg
Just van Rossum2aa09562003-02-01 08:34:46 +0000750 elif opt == '--iconfile':
751 builder.iconfile = arg
Just van Rossumceeb9622002-11-21 23:19:37 +0000752 elif opt == "--nib":
753 builder.nibname = arg
754 elif opt in ('-p', '--plist'):
755 builder.plist = Plist.fromFile(arg)
756 elif opt in ('-l', '--link'):
757 builder.symlink = 1
Just van Rossum16aebf72002-11-22 11:43:10 +0000758 elif opt == '--link-exec':
759 builder.symlink_exec = 1
Just van Rossumceeb9622002-11-21 23:19:37 +0000760 elif opt in ('-h', '--help'):
761 usage()
762 elif opt in ('-v', '--verbose'):
763 builder.verbosity += 1
764 elif opt in ('-q', '--quiet'):
765 builder.verbosity -= 1
Just van Rossumcef32882002-11-26 00:34:52 +0000766 elif opt == '--standalone':
767 builder.standalone = 1
768 elif opt in ('-x', '--exclude'):
769 builder.excludeModules.append(arg)
770 elif opt in ('-i', '--include'):
771 builder.includeModules.append(arg)
772 elif opt == '--package':
773 builder.includePackages.append(arg)
774 elif opt == '--strip':
775 builder.strip = 1
Just van Rossumceeb9622002-11-21 23:19:37 +0000776
777 if len(args) != 1:
778 usage("Must specify one command ('build', 'report' or 'help')")
779 command = args[0]
780
781 if command == "build":
782 builder.setup()
783 builder.build()
784 elif command == "report":
785 builder.setup()
786 builder.report()
787 elif command == "help":
788 usage()
789 else:
790 usage("Unknown command '%s'" % command)
791
792
Just van Rossumad33d722002-11-21 10:23:04 +0000793def buildapp(**kwargs):
Just van Rossumad33d722002-11-21 10:23:04 +0000794 builder = AppBuilder(**kwargs)
Just van Rossumceeb9622002-11-21 23:19:37 +0000795 main(builder)
Just van Rossumad33d722002-11-21 10:23:04 +0000796
797
798if __name__ == "__main__":
Just van Rossumceeb9622002-11-21 23:19:37 +0000799 main()