Merge pull request #498 from tristanlatr/linker-cache

Provides caching for the linker

README.rst

@@ -73,6 +73,8 @@ What's New?
 in development
 ^^^^^^^^^^^^^^
 * Add client side search system based on lunr.js.
+* Fix broken links in docstring summaries.
+* Add cache for the xref linker, reduces the number of identical warnings.
 
 pydoctor 22.2.2
 ^^^^^^^^^^^^^^^

pydoctor/astbuilder.py

@@ -984,7 +984,7 @@ def __init__(self, value: Any, ctx: model.Documentable):
         The colorized value as L{ParsedDocstring}.
         """
 
-        self._linker = epydoc2stan._EpydocLinker(ctx)
+        self._linker = ctx.docstringlinker
         """
         Linker.
         """

pydoctor/model.py

@@ -31,6 +31,7 @@
     from typing_extensions import Literal
     from twisted.web.template import Flattenable
     from pydoctor.astbuilder import ASTBuilder
+    from pydoctor import epydoc2stan
 else:
     Literal = {True: bool, False: bool}
     ASTBuilder = object
@@ -145,6 +146,7 @@ def doctarget(self) -> 'Documentable':
 
     def setup(self) -> None:
         self.contents: Dict[str, Documentable] = {}
+        self._linker: Optional['epydoc2stan.DocstringLinker'] = None
 
     def setDocstring(self, node: ast.Str) -> None:
         doc = node.s
@@ -373,6 +375,19 @@ def report(self, descr: str, section: str = 'parsing', lineno_offset: int = 0) -
             f'{self.description}:{linenumber}: {descr}',
             thresh=-1)
 
+    @property
+    def docstringlinker(self) -> 'epydoc2stan.DocstringLinker':
+        """
+        Returns an instance of L{epydoc2stan.DocstringLinker} suitable for resolving names
+        in the context of the object scope. 
+        """
+        if self._linker is not None:
+            return self._linker
+        # FIXME: avoid cyclic import https://github.com/twisted/pydoctor/issues/507
+        from pydoctor.epydoc2stan import _CachedEpydocLinker
+        self._linker = _CachedEpydocLinker(self)
+        return self._linker
+
 
 class CanContainImportsDocumentable(Documentable):
     def setup(self) -> None:

pydoctor/templatewriter/pages/__init__.py

@@ -48,7 +48,7 @@ def format_decorators(obj: Union[model.Function, model.Attribute]) -> Iterator["
 
         # Colorize decorators!
         doc = colorize_inline_pyval(dec)
-        stan = doc.to_stan(epydoc2stan._EpydocLinker(obj))
+        stan = doc.to_stan(obj.docstringlinker)
         # Report eventual warnings. It warns when a regex failed to parse or the html2stan() function fails.
         for message in doc.warnings:
             obj.report(message)
@@ -435,7 +435,7 @@ def extras(self) -> List["Flattenable"]:
 
     def classSignature(self) -> "Flattenable":
         r: List["Flattenable"] = []
-        _linker = epydoc2stan._EpydocLinker(self.ob)
+        _linker = self.ob.docstringlinker
         zipped = list(zip(self.ob.rawbases, self.ob.bases))
         if zipped:
             r.append('(')

pydoctor/test/__init__.py

@@ -1,10 +1,11 @@
 """PyDoctor's test suite."""
 
 from logging import LogRecord
-from typing import Iterable, TYPE_CHECKING, Optional, Sequence
+from typing import Any, Iterable, TYPE_CHECKING, Optional, Sequence, Type
 import sys
 import pytest
 from pathlib import Path
+import functools
 
 from twisted.web.template import Tag, tags
 
@@ -94,3 +95,12 @@ def link_xref(self, target: str, label: "Flattenable", lineno: int) -> Tag:
 
     def resolve_identifier(self, identifier: str) -> Optional[str]:
         return None
+
+def partialclass(cls: Type[Any], *args: Any, **kwds: Any) -> Type[Any]:
+    # mypy gets errors: - Variable "cls" is not valid as a type
+    #                   - Invalid base class "cls" 
+    class NewCls(cls): #type: ignore
+        __init__ = functools.partialmethod(cls.__init__, *args, **kwds) #type: ignore
+        __class__ = cls
+    assert isinstance(NewCls, type)
+    return NewCls