ClassType UrlGenerator

Known Subclasses:

Generate URL from an object name.

Nested Classes

IndexAmbiguous
The name looked for is ambiguous

Instance Methods

str

get_url(self, name)
Look for a name and return the matching URL documentation.

source code

tuple of str

get_canonical_name(self, name)
Convert an object name into a canonical name.

source code

Class Variables

_SEP_RE = re.compile(r'(?x)([a-zA-Z0-9_]+)|(\.|::|->)|(.)')

Method Details

Look for a name and return the matching URL documentation.

First look for a fully qualified name. If not found, try with partial name.

If no url exists for the given object, return None.

Parameters:

Returns: str

the URL that can be used to reach the name documentation. None if no such URL exists.

Raises:

IndexError - no object found with name
DocUrlGenerator.IndexAmbiguous - more than one object found with a non-fully qualified name; notice that this is an IndexError subclass

Convert an object name into a canonical name.

the canonical name of an object is a tuple of strings containing its name fragments, splitted on any allowed separator ('.', '::', '->').

Noise such parenthesis to indicate a function is discarded.

Parameters:

name (str) - an object name, such as os.path.prefix() or lib::foo::bar

Returns: tuple of str

the fully qualified name such ('os', 'path', 'prefix') and ('lib', 'foo', 'bar')