blob: 1a15591a55b802af41427d47c3c60b5718d81a25 [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",
174 os.path.basename(path))))
175 for path in self.libs:
176 files.append((path, pathjoin("Contents", "Frameworks",
177 os.path.basename(path))))
178 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 Rossum7322b1a2003-02-25 20:15:40 +0000287os.execve(executable, sys.argv, os.environ)
Just van Rossumad33d722002-11-21 10:23:04 +0000288"""
289
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000290
291#
292# Optional wrapper that converts "dropped files" into sys.argv values.
293#
294ARGV_EMULATOR = """\
Jack Jansena03adde2003-02-18 23:29:46 +0000295import argvemulator, os
296
297argvemulator.ArgvCollector().mainloop()
298execfile(os.path.join(os.path.split(__file__)[0], "%(realmainprogram)s"))
299"""
Just van Rossumcef32882002-11-26 00:34:52 +0000300
Just van Rossum8a3ed3f2003-02-25 20:53:12 +0000301
Just van Rossumad33d722002-11-21 10:23:04 +0000302class AppBuilder(BundleBuilder):
303
Jack Jansen0ae32202003-04-09 13:25:43 +0000304 # Override type of the bundle.
305 type = "APPL"
Jack Jansencc81b802003-03-05 14:42:18 +0000306
Jack Jansen0ae32202003-04-09 13:25:43 +0000307 # platform, name of the subfolder of Contents that contains the executable.
308 platform = "MacOS"
Jack Jansencc81b802003-03-05 14:42:18 +0000309
Jack Jansen0ae32202003-04-09 13:25:43 +0000310 # A Python main program. If this argument is given, the main
311 # executable in the bundle will be a small wrapper that invokes
312 # the main program. (XXX Discuss why.)
313 mainprogram = None
Just van Rossumceeb9622002-11-21 23:19:37 +0000314
Jack Jansen0ae32202003-04-09 13:25:43 +0000315 # The main executable. If a Python main program is specified
316 # the executable will be copied to Resources and be invoked
317 # by the wrapper program mentioned above. Otherwise it will
318 # simply be used as the main executable.
319 executable = None
Just van Rossumceeb9622002-11-21 23:19:37 +0000320
Jack Jansen0ae32202003-04-09 13:25:43 +0000321 # The name of the main nib, for Cocoa apps. *Must* be specified
322 # when building a Cocoa app.
323 nibname = None
Just van Rossumad33d722002-11-21 10:23:04 +0000324
Jack Jansen0ae32202003-04-09 13:25:43 +0000325 # The name of the icon file to be copied to Resources and used for
326 # the Finder icon.
327 iconfile = None
Just van Rossum2aa09562003-02-01 08:34:46 +0000328
Jack Jansen0ae32202003-04-09 13:25:43 +0000329 # Symlink the executable instead of copying it.
330 symlink_exec = 0
Just van Rossumad33d722002-11-21 10:23:04 +0000331
Jack Jansen0ae32202003-04-09 13:25:43 +0000332 # If True, build standalone app.
333 standalone = 0
334
Jack Jansen8ba0e802003-05-25 22:00:17 +0000335 # If set, use this for #! lines in stead of sys.executable
336 python = None
337
Jack Jansen0ae32202003-04-09 13:25:43 +0000338 # If True, add a real main program that emulates sys.argv before calling
339 # mainprogram
340 argv_emulation = 0
Just van Rossumcef32882002-11-26 00:34:52 +0000341
Jack Jansen0ae32202003-04-09 13:25:43 +0000342 # The following attributes are only used when building a standalone app.
Just van Rossumcef32882002-11-26 00:34:52 +0000343
Jack Jansen0ae32202003-04-09 13:25:43 +0000344 # Exclude these modules.
345 excludeModules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000346
Jack Jansen0ae32202003-04-09 13:25:43 +0000347 # Include these modules.
348 includeModules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000349
Jack Jansen0ae32202003-04-09 13:25:43 +0000350 # Include these packages.
351 includePackages = []
Just van Rossumcef32882002-11-26 00:34:52 +0000352
Jack Jansen0ae32202003-04-09 13:25:43 +0000353 # Strip binaries.
354 strip = 0
Just van Rossumcef32882002-11-26 00:34:52 +0000355
Jack Jansen0ae32202003-04-09 13:25:43 +0000356 # Found Python modules: [(name, codeobject, ispkg), ...]
357 pymodules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000358
Jack Jansen0ae32202003-04-09 13:25:43 +0000359 # Modules that modulefinder couldn't find:
360 missingModules = []
361 maybeMissingModules = []
Just van Rossumcef32882002-11-26 00:34:52 +0000362
Jack Jansen0ae32202003-04-09 13:25:43 +0000363 # List of all binaries (executables or shared libs), for stripping purposes
364 binaries = []
Just van Rossumcef32882002-11-26 00:34:52 +0000365
Jack Jansen0ae32202003-04-09 13:25:43 +0000366 def setup(self):
367 if self.standalone and self.mainprogram is None:
368 raise BundleBuilderError, ("must specify 'mainprogram' when "
369 "building a standalone application.")
370 if self.mainprogram is None and self.executable is None:
371 raise BundleBuilderError, ("must specify either or both of "
372 "'executable' and 'mainprogram'")
Just van Rossumceeb9622002-11-21 23:19:37 +0000373
Jack Jansen0ae32202003-04-09 13:25:43 +0000374 self.execdir = pathjoin("Contents", self.platform)
Jack Jansencc81b802003-03-05 14:42:18 +0000375
Jack Jansen0ae32202003-04-09 13:25:43 +0000376 if self.name is not None:
377 pass
378 elif self.mainprogram is not None:
379 self.name = os.path.splitext(os.path.basename(self.mainprogram))[0]
380 elif executable is not None:
381 self.name = os.path.splitext(os.path.basename(self.executable))[0]
382 if self.name[-4:] != ".app":
383 self.name += ".app"
Just van Rossumceeb9622002-11-21 23:19:37 +0000384
Jack Jansen0ae32202003-04-09 13:25:43 +0000385 if self.executable is None:
386 if not self.standalone:
387 self.symlink_exec = 1
388 self.executable = sys.executable
Just van Rossum74bdca82002-11-28 11:30:56 +0000389
Jack Jansen0ae32202003-04-09 13:25:43 +0000390 if self.nibname:
391 self.plist.NSMainNibFile = self.nibname
392 if not hasattr(self.plist, "NSPrincipalClass"):
393 self.plist.NSPrincipalClass = "NSApplication"
Just van Rossumceeb9622002-11-21 23:19:37 +0000394
Jack Jansen0ae32202003-04-09 13:25:43 +0000395 BundleBuilder.setup(self)
Just van Rossumceeb9622002-11-21 23:19:37 +0000396
Jack Jansen0ae32202003-04-09 13:25:43 +0000397 self.plist.CFBundleExecutable = self.name
Just van Rossumf7aba232002-11-22 00:31:50 +0000398
Jack Jansen0ae32202003-04-09 13:25:43 +0000399 if self.standalone:
400 self.findDependencies()
Just van Rossumcef32882002-11-26 00:34:52 +0000401
Jack Jansen0ae32202003-04-09 13:25:43 +0000402 def preProcess(self):
403 resdir = "Contents/Resources"
404 if self.executable is not None:
405 if self.mainprogram is None:
406 execname = self.name
407 else:
408 execname = os.path.basename(self.executable)
409 execpath = pathjoin(self.execdir, execname)
410 if not self.symlink_exec:
411 self.files.append((self.executable, execpath))
412 self.binaries.append(execpath)
413 self.execpath = execpath
Just van Rossumad33d722002-11-21 10:23:04 +0000414
Jack Jansen0ae32202003-04-09 13:25:43 +0000415 if self.mainprogram is not None:
416 mainprogram = os.path.basename(self.mainprogram)
417 self.files.append((self.mainprogram, pathjoin(resdir, mainprogram)))
418 if self.argv_emulation:
419 # Change the main program, and create the helper main program (which
420 # does argv collection and then calls the real main).
421 # Also update the included modules (if we're creating a standalone
422 # program) and the plist
423 realmainprogram = mainprogram
424 mainprogram = '__argvemulator_' + mainprogram
425 resdirpath = pathjoin(self.bundlepath, resdir)
426 mainprogrampath = pathjoin(resdirpath, mainprogram)
427 makedirs(resdirpath)
428 open(mainprogrampath, "w").write(ARGV_EMULATOR % locals())
429 if self.standalone:
430 self.includeModules.append("argvemulator")
431 self.includeModules.append("os")
432 if not self.plist.has_key("CFBundleDocumentTypes"):
433 self.plist["CFBundleDocumentTypes"] = [
434 { "CFBundleTypeOSTypes" : [
435 "****",
436 "fold",
437 "disk"],
438 "CFBundleTypeRole": "Viewer"}]
439 # Write bootstrap script
440 executable = os.path.basename(self.executable)
441 execdir = pathjoin(self.bundlepath, self.execdir)
442 bootstrappath = pathjoin(execdir, self.name)
443 makedirs(execdir)
444 if self.standalone:
445 # XXX we're screwed when the end user has deleted
446 # /usr/bin/python
447 hashbang = "/usr/bin/python"
Jack Jansen8ba0e802003-05-25 22:00:17 +0000448 elif self.python:
449 hashbang = self.python
Jack Jansen0ae32202003-04-09 13:25:43 +0000450 else:
451 hashbang = os.path.realpath(sys.executable)
452 standalone = self.standalone
453 open(bootstrappath, "w").write(BOOTSTRAP_SCRIPT % locals())
454 os.chmod(bootstrappath, 0775)
Just van Rossumad33d722002-11-21 10:23:04 +0000455
Jack Jansen0ae32202003-04-09 13:25:43 +0000456 if self.iconfile is not None:
457 iconbase = os.path.basename(self.iconfile)
458 self.plist.CFBundleIconFile = iconbase
459 self.files.append((self.iconfile, pathjoin(resdir, iconbase)))
Just van Rossum2aa09562003-02-01 08:34:46 +0000460
Jack Jansen0ae32202003-04-09 13:25:43 +0000461 def postProcess(self):
462 if self.standalone:
463 self.addPythonModules()
464 if self.strip and not self.symlink:
465 self.stripBinaries()
Just van Rossumcef32882002-11-26 00:34:52 +0000466
Jack Jansen0ae32202003-04-09 13:25:43 +0000467 if self.symlink_exec and self.executable:
468 self.message("Symlinking executable %s to %s" % (self.executable,
469 self.execpath), 2)
470 dst = pathjoin(self.bundlepath, self.execpath)
471 makedirs(os.path.dirname(dst))
472 os.symlink(os.path.abspath(self.executable), dst)
Just van Rossum16aebf72002-11-22 11:43:10 +0000473
Jack Jansen0ae32202003-04-09 13:25:43 +0000474 if self.missingModules or self.maybeMissingModules:
475 self.reportMissing()
Just van Rossumcef32882002-11-26 00:34:52 +0000476
Jack Jansen0ae32202003-04-09 13:25:43 +0000477 def addPythonModules(self):
478 self.message("Adding Python modules", 1)
Just van Rossumcef32882002-11-26 00:34:52 +0000479
Jack Jansen0ae32202003-04-09 13:25:43 +0000480 if USE_ZIPIMPORT:
481 # Create a zip file containing all modules as pyc.
482 import zipfile
483 relpath = pathjoin("Contents", "Resources", ZIP_ARCHIVE)
484 abspath = pathjoin(self.bundlepath, relpath)
485 zf = zipfile.ZipFile(abspath, "w", zipfile.ZIP_DEFLATED)
486 for name, code, ispkg in self.pymodules:
487 self.message("Adding Python module %s" % name, 2)
488 path, pyc = getPycData(name, code, ispkg)
489 zf.writestr(path, pyc)
490 zf.close()
491 # add site.pyc
492 sitepath = pathjoin(self.bundlepath, "Contents", "Resources",
493 "site" + PYC_EXT)
494 writePyc(SITE_CO, sitepath)
495 else:
496 # Create individual .pyc files.
497 for name, code, ispkg in self.pymodules:
498 if ispkg:
499 name += ".__init__"
500 path = name.split(".")
501 path = pathjoin("Contents", "Resources", *path) + PYC_EXT
Just van Rossumcef32882002-11-26 00:34:52 +0000502
Jack Jansen0ae32202003-04-09 13:25:43 +0000503 if ispkg:
504 self.message("Adding Python package %s" % path, 2)
505 else:
506 self.message("Adding Python module %s" % path, 2)
Just van Rossumcef32882002-11-26 00:34:52 +0000507
Jack Jansen0ae32202003-04-09 13:25:43 +0000508 abspath = pathjoin(self.bundlepath, path)
509 makedirs(os.path.dirname(abspath))
510 writePyc(code, abspath)
Just van Rossumcef32882002-11-26 00:34:52 +0000511
Jack Jansen0ae32202003-04-09 13:25:43 +0000512 def stripBinaries(self):
513 if not os.path.exists(STRIP_EXEC):
514 self.message("Error: can't strip binaries: no strip program at "
515 "%s" % STRIP_EXEC, 0)
516 else:
517 self.message("Stripping binaries", 1)
518 for relpath in self.binaries:
519 self.message("Stripping %s" % relpath, 2)
520 abspath = pathjoin(self.bundlepath, relpath)
521 assert not os.path.islink(abspath)
522 rv = os.system("%s -S \"%s\"" % (STRIP_EXEC, abspath))
Just van Rossumcef32882002-11-26 00:34:52 +0000523
Jack Jansen0ae32202003-04-09 13:25:43 +0000524 def findDependencies(self):
525 self.message("Finding module dependencies", 1)
526 import modulefinder
527 mf = modulefinder.ModuleFinder(excludes=self.excludeModules)
528 if USE_ZIPIMPORT:
529 # zipimport imports zlib, must add it manually
530 mf.import_hook("zlib")
531 # manually add our own site.py
532 site = mf.add_module("site")
533 site.__code__ = SITE_CO
534 mf.scan_code(SITE_CO, site)
Just van Rossumcef32882002-11-26 00:34:52 +0000535
Jack Jansen0ae32202003-04-09 13:25:43 +0000536 # warnings.py gets imported implicitly from C
537 mf.import_hook("warnings")
Just van Rossum7322b1a2003-02-25 20:15:40 +0000538
Jack Jansen0ae32202003-04-09 13:25:43 +0000539 includeModules = self.includeModules[:]
540 for name in self.includePackages:
541 includeModules.extend(findPackageContents(name).keys())
542 for name in includeModules:
543 try:
544 mf.import_hook(name)
545 except ImportError:
546 self.missingModules.append(name)
Just van Rossumcef32882002-11-26 00:34:52 +0000547
Jack Jansen0ae32202003-04-09 13:25:43 +0000548 mf.run_script(self.mainprogram)
549 modules = mf.modules.items()
550 modules.sort()
551 for name, mod in modules:
552 if mod.__file__ and mod.__code__ is None:
553 # C extension
554 path = mod.__file__
555 filename = os.path.basename(path)
556 if USE_ZIPIMPORT:
557 # Python modules are stored in a Zip archive, but put
558 # extensions in Contents/Resources/.a and add a tiny "loader"
559 # program in the Zip archive. Due to Thomas Heller.
560 dstpath = pathjoin("Contents", "Resources", filename)
561 source = EXT_LOADER % {"name": name, "filename": filename}
562 code = compile(source, "<dynloader for %s>" % name, "exec")
563 mod.__code__ = code
564 else:
565 # just copy the file
566 dstpath = name.split(".")[:-1] + [filename]
567 dstpath = pathjoin("Contents", "Resources", *dstpath)
568 self.files.append((path, dstpath))
569 self.binaries.append(dstpath)
570 if mod.__code__ is not None:
571 ispkg = mod.__path__ is not None
572 if not USE_ZIPIMPORT or name != "site":
573 # Our site.py is doing the bootstrapping, so we must
574 # include a real .pyc file if USE_ZIPIMPORT is True.
575 self.pymodules.append((name, mod.__code__, ispkg))
Just van Rossumcef32882002-11-26 00:34:52 +0000576
Jack Jansen0ae32202003-04-09 13:25:43 +0000577 if hasattr(mf, "any_missing_maybe"):
578 missing, maybe = mf.any_missing_maybe()
579 else:
580 missing = mf.any_missing()
581 maybe = []
582 self.missingModules.extend(missing)
583 self.maybeMissingModules.extend(maybe)
Just van Rossumcef32882002-11-26 00:34:52 +0000584
Jack Jansen0ae32202003-04-09 13:25:43 +0000585 def reportMissing(self):
586 missing = [name for name in self.missingModules
587 if name not in MAYMISS_MODULES]
588 if self.maybeMissingModules:
589 maybe = self.maybeMissingModules
590 else:
591 maybe = [name for name in missing if "." in name]
592 missing = [name for name in missing if "." not in name]
593 missing.sort()
594 maybe.sort()
595 if maybe:
596 self.message("Warning: couldn't find the following submodules:", 1)
597 self.message(" (Note that these could be false alarms -- "
598 "it's not always", 1)
599 self.message(" possible to distinguish between \"from package "
600 "import submodule\" ", 1)
601 self.message(" and \"from package import name\")", 1)
602 for name in maybe:
603 self.message(" ? " + name, 1)
604 if missing:
605 self.message("Warning: couldn't find the following modules:", 1)
606 for name in missing:
607 self.message(" ? " + name, 1)
Just van Rossum74bdca82002-11-28 11:30:56 +0000608
Jack Jansen0ae32202003-04-09 13:25:43 +0000609 def report(self):
610 # XXX something decent
611 import pprint
612 pprint.pprint(self.__dict__)
613 if self.standalone:
614 self.reportMissing()
Just van Rossumcef32882002-11-26 00:34:52 +0000615
616#
617# Utilities.
618#
619
620SUFFIXES = [_suf for _suf, _mode, _tp in imp.get_suffixes()]
621identifierRE = re.compile(r"[_a-zA-z][_a-zA-Z0-9]*$")
622
623def findPackageContents(name, searchpath=None):
Jack Jansen0ae32202003-04-09 13:25:43 +0000624 head = name.split(".")[-1]
625 if identifierRE.match(head) is None:
626 return {}
627 try:
628 fp, path, (ext, mode, tp) = imp.find_module(head, searchpath)
629 except ImportError:
630 return {}
631 modules = {name: None}
632 if tp == imp.PKG_DIRECTORY and path:
633 files = os.listdir(path)
634 for sub in files:
635 sub, ext = os.path.splitext(sub)
636 fullname = name + "." + sub
637 if sub != "__init__" and fullname not in modules:
638 modules.update(findPackageContents(fullname, [path]))
639 return modules
Just van Rossumcef32882002-11-26 00:34:52 +0000640
641def writePyc(code, path):
Jack Jansen0ae32202003-04-09 13:25:43 +0000642 f = open(path, "wb")
643 f.write(MAGIC)
644 f.write("\0" * 4) # don't bother about a time stamp
645 marshal.dump(code, f)
646 f.close()
Just van Rossumad33d722002-11-21 10:23:04 +0000647
Just van Rossumad33d722002-11-21 10:23:04 +0000648def copy(src, dst, mkdirs=0):
Jack Jansen0ae32202003-04-09 13:25:43 +0000649 """Copy a file or a directory."""
650 if mkdirs:
651 makedirs(os.path.dirname(dst))
652 if os.path.isdir(src):
653 shutil.copytree(src, dst)
654 else:
655 shutil.copy2(src, dst)
Just van Rossumad33d722002-11-21 10:23:04 +0000656
657def copytodir(src, dstdir):
Jack Jansen0ae32202003-04-09 13:25:43 +0000658 """Copy a file or a directory to an existing directory."""
659 dst = pathjoin(dstdir, os.path.basename(src))
660 copy(src, dst)
Just van Rossumad33d722002-11-21 10:23:04 +0000661
662def makedirs(dir):
Jack Jansen0ae32202003-04-09 13:25:43 +0000663 """Make all directories leading up to 'dir' including the leaf
664 directory. Don't moan if any path element already exists."""
665 try:
666 os.makedirs(dir)
667 except OSError, why:
668 if why.errno != errno.EEXIST:
669 raise
Just van Rossumad33d722002-11-21 10:23:04 +0000670
671def symlink(src, dst, mkdirs=0):
Jack Jansen0ae32202003-04-09 13:25:43 +0000672 """Copy a file or a directory."""
673 if not os.path.exists(src):
674 raise IOError, "No such file or directory: '%s'" % src
675 if mkdirs:
676 makedirs(os.path.dirname(dst))
677 os.symlink(os.path.abspath(src), dst)
Just van Rossumad33d722002-11-21 10:23:04 +0000678
679def pathjoin(*args):
Jack Jansen0ae32202003-04-09 13:25:43 +0000680 """Safe wrapper for os.path.join: asserts that all but the first
681 argument are relative paths."""
682 for seg in args[1:]:
683 assert seg[0] != "/"
684 return os.path.join(*args)
Just van Rossumad33d722002-11-21 10:23:04 +0000685
686
Just van Rossumceeb9622002-11-21 23:19:37 +0000687cmdline_doc = """\
688Usage:
Just van Rossumf7aba232002-11-22 00:31:50 +0000689 python bundlebuilder.py [options] command
Just van Rossumceeb9622002-11-21 23:19:37 +0000690 python mybuildscript.py [options] command
691
692Commands:
693 build build the application
694 report print a report
695
696Options:
697 -b, --builddir=DIR the build directory; defaults to "build"
698 -n, --name=NAME application name
699 -r, --resource=FILE extra file or folder to be copied to Resources
Just van Rossum7215e082003-02-25 21:00:55 +0000700 -f, --file=SRC:DST extra file or folder to be copied into the bundle;
701 DST must be a path relative to the bundle root
Just van Rossumceeb9622002-11-21 23:19:37 +0000702 -e, --executable=FILE the executable to be used
703 -m, --mainprogram=FILE the Python main program
Jack Jansena03adde2003-02-18 23:29:46 +0000704 -a, --argv add a wrapper main program to create sys.argv
Just van Rossumceeb9622002-11-21 23:19:37 +0000705 -p, --plist=FILE .plist file (default: generate one)
706 --nib=NAME main nib name
707 -c, --creator=CCCC 4-char creator code (default: '????')
Just van Rossum9af69682003-02-02 18:56:37 +0000708 --iconfile=FILE filename of the icon (an .icns file) to be used
Just van Rossum2aa09562003-02-01 08:34:46 +0000709 as the Finder icon
Just van Rossumceeb9622002-11-21 23:19:37 +0000710 -l, --link symlink files/folder instead of copying them
Just van Rossum16aebf72002-11-22 11:43:10 +0000711 --link-exec symlink the executable instead of copying it
Just van Rossumcef32882002-11-26 00:34:52 +0000712 --standalone build a standalone application, which is fully
713 independent of a Python installation
Jack Jansen8ba0e802003-05-25 22:00:17 +0000714 --python=FILE Python to use in #! line in stead of current Python
Just van Rossum15624d82003-03-21 09:26:59 +0000715 --lib=FILE shared library or framework to be copied into
716 the bundle
Just van Rossumcef32882002-11-26 00:34:52 +0000717 -x, --exclude=MODULE exclude module (with --standalone)
718 -i, --include=MODULE include module (with --standalone)
719 --package=PACKAGE include a whole package (with --standalone)
720 --strip strip binaries (remove debug info)
Just van Rossumceeb9622002-11-21 23:19:37 +0000721 -v, --verbose increase verbosity level
722 -q, --quiet decrease verbosity level
723 -h, --help print this message
724"""
725
726def usage(msg=None):
Jack Jansen0ae32202003-04-09 13:25:43 +0000727 if msg:
728 print msg
729 print cmdline_doc
730 sys.exit(1)
Just van Rossumceeb9622002-11-21 23:19:37 +0000731
732def main(builder=None):
Jack Jansen0ae32202003-04-09 13:25:43 +0000733 if builder is None:
734 builder = AppBuilder(verbosity=1)
Just van Rossumceeb9622002-11-21 23:19:37 +0000735
Jack Jansen0ae32202003-04-09 13:25:43 +0000736 shortopts = "b:n:r:f:e:m:c:p:lx:i:hvqa"
737 longopts = ("builddir=", "name=", "resource=", "file=", "executable=",
738 "mainprogram=", "creator=", "nib=", "plist=", "link",
739 "link-exec", "help", "verbose", "quiet", "argv", "standalone",
740 "exclude=", "include=", "package=", "strip", "iconfile=",
Jack Jansen8ba0e802003-05-25 22:00:17 +0000741 "lib=", "python=")
Just van Rossumceeb9622002-11-21 23:19:37 +0000742
Jack Jansen0ae32202003-04-09 13:25:43 +0000743 try:
744 options, args = getopt.getopt(sys.argv[1:], shortopts, longopts)
745 except getopt.error:
746 usage()
Just van Rossumceeb9622002-11-21 23:19:37 +0000747
Jack Jansen0ae32202003-04-09 13:25:43 +0000748 for opt, arg in options:
749 if opt in ('-b', '--builddir'):
750 builder.builddir = arg
751 elif opt in ('-n', '--name'):
752 builder.name = arg
753 elif opt in ('-r', '--resource'):
754 builder.resources.append(arg)
755 elif opt in ('-f', '--file'):
756 srcdst = arg.split(':')
757 if len(srcdst) != 2:
758 usage("-f or --file argument must be two paths, "
759 "separated by a colon")
760 builder.files.append(srcdst)
761 elif opt in ('-e', '--executable'):
762 builder.executable = arg
763 elif opt in ('-m', '--mainprogram'):
764 builder.mainprogram = arg
765 elif opt in ('-a', '--argv'):
766 builder.argv_emulation = 1
767 elif opt in ('-c', '--creator'):
768 builder.creator = arg
769 elif opt == '--iconfile':
770 builder.iconfile = arg
771 elif opt == "--lib":
772 builder.libs.append(arg)
773 elif opt == "--nib":
774 builder.nibname = arg
775 elif opt in ('-p', '--plist'):
776 builder.plist = Plist.fromFile(arg)
777 elif opt in ('-l', '--link'):
778 builder.symlink = 1
779 elif opt == '--link-exec':
780 builder.symlink_exec = 1
781 elif opt in ('-h', '--help'):
782 usage()
783 elif opt in ('-v', '--verbose'):
784 builder.verbosity += 1
785 elif opt in ('-q', '--quiet'):
786 builder.verbosity -= 1
787 elif opt == '--standalone':
788 builder.standalone = 1
Jack Jansen8ba0e802003-05-25 22:00:17 +0000789 elif opt == '--python':
790 builder.python = arg
Jack Jansen0ae32202003-04-09 13:25:43 +0000791 elif opt in ('-x', '--exclude'):
792 builder.excludeModules.append(arg)
793 elif opt in ('-i', '--include'):
794 builder.includeModules.append(arg)
795 elif opt == '--package':
796 builder.includePackages.append(arg)
797 elif opt == '--strip':
798 builder.strip = 1
Just van Rossumceeb9622002-11-21 23:19:37 +0000799
Jack Jansen0ae32202003-04-09 13:25:43 +0000800 if len(args) != 1:
801 usage("Must specify one command ('build', 'report' or 'help')")
802 command = args[0]
Just van Rossumceeb9622002-11-21 23:19:37 +0000803
Jack Jansen0ae32202003-04-09 13:25:43 +0000804 if command == "build":
805 builder.setup()
806 builder.build()
807 elif command == "report":
808 builder.setup()
809 builder.report()
810 elif command == "help":
811 usage()
812 else:
813 usage("Unknown command '%s'" % command)
Just van Rossumceeb9622002-11-21 23:19:37 +0000814
815
Just van Rossumad33d722002-11-21 10:23:04 +0000816def buildapp(**kwargs):
Jack Jansen0ae32202003-04-09 13:25:43 +0000817 builder = AppBuilder(**kwargs)
818 main(builder)
Just van Rossumad33d722002-11-21 10:23:04 +0000819
820
821if __name__ == "__main__":
Jack Jansen0ae32202003-04-09 13:25:43 +0000822 main()