annotate makeitso/makeitso.py @ 127:829b7f528483

DRY
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 25 May 2011 09:24:48 -0700
parents b8d5d2041fe0
children 0107f95376b3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 #!/usr/bin/env python
52
2765a700982e whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 44
diff changeset
2
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 """
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 filesystem template interpreter
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5 """
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6
30
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
7 import inspect
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8 import os
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9 import re
25
fbf19940fa97 remove the staging directory you attempted to download
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
10 import shutil
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11 import subprocess
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
12 import sys
21
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
13 import tempfile
15
edabb0bfe107 add method to work TTW
Jeff Hammel <jhammel@mozilla.com>
parents: 13
diff changeset
14 import urllib
24
1b802678b341 add note about urllib and timeouts
Jeff Hammel <jhammel@mozilla.com>
parents: 23
diff changeset
15 # TODO: may have to use urllib2.urlopen to get reasonable timeouts
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
16
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
17 from ConfigParser import RawConfigParser
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
18 from optparse import OptionParser
12
a6fd93354f23 add options for starting and ending braces (unused)
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
19
105
67b50417b8d1 stub out loading api templates; this wont work, however, since one is in the middle of a module trying to load a module that depends on the module you are in
Jeff Hammel <jhammel@mozilla.com>
parents: 104
diff changeset
20
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
21 # URL of -this file-
21
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
22 location = 'http://k0s.org/mozilla/hg/MakeItSo/raw-file/tip/makeitso/makeitso.py'
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
23
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
24 ### import tempita
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
25
21
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
26 # URL of tempita
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
27 tempita_location = 'http://bitbucket.org/ianb/tempita/raw-file/tip/tempita/'
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
28
23
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
29 def cleanup():
25
fbf19940fa97 remove the staging directory you attempted to download
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
30 # remove temporary net module directory
23
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
31 if 'tempdir' in globals():
25
fbf19940fa97 remove the staging directory you attempted to download
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
32 shutil.remove(tempdir)
12
a6fd93354f23 add options for starting and ending braces (unused)
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
33 try:
a6fd93354f23 add options for starting and ending braces (unused)
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
34 import tempita
a6fd93354f23 add options for starting and ending braces (unused)
Jeff Hammel <jhammel@mozilla.com>
parents: 9
diff changeset
35 except ImportError:
21
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
36
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
37 # Get tempita from the net
25
fbf19940fa97 remove the staging directory you attempted to download
Jeff Hammel <jhammel@mozilla.com>
parents: 24
diff changeset
38 # TODO: abstract this to get arbitrary modules from the net
23
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
39 def getFiles(url, subdir, files):
21
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
40 """
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
41 fetch files from the internet
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
42 - url : base url
23
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
43 - subdirectory: to put things in
21
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
44 - files : list of files to retrieve
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
45 returns the location of a temporary directory
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
46 """
23
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
47 globals()['tempdir'] = tempfile.mkdtemp()
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
48 os.mkdir(subdir)
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
49 url = url.rstrip('/')
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
50 for filename in files:
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
51 f, headers = urllib.urlretrive('%s/%s' % (url, filename))
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
52 content = file(f).read()
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
53 outfile = os.path.join(globals()['tempdir'], subdir, filename)
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
54 o = file(outfile, 'w')
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
55 print >> o, content
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
56 return globals()['tempdir']
21
c879b93c3f15 stub out fetching tempita from the internet; bitbucket is down, so no further work here atm
Jeff Hammel <jhammel@mozilla.com>
parents: 16
diff changeset
57
23
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
58 tempita_files = ['__init__.py', '_looper.py', 'compat3.py']
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
59
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
60 try:
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
61 t = getFiles(tempita_location, 'tempita', tempita_files)
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
62 sys.path.append(t)
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
63 import tempita
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
64 except:
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
65 cleanup()
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
66 raise NotImplementedError('This should say something like youre not connected to the net')
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
67
30
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
68 # does tempita support delimeters?
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
69 has_delimeters = 'delimeters' in inspect.getargspec(tempita.Template.__init__).args
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
70
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
71 # regular expressions for finding the shebang
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
72 shebang_re = '#!.*makeitso.*'
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
73 shebang_re = re.compile(shebang_re)
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
74
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
75 ### URIs
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
76
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
77 def parent_uri(uri):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
78 """parent resource of a URI"""
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
79
26
044ac9e0b29c add a non-working example with an include clause
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
80 if '://' in uri:
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
81 return uri.rsplit('/', 1)[0] + '/'
27
ac44c36da885 make include example work
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
82 else:
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
83 here = os.path.dirname(os.path.abspath(uri))
27
ac44c36da885 make include example work
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
84 here = here.rstrip(os.path.sep) + os.path.sep
ac44c36da885 make include example work
Jeff Hammel <jhammel@mozilla.com>
parents: 26
diff changeset
85 return here
26
044ac9e0b29c add a non-working example with an include clause
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
86
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
87 def basename(uri):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
88 """return the basename of a URI"""
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
89 if '://' in uri:
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
90 return uri.rsplit('/', 1)[1]
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
91 else:
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
92 return os.path.basename(uri)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
93
26
044ac9e0b29c add a non-working example with an include clause
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
94 def include(uri):
44
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
95 f, headers = urllib.urlretrieve(uri) # XXX -> urllib2 for timeout
26
044ac9e0b29c add a non-working example with an include clause
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
96 return file(f).read()
044ac9e0b29c add a non-working example with an include clause
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
97
30
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
98 ### things that deal with variables
26
044ac9e0b29c add a non-working example with an include clause
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
99
30
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
100 class MissingVariablesException(Exception):
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
101 """exception for (non-interactive) missing variables"""
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
102 def __init__(self, missing):
30
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
103 self.missing = missing
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
104 message = 'Missing variables: %s' % ', '.join(missing)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
105 Exception.__init__(self, message)
30
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
106
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
107 def get_missing(name_error):
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
108 """
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
109 This is a horrible hack because python doesn't do the proper thing
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
110 via eval and return the name of the variable; instead, it just gives
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
111 you a message:
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
112 >>> try:
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
113 ... eval('2*foo')
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
114 ... except Exception, e:
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
115 ... pass
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
116 """
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
117 message = name_error.args[0]
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
118 varname = message.split("'")[1]
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
119 return varname
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
120
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
121 ### template classes
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
122
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
123 class ContentTemplate(tempita.Template):
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
124 """MakeItSo's extension of tempita's Template class"""
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
125
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
126 defaults = {'include': include}
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
127
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
128 def __init__(self, content, name=None, interactive=True, variables=None):
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
129
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
130 # default variables
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
131 self.defaults = self.__class__.defaults.copy()
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
132 self.defaults.update(variables or {})
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
133
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
134 # TODO: automagically tell if the program is interactive or not
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
135 self.interactive = interactive
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
136
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
137 tempita.Template.__init__(self, content, name=name)
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
138
63
b91133e3b02d override get_variables for API template; could instead do this in the ctor, alternately
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
139 def get_variables(self, **variables):
b91133e3b02d override get_variables for API template; could instead do this in the ctor, alternately
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
140 """the template's augmented variable set"""
b91133e3b02d override get_variables for API template; could instead do this in the ctor, alternately
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
141 vars = self.defaults.copy()
b91133e3b02d override get_variables for API template; could instead do this in the ctor, alternately
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
142 vars.update(variables)
b91133e3b02d override get_variables for API template; could instead do this in the ctor, alternately
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
143 return vars
b91133e3b02d override get_variables for API template; could instead do this in the ctor, alternately
Jeff Hammel <jhammel@mozilla.com>
parents: 56
diff changeset
144
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
145 def missing(self, **variables):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
146 """return additional variables needed"""
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
147 vars = self.get_variables(**variables)
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
148 missing = set([])
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
149 while True:
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
150 try:
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
151 tempita.Template.substitute(self, **vars)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
152 return missing
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
153 except NameError, e:
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
154 missed = get_missing(e)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
155 missing.add(missed)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
156 vars[missed] = ''
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
157 return missing
44
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
158
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
159 def check_missing(self, vars):
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
160 """
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
161 check for missing variables and, if applicable,
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
162 update them from the command line
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
163 """
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
164 missing = self.missing(**vars)
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
165 if missing:
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
166 if self.interactive:
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
167 vars.update(self.read_variables(missing))
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
168 else:
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
169 raise MissingVariablesException(missing)
101
80a57bf2b7f4 fixed a few problems
Jeff Hammel <jhammel@mozilla.com>
parents: 94
diff changeset
170
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
171 def variables(self):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
172 """return the variables needed for a template"""
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
173 return self.missing()
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
174
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
175 def substitute(self, **variables):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
176 """interactive (for now) substitution"""
54
d3e1e5745f24 pass the variables, fixes tests
Jeff Hammel <jhammel@mozilla.com>
parents: 53
diff changeset
177 vars = self.get_variables(**variables)
44
6e08cca7d656 do API variable reading and stubbing a bit for control flow
Jeff Hammel <jhammel@mozilla.com>
parents: 42
diff changeset
178 self.check_missing(vars)
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
179 return tempita.Template.substitute(self, **vars)
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
180
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
181 def read_variables(self, variables):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
182 """read variables from stdin"""
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
183 retval = {}
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
184 for i in variables:
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
185 print 'Enter %s: ' % i,
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
186 retval[i] = raw_input()
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
187 return retval
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
188
33
190f310f2f5e more stubbing of template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 32
diff changeset
189
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
190 class URITemplate(ContentTemplate):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
191 """template for a file or URL"""
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
192
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
193 def __init__(self, uri, interactive=True, variables=None):
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
194 content = include(uri)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
195
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
196 # remove makeitso shebang if it has one
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
197 if shebang_re.match(content):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
198 content = os.linesep.join(content.splitlines()[1:])
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
199
56
728cae02a6ed * fix another variable-related bug
Jeff Hammel <jhammel@mozilla.com>
parents: 55
diff changeset
200 variables = variables or {}
76
7909dfaef33b note about adding more metadata
Jeff Hammel <jhammel@mozilla.com>
parents: 63
diff changeset
201 if 'here' not in variables:
7909dfaef33b note about adding more metadata
Jeff Hammel <jhammel@mozilla.com>
parents: 63
diff changeset
202 variables['here'] = parent_uri(uri)
7909dfaef33b note about adding more metadata
Jeff Hammel <jhammel@mozilla.com>
parents: 63
diff changeset
203 # TODO: could add other metadata about the uri,
7909dfaef33b note about adding more metadata
Jeff Hammel <jhammel@mozilla.com>
parents: 63
diff changeset
204 # such as last modification time'
7909dfaef33b note about adding more metadata
Jeff Hammel <jhammel@mozilla.com>
parents: 63
diff changeset
205
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
206 ContentTemplate.__init__(self, content, name=uri,
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
207 interactive=interactive,
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
208 variables=variables)
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
209
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
210 def substitute(self, variables, output=None):
101
80a57bf2b7f4 fixed a few problems
Jeff Hammel <jhammel@mozilla.com>
parents: 94
diff changeset
211
80a57bf2b7f4 fixed a few problems
Jeff Hammel <jhammel@mozilla.com>
parents: 94
diff changeset
212 # interpolate
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
213 content = ContentTemplate.substitute(self, **variables)
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
214
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
215 # write output
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
216 output = output or sys.stdout
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
217 if isinstance(output, basestring):
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
218 path = output
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
219 if os.path.isdir(output):
87
3571417ef92e interpolate file permissions
Jeff Hammel <jhammel@mozilla.com>
parents: 86
diff changeset
220 path = os.path.join(path, basename(self.name))
3571417ef92e interpolate file permissions
Jeff Hammel <jhammel@mozilla.com>
parents: 86
diff changeset
221 f = file(path, 'w')
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
222 print >> f, content
37
7cee2869bd7b stub out directory example
Jeff Hammel <jhammel@mozilla.com>
parents: 36
diff changeset
223 f.close()
87
3571417ef92e interpolate file permissions
Jeff Hammel <jhammel@mozilla.com>
parents: 86
diff changeset
224 try:
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
225 os.chmod(path, os.stat(self.name).st_mode)
87
3571417ef92e interpolate file permissions
Jeff Hammel <jhammel@mozilla.com>
parents: 86
diff changeset
226 except:
3571417ef92e interpolate file permissions
Jeff Hammel <jhammel@mozilla.com>
parents: 86
diff changeset
227 pass
37
7cee2869bd7b stub out directory example
Jeff Hammel <jhammel@mozilla.com>
parents: 36
diff changeset
228 else:
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
229 # file handler
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
230 print >> output, content
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
231
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
232
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
233 class DirectoryTemplate(ContentTemplate):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
234 """template for a directory structure"""
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
235
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
236 def __init__(self, directory, interactive=True, variables=None):
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
237 """
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
238 - output : output directory; if None will render in place
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
239 """
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
240 assert os.path.isdir(directory)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
241 self.name = directory
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
242 self.interactive = interactive
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
243 self.defaults = ContentTemplate.defaults.copy()
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
244 self.defaults.update(variables or {})
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
245
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
246 def check_output(self, output):
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
247 """
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
248 checks output for validity
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
249 """
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
250 assert output # must provide output
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
251 if os.path.exists(output):
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
252 assert os.path.isdir(output), "%s: Must be a directory" % self.name
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
253
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
254 def missing(self, **variables):
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
255 vars = self.defaults.copy()
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
256 vars.update(variables)
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
257 missing = set([])
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
258 for dirpath, dirnames, filenames in os.walk(self.name):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
259
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
260 # find variables from directory names
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
261 for d in dirnames:
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
262 missed = ContentTemplate(d).missing(**vars)
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
263 missing.update(missed)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
264 variables.update(dict([(i, '') for i in missed]))
28
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
265
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
266 # find variables from files
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
267 for f in filenames:
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
268 missed = ContentTemplate(d).missing(**vars)
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
269 missing.update(missed)
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
270 variables.update(dict([(i, '') for i in missed]))
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
271
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
272 path = os.path.join(dirpath, f)
54
d3e1e5745f24 pass the variables, fixes tests
Jeff Hammel <jhammel@mozilla.com>
parents: 53
diff changeset
273 template = URITemplate(path, interactive=self.interactive)
55
b087a14a664b fix several issues involving variable interpolation
Jeff Hammel <jhammel@mozilla.com>
parents: 54
diff changeset
274 missed = template.missing(**vars)
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
275 missing.update(missed)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
276 variables.update(dict([(i, '') for i in missed]))
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
277
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
278 return missing
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
279
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
280 def substitute(self, variables, output):
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
281 self.check_output(output)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
282 vars = self.get_variables(**variables)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
283 self.check_missing(vars)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
284
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
285 # TODO: do this with recursion instead of os.walk so that
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
286 # per-directory control may be asserted
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
287
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
288 # make output directory if necessary
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
289 if output and not os.path.exists(output):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
290 os.makedirs(output)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
291
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
292 for dirname, dirnames, filenames in os.walk(self.name):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
293
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
294 # interpolate directory names
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
295 for d in dirnames:
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
296 path = os.path.join(dirname, d)
101
80a57bf2b7f4 fixed a few problems
Jeff Hammel <jhammel@mozilla.com>
parents: 94
diff changeset
297 interpolated = ContentTemplate(path).substitute(**vars)
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
298 target = os.path.join(output, interpolated.split(self.name, 1)[-1].strip(os.path.sep))
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
299
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
300 if os.path.exists(target):
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
301 # ensure its a directory
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
302 # TODO: check this first before interpolation is in progress
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
303 assert os.path.isdir(target), "Can't substitute a directory on top of the file"
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
304 else:
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
305 os.makedirs(target)
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
306
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
307 # interpolate files
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
308 for filename in filenames:
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
309
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
310 # interpolate filenames
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
311 path = os.path.join(dirname, filename)
101
80a57bf2b7f4 fixed a few problems
Jeff Hammel <jhammel@mozilla.com>
parents: 94
diff changeset
312 interpolated = ContentTemplate(path).substitute(**vars)
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
313 target = os.path.join(output, interpolated.split(self.name, 1)[-1].strip(os.path.sep))
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
314
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
315 # interpolate their contents
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
316 if os.path.exists(target):
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
317 # ensure its a directory
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
318 assert os.path.isfile(target), "Can't substitute a file on top of a directory"
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
319 template = URITemplate(path, interactive=False)
101
80a57bf2b7f4 fixed a few problems
Jeff Hammel <jhammel@mozilla.com>
parents: 94
diff changeset
320 template.substitute(vars, target)
39
a2cdce0108e1 get directory substitution sorta working; start stubbing mixed case
Jeff Hammel <jhammel@mozilla.com>
parents: 38
diff changeset
321
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
322
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
323 class PolyTemplate(ContentTemplate):
113
c3b8ce33d3ad make variable getting logic a little less horrible
Jeff Hammel <jhammel@mozilla.com>
parents: 112
diff changeset
324 """aggregate templates"""
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
325
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
326 def __init__(self, templates, interactive=True, variables=None):
54
d3e1e5745f24 pass the variables, fixes tests
Jeff Hammel <jhammel@mozilla.com>
parents: 53
diff changeset
327 self.interactive = interactive
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
328 self.templates = []
107
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
329 entry_points = get_entry_points()
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
330 for template in templates:
94
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
331 if isinstance(template, basestring):
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
332 # TODO: check if the template is a [e.g] PasteScript.template entry point
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
333 if os.path.isdir(template):
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
334 self.templates.append(DirectoryTemplate(template, interactive=self.interactive, variables=variables))
107
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
335 elif not os.path.exists(template) and template in entry_points:
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
336 self.templates.append(entry_points[template](interactive=interactive, variables=variables))
94
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
337 else:
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
338 self.templates.append(URITemplate(template, interactive=self.interactive, variables=variables))
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
339 else:
94
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
340 # assume the template is an object that conforms to the API
b6a46332cced allow Polytemplates to take template objects
Jeff Hammel <jhammel@mozilla.com>
parents: 93
diff changeset
341 self.templates.append(template)
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
342
112
51c9cb49edec fix a few minor issues
Jeff Hammel <jhammel@mozilla.com>
parents: 110
diff changeset
343 def get_variables(self, **variables):
51c9cb49edec fix a few minor issues
Jeff Hammel <jhammel@mozilla.com>
parents: 110
diff changeset
344 vars = variables.copy()
51c9cb49edec fix a few minor issues
Jeff Hammel <jhammel@mozilla.com>
parents: 110
diff changeset
345 for template in self.templates:
51c9cb49edec fix a few minor issues
Jeff Hammel <jhammel@mozilla.com>
parents: 110
diff changeset
346 vars.update(template.get_variables())
51c9cb49edec fix a few minor issues
Jeff Hammel <jhammel@mozilla.com>
parents: 110
diff changeset
347 return vars
51c9cb49edec fix a few minor issues
Jeff Hammel <jhammel@mozilla.com>
parents: 110
diff changeset
348
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
349 def missing(self, **variables):
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
350 vars = variables.copy()
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
351 missing = set([])
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
352 for template in self.templates:
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
353 missed = template.missing(**vars)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
354 missing.update(missed)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
355 vars.update(dict([(i, '') for i in missed]))
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
356 return missing
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
357
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
358 def check_output(self, output):
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
359 if output and isinstance(output, basestring) and os.path.exists(output) and len(self.templates) > 1:
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
360 assert os.path.isdir(output), "Must specify a directory for multiple templates"
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
361 for template in self.templates:
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
362 if hasattr(template, 'check_output'):
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
363 template.check_output(output)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
364
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
365 def substitute(self, variables, output=None):
28
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
366
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
367 # determine where the hell to put these things
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
368 self.check_output(output)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
369
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
370 # get the variables
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
371 vars = self.get_variables(**variables)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
372 self.check_missing(vars)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
373
114
b8d5d2041fe0 stub out project name -> package name
Jeff Hammel <jhammel@mozilla.com>
parents: 113
diff changeset
374 # make the output directory if multiple templates
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
375 if output and len(self.templates) > 1 and not os.path.exists(output):
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
376 os.makedirs(output)
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
377
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
378 # do the substitution
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
379 for template in self.templates:
90
26b9c3bba04e make the api for substitute() variables, output
Jeff Hammel <jhammel@mozilla.com>
parents: 89
diff changeset
380 template.substitute(vars, output)
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
381
41
9956e13558dd stub out what API templates will look like; put these in a separate file as theres no reason to clutter up the command line entry point any further
Jeff Hammel <jhammel@mozilla.com>
parents: 40
diff changeset
382 ### command line interface
28
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
383
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
384 def read_config(config_files, templates=()):
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
385 """read variables from a set of .ini files"""
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
386 retval = {}
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
387 parser = RawConfigParser()
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
388 parser.read(config_files)
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
389 retval.update(dict(parser.items('DEFAULT')))
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
390 for template in templates:
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
391 if template in parser.sections():
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
392 retval.update(dict(parser.items(template)))
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
393
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
394 return retval
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
395
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
396 def invocation(url, **variables):
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
397 """returns a string appropriate for TTW invocation"""
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
398 variables_string = ' '.join(['%s=%s' % (i,j) for i,j in variables.items()])
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
399 return 'python <(curl %s) %s %s' % (location, url, variables_string)
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
400
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
401 def main(args=sys.argv[1:]):
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
402
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
403 # create option parser
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
404 usage = '%prog [options] template <template> <...>'
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
405 parser = OptionParser(usage, description=__doc__)
28
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
406
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
407 # find dotfile
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
408 dotfile = None
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
409 if 'HOME' in os.environ:
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
410 dotfile = os.path.join(os.environ['HOME'], '.makeitso')
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
411 if not (os.path.exists(dotfile) and os.path.isfile(dotfile)):
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
412 dotfile = None
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
413
28
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
414 # delimeters
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
415 # XXX needs tempita trunk
30
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
416 if has_delimeters:
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
417 parser.add_option('-[', '--start-braces', dest='start_braces',
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
418 help='starting delimeter')
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
419 parser.add_option('-]', '--end-braces', dest='end_braces',
1549be7f0fcb dont point at trunk tempital; as expected, hg repos dont work with setuptools :(
Jeff Hammel <jhammel@mozilla.com>
parents: 28
diff changeset
420 help='starting delimeter')
28
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
421
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
422 # options about where to put things
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
423 parser.add_option('-o', '--output', dest='output',
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
424 help='where to put the output (filename or directory)')
dc18d6db4956 depend on trunk tempita; stubbing for next stage
Jeff Hammel <jhammel@mozilla.com>
parents: 27
diff changeset
425
93
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
426 # options for (.ini) variables
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
427 parser.add_option('-c', '--config', dest='config',
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
428 default=[], action='append',
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
429 help='.ini config files to read variables from')
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
430 if dotfile:
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
431 parser.add_option('--no-defaults', dest='use_defaults',
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
432 default=True, action='store_false',
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
433 help="don't read ~/.makeitso")
104
e059a58ea23c update comment
Jeff Hammel <jhammel@mozilla.com>
parents: 103
diff changeset
434
e059a58ea23c update comment
Jeff Hammel <jhammel@mozilla.com>
parents: 103
diff changeset
435 # TODO
93
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
436 # parser.add_option('-u', '--update', dest='update',
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
437 # help="update the specified .ini file for variables read from this run")
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
438 # parser.add_option('-U', '--Update', dest='Update',
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
439 # help="same as -u, but update the global [DEFAULTS] section")
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
440 # parser.add_option('--dry-run', dest='dry_run',
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
441 # default=False, action='store_true',
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
442 # help="don't actually do the substitution but do everything else")
d5da38fabdf7 note command line options needed for variable handling
Jeff Hammel <jhammel@mozilla.com>
parents: 90
diff changeset
443
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
444 # options for getting information
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
445 parser.add_option('--commandline', dest='commandline',
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
446 action='store_true', default=False,
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
447 help="print the commandline to invoke this script TTW")
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
448 parser.add_option('--variables', dest='variables',
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
449 action='store_true', default=False,
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
450 help='print the variables in a template')
110
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
451 entry_points = get_entry_points()
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
452 if entry_points:
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
453 parser.add_option('--list-templates', dest='list_templates',
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
454 action='store_true', default=False,
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
455 help="list installed MakeItSo! templates")
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
456
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
457
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
458 options, args = parser.parse_args(args)
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
459
110
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
460 # list the templates
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
461 if entry_points and options.list_templates:
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
462 for key in sorted(entry_points.keys()):
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
463 template_class = entry_points[key]
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
464 description = getattr(template_class, 'description', '')
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
465 description = description or getattr(template_class, '__doc__', '')
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
466 description = description.strip()
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
467 print key + ': ' + description
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
468 return
613e9c19a98c add a --list-templates command
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
469
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
470 # print the variables for the templates
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
471 if options.variables:
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
472
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
473 # makes no sense without a template
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
474 if not args:
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
475 parser.print_usage()
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
476 parser.exit()
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
477
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
478 # find all variables
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
479 template = PolyTemplate(templates=args)
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
480 variables = template.variables()
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
481
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
482 # print them
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
483 for variable in sorted(variables):
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
484 print variable
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
485 return
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
486
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
487 # template variables
35
7e47ff4b0cd3 started writing tests; what a surprise, everything is broken ;)
Jeff Hammel <jhammel@mozilla.com>
parents: 34
diff changeset
488 variables = {}
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
489 _args = []
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
490
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
491 # read variables from configuration
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
492 config_files = options.config
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
493 if dotfile and options.use_defaults:
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
494 config_files.insert(0, dotfile)
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
495 if config_files:
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
496 variables.update(read_config(config_files))
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
497
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
498 # override with variables from the command line
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
499 _variables = {}
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
500 for arg in args:
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
501 if '=' in arg:
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
502 key, value = arg.split('=')
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
503 _variables[key] = value
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
504 else:
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
505 _args.append(arg)
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
506 args = _args
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
507 variables.update(_variables)
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
508
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
509 # print TTW commandline for invocation
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
510 if options.commandline:
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
511 if args:
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
512 for arg in args:
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
513 print invocation(arg, **variables)
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
514 else:
26
044ac9e0b29c add a non-working example with an include clause
Jeff Hammel <jhammel@mozilla.com>
parents: 25
diff changeset
515 print invocation('[URI]', **variables)
9
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
516 return
a77630b2b491 * add commandline to print commandlines
Jeff Hammel <jhammel@mozilla.com>
parents: 6
diff changeset
517
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
518
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
519 # get the content
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
520 if args:
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
521 template = PolyTemplate(templates=args,
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
522 variables=variables)
103
a6aff990985b do rudimentary interpretation of config files
Jeff Hammel <jhammel@mozilla.com>
parents: 101
diff changeset
523 template.substitute({}, output=options.output)
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
524 else:
34
46c2d0a7335a continued refactor to have template classes
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
525 template = ContentTemplate(sys.stdin.read(), variables=variables)
88
712a6d358083 fixed output broke other things
Jeff Hammel <jhammel@mozilla.com>
parents: 87
diff changeset
526 print template.substitute()
23
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
527
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
528 # cleanup
776805790c84 stub out getting tempita from the net; unttested
Jeff Hammel <jhammel@mozilla.com>
parents: 22
diff changeset
529 cleanup()
5
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
530
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
531 if __name__ == '__main__':
f064be514e53 choose a better filename and remove some stuff from shebang
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
532 main()
106
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
533
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
534
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
535 # get templates from pkg_resources
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
536 # (MakeItSo! and [TODO] pastescript templates)
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 107
diff changeset
537 # this should go last to ensure the module is wholly loaded [?]
107
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
538 def get_entry_points():
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
539 retval = {}
106
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
540 try:
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
541 from pkg_resources import iter_entry_points
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
542 for i in iter_entry_points('makeitso.templates'):
107
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
543 try:
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
544 retval[i.name] = i.load()
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
545 except:
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
546 continue
106
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
547
1295df1700a4 move stubbing around...maybe last minute will work better? ::shrug::
Jeff Hammel <jhammel@mozilla.com>
parents: 105
diff changeset
548 except ImportError:
107
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
549 return retval
2142ad247eb6 we can has entry points
Jeff Hammel <jhammel@mozilla.com>
parents: 106
diff changeset
550 return retval