blob: a88edc9ac210c491132b3843afbaee6d1b5362a9 [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
Jack Jansen0ae32202003-04-09 13:25:43 +000045 """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 """
Just van Rossumda302da2002-11-23 22:26:44 +000049
Jack Jansen0ae32202003-04-09 13:25:43 +000050 def __init__(self, **kwargs):
51 defaults = self._getDefaults()
52 defaults.update(kwargs)
53 self.__dict__.update(defaults)
Just van Rossumda302da2002-11-23 22:26:44 +000054
Jack Jansen0ae32202003-04-09 13:25:43 +000055 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
Jack Jansen0ae32202003-04-09 13:25:43 +000070 """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.
73 """
Just van Rossumad33d722002-11-21 10:23:04 +000074
Jack Jansen0ae32202003-04-09 13:25:43 +000075 # (Note that Defaults.__init__ (deep)copies these values to
76 # instance variables. Mutable defaults are therefore safe.)
Just van Rossumda302da2002-11-23 22:26:44 +000077
Jack Jansen0ae32202003-04-09 13:25:43 +000078 # Name of the bundle, with or without extension.
79 name = None
Just van Rossumda302da2002-11-23 22:26:44 +000080
Jack Jansen0ae32202003-04-09 13:25:43 +000081 # The property list ("plist")
82 plist = Plist(CFBundleDevelopmentRegion = "English",
83 CFBundleInfoDictionaryVersion = "6.0")
Just van Rossumda302da2002-11-23 22:26:44 +000084
Jack Jansen0ae32202003-04-09 13:25:43 +000085 # The type of the bundle.
86 type = "BNDL"
87 # The creator code of the bundle.
88 creator = None
Just van Rossumda302da2002-11-23 22:26:44 +000089
Jack Jansen0ae32202003-04-09 13:25:43 +000090 # List of files that have to be copied to <bundle>/Contents/Resources.
91 resources = []
Just van Rossumda302da2002-11-23 22:26:44 +000092
Jack Jansen0ae32202003-04-09 13:25:43 +000093 # List of (src, dest) tuples; dest should be a path relative to the bundle
94 # (eg. "Contents/Resources/MyStuff/SomeFile.ext).
95 files = []
Just van Rossumda302da2002-11-23 22:26:44 +000096
Jack Jansen0ae32202003-04-09 13:25:43 +000097 # List of shared libraries (dylibs, Frameworks) to bundle with the app
98 # will be placed in Contents/Frameworks
99 libs = []
Just van Rossum15624d82003-03-21 09:26:59 +0000100
Jack Jansen0ae32202003-04-09 13:25:43 +0000101 # Directory where the bundle will be assembled.
102 builddir = "build"
Just van Rossumda302da2002-11-23 22:26:44 +0000103
Jack Jansen0ae32202003-04-09 13:25:43 +0000104 # Make symlinks instead copying files. This is handy during debugging, but
105 # makes the bundle non-distributable.
106 symlink = 0
Just van Rossumda302da2002-11-23 22:26:44 +0000107
Jack Jansen0ae32202003-04-09 13:25:43 +0000108 # Verbosity level.
109 verbosity = 1
Just van Rossumad33d722002-11-21 10:23:04 +0000110
Jack Jansen0ae32202003-04-09 13:25:43 +0000111 def setup(self):
112 # XXX rethink self.name munging, this is brittle.
113 self.name, ext = os.path.splitext(self.name)
114 if not ext:
115 ext = ".bundle"
116 bundleextension = ext
117 # misc (derived) attributes
118 self.bundlepath = pathjoin(self.builddir, self.name + bundleextension)
Just van Rossumceeb9622002-11-21 23:19:37 +0000119
Jack Jansen0ae32202003-04-09 13:25:43 +0000120 plist = self.plist
121 plist.CFBundleName = self.name
122 plist.CFBundlePackageType = self.type
123 if self.creator is None:
124 if hasattr(plist, "CFBundleSignature"):
125 self.creator = plist.CFBundleSignature
126 else:
127 self.creator = "????"
128 plist.CFBundleSignature = self.creator
129 if not hasattr(plist, "CFBundleIdentifier"):
130 plist.CFBundleIdentifier = self.name
Just van Rossumceeb9622002-11-21 23:19:37 +0000131
Jack Jansen0ae32202003-04-09 13:25:43 +0000132 def build(self):
133 """Build the bundle."""
134 builddir = self.builddir
135 if builddir and not os.path.exists(builddir):
136 os.mkdir(builddir)
137 self.message("Building %s" % repr(self.bundlepath), 1)
138 if os.path.exists(self.bundlepath):
139 shutil.rmtree(self.bundlepath)
140 os.mkdir(self.bundlepath)
141 self.preProcess()
142 self._copyFiles()
143 self._addMetaFiles()
144 self.postProcess()
145 self.message("Done.", 1)
Just van Rossumad33d722002-11-21 10:23:04 +0000146
Jack Jansen0ae32202003-04-09 13:25:43 +0000147 def preProcess(self):
148 """Hook for subclasses."""
149 pass
150 def postProcess(self):
151 """Hook for subclasses."""
152 pass
Just van Rossumad33d722002-11-21 10:23:04 +0000153
Jack Jansen0ae32202003-04-09 13:25:43 +0000154 def _addMetaFiles(self):
155 contents = pathjoin(self.bundlepath, "Contents")
156 makedirs(contents)
157 #
158 # Write Contents/PkgInfo
159 assert len(self.type) == len(self.creator) == 4, \
160 "type and creator must be 4-byte strings."
161 pkginfo = pathjoin(contents, "PkgInfo")
162 f = open(pkginfo, "wb")
163 f.write(self.type + self.creator)
164 f.close()
165 #
166 # Write Contents/Info.plist
167 infoplist = pathjoin(contents, "Info.plist")
168 self.plist.write(infoplist)
Just van Rossumad33d722002-11-21 10:23:04 +0000169
Jack Jansen0ae32202003-04-09 13:25:43 +0000170 def _copyFiles(self):
171 files = self.files[:]
172 for path in self.resources:
173 files.append((path, pathjoin("Contents", "Resources",
Just van Rossumdc31dc02003-06-20 21:43:36 +0000174 os.path.basename(path))))
Jack Jansen0ae32202003-04-09 13:25:43 +0000175 for path in self.libs:
176 files.append((path, pathjoin("Contents", "Frameworks",
Just van Rossumdc31dc02003-06-20 21:43:36 +0000177 os.path.basename(path))))
Jack Jansen0ae32202003-04-09 13:25:43 +0000178 if self.symlink:
179 self.message("Making symbolic links", 1)
180 msg = "Making symlink from"
181 else:
182 self.message("Copying files", 1)
183 msg = "Copying"
184 files.sort()
185 for src, dst in files:
186 if os.path.isdir(src):
187 self.message("%s %s/ to %s/" % (msg, src, dst), 2)
188 else:
189 self.message("%s %s to %s" % (msg, src, dst), 2)
190 dst = pathjoin(self.bundlepath, dst)
191 if self.symlink:
192 symlink(src, dst, mkdirs=1)
193 else:
194 copy(src, dst, mkdirs=1)
Just van Rossumad33d722002-11-21 10:23:04 +0000195
Jack Jansen0ae32202003-04-09 13:25:43 +0000196 def message(self, msg, level=0):
197 if level <= self.verbosity:
198 indent = ""
199 if level > 1:
200 indent = (level - 1) * " "
201 sys.stderr.write(indent + msg + "\n")
Just van Rossumceeb9622002-11-21 23:19:37 +0000202
Jack Jansen0ae32202003-04-09 13:25:43 +0000203 def report(self):
204 # XXX something decent
205 pass
Just van Rossumad33d722002-11-21 10:23:04 +0000206
207
Just van Rossumcef32882002-11-26 00:34:52 +0000208if __debug__:
Jack Jansen0ae32202003-04-09 13:25:43 +0000209 PYC_EXT = ".pyc"
Just van Rossumcef32882002-11-26 00:34:52 +0000210else:
Jack Jansen0ae32202003-04-09 13:25:43 +0000211 PYC_EXT = ".pyo"
Just van Rossumcef32882002-11-26 00:34:52 +0000212
213MAGIC = imp.get_magic()
Just van Rossum109ecbf2003-01-02 13:13:01 +0000214USE_ZIPIMPORT = "zipimport" in sys.builtin_module_names
Just van Rossumcef32882002-11-26 00:34:52 +0000215
216# For standalone apps, we have our own minimal site.py. We don't need
217# all the cruft of the real site.py.
218SITE_PY = """\
219import sys
220del sys.path[1:] # sys.path[0] is Contents/Resources/
221"""
222
Just van Rossum109ecbf2003-01-02 13:13:01 +0000223if USE_ZIPIMPORT:
Jack Jansen0ae32202003-04-09 13:25:43 +0000224 ZIP_ARCHIVE = "Modules.zip"
225 SITE_PY += "sys.path.append(sys.path[0] + '/%s')\n" % ZIP_ARCHIVE
226 def getPycData(fullname, code, ispkg):
227 if ispkg:
228 fullname += ".__init__"
229 path = fullname.replace(".", os.sep) + PYC_EXT
230 return path, MAGIC + '\0\0\0\0' + marshal.dumps(code)
Just van Rossumcef32882002-11-26 00:34:52 +0000231
Just van Rossum74bdca82002-11-28 11:30:56 +0000232SITE_CO = compile(SITE_PY, "<-bundlebuilder.py->", "exec")
Just van Rossum7322b1a2003-02-25 20:15:40 +0000233
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000234#
235# Extension modules can't be in the modules zip archive, so a placeholder
236# is added instead, that loads the extension from a specified location.
237#
Just van Rossum535ffa22002-11-29 20:06:52 +0000238EXT_LOADER = """\
Just van Rossum109ecbf2003-01-02 13:13:01 +0000239def __load():
Jack Jansen0ae32202003-04-09 13:25:43 +0000240 import imp, sys, os
241 for p in sys.path:
242 path = os.path.join(p, "%(filename)s")
243 if os.path.exists(path):
244 break
245 else:
246 assert 0, "file not found: %(filename)s"
247 mod = imp.load_dynamic("%(name)s", path)
Just van Rossum109ecbf2003-01-02 13:13:01 +0000248
249__load()
250del __load
Just van Rossum535ffa22002-11-29 20:06:52 +0000251"""
252
Just van Rossumcef32882002-11-26 00:34:52 +0000253MAYMISS_MODULES = ['mac', 'os2', 'nt', 'ntpath', 'dos', 'dospath',
Jack Jansen0ae32202003-04-09 13:25:43 +0000254 'win32api', 'ce', '_winreg', 'nturl2path', 'sitecustomize',
255 'org.python.core', 'riscos', 'riscosenviron', 'riscospath'
Just van Rossumcef32882002-11-26 00:34:52 +0000256]
257
258STRIP_EXEC = "/usr/bin/strip"
259
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000260#
261# We're using a stock interpreter to run the app, yet we need
262# a way to pass the Python main program to the interpreter. The
263# bootstrapping script fires up the interpreter with the right
264# arguments. os.execve() is used as OSX doesn't like us to
265# start a real new process. Also, the executable name must match
266# the CFBundleExecutable value in the Info.plist, so we lie
267# deliberately with argv[0]. The actual Python executable is
268# passed in an environment variable so we can "repair"
269# sys.executable later.
270#
Just van Rossum74bdca82002-11-28 11:30:56 +0000271BOOTSTRAP_SCRIPT = """\
Just van Rossum0ff7a4e2003-02-26 11:27:56 +0000272#!%(hashbang)s
Just van Rossumad33d722002-11-21 10:23:04 +0000273
Just van Rossum7322b1a2003-02-25 20:15:40 +0000274import sys, os
275execdir = os.path.dirname(sys.argv[0])
276executable = os.path.join(execdir, "%(executable)s")
277resdir = os.path.join(os.path.dirname(execdir), "Resources")
Just van Rossum15624d82003-03-21 09:26:59 +0000278libdir = os.path.join(os.path.dirname(execdir), "Frameworks")
Just van Rossum7322b1a2003-02-25 20:15:40 +0000279mainprogram = os.path.join(resdir, "%(mainprogram)s")
280
281sys.argv.insert(1, mainprogram)
282os.environ["PYTHONPATH"] = resdir
Just van Rossum82ad32e2003-03-21 11:32:37 +0000283if %(standalone)s:
Jack Jansen0ae32202003-04-09 13:25:43 +0000284 os.environ["PYTHONHOME"] = resdir
Just van Rossum7322b1a2003-02-25 20:15:40 +0000285os.environ["PYTHONEXECUTABLE"] = executable
Just van Rossum15624d82003-03-21 09:26:59 +0000286os.environ["DYLD_LIBRARY_PATH"] = libdir
Just van Rossum3166f592003-06-20 18:56:10 +0000287os.environ["DYLD_FRAMEWORK_PATH"] = libdir
Just van Rossum7322b1a2003-02-25 20:15:40 +0000288os.execve(executable, sys.argv, os.environ)
Just van Rossumad33d722002-11-21 10:23:04 +0000289"""
290
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000291
292#
293# Optional wrapper that converts "dropped files" into sys.argv values.
294#
295ARGV_EMULATOR = """\
Jack Jansena03adde2003-02-18 23:29:46 +0000296import argvemulator, os
297
298argvemulator.ArgvCollector().mainloop()
299execfile(os.path.join(os.path.split(__file__)[0], "%(realmainprogram)s"))
300"""
Just van Rossumcef32882002-11-26 00:34:52 +0000301
Just van Rossum3166f592003-06-20 18:56:10 +0000302#
303# When building a standalone app with Python.framework, we need to copy
304# a subset from Python.framework to the bundle. The following list
305# specifies exactly what items we'll copy.
306#
307PYTHONFRAMEWORKGOODIES = [
308 "Python", # the Python core library
309 "Resources/English.lproj",
310 "Resources/Info.plist",
311 "Resources/version.plist",
312]
313
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000314
Just van Rossumad33d722002-11-21 10:23:04 +0000315class AppBuilder(BundleBuilder):
316
Jack Jansen0ae32202003-04-09 13:25:43 +0000317 # Override type of the bundle.
318 type = "APPL"
Jack Jansencc81b802003-03-05 14:42:18 +0000319
Jack Jansen0ae32202003-04-09 13:25:43 +0000320 # platform, name of the subfolder of Contents that contains the executable.
321 platform = "MacOS"
Jack Jansencc81b802003-03-05 14:42:18 +0000322
Jack Jansen0ae32202003-04-09 13:25:43 +0000323 # A Python main program. If this argument is given, the main
324 # executable in the bundle will be a small wrapper that invokes
325 # the main program. (XXX Discuss why.)
326 mainprogram = None
Just van Rossumceeb9622002-11-21 23:19:37 +0000327
Jack Jansen0ae32202003-04-09 13:25:43 +0000328 # The main executable. If a Python main program is specified
329 # the executable will be copied to Resources and be invoked
330 # by the wrapper program mentioned above. Otherwise it will
331 # simply be used as the main executable.
332 executable = None
Just van Rossumceeb9622002-11-21 23:19:37 +0000333
Jack Jansen0ae32202003-04-09 13:25:43 +0000334 # The name of the main nib, for Cocoa apps. *Must* be specified
335 # when building a Cocoa app.
336 nibname = None
Just van Rossumad33d722002-11-21 10:23:04 +0000337
Jack Jansen0ae32202003-04-09 13:25:43 +0000338 # The name of the icon file to be copied to Resources and used for
339 # the Finder icon.
340 iconfile = None
Just van Rossum2aa09562003-02-01 08:34:46 +0000341
Jack Jansen0ae32202003-04-09 13:25:43 +0000342 # Symlink the executable instead of copying it.
343 symlink_exec = 0
Just van Rossumad33d722002-11-21 10:23:04 +0000344
Jack Jansen0ae32202003-04-09 13:25:43 +0000345 # If True, build standalone app.
346 standalone = 0
Just van Rossum3166f592003-06-20 18:56:10 +0000347
Jack Jansen8ba0e802003-05-25 22:00:17 +0000348 # If set, use this for #! lines in stead of sys.executable
349 python = None
Just van Rossum3166f592003-06-20 18:56:10 +0000350
Jack Jansen0ae32202003-04-09 13:25:43 +0000351 # If True, add a real main program that emulates sys.argv before calling
352 # mainprogram
353 argv_emulation = 0
Just van Rossumcef32882002-11-26 00:34:52 +0000354
Jack Jansen0ae32202003-04-09 13:25:43 +0000355 # The following attributes are only used when building a standalone app.
Just van Rossumcef32882002-11-26 00:34:52 +0000356
Jack Jansen0ae32202003-04-09 13:25:43 +0000357 # Exclude these modules.
358 excludeModules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000359
Jack Jansen0ae32202003-04-09 13:25:43 +0000360 # Include these modules.
361 includeModules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000362
Jack Jansen0ae32202003-04-09 13:25:43 +0000363 # Include these packages.
364 includePackages = []
Just van Rossumcef32882002-11-26 00:34:52 +0000365
Just van Rossum00a0b972003-06-20 21:18:22 +0000366 # Strip binaries from debug info.
Jack Jansen0ae32202003-04-09 13:25:43 +0000367 strip = 0
Just van Rossumcef32882002-11-26 00:34:52 +0000368
Jack Jansen0ae32202003-04-09 13:25:43 +0000369 # Found Python modules: [(name, codeobject, ispkg), ...]
370 pymodules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000371
Jack Jansen0ae32202003-04-09 13:25:43 +0000372 # Modules that modulefinder couldn't find:
373 missingModules = []
374 maybeMissingModules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000375
Jack Jansen0ae32202003-04-09 13:25:43 +0000376 def setup(self):
377 if self.standalone and self.mainprogram is None:
378 raise BundleBuilderError, ("must specify 'mainprogram' when "
379 "building a standalone application.")
380 if self.mainprogram is None and self.executable is None:
381 raise BundleBuilderError, ("must specify either or both of "
382 "'executable' and 'mainprogram'")
Just van Rossumceeb9622002-11-21 23:19:37 +0000383
Jack Jansen0ae32202003-04-09 13:25:43 +0000384 self.execdir = pathjoin("Contents", self.platform)
Jack Jansencc81b802003-03-05 14:42:18 +0000385
Jack Jansen0ae32202003-04-09 13:25:43 +0000386 if self.name is not None:
387 pass
388 elif self.mainprogram is not None:
389 self.name = os.path.splitext(os.path.basename(self.mainprogram))[0]
390 elif executable is not None:
391 self.name = os.path.splitext(os.path.basename(self.executable))[0]
392 if self.name[-4:] != ".app":
393 self.name += ".app"
Just van Rossumceeb9622002-11-21 23:19:37 +0000394
Jack Jansen0ae32202003-04-09 13:25:43 +0000395 if self.executable is None:
396 if not self.standalone:
397 self.symlink_exec = 1
398 self.executable = sys.executable
Just van Rossum74bdca82002-11-28 11:30:56 +0000399
Jack Jansen0ae32202003-04-09 13:25:43 +0000400 if self.nibname:
401 self.plist.NSMainNibFile = self.nibname
402 if not hasattr(self.plist, "NSPrincipalClass"):
403 self.plist.NSPrincipalClass = "NSApplication"
Just van Rossumceeb9622002-11-21 23:19:37 +0000404
Just van Rossum3166f592003-06-20 18:56:10 +0000405 if self.standalone and "Python.framework" in sys.exec_prefix:
406 self.addPythonFramework()
407
Jack Jansen0ae32202003-04-09 13:25:43 +0000408 BundleBuilder.setup(self)
Just van Rossumceeb9622002-11-21 23:19:37 +0000409
Jack Jansen0ae32202003-04-09 13:25:43 +0000410 self.plist.CFBundleExecutable = self.name
Just van Rossumf7aba232002-11-22 00:31:50 +0000411
Jack Jansen0ae32202003-04-09 13:25:43 +0000412 if self.standalone:
413 self.findDependencies()
Just van Rossumcef32882002-11-26 00:34:52 +0000414
Jack Jansen0ae32202003-04-09 13:25:43 +0000415 def preProcess(self):
416 resdir = "Contents/Resources"
417 if self.executable is not None:
418 if self.mainprogram is None:
419 execname = self.name
420 else:
421 execname = os.path.basename(self.executable)
422 execpath = pathjoin(self.execdir, execname)
423 if not self.symlink_exec:
424 self.files.append((self.executable, execpath))
Jack Jansen0ae32202003-04-09 13:25:43 +0000425 self.execpath = execpath
Just van Rossumad33d722002-11-21 10:23:04 +0000426
Jack Jansen0ae32202003-04-09 13:25:43 +0000427 if self.mainprogram is not None:
428 mainprogram = os.path.basename(self.mainprogram)
429 self.files.append((self.mainprogram, pathjoin(resdir, mainprogram)))
430 if self.argv_emulation:
431 # Change the main program, and create the helper main program (which
432 # does argv collection and then calls the real main).
433 # Also update the included modules (if we're creating a standalone
434 # program) and the plist
435 realmainprogram = mainprogram
436 mainprogram = '__argvemulator_' + mainprogram
437 resdirpath = pathjoin(self.bundlepath, resdir)
438 mainprogrampath = pathjoin(resdirpath, mainprogram)
439 makedirs(resdirpath)
440 open(mainprogrampath, "w").write(ARGV_EMULATOR % locals())
441 if self.standalone:
442 self.includeModules.append("argvemulator")
443 self.includeModules.append("os")
444 if not self.plist.has_key("CFBundleDocumentTypes"):
445 self.plist["CFBundleDocumentTypes"] = [
446 { "CFBundleTypeOSTypes" : [
447 "****",
448 "fold",
449 "disk"],
450 "CFBundleTypeRole": "Viewer"}]
451 # Write bootstrap script
452 executable = os.path.basename(self.executable)
453 execdir = pathjoin(self.bundlepath, self.execdir)
454 bootstrappath = pathjoin(execdir, self.name)
455 makedirs(execdir)
456 if self.standalone:
457 # XXX we're screwed when the end user has deleted
458 # /usr/bin/python
459 hashbang = "/usr/bin/python"
Jack Jansen8ba0e802003-05-25 22:00:17 +0000460 elif self.python:
461 hashbang = self.python
Jack Jansen0ae32202003-04-09 13:25:43 +0000462 else:
463 hashbang = os.path.realpath(sys.executable)
464 standalone = self.standalone
465 open(bootstrappath, "w").write(BOOTSTRAP_SCRIPT % locals())
466 os.chmod(bootstrappath, 0775)
Just van Rossumad33d722002-11-21 10:23:04 +0000467
Jack Jansen0ae32202003-04-09 13:25:43 +0000468 if self.iconfile is not None:
469 iconbase = os.path.basename(self.iconfile)
470 self.plist.CFBundleIconFile = iconbase
471 self.files.append((self.iconfile, pathjoin(resdir, iconbase)))
Just van Rossum2aa09562003-02-01 08:34:46 +0000472
Jack Jansen0ae32202003-04-09 13:25:43 +0000473 def postProcess(self):
474 if self.standalone:
475 self.addPythonModules()
476 if self.strip and not self.symlink:
477 self.stripBinaries()
Just van Rossumcef32882002-11-26 00:34:52 +0000478
Jack Jansen0ae32202003-04-09 13:25:43 +0000479 if self.symlink_exec and self.executable:
480 self.message("Symlinking executable %s to %s" % (self.executable,
481 self.execpath), 2)
482 dst = pathjoin(self.bundlepath, self.execpath)
483 makedirs(os.path.dirname(dst))
484 os.symlink(os.path.abspath(self.executable), dst)
Just van Rossum16aebf72002-11-22 11:43:10 +0000485
Jack Jansen0ae32202003-04-09 13:25:43 +0000486 if self.missingModules or self.maybeMissingModules:
487 self.reportMissing()
Just van Rossumcef32882002-11-26 00:34:52 +0000488
Just van Rossum3166f592003-06-20 18:56:10 +0000489 def addPythonFramework(self):
490 # If we're building a standalone app with Python.framework,
Just van Rossumdc31dc02003-06-20 21:43:36 +0000491 # include a minimal subset of Python.framework, *unless*
492 # Python.framework was specified manually in self.libs.
493 for lib in self.libs:
494 if os.path.basename(lib) == "Python.framework":
495 # a Python.framework was specified as a library
496 return
497
Just van Rossum3166f592003-06-20 18:56:10 +0000498 frameworkpath = sys.exec_prefix[:sys.exec_prefix.find(
499 "Python.framework") + len("Python.framework")]
Just van Rossumdc31dc02003-06-20 21:43:36 +0000500
Just van Rossum3166f592003-06-20 18:56:10 +0000501 version = sys.version[:3]
502 frameworkpath = pathjoin(frameworkpath, "Versions", version)
503 destbase = pathjoin("Contents", "Frameworks", "Python.framework",
504 "Versions", version)
505 for item in PYTHONFRAMEWORKGOODIES:
506 src = pathjoin(frameworkpath, item)
507 dst = pathjoin(destbase, item)
508 self.files.append((src, dst))
509
Jack Jansen0ae32202003-04-09 13:25:43 +0000510 def addPythonModules(self):
511 self.message("Adding Python modules", 1)
Just van Rossumcef32882002-11-26 00:34:52 +0000512
Jack Jansen0ae32202003-04-09 13:25:43 +0000513 if USE_ZIPIMPORT:
514 # Create a zip file containing all modules as pyc.
515 import zipfile
516 relpath = pathjoin("Contents", "Resources", ZIP_ARCHIVE)
517 abspath = pathjoin(self.bundlepath, relpath)
518 zf = zipfile.ZipFile(abspath, "w", zipfile.ZIP_DEFLATED)
519 for name, code, ispkg in self.pymodules:
520 self.message("Adding Python module %s" % name, 2)
521 path, pyc = getPycData(name, code, ispkg)
522 zf.writestr(path, pyc)
523 zf.close()
524 # add site.pyc
525 sitepath = pathjoin(self.bundlepath, "Contents", "Resources",
526 "site" + PYC_EXT)
527 writePyc(SITE_CO, sitepath)
528 else:
529 # Create individual .pyc files.
530 for name, code, ispkg in self.pymodules:
531 if ispkg:
532 name += ".__init__"
533 path = name.split(".")
534 path = pathjoin("Contents", "Resources", *path) + PYC_EXT
Just van Rossumcef32882002-11-26 00:34:52 +0000535
Jack Jansen0ae32202003-04-09 13:25:43 +0000536 if ispkg:
537 self.message("Adding Python package %s" % path, 2)
538 else:
539 self.message("Adding Python module %s" % path, 2)
Just van Rossumcef32882002-11-26 00:34:52 +0000540
Jack Jansen0ae32202003-04-09 13:25:43 +0000541 abspath = pathjoin(self.bundlepath, path)
542 makedirs(os.path.dirname(abspath))
543 writePyc(code, abspath)
Just van Rossumcef32882002-11-26 00:34:52 +0000544
Jack Jansen0ae32202003-04-09 13:25:43 +0000545 def stripBinaries(self):
546 if not os.path.exists(STRIP_EXEC):
547 self.message("Error: can't strip binaries: no strip program at "
548 "%s" % STRIP_EXEC, 0)
549 else:
Just van Rossum00a0b972003-06-20 21:18:22 +0000550 import stat
Jack Jansen0ae32202003-04-09 13:25:43 +0000551 self.message("Stripping binaries", 1)
Just van Rossum00a0b972003-06-20 21:18:22 +0000552 def walk(top):
553 for name in os.listdir(top):
554 path = pathjoin(top, name)
555 if os.path.islink(path):
556 continue
557 if os.path.isdir(path):
558 walk(path)
559 else:
560 mod = os.stat(path)[stat.ST_MODE]
561 if not (mod & 0100):
562 continue
563 relpath = path[len(self.bundlepath):]
564 self.message("Stripping %s" % relpath, 2)
565 inf, outf = os.popen4("%s -S \"%s\"" %
566 (STRIP_EXEC, path))
567 output = outf.read().strip()
568 if output:
569 # usually not a real problem, like when we're
570 # trying to strip a script
571 self.message("Problem stripping %s:" % relpath, 3)
572 self.message(output, 3)
573 walk(self.bundlepath)
Just van Rossumcef32882002-11-26 00:34:52 +0000574
Jack Jansen0ae32202003-04-09 13:25:43 +0000575 def findDependencies(self):
576 self.message("Finding module dependencies", 1)
577 import modulefinder
578 mf = modulefinder.ModuleFinder(excludes=self.excludeModules)
579 if USE_ZIPIMPORT:
580 # zipimport imports zlib, must add it manually
581 mf.import_hook("zlib")
582 # manually add our own site.py
583 site = mf.add_module("site")
584 site.__code__ = SITE_CO
585 mf.scan_code(SITE_CO, site)
Just van Rossumcef32882002-11-26 00:34:52 +0000586
Jack Jansen0ae32202003-04-09 13:25:43 +0000587 # warnings.py gets imported implicitly from C
588 mf.import_hook("warnings")
Just van Rossum7322b1a2003-02-25 20:15:40 +0000589
Jack Jansen0ae32202003-04-09 13:25:43 +0000590 includeModules = self.includeModules[:]
591 for name in self.includePackages:
592 includeModules.extend(findPackageContents(name).keys())
593 for name in includeModules:
594 try:
595 mf.import_hook(name)
596 except ImportError:
597 self.missingModules.append(name)
Just van Rossumcef32882002-11-26 00:34:52 +0000598
Jack Jansen0ae32202003-04-09 13:25:43 +0000599 mf.run_script(self.mainprogram)
600 modules = mf.modules.items()
601 modules.sort()
602 for name, mod in modules:
603 if mod.__file__ and mod.__code__ is None:
604 # C extension
605 path = mod.__file__
606 filename = os.path.basename(path)
607 if USE_ZIPIMPORT:
608 # Python modules are stored in a Zip archive, but put
609 # extensions in Contents/Resources/.a and add a tiny "loader"
610 # program in the Zip archive. Due to Thomas Heller.
611 dstpath = pathjoin("Contents", "Resources", filename)
612 source = EXT_LOADER % {"name": name, "filename": filename}
613 code = compile(source, "<dynloader for %s>" % name, "exec")
614 mod.__code__ = code
615 else:
616 # just copy the file
617 dstpath = name.split(".")[:-1] + [filename]
618 dstpath = pathjoin("Contents", "Resources", *dstpath)
619 self.files.append((path, dstpath))
Jack Jansen0ae32202003-04-09 13:25:43 +0000620 if mod.__code__ is not None:
621 ispkg = mod.__path__ is not None
622 if not USE_ZIPIMPORT or name != "site":
623 # Our site.py is doing the bootstrapping, so we must
624 # include a real .pyc file if USE_ZIPIMPORT is True.
625 self.pymodules.append((name, mod.__code__, ispkg))
Just van Rossumcef32882002-11-26 00:34:52 +0000626
Jack Jansen0ae32202003-04-09 13:25:43 +0000627 if hasattr(mf, "any_missing_maybe"):
628 missing, maybe = mf.any_missing_maybe()
629 else:
630 missing = mf.any_missing()
631 maybe = []
632 self.missingModules.extend(missing)
633 self.maybeMissingModules.extend(maybe)
Just van Rossumcef32882002-11-26 00:34:52 +0000634
Jack Jansen0ae32202003-04-09 13:25:43 +0000635 def reportMissing(self):
636 missing = [name for name in self.missingModules
637 if name not in MAYMISS_MODULES]
638 if self.maybeMissingModules:
639 maybe = self.maybeMissingModules
640 else:
641 maybe = [name for name in missing if "." in name]
642 missing = [name for name in missing if "." not in name]
643 missing.sort()
644 maybe.sort()
645 if maybe:
646 self.message("Warning: couldn't find the following submodules:", 1)
647 self.message(" (Note that these could be false alarms -- "
648 "it's not always", 1)
649 self.message(" possible to distinguish between \"from package "
650 "import submodule\" ", 1)
651 self.message(" and \"from package import name\")", 1)
652 for name in maybe:
653 self.message(" ? " + name, 1)
654 if missing:
655 self.message("Warning: couldn't find the following modules:", 1)
656 for name in missing:
657 self.message(" ? " + name, 1)
Just van Rossum74bdca82002-11-28 11:30:56 +0000658
Jack Jansen0ae32202003-04-09 13:25:43 +0000659 def report(self):
660 # XXX something decent
661 import pprint
662 pprint.pprint(self.__dict__)
663 if self.standalone:
664 self.reportMissing()
Just van Rossumcef32882002-11-26 00:34:52 +0000665
666#
667# Utilities.
668#
669
670SUFFIXES = [_suf for _suf, _mode, _tp in imp.get_suffixes()]
671identifierRE = re.compile(r"[_a-zA-z][_a-zA-Z0-9]*$")
672
673def findPackageContents(name, searchpath=None):
Jack Jansen0ae32202003-04-09 13:25:43 +0000674 head = name.split(".")[-1]
675 if identifierRE.match(head) is None:
676 return {}
677 try:
678 fp, path, (ext, mode, tp) = imp.find_module(head, searchpath)
679 except ImportError:
680 return {}
681 modules = {name: None}
682 if tp == imp.PKG_DIRECTORY and path:
683 files = os.listdir(path)
684 for sub in files:
685 sub, ext = os.path.splitext(sub)
686 fullname = name + "." + sub
687 if sub != "__init__" and fullname not in modules:
688 modules.update(findPackageContents(fullname, [path]))
689 return modules
Just van Rossumcef32882002-11-26 00:34:52 +0000690
691def writePyc(code, path):
Jack Jansen0ae32202003-04-09 13:25:43 +0000692 f = open(path, "wb")
693 f.write(MAGIC)
694 f.write("\0" * 4) # don't bother about a time stamp
695 marshal.dump(code, f)
696 f.close()
Just van Rossumad33d722002-11-21 10:23:04 +0000697
Just van Rossumad33d722002-11-21 10:23:04 +0000698def copy(src, dst, mkdirs=0):
Jack Jansen0ae32202003-04-09 13:25:43 +0000699 """Copy a file or a directory."""
700 if mkdirs:
701 makedirs(os.path.dirname(dst))
702 if os.path.isdir(src):
Just van Rossumdc31dc02003-06-20 21:43:36 +0000703 shutil.copytree(src, dst, symlinks=1)
Jack Jansen0ae32202003-04-09 13:25:43 +0000704 else:
705 shutil.copy2(src, dst)
Just van Rossumad33d722002-11-21 10:23:04 +0000706
707def copytodir(src, dstdir):
Jack Jansen0ae32202003-04-09 13:25:43 +0000708 """Copy a file or a directory to an existing directory."""
709 dst = pathjoin(dstdir, os.path.basename(src))
710 copy(src, dst)
Just van Rossumad33d722002-11-21 10:23:04 +0000711
712def makedirs(dir):
Jack Jansen0ae32202003-04-09 13:25:43 +0000713 """Make all directories leading up to 'dir' including the leaf
714 directory. Don't moan if any path element already exists."""
715 try:
716 os.makedirs(dir)
717 except OSError, why:
718 if why.errno != errno.EEXIST:
719 raise
Just van Rossumad33d722002-11-21 10:23:04 +0000720
721def symlink(src, dst, mkdirs=0):
Jack Jansen0ae32202003-04-09 13:25:43 +0000722 """Copy a file or a directory."""
723 if not os.path.exists(src):
724 raise IOError, "No such file or directory: '%s'" % src
725 if mkdirs:
726 makedirs(os.path.dirname(dst))
727 os.symlink(os.path.abspath(src), dst)
Just van Rossumad33d722002-11-21 10:23:04 +0000728
729def pathjoin(*args):
Jack Jansen0ae32202003-04-09 13:25:43 +0000730 """Safe wrapper for os.path.join: asserts that all but the first
731 argument are relative paths."""
732 for seg in args[1:]:
733 assert seg[0] != "/"
734 return os.path.join(*args)
Just van Rossumad33d722002-11-21 10:23:04 +0000735
736
Just van Rossumceeb9622002-11-21 23:19:37 +0000737cmdline_doc = """\
738Usage:
Just van Rossumf7aba232002-11-22 00:31:50 +0000739 python bundlebuilder.py [options] command
Just van Rossumceeb9622002-11-21 23:19:37 +0000740 python mybuildscript.py [options] command
741
742Commands:
743 build build the application
744 report print a report
745
746Options:
747 -b, --builddir=DIR the build directory; defaults to "build"
748 -n, --name=NAME application name
749 -r, --resource=FILE extra file or folder to be copied to Resources
Just van Rossum7215e082003-02-25 21:00:55 +0000750 -f, --file=SRC:DST extra file or folder to be copied into the bundle;
751 DST must be a path relative to the bundle root
Just van Rossumceeb9622002-11-21 23:19:37 +0000752 -e, --executable=FILE the executable to be used
753 -m, --mainprogram=FILE the Python main program
Jack Jansena03adde2003-02-18 23:29:46 +0000754 -a, --argv add a wrapper main program to create sys.argv
Just van Rossumceeb9622002-11-21 23:19:37 +0000755 -p, --plist=FILE .plist file (default: generate one)
756 --nib=NAME main nib name
757 -c, --creator=CCCC 4-char creator code (default: '????')
Just van Rossum9af69682003-02-02 18:56:37 +0000758 --iconfile=FILE filename of the icon (an .icns file) to be used
Just van Rossum2aa09562003-02-01 08:34:46 +0000759 as the Finder icon
Just van Rossumceeb9622002-11-21 23:19:37 +0000760 -l, --link symlink files/folder instead of copying them
Just van Rossum16aebf72002-11-22 11:43:10 +0000761 --link-exec symlink the executable instead of copying it
Just van Rossumcef32882002-11-26 00:34:52 +0000762 --standalone build a standalone application, which is fully
763 independent of a Python installation
Jack Jansen8ba0e802003-05-25 22:00:17 +0000764 --python=FILE Python to use in #! line in stead of current Python
Just van Rossum15624d82003-03-21 09:26:59 +0000765 --lib=FILE shared library or framework to be copied into
766 the bundle
Just van Rossumcef32882002-11-26 00:34:52 +0000767 -x, --exclude=MODULE exclude module (with --standalone)
768 -i, --include=MODULE include module (with --standalone)
769 --package=PACKAGE include a whole package (with --standalone)
770 --strip strip binaries (remove debug info)
Just van Rossumceeb9622002-11-21 23:19:37 +0000771 -v, --verbose increase verbosity level
772 -q, --quiet decrease verbosity level
773 -h, --help print this message
774"""
775
776def usage(msg=None):
Jack Jansen0ae32202003-04-09 13:25:43 +0000777 if msg:
778 print msg
779 print cmdline_doc
780 sys.exit(1)
Just van Rossumceeb9622002-11-21 23:19:37 +0000781
782def main(builder=None):
Jack Jansen0ae32202003-04-09 13:25:43 +0000783 if builder is None:
784 builder = AppBuilder(verbosity=1)
Just van Rossumceeb9622002-11-21 23:19:37 +0000785
Jack Jansen0ae32202003-04-09 13:25:43 +0000786 shortopts = "b:n:r:f:e:m:c:p:lx:i:hvqa"
787 longopts = ("builddir=", "name=", "resource=", "file=", "executable=",
788 "mainprogram=", "creator=", "nib=", "plist=", "link",
789 "link-exec", "help", "verbose", "quiet", "argv", "standalone",
790 "exclude=", "include=", "package=", "strip", "iconfile=",
Jack Jansen8ba0e802003-05-25 22:00:17 +0000791 "lib=", "python=")
Just van Rossumceeb9622002-11-21 23:19:37 +0000792
Jack Jansen0ae32202003-04-09 13:25:43 +0000793 try:
794 options, args = getopt.getopt(sys.argv[1:], shortopts, longopts)
795 except getopt.error:
796 usage()
Just van Rossumceeb9622002-11-21 23:19:37 +0000797
Jack Jansen0ae32202003-04-09 13:25:43 +0000798 for opt, arg in options:
799 if opt in ('-b', '--builddir'):
800 builder.builddir = arg
801 elif opt in ('-n', '--name'):
802 builder.name = arg
803 elif opt in ('-r', '--resource'):
Just van Rossumdc31dc02003-06-20 21:43:36 +0000804 builder.resources.append(os.path.normpath(arg))
Jack Jansen0ae32202003-04-09 13:25:43 +0000805 elif opt in ('-f', '--file'):
806 srcdst = arg.split(':')
807 if len(srcdst) != 2:
808 usage("-f or --file argument must be two paths, "
809 "separated by a colon")
810 builder.files.append(srcdst)
811 elif opt in ('-e', '--executable'):
812 builder.executable = arg
813 elif opt in ('-m', '--mainprogram'):
814 builder.mainprogram = arg
815 elif opt in ('-a', '--argv'):
816 builder.argv_emulation = 1
817 elif opt in ('-c', '--creator'):
818 builder.creator = arg
819 elif opt == '--iconfile':
820 builder.iconfile = arg
821 elif opt == "--lib":
Just van Rossumdc31dc02003-06-20 21:43:36 +0000822 builder.libs.append(os.path.normpath(arg))
Jack Jansen0ae32202003-04-09 13:25:43 +0000823 elif opt == "--nib":
824 builder.nibname = arg
825 elif opt in ('-p', '--plist'):
826 builder.plist = Plist.fromFile(arg)
827 elif opt in ('-l', '--link'):
828 builder.symlink = 1
829 elif opt == '--link-exec':
830 builder.symlink_exec = 1
831 elif opt in ('-h', '--help'):
832 usage()
833 elif opt in ('-v', '--verbose'):
834 builder.verbosity += 1
835 elif opt in ('-q', '--quiet'):
836 builder.verbosity -= 1
837 elif opt == '--standalone':
838 builder.standalone = 1
Jack Jansen8ba0e802003-05-25 22:00:17 +0000839 elif opt == '--python':
840 builder.python = arg
Jack Jansen0ae32202003-04-09 13:25:43 +0000841 elif opt in ('-x', '--exclude'):
842 builder.excludeModules.append(arg)
843 elif opt in ('-i', '--include'):
844 builder.includeModules.append(arg)
845 elif opt == '--package':
846 builder.includePackages.append(arg)
847 elif opt == '--strip':
848 builder.strip = 1
Just van Rossumceeb9622002-11-21 23:19:37 +0000849
Jack Jansen0ae32202003-04-09 13:25:43 +0000850 if len(args) != 1:
851 usage("Must specify one command ('build', 'report' or 'help')")
852 command = args[0]
Just van Rossumceeb9622002-11-21 23:19:37 +0000853
Jack Jansen0ae32202003-04-09 13:25:43 +0000854 if command == "build":
855 builder.setup()
856 builder.build()
857 elif command == "report":
858 builder.setup()
859 builder.report()
860 elif command == "help":
861 usage()
862 else:
863 usage("Unknown command '%s'" % command)
Just van Rossumceeb9622002-11-21 23:19:37 +0000864
865
Just van Rossumad33d722002-11-21 10:23:04 +0000866def buildapp(**kwargs):
Jack Jansen0ae32202003-04-09 13:25:43 +0000867 builder = AppBuilder(**kwargs)
868 main(builder)
Just van Rossumad33d722002-11-21 10:23:04 +0000869
870
871if __name__ == "__main__":
Jack Jansen0ae32202003-04-09 13:25:43 +0000872 main()