annotate makeitso/python_package/{{package}}/{{main}}.py @ 196:d25ca7099df8

STUB: makeitso/python_package/{{package}}/{{main}}.py
author Jeff Hammel <k0scist@gmail.com>
date Sat, 24 May 2014 18:24:17 -0700
parents 3cb66c9e5ce8
children bb57bec165b7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 #!/usr/bin/env python
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
2 # -*- coding: utf-8 -*-
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 """
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5 {{description}}
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6 """
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7
187
74f41d53b057 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 161
diff changeset
8 # imports
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
9 import argparse
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
10 import os
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
11 import subprocess
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
12 import sys
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
13
195
3cb66c9e5ce8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 188
diff changeset
14 # module globals
3cb66c9e5ce8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 188
diff changeset
15 __all__ = ['main', 'Parser']
187
74f41d53b057 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 161
diff changeset
16 here = os.path.dirname(os.path.realpath(__file__))
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
17 string = (str, unicode)
187
74f41d53b057 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 161
diff changeset
18
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
19 def ensure_dir(directory):
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
20 """ensure a directory exists"""
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
21 if os.path.exists(directory):
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
22 assert os.path.isdir(directory)
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
23 return directory
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
24 os.makedirs(directory)
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
25 return directory
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
26
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
27
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
28 class Parser(argparse.ArgumentParser):
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
29 """CLI option parser"""
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
30 def __init__(self):
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
31 argparse.ArgumentParser.__init__(self, description=__doc__)
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
32 self.options = None
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
33
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
34 def parse_args(self, *args, **kw):
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
35 options = argparse.ArgumentParser.parse_args(*args, **kw)
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
36 self.validate(options)
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
37 self.options = options
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
38 return options
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
39
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
40 def validate(self, options):
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
41 """validate options"""
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
42
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 149
diff changeset
43 def main(args=sys.argv[1:]):
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
44 """CLI"""
130
d9201f911458 better description formatting
Jeff Hammel <jhammel@mozilla.com>
parents: 79
diff changeset
45
139
23652cbfdfad whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 130
diff changeset
46 # parse command line options
195
3cb66c9e5ce8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 188
diff changeset
47 parser = Parser(description=__doc__)
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
48 options = parser.parse_args(args)
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
49
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
50 if __name__ == '__main__':
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
51 main()