Mercurial > hg > decoupage

annotate decoupage/formatters.py @ 68:4094bee13154

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
quick cleanup
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 03 Aug 2012 23:46:29 -0700
parents fdb77c57bd22
children 262fb90a54b4
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
67
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
3 import random
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
4 import sys
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
5 from fnmatch import fnmatch
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
6 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
7
1
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
8 ### abstract base classes for formatters
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
9
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
10 class FormatterBase(object):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
11 """
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
12 abstract base class if you want to use __init__ methods
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
13 in the form of
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
14 '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
15 """
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
16
10
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
17 defaults = {} # default values for attrs to be set on the instance
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
18
0
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
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
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
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
26 for key, default in self.defaults.items():
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
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
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
31 for key, default in self.defaults.items():
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
32 value = self.kw.pop(key, default)
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
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):
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
39 """
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
40 ignore files of a glob patterns.
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
41 These files will not be linked to in the template.
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
42 e.g. /ignore = .* *.pdf # don't list dotfiles and PDFs
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
43 """
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
44
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
45 def __init__(self, ignore):
12
9f91acf9874c * split on space in formatters to be consist with everything else
k0s <k0scist@gmail.com>
parents: 10
diff changeset
46 self.match = ignore.split()
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
47
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
48 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
49 _files = []
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
50 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
51 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
52 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
53 break
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
54 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
55 _files.append(f)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
56 data['files'] = _files
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
57
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 class All(object):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
60 """
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
61 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
62 the inverse of ignore
12
9f91acf9874c * split on space in formatters to be consist with everything else
k0s <k0scist@gmail.com>
parents: 10
diff changeset
63 calling all with no arguments means only files with descriptions are used
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
64 """
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
65
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
66 def __init__(self, pattern):
12
9f91acf9874c * split on space in formatters to be consist with everything else
k0s <k0scist@gmail.com>
parents: 10
diff changeset
67 self.match = pattern.split()
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
68
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
69 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
70 _files = []
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
71 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
72 if self.match:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
73 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
74 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
75 _files.append(f)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
76 break
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
77 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
78 # 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
79 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
80 _files.append(f)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
81 data['files'] = _files
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
82
67
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
83 class Sort(FormatterBase):
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
84 """
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
85 determines how to sort the files in a directory;
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
86 right now only by case-insensitive alphabetically
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
87 * reverse : reverse the order of the sorting
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
88 """
67
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
89 defaults = {'order': 'name'}
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
90
22
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
91 def __init__(self, pattern):
67
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
92 FormatterBase.__init__(self, pattern)
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
93 self.orders = {'name': self.name,
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
94 'random': self.random,
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
95 }
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
96 # TODO: date
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
97
22
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
98 def __call__(self, request, data):
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
99
67
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
100 sort = self.orders.get(request.GET.get('order', self.order), self.name)
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
101 data['files'] = sort(data['files'])
22
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
102
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
103 if 'reverse' in self.args:
23
d1b1019d9254 unfold the list out of the reverseiterator which otherwise gets consumed and funky
egj@socialplanning.org
parents: 22
diff changeset
104 data['files'] = list(reversed(data['files']))
67
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
105
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
106 def name(self, files):
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
107 return sorted(files, key=lambda x: x['name'].lower())
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
108
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
109 def random(self, files):
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
110 random.shuffle(files)
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
111 return files
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
112
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
113
45
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
114 class Order(object):
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
115 """
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
116 put the files in a particular order
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
117 """
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
118 def __init__(self, pattern):
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
119 if '=' in pattern:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
120 key, value = pattern.split('=', 1)
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
121 assert key == 'file'
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
122 self.file = value
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
123 else:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
124 self.order = [i.strip() for i in pattern.split(',')]
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
125
45
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
126 def __call__(self, request, data):
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
127
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
128 if self.file:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
129 raise NotImplementedError
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
130
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
131 files = []
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
132 file_hash = dict([(i['name'], i) for i in data['files']])
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
133 for f in self.order:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
134 files.append(file_hash.get(f, None))
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
135 files = [ i for i in files if i is not None ]
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
136
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
137
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
138 class FilenameDescription(FormatterBase):
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
139 """
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
140 obtain the description from the filename
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
141 the file extension (if any) will be dropped and
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
142 spaces will be substituted for underscores
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
143 """
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
144 # TODO : deal with CamelCaseFilenames
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
145
51
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
146 separators = ['_', '-'] # space substitute separators
53
9c15bde43ae6 dont capitalize unimportant words
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
147 lesser_words = [ 'or', 'a', 'the', 'on', 'of' ] # unimportant words
51
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
148
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
149 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
150 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
151 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
152 description = f['name']
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
153 if '.' in description:
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
154 description = description.rsplit('.', 1)[0]
17
eab191e0b9b3 meaningful descriptions from filenames
k0s <k0scist@gmail.com>
parents: 16
diff changeset
155 decription = description.strip('_')
51
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
156 for separator in self.separators:
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
157 if separator in description:
53
9c15bde43ae6 dont capitalize unimportant words
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
158 description = ' '.join([(i in self.lesser_words) and i or i.title()
9c15bde43ae6 dont capitalize unimportant words
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
159 for i in description.split(separator)])
9c15bde43ae6 dont capitalize unimportant words
Jeff Hammel <jhammel@mozilla.com>
parents: 51
diff changeset
160 description = description[0].upper() + description[1:]
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
161 f['description'] = description
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
162
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
163
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
164 class TitleDescription(FormatterBase):
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
165 """
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
166 splits a description into a title and a description via a separator in
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
167 the description. The template will now have an additional variable,
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
168 'title', per file
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
169 Arguments:
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
170 * separator: what separator to use (':' by default)
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
171 """
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
172 # XXX what about setting the page title?
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
173
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
174 defaults = { 'separator': ':' }
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
175
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
176 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
177 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
178 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
179 title, description = f['description'].split(self.separator, 1)
39
677e2fe1239c using a blank title will have the title be the filename
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
180 title = title.strip()
677e2fe1239c using a blank title will have the title be the filename
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
181 description = description.strip()
677e2fe1239c using a blank title will have the title be the filename
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
182 if not title:
677e2fe1239c using a blank title will have the title be the filename
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
183 title = f['name']
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
184 f['title'] = title
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
185 f['description'] = description
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
186 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
187 f['title'] = f['description']
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
188 f['description'] = None
10
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
189
32
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
190 class Links(FormatterBase):
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
191 """
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
192 allow list of links per item:
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
193 foo.html = description of foo; [PDF]=foo.pdf; [TXT]=foo.txt
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
194 """
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
195
32
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
196 defaults = { 'separator': ';' }
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
197
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
198 def __call__(self, request, data):
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
199 for f in data['files']:
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
200 if f['description'] and self.separator in f['description']:
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
201 f['description'], links = f['description'].split(self.separator, 1)
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
202 links = links.split(self.separator)
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
203 assert min(['=' in link for link in links])
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
204 links = [ link.split('=', 1) for link in links ]
67
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
205 f['links'] = [{ 'text': text, 'link': link }
fdb77c57bd22 make sort formatter more extensible and add a random method
Jeff Hammel <jhammel@mozilla.com>
parents: 65
diff changeset
206 for text, link in links]
32
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
207
35
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
208
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
209 class Up(object):
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
210 """
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
211 provides an up link to the path above:
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
212 /up = ..
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
213 """
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
214
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
215 def __init__(self, arg):
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
216 self.up = arg.strip()
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
217
35
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
218 def __call__(self, request, data):
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
219 path = request.path_info
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
220 if (path != '/') and self.up:
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
221 data['files'].insert(0, {'path': '..',
65
ac1dc088e37e add inclusion template
Jeff Hammel <jhammel@mozilla.com>
parents: 53
diff changeset
222 'type': 'directory',
35
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
223 'name': path.rsplit('/', 1)[0] + '/',
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
224 'description': self.up})
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
225
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
226 class CSS(object):
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
227 """specify CSS used (whitespace separated list)"""
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
228
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
229 def __init__(self, arg):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
230 self.css = arg.split()
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
231 def __call__(self, request, data):
24
6b27461955d1 correct variable name
k0s <k0scist@gmail.com>
parents: 23
diff changeset
232 data['css'] = self.css
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
233
33
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
234 class JavaScript(object):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
235 """specify JS for the page"""
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
236
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
237 def __init__(self, arg):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
238 self.scripts = arg.split()
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
239 def __call__(self, request, data):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
240 data['scripts'] = self.scripts
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
241
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
242 class Favicon(object):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
243 """specify favicons for the page"""
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
244
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
245 def __init__(self, icon):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
246 self.icon = icon
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
247 def __call__(self, request, data):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
248 data['icon'] = self.icon
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
249
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
250 class Include(object):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
251 """include a file at the top of the body"""
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
252
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
253 def __init__(self, arg):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
254 self.include = arg
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
255 def __call__(self, request, data):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
256 data['include'] = self.include
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
257
68
4094bee13154 quick cleanup
Jeff Hammel <jhammel@mozilla.com>
parents: 67
diff changeset
258
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
259 def formatters():
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
260 formatters = {}
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
261 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
262 try:
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
263 formatter = entry_point.load()
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
264 except:
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
265 continue
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
266 formatters[entry_point.name] = formatter
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
267 return formatters
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
268
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
269 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
270 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
271 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
272
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
273 if __name__ == '__main__':
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
274 main()