Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python |
Guido van Rossum | fce538c | 2002-08-06 17:29:38 +0000 | [diff] [blame] | 2 | # -*- coding: Latin-1 -*- |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 3 | """Generate Python documentation in HTML or text for interactive use. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 4 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 5 | In the Python interpreter, do "from pydoc import help" to provide online |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 6 | help. Calling help(thing) on a Python object documents the object. |
| 7 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 8 | Or, at the shell command line outside of Python: |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 9 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 10 | Run "pydoc <name>" to show documentation on something. <name> may be |
| 11 | the name of a function, module, package, or a dotted reference to a |
| 12 | class or function within a module or module in a package. If the |
| 13 | argument contains a path segment delimiter (e.g. slash on Unix, |
| 14 | backslash on Windows) it is treated as the path to a Python source file. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 15 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 16 | Run "pydoc -k <keyword>" to search for a keyword in the synopsis lines |
| 17 | of all available modules. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 18 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 19 | Run "pydoc -p <port>" to start an HTTP server on a given port on the |
| 20 | local machine to generate documentation web pages. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 21 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 22 | For platforms without a command line, "pydoc -g" starts the HTTP server |
| 23 | and also pops up a little window for controlling it. |
| 24 | |
| 25 | Run "pydoc -w <name>" to write out the HTML documentation for a module |
| 26 | to a file named "<name>.html". |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 27 | |
| 28 | Module docs for core modules are assumed to be in |
| 29 | |
| 30 | http://www.python.org/doc/current/lib/ |
| 31 | |
| 32 | This can be overridden by setting the PYTHONDOCS environment variable |
| 33 | to a different URL or to a local directory containing the Library |
| 34 | Reference Manual pages. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 35 | """ |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 36 | |
| 37 | __author__ = "Ka-Ping Yee <ping@lfw.org>" |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 38 | __date__ = "26 February 2001" |
Ka-Ping Yee | 09d7d9a | 2001-02-27 22:43:48 +0000 | [diff] [blame] | 39 | __version__ = "$Revision$" |
Ka-Ping Yee | 5e2b173 | 2001-02-27 23:35:09 +0000 | [diff] [blame] | 40 | __credits__ = """Guido van Rossum, for an excellent programming language. |
| 41 | Tommy Burnette, the original creator of manpy. |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 42 | Paul Prescod, for all his work on onlinehelp. |
| 43 | Richard Chamberlain, for the first implementation of textdoc. |
| 44 | |
Ka-Ping Yee | 5e2b173 | 2001-02-27 23:35:09 +0000 | [diff] [blame] | 45 | Mynd you, møøse bites Kan be pretty nasti...""" |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 46 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 47 | # Known bugs that can't be fixed here: |
| 48 | # - imp.load_module() cannot be prevented from clobbering existing |
| 49 | # loaded modules, so calling synopsis() on a binary module file |
| 50 | # changes the contents of any existing module with the same name. |
| 51 | # - If the __file__ attribute on a module is a relative path and |
| 52 | # the current directory is changed with os.chdir(), an incorrect |
| 53 | # path will be displayed. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 54 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 55 | import sys, imp, os, re, types, inspect, __builtin__ |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 56 | from repr import Repr |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 57 | from string import expandtabs, find, join, lower, split, strip, rfind, rstrip |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 58 | from collections import deque |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 59 | |
| 60 | # --------------------------------------------------------- common routines |
| 61 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 62 | def pathdirs(): |
| 63 | """Convert sys.path into a list of absolute, existing, unique paths.""" |
| 64 | dirs = [] |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 65 | normdirs = [] |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 66 | for dir in sys.path: |
| 67 | dir = os.path.abspath(dir or '.') |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 68 | normdir = os.path.normcase(dir) |
| 69 | if normdir not in normdirs and os.path.isdir(dir): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 70 | dirs.append(dir) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 71 | normdirs.append(normdir) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 72 | return dirs |
| 73 | |
| 74 | def getdoc(object): |
| 75 | """Get the doc string or comments for an object.""" |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 76 | result = inspect.getdoc(object) or inspect.getcomments(object) |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 77 | return result and re.sub('^ *\n', '', rstrip(result)) or '' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 78 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 79 | def splitdoc(doc): |
| 80 | """Split a doc string into a synopsis line (if any) and the rest.""" |
| 81 | lines = split(strip(doc), '\n') |
| 82 | if len(lines) == 1: |
| 83 | return lines[0], '' |
| 84 | elif len(lines) >= 2 and not rstrip(lines[1]): |
| 85 | return lines[0], join(lines[2:], '\n') |
| 86 | return '', join(lines, '\n') |
| 87 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 88 | def classname(object, modname): |
| 89 | """Get a class name and qualify it with a module name if necessary.""" |
| 90 | name = object.__name__ |
| 91 | if object.__module__ != modname: |
| 92 | name = object.__module__ + '.' + name |
| 93 | return name |
| 94 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 95 | def isdata(object): |
| 96 | """Check if an object is of a type that probably means it's data.""" |
| 97 | return not (inspect.ismodule(object) or inspect.isclass(object) or |
| 98 | inspect.isroutine(object) or inspect.isframe(object) or |
| 99 | inspect.istraceback(object) or inspect.iscode(object)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 100 | |
| 101 | def replace(text, *pairs): |
| 102 | """Do a series of global replacements on a string.""" |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 103 | while pairs: |
| 104 | text = join(split(text, pairs[0]), pairs[1]) |
| 105 | pairs = pairs[2:] |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 106 | return text |
| 107 | |
| 108 | def cram(text, maxlen): |
| 109 | """Omit part of a string if needed to make it fit in a maximum length.""" |
| 110 | if len(text) > maxlen: |
Raymond Hettinger | fca3bb6 | 2002-10-21 04:44:11 +0000 | [diff] [blame] | 111 | pre = max(0, (maxlen-3)//2) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 112 | post = max(0, maxlen-3-pre) |
| 113 | return text[:pre] + '...' + text[len(text)-post:] |
| 114 | return text |
| 115 | |
Brett Cannon | 84601f1 | 2004-06-19 01:22:48 +0000 | [diff] [blame] | 116 | _re_stripid = re.compile(r' at 0x[0-9a-f]{6,16}(>+)$', re.IGNORECASE) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 117 | def stripid(text): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 118 | """Remove the hexadecimal id from a Python object representation.""" |
Brett Cannon | c6c1f47 | 2004-06-19 01:02:51 +0000 | [diff] [blame] | 119 | # The behaviour of %p is implementation-dependent in terms of case. |
| 120 | if _re_stripid.search(repr(Exception)): |
| 121 | return _re_stripid.sub(r'\1', text) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 122 | return text |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 123 | |
Brett Cannon | c6c1f47 | 2004-06-19 01:02:51 +0000 | [diff] [blame] | 124 | def _is_some_method(obj): |
| 125 | return inspect.ismethod(obj) or inspect.ismethoddescriptor(obj) |
Tim Peters | 536d226 | 2001-09-20 05:13:38 +0000 | [diff] [blame] | 126 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 127 | def allmethods(cl): |
| 128 | methods = {} |
Tim Peters | 536d226 | 2001-09-20 05:13:38 +0000 | [diff] [blame] | 129 | for key, value in inspect.getmembers(cl, _is_some_method): |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 130 | methods[key] = 1 |
| 131 | for base in cl.__bases__: |
| 132 | methods.update(allmethods(base)) # all your base are belong to us |
| 133 | for key in methods.keys(): |
| 134 | methods[key] = getattr(cl, key) |
| 135 | return methods |
| 136 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 137 | def _split_list(s, predicate): |
| 138 | """Split sequence s via predicate, and return pair ([true], [false]). |
| 139 | |
| 140 | The return value is a 2-tuple of lists, |
| 141 | ([x for x in s if predicate(x)], |
| 142 | [x for x in s if not predicate(x)]) |
| 143 | """ |
| 144 | |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 145 | yes = [] |
| 146 | no = [] |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 147 | for x in s: |
| 148 | if predicate(x): |
| 149 | yes.append(x) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 150 | else: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 151 | no.append(x) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 152 | return yes, no |
| 153 | |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 154 | def visiblename(name, all=None): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 155 | """Decide whether to show documentation on a variable.""" |
| 156 | # Certain special names are redundant. |
| 157 | if name in ['__builtins__', '__doc__', '__file__', '__path__', |
| 158 | '__module__', '__name__']: return 0 |
| 159 | # Private names are hidden, but special names are displayed. |
| 160 | if name.startswith('__') and name.endswith('__'): return 1 |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 161 | if all is not None: |
| 162 | # only document that which the programmer exported in __all__ |
| 163 | return name in all |
| 164 | else: |
| 165 | return not name.startswith('_') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 166 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 167 | # ----------------------------------------------------- module manipulation |
| 168 | |
| 169 | def ispackage(path): |
| 170 | """Guess whether a path refers to a package directory.""" |
| 171 | if os.path.isdir(path): |
| 172 | for ext in ['.py', '.pyc', '.pyo']: |
| 173 | if os.path.isfile(os.path.join(path, '__init__' + ext)): |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 174 | return True |
| 175 | return False |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 176 | |
| 177 | def synopsis(filename, cache={}): |
| 178 | """Get the one-line summary out of a module file.""" |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 179 | mtime = os.stat(filename).st_mtime |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 180 | lastupdate, result = cache.get(filename, (0, None)) |
| 181 | if lastupdate < mtime: |
| 182 | info = inspect.getmoduleinfo(filename) |
| 183 | file = open(filename) |
| 184 | if info and 'b' in info[2]: # binary modules have to be imported |
| 185 | try: module = imp.load_module('__temp__', file, filename, info[1:]) |
| 186 | except: return None |
| 187 | result = split(module.__doc__ or '', '\n')[0] |
| 188 | del sys.modules['__temp__'] |
| 189 | else: # text modules can be directly examined |
| 190 | line = file.readline() |
| 191 | while line[:1] == '#' or not strip(line): |
| 192 | line = file.readline() |
| 193 | if not line: break |
| 194 | line = strip(line) |
| 195 | if line[:4] == 'r"""': line = line[1:] |
| 196 | if line[:3] == '"""': |
| 197 | line = line[3:] |
| 198 | if line[-1:] == '\\': line = line[:-1] |
| 199 | while not strip(line): |
| 200 | line = file.readline() |
| 201 | if not line: break |
| 202 | result = strip(split(line, '"""')[0]) |
| 203 | else: result = None |
| 204 | file.close() |
| 205 | cache[filename] = (mtime, result) |
| 206 | return result |
| 207 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 208 | class ErrorDuringImport(Exception): |
| 209 | """Errors that occurred while trying to import something to document it.""" |
| 210 | def __init__(self, filename, (exc, value, tb)): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 211 | self.filename = filename |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 212 | self.exc = exc |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 213 | self.value = value |
| 214 | self.tb = tb |
| 215 | |
| 216 | def __str__(self): |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 217 | exc = self.exc |
| 218 | if type(exc) is types.ClassType: |
| 219 | exc = exc.__name__ |
| 220 | return 'problem in %s - %s: %s' % (self.filename, exc, self.value) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 221 | |
| 222 | def importfile(path): |
| 223 | """Import a Python source file or compiled file given its path.""" |
| 224 | magic = imp.get_magic() |
| 225 | file = open(path, 'r') |
| 226 | if file.read(len(magic)) == magic: |
| 227 | kind = imp.PY_COMPILED |
| 228 | else: |
| 229 | kind = imp.PY_SOURCE |
| 230 | file.close() |
| 231 | filename = os.path.basename(path) |
| 232 | name, ext = os.path.splitext(filename) |
| 233 | file = open(path, 'r') |
| 234 | try: |
| 235 | module = imp.load_module(name, file, path, (ext, 'r', kind)) |
| 236 | except: |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 237 | raise ErrorDuringImport(path, sys.exc_info()) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 238 | file.close() |
| 239 | return module |
| 240 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 241 | def safeimport(path, forceload=0, cache={}): |
| 242 | """Import a module; handle errors; return None if the module isn't found. |
| 243 | |
| 244 | If the module *is* found but an exception occurs, it's wrapped in an |
| 245 | ErrorDuringImport exception and reraised. Unlike __import__, if a |
| 246 | package path is specified, the module at the end of the path is returned, |
| 247 | not the package at the beginning. If the optional 'forceload' argument |
| 248 | is 1, we reload the module from disk (unless it's a dynamic extension).""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 249 | if forceload and path in sys.modules: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 250 | # This is the only way to be sure. Checking the mtime of the file |
| 251 | # isn't good enough (e.g. what if the module contains a class that |
| 252 | # inherits from another module that has changed?). |
| 253 | if path not in sys.builtin_module_names: |
| 254 | # Python never loads a dynamic extension a second time from the |
| 255 | # same path, even if the file is changed or missing. Deleting |
| 256 | # the entry in sys.modules doesn't help for dynamic extensions, |
| 257 | # so we're not even going to try to keep them up to date. |
| 258 | info = inspect.getmoduleinfo(sys.modules[path].__file__) |
| 259 | if info[3] != imp.C_EXTENSION: |
| 260 | cache[path] = sys.modules[path] # prevent module from clearing |
| 261 | del sys.modules[path] |
| 262 | try: |
| 263 | module = __import__(path) |
| 264 | except: |
| 265 | # Did the error occur before or after the module was found? |
| 266 | (exc, value, tb) = info = sys.exc_info() |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 267 | if path in sys.modules: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 268 | # An error occured while executing the imported module. |
| 269 | raise ErrorDuringImport(sys.modules[path].__file__, info) |
| 270 | elif exc is SyntaxError: |
| 271 | # A SyntaxError occurred before we could execute the module. |
| 272 | raise ErrorDuringImport(value.filename, info) |
| 273 | elif exc is ImportError and \ |
| 274 | split(lower(str(value)))[:2] == ['no', 'module']: |
| 275 | # The module was not found. |
| 276 | return None |
| 277 | else: |
| 278 | # Some other error occurred during the importing process. |
| 279 | raise ErrorDuringImport(path, sys.exc_info()) |
| 280 | for part in split(path, '.')[1:]: |
| 281 | try: module = getattr(module, part) |
| 282 | except AttributeError: return None |
| 283 | return module |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 284 | |
| 285 | # ---------------------------------------------------- formatter base class |
| 286 | |
| 287 | class Doc: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 288 | def document(self, object, name=None, *args): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 289 | """Generate documentation for an object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 290 | args = (object, name) + args |
Brett Cannon | 28a4f0f | 2003-06-11 23:38:55 +0000 | [diff] [blame] | 291 | # 'try' clause is to attempt to handle the possibility that inspect |
| 292 | # identifies something in a way that pydoc itself has issues handling; |
| 293 | # think 'super' and how it is a descriptor (which raises the exception |
| 294 | # by lacking a __name__ attribute) and an instance. |
| 295 | try: |
| 296 | if inspect.ismodule(object): return self.docmodule(*args) |
| 297 | if inspect.isclass(object): return self.docclass(*args) |
| 298 | if inspect.isroutine(object): return self.docroutine(*args) |
| 299 | except AttributeError: |
| 300 | pass |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 301 | return self.docother(*args) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 302 | |
| 303 | def fail(self, object, name=None, *args): |
| 304 | """Raise an exception for unimplemented types.""" |
| 305 | message = "don't know how to document object%s of type %s" % ( |
| 306 | name and ' ' + repr(name), type(object).__name__) |
| 307 | raise TypeError, message |
| 308 | |
| 309 | docmodule = docclass = docroutine = docother = fail |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 310 | |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 311 | def getdocloc(self, object): |
| 312 | """Return the location of module docs or None""" |
| 313 | |
| 314 | try: |
| 315 | file = inspect.getabsfile(object) |
| 316 | except TypeError: |
| 317 | file = '(built-in)' |
| 318 | |
| 319 | docloc = os.environ.get("PYTHONDOCS", |
| 320 | "http://www.python.org/doc/current/lib") |
| 321 | basedir = os.path.join(sys.exec_prefix, "lib", |
| 322 | "python"+sys.version[0:3]) |
| 323 | if (isinstance(object, type(os)) and |
| 324 | (object.__name__ in ('errno', 'exceptions', 'gc', 'imp', |
| 325 | 'marshal', 'posix', 'signal', 'sys', |
| 326 | 'thread', 'zipimport') or |
| 327 | (file.startswith(basedir) and |
| 328 | not file.startswith(os.path.join(basedir, 'site-packages'))))): |
Skip Montanaro | f213484 | 2004-06-07 02:40:05 +0000 | [diff] [blame] | 329 | htmlfile = "module-%s.html" % object.__name__ |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 330 | if docloc.startswith("http://"): |
Skip Montanaro | f213484 | 2004-06-07 02:40:05 +0000 | [diff] [blame] | 331 | docloc = "%s/%s" % (docloc.rstrip("/"), htmlfile) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 332 | else: |
Skip Montanaro | f213484 | 2004-06-07 02:40:05 +0000 | [diff] [blame] | 333 | docloc = os.path.join(docloc, htmlfile) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 334 | else: |
| 335 | docloc = None |
| 336 | return docloc |
| 337 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 338 | # -------------------------------------------- HTML documentation generator |
| 339 | |
| 340 | class HTMLRepr(Repr): |
| 341 | """Class for safely making an HTML representation of a Python object.""" |
| 342 | def __init__(self): |
| 343 | Repr.__init__(self) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 344 | self.maxlist = self.maxtuple = 20 |
| 345 | self.maxdict = 10 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 346 | self.maxstring = self.maxother = 100 |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 347 | |
| 348 | def escape(self, text): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 349 | return replace(text, '&', '&', '<', '<', '>', '>') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 350 | |
| 351 | def repr(self, object): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 352 | return Repr.repr(self, object) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 353 | |
| 354 | def repr1(self, x, level): |
Skip Montanaro | 0fe8fce | 2003-06-27 15:45:41 +0000 | [diff] [blame] | 355 | if hasattr(type(x), '__name__'): |
| 356 | methodname = 'repr_' + join(split(type(x).__name__), '_') |
| 357 | if hasattr(self, methodname): |
| 358 | return getattr(self, methodname)(x, level) |
| 359 | return self.escape(cram(stripid(repr(x)), self.maxother)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 360 | |
| 361 | def repr_string(self, x, level): |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 362 | test = cram(x, self.maxstring) |
| 363 | testrepr = repr(test) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 364 | if '\\' in test and '\\' not in replace(testrepr, r'\\', ''): |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 365 | # Backslashes are only literal in the string and are never |
| 366 | # needed to make any special characters, so show a raw string. |
| 367 | return 'r' + testrepr[0] + self.escape(test) + testrepr[0] |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 368 | return re.sub(r'((\\[\\abfnrtv\'"]|\\[0-9]..|\\x..|\\u....)+)', |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 369 | r'<font color="#c040c0">\1</font>', |
| 370 | self.escape(testrepr)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 371 | |
Skip Montanaro | df70878 | 2002-03-07 22:58:02 +0000 | [diff] [blame] | 372 | repr_str = repr_string |
| 373 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 374 | def repr_instance(self, x, level): |
| 375 | try: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 376 | return self.escape(cram(stripid(repr(x)), self.maxstring)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 377 | except: |
| 378 | return self.escape('<%s instance>' % x.__class__.__name__) |
| 379 | |
| 380 | repr_unicode = repr_string |
| 381 | |
| 382 | class HTMLDoc(Doc): |
| 383 | """Formatter class for HTML documentation.""" |
| 384 | |
| 385 | # ------------------------------------------- HTML formatting utilities |
| 386 | |
| 387 | _repr_instance = HTMLRepr() |
| 388 | repr = _repr_instance.repr |
| 389 | escape = _repr_instance.escape |
| 390 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 391 | def page(self, title, contents): |
| 392 | """Format an HTML page.""" |
| 393 | return ''' |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 394 | <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 395 | <html><head><title>Python: %s</title> |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 396 | </head><body bgcolor="#f0f0f8"> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 397 | %s |
| 398 | </body></html>''' % (title, contents) |
| 399 | |
| 400 | def heading(self, title, fgcol, bgcol, extras=''): |
| 401 | """Format a page heading.""" |
| 402 | return ''' |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 403 | <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 404 | <tr bgcolor="%s"> |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 405 | <td valign=bottom> <br> |
| 406 | <font color="%s" face="helvetica, arial"> <br>%s</font></td |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 407 | ><td align=right valign=bottom |
Ka-Ping Yee | 987ec90 | 2001-03-23 13:35:45 +0000 | [diff] [blame] | 408 | ><font color="%s" face="helvetica, arial">%s</font></td></tr></table> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 409 | ''' % (bgcol, fgcol, title, fgcol, extras or ' ') |
| 410 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 411 | def section(self, title, fgcol, bgcol, contents, width=6, |
| 412 | prelude='', marginalia=None, gap=' '): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 413 | """Format a section with a heading.""" |
| 414 | if marginalia is None: |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 415 | marginalia = '<tt>' + ' ' * width + '</tt>' |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 416 | result = '''<p> |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 417 | <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 418 | <tr bgcolor="%s"> |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 419 | <td colspan=3 valign=bottom> <br> |
| 420 | <font color="%s" face="helvetica, arial">%s</font></td></tr> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 421 | ''' % (bgcol, fgcol, title) |
| 422 | if prelude: |
| 423 | result = result + ''' |
Ka-Ping Yee | 987ec90 | 2001-03-23 13:35:45 +0000 | [diff] [blame] | 424 | <tr bgcolor="%s"><td rowspan=2>%s</td> |
| 425 | <td colspan=2>%s</td></tr> |
| 426 | <tr><td>%s</td>''' % (bgcol, marginalia, prelude, gap) |
| 427 | else: |
| 428 | result = result + ''' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 429 | <tr><td bgcolor="%s">%s</td><td>%s</td>''' % (bgcol, marginalia, gap) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 430 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 431 | return result + '\n<td width="100%%">%s</td></tr></table>' % contents |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 432 | |
| 433 | def bigsection(self, title, *args): |
| 434 | """Format a section with a big heading.""" |
| 435 | title = '<big><strong>%s</strong></big>' % title |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 436 | return self.section(title, *args) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 437 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 438 | def preformat(self, text): |
| 439 | """Format literal preformatted text.""" |
| 440 | text = self.escape(expandtabs(text)) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 441 | return replace(text, '\n\n', '\n \n', '\n\n', '\n \n', |
| 442 | ' ', ' ', '\n', '<br>\n') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 443 | |
| 444 | def multicolumn(self, list, format, cols=4): |
| 445 | """Format a list of items into a multi-column list.""" |
| 446 | result = '' |
| 447 | rows = (len(list)+cols-1)/cols |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 448 | for col in range(cols): |
| 449 | result = result + '<td width="%d%%" valign=top>' % (100/cols) |
| 450 | for i in range(rows*col, rows*col+rows): |
| 451 | if i < len(list): |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 452 | result = result + format(list[i]) + '<br>\n' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 453 | result = result + '</td>' |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 454 | return '<table width="100%%" summary="list"><tr>%s</tr></table>' % result |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 455 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 456 | def grey(self, text): return '<font color="#909090">%s</font>' % text |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 457 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 458 | def namelink(self, name, *dicts): |
| 459 | """Make a link for an identifier, given name-to-URL mappings.""" |
| 460 | for dict in dicts: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 461 | if name in dict: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 462 | return '<a href="%s">%s</a>' % (dict[name], name) |
| 463 | return name |
| 464 | |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 465 | def classlink(self, object, modname): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 466 | """Make a link for a class.""" |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 467 | name, module = object.__name__, sys.modules.get(object.__module__) |
| 468 | if hasattr(module, name) and getattr(module, name) is object: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 469 | return '<a href="%s.html#%s">%s</a>' % ( |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 470 | module.__name__, name, classname(object, modname)) |
| 471 | return classname(object, modname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 472 | |
| 473 | def modulelink(self, object): |
| 474 | """Make a link for a module.""" |
| 475 | return '<a href="%s.html">%s</a>' % (object.__name__, object.__name__) |
| 476 | |
| 477 | def modpkglink(self, (name, path, ispackage, shadowed)): |
| 478 | """Make a link for a module or package to display in an index.""" |
| 479 | if shadowed: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 480 | return self.grey(name) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 481 | if path: |
| 482 | url = '%s.%s.html' % (path, name) |
| 483 | else: |
| 484 | url = '%s.html' % name |
| 485 | if ispackage: |
| 486 | text = '<strong>%s</strong> (package)' % name |
| 487 | else: |
| 488 | text = name |
| 489 | return '<a href="%s">%s</a>' % (url, text) |
| 490 | |
| 491 | def markup(self, text, escape=None, funcs={}, classes={}, methods={}): |
| 492 | """Mark up some plain text, given a context of symbols to look for. |
| 493 | Each context dictionary maps object names to anchor names.""" |
| 494 | escape = escape or self.escape |
| 495 | results = [] |
| 496 | here = 0 |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 497 | pattern = re.compile(r'\b((http|ftp)://\S+[\w/]|' |
| 498 | r'RFC[- ]?(\d+)|' |
Ka-Ping Yee | f78a81b | 2001-03-27 08:13:42 +0000 | [diff] [blame] | 499 | r'PEP[- ]?(\d+)|' |
Neil Schemenauer | d69711c | 2002-03-24 23:02:07 +0000 | [diff] [blame] | 500 | r'(self\.)?(\w+))') |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 501 | while True: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 502 | match = pattern.search(text, here) |
| 503 | if not match: break |
| 504 | start, end = match.span() |
| 505 | results.append(escape(text[here:start])) |
| 506 | |
Ka-Ping Yee | f78a81b | 2001-03-27 08:13:42 +0000 | [diff] [blame] | 507 | all, scheme, rfc, pep, selfdot, name = match.groups() |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 508 | if scheme: |
Neil Schemenauer | cddc1a0 | 2002-03-24 23:11:21 +0000 | [diff] [blame] | 509 | url = escape(all).replace('"', '"') |
| 510 | results.append('<a href="%s">%s</a>' % (url, url)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 511 | elif rfc: |
Ka-Ping Yee | f78a81b | 2001-03-27 08:13:42 +0000 | [diff] [blame] | 512 | url = 'http://www.rfc-editor.org/rfc/rfc%d.txt' % int(rfc) |
| 513 | results.append('<a href="%s">%s</a>' % (url, escape(all))) |
| 514 | elif pep: |
| 515 | url = 'http://www.python.org/peps/pep-%04d.html' % int(pep) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 516 | results.append('<a href="%s">%s</a>' % (url, escape(all))) |
| 517 | elif text[end:end+1] == '(': |
| 518 | results.append(self.namelink(name, methods, funcs, classes)) |
| 519 | elif selfdot: |
| 520 | results.append('self.<strong>%s</strong>' % name) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 521 | else: |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 522 | results.append(self.namelink(name, classes)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 523 | here = end |
| 524 | results.append(escape(text[here:])) |
| 525 | return join(results, '') |
| 526 | |
| 527 | # ---------------------------------------------- type-specific routines |
| 528 | |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 529 | def formattree(self, tree, modname, parent=None): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 530 | """Produce HTML for a class tree as given by inspect.getclasstree().""" |
| 531 | result = '' |
| 532 | for entry in tree: |
| 533 | if type(entry) is type(()): |
| 534 | c, bases = entry |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 535 | result = result + '<dt><font face="helvetica, arial">' |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 536 | result = result + self.classlink(c, modname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 537 | if bases and bases != (parent,): |
| 538 | parents = [] |
| 539 | for base in bases: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 540 | parents.append(self.classlink(base, modname)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 541 | result = result + '(' + join(parents, ', ') + ')' |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 542 | result = result + '\n</font></dt>' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 543 | elif type(entry) is type([]): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 544 | result = result + '<dd>\n%s</dd>\n' % self.formattree( |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 545 | entry, modname, c) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 546 | return '<dl>\n%s</dl>\n' % result |
| 547 | |
Tim Peters | 8dd7ade | 2001-10-18 19:56:17 +0000 | [diff] [blame] | 548 | def docmodule(self, object, name=None, mod=None, *ignored): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 549 | """Produce HTML documentation for a module object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 550 | name = object.__name__ # ignore the passed-in name |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 551 | try: |
| 552 | all = object.__all__ |
| 553 | except AttributeError: |
| 554 | all = None |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 555 | parts = split(name, '.') |
| 556 | links = [] |
| 557 | for i in range(len(parts)-1): |
| 558 | links.append( |
| 559 | '<a href="%s.html"><font color="#ffffff">%s</font></a>' % |
| 560 | (join(parts[:i+1], '.'), parts[i])) |
| 561 | linkedname = join(links + parts[-1:], '.') |
| 562 | head = '<big><big><strong>%s</strong></big></big>' % linkedname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 563 | try: |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 564 | path = inspect.getabsfile(object) |
Ka-Ping Yee | 6191a23 | 2001-04-13 15:00:27 +0000 | [diff] [blame] | 565 | url = path |
| 566 | if sys.platform == 'win32': |
| 567 | import nturl2path |
| 568 | url = nturl2path.pathname2url(path) |
| 569 | filelink = '<a href="file:%s">%s</a>' % (url, path) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 570 | except TypeError: |
| 571 | filelink = '(built-in)' |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 572 | info = [] |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 573 | if hasattr(object, '__version__'): |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 574 | version = str(object.__version__) |
Ka-Ping Yee | 40c4991 | 2001-02-27 22:46:01 +0000 | [diff] [blame] | 575 | if version[:11] == '$' + 'Revision: ' and version[-1:] == '$': |
| 576 | version = strip(version[11:-1]) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 577 | info.append('version %s' % self.escape(version)) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 578 | if hasattr(object, '__date__'): |
| 579 | info.append(self.escape(str(object.__date__))) |
| 580 | if info: |
| 581 | head = head + ' (%s)' % join(info, ', ') |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 582 | docloc = self.getdocloc(object) |
| 583 | if docloc is not None: |
| 584 | docloc = '<br><a href="%(docloc)s">Module Docs</a>' % locals() |
| 585 | else: |
| 586 | docloc = '' |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 587 | result = self.heading( |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 588 | head, '#ffffff', '#7799ee', |
| 589 | '<a href=".">index</a><br>' + filelink + docloc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 590 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 591 | modules = inspect.getmembers(object, inspect.ismodule) |
| 592 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 593 | classes, cdict = [], {} |
| 594 | for key, value in inspect.getmembers(object, inspect.isclass): |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 595 | if (inspect.getmodule(value) or object) is object: |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 596 | if visiblename(key, all): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 597 | classes.append((key, value)) |
| 598 | cdict[key] = cdict[value] = '#' + key |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 599 | for key, value in classes: |
| 600 | for base in value.__bases__: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 601 | key, modname = base.__name__, base.__module__ |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 602 | module = sys.modules.get(modname) |
| 603 | if modname != name and module and hasattr(module, key): |
| 604 | if getattr(module, key) is base: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 605 | if not key in cdict: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 606 | cdict[key] = cdict[base] = modname + '.html#' + key |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 607 | funcs, fdict = [], {} |
| 608 | for key, value in inspect.getmembers(object, inspect.isroutine): |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 609 | if inspect.isbuiltin(value) or inspect.getmodule(value) is object: |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 610 | if visiblename(key, all): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 611 | funcs.append((key, value)) |
| 612 | fdict[key] = '#-' + key |
| 613 | if inspect.isfunction(value): fdict[value] = fdict[key] |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 614 | data = [] |
| 615 | for key, value in inspect.getmembers(object, isdata): |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 616 | if visiblename(key, all): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 617 | data.append((key, value)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 618 | |
| 619 | doc = self.markup(getdoc(object), self.preformat, fdict, cdict) |
| 620 | doc = doc and '<tt>%s</tt>' % doc |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 621 | result = result + '<p>%s</p>\n' % doc |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 622 | |
| 623 | if hasattr(object, '__path__'): |
| 624 | modpkgs = [] |
| 625 | modnames = [] |
| 626 | for file in os.listdir(object.__path__[0]): |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 627 | path = os.path.join(object.__path__[0], file) |
| 628 | modname = inspect.getmodulename(file) |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 629 | if modname != '__init__': |
| 630 | if modname and modname not in modnames: |
| 631 | modpkgs.append((modname, name, 0, 0)) |
| 632 | modnames.append(modname) |
| 633 | elif ispackage(path): |
| 634 | modpkgs.append((file, name, 1, 0)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 635 | modpkgs.sort() |
| 636 | contents = self.multicolumn(modpkgs, self.modpkglink) |
| 637 | result = result + self.bigsection( |
| 638 | 'Package Contents', '#ffffff', '#aa55cc', contents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 639 | elif modules: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 640 | contents = self.multicolumn( |
| 641 | modules, lambda (key, value), s=self: s.modulelink(value)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 642 | result = result + self.bigsection( |
| 643 | 'Modules', '#fffff', '#aa55cc', contents) |
| 644 | |
| 645 | if classes: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 646 | classlist = map(lambda (key, value): value, classes) |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 647 | contents = [ |
| 648 | self.formattree(inspect.getclasstree(classlist, 1), name)] |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 649 | for key, value in classes: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 650 | contents.append(self.document(value, key, name, fdict, cdict)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 651 | result = result + self.bigsection( |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 652 | 'Classes', '#ffffff', '#ee77aa', join(contents)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 653 | if funcs: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 654 | contents = [] |
| 655 | for key, value in funcs: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 656 | contents.append(self.document(value, key, name, fdict, cdict)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 657 | result = result + self.bigsection( |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 658 | 'Functions', '#ffffff', '#eeaa77', join(contents)) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 659 | if data: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 660 | contents = [] |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 661 | for key, value in data: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 662 | contents.append(self.document(value, key)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 663 | result = result + self.bigsection( |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 664 | 'Data', '#ffffff', '#55aa55', join(contents, '<br>\n')) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 665 | if hasattr(object, '__author__'): |
| 666 | contents = self.markup(str(object.__author__), self.preformat) |
| 667 | result = result + self.bigsection( |
| 668 | 'Author', '#ffffff', '#7799ee', contents) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 669 | if hasattr(object, '__credits__'): |
| 670 | contents = self.markup(str(object.__credits__), self.preformat) |
| 671 | result = result + self.bigsection( |
| 672 | 'Credits', '#ffffff', '#7799ee', contents) |
| 673 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 674 | return result |
| 675 | |
Tim Peters | 8dd7ade | 2001-10-18 19:56:17 +0000 | [diff] [blame] | 676 | def docclass(self, object, name=None, mod=None, funcs={}, classes={}, |
| 677 | *ignored): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 678 | """Produce HTML documentation for a class object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 679 | realname = object.__name__ |
| 680 | name = name or realname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 681 | bases = object.__bases__ |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 682 | |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 683 | contents = [] |
| 684 | push = contents.append |
| 685 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 686 | # Cute little class to pump out a horizontal rule between sections. |
| 687 | class HorizontalRule: |
| 688 | def __init__(self): |
| 689 | self.needone = 0 |
| 690 | def maybe(self): |
| 691 | if self.needone: |
| 692 | push('<hr>\n') |
| 693 | self.needone = 1 |
| 694 | hr = HorizontalRule() |
| 695 | |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 696 | # List the mro, if non-trivial. |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 697 | mro = deque(inspect.getmro(object)) |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 698 | if len(mro) > 2: |
| 699 | hr.maybe() |
| 700 | push('<dl><dt>Method resolution order:</dt>\n') |
| 701 | for base in mro: |
| 702 | push('<dd>%s</dd>\n' % self.classlink(base, |
| 703 | object.__module__)) |
| 704 | push('</dl>\n') |
| 705 | |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 706 | def spill(msg, attrs, predicate): |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 707 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 708 | if ok: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 709 | hr.maybe() |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 710 | push(msg) |
| 711 | for name, kind, homecls, value in ok: |
| 712 | push(self.document(getattr(object, name), name, mod, |
| 713 | funcs, classes, mdict, object)) |
| 714 | push('\n') |
| 715 | return attrs |
| 716 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 717 | def spillproperties(msg, attrs, predicate): |
| 718 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 719 | if ok: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 720 | hr.maybe() |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 721 | push(msg) |
| 722 | for name, kind, homecls, value in ok: |
Tim Peters | 3e767d1 | 2001-09-25 00:01:06 +0000 | [diff] [blame] | 723 | push('<dl><dt><strong>%s</strong></dt>\n' % name) |
| 724 | if value.__doc__ is not None: |
| 725 | doc = self.markup(value.__doc__, self.preformat, |
| 726 | funcs, classes, mdict) |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 727 | push('<dd><tt>%s</tt></dd>\n' % doc) |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 728 | for attr, tag in [('fget', '<em>get</em>'), |
| 729 | ('fset', '<em>set</em>'), |
| 730 | ('fdel', '<em>delete</em>')]: |
Tim Peters | 3e767d1 | 2001-09-25 00:01:06 +0000 | [diff] [blame] | 731 | func = getattr(value, attr) |
| 732 | if func is not None: |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 733 | base = self.document(func, tag, mod, |
Tim Peters | 3e767d1 | 2001-09-25 00:01:06 +0000 | [diff] [blame] | 734 | funcs, classes, mdict, object) |
| 735 | push('<dd>%s</dd>\n' % base) |
| 736 | push('</dl>\n') |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 737 | return attrs |
| 738 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 739 | def spilldata(msg, attrs, predicate): |
| 740 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 741 | if ok: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 742 | hr.maybe() |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 743 | push(msg) |
| 744 | for name, kind, homecls, value in ok: |
| 745 | base = self.docother(getattr(object, name), name, mod) |
Martin v. Löwis | e59e2ba | 2003-05-03 09:09:02 +0000 | [diff] [blame] | 746 | if callable(value) or inspect.isdatadescriptor(value): |
Guido van Rossum | 5e355b2 | 2002-05-21 20:56:15 +0000 | [diff] [blame] | 747 | doc = getattr(value, "__doc__", None) |
| 748 | else: |
| 749 | doc = None |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 750 | if doc is None: |
| 751 | push('<dl><dt>%s</dl>\n' % base) |
| 752 | else: |
| 753 | doc = self.markup(getdoc(value), self.preformat, |
| 754 | funcs, classes, mdict) |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 755 | doc = '<dd><tt>%s</tt>' % doc |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 756 | push('<dl><dt>%s%s</dl>\n' % (base, doc)) |
| 757 | push('\n') |
| 758 | return attrs |
| 759 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 760 | attrs = filter(lambda (name, kind, cls, value): visiblename(name), |
| 761 | inspect.classify_class_attrs(object)) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 762 | mdict = {} |
| 763 | for key, kind, homecls, value in attrs: |
| 764 | mdict[key] = anchor = '#' + name + '-' + key |
| 765 | value = getattr(object, key) |
| 766 | try: |
| 767 | # The value may not be hashable (e.g., a data attr with |
| 768 | # a dict or list value). |
| 769 | mdict[value] = anchor |
| 770 | except TypeError: |
| 771 | pass |
| 772 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 773 | while attrs: |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 774 | if mro: |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 775 | thisclass = mro.popleft() |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 776 | else: |
| 777 | thisclass = attrs[0][2] |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 778 | attrs, inherited = _split_list(attrs, lambda t: t[2] is thisclass) |
| 779 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 780 | if thisclass is __builtin__.object: |
| 781 | attrs = inherited |
| 782 | continue |
| 783 | elif thisclass is object: |
| 784 | tag = 'defined here' |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 785 | else: |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 786 | tag = 'inherited from %s' % self.classlink(thisclass, |
| 787 | object.__module__) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 788 | tag += ':<br>\n' |
| 789 | |
| 790 | # Sort attrs by name. |
Raymond Hettinger | 6b59f5f | 2003-10-16 05:53:16 +0000 | [diff] [blame] | 791 | attrs.sort(key=lambda t: t[0]) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 792 | |
| 793 | # Pump out the attrs, segregated by kind. |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 794 | attrs = spill('Methods %s' % tag, attrs, |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 795 | lambda t: t[1] == 'method') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 796 | attrs = spill('Class methods %s' % tag, attrs, |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 797 | lambda t: t[1] == 'class method') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 798 | attrs = spill('Static methods %s' % tag, attrs, |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 799 | lambda t: t[1] == 'static method') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 800 | attrs = spillproperties('Properties %s' % tag, attrs, |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 801 | lambda t: t[1] == 'property') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 802 | attrs = spilldata('Data and other attributes %s' % tag, attrs, |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 803 | lambda t: t[1] == 'data') |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 804 | assert attrs == [] |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 805 | attrs = inherited |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 806 | |
| 807 | contents = ''.join(contents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 808 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 809 | if name == realname: |
| 810 | title = '<a name="%s">class <strong>%s</strong></a>' % ( |
| 811 | name, realname) |
| 812 | else: |
| 813 | title = '<strong>%s</strong> = <a name="%s">class %s</a>' % ( |
| 814 | name, name, realname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 815 | if bases: |
| 816 | parents = [] |
| 817 | for base in bases: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 818 | parents.append(self.classlink(base, object.__module__)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 819 | title = title + '(%s)' % join(parents, ', ') |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 820 | doc = self.markup(getdoc(object), self.preformat, funcs, classes, mdict) |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 821 | doc = doc and '<tt>%s<br> </tt>' % doc |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 822 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 823 | return self.section(title, '#000000', '#ffc8d8', contents, 3, doc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 824 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 825 | def formatvalue(self, object): |
| 826 | """Format an argument default value as text.""" |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 827 | return self.grey('=' + self.repr(object)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 828 | |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 829 | def docroutine(self, object, name=None, mod=None, |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 830 | funcs={}, classes={}, methods={}, cl=None): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 831 | """Produce HTML documentation for a function or method object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 832 | realname = object.__name__ |
| 833 | name = name or realname |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 834 | anchor = (cl and cl.__name__ or '') + '-' + name |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 835 | note = '' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 836 | skipdocs = 0 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 837 | if inspect.ismethod(object): |
Ka-Ping Yee | 6dcfa38 | 2001-04-12 20:27:31 +0000 | [diff] [blame] | 838 | imclass = object.im_class |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 839 | if cl: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 840 | if imclass is not cl: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 841 | note = ' from ' + self.classlink(imclass, mod) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 842 | else: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 843 | if object.im_self: |
| 844 | note = ' method of %s instance' % self.classlink( |
| 845 | object.im_self.__class__, mod) |
| 846 | else: |
| 847 | note = ' unbound %s method' % self.classlink(imclass,mod) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 848 | object = object.im_func |
| 849 | |
| 850 | if name == realname: |
| 851 | title = '<a name="%s"><strong>%s</strong></a>' % (anchor, realname) |
| 852 | else: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 853 | if (cl and realname in cl.__dict__ and |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 854 | cl.__dict__[realname] is object): |
Ka-Ping Yee | e280c06 | 2001-03-23 14:05:53 +0000 | [diff] [blame] | 855 | reallink = '<a href="#%s">%s</a>' % ( |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 856 | cl.__name__ + '-' + realname, realname) |
| 857 | skipdocs = 1 |
| 858 | else: |
| 859 | reallink = realname |
| 860 | title = '<a name="%s"><strong>%s</strong></a> = %s' % ( |
| 861 | anchor, name, reallink) |
Tim Peters | 4bcfa31 | 2001-09-20 06:08:24 +0000 | [diff] [blame] | 862 | if inspect.isfunction(object): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 863 | args, varargs, varkw, defaults = inspect.getargspec(object) |
| 864 | argspec = inspect.formatargspec( |
| 865 | args, varargs, varkw, defaults, formatvalue=self.formatvalue) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 866 | if realname == '<lambda>': |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 867 | title = '<strong>%s</strong> <em>lambda</em> ' % name |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 868 | argspec = argspec[1:-1] # remove parentheses |
Tim Peters | 4bcfa31 | 2001-09-20 06:08:24 +0000 | [diff] [blame] | 869 | else: |
| 870 | argspec = '(...)' |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 871 | |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 872 | decl = title + argspec + (note and self.grey( |
| 873 | '<font face="helvetica, arial">%s</font>' % note)) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 874 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 875 | if skipdocs: |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 876 | return '<dl><dt>%s</dt></dl>\n' % decl |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 877 | else: |
| 878 | doc = self.markup( |
| 879 | getdoc(object), self.preformat, funcs, classes, methods) |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 880 | doc = doc and '<dd><tt>%s</tt></dd>' % doc |
| 881 | return '<dl><dt>%s</dt>%s</dl>\n' % (decl, doc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 882 | |
Tim Peters | 8dd7ade | 2001-10-18 19:56:17 +0000 | [diff] [blame] | 883 | def docother(self, object, name=None, mod=None, *ignored): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 884 | """Produce HTML documentation for a data object.""" |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 885 | lhs = name and '<strong>%s</strong> = ' % name or '' |
| 886 | return lhs + self.repr(object) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 887 | |
| 888 | def index(self, dir, shadowed=None): |
| 889 | """Generate an HTML index for a directory of modules.""" |
| 890 | modpkgs = [] |
| 891 | if shadowed is None: shadowed = {} |
| 892 | seen = {} |
| 893 | files = os.listdir(dir) |
| 894 | |
| 895 | def found(name, ispackage, |
| 896 | modpkgs=modpkgs, shadowed=shadowed, seen=seen): |
Raymond Hettinger | 4f759d8 | 2002-11-02 02:02:46 +0000 | [diff] [blame] | 897 | if name not in seen: |
| 898 | modpkgs.append((name, '', ispackage, name in shadowed)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 899 | seen[name] = 1 |
| 900 | shadowed[name] = 1 |
| 901 | |
| 902 | # Package spam/__init__.py takes precedence over module spam.py. |
| 903 | for file in files: |
| 904 | path = os.path.join(dir, file) |
| 905 | if ispackage(path): found(file, 1) |
| 906 | for file in files: |
| 907 | path = os.path.join(dir, file) |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 908 | if os.path.isfile(path): |
| 909 | modname = inspect.getmodulename(file) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 910 | if modname: found(modname, 0) |
| 911 | |
| 912 | modpkgs.sort() |
| 913 | contents = self.multicolumn(modpkgs, self.modpkglink) |
| 914 | return self.bigsection(dir, '#ffffff', '#ee77aa', contents) |
| 915 | |
| 916 | # -------------------------------------------- text documentation generator |
| 917 | |
| 918 | class TextRepr(Repr): |
| 919 | """Class for safely making a text representation of a Python object.""" |
| 920 | def __init__(self): |
| 921 | Repr.__init__(self) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 922 | self.maxlist = self.maxtuple = 20 |
| 923 | self.maxdict = 10 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 924 | self.maxstring = self.maxother = 100 |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 925 | |
| 926 | def repr1(self, x, level): |
Skip Montanaro | 0fe8fce | 2003-06-27 15:45:41 +0000 | [diff] [blame] | 927 | if hasattr(type(x), '__name__'): |
| 928 | methodname = 'repr_' + join(split(type(x).__name__), '_') |
| 929 | if hasattr(self, methodname): |
| 930 | return getattr(self, methodname)(x, level) |
| 931 | return cram(stripid(repr(x)), self.maxother) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 932 | |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 933 | def repr_string(self, x, level): |
| 934 | test = cram(x, self.maxstring) |
| 935 | testrepr = repr(test) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 936 | if '\\' in test and '\\' not in replace(testrepr, r'\\', ''): |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 937 | # Backslashes are only literal in the string and are never |
| 938 | # needed to make any special characters, so show a raw string. |
| 939 | return 'r' + testrepr[0] + test + testrepr[0] |
| 940 | return testrepr |
| 941 | |
Skip Montanaro | df70878 | 2002-03-07 22:58:02 +0000 | [diff] [blame] | 942 | repr_str = repr_string |
| 943 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 944 | def repr_instance(self, x, level): |
| 945 | try: |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 946 | return cram(stripid(repr(x)), self.maxstring) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 947 | except: |
| 948 | return '<%s instance>' % x.__class__.__name__ |
| 949 | |
| 950 | class TextDoc(Doc): |
| 951 | """Formatter class for text documentation.""" |
| 952 | |
| 953 | # ------------------------------------------- text formatting utilities |
| 954 | |
| 955 | _repr_instance = TextRepr() |
| 956 | repr = _repr_instance.repr |
| 957 | |
| 958 | def bold(self, text): |
| 959 | """Format a string in bold by overstriking.""" |
| 960 | return join(map(lambda ch: ch + '\b' + ch, text), '') |
| 961 | |
| 962 | def indent(self, text, prefix=' '): |
| 963 | """Indent text by prepending a given prefix to each line.""" |
| 964 | if not text: return '' |
| 965 | lines = split(text, '\n') |
| 966 | lines = map(lambda line, prefix=prefix: prefix + line, lines) |
| 967 | if lines: lines[-1] = rstrip(lines[-1]) |
| 968 | return join(lines, '\n') |
| 969 | |
| 970 | def section(self, title, contents): |
| 971 | """Format a section with a given heading.""" |
| 972 | return self.bold(title) + '\n' + rstrip(self.indent(contents)) + '\n\n' |
| 973 | |
| 974 | # ---------------------------------------------- type-specific routines |
| 975 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 976 | def formattree(self, tree, modname, parent=None, prefix=''): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 977 | """Render in text a class tree as returned by inspect.getclasstree().""" |
| 978 | result = '' |
| 979 | for entry in tree: |
| 980 | if type(entry) is type(()): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 981 | c, bases = entry |
| 982 | result = result + prefix + classname(c, modname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 983 | if bases and bases != (parent,): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 984 | parents = map(lambda c, m=modname: classname(c, m), bases) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 985 | result = result + '(%s)' % join(parents, ', ') |
| 986 | result = result + '\n' |
| 987 | elif type(entry) is type([]): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 988 | result = result + self.formattree( |
| 989 | entry, modname, c, prefix + ' ') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 990 | return result |
| 991 | |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 992 | def docmodule(self, object, name=None, mod=None): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 993 | """Produce text documentation for a given module object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 994 | name = object.__name__ # ignore the passed-in name |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 995 | synop, desc = splitdoc(getdoc(object)) |
| 996 | result = self.section('NAME', name + (synop and ' - ' + synop)) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 997 | |
| 998 | try: |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 999 | all = object.__all__ |
| 1000 | except AttributeError: |
| 1001 | all = None |
| 1002 | |
| 1003 | try: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1004 | file = inspect.getabsfile(object) |
| 1005 | except TypeError: |
| 1006 | file = '(built-in)' |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 1007 | result = result + self.section('FILE', file) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 1008 | |
| 1009 | docloc = self.getdocloc(object) |
| 1010 | if docloc is not None: |
| 1011 | result = result + self.section('MODULE DOCS', docloc) |
| 1012 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1013 | if desc: |
| 1014 | result = result + self.section('DESCRIPTION', desc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1015 | |
| 1016 | classes = [] |
| 1017 | for key, value in inspect.getmembers(object, inspect.isclass): |
| 1018 | if (inspect.getmodule(value) or object) is object: |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 1019 | if visiblename(key, all): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1020 | classes.append((key, value)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1021 | funcs = [] |
| 1022 | for key, value in inspect.getmembers(object, inspect.isroutine): |
| 1023 | if inspect.isbuiltin(value) or inspect.getmodule(value) is object: |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 1024 | if visiblename(key, all): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1025 | funcs.append((key, value)) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1026 | data = [] |
| 1027 | for key, value in inspect.getmembers(object, isdata): |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 1028 | if visiblename(key, all): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1029 | data.append((key, value)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1030 | |
| 1031 | if hasattr(object, '__path__'): |
| 1032 | modpkgs = [] |
| 1033 | for file in os.listdir(object.__path__[0]): |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1034 | path = os.path.join(object.__path__[0], file) |
| 1035 | modname = inspect.getmodulename(file) |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1036 | if modname != '__init__': |
| 1037 | if modname and modname not in modpkgs: |
| 1038 | modpkgs.append(modname) |
| 1039 | elif ispackage(path): |
| 1040 | modpkgs.append(file + ' (package)') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1041 | modpkgs.sort() |
| 1042 | result = result + self.section( |
| 1043 | 'PACKAGE CONTENTS', join(modpkgs, '\n')) |
| 1044 | |
| 1045 | if classes: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1046 | classlist = map(lambda (key, value): value, classes) |
| 1047 | contents = [self.formattree( |
| 1048 | inspect.getclasstree(classlist, 1), name)] |
| 1049 | for key, value in classes: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1050 | contents.append(self.document(value, key, name)) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1051 | result = result + self.section('CLASSES', join(contents, '\n')) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1052 | |
| 1053 | if funcs: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1054 | contents = [] |
| 1055 | for key, value in funcs: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1056 | contents.append(self.document(value, key, name)) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1057 | result = result + self.section('FUNCTIONS', join(contents, '\n')) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1058 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1059 | if data: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1060 | contents = [] |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1061 | for key, value in data: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1062 | contents.append(self.docother(value, key, name, 70)) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1063 | result = result + self.section('DATA', join(contents, '\n')) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1064 | |
| 1065 | if hasattr(object, '__version__'): |
| 1066 | version = str(object.__version__) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 1067 | if version[:11] == '$' + 'Revision: ' and version[-1:] == '$': |
| 1068 | version = strip(version[11:-1]) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1069 | result = result + self.section('VERSION', version) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 1070 | if hasattr(object, '__date__'): |
| 1071 | result = result + self.section('DATE', str(object.__date__)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1072 | if hasattr(object, '__author__'): |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 1073 | result = result + self.section('AUTHOR', str(object.__author__)) |
| 1074 | if hasattr(object, '__credits__'): |
| 1075 | result = result + self.section('CREDITS', str(object.__credits__)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1076 | return result |
| 1077 | |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1078 | def docclass(self, object, name=None, mod=None): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1079 | """Produce text documentation for a given class object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1080 | realname = object.__name__ |
| 1081 | name = name or realname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1082 | bases = object.__bases__ |
| 1083 | |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 1084 | def makename(c, m=object.__module__): |
| 1085 | return classname(c, m) |
| 1086 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1087 | if name == realname: |
| 1088 | title = 'class ' + self.bold(realname) |
| 1089 | else: |
| 1090 | title = self.bold(name) + ' = class ' + realname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1091 | if bases: |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1092 | parents = map(makename, bases) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1093 | title = title + '(%s)' % join(parents, ', ') |
| 1094 | |
| 1095 | doc = getdoc(object) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1096 | contents = doc and [doc + '\n'] or [] |
| 1097 | push = contents.append |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1098 | |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 1099 | # List the mro, if non-trivial. |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1100 | mro = deque(inspect.getmro(object)) |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 1101 | if len(mro) > 2: |
| 1102 | push("Method resolution order:") |
| 1103 | for base in mro: |
| 1104 | push(' ' + makename(base)) |
| 1105 | push('') |
| 1106 | |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1107 | # Cute little class to pump out a horizontal rule between sections. |
| 1108 | class HorizontalRule: |
| 1109 | def __init__(self): |
| 1110 | self.needone = 0 |
| 1111 | def maybe(self): |
| 1112 | if self.needone: |
| 1113 | push('-' * 70) |
| 1114 | self.needone = 1 |
| 1115 | hr = HorizontalRule() |
| 1116 | |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1117 | def spill(msg, attrs, predicate): |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1118 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1119 | if ok: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1120 | hr.maybe() |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1121 | push(msg) |
| 1122 | for name, kind, homecls, value in ok: |
| 1123 | push(self.document(getattr(object, name), |
| 1124 | name, mod, object)) |
| 1125 | return attrs |
| 1126 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1127 | def spillproperties(msg, attrs, predicate): |
| 1128 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1129 | if ok: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1130 | hr.maybe() |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1131 | push(msg) |
| 1132 | for name, kind, homecls, value in ok: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1133 | push(name) |
| 1134 | need_blank_after_doc = 0 |
| 1135 | doc = getdoc(value) or '' |
| 1136 | if doc: |
| 1137 | push(self.indent(doc)) |
| 1138 | need_blank_after_doc = 1 |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1139 | for attr, tag in [('fget', '<get>'), |
| 1140 | ('fset', '<set>'), |
| 1141 | ('fdel', '<delete>')]: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1142 | func = getattr(value, attr) |
| 1143 | if func is not None: |
| 1144 | if need_blank_after_doc: |
| 1145 | push('') |
| 1146 | need_blank_after_doc = 0 |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1147 | base = self.document(func, tag, mod) |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1148 | push(self.indent(base)) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1149 | return attrs |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 1150 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1151 | def spilldata(msg, attrs, predicate): |
| 1152 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1153 | if ok: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1154 | hr.maybe() |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1155 | push(msg) |
| 1156 | for name, kind, homecls, value in ok: |
Martin v. Löwis | e59e2ba | 2003-05-03 09:09:02 +0000 | [diff] [blame] | 1157 | if callable(value) or inspect.isdatadescriptor(value): |
Guido van Rossum | 5e355b2 | 2002-05-21 20:56:15 +0000 | [diff] [blame] | 1158 | doc = getattr(value, "__doc__", None) |
| 1159 | else: |
| 1160 | doc = None |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1161 | push(self.docother(getattr(object, name), |
| 1162 | name, mod, 70, doc) + '\n') |
| 1163 | return attrs |
| 1164 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1165 | attrs = filter(lambda (name, kind, cls, value): visiblename(name), |
| 1166 | inspect.classify_class_attrs(object)) |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1167 | while attrs: |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 1168 | if mro: |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1169 | thisclass = mro.popleft() |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 1170 | else: |
| 1171 | thisclass = attrs[0][2] |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1172 | attrs, inherited = _split_list(attrs, lambda t: t[2] is thisclass) |
| 1173 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1174 | if thisclass is __builtin__.object: |
| 1175 | attrs = inherited |
| 1176 | continue |
| 1177 | elif thisclass is object: |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1178 | tag = "defined here" |
| 1179 | else: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1180 | tag = "inherited from %s" % classname(thisclass, |
| 1181 | object.__module__) |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1182 | filter(lambda t: not t[0].startswith('_'), attrs) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1183 | |
| 1184 | # Sort attrs by name. |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1185 | attrs.sort() |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1186 | |
| 1187 | # Pump out the attrs, segregated by kind. |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1188 | attrs = spill("Methods %s:\n" % tag, attrs, |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1189 | lambda t: t[1] == 'method') |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1190 | attrs = spill("Class methods %s:\n" % tag, attrs, |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1191 | lambda t: t[1] == 'class method') |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1192 | attrs = spill("Static methods %s:\n" % tag, attrs, |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1193 | lambda t: t[1] == 'static method') |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1194 | attrs = spillproperties("Properties %s:\n" % tag, attrs, |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1195 | lambda t: t[1] == 'property') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1196 | attrs = spilldata("Data and other attributes %s:\n" % tag, attrs, |
| 1197 | lambda t: t[1] == 'data') |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1198 | assert attrs == [] |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 1199 | attrs = inherited |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1200 | |
| 1201 | contents = '\n'.join(contents) |
| 1202 | if not contents: |
| 1203 | return title + '\n' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1204 | return title + '\n' + self.indent(rstrip(contents), ' | ') + '\n' |
| 1205 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1206 | def formatvalue(self, object): |
| 1207 | """Format an argument default value as text.""" |
| 1208 | return '=' + self.repr(object) |
| 1209 | |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1210 | def docroutine(self, object, name=None, mod=None, cl=None): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1211 | """Produce text documentation for a function or method object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1212 | realname = object.__name__ |
| 1213 | name = name or realname |
| 1214 | note = '' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1215 | skipdocs = 0 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1216 | if inspect.ismethod(object): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1217 | imclass = object.im_class |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1218 | if cl: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1219 | if imclass is not cl: |
| 1220 | note = ' from ' + classname(imclass, mod) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1221 | else: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 1222 | if object.im_self: |
| 1223 | note = ' method of %s instance' % classname( |
| 1224 | object.im_self.__class__, mod) |
| 1225 | else: |
| 1226 | note = ' unbound %s method' % classname(imclass,mod) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1227 | object = object.im_func |
| 1228 | |
| 1229 | if name == realname: |
| 1230 | title = self.bold(realname) |
| 1231 | else: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 1232 | if (cl and realname in cl.__dict__ and |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1233 | cl.__dict__[realname] is object): |
| 1234 | skipdocs = 1 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1235 | title = self.bold(name) + ' = ' + realname |
Tim Peters | 4bcfa31 | 2001-09-20 06:08:24 +0000 | [diff] [blame] | 1236 | if inspect.isfunction(object): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1237 | args, varargs, varkw, defaults = inspect.getargspec(object) |
| 1238 | argspec = inspect.formatargspec( |
| 1239 | args, varargs, varkw, defaults, formatvalue=self.formatvalue) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1240 | if realname == '<lambda>': |
| 1241 | title = 'lambda' |
| 1242 | argspec = argspec[1:-1] # remove parentheses |
Tim Peters | 4bcfa31 | 2001-09-20 06:08:24 +0000 | [diff] [blame] | 1243 | else: |
| 1244 | argspec = '(...)' |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1245 | decl = title + argspec + note |
| 1246 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1247 | if skipdocs: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1248 | return decl + '\n' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1249 | else: |
| 1250 | doc = getdoc(object) or '' |
| 1251 | return decl + '\n' + (doc and rstrip(self.indent(doc)) + '\n') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1252 | |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1253 | def docother(self, object, name=None, mod=None, maxlen=None, doc=None): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1254 | """Produce text documentation for a data object.""" |
| 1255 | repr = self.repr(object) |
| 1256 | if maxlen: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1257 | line = (name and name + ' = ' or '') + repr |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1258 | chop = maxlen - len(line) |
| 1259 | if chop < 0: repr = repr[:chop] + '...' |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1260 | line = (name and self.bold(name) + ' = ' or '') + repr |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1261 | if doc is not None: |
| 1262 | line += '\n' + self.indent(str(doc)) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1263 | return line |
| 1264 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1265 | # --------------------------------------------------------- user interfaces |
| 1266 | |
| 1267 | def pager(text): |
| 1268 | """The first time this is called, determine what kind of pager to use.""" |
| 1269 | global pager |
| 1270 | pager = getpager() |
| 1271 | pager(text) |
| 1272 | |
| 1273 | def getpager(): |
| 1274 | """Decide what method to use for paging through text.""" |
| 1275 | if type(sys.stdout) is not types.FileType: |
| 1276 | return plainpager |
| 1277 | if not sys.stdin.isatty() or not sys.stdout.isatty(): |
| 1278 | return plainpager |
Fred Drake | 0a66fcb | 2001-07-23 19:44:30 +0000 | [diff] [blame] | 1279 | if os.environ.get('TERM') in ['dumb', 'emacs']: |
Fred Drake | 5e9eb98 | 2001-07-23 19:48:10 +0000 | [diff] [blame] | 1280 | return plainpager |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 1281 | if 'PAGER' in os.environ: |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1282 | if sys.platform == 'win32': # pipes completely broken in Windows |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1283 | return lambda text: tempfilepager(plain(text), os.environ['PAGER']) |
| 1284 | elif os.environ.get('TERM') in ['dumb', 'emacs']: |
| 1285 | return lambda text: pipepager(plain(text), os.environ['PAGER']) |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1286 | else: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1287 | return lambda text: pipepager(text, os.environ['PAGER']) |
Andrew MacIntyre | 54e0eab | 2002-03-03 03:12:30 +0000 | [diff] [blame] | 1288 | if sys.platform == 'win32' or sys.platform.startswith('os2'): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1289 | return lambda text: tempfilepager(plain(text), 'more <') |
Skip Montanaro | d404bee | 2002-09-26 21:44:57 +0000 | [diff] [blame] | 1290 | if hasattr(os, 'system') and os.system('(less) 2>/dev/null') == 0: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1291 | return lambda text: pipepager(text, 'less') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1292 | |
| 1293 | import tempfile |
Guido van Rossum | 3b0a329 | 2002-08-09 16:38:32 +0000 | [diff] [blame] | 1294 | (fd, filename) = tempfile.mkstemp() |
| 1295 | os.close(fd) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1296 | try: |
| 1297 | if hasattr(os, 'system') and os.system('more %s' % filename) == 0: |
| 1298 | return lambda text: pipepager(text, 'more') |
| 1299 | else: |
| 1300 | return ttypager |
| 1301 | finally: |
| 1302 | os.unlink(filename) |
| 1303 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1304 | def plain(text): |
| 1305 | """Remove boldface formatting from text.""" |
| 1306 | return re.sub('.\b', '', text) |
| 1307 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1308 | def pipepager(text, cmd): |
| 1309 | """Page through text by feeding it to another program.""" |
| 1310 | pipe = os.popen(cmd, 'w') |
| 1311 | try: |
| 1312 | pipe.write(text) |
| 1313 | pipe.close() |
| 1314 | except IOError: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1315 | pass # Ignore broken pipes caused by quitting the pager program. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1316 | |
| 1317 | def tempfilepager(text, cmd): |
| 1318 | """Page through text by invoking a program on a temporary file.""" |
| 1319 | import tempfile |
Tim Peters | 550e4e5 | 2003-02-07 01:53:46 +0000 | [diff] [blame] | 1320 | filename = tempfile.mktemp() |
| 1321 | file = open(filename, 'w') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1322 | file.write(text) |
| 1323 | file.close() |
| 1324 | try: |
Ka-Ping Yee | c92cdf7 | 2001-03-02 05:54:35 +0000 | [diff] [blame] | 1325 | os.system(cmd + ' ' + filename) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1326 | finally: |
| 1327 | os.unlink(filename) |
| 1328 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1329 | def ttypager(text): |
| 1330 | """Page through text on a text terminal.""" |
| 1331 | lines = split(plain(text), '\n') |
| 1332 | try: |
| 1333 | import tty |
| 1334 | fd = sys.stdin.fileno() |
| 1335 | old = tty.tcgetattr(fd) |
| 1336 | tty.setcbreak(fd) |
| 1337 | getchar = lambda: sys.stdin.read(1) |
Ka-Ping Yee | 457aab2 | 2001-02-27 23:36:29 +0000 | [diff] [blame] | 1338 | except (ImportError, AttributeError): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1339 | tty = None |
| 1340 | getchar = lambda: sys.stdin.readline()[:-1][:1] |
| 1341 | |
| 1342 | try: |
| 1343 | r = inc = os.environ.get('LINES', 25) - 1 |
| 1344 | sys.stdout.write(join(lines[:inc], '\n') + '\n') |
| 1345 | while lines[r:]: |
| 1346 | sys.stdout.write('-- more --') |
| 1347 | sys.stdout.flush() |
| 1348 | c = getchar() |
| 1349 | |
| 1350 | if c in ['q', 'Q']: |
| 1351 | sys.stdout.write('\r \r') |
| 1352 | break |
| 1353 | elif c in ['\r', '\n']: |
| 1354 | sys.stdout.write('\r \r' + lines[r] + '\n') |
| 1355 | r = r + 1 |
| 1356 | continue |
| 1357 | if c in ['b', 'B', '\x1b']: |
| 1358 | r = r - inc - inc |
| 1359 | if r < 0: r = 0 |
| 1360 | sys.stdout.write('\n' + join(lines[r:r+inc], '\n') + '\n') |
| 1361 | r = r + inc |
| 1362 | |
| 1363 | finally: |
| 1364 | if tty: |
| 1365 | tty.tcsetattr(fd, tty.TCSAFLUSH, old) |
| 1366 | |
| 1367 | def plainpager(text): |
| 1368 | """Simply print unformatted text. This is the ultimate fallback.""" |
| 1369 | sys.stdout.write(plain(text)) |
| 1370 | |
| 1371 | def describe(thing): |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1372 | """Produce a short description of the given thing.""" |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1373 | if inspect.ismodule(thing): |
| 1374 | if thing.__name__ in sys.builtin_module_names: |
| 1375 | return 'built-in module ' + thing.__name__ |
| 1376 | if hasattr(thing, '__path__'): |
| 1377 | return 'package ' + thing.__name__ |
| 1378 | else: |
| 1379 | return 'module ' + thing.__name__ |
| 1380 | if inspect.isbuiltin(thing): |
| 1381 | return 'built-in function ' + thing.__name__ |
| 1382 | if inspect.isclass(thing): |
| 1383 | return 'class ' + thing.__name__ |
| 1384 | if inspect.isfunction(thing): |
| 1385 | return 'function ' + thing.__name__ |
| 1386 | if inspect.ismethod(thing): |
| 1387 | return 'method ' + thing.__name__ |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1388 | if type(thing) is types.InstanceType: |
| 1389 | return 'instance of ' + thing.__class__.__name__ |
| 1390 | return type(thing).__name__ |
| 1391 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1392 | def locate(path, forceload=0): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1393 | """Locate an object by name or dotted path, importing as necessary.""" |
Guido van Rossum | 97dede0 | 2003-02-16 01:12:32 +0000 | [diff] [blame] | 1394 | parts = [part for part in split(path, '.') if part] |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1395 | module, n = None, 0 |
| 1396 | while n < len(parts): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1397 | nextmodule = safeimport(join(parts[:n+1], '.'), forceload) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1398 | if nextmodule: module, n = nextmodule, n + 1 |
| 1399 | else: break |
| 1400 | if module: |
| 1401 | object = module |
| 1402 | for part in parts[n:]: |
| 1403 | try: object = getattr(object, part) |
| 1404 | except AttributeError: return None |
| 1405 | return object |
| 1406 | else: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1407 | if hasattr(__builtin__, path): |
| 1408 | return getattr(__builtin__, path) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1409 | |
| 1410 | # --------------------------------------- interactive interpreter interface |
| 1411 | |
| 1412 | text = TextDoc() |
| 1413 | html = HTMLDoc() |
| 1414 | |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1415 | def resolve(thing, forceload=0): |
| 1416 | """Given an object or a path to an object, get the object and its name.""" |
| 1417 | if isinstance(thing, str): |
| 1418 | object = locate(thing, forceload) |
| 1419 | if not object: |
| 1420 | raise ImportError, 'no Python documentation found for %r' % thing |
| 1421 | return object, thing |
| 1422 | else: |
| 1423 | return thing, getattr(thing, '__name__', None) |
| 1424 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1425 | def doc(thing, title='Python Library Documentation: %s', forceload=0): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1426 | """Display text documentation, given an object or a path to an object.""" |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1427 | try: |
| 1428 | object, name = resolve(thing, forceload) |
| 1429 | desc = describe(object) |
| 1430 | module = inspect.getmodule(object) |
| 1431 | if name and '.' in name: |
| 1432 | desc += ' in ' + name[:name.rfind('.')] |
| 1433 | elif module and module is not object: |
| 1434 | desc += ' in module ' + module.__name__ |
| 1435 | pager(title % desc + '\n\n' + text.document(object, name)) |
| 1436 | except (ImportError, ErrorDuringImport), value: |
| 1437 | print value |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1438 | |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1439 | def writedoc(thing, forceload=0): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1440 | """Write HTML documentation to a file in the current directory.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1441 | try: |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1442 | object, name = resolve(thing, forceload) |
| 1443 | page = html.page(describe(object), html.document(object, name)) |
| 1444 | file = open(name + '.html', 'w') |
| 1445 | file.write(page) |
| 1446 | file.close() |
| 1447 | print 'wrote', name + '.html' |
| 1448 | except (ImportError, ErrorDuringImport), value: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1449 | print value |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1450 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1451 | def writedocs(dir, pkgpath='', done=None): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1452 | """Write out HTML documentation for all modules in a directory tree.""" |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1453 | if done is None: done = {} |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1454 | for file in os.listdir(dir): |
| 1455 | path = os.path.join(dir, file) |
| 1456 | if ispackage(path): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1457 | writedocs(path, pkgpath + file + '.', done) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1458 | elif os.path.isfile(path): |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1459 | modname = inspect.getmodulename(path) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1460 | if modname: |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1461 | if modname == '__init__': |
| 1462 | modname = pkgpath[:-1] # remove trailing period |
| 1463 | else: |
| 1464 | modname = pkgpath + modname |
| 1465 | if modname not in done: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1466 | done[modname] = 1 |
| 1467 | writedoc(modname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1468 | |
| 1469 | class Helper: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1470 | keywords = { |
| 1471 | 'and': 'BOOLEAN', |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1472 | 'assert': ('ref/assert', ''), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1473 | 'break': ('ref/break', 'while for'), |
| 1474 | 'class': ('ref/class', 'CLASSES SPECIALMETHODS'), |
| 1475 | 'continue': ('ref/continue', 'while for'), |
| 1476 | 'def': ('ref/function', ''), |
| 1477 | 'del': ('ref/del', 'BASICMETHODS'), |
| 1478 | 'elif': 'if', |
| 1479 | 'else': ('ref/if', 'while for'), |
| 1480 | 'except': 'try', |
| 1481 | 'exec': ('ref/exec', ''), |
| 1482 | 'finally': 'try', |
| 1483 | 'for': ('ref/for', 'break continue while'), |
| 1484 | 'from': 'import', |
| 1485 | 'global': ('ref/global', 'NAMESPACES'), |
| 1486 | 'if': ('ref/if', 'TRUTHVALUE'), |
| 1487 | 'import': ('ref/import', 'MODULES'), |
| 1488 | 'in': ('ref/comparisons', 'SEQUENCEMETHODS2'), |
| 1489 | 'is': 'COMPARISON', |
Neal Norwitz | 742dde4 | 2003-03-30 20:31:34 +0000 | [diff] [blame] | 1490 | 'lambda': ('ref/lambdas', 'FUNCTIONS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1491 | 'not': 'BOOLEAN', |
| 1492 | 'or': 'BOOLEAN', |
Neal Norwitz | 742dde4 | 2003-03-30 20:31:34 +0000 | [diff] [blame] | 1493 | 'pass': ('ref/pass', ''), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1494 | 'print': ('ref/print', ''), |
| 1495 | 'raise': ('ref/raise', 'EXCEPTIONS'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1496 | 'return': ('ref/return', 'FUNCTIONS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1497 | 'try': ('ref/try', 'EXCEPTIONS'), |
| 1498 | 'while': ('ref/while', 'break continue if TRUTHVALUE'), |
Tim Peters | fb05c4e | 2002-10-30 05:21:00 +0000 | [diff] [blame] | 1499 | 'yield': ('ref/yield', ''), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1500 | } |
| 1501 | |
| 1502 | topics = { |
| 1503 | 'TYPES': ('ref/types', 'STRINGS UNICODE NUMBERS SEQUENCES MAPPINGS FUNCTIONS CLASSES MODULES FILES inspect'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1504 | 'STRINGS': ('ref/strings', 'str UNICODE SEQUENCES STRINGMETHODS FORMATTING TYPES'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1505 | 'STRINGMETHODS': ('lib/string-methods', 'STRINGS FORMATTING'), |
| 1506 | 'FORMATTING': ('lib/typesseq-strings', 'OPERATORS'), |
Neal Norwitz | 54f871e | 2003-05-26 13:49:54 +0000 | [diff] [blame] | 1507 | 'UNICODE': ('ref/strings', 'encodings unicode SEQUENCES STRINGMETHODS FORMATTING TYPES'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1508 | 'NUMBERS': ('ref/numbers', 'INTEGER FLOAT COMPLEX TYPES'), |
| 1509 | 'INTEGER': ('ref/integers', 'int range'), |
| 1510 | 'FLOAT': ('ref/floating', 'float math'), |
| 1511 | 'COMPLEX': ('ref/imaginary', 'complex cmath'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1512 | 'SEQUENCES': ('lib/typesseq', 'STRINGMETHODS FORMATTING xrange LISTS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1513 | 'MAPPINGS': 'DICTIONARIES', |
| 1514 | 'FUNCTIONS': ('lib/typesfunctions', 'def TYPES'), |
| 1515 | 'METHODS': ('lib/typesmethods', 'class def CLASSES TYPES'), |
| 1516 | 'CODEOBJECTS': ('lib/bltin-code-objects', 'compile FUNCTIONS TYPES'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1517 | 'TYPEOBJECTS': ('lib/bltin-type-objects', 'types TYPES'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1518 | 'FRAMEOBJECTS': 'TYPES', |
| 1519 | 'TRACEBACKS': 'TYPES', |
| 1520 | 'NONE': ('lib/bltin-null-object', ''), |
| 1521 | 'ELLIPSIS': ('lib/bltin-ellipsis-object', 'SLICINGS'), |
| 1522 | 'FILES': ('lib/bltin-file-objects', ''), |
| 1523 | 'SPECIALATTRIBUTES': ('lib/specialattrs', ''), |
| 1524 | 'CLASSES': ('ref/types', 'class SPECIALMETHODS PRIVATENAMES'), |
| 1525 | 'MODULES': ('lib/typesmodules', 'import'), |
| 1526 | 'PACKAGES': 'import', |
| 1527 | 'EXPRESSIONS': ('ref/summary', 'lambda or and not in is BOOLEAN COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES LISTS DICTIONARIES BACKQUOTES'), |
| 1528 | 'OPERATORS': 'EXPRESSIONS', |
| 1529 | 'PRECEDENCE': 'EXPRESSIONS', |
| 1530 | 'OBJECTS': ('ref/objects', 'TYPES'), |
| 1531 | 'SPECIALMETHODS': ('ref/specialnames', 'BASICMETHODS ATTRIBUTEMETHODS CALLABLEMETHODS SEQUENCEMETHODS1 MAPPINGMETHODS SEQUENCEMETHODS2 NUMBERMETHODS CLASSES'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1532 | 'BASICMETHODS': ('ref/customization', 'cmp hash repr str SPECIALMETHODS'), |
| 1533 | 'ATTRIBUTEMETHODS': ('ref/attribute-access', 'ATTRIBUTES SPECIALMETHODS'), |
| 1534 | 'CALLABLEMETHODS': ('ref/callable-types', 'CALLS SPECIALMETHODS'), |
| 1535 | 'SEQUENCEMETHODS1': ('ref/sequence-types', 'SEQUENCES SEQUENCEMETHODS2 SPECIALMETHODS'), |
| 1536 | 'SEQUENCEMETHODS2': ('ref/sequence-methods', 'SEQUENCES SEQUENCEMETHODS1 SPECIALMETHODS'), |
| 1537 | 'MAPPINGMETHODS': ('ref/sequence-types', 'MAPPINGS SPECIALMETHODS'), |
| 1538 | 'NUMBERMETHODS': ('ref/numeric-types', 'NUMBERS AUGMENTEDASSIGNMENT SPECIALMETHODS'), |
Neal Norwitz | 54f871e | 2003-05-26 13:49:54 +0000 | [diff] [blame] | 1539 | 'EXECUTION': ('ref/execmodel', 'NAMESPACES DYNAMICFEATURES EXCEPTIONS'), |
| 1540 | 'NAMESPACES': ('ref/naming', 'global ASSIGNMENT DELETION DYNAMICFEATURES'), |
| 1541 | 'DYNAMICFEATURES': ('ref/dynamic-features', ''), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1542 | 'SCOPING': 'NAMESPACES', |
| 1543 | 'FRAMES': 'NAMESPACES', |
| 1544 | 'EXCEPTIONS': ('ref/exceptions', 'try except finally raise'), |
Neal Norwitz | 54f871e | 2003-05-26 13:49:54 +0000 | [diff] [blame] | 1545 | 'COERCIONS': ('ref/coercion-rules','CONVERSIONS'), |
| 1546 | 'CONVERSIONS': ('ref/conversions', 'COERCIONS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1547 | 'IDENTIFIERS': ('ref/identifiers', 'keywords SPECIALIDENTIFIERS'), |
| 1548 | 'SPECIALIDENTIFIERS': ('ref/id-classes', ''), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1549 | 'PRIVATENAMES': ('ref/atom-identifiers', ''), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1550 | 'LITERALS': ('ref/atom-literals', 'STRINGS BACKQUOTES NUMBERS TUPLELITERALS LISTLITERALS DICTIONARYLITERALS'), |
| 1551 | 'TUPLES': 'SEQUENCES', |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1552 | 'TUPLELITERALS': ('ref/exprlists', 'TUPLES LITERALS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1553 | 'LISTS': ('lib/typesseq-mutable', 'LISTLITERALS'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1554 | 'LISTLITERALS': ('ref/lists', 'LISTS LITERALS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1555 | 'DICTIONARIES': ('lib/typesmapping', 'DICTIONARYLITERALS'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1556 | 'DICTIONARYLITERALS': ('ref/dict', 'DICTIONARIES LITERALS'), |
| 1557 | 'BACKQUOTES': ('ref/string-conversions', 'repr str STRINGS LITERALS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1558 | 'ATTRIBUTES': ('ref/attribute-references', 'getattr hasattr setattr ATTRIBUTEMETHODS'), |
| 1559 | 'SUBSCRIPTS': ('ref/subscriptions', 'SEQUENCEMETHODS1'), |
| 1560 | 'SLICINGS': ('ref/slicings', 'SEQUENCEMETHODS2'), |
| 1561 | 'CALLS': ('ref/calls', 'EXPRESSIONS'), |
| 1562 | 'POWER': ('ref/power', 'EXPRESSIONS'), |
| 1563 | 'UNARY': ('ref/unary', 'EXPRESSIONS'), |
| 1564 | 'BINARY': ('ref/binary', 'EXPRESSIONS'), |
| 1565 | 'SHIFTING': ('ref/shifting', 'EXPRESSIONS'), |
| 1566 | 'BITWISE': ('ref/bitwise', 'EXPRESSIONS'), |
| 1567 | 'COMPARISON': ('ref/comparisons', 'EXPRESSIONS BASICMETHODS'), |
Neal Norwitz | f98159c | 2003-02-07 20:49:40 +0000 | [diff] [blame] | 1568 | 'BOOLEAN': ('ref/Booleans', 'EXPRESSIONS TRUTHVALUE'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1569 | 'ASSERTION': 'assert', |
| 1570 | 'ASSIGNMENT': ('ref/assignment', 'AUGMENTEDASSIGNMENT'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1571 | 'AUGMENTEDASSIGNMENT': ('ref/augassign', 'NUMBERMETHODS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1572 | 'DELETION': 'del', |
| 1573 | 'PRINTING': 'print', |
| 1574 | 'RETURNING': 'return', |
| 1575 | 'IMPORTING': 'import', |
| 1576 | 'CONDITIONAL': 'if', |
| 1577 | 'LOOPING': ('ref/compound', 'for while break continue'), |
| 1578 | 'TRUTHVALUE': ('lib/truth', 'if while and or not BASICMETHODS'), |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1579 | 'DEBUGGING': ('lib/module-pdb', 'pdb'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1580 | } |
| 1581 | |
| 1582 | def __init__(self, input, output): |
| 1583 | self.input = input |
| 1584 | self.output = output |
| 1585 | self.docdir = None |
| 1586 | execdir = os.path.dirname(sys.executable) |
| 1587 | homedir = os.environ.get('PYTHONHOME') |
| 1588 | for dir in [os.environ.get('PYTHONDOCS'), |
| 1589 | homedir and os.path.join(homedir, 'doc'), |
| 1590 | os.path.join(execdir, 'doc'), |
| 1591 | '/usr/doc/python-docs-' + split(sys.version)[0], |
| 1592 | '/usr/doc/python-' + split(sys.version)[0], |
| 1593 | '/usr/doc/python-docs-' + sys.version[:3], |
Jack Jansen | b2628b0 | 2002-08-23 08:40:42 +0000 | [diff] [blame] | 1594 | '/usr/doc/python-' + sys.version[:3], |
| 1595 | os.path.join(sys.prefix, 'Resources/English.lproj/Documentation')]: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1596 | if dir and os.path.isdir(os.path.join(dir, 'lib')): |
| 1597 | self.docdir = dir |
| 1598 | |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1599 | def __repr__(self): |
Ka-Ping Yee | 9bc576b | 2001-04-13 13:57:31 +0000 | [diff] [blame] | 1600 | if inspect.stack()[1][3] == '?': |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1601 | self() |
| 1602 | return '' |
Ka-Ping Yee | 9bc576b | 2001-04-13 13:57:31 +0000 | [diff] [blame] | 1603 | return '<pydoc.Helper instance>' |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1604 | |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1605 | def __call__(self, request=None): |
| 1606 | if request is not None: |
| 1607 | self.help(request) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1608 | else: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1609 | self.intro() |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1610 | self.interact() |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1611 | self.output.write(''' |
Fred Drake | e61967f | 2001-05-10 18:41:02 +0000 | [diff] [blame] | 1612 | You are now leaving help and returning to the Python interpreter. |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1613 | If you want to ask for help on a particular object directly from the |
| 1614 | interpreter, you can type "help(object)". Executing "help('string')" |
| 1615 | has the same effect as typing a particular string at the help> prompt. |
| 1616 | ''') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1617 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1618 | def interact(self): |
| 1619 | self.output.write('\n') |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 1620 | while True: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1621 | self.output.write('help> ') |
| 1622 | self.output.flush() |
| 1623 | try: |
| 1624 | request = self.input.readline() |
| 1625 | if not request: break |
| 1626 | except KeyboardInterrupt: break |
| 1627 | request = strip(replace(request, '"', '', "'", '')) |
| 1628 | if lower(request) in ['q', 'quit']: break |
| 1629 | self.help(request) |
| 1630 | |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1631 | def help(self, request): |
| 1632 | if type(request) is type(''): |
| 1633 | if request == 'help': self.intro() |
| 1634 | elif request == 'keywords': self.listkeywords() |
| 1635 | elif request == 'topics': self.listtopics() |
| 1636 | elif request == 'modules': self.listmodules() |
| 1637 | elif request[:8] == 'modules ': |
| 1638 | self.listmodules(split(request)[1]) |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 1639 | elif request in self.keywords: self.showtopic(request) |
| 1640 | elif request in self.topics: self.showtopic(request) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1641 | elif request: doc(request, 'Help on %s:') |
| 1642 | elif isinstance(request, Helper): self() |
| 1643 | else: doc(request, 'Help on %s:') |
| 1644 | self.output.write('\n') |
| 1645 | |
| 1646 | def intro(self): |
| 1647 | self.output.write(''' |
| 1648 | Welcome to Python %s! This is the online help utility. |
| 1649 | |
| 1650 | If this is your first time using Python, you should definitely check out |
| 1651 | the tutorial on the Internet at http://www.python.org/doc/tut/. |
| 1652 | |
| 1653 | Enter the name of any module, keyword, or topic to get help on writing |
| 1654 | Python programs and using Python modules. To quit this help utility and |
| 1655 | return to the interpreter, just type "quit". |
| 1656 | |
| 1657 | To get a list of available modules, keywords, or topics, type "modules", |
| 1658 | "keywords", or "topics". Each module also comes with a one-line summary |
| 1659 | of what it does; to list the modules whose summaries contain a given word |
| 1660 | such as "spam", type "modules spam". |
| 1661 | ''' % sys.version[:3]) |
| 1662 | |
| 1663 | def list(self, items, columns=4, width=80): |
| 1664 | items = items[:] |
| 1665 | items.sort() |
| 1666 | colw = width / columns |
| 1667 | rows = (len(items) + columns - 1) / columns |
| 1668 | for row in range(rows): |
| 1669 | for col in range(columns): |
| 1670 | i = col * rows + row |
| 1671 | if i < len(items): |
| 1672 | self.output.write(items[i]) |
| 1673 | if col < columns - 1: |
| 1674 | self.output.write(' ' + ' ' * (colw-1 - len(items[i]))) |
| 1675 | self.output.write('\n') |
| 1676 | |
| 1677 | def listkeywords(self): |
| 1678 | self.output.write(''' |
| 1679 | Here is a list of the Python keywords. Enter any keyword to get more help. |
| 1680 | |
| 1681 | ''') |
| 1682 | self.list(self.keywords.keys()) |
| 1683 | |
| 1684 | def listtopics(self): |
| 1685 | self.output.write(''' |
| 1686 | Here is a list of available topics. Enter any topic name to get more help. |
| 1687 | |
| 1688 | ''') |
| 1689 | self.list(self.topics.keys()) |
| 1690 | |
| 1691 | def showtopic(self, topic): |
| 1692 | if not self.docdir: |
| 1693 | self.output.write(''' |
| 1694 | Sorry, topic and keyword documentation is not available because the Python |
| 1695 | HTML documentation files could not be found. If you have installed them, |
| 1696 | please set the environment variable PYTHONDOCS to indicate their location. |
| 1697 | ''') |
| 1698 | return |
| 1699 | target = self.topics.get(topic, self.keywords.get(topic)) |
| 1700 | if not target: |
| 1701 | self.output.write('no documentation found for %s\n' % repr(topic)) |
| 1702 | return |
| 1703 | if type(target) is type(''): |
| 1704 | return self.showtopic(target) |
| 1705 | |
| 1706 | filename, xrefs = target |
| 1707 | filename = self.docdir + '/' + filename + '.html' |
| 1708 | try: |
| 1709 | file = open(filename) |
| 1710 | except: |
| 1711 | self.output.write('could not read docs from %s\n' % filename) |
| 1712 | return |
| 1713 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1714 | divpat = re.compile('<div[^>]*navigat.*?</div.*?>', re.I | re.S) |
| 1715 | addrpat = re.compile('<address.*?>.*?</address.*?>', re.I | re.S) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1716 | document = re.sub(addrpat, '', re.sub(divpat, '', file.read())) |
| 1717 | file.close() |
| 1718 | |
| 1719 | import htmllib, formatter, StringIO |
| 1720 | buffer = StringIO.StringIO() |
| 1721 | parser = htmllib.HTMLParser( |
| 1722 | formatter.AbstractFormatter(formatter.DumbWriter(buffer))) |
| 1723 | parser.start_table = parser.do_p |
| 1724 | parser.end_table = lambda parser=parser: parser.do_p({}) |
| 1725 | parser.start_tr = parser.do_br |
| 1726 | parser.start_td = parser.start_th = lambda a, b=buffer: b.write('\t') |
| 1727 | parser.feed(document) |
| 1728 | buffer = replace(buffer.getvalue(), '\xa0', ' ', '\n', '\n ') |
| 1729 | pager(' ' + strip(buffer) + '\n') |
Ka-Ping Yee | da79389 | 2001-04-13 11:02:51 +0000 | [diff] [blame] | 1730 | if xrefs: |
| 1731 | buffer = StringIO.StringIO() |
| 1732 | formatter.DumbWriter(buffer).send_flowing_data( |
| 1733 | 'Related help topics: ' + join(split(xrefs), ', ') + '\n') |
| 1734 | self.output.write('\n%s\n' % buffer.getvalue()) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1735 | |
| 1736 | def listmodules(self, key=''): |
| 1737 | if key: |
| 1738 | self.output.write(''' |
| 1739 | Here is a list of matching modules. Enter any module name to get more help. |
| 1740 | |
| 1741 | ''') |
| 1742 | apropos(key) |
| 1743 | else: |
| 1744 | self.output.write(''' |
| 1745 | Please wait a moment while I gather a list of all available modules... |
| 1746 | |
| 1747 | ''') |
| 1748 | modules = {} |
| 1749 | def callback(path, modname, desc, modules=modules): |
| 1750 | if modname and modname[-9:] == '.__init__': |
| 1751 | modname = modname[:-9] + ' (package)' |
| 1752 | if find(modname, '.') < 0: |
| 1753 | modules[modname] = 1 |
| 1754 | ModuleScanner().run(callback) |
| 1755 | self.list(modules.keys()) |
| 1756 | self.output.write(''' |
| 1757 | Enter any module name to get more help. Or, type "modules spam" to search |
| 1758 | for modules whose descriptions contain the word "spam". |
| 1759 | ''') |
| 1760 | |
| 1761 | help = Helper(sys.stdin, sys.stdout) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1762 | |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1763 | class Scanner: |
| 1764 | """A generic tree iterator.""" |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1765 | def __init__(self, roots, children, descendp): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1766 | self.roots = roots[:] |
| 1767 | self.state = [] |
| 1768 | self.children = children |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1769 | self.descendp = descendp |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1770 | |
| 1771 | def next(self): |
| 1772 | if not self.state: |
| 1773 | if not self.roots: |
| 1774 | return None |
| 1775 | root = self.roots.pop(0) |
| 1776 | self.state = [(root, self.children(root))] |
| 1777 | node, children = self.state[-1] |
| 1778 | if not children: |
| 1779 | self.state.pop() |
| 1780 | return self.next() |
| 1781 | child = children.pop(0) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1782 | if self.descendp(child): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1783 | self.state.append((child, self.children(child))) |
| 1784 | return child |
| 1785 | |
| 1786 | class ModuleScanner(Scanner): |
| 1787 | """An interruptible scanner that searches module synopses.""" |
| 1788 | def __init__(self): |
| 1789 | roots = map(lambda dir: (dir, ''), pathdirs()) |
Ka-Ping Yee | eca15c1 | 2001-04-13 13:53:07 +0000 | [diff] [blame] | 1790 | Scanner.__init__(self, roots, self.submodules, self.isnewpackage) |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 1791 | self.inodes = map(lambda (dir, pkg): os.stat(dir).st_ino, roots) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1792 | |
| 1793 | def submodules(self, (dir, package)): |
| 1794 | children = [] |
| 1795 | for file in os.listdir(dir): |
| 1796 | path = os.path.join(dir, file) |
Tim Peters | 30edd23 | 2001-03-16 08:29:48 +0000 | [diff] [blame] | 1797 | if ispackage(path): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1798 | children.append((path, package + (package and '.') + file)) |
| 1799 | else: |
| 1800 | children.append((path, package)) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1801 | children.sort() # so that spam.py comes before spam.pyc or spam.pyo |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1802 | return children |
| 1803 | |
Ka-Ping Yee | eca15c1 | 2001-04-13 13:53:07 +0000 | [diff] [blame] | 1804 | def isnewpackage(self, (dir, package)): |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 1805 | inode = os.path.exists(dir) and os.stat(dir).st_ino |
Ka-Ping Yee | eca15c1 | 2001-04-13 13:53:07 +0000 | [diff] [blame] | 1806 | if not (os.path.islink(dir) and inode in self.inodes): |
Ka-Ping Yee | 6191a23 | 2001-04-13 15:00:27 +0000 | [diff] [blame] | 1807 | self.inodes.append(inode) # detect circular symbolic links |
Ka-Ping Yee | eca15c1 | 2001-04-13 13:53:07 +0000 | [diff] [blame] | 1808 | return ispackage(dir) |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 1809 | return False |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1810 | |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 1811 | def run(self, callback, key=None, completer=None): |
| 1812 | if key: key = lower(key) |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 1813 | self.quit = False |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1814 | seen = {} |
| 1815 | |
| 1816 | for modname in sys.builtin_module_names: |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 1817 | if modname != '__main__': |
| 1818 | seen[modname] = 1 |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 1819 | if key is None: |
| 1820 | callback(None, modname, '') |
| 1821 | else: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1822 | desc = split(__import__(modname).__doc__ or '', '\n')[0] |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 1823 | if find(lower(modname + ' - ' + desc), key) >= 0: |
| 1824 | callback(None, modname, desc) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1825 | |
| 1826 | while not self.quit: |
| 1827 | node = self.next() |
| 1828 | if not node: break |
| 1829 | path, package = node |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1830 | modname = inspect.getmodulename(path) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1831 | if os.path.isfile(path) and modname: |
| 1832 | modname = package + (package and '.') + modname |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 1833 | if not modname in seen: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1834 | seen[modname] = 1 # if we see spam.py, skip spam.pyc |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 1835 | if key is None: |
| 1836 | callback(path, modname, '') |
| 1837 | else: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1838 | desc = synopsis(path) or '' |
| 1839 | if find(lower(modname + ' - ' + desc), key) >= 0: |
| 1840 | callback(path, modname, desc) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1841 | if completer: completer() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1842 | |
| 1843 | def apropos(key): |
| 1844 | """Print all the one-line module summaries that contain a substring.""" |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1845 | def callback(path, modname, desc): |
| 1846 | if modname[-9:] == '.__init__': |
| 1847 | modname = modname[:-9] + ' (package)' |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1848 | print modname, desc and '- ' + desc |
| 1849 | try: import warnings |
| 1850 | except ImportError: pass |
| 1851 | else: warnings.filterwarnings('ignore') # ignore problems during import |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 1852 | ModuleScanner().run(callback, key) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1853 | |
| 1854 | # --------------------------------------------------- web browser interface |
| 1855 | |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 1856 | def serve(port, callback=None, completer=None): |
Ka-Ping Yee | fd54069 | 2001-04-12 12:54:36 +0000 | [diff] [blame] | 1857 | import BaseHTTPServer, mimetools, select |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1858 | |
| 1859 | # Patch up mimetools.Message so it doesn't break if rfc822 is reloaded. |
| 1860 | class Message(mimetools.Message): |
| 1861 | def __init__(self, fp, seekable=1): |
| 1862 | Message = self.__class__ |
| 1863 | Message.__bases__[0].__bases__[0].__init__(self, fp, seekable) |
| 1864 | self.encodingheader = self.getheader('content-transfer-encoding') |
| 1865 | self.typeheader = self.getheader('content-type') |
| 1866 | self.parsetype() |
| 1867 | self.parseplist() |
| 1868 | |
| 1869 | class DocHandler(BaseHTTPServer.BaseHTTPRequestHandler): |
| 1870 | def send_document(self, title, contents): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1871 | try: |
| 1872 | self.send_response(200) |
| 1873 | self.send_header('Content-Type', 'text/html') |
| 1874 | self.end_headers() |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1875 | self.wfile.write(html.page(title, contents)) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1876 | except IOError: pass |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1877 | |
| 1878 | def do_GET(self): |
| 1879 | path = self.path |
| 1880 | if path[-5:] == '.html': path = path[:-5] |
| 1881 | if path[:1] == '/': path = path[1:] |
| 1882 | if path and path != '.': |
| 1883 | try: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1884 | obj = locate(path, forceload=1) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1885 | except ErrorDuringImport, value: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1886 | self.send_document(path, html.escape(str(value))) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1887 | return |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1888 | if obj: |
| 1889 | self.send_document(describe(obj), html.document(obj, path)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1890 | else: |
| 1891 | self.send_document(path, |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1892 | 'no Python documentation found for %s' % repr(path)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1893 | else: |
| 1894 | heading = html.heading( |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1895 | '<big><big><strong>Python: Index of Modules</strong></big></big>', |
| 1896 | '#ffffff', '#7799ee') |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 1897 | def bltinlink(name): |
| 1898 | return '<a href="%s.html">%s</a>' % (name, name) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1899 | names = filter(lambda x: x != '__main__', |
| 1900 | sys.builtin_module_names) |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 1901 | contents = html.multicolumn(names, bltinlink) |
| 1902 | indices = ['<p>' + html.bigsection( |
| 1903 | 'Built-in Modules', '#ffffff', '#ee77aa', contents)] |
| 1904 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1905 | seen = {} |
| 1906 | for dir in pathdirs(): |
| 1907 | indices.append(html.index(dir, seen)) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1908 | contents = heading + join(indices) + '''<p align=right> |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 1909 | <font color="#909090" face="helvetica, arial"><strong> |
| 1910 | pydoc</strong> by Ka-Ping Yee <ping@lfw.org></font>''' |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1911 | self.send_document('Index of Modules', contents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1912 | |
| 1913 | def log_message(self, *args): pass |
| 1914 | |
Ka-Ping Yee | fd54069 | 2001-04-12 12:54:36 +0000 | [diff] [blame] | 1915 | class DocServer(BaseHTTPServer.HTTPServer): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1916 | def __init__(self, port, callback): |
Ka-Ping Yee | db8ed15 | 2001-03-02 05:58:17 +0000 | [diff] [blame] | 1917 | host = (sys.platform == 'mac') and '127.0.0.1' or 'localhost' |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1918 | self.address = ('', port) |
Ka-Ping Yee | db8ed15 | 2001-03-02 05:58:17 +0000 | [diff] [blame] | 1919 | self.url = 'http://%s:%d/' % (host, port) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1920 | self.callback = callback |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1921 | self.base.__init__(self, self.address, self.handler) |
| 1922 | |
| 1923 | def serve_until_quit(self): |
| 1924 | import select |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 1925 | self.quit = False |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1926 | while not self.quit: |
| 1927 | rd, wr, ex = select.select([self.socket.fileno()], [], [], 1) |
| 1928 | if rd: self.handle_request() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1929 | |
| 1930 | def server_activate(self): |
| 1931 | self.base.server_activate(self) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1932 | if self.callback: self.callback(self) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1933 | |
| 1934 | DocServer.base = BaseHTTPServer.HTTPServer |
| 1935 | DocServer.handler = DocHandler |
| 1936 | DocHandler.MessageClass = Message |
| 1937 | try: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1938 | try: |
| 1939 | DocServer(port, callback).serve_until_quit() |
| 1940 | except (KeyboardInterrupt, select.error): |
| 1941 | pass |
| 1942 | finally: |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 1943 | if completer: completer() |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1944 | |
| 1945 | # ----------------------------------------------------- graphical interface |
| 1946 | |
| 1947 | def gui(): |
| 1948 | """Graphical interface (starts web server and pops up a control window).""" |
| 1949 | class GUI: |
| 1950 | def __init__(self, window, port=7464): |
| 1951 | self.window = window |
| 1952 | self.server = None |
| 1953 | self.scanner = None |
| 1954 | |
| 1955 | import Tkinter |
| 1956 | self.server_frm = Tkinter.Frame(window) |
| 1957 | self.title_lbl = Tkinter.Label(self.server_frm, |
| 1958 | text='Starting server...\n ') |
| 1959 | self.open_btn = Tkinter.Button(self.server_frm, |
| 1960 | text='open browser', command=self.open, state='disabled') |
| 1961 | self.quit_btn = Tkinter.Button(self.server_frm, |
| 1962 | text='quit serving', command=self.quit, state='disabled') |
| 1963 | |
| 1964 | self.search_frm = Tkinter.Frame(window) |
| 1965 | self.search_lbl = Tkinter.Label(self.search_frm, text='Search for') |
| 1966 | self.search_ent = Tkinter.Entry(self.search_frm) |
| 1967 | self.search_ent.bind('<Return>', self.search) |
| 1968 | self.stop_btn = Tkinter.Button(self.search_frm, |
| 1969 | text='stop', pady=0, command=self.stop, state='disabled') |
| 1970 | if sys.platform == 'win32': |
Ka-Ping Yee | c92cdf7 | 2001-03-02 05:54:35 +0000 | [diff] [blame] | 1971 | # Trying to hide and show this button crashes under Windows. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1972 | self.stop_btn.pack(side='right') |
| 1973 | |
| 1974 | self.window.title('pydoc') |
| 1975 | self.window.protocol('WM_DELETE_WINDOW', self.quit) |
| 1976 | self.title_lbl.pack(side='top', fill='x') |
| 1977 | self.open_btn.pack(side='left', fill='x', expand=1) |
| 1978 | self.quit_btn.pack(side='right', fill='x', expand=1) |
| 1979 | self.server_frm.pack(side='top', fill='x') |
| 1980 | |
| 1981 | self.search_lbl.pack(side='left') |
| 1982 | self.search_ent.pack(side='right', fill='x', expand=1) |
| 1983 | self.search_frm.pack(side='top', fill='x') |
| 1984 | self.search_ent.focus_set() |
| 1985 | |
Ka-Ping Yee | c92cdf7 | 2001-03-02 05:54:35 +0000 | [diff] [blame] | 1986 | font = ('helvetica', sys.platform == 'win32' and 8 or 10) |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 1987 | self.result_lst = Tkinter.Listbox(window, font=font, height=6) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1988 | self.result_lst.bind('<Button-1>', self.select) |
| 1989 | self.result_lst.bind('<Double-Button-1>', self.goto) |
| 1990 | self.result_scr = Tkinter.Scrollbar(window, |
| 1991 | orient='vertical', command=self.result_lst.yview) |
| 1992 | self.result_lst.config(yscrollcommand=self.result_scr.set) |
| 1993 | |
| 1994 | self.result_frm = Tkinter.Frame(window) |
| 1995 | self.goto_btn = Tkinter.Button(self.result_frm, |
| 1996 | text='go to selected', command=self.goto) |
| 1997 | self.hide_btn = Tkinter.Button(self.result_frm, |
| 1998 | text='hide results', command=self.hide) |
| 1999 | self.goto_btn.pack(side='left', fill='x', expand=1) |
| 2000 | self.hide_btn.pack(side='right', fill='x', expand=1) |
| 2001 | |
| 2002 | self.window.update() |
| 2003 | self.minwidth = self.window.winfo_width() |
| 2004 | self.minheight = self.window.winfo_height() |
| 2005 | self.bigminheight = (self.server_frm.winfo_reqheight() + |
| 2006 | self.search_frm.winfo_reqheight() + |
| 2007 | self.result_lst.winfo_reqheight() + |
| 2008 | self.result_frm.winfo_reqheight()) |
| 2009 | self.bigwidth, self.bigheight = self.minwidth, self.bigminheight |
| 2010 | self.expanded = 0 |
| 2011 | self.window.wm_geometry('%dx%d' % (self.minwidth, self.minheight)) |
| 2012 | self.window.wm_minsize(self.minwidth, self.minheight) |
Martin v. Löwis | 5b26abb | 2002-12-28 09:23:09 +0000 | [diff] [blame] | 2013 | self.window.tk.willdispatch() |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2014 | |
| 2015 | import threading |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 2016 | threading.Thread( |
| 2017 | target=serve, args=(port, self.ready, self.quit)).start() |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2018 | |
| 2019 | def ready(self, server): |
| 2020 | self.server = server |
| 2021 | self.title_lbl.config( |
| 2022 | text='Python documentation server at\n' + server.url) |
| 2023 | self.open_btn.config(state='normal') |
| 2024 | self.quit_btn.config(state='normal') |
| 2025 | |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 2026 | def open(self, event=None, url=None): |
| 2027 | url = url or self.server.url |
| 2028 | try: |
| 2029 | import webbrowser |
| 2030 | webbrowser.open(url) |
| 2031 | except ImportError: # pre-webbrowser.py compatibility |
Ka-Ping Yee | c92cdf7 | 2001-03-02 05:54:35 +0000 | [diff] [blame] | 2032 | if sys.platform == 'win32': |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 2033 | os.system('start "%s"' % url) |
| 2034 | elif sys.platform == 'mac': |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 2035 | try: import ic |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 2036 | except ImportError: pass |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 2037 | else: ic.launchurl(url) |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 2038 | else: |
| 2039 | rc = os.system('netscape -remote "openURL(%s)" &' % url) |
| 2040 | if rc: os.system('netscape "%s" &' % url) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2041 | |
| 2042 | def quit(self, event=None): |
| 2043 | if self.server: |
| 2044 | self.server.quit = 1 |
| 2045 | self.window.quit() |
| 2046 | |
| 2047 | def search(self, event=None): |
| 2048 | key = self.search_ent.get() |
| 2049 | self.stop_btn.pack(side='right') |
| 2050 | self.stop_btn.config(state='normal') |
| 2051 | self.search_lbl.config(text='Searching for "%s"...' % key) |
| 2052 | self.search_ent.forget() |
| 2053 | self.search_lbl.pack(side='left') |
| 2054 | self.result_lst.delete(0, 'end') |
| 2055 | self.goto_btn.config(state='disabled') |
| 2056 | self.expand() |
| 2057 | |
| 2058 | import threading |
| 2059 | if self.scanner: |
| 2060 | self.scanner.quit = 1 |
| 2061 | self.scanner = ModuleScanner() |
| 2062 | threading.Thread(target=self.scanner.run, |
Ka-Ping Yee | 6dcfa38 | 2001-04-12 20:27:31 +0000 | [diff] [blame] | 2063 | args=(self.update, key, self.done)).start() |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2064 | |
| 2065 | def update(self, path, modname, desc): |
| 2066 | if modname[-9:] == '.__init__': |
| 2067 | modname = modname[:-9] + ' (package)' |
| 2068 | self.result_lst.insert('end', |
| 2069 | modname + ' - ' + (desc or '(no description)')) |
| 2070 | |
| 2071 | def stop(self, event=None): |
| 2072 | if self.scanner: |
| 2073 | self.scanner.quit = 1 |
| 2074 | self.scanner = None |
| 2075 | |
| 2076 | def done(self): |
| 2077 | self.scanner = None |
| 2078 | self.search_lbl.config(text='Search for') |
| 2079 | self.search_lbl.pack(side='left') |
| 2080 | self.search_ent.pack(side='right', fill='x', expand=1) |
| 2081 | if sys.platform != 'win32': self.stop_btn.forget() |
| 2082 | self.stop_btn.config(state='disabled') |
| 2083 | |
| 2084 | def select(self, event=None): |
| 2085 | self.goto_btn.config(state='normal') |
| 2086 | |
| 2087 | def goto(self, event=None): |
| 2088 | selection = self.result_lst.curselection() |
| 2089 | if selection: |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2090 | modname = split(self.result_lst.get(selection[0]))[0] |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 2091 | self.open(url=self.server.url + modname + '.html') |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2092 | |
| 2093 | def collapse(self): |
| 2094 | if not self.expanded: return |
| 2095 | self.result_frm.forget() |
| 2096 | self.result_scr.forget() |
| 2097 | self.result_lst.forget() |
| 2098 | self.bigwidth = self.window.winfo_width() |
| 2099 | self.bigheight = self.window.winfo_height() |
| 2100 | self.window.wm_geometry('%dx%d' % (self.minwidth, self.minheight)) |
| 2101 | self.window.wm_minsize(self.minwidth, self.minheight) |
| 2102 | self.expanded = 0 |
| 2103 | |
| 2104 | def expand(self): |
| 2105 | if self.expanded: return |
| 2106 | self.result_frm.pack(side='bottom', fill='x') |
| 2107 | self.result_scr.pack(side='right', fill='y') |
| 2108 | self.result_lst.pack(side='top', fill='both', expand=1) |
| 2109 | self.window.wm_geometry('%dx%d' % (self.bigwidth, self.bigheight)) |
| 2110 | self.window.wm_minsize(self.minwidth, self.bigminheight) |
| 2111 | self.expanded = 1 |
| 2112 | |
| 2113 | def hide(self, event=None): |
| 2114 | self.stop() |
| 2115 | self.collapse() |
| 2116 | |
| 2117 | import Tkinter |
| 2118 | try: |
| 2119 | gui = GUI(Tkinter.Tk()) |
| 2120 | Tkinter.mainloop() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2121 | except KeyboardInterrupt: |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2122 | pass |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2123 | |
| 2124 | # -------------------------------------------------- command-line interface |
| 2125 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2126 | def ispath(x): |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 2127 | return isinstance(x, str) and find(x, os.sep) >= 0 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2128 | |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 2129 | def cli(): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2130 | """Command-line interface (looks at sys.argv to decide what to do).""" |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2131 | import getopt |
| 2132 | class BadUsage: pass |
| 2133 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 2134 | # Scripts don't get the current directory in their path by default. |
Ka-Ping Yee | f78a81b | 2001-03-27 08:13:42 +0000 | [diff] [blame] | 2135 | scriptdir = os.path.dirname(sys.argv[0]) |
| 2136 | if scriptdir in sys.path: |
| 2137 | sys.path.remove(scriptdir) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 2138 | sys.path.insert(0, '.') |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2139 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 2140 | try: |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2141 | opts, args = getopt.getopt(sys.argv[1:], 'gk:p:w') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2142 | writing = 0 |
| 2143 | |
| 2144 | for opt, val in opts: |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2145 | if opt == '-g': |
| 2146 | gui() |
| 2147 | return |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2148 | if opt == '-k': |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2149 | apropos(val) |
| 2150 | return |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2151 | if opt == '-p': |
| 2152 | try: |
| 2153 | port = int(val) |
| 2154 | except ValueError: |
| 2155 | raise BadUsage |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2156 | def ready(server): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 2157 | print 'pydoc server ready at %s' % server.url |
| 2158 | def stopped(): |
| 2159 | print 'pydoc server stopped' |
| 2160 | serve(port, ready, stopped) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2161 | return |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2162 | if opt == '-w': |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2163 | writing = 1 |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2164 | |
| 2165 | if not args: raise BadUsage |
| 2166 | for arg in args: |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 2167 | if ispath(arg) and not os.path.exists(arg): |
| 2168 | print 'file %r does not exist' % arg |
| 2169 | break |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2170 | try: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2171 | if ispath(arg) and os.path.isfile(arg): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2172 | arg = importfile(arg) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2173 | if writing: |
| 2174 | if ispath(arg) and os.path.isdir(arg): |
| 2175 | writedocs(arg) |
| 2176 | else: |
| 2177 | writedoc(arg) |
| 2178 | else: |
Martin v. Löwis | b8c084e | 2003-06-14 09:03:46 +0000 | [diff] [blame] | 2179 | help.help(arg) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 2180 | except ErrorDuringImport, value: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2181 | print value |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2182 | |
| 2183 | except (getopt.error, BadUsage): |
Martin v. Löwis | f9b08b8 | 2003-10-31 13:05:21 +0000 | [diff] [blame] | 2184 | cmd = os.path.basename(sys.argv[0]) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2185 | print """pydoc - the Python documentation tool |
| 2186 | |
| 2187 | %s <name> ... |
| 2188 | Show text documentation on something. <name> may be the name of a |
Martin v. Löwis | b8c084e | 2003-06-14 09:03:46 +0000 | [diff] [blame] | 2189 | Python keyword, topic, function, module, or package, or a dotted |
| 2190 | reference to a class or function within a module or module in a |
| 2191 | package. If <name> contains a '%s', it is used as the path to a |
| 2192 | Python source file to document. If name is 'keywords', 'topics', |
| 2193 | or 'modules', a listing of these things is displayed. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2194 | |
| 2195 | %s -k <keyword> |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2196 | Search for a keyword in the synopsis lines of all available modules. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2197 | |
| 2198 | %s -p <port> |
| 2199 | Start an HTTP server on the given port on the local machine. |
| 2200 | |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2201 | %s -g |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 2202 | Pop up a graphical interface for finding and serving documentation. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2203 | |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2204 | %s -w <name> ... |
| 2205 | Write out the HTML documentation for a module to a file in the current |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 2206 | directory. If <name> contains a '%s', it is treated as a filename; if |
| 2207 | it names a directory, documentation is written for all the contents. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2208 | """ % (cmd, os.sep, cmd, cmd, cmd, cmd, os.sep) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 2209 | |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2210 | if __name__ == '__main__': cli() |