Mercurial > hg > MakeItSo

annotate makeitso/python.py @ 159:cfd4f1e91090

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
wip
author Jeff Hammel <jhammel@mozilla.com>
date Tue, 30 Jul 2013 15:20:38 -0700
parents 386a44a52139
children 9033a5f11b92
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 #!/usr/bin/env python
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3 """
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 python package templates for makeitso
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6 Several components are included.
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7 [TODO] You may use these subtemplates in any combination.
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9 * README.txt : a README in restructured text
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
10 * examples : examples for your package
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11 * setup.py : setup utility for the full package
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
12 * ./main.py : CLI handler for your webapp
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
13 * ./model.py : model of a persisted object
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
14 * ./template.py : a MakeItSo template for project creation
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
15 * ./tests : doctest suite for the package
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
16 * ./web.py : a webob web handler
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
17 """
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
18
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
19 import os
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
20 import sys
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
21 from cli import MakeItSoCLI
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
22 from makeitso import ContentTemplate
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
23 from optparse import OptionParser
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
24 from template import MakeItSoTemplate
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
25 from template import Variable
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
26
151
e70421c50d0a move to ABC
Jeff Hammel <jhammel@mozilla.com>
parents: 131
diff changeset
27 class PythonTemplate(MakeItSoTemplate):
e70421c50d0a move to ABC
Jeff Hammel <jhammel@mozilla.com>
parents: 131
diff changeset
28 """abstract base class for python-type templates"""
e70421c50d0a move to ABC
Jeff Hammel <jhammel@mozilla.com>
parents: 131
diff changeset
29
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
30 def path2name(self, path):
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
31 return os.path.basename(path.rstrip(os.path.sep))
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
32
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
33 class PythonScriptTemplate(PythonTemplate):
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
34 """template for a single python script"""
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
35 templates = [('python_package', '{{package}}', '{{main}}.py')]
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
36
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
37
151
e70421c50d0a move to ABC
Jeff Hammel <jhammel@mozilla.com>
parents: 131
diff changeset
38 class PythonModuleTemplate(PythonTemplate):
131
4922bee3d080 add single module to registered templates
Jeff Hammel <jhammel@mozilla.com>
parents: 122
diff changeset
39 """single module python package"""
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
40 # TODO: this should use the same files as PythonPackageTemplate
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
41 templates = ['python_module',
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
42 ('python_package', '{{package}}', '{{main}}.py')]
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
43 vars = [Variable('description')]
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
44 look = False
131
4922bee3d080 add single module to registered templates
Jeff Hammel <jhammel@mozilla.com>
parents: 122
diff changeset
45
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
46 def pre(self, variables, output):
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
47 variables['module'] = variables['main'] = path2name(output)
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
48
151
e70421c50d0a move to ABC
Jeff Hammel <jhammel@mozilla.com>
parents: 131
diff changeset
49 class PythonPackageTemplate(PythonTemplate):
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
50 """
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
51 python package template
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
52 """
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
53 name = 'python-package'
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
54 templates = ['python_package']
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
55 vars = [Variable('description'),
115
7dbc3cdadffe add a test for the python-package template
Jeff Hammel <jhammel@mozilla.com>
parents: 114
diff changeset
56 Variable('author', 'author of the package'),
7dbc3cdadffe add a test for the python-package template
Jeff Hammel <jhammel@mozilla.com>
parents: 114
diff changeset
57 Variable('email', "author's email"),
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
58 Variable('url', 'project url'),
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
59 Variable('repo', 'project repository'),
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
60 ]
111
bad70fb08b15 minor syntax corrections
Jeff Hammel <jhammel@mozilla.com>
parents: 109
diff changeset
61 look = False
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
62
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
63 # things that go in setup.py
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
64 dependencies = {'web.py': ['webob'],
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
65 'template.py': ['MakeItSo']}
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
66 console_scripts = {'main.py': '{{project}} = {{project}}.{{main}}:main',
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
67 'template.py': '{{project}}-template = {{project}}.template:main'
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
68 }
151
e70421c50d0a move to ABC
Jeff Hammel <jhammel@mozilla.com>
parents: 131
diff changeset
69
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
70 def __init__(self, **kw):
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
71 MakeItSoTemplate.__init__(self, **kw)
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
72
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
73 # TODO: get the templates you actually care about [maybe from the CLI?]
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
74
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
75 def pre(self, variables, output):
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
76 """
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
77 sanitize some variables
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
78 """
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
79
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
80 # get project from output directory
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
81 variables['project'] = self.path2name(output)
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
82
114
b8d5d2041fe0 stub out project name -> package name
Jeff Hammel <jhammel@mozilla.com>
parents: 111
diff changeset
83 # get package name from project
b8d5d2041fe0 stub out project name -> package name
Jeff Hammel <jhammel@mozilla.com>
parents: 111
diff changeset
84 # XXX could have looser restrictions with transforms
116
908e9a653668 fix a syntax error in the python template thanks to some friendly tests
Jeff Hammel <jhammel@mozilla.com>
parents: 115
diff changeset
85 assert variables['project'].isalnum(), 'Project name must be just letters, you gave %s' % variables['project']
114
b8d5d2041fe0 stub out project name -> package name
Jeff Hammel <jhammel@mozilla.com>
parents: 111
diff changeset
86 variables['package'] = variables['project'].lower()
b8d5d2041fe0 stub out project name -> package name
Jeff Hammel <jhammel@mozilla.com>
parents: 111
diff changeset
87
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
88 # name of CLI main file
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
89 variables.setdefault('main', 'main')
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
90
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
91 # dependencies
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
92 dependencies = set([])
111
bad70fb08b15 minor syntax corrections
Jeff Hammel <jhammel@mozilla.com>
parents: 109
diff changeset
93 for template, dependency in self.dependencies.items():
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
94 dependencies.update(dependency)
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
95 dependencies = list(dependencies)
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
96 variables['dependencies'] = dependencies
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
97
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
98 # console_scripts
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
99 console_scripts = []
111
bad70fb08b15 minor syntax corrections
Jeff Hammel <jhammel@mozilla.com>
parents: 109
diff changeset
100 for template, console_script in self.console_scripts.items():
bad70fb08b15 minor syntax corrections
Jeff Hammel <jhammel@mozilla.com>
parents: 109
diff changeset
101 console_scripts.append(console_script)
109
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
102 if console_scripts:
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
103 s = 'setup(' # placeholder string
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
104 script_strings = ['[console_scripts]']
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
105 for console_script in console_scripts:
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
106 template = ContentTemplate(console_script)
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
107 output = template.substitute(project=variables['project'])
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
108 script_strings.append(output)
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
109 variables['console_scripts'] = '\n'.join([' ' * len(s) + i
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
110 for i in script_strings])
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
111 else:
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
112 variables['console_scripts'] = ''
697568ba4a22 make the python package template a little fancier
Jeff Hammel <jhammel@mozilla.com>
parents: 108
diff changeset
113
108
32893f67f85d stub out a better python package
Jeff Hammel <jhammel@mozilla.com>
parents: 102
diff changeset
114
102
ad5fd3eb6674 template fixes....not the best, but will do
Jeff Hammel <jhammel@mozilla.com>
parents: 95
diff changeset
115 class PythonPackageCLI(MakeItSoCLI):
ad5fd3eb6674 template fixes....not the best, but will do
Jeff Hammel <jhammel@mozilla.com>
parents: 95
diff changeset
116 """
ad5fd3eb6674 template fixes....not the best, but will do
Jeff Hammel <jhammel@mozilla.com>
parents: 95
diff changeset
117 CLI front end for the python package template
ad5fd3eb6674 template fixes....not the best, but will do
Jeff Hammel <jhammel@mozilla.com>
parents: 95
diff changeset
118 """
122
b2152efec89a get the description from the docstring if applicable
Jeff Hammel <jhammel@mozilla.com>
parents: 116
diff changeset
119 usage = '%prog [options] project'
95
e74baa8e6df4 fix CLI interface a bit....write a test for it
Jeff Hammel <jhammel@mozilla.com>
parents: 78
diff changeset
120
102
ad5fd3eb6674 template fixes....not the best, but will do
Jeff Hammel <jhammel@mozilla.com>
parents: 95
diff changeset
121 def main(args=sys.argv[1:]):
ad5fd3eb6674 template fixes....not the best, but will do
Jeff Hammel <jhammel@mozilla.com>
parents: 95
diff changeset
122 cli = PythonPackageCLI(PythonPackageTemplate)
ad5fd3eb6674 template fixes....not the best, but will do
Jeff Hammel <jhammel@mozilla.com>
parents: 95
diff changeset
123 cli(*args)
78
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
124
d4184945f8a8 stub out python package creation
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
125 if __name__ == '__main__':
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 151
diff changeset
126 main()