Mercurial > hg > contenttransformer

annotate contenttransformer/transformers.py @ 15:946176949bba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add the genshi transformer
author Jeff Hammel <jhammel@mozilla.com>
date Mon, 06 Sep 2010 08:45:30 -0700
parents 59496de89997
children 6cbe4172b54b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
29805d442afc initial commit of contenttransformer; still in the stub stage
k0s <k0scist@gmail.com>
parents:
diff changeset
1 import docutils.core
2
1e2c475015d8 restructured text now works
k0s <k0scist@gmail.com>
parents: 0
diff changeset
2 import subprocess
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
3 from webob import Request, Response
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
4
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
5 class Transformer(object):
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
6 """abstract base class for transformer objects"""
9
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
7 def __init__(self, content, content_type):
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
8 self.content = content
9
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
9 self.content_type = content_type
0
29805d442afc initial commit of contenttransformer; still in the stub stage
k0s <k0scist@gmail.com>
parents:
diff changeset
10
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
11 def transform(self, request):
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
12 """returns a tuple of (body, content-type)"""
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
13 raise NotImplementedError
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
14
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
15 def __call__(self, environ, start_response):
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
16 request = Request(environ)
9
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
17 response = self.get_response(request)
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
18 return response(environ, start_response)
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
19
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
20 def get_response(self, request):
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
21 if request.GET.get('format') == 'raw':
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
22 return Response(content_type=self.content_type, body=self.content)
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
23 content_type, body = self.transform(request)
9
051d4d39b4b9 * separate out get_response to its own function
k0s <k0scist@gmail.com>
parents: 7
diff changeset
24 return Response(content_type=content_type, body=body)
10
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
25
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
26 class ContentTypeChanger(Transformer):
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
27 def __init__(self, content, from_type, to_type):
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
28 self.to_type = to_type
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
29 Transformer.__init__(self, content, from_type)
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
30
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
31 def transform(self, request):
a9ddcfc7c4e8 added transformer just of content-type name
k0s <k0scist@gmail.com>
parents: 9
diff changeset
32 return (self.to_type, self.content)
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
33
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
34 class Graphviz(Transformer):
12
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
35 content_types = { 'png': 'image/png',
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
36 'svg': 'image/svg+xml' }
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
37
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
38 def __init__(self, content, content_type, format='png'):
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
39 self.format=format
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
40 Transformer.__init__(self, content, content_type)
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
41
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
42 def transform(self, request):
0
29805d442afc initial commit of contenttransformer; still in the stub stage
k0s <k0scist@gmail.com>
parents:
diff changeset
43 """create a Graphviz object"""
12
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
44 _format = request.GET.get('format', self.format)
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
45 assert _format in self.content_types, 'Unknown format: ' + _format
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
46 process = subprocess.Popen(['dot', '-T' + _format],
3
1a267297f779 graphviz now works, giving real version
k0s <k0scist@gmail.com>
parents: 2
diff changeset
47 stdin=subprocess.PIPE,
1a267297f779 graphviz now works, giving real version
k0s <k0scist@gmail.com>
parents: 2
diff changeset
48 stdout=subprocess.PIPE)
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
49 image, _ = process.communicate(self.content)
12
59496de89997 allow graphviz to serve svg
Jeff Hammel <jhammel@mozilla.com>
parents: 10
diff changeset
50 return (self.content_types[_format], image)
0
29805d442afc initial commit of contenttransformer; still in the stub stage
k0s <k0scist@gmail.com>
parents:
diff changeset
51
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
52 class RestructuredText(Transformer):
0
29805d442afc initial commit of contenttransformer; still in the stub stage
k0s <k0scist@gmail.com>
parents:
diff changeset
53 settings = { 'report_level': 5 }
29805d442afc initial commit of contenttransformer; still in the stub stage
k0s <k0scist@gmail.com>
parents:
diff changeset
54
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
55 def transform(self, request):
0
29805d442afc initial commit of contenttransformer; still in the stub stage
k0s <k0scist@gmail.com>
parents:
diff changeset
56 """template: genshi(?) template to use (???)"""
7
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
57 html = docutils.core.publish_string(self.content,
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
58 writer_name='html',
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
59 settings_overrides=self.settings)
68643e72c749 use abstract base class for transformers so that behaviour can be streamlined
k0s <k0scist@gmail.com>
parents: 3
diff changeset
60 return ('text/html', html)
15
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
61
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
62 try:
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
63 import genshi
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
64 from genshi.template import MarkupTemplate
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
65
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
66 class GenshiTransformer(Transformer):
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
67
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
68 def __init__(self, content, content_type):
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
69 Transformer.__init__(self, content, content_type)
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
70
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
71 def transform(self, request):
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
72 variables = dict(request=request)
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
73 template = MarkupTemplate(self.content)
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
74 stream = template.generate(**variables)
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
75 return ('text/html', stream.render('html', doctype='html'))
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
76
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
77 except ImportError:
946176949bba add the genshi transformer
Jeff Hammel <jhammel@mozilla.com>
parents: 12
diff changeset
78 pass