annotate makeitso/python_package/{{package}}/{{main}}.py @ 209:ee752ac566f1

correct template syntax
author Jeff Hammel <k0scist@gmail.com>
date Sat, 28 Feb 2015 16:08:45 -0800
parents 04c5464355b8
children ab726b2f3143
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
207
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
13 import time
159
Jeff Hammel <jhammel@mozilla.com>
parents: 155
diff changeset
14
195
3cb66c9e5ce8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 188
diff changeset
15 # module globals
3cb66c9e5ce8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 188
diff changeset
16 __all__ = ['main', 'Parser']
187
74f41d53b057 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 161
diff changeset
17 here = os.path.dirname(os.path.realpath(__file__))
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
18 string = (str, unicode)
187
74f41d53b057 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 161
diff changeset
19
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
20 def ensure_dir(directory):
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
21 """ensure a directory exists"""
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
22 if os.path.exists(directory):
205
0a991b8fe839 better check
Jeff Hammel <k0scist@gmail.com>
parents: 198
diff changeset
23 if not os.path.isdir(directory):
0a991b8fe839 better check
Jeff Hammel <k0scist@gmail.com>
parents: 198
diff changeset
24 raise OSError("Not a directory: '{}'".format(directory))
196
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 os.makedirs(directory)
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
27 return directory
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
28
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
29
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
30 class Parser(argparse.ArgumentParser):
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
31 """CLI option parser"""
198
be7e2e336d7a STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 197
diff changeset
32 def __init__(self, **kwargs):
206
d9d7bfdb54db http://stackoverflow.com/questions/4375327/python-argparse-preformatted-help-text
Jeff Hammel <k0scist@gmail.com>
parents: 205
diff changeset
33 kwargs.setdefault('formatter_class', argparse.RawTextHelpFormatter)
198
be7e2e336d7a STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 197
diff changeset
34 kwargs.setdefault('description', __doc__)
be7e2e336d7a STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 197
diff changeset
35 argparse.ArgumentParser.__init__(self, **kwargs)
207
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
36 self.add_argument('--monitor', dest='monitor',
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
37 type=float, metavar='SLEEP',
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
38 help="run in monitor mode")
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
39 self.options = None
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
40
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
41 def parse_args(self, *args, **kw):
197
bb57bec165b7 fix errors with template
Jeff Hammel <k0scist@gmail.com>
parents: 196
diff changeset
42 options = argparse.ArgumentParser.parse_args(self, *args, **kw)
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
43 self.validate(options)
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
44 self.options = options
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
45 return options
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
46
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
47 def validate(self, options):
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
48 """validate options"""
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
49
155
386a44a52139 moving to a thing with script template
Jeff Hammel <jhammel@mozilla.com>
parents: 149
diff changeset
50 def main(args=sys.argv[1:]):
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
51 """CLI"""
130
d9201f911458 better description formatting
Jeff Hammel <jhammel@mozilla.com>
parents: 79
diff changeset
52
139
23652cbfdfad whitespace
Jeff Hammel <jhammel@mozilla.com>
parents: 130
diff changeset
53 # parse command line options
197
bb57bec165b7 fix errors with template
Jeff Hammel <k0scist@gmail.com>
parents: 196
diff changeset
54 parser = Parser()
188
1bcf60bcc455 update to argparse
Jeff Hammel <k0scist@gmail.com>
parents: 187
diff changeset
55 options = parser.parse_args(args)
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
56
207
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
57 try:
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
58 while True:
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
59 if options.monitor:
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
60 time.sleep(options.monitor)
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
61 else:
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
62 break
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
63 except KeyboardInterrupt:
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
64 pass
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
65
79
8c326f764cfe add a CLI template
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
66 if __name__ == '__main__':
196
d25ca7099df8 STUB: makeitso/python_package/{{package}}/{{main}}.py
Jeff Hammel <k0scist@gmail.com>
parents: 195
diff changeset
67 main()
207
04c5464355b8 monitor
Jeff Hammel <k0scist@gmail.com>
parents: 206
diff changeset
68