pydoctor.test.test_templatewriter

module documentation
(source)

Undocumented

Function filetext Undocumented
Function flatten Undocumented
Function getHTMLOf Undocumented
Function is_fs_case_sensitive Undocumented
Function test_basic_package Undocumented
Function test_compact_module_summary Undocumented
Function test_crash_xmlstring_entities Crash test for https://github.com/twisted/pydoctor/issues/641
Function test_crash_xmlstring_entities_rst Idem for RST
Function test_document_code_in_init_module Undocumented
Function test_empty_table Undocumented
Function test_format_decorators Test pages.format_decorators
Function test_format_signature Test pages.format_signature.
Function test_hasdocstring Undocumented
Function test_html_template_version Undocumented
Function test_index_contains_infos Test if index.html contains the following informations:
Function test_isClassNodePrivate A node for a private class with public subclasses is considered public.
Function test_isPrivate A documentable object is private if it is private itself or lives in a private context.
Function test_missing_variable Undocumented
Function test_multipleInheritanceNewClass A class that has multiple bases has all methods in its MRO rendered.
Function test_nonempty_table Undocumented
Function test_objects_order_mixed_modules_and_packages Packages and modules are mixed when sorting with objects_order.
Function test_rest_support Undocumented
Function test_sidebar Undocumented
Function test_simple Undocumented
Function test_template Undocumented
Function test_template_casing Undocumented
Function test_template_fromdir_fromfile_failure Undocumented
Function test_template_lookup_add_template_allok Undocumented
Function test_template_lookup_add_template_raises Undocumented
Function test_template_lookup_add_template_warns Undocumented
Function test_template_lookup_get_template Undocumented
Function test_template_subfolders_overrides Undocumented
Function test_template_subfolders_write Undocumented
Function test_template_subfolders_write_casing Undocumented
Function test_templatelookup_casing Undocumented
Function test_themes_template_versions All our templates should be up to date.
Variable src_crash_xml_entities Undocumented
Variable template_dir Undocumented
def filetext(path): (source)

Undocumented

Parameters
path:Union[Path, Traversable]Undocumented
Returns
strUndocumented
def flatten(t): (source)

Undocumented

Parameters
t:FlattenableUndocumented
Returns
strUndocumented
def getHTMLOf(ob): (source)

Undocumented

Parameters
ob:model.DocumentableUndocumented
Returns
strUndocumented
def is_fs_case_sensitive(): (source)

Undocumented

Returns
boolUndocumented
def test_basic_package(tmp_path): (source)

Undocumented

Parameters
tmp_path:PathUndocumented
def test_compact_module_summary(): (source)

Undocumented

@pytest.mark.parametrize('processtypes', [True, False])
def test_crash_xmlstring_entities(capsys, processtypes): (source)

Crash test for https://github.com/twisted/pydoctor/issues/641

This test might fail in the future, when twisted's XMLString supports XHTML entities (see https://github.com/twisted/twisted/issues/11581). But it will always fail for python 3.6 since twisted dropped support for these versions of python.

Parameters
capsys:CapSysUndocumented
processtypes:boolUndocumented
@pytest.mark.parametrize('processtypes', [True, False])
def test_crash_xmlstring_entities_rst(capsys, processtypes): (source)

Idem for RST

Parameters
capsys:CapSysUndocumented
processtypes:boolUndocumented
def test_document_code_in_init_module(): (source)

Undocumented

def test_empty_table(): (source)

Undocumented

def test_format_decorators(): (source)

Test pages.format_decorators

def test_format_signature(): (source)

Test pages.format_signature.

Note
This test will need to be adapted one we include annotations inside signatures.
def test_hasdocstring(): (source)

Undocumented

def test_html_template_version(): (source)

Undocumented

def test_index_contains_infos(tmp_path): (source)

Test if index.html contains the following informations:

  • meta generator tag
  • nav and links to modules, classes, names
  • link to the root packages
  • pydoctor github link in the footer
Parameters
tmp_path:PathUndocumented
def test_isClassNodePrivate(): (source)

A node for a private class with public subclasses is considered public.

@pytest.mark.parametrize('func', [isPrivate, isClassNodePrivate])
def test_isPrivate(func): (source)

A documentable object is private if it is private itself or lives in a private context.

Parameters
func:Callable[[model.Class], bool]Undocumented
def test_missing_variable(): (source)

Undocumented

@pytest.mark.parametrize('className', ['NewClassThatMultiplyInherits', 'OldClassThatMultiplyInherits', 'Diamond'])
def test_multipleInheritanceNewClass(className): (source)

A class that has multiple bases has all methods in its MRO rendered.

Parameters
className:strUndocumented
def test_nonempty_table(): (source)

Undocumented

def test_objects_order_mixed_modules_and_packages(): (source)

Packages and modules are mixed when sorting with objects_order.

def test_rest_support(): (source)

Undocumented

def test_sidebar(): (source)

Undocumented

def test_simple(): (source)

Undocumented

def test_template(): (source)

Undocumented

def test_template_casing(): (source)

Undocumented

def test_template_fromdir_fromfile_failure(): (source)

Undocumented

def test_template_lookup_add_template_allok(): (source)

Undocumented

def test_template_lookup_add_template_raises(): (source)

Undocumented

def test_template_lookup_add_template_warns(): (source)

Undocumented

def test_template_lookup_get_template(): (source)

Undocumented

def test_template_subfolders_overrides(): (source)

Undocumented

def test_template_subfolders_write(tmp_path): (source)

Undocumented

Parameters
tmp_path:PathUndocumented
@pytest.mark.skipif(not is_fs_case_sensitive(), reason='This test requires a case sensitive file system.')
def test_template_subfolders_write_casing(tmp_path): (source)

Undocumented

Parameters
tmp_path:PathUndocumented
def test_templatelookup_casing(): (source)

Undocumented

def test_themes_template_versions(): (source)

All our templates should be up to date.

src_crash_xml_entities: str = (source)

Undocumented

template_dir = (source)

Undocumented