From 97615beda26ff7cba28882ec4398fa6f1b640ea0 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 4 Dec 2018 01:00:37 +0900 Subject: [PATCH] refactor TextTranslator; Replace _make_depart_admonition() --- CHANGES | 1 + doc/extdev/index.rst | 5 +++++ sphinx/writers/text.py | 42 ++++++++++++++++++++++++++---------------- 3 files changed, 32 insertions(+), 16 deletions(-) diff --git a/CHANGES b/CHANGES index 09fabfdd2..c4e1c9328 100644 --- a/CHANGES +++ b/CHANGES @@ -52,6 +52,7 @@ Deprecated * ``sphinx.util.osutil.walk()`` * ``sphinx.util.pycompat.u`` * ``sphinx.writers.latex.LaTeXTranslator.babel_defmacro()`` +* ``sphinx.writers.text.TextTranslator._make_depart_admonition()`` * template variables for LaTeX template - ``pageautorefname`` diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 15bee8390..26083baa3 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -187,6 +187,11 @@ The following is a list of deprecated interfaces. - 3.0 - N/A + * - ``sphinx.writers.text.TextTranslator._make_depart_admonition()`` + - 2.0 + - 3.0 + - N/A + * - ``sphinx.writers.latex.LaTeXTranslator.babel_defmacro()`` - 2.0 - 4.0 diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 9bad2c10e..f4fc594e6 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -12,6 +12,7 @@ import math import os import re import textwrap +import warnings from itertools import groupby, chain from typing import Iterable, cast @@ -19,6 +20,7 @@ from docutils import nodes, writers from docutils.utils import column_width from sphinx import addnodes +from sphinx.deprecation import RemovedInSphinx30Warning from sphinx.locale import admonitionlabels, _ from sphinx.util.docutils import SphinxTranslator @@ -1049,33 +1051,31 @@ class TextTranslator(SphinxTranslator): if isinstance(node.children[0], nodes.Sequential): self.add_text(self.nl) - def _make_depart_admonition(name): - # type: (unicode) -> Callable[[TextTranslator, nodes.Element], None] - def depart_admonition(self, node): - # type: (nodes.Element) -> None - self.end_state(first=admonitionlabels[name] + ': ') - return depart_admonition + def _depart_admonition(self, node): + # type: (nodes.Element) -> None + label = admonitionlabels[node.tagname] + self.end_state(first=label + ': ') visit_attention = _visit_admonition - depart_attention = _make_depart_admonition('attention') + depart_attention = _depart_admonition visit_caution = _visit_admonition - depart_caution = _make_depart_admonition('caution') + depart_caution = _depart_admonition visit_danger = _visit_admonition - depart_danger = _make_depart_admonition('danger') + depart_danger = _depart_admonition visit_error = _visit_admonition - depart_error = _make_depart_admonition('error') + depart_error = _depart_admonition visit_hint = _visit_admonition - depart_hint = _make_depart_admonition('hint') + depart_hint = _depart_admonition visit_important = _visit_admonition - depart_important = _make_depart_admonition('important') + depart_important = _depart_admonition visit_note = _visit_admonition - depart_note = _make_depart_admonition('note') + depart_note = _depart_admonition visit_tip = _visit_admonition - depart_tip = _make_depart_admonition('tip') + depart_tip = _depart_admonition visit_warning = _visit_admonition - depart_warning = _make_depart_admonition('warning') + depart_warning = _depart_admonition visit_seealso = _visit_admonition - depart_seealso = _make_depart_admonition('seealso') + depart_seealso = _depart_admonition def visit_versionmodified(self, node): # type: (addnodes.versionmodified) -> None @@ -1370,3 +1370,13 @@ class TextTranslator(SphinxTranslator): def unknown_visit(self, node): # type: (nodes.Node) -> None raise NotImplementedError('Unknown node: ' + node.__class__.__name__) + + def _make_depart_admonition(name): + # type: (unicode) -> Callable[[TextTranslator, nodes.Element], None] + warnings.warn('TextTranslator._make_depart_admonition() is deprecated.', + RemovedInSphinx30Warning) + + def depart_admonition(self, node): + # type: (nodes.Element) -> None + self.end_state(first=admonitionlabels[name] + ': ') + return depart_admonition