1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
#!/usr/bin/env python
#
# $Id: docstring_PlainText.py,v 1.1 2001/10/24 21:27:35 doughellmann Exp $
#
# Copyright 2001 Doug Hellmann.
#
#
# All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
"""Plan text format converter.
This is *not* the same as the RawText converter, which is a
pass-through converter. This converter will actually modify some
output.
"""
__rcs_info__ = {
#
# Creation Information
#
'module_name' : '$RCSfile: docstring_PlainText.py,v $',
'rcs_id' : '$Id: docstring_PlainText.py,v 1.1 2001/10/24 21:27:35 doughellmann Exp $',
'creator' : 'Doug Hellmann <DougHellmann@bigfoot.com>',
'project' : 'UNSPECIFIED',
'created' : 'Wed, 26-Sep-2001 09:52:01 EDT',
#
# Current Information
#
'author' : '$Author: doughellmann $',
'version' : '$Revision: 1.1 $',
'date' : '$Date: 2001/10/24 21:27:35 $',
}
try:
__version__ = __rcs_info__['version'].split(' ')[1]
except:
__version__ = '0.0'
#
# Import system modules
#
import string
#
# Import Local modules
#
import happydoclib.docstring.StructuredText
import happydoclib
#
# Module
#
def entryPoint():
"Return information about this module to the dynamic loader."
return {
'name':'PlainText',
'factory':PlainTextConverter,
'filenamePatternList':[],
}
class PlainTextFile(happydoclib.happydocstring.ExternalDocumentationFileBase):
"""External documentation in PlainText format.
"""
_input_type = 'PlainText'
def __init__(self, filename, body=None):
happydoclib.happydocstring.ExternalDocumentationFileBase.__init__(
self,
filename,
body)
lines = self._file_contents.split('\n')
for body_line in lines:
body_line = body_line.strip()
if not body_line:
continue
self._oneliner = body_line
break
return
class PlainTextConverter(happydoclib.happydocstring.HappyDocStringConverterBase):
"""PlainText format converter.
This is *not* the same as the RawText converter, which is a
pass-through converter. This converter will actually modify some
output.
"""
externalDocumentFactory = PlainTextFile
RECOGNIZED_OUTPUT_FORMATS = [ 'html' ]
_input_type = 'PlainText'
def _testOutputFormat(self, outputFormat):
if outputFormat not in self.RECOGNIZED_OUTPUT_FORMATS:
raise ValueError('Unrecognized output format "%s" for %s.' % (
outputFormat,
self.__class__.__name__,
)
)
def convert(self, inputText, outputFormat, level=3, *args, **namedArgs):
"""Returns the 'inputText' data translated into the 'outputFormat'.
Parameters:
'inputText' -- String or other sequence of characters to be
converted. This string should be in the format advertised
by the docstring converter.
'outputFormat' -- String defined by the docstring converter
class to represent a supported output scheme. This value is
converter-specific, and not all converters will support the
same output formats.
'level=3' -- Beginning indention level for the text. This
controls what type of header elements are created among
other behaviors.
"""
self._testOutputFormat(outputFormat)
if outputFormat == 'html':
return '<pre>\n%s\n</pre>' % str(inputText)
return inputText
def quote(self, inputText, outputFormat, *args, **namedArgs):
"""Returns the 'inputText' quoted in a way that special characters are escaped.
Parameters:
'inputText' -- String or other sequence of characters to be
converted. This string should be in the format advertised
by the docstring converter.
'outputFormat' -- String defined by the docstring converter
class to represent a supported output scheme. This value is
converter-specific, and not all converters will support the
same output formats.
'*args' -- Additional, converter-specific, positional arguments.
'**namedArgs' -- Additional, converter-specific, named arguments.
"""
self._testOutputFormat(outputFormat)
if outputFormat == 'html':
return apply( happydoclib.docstring.StructuredText.html_quote,
(inputText,)+args,
namedArgs,
)
return inputText
class PlainTextUnitTest(happydoclib.happydocstring.DocStringConverterTest):
def testPlainTextOneLiner(self):
body = '''This is the one liner.
Here is some additional text.
'''
ptf = PlainTextFile(filename='internal', body=body)
assert ptf, 'Unable to create valid PlainTextFile'
expected_oneliner = 'This is the one liner.'
assert ptf.oneLiner() == expected_oneliner, \
'Got different one-liner "%s"' % ptf.oneLiner()
return
|
