Mercurial > hg > decoupage

annotate decoupage/formatters.py @ 9:ec2d0d850b83

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add ability to print formatters with decoupage-formatters console_script
author k0s <k0scist@gmail.com>
date Thu, 24 Dec 2009 23:33:37 -0500
parents 93ab6d1968bd
children a328cc9d2c74
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
1 #!/usr/bin/env python
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
2
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
3 import sys
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
4 from fnmatch import fnmatch
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
5 from pkg_resources import iter_entry_points
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
6
1
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
7 ### abstract base classes for formatters
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
8
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
9 class FormatterBase(object):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
10 """
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
11 abstract base class if you want to use __init__ methods
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
12 in the form of
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
13 'arg1, arg2, arg3, kw1=foo, kw2=bar, kw3=baz
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
14 """
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
15
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
16 defaults = {}
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
17
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
18 def __init__(self, string):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
19 args = [ i.strip() for i in string.split(',') ]
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
20 for index, arg in enumerate(args):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
21 if '=' in arg:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
22 break
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
23 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
24 self.args = args
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
25 return
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
26 self.args = args[:index]
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
27 self.kw = dict([i.split('=', 1) for i in args[index:]])
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
28 for key, default in defaults.items():
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
29 if key not in self.kw:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
30 self.kw[key] = default
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
31
1
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
32
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
33 ### formatters
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
34
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
35 class Ignore(object):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
36 """ignore files of a certain pattern"""
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
37
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
38
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
39 def __init__(self, ignore):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
40 self.match = [ i.strip() for i in ignore.split(',')
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
41 if i.strip() ]
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
42
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
43 def __call__(self, request, data):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
44 _files = []
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
45 for f in data['files']:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
46 for pattern in self.match:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
47 if fnmatch(f['name'], pattern):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
48 break
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
49 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
50 _files.append(f)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
51 data['files'] = _files
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
52
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
53
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
54 class All(object):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
55 """
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
56 only pass files of a certain pattern;
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
57 the inverse of ignore
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
58 """
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
59
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
60 def __init__(self, pattern):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
61 self.match = [ i.strip() for i in pattern.split(',')
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
62 if i.strip() ]
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
63
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
64
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
65 def __call__(self, request, data):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
66 _files = []
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
67 for f in data['files']:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
68 if self.match:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
69 for pattern in self.match:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
70 if fnmatch(f['name'], pattern):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
71 _files.append(f)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
72 break
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
73 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
74 # use only files where the description is not None
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
75 if f['description'] is not None:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
76 _files.append(f)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
77 data['files'] = _files
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
78
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
79
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
80 class FilenameDescription(FormatterBase):
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
81 """substitute the description for the filename"""
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
82
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
83 def __call__(self, request, data):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
84 for f in data['files']:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
85 if f['description'] is None:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
86 description = f['name']
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
87 if 'strip' in self.args:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
88 description = description.rsplit('.', 1)[0]
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
89 f['description'] = description
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
90
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
91
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
92 class TitleDescription(FormatterBase):
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
93 """splits a description into a title and a description with a separator"""
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
94
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
95
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
96 defaults = { 'separator': ':' }
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
97
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
98 def __call__(self, request, data):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
99 for f in data['files']:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
100 if f['description'] and self.separator in f['description']:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
101 title, description = f['description'].split(self.separator, 1)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
102 f['title'] = title
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
103 f['description'] = description
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
104 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
105 f['title'] = f['description']
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
106 f['description'] = None
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
107
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
108
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
109 def formatters():
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
110 formatters = {}
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
111 for entry_point in iter_entry_points('decoupage.formatters'):
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
112 try:
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
113 formatter = entry_point.load()
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
114 except:
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
115 continue
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
116 formatters[entry_point.name] = formatter
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
117 return formatters
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
118
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
119 def main(args=sys.argv[1:]):
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
120 for name, formatter in formatters().items():
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
121 print '%s%s' % (name, formatter.__doc__ and ': ' + formatter.__doc__ or '')
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
122
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
123 if __name__ == '__main__':
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
124 main()