annotate smartopen/smartopen.py @ 9:4dd12cf64c0e

remove debugging code and state what should be done
author Jeff Hammel <jhammel@mozilla.com>
date Tue, 04 May 2010 08:49:39 -0700
parents 01015b36290a
children a62fbff067f8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
1 #!/usr/bin/env python
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
2
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
3 """ smart open the data passed in """
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
4
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
5 import os
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
6 import sys
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
7
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
8 from optparse import OptionParser
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
9 from pkg_resources import iter_entry_points
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
10 from ConfigParser import ConfigParser
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
11
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
12 def locations(names=None, config=None):
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
13 """
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
14 list of 2-tuples of location handlers;
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
15 * names: order names of handlers
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
16 * config: nested dictionary of configuration from names
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
17 """
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
18
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
19 _handlers = {}
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
20 _names = []
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
21 if config is None:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
22 config = {}
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
23
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
24 for i in iter_entry_points('smartopen.locations'):
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
25 try:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
26 handler = i.load()
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
27 except:
9
4dd12cf64c0e remove debugging code and state what should be done
Jeff Hammel <jhammel@mozilla.com>
parents: 4
diff changeset
28 continue # TODO: warn/debug with --verbose flag
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
29 _handlers[i.name] = handler
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
30 if not names:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
31 _names.append(i.name)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
32
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
33 if not names:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
34 names = _names
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
35 handlers = []
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
36 for name in names:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
37 if ':' in name:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
38 _name, section = name.split(':', 1)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
39 else:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
40 _name = name
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
41 if _name in _handlers:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
42 try:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
43 handler = _handlers[_name](**config.get(name, {}))
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
44 except:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
45 continue
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
46 handlers.append((name, handler))
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
47 return handlers
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
48
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
49 def urls(query, handlers=None):
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
50 if handlers is None:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
51 handlers = locations()
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
52 urls = []
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
53 for name, handler in handlers:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
54 if handler.test(query):
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
55 urls.append((name, handler.url(query)))
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
56 return urls
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
57
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
58 def url(query, handlers=None):
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
59 if handlers is None:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
60 handlers = locations()
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
61 for name, handler in handlers:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
62 if handler.test(query):
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
63 return handler.url(query)
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
64
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
65 def main(args=sys.argv[1:]):
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
66
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
67 # parse command line optioins
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
68 parser = OptionParser()
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
69 parser.add_option('-c', '--config', dest="config",
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
70 help="config file to read")
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
71 parser.add_option('-u', '--url', dest="url",
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
72 action='store_true', default=False,
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
73 help="print the first url handled")
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
74 parser.add_option('-a', '--all', dest="all",
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
75 action='store_true', default=False,
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
76 help="print all handlers that match the query")
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
77 parser.add_option('-H', '--handler', dest="handlers",
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
78 action='append',
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
79 help="name of the handler to use, in order")
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
80 parser.add_option('--print-handlers', dest="print_handlers",
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
81 action='store_true',
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
82 help="print all handlers in order they would be tried")
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
83 options, args = parser.parse_args(args)
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
84
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
85 # sanity check
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
86 assert not (options.url and options.all)
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
87 if not options.handlers:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
88 options.handlers = None
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
89
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
90 # config
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
91 config = ConfigParser()
4
01015b36290a look for home configuration file if it exists
k0s <k0scist@gmail.com>
parents: 1
diff changeset
92 if not options.config:
01015b36290a look for home configuration file if it exists
k0s <k0scist@gmail.com>
parents: 1
diff changeset
93 options.config = os.path.join(os.environ.get('HOME', ''), '.smartopen.ini')
01015b36290a look for home configuration file if it exists
k0s <k0scist@gmail.com>
parents: 1
diff changeset
94 if os.path.exists(options.config):
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
95 config.read(options.config)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
96 if not options.handlers and config.has_option('DEFAULTS', 'handlers'):
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
97 options.handlers = [ i.strip() for i in config.get('DEFAULTS', 'handlers').split(',') ]
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
98 _config = {}
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
99 for section in config.sections():
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
100 _config[section] = dict(config.items(section))
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
101
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
102 # get the handlers
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
103 _locations = locations(options.handlers, _config)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
104
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
105 # print the handlers
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
106 if options.print_handlers:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
107 for name, loc in _locations:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
108 print name
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
109 sys.exit(0)
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
110
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
111 # get data to be operated on
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
112 if args:
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
113 data = ' '.join(args)
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
114 else:
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
115 data = sys.stdin.read()
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
116
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
117 # print the URLs
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
118 if options.all:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
119 _urls = urls(data, _locations)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
120 for name, _url in _urls:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
121 print '%s: %s' % (name, _url)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
122 sys.exit(0)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
123
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
124 _url = url(data, _locations)
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
125
1
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
126 # print a URL
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
127 if options.url:
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
128 print _url
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
129 sys.exit(0)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
130
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
131 # open the URL in a browser
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
132 os.system("firefox '%s'" % _url)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
133 sys.exit(0)
10fc4904c10f now can pass data
k0s <k0scist@gmail.com>
parents: 0
diff changeset
134
0
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
135
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
136 if __name__ == '__main__':
d6fa501af82f initial commit of smartopen
k0s <k0scist@gmail.com>
parents:
diff changeset
137 main()