pydoctor.test.test_packages

module documentation
(source)

Undocumented

Function processPackage Undocumented
Function test_allgames Test reparenting of documentables. A name which is defined in module 1, but included in __all__ of module 2 that it is imported into, should end up in the documentation of module 2.
Function test_cyclic_imports Test whether names are resolved correctly when we have import cycles. The test package contains module 'a' that defines class 'A' and module 'b' that defines class 'B'; each module imports the other. Since the test data is symmetrical, we will at some point be importing a module that has not been fully processed yet, no matter which module gets processed first.
Function test_importingfrompackage Undocumented
Function test_modnamedafterbuiltin Undocumented
Function test_nestedconfusion Undocumented
Function test_package_docstring Undocumented
Function test_package_module_name_clash When a module and a package have the same full name, the package wins.
Function test_relative_import Undocumented
Function test_reparented_module A module that is imported in a package as a different name and exported in that package under the new name via __all__ is presented using the new name.
Function test_reparenting_crash Test for https://github.com/twisted/pydoctor/issues/513
Function test_reparenting_follows_aliases Test for https://github.com/twisted/pydoctor/issues/505
Variable testpackages Undocumented
def processPackage(packname, systemcls=model.System): (source)

Undocumented

Parameters
packname:strUndocumented
systemcls:Callable[[], model.System]Undocumented
Returns
model.SystemUndocumented
def test_allgames(): (source)

Test reparenting of documentables. A name which is defined in module 1, but included in __all__ of module 2 that it is imported into, should end up in the documentation of module 2.

def test_cyclic_imports(): (source)

Test whether names are resolved correctly when we have import cycles. The test package contains module 'a' that defines class 'A' and module 'b' that defines class 'B'; each module imports the other. Since the test data is symmetrical, we will at some point be importing a module that has not been fully processed yet, no matter which module gets processed first.

def test_importingfrompackage(): (source)

Undocumented

def test_modnamedafterbuiltin(): (source)

Undocumented

def test_nestedconfusion(): (source)

Undocumented

def test_package_docstring(): (source)

Undocumented

def test_package_module_name_clash(): (source)

When a module and a package have the same full name, the package wins.

def test_relative_import(): (source)

Undocumented

def test_reparented_module(): (source)

A module that is imported in a package as a different name and exported in that package under the new name via __all__ is presented using the new name.

@pytest.mark.parametrize('modname', ['reparenting_crash', 'reparenting_crash_alt'])
def test_reparenting_crash(modname): (source)

Test for https://github.com/twisted/pydoctor/issues/513

Parameters
modname:strUndocumented
def test_reparenting_follows_aliases(): (source)

Test for https://github.com/twisted/pydoctor/issues/505

Reparenting process follows aliases.

testpackages = (source)

Undocumented