pydoctor.utils

module documentation

(source)

General purpose utility functions.

Function	`error`	Undocumented
Function	`findClassFromDottedName`	Looks up a class by full name.
Function	`parse_path`	Parse a str path to a `Path` object using `resolve_path()`.
Function	`parse_privacy_tuple`	Parse string like 'public:match' to a tuple (PrivacyClass.PUBLIC, 'match').
Function	`partialclass`	Bind a class to be created with some predefined __init__ arguments.
Function	`resolve_path`	Parse a given path string to a `Path` object.
Type Variable	`T`	Undocumented

Undocumented

def findClassFromDottedName(dottedname, optionname, base_class): (source) ¶

Looks up a class by full name.

Parse a str path to a Path object using resolve_path().

Watch out, prints a message and SystemExits on error!

def parse_privacy_tuple(value, opt): (source) ¶

Parse string like 'public:match*' to a tuple (PrivacyClass.PUBLIC, 'match*').

Watch out, prints a message and SystemExits on error!

Parameters
value:`str`	Undocumented
opt:`str`	Undocumented
Returns
`Tuple[model.PrivacyClass, str]`	Undocumented

def partialclass(cls, *args, **kwds): (source) ¶

Bind a class to be created with some predefined __init__ arguments.

Parse a given path string to a Path object.

The path is converted to an absolute path, as required by System.setSourceHref(). The path does not need to exist.

Watch out, prints a message and SystemExits on error!

Undocumented

Value

TypeVar('T')