root/galaxy-central/eggs/docutils-0.4-py2.6.egg/docutils/transforms/universal.py

リビジョン 3, 5.2 KB (コミッタ: kohda, 14 年 前)

Install Unix tools  http://hannonlab.cshl.edu/galaxy_unix_tools/galaxy.html

行番号 
1# Authors: David Goodger, Ueli Schlaepfer
2# Contact: goodger@users.sourceforge.net
3# Revision: $Revision: 4183 $
4# Date: $Date: 2005-12-12 05:12:02 +0100 (Mon, 12 Dec 2005) $
5# Copyright: This module has been placed in the public domain.
6
7"""
8Transforms needed by most or all documents:
9
10- `Decorations`: Generate a document's header & footer.
11- `Messages`: Placement of system messages stored in
12  `nodes.document.transform_messages`.
13- `TestMessages`: Like `Messages`, used on test runs.
14- `FinalReferences`: Resolve remaining references.
15"""
16
17__docformat__ = 'reStructuredText'
18
19import re
20import sys
21import time
22from docutils import nodes, utils
23from docutils.transforms import TransformError, Transform
24
25
26class Decorations(Transform):
27
28    """
29    Populate a document's decoration element (header, footer).
30    """
31
32    default_priority = 820
33
34    def apply(self):
35        header_nodes = self.generate_header()
36        if header_nodes:
37            decoration = self.document.get_decoration()
38            header = decoration.get_header()
39            header.extend(header_nodes)
40        footer_nodes = self.generate_footer()
41        if footer_nodes:
42            decoration = self.document.get_decoration()
43            footer = decoration.get_footer()
44            footer.extend(footer_nodes)
45
46    def generate_header(self):
47        return None
48
49    def generate_footer(self):
50        # @@@ Text is hard-coded for now.
51        # Should be made dynamic (language-dependent).
52        settings = self.document.settings
53        if settings.generator or settings.datestamp or settings.source_link \
54               or settings.source_url:
55            text = []
56            if settings.source_link and settings._source \
57                   or settings.source_url:
58                if settings.source_url:
59                    source = settings.source_url
60                else:
61                    source = utils.relative_path(settings._destination,
62                                                 settings._source)
63                text.extend([
64                    nodes.reference('', 'View document source',
65                                    refuri=source),
66                    nodes.Text('.\n')])
67            if settings.datestamp:
68                datestamp = time.strftime(settings.datestamp, time.gmtime())
69                text.append(nodes.Text('Generated on: ' + datestamp + '.\n'))
70            if settings.generator:
71                text.extend([
72                    nodes.Text('Generated by '),
73                    nodes.reference('', 'Docutils', refuri=
74                                    'http://docutils.sourceforge.net/'),
75                    nodes.Text(' from '),
76                    nodes.reference('', 'reStructuredText', refuri='http://'
77                                    'docutils.sourceforge.net/rst.html'),
78                    nodes.Text(' source.\n')])
79            return [nodes.paragraph('', '', *text)]
80        else:
81            return None
82
83
84class ExposeInternals(Transform):
85
86    """
87    Expose internal attributes if ``expose_internals`` setting is set.
88    """
89
90    default_priority = 840
91   
92    def not_Text(self, node):
93        return not isinstance(node, nodes.Text)
94
95    def apply(self):
96        if self.document.settings.expose_internals:
97            for node in self.document.traverse(self.not_Text):
98                for att in self.document.settings.expose_internals:
99                    value = getattr(node, att, None)
100                    if value is not None:
101                        node['internal:' + att] = value
102
103
104class Messages(Transform):
105
106    """
107    Place any system messages generated after parsing into a dedicated section
108    of the document.
109    """
110
111    default_priority = 860
112
113    def apply(self):
114        unfiltered = self.document.transform_messages
115        threshold = self.document.reporter.report_level
116        messages = []
117        for msg in unfiltered:
118            if msg['level'] >= threshold and not msg.parent:
119                messages.append(msg)
120        if messages:
121            section = nodes.section(classes=['system-messages'])
122            # @@@ get this from the language module?
123            section += nodes.title('', 'Docutils System Messages')
124            section += messages
125            self.document.transform_messages[:] = []
126            self.document += section
127
128
129class FilterMessages(Transform):
130
131    """
132    Remove system messages below verbosity threshold.
133    """
134
135    default_priority = 870
136
137    def apply(self):
138        for node in self.document.traverse(nodes.system_message):
139            if node['level'] < self.document.reporter.report_level:
140                node.parent.remove(node)
141
142
143class TestMessages(Transform):
144
145    """
146    Append all post-parse system messages to the end of the document.
147
148    Used for testing purposes.
149    """
150
151    default_priority = 880
152
153    def apply(self):
154        for msg in self.document.transform_messages:
155            if not msg.parent:
156                self.document += msg
157
158
159class StripComments(Transform):
160
161    """
162    Remove comment elements from the document tree (only if the
163    ``strip_comments`` setting is enabled).
164    """
165
166    default_priority = 740
167
168    def apply(self):
169        if self.document.settings.strip_comments:
170            for node in self.document.traverse(nodes.comment):
171                node.parent.remove(node)
Note: リポジトリブラウザについてのヘルプは TracBrowser を参照してください。