Few simplifications here and there.

twisted · tristanlatr · Oct 25, 2024 · Oct 25, 2024 · Oct 25, 2024 · Oct 25, 2024
commit a46a3a38df11914fa26e2635fd5664b0784dbc59
diff --git a/pydoctor/epydoc/markup/__init__.py b/pydoctor/epydoc/markup/__init__.py
@@ -33,6 +33,7 @@
 from __future__ import annotations
 __docformat__ = 'epytext en'
 
+import contextlib
 from itertools import chain
 from typing import Callable, ContextManager, Iterable, List, Optional, Sequence, Iterator, TYPE_CHECKING
 import abc
@@ -209,7 +210,8 @@ def to_text(self) -> str:
         Translate this docstring to a string.
         The default implementation depends on L{to_node}.
         """
-        return ''.join(node2stan.gettext(self.to_node()))
+        doc = self.to_node()
+        return ''.join(node2stan.gettext(doc))
 
     def with_linker(self, linker: DocstringLinker) -> ParsedDocstring:
         """
@@ -425,6 +427,20 @@ def switch_context(self, ob:Optional['Documentable']) -> ContextManager[None]:
         in this case error will NOT be reported at all.
         """
 
+class NotFoundLinker(DocstringLinker):
+    """A DocstringLinker implementation that cannot find any links."""
+
+    def link_to(self, target: str, label: "Flattenable") -> Tag:
+        return tags.transparent(label)
+
+    def link_xref(self, target: str, label: "Flattenable", lineno: int) -> Tag:
+        return tags.code(label)
+
+    @contextlib.contextmanager
+    def switch_context(self, ob: Documentable | None) -> Iterator[None]:
+        yield
+
+
 ##################################################
 ## ParseError exceptions
 ##################################################

diff --git a/pydoctor/epydoc/markup/_types.py b/pydoctor/epydoc/markup/_types.py
@@ -48,8 +48,9 @@ def has_body(self) -> bool:
 
     def to_node(self) -> nodes.document:
         """
-        Not implemented.
+        Not implemented at this time :/
         """
+        #TODO: Fix this soon
         raise NotImplementedError()
 
     def to_stan(self, docstring_linker: DocstringLinker) -> Tag:

diff --git a/pydoctor/epydoc2stan.py b/pydoctor/epydoc2stan.py
@@ -966,7 +966,7 @@ def colorized_pyval_fallback(_: List[ParseError], doc:ParsedDocstring, __:model.
     """
     This fallback function uses L{ParsedDocstring.to_node()}, so it must be used only with L{ParsedDocstring} subclasses that implements C{to_node()}.
     """
-    return Tag('code')(node2stan.gettext(doc.to_node()))
+    return tags.code(doc.to_text())
 
 def _format_constant_value(obj: model.Attribute) -> Iterator["Flattenable"]:
 

diff --git a/pydoctor/templatewriter/pages/__init__.py b/pydoctor/templatewriter/pages/__init__.py
@@ -70,8 +70,7 @@ def format_signature(func: Union[model.Function, model.FunctionOverload]) -> "Fl
         parsed_sig, 
         ctx.docstring_linker, 
         ctx, 
-        fallback=lambda _, doc, ___: tags.transparent(
-            node2stan.gettext(doc.to_node())),
+        fallback=lambda _, doc, ___: tags.transparent(doc.to_text()),
         section='signature'
     )
 

diff --git a/pydoctor/templatewriter/search.py b/pydoctor/templatewriter/search.py
@@ -104,12 +104,7 @@ def format_docstring(self, ob: model.Documentable) -> Optional[str]:
         source = epydoc2stan.ensure_parsed_docstring(ob)
         if source is not None:
             assert ob.parsed_docstring is not None
-            try:
-                doc = ' '.join(node2stan.gettext(ob.parsed_docstring.to_node()))
-            except NotImplementedError:
-                # some ParsedDocstring subclass raises NotImplementedError on calling to_node()
-                # Like ParsedPlaintextDocstring.
-                doc = source.docstring
+            doc = ob.parsed_docstring.to_text()
         return doc
 
     def format_kind(self, ob:model.Documentable) -> str:

diff --git a/pydoctor/test/__init__.py b/pydoctor/test/__init__.py
@@ -1,20 +1,18 @@
 """PyDoctor's test suite."""
 
-import contextlib
 from logging import LogRecord
-from typing import Iterable, TYPE_CHECKING, Iterator, Optional, Sequence
+from typing import Iterable, TYPE_CHECKING, Sequence
 import sys
 import pytest
 from pathlib import Path
 
-from twisted.web.template import Tag, tags
 
 from pydoctor import epydoc2stan, model
 from pydoctor.templatewriter import IWriter, TemplateLookup
-from pydoctor.epydoc.markup import DocstringLinker
+from pydoctor.epydoc.markup import NotFoundLinker
 
-if TYPE_CHECKING:
-    from twisted.web.template import Flattenable
+
+__all__ = ['InMemoryWriter', 'NotFoundLinker', 'posonlyargs', 'typecomment', 'CapSys']
 
 posonlyargs = pytest.mark.skipif(sys.version_info < (3, 8), reason="requires python 3.8")
 typecomment = pytest.mark.skipif(sys.version_info < (3, 8), reason="requires python 3.8")
@@ -87,18 +85,3 @@ def _writeDocsFor(self, ob: model.Documentable) -> None:
 
         for o in ob.contents.values():
             self._writeDocsFor(o)
-
-
-class NotFoundLinker(DocstringLinker):
-    """A DocstringLinker implementation that cannot find any links."""
-
-    def link_to(self, target: str, label: "Flattenable") -> Tag:
-        return tags.transparent(label)
-
-    def link_xref(self, target: str, label: "Flattenable", lineno: int) -> Tag:
-        return tags.code(label)
-
-    @contextlib.contextmanager
-    def switch_context(self, ob: Optional[model.Documentable]) -> Iterator[None]:
-        yield
-
diff --git a/pydoctor/test/epydoc/test_pyval_repr.py b/pydoctor/test/epydoc/test_pyval_repr.py
@@ -10,7 +10,6 @@
 from pydoctor.epydoc.markup._pyval_repr import PyvalColorizer, colorize_inline_pyval
 from pydoctor.test import NotFoundLinker
 from pydoctor.stanutils import flatten, flatten_text, html2stan
-from pydoctor.node2stan import gettext
 
 def color(v: Any, linebreakok:bool=True, maxlines:int=5, linelen:int=40) -> str:
     colorizer = PyvalColorizer(linelen=linelen, linebreakok=linebreakok, maxlines=maxlines)
@@ -1160,7 +1159,7 @@ def color_re(s: Union[bytes, str],
     val = colorizer.colorize(extract_expr(ast.parse(f"re.compile({repr(s)})")))
 
     if check_roundtrip:
-        raw_text = ''.join(gettext(val.to_node()))
+        raw_text = val.to_text()
         re_begin = 13
         raw_string = True
 
@@ -1428,7 +1427,7 @@ def color2(v: Any, linelen:int=50) -> str:
     """
     colorizer = PyvalColorizer(linelen=linelen, maxlines=5)
     colorized = colorizer.colorize(v)
-    text1 = ''.join(gettext(colorized.to_node()))
+    text1 = colorized.to_text()
     text2 = flatten_text(html2stan(flatten(colorized.to_stan(NotFoundLinker()))))
     assert text1 == text2
     return text2
@@ -1473,7 +1472,7 @@ def test_summary() -> None:
     """
     summarizer = PyvalColorizer(linelen=60, maxlines=1, linebreakok=False)
     def summarize(v:Any) -> str:
-        return(''.join(gettext(summarizer.colorize(v).to_node())))
+        return summarizer.colorize(v).to_text()
 
     assert summarize(list(range(100))) == "[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16..."
     assert summarize('hello\nworld') == r"'hello\nworld'"

diff --git a/pydoctor/test/test_astbuilder.py b/pydoctor/test/test_astbuilder.py
@@ -112,7 +112,7 @@ def signature2str(func: model.Function | model.FunctionOverload) -> str:
     doc = get_parsed_signature(func)
     assert doc
     fromhtml = flatten_text(format_signature(func))
-    fromdocutils = ''.join(node2stan.gettext(doc.to_node()))
+    fromdocutils = doc.to_text()
     assert fromhtml == fromdocutils
     return fromhtml