|
pathdirs()
Convert sys.path into a list of absolute, existing, unique paths. |
|
|
|
getdoc(object)
Get the doc string or comments for an object. |
|
|
|
splitdoc(doc)
Split a doc string into a synopsis line (if any) and the rest. |
|
|
|
classname(object,
modname)
Get a class name and qualify it with a module name if necessary. |
|
|
|
isdata(object)
Check if an object is of a type that probably means it's data. |
|
|
|
replace(text,
*pairs)
Do a series of global replacements on a string. |
|
|
|
cram(text,
maxlen)
Omit part of a string if needed to make it fit in a maximum length. |
|
|
|
stripid(text)
Remove the hexadecimal id from a Python object representation. |
|
|
|
|
|
|
|
_split_list(s,
predicate)
Split sequence s via predicate, and return pair ([true], [false]). |
|
|
|
visiblename(name,
all=None)
Decide whether to show documentation on a variable. |
|
|
|
classify_class_attrs(object)
Wrap inspect.classify_class_attrs, with fixup for data descriptors. |
|
|
|
ispackage(path)
Guess whether a path refers to a package directory. |
|
|
|
|
|
synopsis(filename,
cache={ } )
Get the one-line summary out of a module file. |
|
|
|
importfile(path)
Import a Python source file or compiled file given its path. |
|
|
|
safeimport(path,
forceload=0,
cache={ } )
Import a module; handle errors; return None if the module isn't
found. |
|
|
|
pager(text)
The first time this is called, determine what kind of pager to use. |
|
|
|
getpager()
Decide what method to use for paging through text. |
|
|
|
plain(text)
Remove boldface formatting from text. |
|
|
|
pipepager(text,
cmd)
Page through text by feeding it to another program. |
|
|
|
tempfilepager(text,
cmd)
Page through text by invoking a program on a temporary file. |
|
|
|
ttypager(text)
Page through text on a text terminal. |
|
|
|
|
|
describe(thing)
Produce a short description of the given thing. |
|
|
|
locate(path,
forceload=0)
Locate an object by name or dotted path, importing as necessary. |
|
|
|
resolve(thing,
forceload=0)
Given an object or a path to an object, get the object and its name. |
|
|
|
doc(thing,
title=' Python Library Documentation: %s ' ,
forceload=0)
Display text documentation, given an object or a path to an object. |
|
|
|
writedoc(thing,
forceload=0)
Write HTML documentation to a file in the current directory. |
|
|
|
writedocs(dir,
pkgpath='
' ,
done=None)
Write out HTML documentation for all modules in a directory tree. |
|
|
|
apropos(key)
Print all the one-line module summaries that contain a substring. |
|
|
|
serve(port,
callback=None,
completer=None) |
|
|
|
gui()
Graphical interface (starts web server and pops up a control window). |
|
|
|
|
|
cli()
Command-line interface (looks at sys.argv to decide what to do). |
|
|