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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
import sys
import zipfile
import tarfile
import gzip
import bz2
import StringIO
import cgi
import urlparse
from docutils import io, readers
from docutils.core import publish_doctree, Publisher
from docutils.writers import get_writer_class
from docutils.transforms import TransformError, Transform
# BEGIN PYGMENTS SUPPORT BLOCK
# <RJ> the following is included from pygments' external / rst-directive.py
# because the docutils version on both testpypi and pypi prod does not include
# pygments support (I believe 0.9 is the minimum requirement.) If that's ever
# resolved then this PYGMENTS SUPPORT BLOCK may be removed.
# Set to True if you want inline CSS styles instead of classes
INLINESTYLES = False
from pygments.formatters import HtmlFormatter
# The default formatter
DEFAULT = HtmlFormatter(noclasses=INLINESTYLES)
# Add name -> formatter pairs for every variant you want to use
VARIANTS = {
# 'linenos': HtmlFormatter(noclasses=INLINESTYLES, linenos=True),
}
from docutils import nodes
from docutils.parsers.rst import directives, Directive
from pygments import highlight
from pygments.lexers import get_lexer_by_name, TextLexer
class Pygments(Directive):
""" Source code syntax hightlighting.
"""
required_arguments = 1
optional_arguments = 0
final_argument_whitespace = True
option_spec = dict([(key, directives.flag) for key in VARIANTS])
has_content = True
def run(self):
self.assert_has_content()
try:
lexer = get_lexer_by_name(self.arguments[0])
except ValueError:
# no lexer found - use the text one instead of an exception
lexer = TextLexer()
# take an arbitrary option if more than one is given
formatter = self.options and VARIANTS[self.options.keys()[0]] or DEFAULT
parsed = highlight(u'\n'.join(self.content), lexer, formatter)
return [nodes.raw('', parsed, format='html')]
directives.register_directive('code', Pygments)
directives.register_directive('code-block', Pygments) # Sphinx
directives.register_directive('sourcecode', Pygments)
# END PYGMENTS SUPPORT BLOCK
def trim_docstring(text):
"""
Trim indentation and blank lines from docstring text & return it.
See PEP 257.
"""
if not text:
return text
# Convert tabs to spaces (following the normal Python rules)
# and split into a list of lines:
lines = text.expandtabs().splitlines()
# Determine minimum indentation (first line doesn't count):
indent = sys.maxint
for line in lines[1:]:
stripped = line.lstrip()
if stripped:
indent = min(indent, len(line) - len(stripped))
# Remove indentation (first line is special):
trimmed = [lines[0].strip()]
if indent < sys.maxint:
for line in lines[1:]:
trimmed.append(line[indent:].rstrip())
# Strip off trailing and leading blank lines:
while trimmed and not trimmed[-1]:
trimmed.pop()
while trimmed and not trimmed[0]:
trimmed.pop(0)
# Return a single string:
return '\n'.join(trimmed)
ALLOWED_SCHEMES = '''file ftp gopher hdl http https imap mailto mms news nntp
prospero rsync rtsp rtspu sftp shttp sip sips snews svn svn+ssh telnet
wais irc'''.split()
def processDescription(source, output_encoding='unicode'):
"""Given an source string, returns an HTML fragment as a string.
The return value is the contents of the <body> tag.
Parameters:
- `source`: A multi-line text string; required.
- `output_encoding`: The desired encoding of the output. If a Unicode
string is desired, use the default value of "unicode" .
"""
# Dedent all lines of `source`.
source = trim_docstring(source)
settings_overrides={
'raw_enabled': 0, # no raw HTML code
'file_insertion_enabled': 0, # no file/URL access
'halt_level': 2, # at warnings or errors, raise an exception
'report_level': 5, # never report problems with the reST code
}
# capture publishing errors, they go to stderr
old_stderr = sys.stderr
sys.stderr = s = StringIO.StringIO()
parts = None
try:
# Convert reStructuredText to HTML using Docutils.
document = publish_doctree(source=source,
settings_overrides=settings_overrides)
for node in document.traverse():
if node.tagname == '#text':
continue
if node.hasattr('refuri'):
uri = node['refuri']
elif node.hasattr('uri'):
uri = node['uri']
else:
continue
o = urlparse.urlparse(uri)
if o.scheme not in ALLOWED_SCHEMES:
raise TransformError('link scheme not allowed')
# now turn the transformed document into HTML
reader = readers.doctree.Reader(parser_name='null')
pub = Publisher(reader, source=io.DocTreeInput(document),
destination_class=io.StringOutput)
pub.set_writer('html')
pub.process_programmatic_settings(None, settings_overrides, None)
pub.set_destination(None, None)
pub.publish()
parts = pub.writer.parts
except:
pass
sys.stderr = old_stderr
# original text if publishing errors occur
if parts is None or len(s.getvalue()) > 0:
output = "".join('<PRE>\n' + cgi.escape(source) + '</PRE>')
else:
output = parts['body']
if output_encoding != 'unicode':
output = output.encode(output_encoding)
return output
def extractPackageReadme(content, filename, filetype):
'''Extract the README from a file and attempt to turn it into HTML.
Return the source text and html version or emty strings in either case if
extraction fails.
'''
text = html = ''
if filename.endswith('.zip') or filename.endswith('.egg'):
try:
t = StringIO.StringIO(content)
t.filename = filename
zip = zipfile.ZipFile(t)
l = zip.namelist()
except zipfile.error:
return '', ''
for entry in l:
parts = entry.split('/')
if len(parts) != 2:
continue
filename = parts[-1]
if filename.count('.') > 1:
continue
if filename.count('.') == 1:
name, ext = filename.split('.')
else:
# just use the filename and assume a readme is plain text
name = filename
ext = 'txt'
if name.upper() != 'README':
continue
if ext not in ('txt', 'rst', 'md'):
return
# grab the content and parse if it's something we might understand,
# based on the file extension
text = zip.open(entry).read()
# we can only deal with UTF-8 so make it UTF-8 safe
text = text.decode('utf-8', 'replace').encode('utf-8')
if text:
return text, processDescription(text)
elif (filename.endswith('.tar.gz') or filename.endswith('.tgz') or
filename.endswith('.tar.bz2') or filename.endswith('.tbz2')):
# open the tar file with the appropriate compression
ext = filename.split('.')[-1]
if ext[-2:] == 'gz':
file = StringIO.StringIO(content)
file = gzip.GzipFile(filename, fileobj=file)
else:
file = StringIO.StringIO(bz2.decompress(content))
try:
tar = tarfile.TarFile(filename, 'r', file)
l = tar.getmembers()
except tarfile.TarError:
return '', ''
for entry in l:
parts = entry.name.split('/')
if len(parts) != 2:
continue
filename = parts[-1]
if filename.count('.') > 1:
continue
if filename.count('.') == 1:
name, ext = filename.split('.')
else:
# just use the filename and assume a readme is plain text
name = filename
ext = 'txt'
if name.upper() != 'README':
continue
if ext not in ('txt', 'rst', 'md'):
continue
# grab the content and parse if it's something we might understand,
# based on the file extension
try:
text = tar.extractfile(entry).read()
# we can only deal with UTF-8 so make it UTF-8 safe
text = text.decode('utf-8', 'replace').encode('utf-8')
except:
# issue 3521663: extraction may fail if entry is a symlink to
# a non-existing file
continue
if text:
return text, processDescription(text)
return text, html
if __name__ == '__main__':
fname ='../parse/dist/parse-1.4.1.tar.gz'
# fname ='../parse/dist/parse-1.4.1.zip'
# fname ='../parse/dist/parse-1.4.1.tar.bz2'
text, html = extractPackageReadme(open(fname).read(), fname, 'sdist')
|
