'.join(items)
+ values = dict(title = title,
+ items = items,
+ css_class=css_class,
+ )
+ template = (' {title}'
+ ' '
+ ' '
+ ' '
+ )
+ return template.format(**values)
- def html_navbar():
- version = "%s [%s, %s]" % (platform.python_version(),
- platform.python_build()[0],
- platform.python_compiler())
- return """
-
- Python %s
%s
-
-
-
- """ % (version, platform.platform(terse=True))
+ def index_columns(self, title, items, css_class):
+ """Create a index section with columns."""
+ section = html._index_section(title, items,
+ css_class="index-columns")
+ template = (''
+ ' {section}'
+ '
'
+ )
+ return template.format(css_class=css_class, section=section)
- def html_index():
- """Module Index page."""
+ def index_lines(self, title, items, css_class):
+ """Create an index section with line."""
+ section = html._index_section(title, items,
+ css_class="index-lines")
+ template = (''
+ ' {section}'
+ '
'
+ )
+ return template.format(css_class=css_class, section=section)
- def bltinlink(name):
- return '%s' % (name, name)
+ html = _HTMLDoc()
- heading = html.heading(
- 'Index of Modules',
- '#ffffff', '#7799ee')
- names = [name for name in sys.builtin_module_names
- if name != '__main__']
- contents = html.multicolumn(names, bltinlink)
- contents = [heading, '' + html.bigsection(
- 'Built-in Modules', '#ffffff', '#ee77aa', contents)]
+ def html_header():
+ values = dict(version=platform.python_version(),
+ build=platform.python_build()[0],
+ compiler=platform.python_compiler(),
+ platform=platform.platform(terse=True),
+ )
+ template = \
+"""
+
+"""
+ return template.format(**values)
- seen = {}
+ def html_modules():
+ """Module Index page."""
+ link_list = ['%s' % (name, name)
+ for name in sys.builtin_module_names
+ if name != '__main__']
+ contents = [html.index_columns('Built-in modules', link_list,
+ css_class='section modules')]
+ shadowed = set()
for dir in sys.path:
- contents.append(html.index(dir, seen))
+ modules = []
+ for importer, name, ispkg in pkgutil.iter_modules([dir]):
+ if name not in shadowed:
+ modules.append((name, ispkg))
+ shadowed.add(name)
+ modules.sort()
+ links = []
+ for name, ispkg in modules:
+ if ispkg:
+ template = (''
+ '{name} (package)')
+ else:
+ template = (''
+ '{name}')
+ link = template.format(name=name)
+ links.append(link)
+ contents.append(html.index_columns(dir,
+ links, css_class='section modules'))
+ content =''.join(contents)
+ template = (''
+ '
Index of Modules
'
+ ' {content}'
+ ''
+ ''
+ )
+ return 'Index of Modules', template.format(content=content)
- contents.append(
- 'pydoc by Ka-Ping Yee'
- '<ping@lfw.org>')
- return 'Index of Modules', ''.join(contents)
-
def html_search(key):
"""Search results page."""
# scan for modules
search_result = []
-
def callback(path, modname, desc):
if modname[-9:] == '.__init__':
modname = modname[:-9] + ' (package)'
- search_result.append((modname, desc and '- ' + desc))
-
+ search_result.append((modname, desc and ' - ' + desc))
with warnings.catch_warnings():
warnings.filterwarnings('ignore') # ignore problems during import
ModuleScanner().run(callback, key)
+ link_list = ['%s%s' % (name, name, desc)
+ for name, desc in search_result]
+ content = html.index_lines('key = %s' % key, link_list,
+ css_class='section modules')
+ template = ('
'
+ '
Search Results
'
+ ' {content}'
+ ''
+ )
+ return 'Search Results', template.format(content=content)
- # format page
- def bltinlink(name):
- return '%s' % (name, name)
-
- results = []
- heading = html.heading(
- 'Search Results',
- '#ffffff', '#7799ee')
- for name, desc in search_result:
- results.append(bltinlink(name) + desc)
- contents = heading + html.bigsection(
- 'key = %s' % key, '#ffffff', '#ee77aa', '
'.join(results))
- return 'Search Results', contents
-
def html_getfile(path):
"""Get and display a source file listing safely."""
- path = path.replace('%20', ' ')
with open(path, 'r') as fp:
lines = html.escape(fp.read())
- body = '%s
' % lines
- heading = html.heading(
- 'File Listing',
- '#ffffff', '#7799ee')
- contents = heading + html.bigsection(
- 'File: %s' % path, '#ffffff', '#ee77aa', body)
- return 'getfile %s' % path, contents
+ title = 'getfile %s' % path.replace('%20', ' ')
+ template = (''
+ '
File Listing
'
+ '
'
+ ' - File: {path}
'
+ ' {lines}
'
+ '
'
+ '
'
+ '
Index
'
+ ' {content}'
+ ''
+ )
+ return 'Topics', template.format(content=content)
- def bltinlink(name):
- return '%s' % (name, name)
-
- heading = html.heading(
- 'INDEX',
- '#ffffff', '#7799ee')
- names = sorted(Helper.topics.keys())
-
- contents = html.multicolumn(names, bltinlink)
- contents = heading + html.bigsection(
- 'Topics', '#ffffff', '#ee77aa', contents)
- return 'Topics', contents
-
def html_keywords():
"""Index of keywords."""
- heading = html.heading(
- 'INDEX',
- '#ffffff', '#7799ee')
- names = sorted(Helper.keywords.keys())
+ link_list = ['%s' % (name, name)
+ for name in sorted(Helper.keywords.keys())]
+ content = html.index_columns('Keywords', link_list,
+ css_class="section topics")
+ template = (''
+ '
Index
'
+ ' {content}'
+ ''
+ )
+ return 'Keywords', template.format(content=content)
- def bltinlink(name):
- return '%s' % (name, name)
- contents = html.multicolumn(names, bltinlink)
- contents = heading + html.bigsection(
- 'Keywords', '#ffffff', '#ee77aa', contents)
- return 'Keywords', contents
-
def html_topicpage(topic):
"""Topic or keyword help page."""
buf = io.StringIO()
htmlhelp = Helper(buf, buf)
contents, xrefs = htmlhelp._gettopic(topic)
if topic in htmlhelp.keywords:
- title = 'KEYWORD'
+ title = 'Keyword'
else:
- title = 'TOPIC'
- heading = html.heading(
- '%s' % title,
- '#ffffff', '#7799ee')
- contents = '%s
' % contents
- contents = html.bigsection(topic , '#ffffff','#ee77aa', contents)
- xrefs = sorted(xrefs.split())
+ title = 'Topic'
+ text = html.markup(contents)
+ link_list = ['%s' % (name, name)
+ for name in sorted(xrefs.split())]
+ xrefs = html.index_columns('Related help Topics', link_list,
+ css_class="section topics")
+ values = dict(
+ title=title,
+ topic=topic,
+ text=text,
+ xrefs=xrefs,
+ )
+ template = (''
+ '
{title}
'
+ '
'
+ ' - {topic}
'
+ ' {text}
'
+ ' {xrefs}'
+ '
'
+ '
Error
'
+ '
'
+ ' - {title}
'
+ ' - '
+ '
{exc}'
+ '
{err}'
+ '
'
+ '
'
+ '
%s
' %
+ html.document(obj, url))
+ except Exception as exc:
+ title, content = html_error(exc, url)
+ return html.page(title, content)
if url.startswith('/'):
url = url[1:]
if content_type == 'text/css':
path_here = os.path.dirname(os.path.realpath(__file__))
- try:
- with open(os.path.join(path_here, url)) as fp:
- return ''.join(fp.readlines())
- except IOError:
- return 'Error: can not open css file %r' % url
+ with open(os.path.join(path_here, url)) as fp:
+ return ''.join(fp.readlines())
elif content_type == 'text/html':
return get_html_page(url)
- return 'Error: unknown content type %r' % content_type
+ raise ValueError('unknown content type: (%r, %r)' % (content_type, url))
def browse(port=0, *, open_browser=True):
@@ -2720,6 +2785,8 @@
print('Server ready at', serverthread.url)
print(server_help_msg)
while serverthread.serving:
+ if serverthread.error:
+ print(serverthread.error)
cmd = input('server> ')
cmd = cmd.lower()
if cmd == 'q':
Index: Lib/test/test_pydoc.py
===================================================================
--- Lib/test/test_pydoc.py (revision 87586)
+++ Lib/test/test_pydoc.py (working copy)
@@ -419,30 +419,27 @@
"""Tests for pydoc._url_handler"""
def test_content_type_err(self):
- err = 'Error: unknown content type '
f = pydoc._url_handler
- result = f("", "")
- self.assertEqual(result, err + "''")
- result = f("", "foobar")
- self.assertEqual(result, err + "'foobar'")
+ self.assertRaises(ValueError, f, "", "")
+ self.assertRaises(ValueError, f, "", "foobar")
def test_url_requests(self):
# Test for the correct title in the html pages returned.
# This tests the different parts of the URL handler without
# getting too picky about the exact html.
requests = [
- ("", "Python: Index of Modules"),
- ("get?key=", "Python: Index of Modules"),
- ("index", "Python: Index of Modules"),
- ("topics", "Python: Topics"),
- ("keywords", "Python: Keywords"),
- ("pydoc", "Python: module pydoc"),
- ("get?key=pydoc", "Python: module pydoc"),
- ("search?key=pydoc", "Python: Search Results"),
- ("def", "Python: KEYWORD def"),
- ("STRINGS", "Python: TOPIC STRINGS"),
- ("foobar", "Python: Error"),
- ("getfile?key=foobar", "Python: Read Error"),
+ ("", "PyDoc: Index of Modules"),
+ ("get?key=", "PyDoc: Index of Modules"),
+ ("index", "PyDoc: Index of Modules"),
+ ("topics", "PyDoc: Topics"),
+ ("keywords", "PyDoc: Keywords"),
+ ("pydoc", "PyDoc: module pydoc"),
+ ("get?key=pydoc", "PyDoc: module pydoc"),
+ ("search?key=pydoc", "PyDoc: Search Results"),
+ ("def", "PyDoc: Keyword def"),
+ ("STRINGS", "PyDoc: Topic STRINGS"),
+ ("foobar", "PyDoc: Error - foobar"),
+ ("getfile?key=foobar", "PyDoc: Error - getfile?key=foobar"),
]
for url, title in requests:
@@ -451,7 +448,7 @@
self.assertEqual(result, title)
path = string.__file__
- title = "Python: getfile " + path
+ title = "PyDoc: getfile " + path
url = "getfile?key=" + path
text = pydoc._url_handler(url, "text/html")
result = get_html_title(text)