pydoctor.options

module documentation
(source)

The command-line parsing.

Class IntersphinxSource Undocumented
Class Options Container for all possible pydoctor options.
Function get_parser Undocumented
Function parse_args Undocumented
Constant BUILDTIME_FORMAT Undocumented
Constant BUILDTIME_FORMAT_HELP Undocumented
Constant CONFIG_SECTIONS Undocumented
Constant DEFAULT_CONFIG_FILES Undocumented
Constant DEFAULT_SYSTEM Undocumented
Constant FALSE_VALUES Undocumented
Variable PydoctorConfigParser Undocumented
Function _convert_htmlbaseurl Undocumented
Function _convert_htmlwriter Undocumented
Function _convert_intersphinx Undocumented
Function _convert_privacy Undocumented
Function _convert_projectbasedirectory Undocumented
Function _convert_sourcepath Undocumented
Function _convert_systemclass Undocumented
Function _convert_templatedir Undocumented
Function _get_viewsource_template Recognize several version control providers based on option --html-viewsource-base.
Function _parse_intersphinx Function returning a tuple (inventory file, base_url) for the intersphinx-file commandline argument. Used double commas because the simple comma might conflict with windows drive names.
Function _warn_deprecated_options Check the CLI options and warn on deprecated options.
Constant _RECOGNIZED_SOURCE_HREF Undocumented
def get_parser() -> ArgumentParser: (source)

Undocumented

def parse_args(args: Sequence[str]) -> Namespace: (source)

Undocumented

BUILDTIME_FORMAT: str = (source)

Undocumented

Value
'%Y-%m-%d %H:%M:%S'
BUILDTIME_FORMAT_HELP: str = (source)

Undocumented

Value
'YYYY-mm-dd HH:MM:SS'
CONFIG_SECTIONS: list[str] = (source)

Undocumented

Value
['tool.pydoctor', 'tool:pydoctor', 'pydoctor']
DEFAULT_CONFIG_FILES: list[str] = (source)

Undocumented

Value
['./pyproject.toml', './setup.cfg', './pydoctor.ini']
DEFAULT_SYSTEM: str = (source)

Undocumented

Value
'pydoctor.model.System'
FALSE_VALUES: set[str] = (source)

Undocumented

Value
set(['false', 'no', 'off', '0'])
PydoctorConfigParser = (source)

Undocumented

def _convert_htmlbaseurl(url: str | None) -> str | None: (source)

Undocumented

def _convert_htmlwriter(s: str) -> type[IWriter]: (source)

Undocumented

def _convert_intersphinx(files: list[str], option: str) -> list[IntersphinxSource]: (source)

Undocumented

def _convert_privacy(l: list[str]) -> list[tuple[model.PrivacyClass, str]]: (source)

Undocumented

def _convert_projectbasedirectory(s: str | None) -> Path | None: (source)

Undocumented

def _convert_sourcepath(l: list[str]) -> list[Path]: (source)

Undocumented

def _convert_systemclass(s: str) -> type[model.System]: (source)

Undocumented

def _convert_templatedir(l: list[str]) -> list[Path]: (source)

Undocumented

def _get_viewsource_template(sourcebase: str | None) -> str: (source)

Recognize several version control providers based on option --html-viewsource-base.

def _parse_intersphinx(s: str, option: str = '--interspinx') -> IntersphinxSource: (source)

Function returning a tuple (inventory file, base_url) for the intersphinx-file commandline argument. Used double commas because the simple comma might conflict with windows drive names.

>>> _parse_intersphinx('https://example.com/api/objects.inv::https://two/')
IntersphinxSource(source='https://example.com/api/objects.inv', base_url='https://two/')
>>> _parse_intersphinx('c:/one::https://two/')
IntersphinxSource(source='c:/one', base_url='https://two/')
>>> _parse_intersphinx('https://example.com/api/objects.inv  ::  https://two/')
IntersphinxSource(source='https://example.com/api/objects.inv', base_url='https://two/')
>>> _parse_intersphinx('    c:/one  ::      https://two/    ')
IntersphinxSource(source='c:/one', base_url='https://two/')
>>> _parse_intersphinx('https://example.com/api/objects.inv')
IntersphinxSource(source='https://example.com/api/objects.inv', base_url=None)
>>> _parse_intersphinx('c:/one')
IntersphinxSource(source='c:/one', base_url=None)
>>> _parse_intersphinx('three::c:/one::https://two/')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('::one')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('one::')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('::::')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('three ::   c:/one    :: https://two/')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('::  one')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('one    ::')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('::  ::')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option
>>> _parse_intersphinx('source::localhost')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option, providing a scheme is required for the base URL
>>> _parse_intersphinx('source ::    localhost')
Traceback (most recent call last):
...
ValueError: malformed --interspinx option, providing a scheme is required for the base URL
def _warn_deprecated_options(options: Namespace): (source)

Check the CLI options and warn on deprecated options.

_RECOGNIZED_SOURCE_HREF = (source)

Undocumented

Value
{'{mod_source_href}#l{lineno}': re.compile(r'(^https?://sourceforge\.net/)'),
 '{mod_source_href}#lines-{lineno}': re.compile(r'(^https?://bitbucket\.org/)'),
 '{mod_source_href}#L{lineno}': re.compile(r'(.*)?')}