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

#	count	content
1	n/a	"""tools for BuildApplet and BuildApplication"""
2	n/a
3	n/a	import warnings
4	n/a	warnings.warnpy3k("the buildtools module is deprecated and is removed in 3.0",
5	n/a	stacklevel=2)
6	n/a
7	n/a	import sys
8	n/a	import os
9	n/a	import string
10	n/a	import imp
11	n/a	import marshal
12	n/a	from Carbon import Res
13	n/a	import Carbon.Files
14	n/a	import Carbon.File
15	n/a	import MacOS
16	n/a	import macostools
17	n/a	import macresource
18	n/a	try:
19	n/a	import EasyDialogs
20	n/a	except ImportError:
21	n/a	EasyDialogs = None
22	n/a	import shutil
23	n/a
24	n/a
25	n/a	BuildError = "BuildError"
26	n/a
27	n/a	# .pyc file (and 'PYC ' resource magic number)
28	n/a	MAGIC = imp.get_magic()
29	n/a
30	n/a	# Template file (searched on sys.path)
31	n/a	TEMPLATE = "PythonInterpreter"
32	n/a
33	n/a	# Specification of our resource
34	n/a	RESTYPE = 'PYC '
35	n/a	RESNAME = '__main__'
36	n/a
37	n/a	# A resource with this name sets the "owner" (creator) of the destination
38	n/a	# It should also have ID=0. Either of these alone is not enough.
39	n/a	OWNERNAME = "owner resource"
40	n/a
41	n/a	# Default applet creator code
42	n/a	DEFAULT_APPLET_CREATOR="Pyta"
43	n/a
44	n/a	# OpenResFile mode parameters
45	n/a	READ = 1
46	n/a	WRITE = 2
47	n/a
48	n/a	# Parameter for FSOpenResourceFile
49	n/a	RESOURCE_FORK_NAME=Carbon.File.FSGetResourceForkName()
50	n/a
51	n/a	def findtemplate(template=None):
52	n/a	"""Locate the applet template along sys.path"""
53	n/a	if MacOS.runtimemodel == 'macho':
54	n/a	return None
55	n/a	if not template:
56	n/a	template=TEMPLATE
57	n/a	for p in sys.path:
58	n/a	file = os.path.join(p, template)
59	n/a	try:
60	n/a	file, d1, d2 = Carbon.File.FSResolveAliasFile(file, 1)
61	n/a	break
62	n/a	except (Carbon.File.Error, ValueError):
63	n/a	continue
64	n/a	else:
65	n/a	raise BuildError, "Template %r not found on sys.path" % (template,)
66	n/a	file = file.as_pathname()
67	n/a	return file
68	n/a
69	n/a	def process(template, filename, destname, copy_codefragment=0,
70	n/a	rsrcname=None, others=[], raw=0, progress="default", destroot=""):
71	n/a
72	n/a	if progress == "default":
73	n/a	if EasyDialogs is None:
74	n/a	print "Compiling %s"%(os.path.split(filename)[1],)
75	n/a	process = None
76	n/a	else:
77	n/a	progress = EasyDialogs.ProgressBar("Processing %s..."%os.path.split(filename)[1], 120)
78	n/a	progress.label("Compiling...")
79	n/a	progress.inc(0)
80	n/a	# check for the script name being longer than 32 chars. This may trigger a bug
81	n/a	# on OSX that can destroy your sourcefile.
82	n/a	if '#' in os.path.split(filename)[1]:
83	n/a	raise BuildError, "BuildApplet could destroy your sourcefile on OSX, please rename: %s" % filename
84	n/a	# Read the source and compile it
85	n/a	# (there's no point overwriting the destination if it has a syntax error)
86	n/a
87	n/a	fp = open(filename, 'rU')
88	n/a	text = fp.read()
89	n/a	fp.close()
90	n/a	try:
91	n/a	code = compile(text + '\n', filename, "exec")
92	n/a	except SyntaxError, arg:
93	n/a	raise BuildError, "Syntax error in script %s: %s" % (filename, arg)
94	n/a	except EOFError:
95	n/a	raise BuildError, "End-of-file in script %s" % (filename,)
96	n/a
97	n/a	# Set the destination file name. Note that basename
98	n/a	# does contain the whole filepath, only a .py is stripped.
99	n/a
100	n/a	if string.lower(filename[-3:]) == ".py":
101	n/a	basename = filename[:-3]
102	n/a	if MacOS.runtimemodel != 'macho' and not destname:
103	n/a	destname = basename
104	n/a	else:
105	n/a	basename = filename
106	n/a
107	n/a	if not destname:
108	n/a	if MacOS.runtimemodel == 'macho':
109	n/a	destname = basename + '.app'
110	n/a	else:
111	n/a	destname = basename + '.applet'
112	n/a	if not rsrcname:
113	n/a	rsrcname = basename + '.rsrc'
114	n/a
115	n/a	# Try removing the output file. This fails in MachO, but it should
116	n/a	# do any harm.
117	n/a	try:
118	n/a	os.remove(destname)
119	n/a	except os.error:
120	n/a	pass
121	n/a	process_common(template, progress, code, rsrcname, destname, 0,
122	n/a	copy_codefragment, raw, others, filename, destroot)
123	n/a
124	n/a
125	n/a	def update(template, filename, output):
126	n/a	if MacOS.runtimemodel == 'macho':
127	n/a	raise BuildError, "No updating yet for MachO applets"
128	n/a	if progress:
129	n/a	if EasyDialogs is None:
130	n/a	print "Updating %s"%(os.path.split(filename)[1],)
131	n/a	progress = None
132	n/a	else:
133	n/a	progress = EasyDialogs.ProgressBar("Updating %s..."%os.path.split(filename)[1], 120)
134	n/a	else:
135	n/a	progress = None
136	n/a	if not output:
137	n/a	output = filename + ' (updated)'
138	n/a
139	n/a	# Try removing the output file
140	n/a	try:
141	n/a	os.remove(output)
142	n/a	except os.error:
143	n/a	pass
144	n/a	process_common(template, progress, None, filename, output, 1, 1)
145	n/a
146	n/a
147	n/a	def process_common(template, progress, code, rsrcname, destname, is_update,
148	n/a	copy_codefragment, raw=0, others=[], filename=None, destroot=""):
149	n/a	if MacOS.runtimemodel == 'macho':
150	n/a	return process_common_macho(template, progress, code, rsrcname, destname,
151	n/a	is_update, raw, others, filename, destroot)
152	n/a	if others:
153	n/a	raise BuildError, "Extra files only allowed for MachoPython applets"
154	n/a	# Create FSSpecs for the various files
155	n/a	template_fsr, d1, d2 = Carbon.File.FSResolveAliasFile(template, 1)
156	n/a	template = template_fsr.as_pathname()
157	n/a
158	n/a	# Copy data (not resources, yet) from the template
159	n/a	if progress:
160	n/a	progress.label("Copy data fork...")
161	n/a	progress.set(10)
162	n/a
163	n/a	if copy_codefragment:
164	n/a	tmpl = open(template, "rb")
165	n/a	dest = open(destname, "wb")
166	n/a	data = tmpl.read()
167	n/a	if data:
168	n/a	dest.write(data)
169	n/a	dest.close()
170	n/a	tmpl.close()
171	n/a	del dest
172	n/a	del tmpl
173	n/a
174	n/a	# Open the output resource fork
175	n/a
176	n/a	if progress:
177	n/a	progress.label("Copy resources...")
178	n/a	progress.set(20)
179	n/a	try:
180	n/a	output = Res.FSOpenResourceFile(destname, RESOURCE_FORK_NAME, WRITE)
181	n/a	except MacOS.Error:
182	n/a	destdir, destfile = os.path.split(destname)
183	n/a	Res.FSCreateResourceFile(destdir, unicode(destfile), RESOURCE_FORK_NAME)
184	n/a	output = Res.FSOpenResourceFile(destname, RESOURCE_FORK_NAME, WRITE)
185	n/a
186	n/a	# Copy the resources from the target specific resource template, if any
187	n/a	typesfound, ownertype = [], None
188	n/a	try:
189	n/a	input = Res.FSOpenResourceFile(rsrcname, RESOURCE_FORK_NAME, READ)
190	n/a	except (MacOS.Error, ValueError):
191	n/a	pass
192	n/a	if progress:
193	n/a	progress.inc(50)
194	n/a	else:
195	n/a	if is_update:
196	n/a	skip_oldfile = ['cfrg']
197	n/a	else:
198	n/a	skip_oldfile = []
199	n/a	typesfound, ownertype = copyres(input, output, skip_oldfile, 0, progress)
200	n/a	Res.CloseResFile(input)
201	n/a
202	n/a	# Check which resource-types we should not copy from the template
203	n/a	skiptypes = []
204	n/a	if 'vers' in typesfound: skiptypes.append('vers')
205	n/a	if 'SIZE' in typesfound: skiptypes.append('SIZE')
206	n/a	if 'BNDL' in typesfound: skiptypes = skiptypes + ['BNDL', 'FREF', 'icl4',
207	n/a	'icl8', 'ics4', 'ics8', 'ICN#', 'ics#']
208	n/a	if not copy_codefragment:
209	n/a	skiptypes.append('cfrg')
210	n/a	## skipowner = (ownertype != None)
211	n/a
212	n/a	# Copy the resources from the template
213	n/a
214	n/a	input = Res.FSOpenResourceFile(template, RESOURCE_FORK_NAME, READ)
215	n/a	dummy, tmplowner = copyres(input, output, skiptypes, 1, progress)
216	n/a
217	n/a	Res.CloseResFile(input)
218	n/a	## if ownertype is None:
219	n/a	## raise BuildError, "No owner resource found in either resource file or template"
220	n/a	# Make sure we're manipulating the output resource file now
221	n/a
222	n/a	Res.UseResFile(output)
223	n/a
224	n/a	if ownertype is None:
225	n/a	# No owner resource in the template. We have skipped the
226	n/a	# Python owner resource, so we have to add our own. The relevant
227	n/a	# bundle stuff is already included in the interpret/applet template.
228	n/a	newres = Res.Resource('\0')
229	n/a	newres.AddResource(DEFAULT_APPLET_CREATOR, 0, "Owner resource")
230	n/a	ownertype = DEFAULT_APPLET_CREATOR
231	n/a
232	n/a	if code:
233	n/a	# Delete any existing 'PYC ' resource named __main__
234	n/a
235	n/a	try:
236	n/a	res = Res.Get1NamedResource(RESTYPE, RESNAME)
237	n/a	res.RemoveResource()
238	n/a	except Res.Error:
239	n/a	pass
240	n/a
241	n/a	# Create the raw data for the resource from the code object
242	n/a	if progress:
243	n/a	progress.label("Write PYC resource...")
244	n/a	progress.set(120)
245	n/a
246	n/a	data = marshal.dumps(code)
247	n/a	del code
248	n/a	data = (MAGIC + '\0\0\0\0') + data
249	n/a
250	n/a	# Create the resource and write it
251	n/a
252	n/a	id = 0
253	n/a	while id < 128:
254	n/a	id = Res.Unique1ID(RESTYPE)
255	n/a	res = Res.Resource(data)
256	n/a	res.AddResource(RESTYPE, id, RESNAME)
257	n/a	attrs = res.GetResAttrs()
258	n/a	attrs = attrs \| 0x04 # set preload
259	n/a	res.SetResAttrs(attrs)
260	n/a	res.WriteResource()
261	n/a	res.ReleaseResource()
262	n/a
263	n/a	# Close the output file
264	n/a
265	n/a	Res.CloseResFile(output)
266	n/a
267	n/a	# Now set the creator, type and bundle bit of the destination.
268	n/a	# Done with FSSpec's, FSRef FInfo isn't good enough yet (2.3a1+)
269	n/a	dest_fss = Carbon.File.FSSpec(destname)
270	n/a	dest_finfo = dest_fss.FSpGetFInfo()
271	n/a	dest_finfo.Creator = ownertype
272	n/a	dest_finfo.Type = 'APPL'
273	n/a	dest_finfo.Flags = dest_finfo.Flags \| Carbon.Files.kHasBundle \| Carbon.Files.kIsShared
274	n/a	dest_finfo.Flags = dest_finfo.Flags & ~Carbon.Files.kHasBeenInited
275	n/a	dest_fss.FSpSetFInfo(dest_finfo)
276	n/a
277	n/a	macostools.touched(destname)
278	n/a	if progress:
279	n/a	progress.label("Done.")
280	n/a	progress.inc(0)
281	n/a
282	n/a	def process_common_macho(template, progress, code, rsrcname, destname, is_update,
283	n/a	raw=0, others=[], filename=None, destroot=""):
284	n/a	# Check that we have a filename
285	n/a	if filename is None:
286	n/a	raise BuildError, "Need source filename on MacOSX"
287	n/a	# First make sure the name ends in ".app"
288	n/a	if destname[-4:] != '.app':
289	n/a	destname = destname + '.app'
290	n/a	# Now deduce the short name
291	n/a	destdir, shortname = os.path.split(destname)
292	n/a	if shortname[-4:] == '.app':
293	n/a	# Strip the .app suffix
294	n/a	shortname = shortname[:-4]
295	n/a	# And deduce the .plist and .icns names
296	n/a	plistname = None
297	n/a	icnsname = None
298	n/a	if rsrcname and rsrcname[-5:] == '.rsrc':
299	n/a	tmp = rsrcname[:-5]
300	n/a	plistname = tmp + '.plist'
301	n/a	if os.path.exists(plistname):
302	n/a	icnsname = tmp + '.icns'
303	n/a	if not os.path.exists(icnsname):
304	n/a	icnsname = None
305	n/a	else:
306	n/a	plistname = None
307	n/a	if not icnsname:
308	n/a	dft_icnsname = os.path.join(sys.prefix, 'Resources/Python.app/Contents/Resources/PythonApplet.icns')
309	n/a	if os.path.exists(dft_icnsname):
310	n/a	icnsname = dft_icnsname
311	n/a	if not os.path.exists(rsrcname):
312	n/a	rsrcname = None
313	n/a	if progress:
314	n/a	progress.label('Creating bundle...')
315	n/a	import bundlebuilder
316	n/a	builder = bundlebuilder.AppBuilder(verbosity=0)
317	n/a	builder.mainprogram = filename
318	n/a	builder.builddir = destdir
319	n/a	builder.name = shortname
320	n/a	builder.destroot = destroot
321	n/a	if rsrcname:
322	n/a	realrsrcname = macresource.resource_pathname(rsrcname)
323	n/a	builder.files.append((realrsrcname,
324	n/a	os.path.join('Contents/Resources', os.path.basename(rsrcname))))
325	n/a	for o in others:
326	n/a	if type(o) == str:
327	n/a	builder.resources.append(o)
328	n/a	else:
329	n/a	builder.files.append(o)
330	n/a	if plistname:
331	n/a	import plistlib
332	n/a	builder.plist = plistlib.Plist.fromFile(plistname)
333	n/a	if icnsname:
334	n/a	builder.iconfile = icnsname
335	n/a	if not raw:
336	n/a	builder.argv_emulation = 1
337	n/a	builder.setup()
338	n/a	builder.build()
339	n/a	if progress:
340	n/a	progress.label('Done.')
341	n/a	progress.inc(0)
342	n/a
343	n/a	## macostools.touched(dest_fss)
344	n/a
345	n/a	# Copy resources between two resource file descriptors.
346	n/a	# skip a resource named '__main__' or (if skipowner is set) with ID zero.
347	n/a	# Also skip resources with a type listed in skiptypes.
348	n/a	#
349	n/a	def copyres(input, output, skiptypes, skipowner, progress=None):
350	n/a	ctor = None
351	n/a	alltypes = []
352	n/a	Res.UseResFile(input)
353	n/a	ntypes = Res.Count1Types()
354	n/a	progress_type_inc = 50/ntypes
355	n/a	for itype in range(1, 1+ntypes):
356	n/a	type = Res.Get1IndType(itype)
357	n/a	if type in skiptypes:
358	n/a	continue
359	n/a	alltypes.append(type)
360	n/a	nresources = Res.Count1Resources(type)
361	n/a	progress_cur_inc = progress_type_inc/nresources
362	n/a	for ires in range(1, 1+nresources):
363	n/a	res = Res.Get1IndResource(type, ires)
364	n/a	id, type, name = res.GetResInfo()
365	n/a	lcname = string.lower(name)
366	n/a
367	n/a	if lcname == OWNERNAME and id == 0:
368	n/a	if skipowner:
369	n/a	continue # Skip this one
370	n/a	else:
371	n/a	ctor = type
372	n/a	size = res.size
373	n/a	attrs = res.GetResAttrs()
374	n/a	if progress:
375	n/a	progress.label("Copy %s %d %s"%(type, id, name))
376	n/a	progress.inc(progress_cur_inc)
377	n/a	res.LoadResource()
378	n/a	res.DetachResource()
379	n/a	Res.UseResFile(output)
380	n/a	try:
381	n/a	res2 = Res.Get1Resource(type, id)
382	n/a	except MacOS.Error:
383	n/a	res2 = None
384	n/a	if res2:
385	n/a	if progress:
386	n/a	progress.label("Overwrite %s %d %s"%(type, id, name))
387	n/a	progress.inc(0)
388	n/a	res2.RemoveResource()
389	n/a	res.AddResource(type, id, name)
390	n/a	res.WriteResource()
391	n/a	attrs = attrs \| res.GetResAttrs()
392	n/a	res.SetResAttrs(attrs)
393	n/a	Res.UseResFile(input)
394	n/a	return alltypes, ctor
395	n/a
396	n/a	def copyapptree(srctree, dsttree, exceptlist=[], progress=None):
397	n/a	names = []
398	n/a	if os.path.exists(dsttree):
399	n/a	shutil.rmtree(dsttree)
400	n/a	os.mkdir(dsttree)
401	n/a	todo = os.listdir(srctree)
402	n/a	while todo:
403	n/a	this, todo = todo[0], todo[1:]
404	n/a	if this in exceptlist:
405	n/a	continue
406	n/a	thispath = os.path.join(srctree, this)
407	n/a	if os.path.isdir(thispath):
408	n/a	thiscontent = os.listdir(thispath)
409	n/a	for t in thiscontent:
410	n/a	todo.append(os.path.join(this, t))
411	n/a	names.append(this)
412	n/a	for this in names:
413	n/a	srcpath = os.path.join(srctree, this)
414	n/a	dstpath = os.path.join(dsttree, this)
415	n/a	if os.path.isdir(srcpath):
416	n/a	os.mkdir(dstpath)
417	n/a	elif os.path.islink(srcpath):
418	n/a	endpoint = os.readlink(srcpath)
419	n/a	os.symlink(endpoint, dstpath)
420	n/a	else:
421	n/a	if progress:
422	n/a	progress.label('Copy '+this)
423	n/a	progress.inc(0)
424	n/a	shutil.copy2(srcpath, dstpath)
425	n/a
426	n/a	def writepycfile(codeobject, cfile):
427	n/a	import marshal
428	n/a	fc = open(cfile, 'wb')
429	n/a	fc.write('\0\0\0\0') # MAGIC placeholder, written later
430	n/a	fc.write('\0\0\0\0') # Timestap placeholder, not needed
431	n/a	marshal.dump(codeobject, fc)
432	n/a	fc.flush()
433	n/a	fc.seek(0, 0)
434	n/a	fc.write(MAGIC)
435	n/a	fc.close()