pydoctor.test.test_epydoc2stan._TestCachedEpydocLinker

class documentation

class _TestCachedEpydocLinker(linker._CachedEpydocLinker): (source)

Docstring linker for testing the caching of results.

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.
Instance Variable	`lookups`	Undocumented
Instance Variable	`max_lookups`	Undocumented

Inherited from _CachedEpydocLinker:

Class	`CacheEntry`	Undocumented
Exception	`NewDerivedEntry`	Undocumented
Method	`_adjust_link`	Undocumented
Method	`_get_cache`	Undocumented
Method	`_lookup_cached_entry`	Undocumented
Method	`_lookup_cached_link_to`	Undocumented
Method	`_lookup_cached_link_xref`	Undocumented
Method	`_new_derived_entry`	Undocumented
Method	`_store_in_cache`	Undocumented
Type Alias	`_CacheType`	Undocumented
Class Variable	`_defaultCache`	Undocumented
Instance Variable	`_link_to_cache`	Undocumented
Instance Variable	`_link_xref_cache`	Undocumented

Inherited from _EpydocLinker (via _CachedEpydocLinker):

Exception	`LookupFailed`	Encapsulate a link tag that is not actually a link because we count not resolve the name.
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	`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, max_lookups, same_page_optimization=True): (source) ¶

overrides pydoctor.linker._CachedEpydocLinker.__init__

Undocumented

Parameters
obj:`model.Documentable`	Undocumented
max_lookups:`int`	Undocumented
same_page_optimization:`bool`	Undocumented

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

overrides pydoctor.linker._CachedEpydocLinker.link_to

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

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

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

overrides pydoctor.linker._CachedEpydocLinker.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>`.

lookups: int = (source) ¶

Undocumented

max_lookups = (source) ¶

Undocumented