pydoctor.test.test_commandline

module documentation

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​_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):
Run CLI with options and return the output triggered by system exit.
Parameters
*options:strUndocumented
Returns
strUndocumented
def test_cache_enabled_by_default():
Intersphinx object caching is enabled by default.
def test_cannot_advance_blank_system():

Undocumented

def 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.
def test_invalid_option():

Undocumented

def test_invalid_systemclasses():

Undocumented

def test_main_project_name_guess(capsys):
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):
When a project name is provided in the CLI arguments nothing is logged.
Parameters
capsys:CapSysUndocumented
def test_main_return_non_zero_on_warnings():
When `-W` is used it returns 3 as exit code when there are warnings.
def test_main_return_zero_on_warnings():
By default it will return 0 as exit code even when there are warnings.
def test_main_source_outside_basedir(capsys):
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):
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):

--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():

Undocumented

def test_project_version_default():
When no --project-version is provided, it will default empty string.
def test_project_version_string():
--project-version can be passed as a simple string.
def test_projectbasedir_absolute(tmp_path):

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():
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):
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