| | |
- exceptions.Exception(exceptions.BaseException)
-
- ErrorDuringImport
- repr.Repr
-
- HTMLRepr
- TextRepr
- Doc
-
- HTMLDoc
- TextDoc
- Helper
- Scanner
-
- ModuleScanner
class Doc |
| | |
Methods defined here:
- docclass = fail(self, object, name=None, *args)
- docmodule = fail(self, object, name=None, *args)
- docother = fail(self, object, name=None, *args)
- docroutine = fail(self, object, name=None, *args)
- document(self, object, name=None, *args)
- Generate documentation for an object.
- fail(self, object, name=None, *args)
- Raise an exception for unimplemented types.
|
class HTMLDoc(Doc) |
| |
Formatter class for HTML documentation.
|
| |
Methods defined here:
- bigsection(self, title, *args)
- Format a section with a big heading.
- classlink(self, object, modname)
- Make a link for a class.
- docclass(self, object, name=None, mod=None, funcs={}, classes={}, *ignored)
- Produce HTML documentation for a class object.
- docmodule(self, object, name=None, mod=None, *ignored)
- Produce HTML documentation for a module object.
- docother(self, object, name=None, mod=None, *ignored)
- Produce HTML documentation for a data object.
- docroutine(self, object, name=None, mod=None, funcs={}, classes={}, methods={}, cl=None)
- Produce HTML documentation for a function or method object.
- escape(self, text) from HTMLRepr
- formattree(self, tree, modname, parent=None)
- Produce HTML for a class tree as given by inspect.getclasstree().
- formatvalue(self, object)
- Format an argument default value as text.
- grey(self, text)
- heading(self, title, fgcol, bgcol, extras='')
- Format a page heading.
- index(self, name, dir, shadowed=None)
- Generate an HTML index for a directory of modules.
- markup(self, text, escape=None, funcs={}, classes={}, methods={})
- Mark up some plain text, given a context of symbols to look for.
some simple tags are defined:
NAME - creates a link for module named NAME
NAME - creates a link LINK with tag NAME
Each context dictionary maps object names to anchor names.
- modpkglink(self, (name, path, ispackage, shadowed))
- Make a link for a module or package to display in an index.
- modulelink(self, object)
- Make a link for a module.
- multicolumn(self, list, format, cols=4)
- Format a list of items into a multi-column list.
- namelink(self, name, *dicts)
- Make a link for an identifier, given name-to-URL mappings.
- page(self, title, contents)
- Format an HTML page.
- preformat(self, text)
- Format literal preformatted text.
- repr(self, object) from HTMLRepr
- section(self, title, fgcol, bgcol, contents, width=6, prelude='', marginalia=None, gap=' ')
- Format a section with a heading.
Methods inherited from Doc:
- document(self, object, name=None, *args)
- Generate documentation for an object.
- fail(self, object, name=None, *args)
- Raise an exception for unimplemented types.
|
class HTMLRepr(repr.Repr) |
| |
Class for safely making an HTML representation of a Python object.
|
| |
Methods defined here:
- __init__(self)
- escape(self, text)
- repr(self, object)
- repr1(self, x, level)
- repr_instance(self, x, level)
- repr_str = repr_string(self, x, level)
- repr_string(self, x, level)
- repr_unicode = repr_string(self, x, level)
Methods inherited from repr.Repr:
- repr_array(self, x, level)
- repr_deque(self, x, level)
- repr_dict(self, x, level)
- repr_frozenset(self, x, level)
- repr_list(self, x, level)
- repr_long(self, x, level)
- repr_set(self, x, level)
- repr_tuple(self, x, level)
|
class Helper |
| | |
Methods defined here:
- __call__(self, request=None)
- __init__(self, input, output)
- __repr__(self)
- help(self, request)
- interact(self)
- intro(self)
- list(self, items, columns=4, width=80)
- listkeywords(self)
- listmodules(self, key='')
- listtopics(self)
- showtopic(self, topic)
Data and other attributes defined here:
- keywords = {'and': 'BOOLEAN', 'assert': ('ref/assert', ''), 'break': ('ref/break', 'while for'), 'class': ('ref/class', 'CLASSES SPECIALMETHODS'), 'continue': ('ref/continue', 'while for'), 'def': ('ref/function', ''), 'del': ('ref/del', 'BASICMETHODS'), 'elif': 'if', 'else': ('ref/if', 'while for'), 'except': 'try', ...}
- topics = {'ASSERTION': 'assert', 'ASSIGNMENT': ('ref/assignment', 'AUGMENTEDASSIGNMENT'), 'ATTRIBUTEMETHODS': ('ref/attribute-access', 'ATTRIBUTES SPECIALMETHODS'), 'ATTRIBUTES': ('ref/attribute-references', 'getattr hasattr setattr ATTRIBUTEMETHODS'), 'AUGMENTEDASSIGNMENT': ('ref/augassign', 'NUMBERMETHODS'), 'BACKQUOTES': ('ref/string-conversions', 'repr str STRINGS LITERALS'), 'BASICMETHODS': ('ref/customization', 'cmp hash repr str SPECIALMETHODS'), 'BINARY': ('ref/binary', 'EXPRESSIONS'), 'BITWISE': ('ref/bitwise', 'EXPRESSIONS'), 'BOOLEAN': ('ref/Booleans', 'EXPRESSIONS TRUTHVALUE'), ...}
|
class TextDoc(Doc) |
| |
Formatter class for text documentation.
|
| |
Methods defined here:
- bold(self, text)
- Format a string in bold by overstriking.
- docclass(self, object, name=None, mod=None)
- Produce text documentation for a given class object.
- docmodule(self, object, name=None, mod=None)
- Produce text documentation for a given module object.
- docother(self, object, name=None, mod=None, maxlen=None, doc=None)
- Produce text documentation for a data object.
- docroutine(self, object, name=None, mod=None, cl=None)
- Produce text documentation for a function or method object.
- formattree(self, tree, modname, parent=None, prefix='')
- Render in text a class tree as returned by inspect.getclasstree().
- formatvalue(self, object)
- Format an argument default value as text.
- indent(self, text, prefix=' ')
- Indent text by prepending a given prefix to each line.
- markup(self, text)
- remove markup tags.
- repr(self, x) from TextRepr
- section(self, title, contents)
- Format a section with a given heading.
Methods inherited from Doc:
- document(self, object, name=None, *args)
- Generate documentation for an object.
- fail(self, object, name=None, *args)
- Raise an exception for unimplemented types.
|
class TextRepr(repr.Repr) |
| |
Class for safely making a text representation of a Python object.
|
| |
Methods defined here:
- __init__(self)
- repr1(self, x, level)
- repr_instance(self, x, level)
- repr_str = repr_string(self, x, level)
- repr_string(self, x, level)
Methods inherited from repr.Repr:
- repr(self, x)
- repr_array(self, x, level)
- repr_deque(self, x, level)
- repr_dict(self, x, level)
- repr_frozenset(self, x, level)
- repr_list(self, x, level)
- repr_long(self, x, level)
- repr_set(self, x, level)
- repr_tuple(self, x, level)
| |