pydoctor.linker._EpydocLinker

class documentation

class _EpydocLinker(DocstringLinker): (source)

Known subclasses: pydoctor.linker._CachedEpydocLinker

This linker implements the xref lookup logic.

Exception	`LookupFailed`	Encapsulate a link tag that is not actually a link because we count not resolve the name.
Method	`__init__`	Undocumented
Method	`disable_same_page_optimazation`	By default, when linkng to an object on the same page, the linker will generate an URL that links to the anchor only, this will avoid reloading the page needlessly. But sometimes we're using a linker to present the content on another page...
Method	`link_to`	Format a link to a Python identifier. This will resolve the identifier like Python itself would.
Method	`link_xref`	Format a cross-reference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.
Method	`look_for_intersphinx`	Return link for `name` based on intersphinx inventory.
Method	`look_for_name`	Undocumented
Method	`resolve_identifier`	Resolve a Python identifier. This will resolve the identifier like Python itself would.
Instance Variable	`obj`	Undocumented
Instance Variable	`same_page_optimization`	Undocumented
Instance Variable	`strict`	Undocumented
Static Method	`_create_intersphinx_link`	Create a link with the special 'intersphinx-link' CSS class.
Method	`_resolve_identifier_xref`	Resolve a crossreference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.

def __init__(self, obj, same_page_optimization, strict=False): (source) ¶

overridden in pydoctor.linker._CachedEpydocLinker

Undocumented

Parameters
obj:`model.Documentable`	Undocumented
same_page_optimization:`bool`	Undocumented
strict:`bool`	Undocumented

@contextlib.contextmanager
def disable_same_page_optimazation(self): (source) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.disable_same_page_optimazation

By default, when linkng to an object on the same page, the linker will generate an URL that links to the anchor only, this will avoid reloading the page needlessly. But sometimes we're using a linker to present the content on another page. This context manager will make the linker always generate full URLs.

Returns
`Iterator[None]`	Undocumented

def link_to(self, identifier, label): (source) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.link_to

overridden in pydoctor.linker._CachedEpydocLinker

Format a link to a Python identifier. This will resolve the identifier like Python itself would.

Parameters
identifier:`str`	Undocumented
label:`Flattenable`	The label to show for the link.
target	The name of the Python identifier that should be linked to.
Returns
`Tag`	The link, or just the label if the target was not found.

def link_xref(self, target, label, lineno): (source) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.link_xref

overridden in pydoctor.linker._CachedEpydocLinker

Format a cross-reference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.

Parameters
target:`str`	The name of the Python identifier that should be linked to.
label:`Flattenable`	The label to show for the link.
lineno:`int`	The line number within the docstring at which the crossreference is located.
Returns
`Tag`	The link, or just the label if the target was not found. In either case, the returned top-level tag will be `<code>`.

def look_for_intersphinx(self, name): (source) ¶

Return link for `name` based on intersphinx inventory.

Return None if link is not found.

Parameters
name:`str`	Undocumented
Returns
`Optional[str]`	Undocumented

def look_for_name(self, name, candidates, lineno): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented
candidates:`Iterable[model.Documentable]`	Undocumented
lineno:`int`	Undocumented
Returns
`Optional[model.Documentable]`	Undocumented

def resolve_identifier(self, identifier): (source) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.resolve_identifier

Resolve a Python identifier. This will resolve the identifier like Python itself would.

Parameters
identifier:`str`	The name of the Python identifier that should be linked to.
Returns
`Optional[str]`	The URL of the target, or `None` if not found.

obj = (source) ¶

Undocumented

same_page_optimization = (source) ¶

Undocumented

strict = (source) ¶

Undocumented

@staticmethod
def _create_intersphinx_link(label, url): (source) ¶

Create a link with the special 'intersphinx-link' CSS class.

Parameters
label:`Flattenable`	Undocumented
url:`str`	Undocumented
Returns
`Tag`	Undocumented

def _resolve_identifier_xref(self, identifier, lineno): (source) ¶

Resolve a crossreference link to a Python identifier. This will resolve the identifier to any reasonable target, even if it has to look in places where Python itself would not.

Parameters
identifier:`str`	The name of the Python identifier that should be linked to.
lineno:`int`	The line number within the docstring at which the crossreference is located.
Returns
`Union[str, model.Documentable]`	The referenced object within our system, or the URL of an external target (found via Intersphinx).
Raises
`LookupError`	If `identifier` could not be resolved.