Mercurial > hg > decoupage
annotate decoupage/formatters.py @ 10:a328cc9d2c74
* fix formatters
* allow /inherit keyword to specify configuration
* bump version
author | k0s <k0scist@gmail.com> |
---|---|
date | Fri, 25 Dec 2009 01:03:06 -0500 |
parents | ec2d0d850b83 |
children | 9f91acf9874c |
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 |
10 | 16 defaults = {} # default values for attrs to be set on the instance |
17 | |
0
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
18 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
19 def __init__(self, string): |
10 | 20 args = [ i.strip() for i in string.split(',')] |
0
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
21 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
|
22 if '=' in arg: |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
23 break |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
24 else: |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
25 self.args = args |
10 | 26 for key, default in self.defaults.items(): |
27 setattr(self, key, default) | |
0
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
28 return |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
29 self.args = args[:index] |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
30 self.kw = dict([i.split('=', 1) for i in args[index:]]) |
10 | 31 for key, default in self.defaults.items(): |
32 value = self.kw.pop(key, default) | |
33 setattr(self, key, value) | |
0
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
34 |
1
93ab6d1968bd
adding comments about what this file contains
jhammel@jhammel-laptop
parents:
0
diff
changeset
|
35 |
93ab6d1968bd
adding comments about what this file contains
jhammel@jhammel-laptop
parents:
0
diff
changeset
|
36 ### formatters |
93ab6d1968bd
adding comments about what this file contains
jhammel@jhammel-laptop
parents:
0
diff
changeset
|
37 |
0
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
38 class Ignore(object): |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
39 """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
|
40 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
41 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
42 def __init__(self, ignore): |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
43 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
|
44 if i.strip() ] |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
45 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
46 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
|
47 _files = [] |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
48 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
|
49 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
|
50 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
|
51 break |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
52 else: |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
53 _files.append(f) |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
54 data['files'] = _files |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
55 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
56 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
57 class All(object): |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
58 """ |
9
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
59 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
|
60 the inverse of ignore |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
61 """ |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
62 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
63 def __init__(self, pattern): |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
64 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
|
65 if i.strip() ] |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
66 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
67 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
68 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
|
69 _files = [] |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
70 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
|
71 if self.match: |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
72 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
|
73 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
|
74 _files.append(f) |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
75 break |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
76 else: |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
77 # 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
|
78 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
|
79 _files.append(f) |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
80 data['files'] = _files |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
81 |
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 class FilenameDescription(FormatterBase): |
9
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
84 """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
|
85 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
86 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
|
87 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
|
88 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
|
89 description = f['name'] |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
90 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
|
91 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
|
92 f['description'] = description |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
93 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
94 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
95 class TitleDescription(FormatterBase): |
9
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
96 """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
|
97 |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
98 |
0
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
99 defaults = { 'separator': ':' } |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
100 |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
101 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
|
102 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
|
103 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
|
104 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
|
105 f['title'] = title |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
106 f['description'] = description |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
107 else: |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
108 f['title'] = f['description'] |
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
109 f['description'] = None |
10 | 110 |
0
fa2005f769eb
adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff
changeset
|
111 |
9
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
112 def formatters(): |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
113 formatters = {} |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
114 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
|
115 try: |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
116 formatter = entry_point.load() |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
117 except: |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
118 continue |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
119 formatters[entry_point.name] = formatter |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
120 return formatters |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
121 |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
122 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
|
123 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
|
124 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
|
125 |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
126 if __name__ == '__main__': |
ec2d0d850b83
add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents:
1
diff
changeset
|
127 main() |