114 lines
4.0 KiB
Python
114 lines
4.0 KiB
Python
|
# Author: David Goodger
|
||
|
|
# Contact: goodger@users.sourceforge.net
|
||
|
|
# Revision: $Revision$
|
||
|
|
# Date: $Date$
|
||
|
|
# Copyright: This module has been placed in the public domain.
|
||
|
|
|
||
|
|
"""
|
||
|
|
PEP HTML Writer.
|
||
|
|
"""
|
||
|
|
|
||
|
|
__docformat__ = 'reStructuredText'
|
||
|
|
|
||
|
|
|
||
|
|
import sys
|
||
|
|
import docutils
|
||
|
|
from docutils import nodes, optik, utils
|
||
|
|
from docutils.writers import html4css1
|
||
|
|
|
||
|
|
|
||
|
|
class Writer(html4css1.Writer):
|
||
|
|
|
||
|
|
settings_spec = html4css1.Writer.settings_spec + (
|
||
|
|
'PEP/HTML-Specific Options',
|
||
|
|
'The HTML --footnote-references option is set to "brackets" by '
|
||
|
|
'default.',
|
||
|
|
(('Specify a PEP stylesheet URL, used verbatim. Default is '
|
||
|
|
'--stylesheet\'s value. If given, --pep-stylesheet overrides '
|
||
|
|
'--stylesheet.',
|
||
|
|
['--pep-stylesheet'],
|
||
|
|
{'metavar': '<URL>'}),
|
||
|
|
('Specify a PEP stylesheet file, relative to the current working '
|
||
|
|
'directory. The path is adjusted relative to the output HTML '
|
||
|
|
'file. Overrides --pep-stylesheet and --stylesheet-path.',
|
||
|
|
['--pep-stylesheet-path'],
|
||
|
|
{'metavar': '<path>'}),
|
||
|
|
('Specify a template file. Default is "pep-html-template".',
|
||
|
|
['--pep-template'],
|
||
|
|
{'default': 'pep-html-template', 'metavar': '<file>'}),
|
||
|
|
('Python\'s home URL. Default is ".." (parent directory).',
|
||
|
|
['--python-home'],
|
||
|
|
{'default': '..', 'metavar': '<URL>'}),
|
||
|
|
('Home URL prefix for PEPs. Default is "." (current directory).',
|
||
|
|
['--pep-home'],
|
||
|
|
{'default': '.', 'metavar': '<URL>'}),
|
||
|
|
# Workaround for SourceForge's broken Python
|
||
|
|
# (``import random`` causes a segfault).
|
||
|
|
(optik.SUPPRESS_HELP,
|
||
|
|
['--no-random'], {'action': 'store_true'}),))
|
||
|
|
|
||
|
|
settings_default_overrides = {'footnote_references': 'brackets'}
|
||
|
|
|
||
|
|
relative_path_settings = ('pep_stylesheet_path', 'pep_template')
|
||
|
|
|
||
|
|
def __init__(self):
|
||
|
|
html4css1.Writer.__init__(self)
|
||
|
|
self.translator_class = HTMLTranslator
|
||
|
|
|
||
|
|
def translate(self):
|
||
|
|
html4css1.Writer.translate(self)
|
||
|
|
settings = self.document.settings
|
||
|
|
template = open(settings.pep_template).read()
|
||
|
|
# Substitutions dict for template:
|
||
|
|
subs = {}
|
||
|
|
subs['encoding'] = settings.output_encoding
|
||
|
|
subs['version'] = docutils.__version__
|
||
|
|
subs['stylesheet'] = ''.join(self.stylesheet)
|
||
|
|
pyhome = settings.python_home
|
||
|
|
subs['pyhome'] = pyhome
|
||
|
|
subs['pephome'] = settings.pep_home
|
||
|
|
if pyhome == '..':
|
||
|
|
subs['pepindex'] = '.'
|
||
|
|
else:
|
||
|
|
subs['pepindex'] = pyhome + '/peps/'
|
||
|
|
index = self.document.first_child_matching_class(nodes.field_list)
|
||
|
|
header = self.document[index]
|
||
|
|
pepnum = header[0][1].astext()
|
||
|
|
subs['pep'] = pepnum
|
||
|
|
if settings.no_random:
|
||
|
|
subs['banner'] = 0
|
||
|
|
else:
|
||
|
|
import random
|
||
|
|
subs['banner'] = random.randrange(64)
|
||
|
|
try:
|
||
|
|
subs['pepnum'] = '%04i' % int(pepnum)
|
||
|
|
except:
|
||
|
|
subs['pepnum'] = pepnum
|
||
|
|
subs['title'] = header[1][1].astext()
|
||
|
|
subs['body'] = ''.join(
|
||
|
|
self.body_pre_docinfo + self.docinfo + self.body)
|
||
|
|
subs['body_suffix'] = ''.join(self.body_suffix)
|
||
|
|
self.output = template % subs
|
||
|
|
|
||
|
|
|
||
|
|
class HTMLTranslator(html4css1.HTMLTranslator):
|
||
|
|
|
||
|
|
def get_stylesheet_reference(self, relative_to=None):
|
||
|
|
settings = self.settings
|
||
|
|
if relative_to == None:
|
||
|
|
relative_to = settings._destination
|
||
|
|
if settings.pep_stylesheet_path:
|
||
|
|
return utils.relative_path(relative_to,
|
||
|
|
settings.pep_stylesheet_path)
|
||
|
|
elif settings.pep_stylesheet:
|
||
|
|
return settings.pep_stylesheet
|
||
|
|
elif settings._stylesheet_path:
|
||
|
|
return utils.relative_path(relative_to, settings.stylesheet_path)
|
||
|
|
else:
|
||
|
|
return settings.stylesheet
|
||
|
|
|
||
|
|
def depart_field_list(self, node):
|
||
|
|
html4css1.HTMLTranslator.depart_field_list(self, node)
|
||
|
|
if node.get('class') == 'rfc2822':
|
||
|
|
self.body.append('<hr />\n')
|