pydoctor.test.test_commandline

module documentation
(source)

Undocumented

Function geterrtext Run CLI with options and return the output triggered by system exit.
Function test_cache_enabled_by_default Intersphinx object caching is enabled by default.
Function test_cannot_advance_blank_system Undocumented
Function test_cli_warnings_on_error The --warnings-as-errors option is disabled by default. This is the test for the long form of the CLI option.
Function test_help_option pydoctor --help
Function test_invalid_option Undocumented
Function test_invalid_systemclasses Undocumented
Function test_main_project_name_guess When no project name is provided in the CLI arguments, a default name is used and logged.
Function test_main_project_name_option When a project name is provided in the CLI arguments nothing is logged.
Function test_main_return_non_zero_on_warnings When `-W` is used it returns 3 as exit code when there are warnings.
Function test_main_return_zero_on_warnings By default it will return 0 as exit code even when there are warnings.
Function test_main_source_outside_basedir If a --project-base-dir is given, all package and module paths must be located inside that base directory.
Function test_main_symlinked_paths The project base directory and package/module directories are normalized in the same way, such that System.setSourceHref() can call Path.relative_to() on them.
Function test_make_intersphix --make-intersphinx without --make-html will only produce the Sphinx inventory object.
Function test_no_systemclasses_py3 Undocumented
Function test_project_version_default When no --project-version is provided, it will default empty string.
Function test_project_version_string --project-version can be passed as a simple string.
Function test_projectbasedir_absolute The --project-base-dir option, when given an absolute path, should set that path as the projectbasedirectory attribute on the options object.
Function test_projectbasedir_relative The --project-base-dir option, when given a relative path, should convert that path to absolute and set it as the projectbasedirectory attribute on the options object.
Function test_projectbasedir_symlink The --project-base-dir option, when given a path containing a symbolic link, should resolve the path to the target directory.
def geterrtext(*options): (source)

Run CLI with options and return the output triggered by system exit.

Parameters
*options:strUndocumented
Returns
strUndocumented
def test_cache_enabled_by_default(): (source)

Intersphinx object caching is enabled by default.

def test_cannot_advance_blank_system(): (source)

Undocumented

def test_cli_warnings_on_error(): (source)

The --warnings-as-errors option is disabled by default. This is the test for the long form of the CLI option.

def test_help_option(capsys): (source)

pydoctor --help

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

Undocumented

def test_invalid_systemclasses(): (source)

Undocumented

def test_main_project_name_guess(capsys): (source)

When no project name is provided in the CLI arguments, a default name is used and logged.

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

When a project name is provided in the CLI arguments nothing is logged.

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

When `-W` is used it returns 3 as exit code when there are warnings.

def test_main_return_zero_on_warnings(): (source)

By default it will return 0 as exit code even when there are warnings.

def test_main_source_outside_basedir(capsys): (source)

If a --project-base-dir is given, all package and module paths must be located inside that base directory.

Parameters
capsys:CapSysUndocumented
def test_main_symlinked_paths(tmp_path): (source)

The project base directory and package/module directories are normalized in the same way, such that System.setSourceHref() can call Path.relative_to() on them.

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

--make-intersphinx without --make-html will only produce the Sphinx inventory object.

This is also an integration test for the Sphinx inventory writer.

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

Undocumented

def test_project_version_default(): (source)

When no --project-version is provided, it will default empty string.

def test_project_version_string(): (source)

--project-version can be passed as a simple string.

def test_projectbasedir_absolute(tmp_path): (source)

The --project-base-dir option, when given an absolute path, should set that path as the projectbasedirectory attribute on the options object.

Previous versions of this test tried using non-existing paths and compared the string representations, but that was unreliable, since the input path might contain a symlink that will be resolved, such as "/home" on macOS. Using Path.samefile() is reliable, but requires an existing path.

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

The --project-base-dir option, when given a relative path, should convert that path to absolute and set it as the projectbasedirectory attribute on the options object.

def test_projectbasedir_symlink(tmp_path): (source)

The --project-base-dir option, when given a path containing a symbolic link, should resolve the path to the target directory.

Parameters
tmp_path:PathUndocumented