mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge pull request #5617 from jdufresne/super
Use super() to call parent class's method
This commit is contained in:
commit
e89b1d342e
@ -150,7 +150,7 @@ class FootnoteCollector(nodes.NodeVisitor):
|
|||||||
self.auto_footnotes = [] # type: List[nodes.footnote]
|
self.auto_footnotes = [] # type: List[nodes.footnote]
|
||||||
self.used_footnote_numbers = set() # type: Set[unicode]
|
self.used_footnote_numbers = set() # type: Set[unicode]
|
||||||
self.footnote_refs = [] # type: List[nodes.footnote_reference]
|
self.footnote_refs = [] # type: List[nodes.footnote_reference]
|
||||||
nodes.NodeVisitor.__init__(self, document)
|
super(FootnoteCollector, self).__init__(document)
|
||||||
|
|
||||||
def unknown_visit(self, node):
|
def unknown_visit(self, node):
|
||||||
# type: (nodes.Node) -> None
|
# type: (nodes.Node) -> None
|
||||||
@ -359,7 +359,7 @@ class LaTeXFootnoteVisitor(nodes.NodeVisitor):
|
|||||||
self.pendings = [] # type: List[nodes.Node]
|
self.pendings = [] # type: List[nodes.Node]
|
||||||
self.table_footnotes = [] # type: List[nodes.Node]
|
self.table_footnotes = [] # type: List[nodes.Node]
|
||||||
self.restricted = None # type: nodes.Node
|
self.restricted = None # type: nodes.Node
|
||||||
nodes.NodeVisitor.__init__(self, document)
|
super(LaTeXFootnoteVisitor, self).__init__(document)
|
||||||
|
|
||||||
def unknown_visit(self, node):
|
def unknown_visit(self, node):
|
||||||
# type: (nodes.Node) -> None
|
# type: (nodes.Node) -> None
|
||||||
|
@ -52,7 +52,7 @@ class AnchorCheckParser(html_parser.HTMLParser):
|
|||||||
|
|
||||||
def __init__(self, search_anchor):
|
def __init__(self, search_anchor):
|
||||||
# type: (unicode) -> None
|
# type: (unicode) -> None
|
||||||
html_parser.HTMLParser.__init__(self)
|
super(AnchorCheckParser, self).__init__()
|
||||||
|
|
||||||
self.search_anchor = search_anchor
|
self.search_anchor = search_anchor
|
||||||
self.found = False
|
self.found = False
|
||||||
|
@ -54,7 +54,7 @@ class ExtensionError(SphinxError):
|
|||||||
|
|
||||||
def __init__(self, message, orig_exc=None):
|
def __init__(self, message, orig_exc=None):
|
||||||
# type: (unicode, Exception) -> None
|
# type: (unicode, Exception) -> None
|
||||||
SphinxError.__init__(self, message)
|
super(ExtensionError, self).__init__(message)
|
||||||
self.message = message
|
self.message = message
|
||||||
self.orig_exc = orig_exc
|
self.orig_exc = orig_exc
|
||||||
|
|
||||||
@ -67,7 +67,7 @@ class ExtensionError(SphinxError):
|
|||||||
|
|
||||||
def __str__(self):
|
def __str__(self):
|
||||||
# type: () -> str
|
# type: () -> str
|
||||||
parent_str = SphinxError.__str__(self)
|
parent_str = super(ExtensionError, self).__str__()
|
||||||
if self.orig_exc:
|
if self.orig_exc:
|
||||||
return '%s (exception: %s)' % (parent_str, self.orig_exc)
|
return '%s (exception: %s)' % (parent_str, self.orig_exc)
|
||||||
return parent_str
|
return parent_str
|
||||||
|
@ -49,7 +49,7 @@ class MathExtError(SphinxError):
|
|||||||
msg += '\n[stderr]\n' + stderr.decode(sys_encoding, 'replace')
|
msg += '\n[stderr]\n' + stderr.decode(sys_encoding, 'replace')
|
||||||
if stdout:
|
if stdout:
|
||||||
msg += '\n[stdout]\n' + stdout.decode(sys_encoding, 'replace')
|
msg += '\n[stdout]\n' + stdout.decode(sys_encoding, 'replace')
|
||||||
SphinxError.__init__(self, msg)
|
super(MathExtError, self).__init__(msg)
|
||||||
|
|
||||||
|
|
||||||
class InvokeError(SphinxError):
|
class InvokeError(SphinxError):
|
||||||
|
@ -66,7 +66,7 @@ class SphinxBaseReader(standalone.Reader):
|
|||||||
def __init__(self, app, *args, **kwargs):
|
def __init__(self, app, *args, **kwargs):
|
||||||
# type: (Sphinx, Any, Any) -> None
|
# type: (Sphinx, Any, Any) -> None
|
||||||
self.env = app.env
|
self.env = app.env
|
||||||
standalone.Reader.__init__(self, *args, **kwargs)
|
super(SphinxBaseReader, self).__init__(*args, **kwargs)
|
||||||
|
|
||||||
def get_transforms(self):
|
def get_transforms(self):
|
||||||
# type: () -> List[Type[Transform]]
|
# type: () -> List[Type[Transform]]
|
||||||
@ -106,7 +106,7 @@ class SphinxStandaloneReader(SphinxBaseReader):
|
|||||||
def __init__(self, app, *args, **kwargs):
|
def __init__(self, app, *args, **kwargs):
|
||||||
# type: (Sphinx, Any, Any) -> None
|
# type: (Sphinx, Any, Any) -> None
|
||||||
self.transforms = self.transforms + app.registry.get_transforms()
|
self.transforms = self.transforms + app.registry.get_transforms()
|
||||||
SphinxBaseReader.__init__(self, app, *args, **kwargs)
|
super(SphinxStandaloneReader, self).__init__(app, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
class SphinxI18nReader(SphinxBaseReader):
|
class SphinxI18nReader(SphinxBaseReader):
|
||||||
@ -171,7 +171,7 @@ class SphinxBaseFileInput(FileInput):
|
|||||||
codecs.register_error('sphinx', self.warn_and_replace) # type: ignore
|
codecs.register_error('sphinx', self.warn_and_replace) # type: ignore
|
||||||
|
|
||||||
kwds['error_handler'] = 'sphinx' # py3: handle error on open.
|
kwds['error_handler'] = 'sphinx' # py3: handle error on open.
|
||||||
FileInput.__init__(self, *args, **kwds)
|
super(SphinxBaseFileInput, self).__init__(*args, **kwds)
|
||||||
|
|
||||||
def decode(self, data):
|
def decode(self, data):
|
||||||
# type: (Union[unicode, bytes]) -> unicode
|
# type: (Union[unicode, bytes]) -> unicode
|
||||||
|
@ -195,7 +195,7 @@ class WordCollector(NodeVisitor):
|
|||||||
|
|
||||||
def __init__(self, document, lang):
|
def __init__(self, document, lang):
|
||||||
# type: (nodes.Node, SearchLanguage) -> None
|
# type: (nodes.Node, SearchLanguage) -> None
|
||||||
NodeVisitor.__init__(self, document)
|
super(WordCollector, self).__init__(document)
|
||||||
self.found_words = [] # type: List[unicode]
|
self.found_words = [] # type: List[unicode]
|
||||||
self.found_title_words = [] # type: List[unicode]
|
self.found_title_words = [] # type: List[unicode]
|
||||||
self.lang = lang
|
self.lang = lang
|
||||||
|
@ -137,9 +137,9 @@ class SphinxTestApp(application.Sphinx):
|
|||||||
if v.startswith('visit_'))
|
if v.startswith('visit_'))
|
||||||
|
|
||||||
try:
|
try:
|
||||||
application.Sphinx.__init__(self, srcdir, confdir, outdir, doctreedir, # type: ignore # NOQA
|
super(SphinxTestApp, self).__init__(srcdir, confdir, outdir, doctreedir, # type: ignore # NOQA
|
||||||
buildername, confoverrides, status, warning,
|
buildername, confoverrides, status, warning,
|
||||||
freshenv, warningiserror, tags)
|
freshenv, warningiserror, tags)
|
||||||
except Exception:
|
except Exception:
|
||||||
self.cleanup()
|
self.cleanup()
|
||||||
raise
|
raise
|
||||||
|
@ -54,7 +54,7 @@ class HighlightLanguageVisitor(nodes.NodeVisitor):
|
|||||||
# type: (nodes.document, unicode) -> None
|
# type: (nodes.document, unicode) -> None
|
||||||
self.default_setting = HighlightSetting(default_language, sys.maxsize)
|
self.default_setting = HighlightSetting(default_language, sys.maxsize)
|
||||||
self.settings = [] # type: List[HighlightSetting]
|
self.settings = [] # type: List[HighlightSetting]
|
||||||
nodes.NodeVisitor.__init__(self, document)
|
super(HighlightLanguageVisitor, self).__init__(document)
|
||||||
|
|
||||||
def unknown_visit(self, node):
|
def unknown_visit(self, node):
|
||||||
# type: (nodes.Node) -> None
|
# type: (nodes.Node) -> None
|
||||||
|
@ -203,7 +203,7 @@ class ImageConverter(BaseImageConverter):
|
|||||||
self.available = None # type: bool
|
self.available = None # type: bool
|
||||||
# the converter is available or not.
|
# the converter is available or not.
|
||||||
# Will be checked at first conversion
|
# Will be checked at first conversion
|
||||||
BaseImageConverter.__init__(self, *args, **kwargs) # type: ignore
|
super(ImageConverter, self).__init__(*args, **kwargs)
|
||||||
|
|
||||||
def match(self, node):
|
def match(self, node):
|
||||||
# type: (nodes.Node) -> bool
|
# type: (nodes.Node) -> bool
|
||||||
|
@ -138,7 +138,7 @@ class GroupedField(Field):
|
|||||||
def __init__(self, name, names=(), label=None, rolename=None,
|
def __init__(self, name, names=(), label=None, rolename=None,
|
||||||
can_collapse=False):
|
can_collapse=False):
|
||||||
# type: (unicode, Tuple[unicode, ...], unicode, unicode, bool) -> None
|
# type: (unicode, Tuple[unicode, ...], unicode, unicode, bool) -> None
|
||||||
Field.__init__(self, name, names, label, True, rolename)
|
super(GroupedField, self).__init__(name, names, label, True, rolename)
|
||||||
self.can_collapse = can_collapse
|
self.can_collapse = can_collapse
|
||||||
|
|
||||||
def make_field(self,
|
def make_field(self,
|
||||||
@ -190,7 +190,7 @@ class TypedField(GroupedField):
|
|||||||
def __init__(self, name, names=(), typenames=(), label=None,
|
def __init__(self, name, names=(), typenames=(), label=None,
|
||||||
rolename=None, typerolename=None, can_collapse=False):
|
rolename=None, typerolename=None, can_collapse=False):
|
||||||
# type: (unicode, Tuple[unicode, ...], Tuple[unicode, ...], unicode, unicode, unicode, bool) -> None # NOQA
|
# type: (unicode, Tuple[unicode, ...], Tuple[unicode, ...], unicode, unicode, unicode, bool) -> None # NOQA
|
||||||
GroupedField.__init__(self, name, names, label, rolename, can_collapse)
|
super(TypedField, self).__init__(name, names, label, rolename, can_collapse)
|
||||||
self.typenames = typenames
|
self.typenames = typenames
|
||||||
self.typerolename = typerolename
|
self.typerolename = typerolename
|
||||||
|
|
||||||
|
@ -247,8 +247,8 @@ class LoggingReporter(Reporter):
|
|||||||
error_handler='backslashreplace'):
|
error_handler='backslashreplace'):
|
||||||
# type: (unicode, int, int, bool, unicode) -> None
|
# type: (unicode, int, int, bool, unicode) -> None
|
||||||
stream = WarningStream()
|
stream = WarningStream()
|
||||||
Reporter.__init__(self, source, report_level, halt_level,
|
super(LoggingReporter, self).__init__(source, report_level, halt_level,
|
||||||
stream, debug, error_handler=error_handler)
|
stream, debug, error_handler=error_handler)
|
||||||
|
|
||||||
|
|
||||||
class NullReporter(Reporter):
|
class NullReporter(Reporter):
|
||||||
@ -256,7 +256,7 @@ class NullReporter(Reporter):
|
|||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
# type: () -> None
|
# type: () -> None
|
||||||
Reporter.__init__(self, '', 999, 4)
|
super(NullReporter, self).__init__('', 999, 4)
|
||||||
|
|
||||||
|
|
||||||
def is_html5_writer_available():
|
def is_html5_writer_available():
|
||||||
@ -307,7 +307,7 @@ class SphinxFileOutput(FileOutput):
|
|||||||
def __init__(self, **kwargs):
|
def __init__(self, **kwargs):
|
||||||
# type: (Any) -> None
|
# type: (Any) -> None
|
||||||
self.overwrite_if_changed = kwargs.pop('overwrite_if_changed', False)
|
self.overwrite_if_changed = kwargs.pop('overwrite_if_changed', False)
|
||||||
FileOutput.__init__(self, **kwargs)
|
super(SphinxFileOutput, self).__init__(**kwargs)
|
||||||
|
|
||||||
def write(self, data):
|
def write(self, data):
|
||||||
# type: (unicode) -> unicode
|
# type: (unicode) -> unicode
|
||||||
|
@ -47,7 +47,7 @@ class HTMLWriter(Writer):
|
|||||||
|
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (StandaloneHTMLBuilder) -> None
|
# type: (StandaloneHTMLBuilder) -> None
|
||||||
Writer.__init__(self)
|
super(HTMLWriter, self).__init__()
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
def translate(self):
|
def translate(self):
|
||||||
@ -73,7 +73,7 @@ class HTMLTranslator(BaseTranslator):
|
|||||||
|
|
||||||
def __init__(self, builder, *args, **kwds):
|
def __init__(self, builder, *args, **kwds):
|
||||||
# type: (StandaloneHTMLBuilder, Any, Any) -> None
|
# type: (StandaloneHTMLBuilder, Any, Any) -> None
|
||||||
BaseTranslator.__init__(self, *args, **kwds)
|
super(HTMLTranslator, self).__init__(*args, **kwds)
|
||||||
self.highlighter = builder.highlighter
|
self.highlighter = builder.highlighter
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
self.docnames = [builder.current_docname] # for singlehtml builder
|
self.docnames = [builder.current_docname] # for singlehtml builder
|
||||||
|
@ -43,7 +43,7 @@ class HTML5Translator(BaseTranslator):
|
|||||||
|
|
||||||
def __init__(self, builder, *args, **kwds):
|
def __init__(self, builder, *args, **kwds):
|
||||||
# type: (StandaloneHTMLBuilder, Any, Any) -> None
|
# type: (StandaloneHTMLBuilder, Any, Any) -> None
|
||||||
BaseTranslator.__init__(self, *args, **kwds)
|
super(HTML5Translator, self).__init__(*args, **kwds)
|
||||||
self.highlighter = builder.highlighter
|
self.highlighter = builder.highlighter
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
self.docnames = [builder.current_docname] # for singlehtml builder
|
self.docnames = [builder.current_docname] # for singlehtml builder
|
||||||
|
@ -193,7 +193,7 @@ class LaTeXWriter(writers.Writer):
|
|||||||
|
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (Builder) -> None
|
# type: (Builder) -> None
|
||||||
writers.Writer.__init__(self)
|
super(LaTeXWriter, self).__init__()
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
def translate(self):
|
def translate(self):
|
||||||
@ -451,7 +451,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
|
|||||||
|
|
||||||
def __init__(self, document, builder):
|
def __init__(self, document, builder):
|
||||||
# type: (nodes.Node, Builder) -> None
|
# type: (nodes.Node, Builder) -> None
|
||||||
nodes.NodeVisitor.__init__(self, document)
|
super(LaTeXTranslator, self).__init__(document)
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
self.body = [] # type: List[unicode]
|
self.body = [] # type: List[unicode]
|
||||||
|
|
||||||
|
@ -32,7 +32,7 @@ logger = logging.getLogger(__name__)
|
|||||||
class ManualPageWriter(Writer):
|
class ManualPageWriter(Writer):
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (Builder) -> None
|
# type: (Builder) -> None
|
||||||
Writer.__init__(self)
|
super(ManualPageWriter, self).__init__()
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
def translate(self):
|
def translate(self):
|
||||||
@ -82,7 +82,7 @@ class ManualPageTranslator(BaseTranslator):
|
|||||||
|
|
||||||
def __init__(self, builder, *args, **kwds):
|
def __init__(self, builder, *args, **kwds):
|
||||||
# type: (Builder, Any, Any) -> None
|
# type: (Builder, Any, Any) -> None
|
||||||
BaseTranslator.__init__(self, *args, **kwds)
|
super(ManualPageTranslator, self).__init__(*args, **kwds)
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
self.in_productionlist = 0
|
self.in_productionlist = 0
|
||||||
|
@ -128,7 +128,7 @@ class TexinfoWriter(writers.Writer):
|
|||||||
|
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (TexinfoBuilder) -> None
|
# type: (TexinfoBuilder) -> None
|
||||||
writers.Writer.__init__(self)
|
super(TexinfoWriter, self).__init__()
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
def translate(self):
|
def translate(self):
|
||||||
@ -161,7 +161,7 @@ class TexinfoTranslator(nodes.NodeVisitor):
|
|||||||
|
|
||||||
def __init__(self, document, builder):
|
def __init__(self, document, builder):
|
||||||
# type: (nodes.Node, TexinfoBuilder) -> None
|
# type: (nodes.Node, TexinfoBuilder) -> None
|
||||||
nodes.NodeVisitor.__init__(self, document)
|
super(TexinfoTranslator, self).__init__(document)
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
self.init_settings()
|
self.init_settings()
|
||||||
|
|
||||||
|
@ -382,7 +382,7 @@ class TextWriter(writers.Writer):
|
|||||||
|
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (TextBuilder) -> None
|
# type: (TextBuilder) -> None
|
||||||
writers.Writer.__init__(self)
|
super(TextWriter, self).__init__()
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
def translate(self):
|
def translate(self):
|
||||||
@ -397,7 +397,7 @@ class TextTranslator(nodes.NodeVisitor):
|
|||||||
|
|
||||||
def __init__(self, document, builder):
|
def __init__(self, document, builder):
|
||||||
# type: (nodes.Node, TextBuilder) -> None
|
# type: (nodes.Node, TextBuilder) -> None
|
||||||
nodes.NodeVisitor.__init__(self, document)
|
super(TextTranslator, self).__init__(document)
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
newlines = builder.config.text_newlines
|
newlines = builder.config.text_newlines
|
||||||
|
@ -22,7 +22,7 @@ class XMLWriter(BaseXMLWriter):
|
|||||||
|
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (Builder) -> None
|
# type: (Builder) -> None
|
||||||
BaseXMLWriter.__init__(self)
|
super(XMLWriter, self).__init__()
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
self.translator_class = self.builder.get_translator_class()
|
self.translator_class = self.builder.get_translator_class()
|
||||||
|
|
||||||
@ -49,7 +49,7 @@ class PseudoXMLWriter(writers.Writer):
|
|||||||
|
|
||||||
def __init__(self, builder):
|
def __init__(self, builder):
|
||||||
# type: (Builder) -> None
|
# type: (Builder) -> None
|
||||||
writers.Writer.__init__(self)
|
super(PseudoXMLWriter, self).__init__()
|
||||||
self.builder = builder
|
self.builder = builder
|
||||||
|
|
||||||
def translate(self):
|
def translate(self):
|
||||||
|
@ -17,7 +17,7 @@ from sphinx.util.fileutil import copy_asset, copy_asset_file
|
|||||||
|
|
||||||
class DummyTemplateLoader(BuiltinTemplateLoader):
|
class DummyTemplateLoader(BuiltinTemplateLoader):
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
BuiltinTemplateLoader.__init__(self)
|
super(DummyTemplateLoader, self).__init__()
|
||||||
builder = mock.Mock()
|
builder = mock.Mock()
|
||||||
builder.config.templates_path = []
|
builder.config.templates_path = []
|
||||||
builder.app.translater = None
|
builder.app.translater = None
|
||||||
|
Loading…
Reference in New Issue
Block a user