module documentation

Unit tests for model.

Class Dummy No class docstring; 1/1 method documented
Class FakeDocumentable A fake of pydoctor.model.Documentable that provides a system and sourceHref attribute.
Class FakeOptions A fake options object as if it came from argparse.
Function dummy_function_with_complex_signature Undocumented
Function test_c_module_python_module_name_clash Undocumented
Function test_c_module_text_signature Undocumented
Function test_constructor_params_empty Undocumented
Function test_constructor_params_inherited Undocumented
Function test_constructor_params_simple Undocumented
Function test_docsources_class_attribute Undocumented
Function test_docstring_lineno Undocumented
Function test_fetchIntersphinxInventories_content Download and parse intersphinx inventories for each configured intersphix.
Function test_fetchIntersphinxInventories_empty Convert option to empty dict.
Function test_htmlsourcetemplate_auto_detect Tests for the recognition of different version control providers that uses differents URL templates to point to line numbers.
Function test_htmlsourcetemplate_custom The links to source code web pages can be customized via an CLI argument.
Function test_initialization_default When initialized without options, will use default options and default verbosity.
Function test_initialization_options Can be initialized with options.
Function test_introspection_extension Find docstrings from this test using introspection of an extension.
Function test_introspection_python Find docstrings from this test using introspection on pure Python.
Function test_privacy_reparented Test that the privacy of an object changes if the name of the object changes (with reparenting).
Function test_privacy_switch Undocumented
Function test_resolve_name_subclass Model.resolveName knows about single inheritance.
Function test_setSourceHrefOption Test that the projectbasedirectory option sets the model.sourceHref properly.
Variable testpackages Undocumented
def dummy_function_with_complex_signature(foo, bar): (source)

Undocumented

Parameters
foo:intUndocumented
bar:floatUndocumented
Returns
strUndocumented
@pytest.mark.skipif('platform.python_implementation() == \'PyPy\'')
def test_c_module_python_module_name_clash(capsys): (source)

Undocumented

Parameters
capsys:CapSysUndocumented
@pytest.mark.skipif('platform.python_implementation() == \'PyPy\'')
def test_c_module_text_signature(capsys): (source)

Undocumented

Parameters
capsys:CapSysUndocumented
def test_constructor_params_empty(): (source)

Undocumented

def test_constructor_params_inherited(): (source)

Undocumented

def test_constructor_params_simple(): (source)

Undocumented

def test_docsources_class_attribute(): (source)

Undocumented

def test_docstring_lineno(): (source)

Undocumented

def test_fetchIntersphinxInventories_content(): (source)

Download and parse intersphinx inventories for each configured intersphix.

def test_fetchIntersphinxInventories_empty(): (source)

Convert option to empty dict.

def test_htmlsourcetemplate_auto_detect(): (source)

Tests for the recognition of different version control providers that uses differents URL templates to point to line numbers.

Supported templates are:

    Github : {}#L{lineno}
    Bitbucket: {}#lines-{lineno}
    SourceForge : {}#l{lineno}
def test_htmlsourcetemplate_custom(): (source)

The links to source code web pages can be customized via an CLI argument.

def test_initialization_default(): (source)

When initialized without options, will use default options and default verbosity.

def test_initialization_options(): (source)

Can be initialized with options.

def test_introspection_extension(): (source)

Find docstrings from this test using introspection of an extension.

def test_introspection_python(): (source)

Find docstrings from this test using introspection on pure Python.

def test_privacy_reparented(): (source)

Test that the privacy of an object changes if the name of the object changes (with reparenting).

@pytest.mark.parametrize('privacy', [['public:m._public**', 'public:m.tests', 'public:m.tests.helpers', 'private:m._public.private', 'hidden:m._public.hidden', 'hidden:m.tests.*'], reversed(['private:**private', 'hidden:**hidden', 'public:**_public', 'hidden:m.tests.test**'])])
def test_privacy_switch(privacy): (source)

Undocumented

Parameters
privacy:objectUndocumented
def test_resolve_name_subclass(capsys): (source)

Model.resolveName knows about single inheritance.

Parameters
capsys:CapSysUndocumented
@pytest.mark.parametrize('projectBaseDir', [PurePosixPath('/foo/bar/ProjectName'), PureWindowsPath('C:\\foo\\bar\\ProjectName')])
def test_setSourceHrefOption(projectBaseDir): (source)

Test that the projectbasedirectory option sets the model.sourceHref properly.

Parameters
projectBaseDir:PathUndocumented
testpackages = (source)

Undocumented