Mercurial > hg > decoupage

annotate decoupage/formatters.py @ 51:8002dcdb8e82

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add "-" to list of FilenameDescription separators
author Jeff Hammel <jhammel@mozilla.com>
date Wed, 03 Nov 2010 18:41:42 -0700
parents 650e1b62a628
children 9c15bde43ae6
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
10
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
16 defaults = {} # default values for attrs to be set on the instance
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
17
0
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):
10
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
19 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
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
10
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
25 for key, default in self.defaults.items():
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
26 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
27 return
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
28 self.args = args[:index]
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
29 self.kw = dict([i.split('=', 1) for i in args[index:]])
10
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
30 for key, default in self.defaults.items():
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
31 value = self.kw.pop(key, default)
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
32 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
33
1
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
34
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
35 ### formatters
93ab6d1968bd adding comments about what this file contains
jhammel@jhammel-laptop
parents: 0
diff changeset
36
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
37 class Ignore(object):
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
38 """
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
39 ignore files of a glob patterns.
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
40 These files will not be linked to in the template.
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
41 e.g. /ignore = .* *.pdf # don't list dotfiles and PDFs
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
42 """
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
43
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
44 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
45 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
46
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
47 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
48 _files = []
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
49 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
50 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
51 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
52 break
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
53 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
54 _files.append(f)
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
55 data['files'] = _files
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
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
58 class All(object):
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
59 """
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
60 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
61 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
62 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
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 __init__(self, pattern):
12
9f91acf9874c * split on space in formatters to be consist with everything else
k0s <k0scist@gmail.com>
parents: 10
diff changeset
66 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
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
22
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
82 class Sort(object):
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
83 """
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
84 determines how to sort the files in a directory;
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
85 right now only by case-insensitive alphabetically
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
86 * reverse : reverse the order of the sorting
27
9e86c5cb111a minor documentation updates
k0s <k0scist@gmail.com>
parents: 24
diff changeset
87 """
22
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
88 def __init__(self, pattern):
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
89 self.args = [i.strip() for i in pattern.split(',')]
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
90
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
91 def __call__(self, request, data):
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
92
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
93 data['files'] = sorted(data['files'], key=lambda x: x['name'].lower())
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
94
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
95 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
96 data['files'] = list(reversed(data['files']))
22
a8d36caa8f09 add formatter
egj@socialplanning.org
parents: 17
diff changeset
97
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
98
45
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
99 class Order(object):
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
100 """
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
101 put the files in a particular order
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
102 """
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
103 def __init__(self, pattern):
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
104 if '=' in pattern:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
105 key, value = pattern.split('=', 1)
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
106 assert key == 'file'
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
107 self.file = value
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
108 else:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
109 self.order = [i.strip() for i in pattern.split(',')]
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
110
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
111 def __call__(self, request, data):
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
112
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
113 if self.file:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
114 raise NotImplementedError
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 files = []
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
117 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
118 for f in self.order:
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
119 files.append(file_hash.get(f, None))
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
120 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
121
650e1b62a628 add order formatter (untested)
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
122
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
123 class FilenameDescription(FormatterBase):
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
124 """
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
125 obtain the description from the filename
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
126 the file extension (if any) will be dropped and
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
127 spaces will be substituted for underscores
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
128 """
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
129 # 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
130
51
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
131 separators = ['_', '-'] # space substitute separators
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
132
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
133 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
134 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
135 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
136 description = f['name']
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
137 if '.' in description:
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
138 description = description.rsplit('.', 1)[0]
17
eab191e0b9b3 meaningful descriptions from filenames
k0s <k0scist@gmail.com>
parents: 16
diff changeset
139 decription = description.strip('_')
51
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
140 for separator in self.separators:
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
141 if separator in description:
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
142 description = ' '.join([i.title() for i in description.split(separator)])
8002dcdb8e82 add "-" to list of FilenameDescription separators
Jeff Hammel <jhammel@mozilla.com>
parents: 45
diff changeset
143
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
144 f['description'] = description
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
145
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
146
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
147 class TitleDescription(FormatterBase):
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
148 """
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
149 splits a description into a title and a description via a separator in
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
150 the description. The template will now have an additional variable,
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
151 'title', per file
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
152 Arguments:
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
153 * separator: what separator to use (':' by default)
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
154 """
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
155 # 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
156
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
157 defaults = { 'separator': ':' }
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
158
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
159 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
160 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
161 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
162 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
163 title = title.strip()
677e2fe1239c using a blank title will have the title be the filename
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
164 description = description.strip()
677e2fe1239c using a blank title will have the title be the filename
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
165 if not title:
677e2fe1239c using a blank title will have the title be the filename
Jeff Hammel <jhammel@mozilla.com>
parents: 35
diff changeset
166 title = f['name']
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
167 f['title'] = title
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
168 f['description'] = description
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
169 else:
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
170 f['title'] = f['description']
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
171 f['description'] = None
10
a328cc9d2c74 * fix formatters
k0s <k0scist@gmail.com>
parents: 9
diff changeset
172
32
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
173 class Links(FormatterBase):
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
174 """
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
175 allow list of links per item:
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
176 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
177 """
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
178
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
179 defaults = { 'separator': ';' }
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
180
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
181 def __call__(self, request, data):
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
182 for f in data['files']:
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
183 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
184 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
185 links = links.split(self.separator)
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
186 assert min(['=' in link for link in links])
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
187 links = [ link.split('=', 1) for link in links ]
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
188 f['links'] = [ { 'text': text, 'link': link }
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
189 for text, link in links ]
983c13e1b71f included a links formatter; restructure index template
k0s <k0scist@gmail.com>
parents: 24
diff changeset
190
35
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
191
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
192 class Up(object):
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
193 """
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
194 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
195 /up = ..
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
196 """
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
197
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
198 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
199 self.up = arg.strip()
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
200
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
201 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
202 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
203 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
204 data['files'].insert(0, {'path': '..',
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
205 '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
206 'description': self.up})
20e3d138dc98 better way of doing up; this breaks old behaviour so incrementing version
k0s <k0scist@gmail.com>
parents: 34
diff changeset
207
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
208 class CSS(object):
28
fc1c479296c3 more docmentation updates
k0s <k0scist@gmail.com>
parents: 27
diff changeset
209 """specify CSS used (whitespace separated list)"""
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
210
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
211 def __init__(self, arg):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
212 self.css = arg.split()
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
213 def __call__(self, request, data):
24
6b27461955d1 correct variable name
k0s <k0scist@gmail.com>
parents: 23
diff changeset
214 data['css'] = self.css
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
215
33
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
216 class JavaScript(object):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
217 """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
218
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
219 def __init__(self, arg):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
220 self.scripts = arg.split()
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
221 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
222 data['scripts'] = self.scripts
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
223
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
224 class Favicon(object):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
225 """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
226
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
227 def __init__(self, icon):
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
228 self.icon = icon
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
229 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
230 data['icon'] = self.icon
e384d4569ac3 include components necessary to make decoupage feel almost like a framework
k0s <k0scist@gmail.com>
parents: 32
diff changeset
231
16
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
232 class Include(object):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
233 """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
234
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
235 def __init__(self, arg):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
236 self.include = arg
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
237 def __call__(self, request, data):
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
238 data['include'] = self.include
985b3a7e0e88 add formatters to include css and genshi templates
k0s <k0scist@gmail.com>
parents: 12
diff changeset
239
0
fa2005f769eb adding decoupage from http://my-svn.assembla.com/svn/arbez/decoupage r355
k0s <k0scist@gmail.com>
parents:
diff changeset
240
9
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
241 def formatters():
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
242 formatters = {}
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
243 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
244 try:
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
245 formatter = entry_point.load()
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
246 except:
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
247 continue
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
248 formatters[entry_point.name] = formatter
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
249 return formatters
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
250
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
251 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
252 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
253 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
254
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
255 if __name__ == '__main__':
ec2d0d850b83 add ability to print formatters with decoupage-formatters console_script
k0s <k0scist@gmail.com>
parents: 1
diff changeset
256 main()