pydoctor.linker._EpydocLinker

class documentation

class _EpydocLinker(DocstringLinker): (source)

Constructor: _EpydocLinker(obj)

This linker implements the xref lookup logic.

Method	`__init__`	Undocumented
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	`switch_context`	Switch the context of the linker, keeping the same underlying lookup rules.
Instance Variable	`reporting_obj`	Object used for reporting link not found errors. Changed when the linker `switch_context`.
Property	`obj`	Object used for resolving the target name, it's NOT changed when the linker `switch_context`.
Property	`page_url`	URL of the page used to compute the relative links from. Can be an empty string to always generate full urls.
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.
Instance Variable	`_init_obj`	Undocumented
Instance Variable	`_page_object`	Undocumented

def __init__(self, obj: model.Documentable): (source) ¶

Undocumented

def link_to(self, identifier: str, label: Flattenable, *, is_annotation: bool = False) -> Tag: (source) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.link_to

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.
is_annotation:`bool`	Generated links will give precedence to the module defined variables rather the nested definitions when there are name collisions.
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: str, label: Flattenable, lineno: int) -> Tag: (source) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.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.

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: str) -> str | None: (source) ¶

Return link for `name` based on intersphinx inventory.

Return None if link is not found.

def look_for_name(self, name: str, candidates: Iterable[model.Documentable], lineno: int) -> model.Documentable | None: (source) ¶

Undocumented

@contextlib.contextmanager

def switch_context(self, ob: model.Documentable | None) -> Iterator[None]: (source) ¶

overrides pydoctor.epydoc.markup.DocstringLinker.switch_context

Switch the context of the linker, keeping the same underlying lookup rules.

Useful to resolve links with the right Documentable context but create correct - absolute or relative - links to be clicked on from another page rather than the initial page of the context. "Cannot find link target" errors will be reported relatively to the new context object.

Pass None to always generate full URLs (for summaries for example), in this case error will NOT be reported at all.

reporting_obj: model.Documentable | None = (source) ¶

Object used for reporting link not found errors. Changed when the linker switch_context.

@property

obj: model.Documentable = (source) ¶

Object used for resolving the target name, it's NOT changed when the linker switch_context.

@property

page_url: str = (source) ¶

URL of the page used to compute the relative links from. Can be an empty string to always generate full urls.

def _resolve_identifier_xref(self, identifier: str, lineno: int) -> str | model.Documentable: (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
`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.

_init_obj = (source) ¶

Undocumented

_page_object: model.Documentable | None = (source) ¶

Undocumented