python-botocore/botocore/docs/bcdoc/docstringparser.py
2015-11-24 20:34:53 +09:00

52 lines
1.7 KiB
Python

# Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from botocore.compat import six
from six.moves import html_parser
class DocStringParser(html_parser.HTMLParser):
"""
A simple HTML parser. Focused on converting the subset of HTML
that appears in the documentation strings of the JSON models into
simple ReST format.
"""
def __init__(self, doc):
html_parser.HTMLParser.__init__(self)
self.doc = doc
self.unhandled_tags = []
def handle_starttag(self, tag, attrs):
handler_name = 'start_%s' % tag
if hasattr(self.doc.style, handler_name):
getattr(self.doc.style, handler_name)(attrs)
else:
self.unhandled_tags.append(tag)
def handle_endtag(self, tag):
handler_name = 'end_%s' % tag
if hasattr(self.doc.style, handler_name):
getattr(self.doc.style, handler_name)()
def handle_data(self, data):
if data.isspace():
data = ' '
else:
end_space = data[-1].isspace()
words = data.split()
words = self.doc.translate_words(words)
data = ' '.join(words)
if end_space:
data += ' '
self.doc.handle_data(data)