Benjamin Peterson | 90f5ba5 | 2010-03-11 22:53:45 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 2 | """Generate Python documentation in HTML or text for interactive use. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 3 | |
R David Murray | 3d050dd | 2014-04-19 12:59:30 -0400 | [diff] [blame] | 4 | At the Python interactive prompt, calling help(thing) on a Python object |
| 5 | documents the object, and calling help() starts up an interactive |
| 6 | help session. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 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 | |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 19 | Run "pydoc -n <hostname>" to start an HTTP server with the given |
| 20 | hostname (default: localhost) on the local machine. |
| 21 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 22 | Run "pydoc -p <port>" to start an HTTP server on the given port on the |
| 23 | local machine. Port number 0 can be used to get an arbitrary unused port. |
| 24 | |
| 25 | Run "pydoc -b" to start an HTTP server on an arbitrary unused port and |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 26 | open a Web browser to interactively browse documentation. Combine with |
| 27 | the -n and -p options to control the hostname and port used. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 28 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 29 | Run "pydoc -w <name>" to write out the HTML documentation for a module |
| 30 | to a file named "<name>.html". |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 31 | |
| 32 | Module docs for core modules are assumed to be in |
| 33 | |
Martin Panter | 4f8aaf6 | 2016-06-12 04:24:06 +0000 | [diff] [blame] | 34 | https://docs.python.org/X.Y/library/ |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 35 | |
| 36 | This can be overridden by setting the PYTHONDOCS environment variable |
| 37 | to a different URL or to a local directory containing the Library |
| 38 | Reference Manual pages. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 39 | """ |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 40 | __all__ = ['help'] |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 41 | __author__ = "Ka-Ping Yee <ping@lfw.org>" |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 42 | __date__ = "26 February 2001" |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 43 | |
Martin v. Löwis | 6fe8f19 | 2004-11-14 10:21:04 +0000 | [diff] [blame] | 44 | __credits__ = """Guido van Rossum, for an excellent programming language. |
Ka-Ping Yee | 5e2b173 | 2001-02-27 23:35:09 +0000 | [diff] [blame] | 45 | Tommy Burnette, the original creator of manpy. |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 46 | Paul Prescod, for all his work on onlinehelp. |
| 47 | Richard Chamberlain, for the first implementation of textdoc. |
Raymond Hettinger | ed2dbe3 | 2005-01-01 07:51:01 +0000 | [diff] [blame] | 48 | """ |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 49 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 50 | # Known bugs that can't be fixed here: |
Brett Cannon | f4ba4ec | 2013-06-15 14:25:04 -0400 | [diff] [blame] | 51 | # - synopsis() cannot be prevented from clobbering existing |
| 52 | # loaded modules. |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 53 | # - If the __file__ attribute on a module is a relative path and |
| 54 | # the current directory is changed with os.chdir(), an incorrect |
| 55 | # path will be displayed. |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 56 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 57 | import builtins |
Brett Cannon | d5e6f2e | 2013-06-11 17:09:36 -0400 | [diff] [blame] | 58 | import importlib._bootstrap |
Eric Snow | 32439d6 | 2015-05-02 19:15:18 -0600 | [diff] [blame] | 59 | import importlib._bootstrap_external |
Brett Cannon | cb66eb0 | 2012-05-11 12:58:42 -0400 | [diff] [blame] | 60 | import importlib.machinery |
Brett Cannon | f4ba4ec | 2013-06-15 14:25:04 -0400 | [diff] [blame] | 61 | import importlib.util |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 62 | import inspect |
Victor Stinner | e6c910e | 2011-06-30 15:55:43 +0200 | [diff] [blame] | 63 | import io |
| 64 | import os |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 65 | import pkgutil |
| 66 | import platform |
| 67 | import re |
Victor Stinner | e6c910e | 2011-06-30 15:55:43 +0200 | [diff] [blame] | 68 | import sys |
Victor Stinner | 4fac7ed | 2020-02-12 13:02:29 +0100 | [diff] [blame] | 69 | import sysconfig |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 70 | import time |
Victor Stinner | e6c910e | 2011-06-30 15:55:43 +0200 | [diff] [blame] | 71 | import tokenize |
Zachary Ware | eb43214 | 2014-07-10 11:18:00 -0500 | [diff] [blame] | 72 | import urllib.parse |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 73 | import warnings |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 74 | from collections import deque |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 75 | from reprlib import Repr |
Victor Stinner | 7fa767e | 2014-03-20 09:16:38 +0100 | [diff] [blame] | 76 | from traceback import format_exception_only |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 77 | |
| 78 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 79 | # --------------------------------------------------------- common routines |
| 80 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 81 | def pathdirs(): |
| 82 | """Convert sys.path into a list of absolute, existing, unique paths.""" |
| 83 | dirs = [] |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 84 | normdirs = [] |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 85 | for dir in sys.path: |
| 86 | dir = os.path.abspath(dir or '.') |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 87 | normdir = os.path.normcase(dir) |
| 88 | if normdir not in normdirs and os.path.isdir(dir): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 89 | dirs.append(dir) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 90 | normdirs.append(normdir) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 91 | return dirs |
| 92 | |
Serhiy Storchaka | 08b47c3 | 2020-05-18 20:25:07 +0300 | [diff] [blame] | 93 | def _findclass(func): |
| 94 | cls = sys.modules.get(func.__module__) |
| 95 | if cls is None: |
| 96 | return None |
| 97 | for name in func.__qualname__.split('.')[:-1]: |
| 98 | cls = getattr(cls, name) |
| 99 | if not inspect.isclass(cls): |
| 100 | return None |
| 101 | return cls |
| 102 | |
| 103 | def _finddoc(obj): |
| 104 | if inspect.ismethod(obj): |
| 105 | name = obj.__func__.__name__ |
| 106 | self = obj.__self__ |
| 107 | if (inspect.isclass(self) and |
| 108 | getattr(getattr(self, name, None), '__func__') is obj.__func__): |
| 109 | # classmethod |
| 110 | cls = self |
| 111 | else: |
| 112 | cls = self.__class__ |
| 113 | elif inspect.isfunction(obj): |
| 114 | name = obj.__name__ |
| 115 | cls = _findclass(obj) |
| 116 | if cls is None or getattr(cls, name) is not obj: |
| 117 | return None |
| 118 | elif inspect.isbuiltin(obj): |
| 119 | name = obj.__name__ |
| 120 | self = obj.__self__ |
| 121 | if (inspect.isclass(self) and |
| 122 | self.__qualname__ + '.' + name == obj.__qualname__): |
| 123 | # classmethod |
| 124 | cls = self |
| 125 | else: |
| 126 | cls = self.__class__ |
| 127 | # Should be tested before isdatadescriptor(). |
| 128 | elif isinstance(obj, property): |
| 129 | func = obj.fget |
| 130 | name = func.__name__ |
| 131 | cls = _findclass(func) |
| 132 | if cls is None or getattr(cls, name) is not obj: |
| 133 | return None |
| 134 | elif inspect.ismethoddescriptor(obj) or inspect.isdatadescriptor(obj): |
| 135 | name = obj.__name__ |
| 136 | cls = obj.__objclass__ |
| 137 | if getattr(cls, name) is not obj: |
| 138 | return None |
| 139 | if inspect.ismemberdescriptor(obj): |
| 140 | slots = getattr(cls, '__slots__', None) |
| 141 | if isinstance(slots, dict) and name in slots: |
| 142 | return slots[name] |
| 143 | else: |
| 144 | return None |
| 145 | for base in cls.__mro__: |
| 146 | try: |
| 147 | doc = _getowndoc(getattr(base, name)) |
| 148 | except AttributeError: |
| 149 | continue |
| 150 | if doc is not None: |
| 151 | return doc |
| 152 | return None |
| 153 | |
| 154 | def _getowndoc(obj): |
| 155 | """Get the documentation string for an object if it is not |
| 156 | inherited from its class.""" |
| 157 | try: |
| 158 | doc = object.__getattribute__(obj, '__doc__') |
| 159 | if doc is None: |
| 160 | return None |
| 161 | if obj is not type: |
| 162 | typedoc = type(obj).__doc__ |
| 163 | if isinstance(typedoc, str) and typedoc == doc: |
| 164 | return None |
| 165 | return doc |
| 166 | except AttributeError: |
| 167 | return None |
| 168 | |
| 169 | def _getdoc(object): |
| 170 | """Get the documentation string for an object. |
| 171 | |
| 172 | All tabs are expanded to spaces. To clean up docstrings that are |
| 173 | indented to line up with blocks of code, any whitespace than can be |
| 174 | uniformly removed from the second line onwards is removed.""" |
| 175 | doc = _getowndoc(object) |
| 176 | if doc is None: |
| 177 | try: |
| 178 | doc = _finddoc(object) |
| 179 | except (AttributeError, TypeError): |
| 180 | return None |
| 181 | if not isinstance(doc, str): |
| 182 | return None |
| 183 | return inspect.cleandoc(doc) |
| 184 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 185 | def getdoc(object): |
| 186 | """Get the doc string or comments for an object.""" |
Serhiy Storchaka | 08b47c3 | 2020-05-18 20:25:07 +0300 | [diff] [blame] | 187 | result = _getdoc(object) or inspect.getcomments(object) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 188 | return result and re.sub('^ *\n', '', result.rstrip()) or '' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 189 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 190 | def splitdoc(doc): |
| 191 | """Split a doc string into a synopsis line (if any) and the rest.""" |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 192 | lines = doc.strip().split('\n') |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 193 | if len(lines) == 1: |
| 194 | return lines[0], '' |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 195 | elif len(lines) >= 2 and not lines[1].rstrip(): |
| 196 | return lines[0], '\n'.join(lines[2:]) |
| 197 | return '', '\n'.join(lines) |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 198 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 199 | def classname(object, modname): |
| 200 | """Get a class name and qualify it with a module name if necessary.""" |
| 201 | name = object.__name__ |
| 202 | if object.__module__ != modname: |
| 203 | name = object.__module__ + '.' + name |
| 204 | return name |
| 205 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 206 | def isdata(object): |
Georg Brandl | 9443242 | 2005-07-22 21:52:25 +0000 | [diff] [blame] | 207 | """Check if an object is of a type that probably means it's data.""" |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 208 | return not (inspect.ismodule(object) or inspect.isclass(object) or |
| 209 | inspect.isroutine(object) or inspect.isframe(object) or |
| 210 | inspect.istraceback(object) or inspect.iscode(object)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 211 | |
| 212 | def replace(text, *pairs): |
| 213 | """Do a series of global replacements on a string.""" |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 214 | while pairs: |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 215 | text = pairs[1].join(text.split(pairs[0])) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 216 | pairs = pairs[2:] |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 217 | return text |
| 218 | |
| 219 | def cram(text, maxlen): |
| 220 | """Omit part of a string if needed to make it fit in a maximum length.""" |
| 221 | if len(text) > maxlen: |
Raymond Hettinger | fca3bb6 | 2002-10-21 04:44:11 +0000 | [diff] [blame] | 222 | pre = max(0, (maxlen-3)//2) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 223 | post = max(0, maxlen-3-pre) |
| 224 | return text[:pre] + '...' + text[len(text)-post:] |
| 225 | return text |
| 226 | |
Brett Cannon | 84601f1 | 2004-06-19 01:22:48 +0000 | [diff] [blame] | 227 | _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] | 228 | def stripid(text): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 229 | """Remove the hexadecimal id from a Python object representation.""" |
Brett Cannon | c6c1f47 | 2004-06-19 01:02:51 +0000 | [diff] [blame] | 230 | # The behaviour of %p is implementation-dependent in terms of case. |
Ezio Melotti | 412c95a | 2010-02-16 23:31:04 +0000 | [diff] [blame] | 231 | return _re_stripid.sub(r'\1', text) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 232 | |
Larry Hastings | 24a882b | 2014-02-20 23:34:46 -0800 | [diff] [blame] | 233 | def _is_bound_method(fn): |
| 234 | """ |
| 235 | Returns True if fn is a bound method, regardless of whether |
| 236 | fn was implemented in Python or in C. |
| 237 | """ |
| 238 | if inspect.ismethod(fn): |
| 239 | return True |
| 240 | if inspect.isbuiltin(fn): |
| 241 | self = getattr(fn, '__self__', None) |
| 242 | return not (inspect.ismodule(self) or (self is None)) |
| 243 | return False |
| 244 | |
| 245 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 246 | def allmethods(cl): |
| 247 | methods = {} |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 248 | for key, value in inspect.getmembers(cl, inspect.isroutine): |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 249 | methods[key] = 1 |
| 250 | for base in cl.__bases__: |
| 251 | methods.update(allmethods(base)) # all your base are belong to us |
| 252 | for key in methods.keys(): |
| 253 | methods[key] = getattr(cl, key) |
| 254 | return methods |
| 255 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 256 | def _split_list(s, predicate): |
| 257 | """Split sequence s via predicate, and return pair ([true], [false]). |
| 258 | |
| 259 | The return value is a 2-tuple of lists, |
| 260 | ([x for x in s if predicate(x)], |
| 261 | [x for x in s if not predicate(x)]) |
| 262 | """ |
| 263 | |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 264 | yes = [] |
| 265 | no = [] |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 266 | for x in s: |
| 267 | if predicate(x): |
| 268 | yes.append(x) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 269 | else: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 270 | no.append(x) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 271 | return yes, no |
| 272 | |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 273 | def visiblename(name, all=None, obj=None): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 274 | """Decide whether to show documentation on a variable.""" |
Brett Cannon | d340b43 | 2012-08-06 17:19:22 -0400 | [diff] [blame] | 275 | # Certain special names are redundant or internal. |
Eric Snow | b523f84 | 2013-11-22 09:05:39 -0700 | [diff] [blame] | 276 | # XXX Remove __initializing__? |
Brett Cannon | d340b43 | 2012-08-06 17:19:22 -0400 | [diff] [blame] | 277 | if name in {'__author__', '__builtins__', '__cached__', '__credits__', |
Eric Snow | b523f84 | 2013-11-22 09:05:39 -0700 | [diff] [blame] | 278 | '__date__', '__doc__', '__file__', '__spec__', |
Brett Cannon | d340b43 | 2012-08-06 17:19:22 -0400 | [diff] [blame] | 279 | '__loader__', '__module__', '__name__', '__package__', |
| 280 | '__path__', '__qualname__', '__slots__', '__version__'}: |
Raymond Hettinger | 6827294 | 2011-03-18 02:22:15 -0700 | [diff] [blame] | 281 | return 0 |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 282 | # Private names are hidden, but special names are displayed. |
| 283 | if name.startswith('__') and name.endswith('__'): return 1 |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 284 | # Namedtuples have public fields and methods with a single leading underscore |
| 285 | if name.startswith('_') and hasattr(obj, '_fields'): |
| 286 | return True |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 287 | if all is not None: |
| 288 | # only document that which the programmer exported in __all__ |
| 289 | return name in all |
| 290 | else: |
| 291 | return not name.startswith('_') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 292 | |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 293 | def classify_class_attrs(object): |
| 294 | """Wrap inspect.classify_class_attrs, with fixup for data descriptors.""" |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 295 | results = [] |
| 296 | for (name, kind, cls, value) in inspect.classify_class_attrs(object): |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 297 | if inspect.isdatadescriptor(value): |
| 298 | kind = 'data descriptor' |
Raymond Hettinger | 62be338 | 2019-03-24 17:07:47 -0700 | [diff] [blame] | 299 | if isinstance(value, property) and value.fset is None: |
| 300 | kind = 'readonly property' |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 301 | results.append((name, kind, cls, value)) |
| 302 | return results |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 303 | |
Raymond Hettinger | 95801bb | 2015-08-18 22:25:16 -0700 | [diff] [blame] | 304 | def sort_attributes(attrs, object): |
| 305 | 'Sort the attrs list in-place by _fields and then alphabetically by name' |
| 306 | # This allows data descriptors to be ordered according |
| 307 | # to a _fields attribute if present. |
| 308 | fields = getattr(object, '_fields', []) |
| 309 | try: |
| 310 | field_order = {name : i-len(fields) for (i, name) in enumerate(fields)} |
| 311 | except TypeError: |
| 312 | field_order = {} |
| 313 | keyfunc = lambda attr: (field_order.get(attr[0], 0), attr[0]) |
| 314 | attrs.sort(key=keyfunc) |
| 315 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 316 | # ----------------------------------------------------- module manipulation |
| 317 | |
| 318 | def ispackage(path): |
| 319 | """Guess whether a path refers to a package directory.""" |
| 320 | if os.path.isdir(path): |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 321 | for ext in ('.py', '.pyc'): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 322 | if os.path.isfile(os.path.join(path, '__init__' + ext)): |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 323 | return True |
| 324 | return False |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 325 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 326 | def source_synopsis(file): |
| 327 | line = file.readline() |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 328 | while line[:1] == '#' or not line.strip(): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 329 | line = file.readline() |
| 330 | if not line: break |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 331 | line = line.strip() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 332 | if line[:4] == 'r"""': line = line[1:] |
| 333 | if line[:3] == '"""': |
| 334 | line = line[3:] |
| 335 | if line[-1:] == '\\': line = line[:-1] |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 336 | while not line.strip(): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 337 | line = file.readline() |
| 338 | if not line: break |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 339 | result = line.split('"""')[0].strip() |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 340 | else: result = None |
| 341 | return result |
| 342 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 343 | def synopsis(filename, cache={}): |
| 344 | """Get the one-line summary out of a module file.""" |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 345 | mtime = os.stat(filename).st_mtime |
Charles-François Natali | 27c4e88 | 2011-07-27 19:40:02 +0200 | [diff] [blame] | 346 | lastupdate, result = cache.get(filename, (None, None)) |
| 347 | if lastupdate is None or lastupdate < mtime: |
Eric Snow | aed5b22 | 2014-01-04 20:38:11 -0700 | [diff] [blame] | 348 | # Look for binary suffixes first, falling back to source. |
| 349 | if filename.endswith(tuple(importlib.machinery.BYTECODE_SUFFIXES)): |
| 350 | loader_cls = importlib.machinery.SourcelessFileLoader |
| 351 | elif filename.endswith(tuple(importlib.machinery.EXTENSION_SUFFIXES)): |
| 352 | loader_cls = importlib.machinery.ExtensionFileLoader |
| 353 | else: |
| 354 | loader_cls = None |
| 355 | # Now handle the choice. |
| 356 | if loader_cls is None: |
| 357 | # Must be a source file. |
| 358 | try: |
| 359 | file = tokenize.open(filename) |
| 360 | except OSError: |
| 361 | # module can't be opened, so skip it |
| 362 | return None |
| 363 | # text modules can be directly examined |
| 364 | with file: |
| 365 | result = source_synopsis(file) |
| 366 | else: |
| 367 | # Must be a binary module, which has to be imported. |
| 368 | loader = loader_cls('__temp__', filename) |
Eric Snow | 3a62d14 | 2014-01-06 20:42:59 -0700 | [diff] [blame] | 369 | # XXX We probably don't need to pass in the loader here. |
| 370 | spec = importlib.util.spec_from_file_location('__temp__', filename, |
| 371 | loader=loader) |
Brett Cannon | cb66eb0 | 2012-05-11 12:58:42 -0400 | [diff] [blame] | 372 | try: |
Brett Cannon | 2a17bde | 2014-05-30 14:55:29 -0400 | [diff] [blame] | 373 | module = importlib._bootstrap._load(spec) |
Brett Cannon | cb66eb0 | 2012-05-11 12:58:42 -0400 | [diff] [blame] | 374 | except: |
| 375 | return None |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 376 | del sys.modules['__temp__'] |
Benjamin Peterson | 54237f9 | 2015-02-16 19:45:01 -0500 | [diff] [blame] | 377 | result = module.__doc__.splitlines()[0] if module.__doc__ else None |
Eric Snow | aed5b22 | 2014-01-04 20:38:11 -0700 | [diff] [blame] | 378 | # Cache the result. |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 379 | cache[filename] = (mtime, result) |
| 380 | return result |
| 381 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 382 | class ErrorDuringImport(Exception): |
| 383 | """Errors that occurred while trying to import something to document it.""" |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 384 | def __init__(self, filename, exc_info): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 385 | self.filename = filename |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 386 | self.exc, self.value, self.tb = exc_info |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 387 | |
| 388 | def __str__(self): |
Guido van Rossum | a01a8b6 | 2007-05-27 09:20:14 +0000 | [diff] [blame] | 389 | exc = self.exc.__name__ |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 390 | return 'problem in %s - %s: %s' % (self.filename, exc, self.value) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 391 | |
| 392 | def importfile(path): |
| 393 | """Import a Python source file or compiled file given its path.""" |
Brett Cannon | f4ba4ec | 2013-06-15 14:25:04 -0400 | [diff] [blame] | 394 | magic = importlib.util.MAGIC_NUMBER |
Victor Stinner | e975af6 | 2011-07-04 02:08:50 +0200 | [diff] [blame] | 395 | with open(path, 'rb') as file: |
Brett Cannon | d5e6f2e | 2013-06-11 17:09:36 -0400 | [diff] [blame] | 396 | is_bytecode = magic == file.read(len(magic)) |
| 397 | filename = os.path.basename(path) |
| 398 | name, ext = os.path.splitext(filename) |
| 399 | if is_bytecode: |
Eric Snow | 32439d6 | 2015-05-02 19:15:18 -0600 | [diff] [blame] | 400 | loader = importlib._bootstrap_external.SourcelessFileLoader(name, path) |
Brett Cannon | d5e6f2e | 2013-06-11 17:09:36 -0400 | [diff] [blame] | 401 | else: |
Eric Snow | 32439d6 | 2015-05-02 19:15:18 -0600 | [diff] [blame] | 402 | loader = importlib._bootstrap_external.SourceFileLoader(name, path) |
Eric Snow | 3a62d14 | 2014-01-06 20:42:59 -0700 | [diff] [blame] | 403 | # XXX We probably don't need to pass in the loader here. |
| 404 | spec = importlib.util.spec_from_file_location(name, path, loader=loader) |
Brett Cannon | d5e6f2e | 2013-06-11 17:09:36 -0400 | [diff] [blame] | 405 | try: |
Brett Cannon | 2a17bde | 2014-05-30 14:55:29 -0400 | [diff] [blame] | 406 | return importlib._bootstrap._load(spec) |
Brett Cannon | d5e6f2e | 2013-06-11 17:09:36 -0400 | [diff] [blame] | 407 | except: |
| 408 | raise ErrorDuringImport(path, sys.exc_info()) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 409 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 410 | def safeimport(path, forceload=0, cache={}): |
| 411 | """Import a module; handle errors; return None if the module isn't found. |
| 412 | |
| 413 | If the module *is* found but an exception occurs, it's wrapped in an |
| 414 | ErrorDuringImport exception and reraised. Unlike __import__, if a |
| 415 | package path is specified, the module at the end of the path is returned, |
| 416 | not the package at the beginning. If the optional 'forceload' argument |
| 417 | is 1, we reload the module from disk (unless it's a dynamic extension).""" |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 418 | try: |
Ka-Ping Yee | 9a2dcf8 | 2005-11-05 05:04:41 +0000 | [diff] [blame] | 419 | # If forceload is 1 and the module has been previously loaded from |
| 420 | # disk, we always have to reload the module. Checking the file's |
| 421 | # mtime isn't good enough (e.g. the module could contain a class |
| 422 | # that inherits from another module that has changed). |
| 423 | if forceload and path in sys.modules: |
| 424 | if path not in sys.builtin_module_names: |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 425 | # Remove the module from sys.modules and re-import to try |
| 426 | # and avoid problems with partially loaded modules. |
| 427 | # Also remove any submodules because they won't appear |
| 428 | # in the newly loaded module's namespace if they're already |
| 429 | # in sys.modules. |
Ka-Ping Yee | 9a2dcf8 | 2005-11-05 05:04:41 +0000 | [diff] [blame] | 430 | subs = [m for m in sys.modules if m.startswith(path + '.')] |
| 431 | for key in [path] + subs: |
| 432 | # Prevent garbage collection. |
| 433 | cache[key] = sys.modules[key] |
| 434 | del sys.modules[key] |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 435 | module = __import__(path) |
| 436 | except: |
| 437 | # Did the error occur before or after the module was found? |
| 438 | (exc, value, tb) = info = sys.exc_info() |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 439 | if path in sys.modules: |
Fred Drake | db390c1 | 2005-10-28 14:39:47 +0000 | [diff] [blame] | 440 | # An error occurred while executing the imported module. |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 441 | raise ErrorDuringImport(sys.modules[path].__file__, info) |
| 442 | elif exc is SyntaxError: |
| 443 | # A SyntaxError occurred before we could execute the module. |
| 444 | raise ErrorDuringImport(value.filename, info) |
Eric Snow | 46f97b8 | 2016-09-07 16:56:15 -0700 | [diff] [blame] | 445 | elif issubclass(exc, ImportError) and value.name == path: |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 446 | # No such module in the path. |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 447 | return None |
| 448 | else: |
| 449 | # Some other error occurred during the importing process. |
| 450 | raise ErrorDuringImport(path, sys.exc_info()) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 451 | for part in path.split('.')[1:]: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 452 | try: module = getattr(module, part) |
| 453 | except AttributeError: return None |
| 454 | return module |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 455 | |
| 456 | # ---------------------------------------------------- formatter base class |
| 457 | |
| 458 | class Doc: |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 459 | |
| 460 | PYTHONDOCS = os.environ.get("PYTHONDOCS", |
R David Murray | ead9bfc | 2016-06-03 19:28:35 -0400 | [diff] [blame] | 461 | "https://docs.python.org/%d.%d/library" |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 462 | % sys.version_info[:2]) |
| 463 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 464 | def document(self, object, name=None, *args): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 465 | """Generate documentation for an object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 466 | args = (object, name) + args |
Brett Cannon | 28a4f0f | 2003-06-11 23:38:55 +0000 | [diff] [blame] | 467 | # 'try' clause is to attempt to handle the possibility that inspect |
| 468 | # identifies something in a way that pydoc itself has issues handling; |
| 469 | # think 'super' and how it is a descriptor (which raises the exception |
| 470 | # by lacking a __name__ attribute) and an instance. |
| 471 | try: |
| 472 | if inspect.ismodule(object): return self.docmodule(*args) |
| 473 | if inspect.isclass(object): return self.docclass(*args) |
| 474 | if inspect.isroutine(object): return self.docroutine(*args) |
| 475 | except AttributeError: |
| 476 | pass |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 477 | if inspect.isdatadescriptor(object): return self.docdata(*args) |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 478 | return self.docother(*args) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 479 | |
| 480 | def fail(self, object, name=None, *args): |
| 481 | """Raise an exception for unimplemented types.""" |
| 482 | message = "don't know how to document object%s of type %s" % ( |
| 483 | name and ' ' + repr(name), type(object).__name__) |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 484 | raise TypeError(message) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 485 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 486 | docmodule = docclass = docroutine = docother = docproperty = docdata = fail |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 487 | |
Victor Stinner | 4fac7ed | 2020-02-12 13:02:29 +0100 | [diff] [blame] | 488 | def getdocloc(self, object, basedir=sysconfig.get_path('stdlib')): |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 489 | """Return the location of module docs or None""" |
| 490 | |
| 491 | try: |
| 492 | file = inspect.getabsfile(object) |
| 493 | except TypeError: |
| 494 | file = '(built-in)' |
| 495 | |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 496 | docloc = os.environ.get("PYTHONDOCS", self.PYTHONDOCS) |
| 497 | |
Martin Panter | 4f8aaf6 | 2016-06-12 04:24:06 +0000 | [diff] [blame] | 498 | basedir = os.path.normcase(basedir) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 499 | if (isinstance(object, type(os)) and |
| 500 | (object.__name__ in ('errno', 'exceptions', 'gc', 'imp', |
| 501 | 'marshal', 'posix', 'signal', 'sys', |
Georg Brandl | 2067bfd | 2008-05-25 13:05:15 +0000 | [diff] [blame] | 502 | '_thread', 'zipimport') or |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 503 | (file.startswith(basedir) and |
Brian Curtin | 49c284c | 2010-03-31 03:19:28 +0000 | [diff] [blame] | 504 | not file.startswith(os.path.join(basedir, 'site-packages')))) and |
Brian Curtin | edef05b | 2010-04-01 04:05:25 +0000 | [diff] [blame] | 505 | object.__name__ not in ('xml.etree', 'test.pydoc_mod')): |
Martin Panter | 4f8aaf6 | 2016-06-12 04:24:06 +0000 | [diff] [blame] | 506 | if docloc.startswith(("http://", "https://")): |
R David Murray | ead9bfc | 2016-06-03 19:28:35 -0400 | [diff] [blame] | 507 | docloc = "%s/%s" % (docloc.rstrip("/"), object.__name__.lower()) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 508 | else: |
R David Murray | ead9bfc | 2016-06-03 19:28:35 -0400 | [diff] [blame] | 509 | docloc = os.path.join(docloc, object.__name__.lower() + ".html") |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 510 | else: |
| 511 | docloc = None |
| 512 | return docloc |
| 513 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 514 | # -------------------------------------------- HTML documentation generator |
| 515 | |
| 516 | class HTMLRepr(Repr): |
| 517 | """Class for safely making an HTML representation of a Python object.""" |
| 518 | def __init__(self): |
| 519 | Repr.__init__(self) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 520 | self.maxlist = self.maxtuple = 20 |
| 521 | self.maxdict = 10 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 522 | self.maxstring = self.maxother = 100 |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 523 | |
| 524 | def escape(self, text): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 525 | return replace(text, '&', '&', '<', '<', '>', '>') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 526 | |
| 527 | def repr(self, object): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 528 | return Repr.repr(self, object) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 529 | |
| 530 | def repr1(self, x, level): |
Skip Montanaro | 0fe8fce | 2003-06-27 15:45:41 +0000 | [diff] [blame] | 531 | if hasattr(type(x), '__name__'): |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 532 | methodname = 'repr_' + '_'.join(type(x).__name__.split()) |
Skip Montanaro | 0fe8fce | 2003-06-27 15:45:41 +0000 | [diff] [blame] | 533 | if hasattr(self, methodname): |
| 534 | return getattr(self, methodname)(x, level) |
| 535 | return self.escape(cram(stripid(repr(x)), self.maxother)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 536 | |
| 537 | def repr_string(self, x, level): |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 538 | test = cram(x, self.maxstring) |
| 539 | testrepr = repr(test) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 540 | if '\\' in test and '\\' not in replace(testrepr, r'\\', ''): |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 541 | # Backslashes are only literal in the string and are never |
| 542 | # needed to make any special characters, so show a raw string. |
| 543 | return 'r' + testrepr[0] + self.escape(test) + testrepr[0] |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 544 | return re.sub(r'((\\[\\abfnrtv\'"]|\\[0-9]..|\\x..|\\u....)+)', |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 545 | r'<font color="#c040c0">\1</font>', |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 546 | self.escape(testrepr)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 547 | |
Skip Montanaro | df70878 | 2002-03-07 22:58:02 +0000 | [diff] [blame] | 548 | repr_str = repr_string |
| 549 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 550 | def repr_instance(self, x, level): |
| 551 | try: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 552 | return self.escape(cram(stripid(repr(x)), self.maxstring)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 553 | except: |
| 554 | return self.escape('<%s instance>' % x.__class__.__name__) |
| 555 | |
| 556 | repr_unicode = repr_string |
| 557 | |
| 558 | class HTMLDoc(Doc): |
| 559 | """Formatter class for HTML documentation.""" |
| 560 | |
| 561 | # ------------------------------------------- HTML formatting utilities |
| 562 | |
| 563 | _repr_instance = HTMLRepr() |
| 564 | repr = _repr_instance.repr |
| 565 | escape = _repr_instance.escape |
| 566 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 567 | def page(self, title, contents): |
| 568 | """Format an HTML page.""" |
Georg Brandl | 388faac | 2009-04-10 08:31:48 +0000 | [diff] [blame] | 569 | return '''\ |
Georg Brandl | e606694 | 2009-04-10 08:28:28 +0000 | [diff] [blame] | 570 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 571 | <html><head><title>Python: %s</title> |
Georg Brandl | 388faac | 2009-04-10 08:31:48 +0000 | [diff] [blame] | 572 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 573 | </head><body bgcolor="#f0f0f8"> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 574 | %s |
| 575 | </body></html>''' % (title, contents) |
| 576 | |
| 577 | def heading(self, title, fgcol, bgcol, extras=''): |
| 578 | """Format a page heading.""" |
| 579 | return ''' |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 580 | <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 581 | <tr bgcolor="%s"> |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 582 | <td valign=bottom> <br> |
| 583 | <font color="%s" face="helvetica, arial"> <br>%s</font></td |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 584 | ><td align=right valign=bottom |
Ka-Ping Yee | 987ec90 | 2001-03-23 13:35:45 +0000 | [diff] [blame] | 585 | ><font color="%s" face="helvetica, arial">%s</font></td></tr></table> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 586 | ''' % (bgcol, fgcol, title, fgcol, extras or ' ') |
| 587 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 588 | def section(self, title, fgcol, bgcol, contents, width=6, |
| 589 | prelude='', marginalia=None, gap=' '): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 590 | """Format a section with a heading.""" |
| 591 | if marginalia is None: |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 592 | marginalia = '<tt>' + ' ' * width + '</tt>' |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 593 | result = '''<p> |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 594 | <table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 595 | <tr bgcolor="%s"> |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 596 | <td colspan=3 valign=bottom> <br> |
| 597 | <font color="%s" face="helvetica, arial">%s</font></td></tr> |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 598 | ''' % (bgcol, fgcol, title) |
| 599 | if prelude: |
| 600 | result = result + ''' |
Ka-Ping Yee | 987ec90 | 2001-03-23 13:35:45 +0000 | [diff] [blame] | 601 | <tr bgcolor="%s"><td rowspan=2>%s</td> |
| 602 | <td colspan=2>%s</td></tr> |
| 603 | <tr><td>%s</td>''' % (bgcol, marginalia, prelude, gap) |
| 604 | else: |
| 605 | result = result + ''' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 606 | <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] | 607 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 608 | return result + '\n<td width="100%%">%s</td></tr></table>' % contents |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 609 | |
| 610 | def bigsection(self, title, *args): |
| 611 | """Format a section with a big heading.""" |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 612 | title = '<big><strong>%s</strong></big>' % title |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 613 | return self.section(title, *args) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 614 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 615 | def preformat(self, text): |
| 616 | """Format literal preformatted text.""" |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 617 | text = self.escape(text.expandtabs()) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 618 | return replace(text, '\n\n', '\n \n', '\n\n', '\n \n', |
| 619 | ' ', ' ', '\n', '<br>\n') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 620 | |
| 621 | def multicolumn(self, list, format, cols=4): |
| 622 | """Format a list of items into a multi-column list.""" |
| 623 | result = '' |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 624 | rows = (len(list)+cols-1)//cols |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 625 | for col in range(cols): |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 626 | result = result + '<td width="%d%%" valign=top>' % (100//cols) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 627 | for i in range(rows*col, rows*col+rows): |
| 628 | if i < len(list): |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 629 | result = result + format(list[i]) + '<br>\n' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 630 | result = result + '</td>' |
Tim Peters | 59ed448 | 2001-10-31 04:20:26 +0000 | [diff] [blame] | 631 | return '<table width="100%%" summary="list"><tr>%s</tr></table>' % result |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 632 | |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 633 | def grey(self, text): return '<font color="#909090">%s</font>' % text |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 634 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 635 | def namelink(self, name, *dicts): |
| 636 | """Make a link for an identifier, given name-to-URL mappings.""" |
| 637 | for dict in dicts: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 638 | if name in dict: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 639 | return '<a href="%s">%s</a>' % (dict[name], name) |
| 640 | return name |
| 641 | |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 642 | def classlink(self, object, modname): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 643 | """Make a link for a class.""" |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 644 | name, module = object.__name__, sys.modules.get(object.__module__) |
| 645 | if hasattr(module, name) and getattr(module, name) is object: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 646 | return '<a href="%s.html#%s">%s</a>' % ( |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 647 | module.__name__, name, classname(object, modname)) |
| 648 | return classname(object, modname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 649 | |
| 650 | def modulelink(self, object): |
| 651 | """Make a link for a module.""" |
| 652 | return '<a href="%s.html">%s</a>' % (object.__name__, object.__name__) |
| 653 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 654 | def modpkglink(self, modpkginfo): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 655 | """Make a link for a module or package to display in an index.""" |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 656 | name, path, ispackage, shadowed = modpkginfo |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 657 | if shadowed: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 658 | return self.grey(name) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 659 | if path: |
| 660 | url = '%s.%s.html' % (path, name) |
| 661 | else: |
| 662 | url = '%s.html' % name |
| 663 | if ispackage: |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 664 | text = '<strong>%s</strong> (package)' % name |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 665 | else: |
| 666 | text = name |
| 667 | return '<a href="%s">%s</a>' % (url, text) |
| 668 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 669 | def filelink(self, url, path): |
| 670 | """Make a link to source file.""" |
| 671 | return '<a href="file:%s">%s</a>' % (url, path) |
| 672 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 673 | def markup(self, text, escape=None, funcs={}, classes={}, methods={}): |
| 674 | """Mark up some plain text, given a context of symbols to look for. |
| 675 | Each context dictionary maps object names to anchor names.""" |
| 676 | escape = escape or self.escape |
| 677 | results = [] |
| 678 | here = 0 |
Kirill | 61289d4 | 2019-11-13 19:13:53 +0300 | [diff] [blame] | 679 | pattern = re.compile(r'\b((http|https|ftp)://\S+[\w/]|' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 680 | r'RFC[- ]?(\d+)|' |
Ka-Ping Yee | f78a81b | 2001-03-27 08:13:42 +0000 | [diff] [blame] | 681 | r'PEP[- ]?(\d+)|' |
Neil Schemenauer | d69711c | 2002-03-24 23:02:07 +0000 | [diff] [blame] | 682 | r'(self\.)?(\w+))') |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 683 | while True: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 684 | match = pattern.search(text, here) |
| 685 | if not match: break |
| 686 | start, end = match.span() |
| 687 | results.append(escape(text[here:start])) |
| 688 | |
Ka-Ping Yee | f78a81b | 2001-03-27 08:13:42 +0000 | [diff] [blame] | 689 | all, scheme, rfc, pep, selfdot, name = match.groups() |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 690 | if scheme: |
Neil Schemenauer | cddc1a0 | 2002-03-24 23:11:21 +0000 | [diff] [blame] | 691 | url = escape(all).replace('"', '"') |
| 692 | results.append('<a href="%s">%s</a>' % (url, url)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 693 | elif rfc: |
Ka-Ping Yee | f78a81b | 2001-03-27 08:13:42 +0000 | [diff] [blame] | 694 | url = 'http://www.rfc-editor.org/rfc/rfc%d.txt' % int(rfc) |
| 695 | results.append('<a href="%s">%s</a>' % (url, escape(all))) |
| 696 | elif pep: |
Christian Heimes | 2202f87 | 2008-02-06 14:31:34 +0000 | [diff] [blame] | 697 | url = 'http://www.python.org/dev/peps/pep-%04d/' % int(pep) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 698 | results.append('<a href="%s">%s</a>' % (url, escape(all))) |
Benjamin Peterson | ed1160b | 2014-06-07 16:44:00 -0700 | [diff] [blame] | 699 | elif selfdot: |
| 700 | # Create a link for methods like 'self.method(...)' |
| 701 | # and use <strong> for attributes like 'self.attr' |
| 702 | if text[end:end+1] == '(': |
| 703 | results.append('self.' + self.namelink(name, methods)) |
| 704 | else: |
| 705 | results.append('self.<strong>%s</strong>' % name) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 706 | elif text[end:end+1] == '(': |
| 707 | results.append(self.namelink(name, methods, funcs, classes)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 708 | else: |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 709 | results.append(self.namelink(name, classes)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 710 | here = end |
| 711 | results.append(escape(text[here:])) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 712 | return ''.join(results) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 713 | |
| 714 | # ---------------------------------------------- type-specific routines |
| 715 | |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 716 | def formattree(self, tree, modname, parent=None): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 717 | """Produce HTML for a class tree as given by inspect.getclasstree().""" |
| 718 | result = '' |
| 719 | for entry in tree: |
| 720 | if type(entry) is type(()): |
| 721 | c, bases = entry |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 722 | result = result + '<dt><font face="helvetica, arial">' |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 723 | result = result + self.classlink(c, modname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 724 | if bases and bases != (parent,): |
| 725 | parents = [] |
| 726 | for base in bases: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 727 | parents.append(self.classlink(base, modname)) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 728 | result = result + '(' + ', '.join(parents) + ')' |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 729 | result = result + '\n</font></dt>' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 730 | elif type(entry) is type([]): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 731 | result = result + '<dd>\n%s</dd>\n' % self.formattree( |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 732 | entry, modname, c) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 733 | return '<dl>\n%s</dl>\n' % result |
| 734 | |
Tim Peters | 8dd7ade | 2001-10-18 19:56:17 +0000 | [diff] [blame] | 735 | def docmodule(self, object, name=None, mod=None, *ignored): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 736 | """Produce HTML documentation for a module object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 737 | name = object.__name__ # ignore the passed-in name |
Skip Montanaro | a5616d2 | 2004-06-11 04:46:12 +0000 | [diff] [blame] | 738 | try: |
| 739 | all = object.__all__ |
| 740 | except AttributeError: |
| 741 | all = None |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 742 | parts = name.split('.') |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 743 | links = [] |
| 744 | for i in range(len(parts)-1): |
| 745 | links.append( |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 746 | '<a href="%s.html"><font color="#ffffff">%s</font></a>' % |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 747 | ('.'.join(parts[:i+1]), parts[i])) |
| 748 | linkedname = '.'.join(links + parts[-1:]) |
Raymond Hettinger | 95f285c | 2009-02-24 23:41:47 +0000 | [diff] [blame] | 749 | head = '<big><big><strong>%s</strong></big></big>' % linkedname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 750 | try: |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 751 | path = inspect.getabsfile(object) |
Zachary Ware | eb43214 | 2014-07-10 11:18:00 -0500 | [diff] [blame] | 752 | url = urllib.parse.quote(path) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 753 | filelink = self.filelink(url, path) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 754 | except TypeError: |
| 755 | filelink = '(built-in)' |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 756 | info = [] |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 757 | if hasattr(object, '__version__'): |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 758 | version = str(object.__version__) |
Ka-Ping Yee | 40c4991 | 2001-02-27 22:46:01 +0000 | [diff] [blame] | 759 | if version[:11] == '$' + 'Revision: ' and version[-1:] == '$': |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 760 | version = version[11:-1].strip() |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 761 | info.append('version %s' % self.escape(version)) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 762 | if hasattr(object, '__date__'): |
| 763 | info.append(self.escape(str(object.__date__))) |
| 764 | if info: |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 765 | head = head + ' (%s)' % ', '.join(info) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 766 | docloc = self.getdocloc(object) |
| 767 | if docloc is not None: |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 768 | docloc = '<br><a href="%(docloc)s">Module Reference</a>' % locals() |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 769 | else: |
| 770 | docloc = '' |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 771 | result = self.heading( |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 772 | head, '#ffffff', '#7799ee', |
| 773 | '<a href=".">index</a><br>' + filelink + docloc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 774 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 775 | modules = inspect.getmembers(object, inspect.ismodule) |
| 776 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 777 | classes, cdict = [], {} |
| 778 | for key, value in inspect.getmembers(object, inspect.isclass): |
Johannes Gijsbers | 4c11f60 | 2004-08-30 14:13:04 +0000 | [diff] [blame] | 779 | # if __all__ exists, believe it. Otherwise use old heuristic. |
| 780 | if (all is not None or |
| 781 | (inspect.getmodule(value) or object) is object): |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 782 | if visiblename(key, all, object): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 783 | classes.append((key, value)) |
| 784 | cdict[key] = cdict[value] = '#' + key |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 785 | for key, value in classes: |
| 786 | for base in value.__bases__: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 787 | key, modname = base.__name__, base.__module__ |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 788 | module = sys.modules.get(modname) |
| 789 | if modname != name and module and hasattr(module, key): |
| 790 | if getattr(module, key) is base: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 791 | if not key in cdict: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 792 | cdict[key] = cdict[base] = modname + '.html#' + key |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 793 | funcs, fdict = [], {} |
| 794 | for key, value in inspect.getmembers(object, inspect.isroutine): |
Johannes Gijsbers | 4c11f60 | 2004-08-30 14:13:04 +0000 | [diff] [blame] | 795 | # if __all__ exists, believe it. Otherwise use old heuristic. |
| 796 | if (all is not None or |
| 797 | inspect.isbuiltin(value) or inspect.getmodule(value) is object): |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 798 | if visiblename(key, all, object): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 799 | funcs.append((key, value)) |
| 800 | fdict[key] = '#-' + key |
| 801 | if inspect.isfunction(value): fdict[value] = fdict[key] |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 802 | data = [] |
| 803 | for key, value in inspect.getmembers(object, isdata): |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 804 | if visiblename(key, all, object): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 805 | data.append((key, value)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 806 | |
| 807 | doc = self.markup(getdoc(object), self.preformat, fdict, cdict) |
| 808 | doc = doc and '<tt>%s</tt>' % doc |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 809 | result = result + '<p>%s</p>\n' % doc |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 810 | |
| 811 | if hasattr(object, '__path__'): |
| 812 | modpkgs = [] |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 813 | for importer, modname, ispkg in pkgutil.iter_modules(object.__path__): |
| 814 | modpkgs.append((modname, name, ispkg, 0)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 815 | modpkgs.sort() |
| 816 | contents = self.multicolumn(modpkgs, self.modpkglink) |
| 817 | result = result + self.bigsection( |
| 818 | 'Package Contents', '#ffffff', '#aa55cc', contents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 819 | elif modules: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 820 | contents = self.multicolumn( |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 821 | modules, lambda t: self.modulelink(t[1])) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 822 | result = result + self.bigsection( |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 823 | 'Modules', '#ffffff', '#aa55cc', contents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 824 | |
| 825 | if classes: |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 826 | classlist = [value for (key, value) in classes] |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 827 | contents = [ |
| 828 | self.formattree(inspect.getclasstree(classlist, 1), name)] |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 829 | for key, value in classes: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 830 | contents.append(self.document(value, key, name, fdict, cdict)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 831 | result = result + self.bigsection( |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 832 | 'Classes', '#ffffff', '#ee77aa', ' '.join(contents)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 833 | if funcs: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 834 | contents = [] |
| 835 | for key, value in funcs: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 836 | contents.append(self.document(value, key, name, fdict, cdict)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 837 | result = result + self.bigsection( |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 838 | 'Functions', '#ffffff', '#eeaa77', ' '.join(contents)) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 839 | if data: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 840 | contents = [] |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 841 | for key, value in data: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 842 | contents.append(self.document(value, key)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 843 | result = result + self.bigsection( |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 844 | 'Data', '#ffffff', '#55aa55', '<br>\n'.join(contents)) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 845 | if hasattr(object, '__author__'): |
| 846 | contents = self.markup(str(object.__author__), self.preformat) |
| 847 | result = result + self.bigsection( |
| 848 | 'Author', '#ffffff', '#7799ee', contents) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 849 | if hasattr(object, '__credits__'): |
| 850 | contents = self.markup(str(object.__credits__), self.preformat) |
| 851 | result = result + self.bigsection( |
| 852 | 'Credits', '#ffffff', '#7799ee', contents) |
| 853 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 854 | return result |
| 855 | |
Tim Peters | 8dd7ade | 2001-10-18 19:56:17 +0000 | [diff] [blame] | 856 | def docclass(self, object, name=None, mod=None, funcs={}, classes={}, |
| 857 | *ignored): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 858 | """Produce HTML documentation for a class object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 859 | realname = object.__name__ |
| 860 | name = name or realname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 861 | bases = object.__bases__ |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 862 | |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 863 | contents = [] |
| 864 | push = contents.append |
| 865 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 866 | # Cute little class to pump out a horizontal rule between sections. |
| 867 | class HorizontalRule: |
| 868 | def __init__(self): |
| 869 | self.needone = 0 |
| 870 | def maybe(self): |
| 871 | if self.needone: |
| 872 | push('<hr>\n') |
| 873 | self.needone = 1 |
| 874 | hr = HorizontalRule() |
| 875 | |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 876 | # List the mro, if non-trivial. |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 877 | mro = deque(inspect.getmro(object)) |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 878 | if len(mro) > 2: |
| 879 | hr.maybe() |
| 880 | push('<dl><dt>Method resolution order:</dt>\n') |
| 881 | for base in mro: |
| 882 | push('<dd>%s</dd>\n' % self.classlink(base, |
| 883 | object.__module__)) |
| 884 | push('</dl>\n') |
| 885 | |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 886 | def spill(msg, attrs, predicate): |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 887 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 888 | if ok: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 889 | hr.maybe() |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 890 | push(msg) |
| 891 | for name, kind, homecls, value in ok: |
Antoine Pitrou | 86a8a9a | 2011-12-21 09:57:40 +0100 | [diff] [blame] | 892 | try: |
| 893 | value = getattr(object, name) |
| 894 | except Exception: |
| 895 | # Some descriptors may meet a failure in their __get__. |
| 896 | # (bug #1785) |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 897 | push(self.docdata(value, name, mod)) |
Antoine Pitrou | 86a8a9a | 2011-12-21 09:57:40 +0100 | [diff] [blame] | 898 | else: |
| 899 | push(self.document(value, name, mod, |
| 900 | funcs, classes, mdict, object)) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 901 | push('\n') |
| 902 | return attrs |
| 903 | |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 904 | def spilldescriptors(msg, attrs, predicate): |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 905 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 906 | if ok: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 907 | hr.maybe() |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 908 | push(msg) |
| 909 | for name, kind, homecls, value in ok: |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 910 | push(self.docdata(value, name, mod)) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 911 | return attrs |
| 912 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 913 | def spilldata(msg, attrs, predicate): |
| 914 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 915 | if ok: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 916 | hr.maybe() |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 917 | push(msg) |
| 918 | for name, kind, homecls, value in ok: |
| 919 | base = self.docother(getattr(object, name), name, mod) |
Serhiy Storchaka | fbf2786 | 2020-04-15 23:00:20 +0300 | [diff] [blame] | 920 | doc = getdoc(value) |
| 921 | if not doc: |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 922 | push('<dl><dt>%s</dl>\n' % base) |
| 923 | else: |
| 924 | doc = self.markup(getdoc(value), self.preformat, |
| 925 | funcs, classes, mdict) |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 926 | doc = '<dd><tt>%s</tt>' % doc |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 927 | push('<dl><dt>%s%s</dl>\n' % (base, doc)) |
| 928 | push('\n') |
| 929 | return attrs |
| 930 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 931 | attrs = [(name, kind, cls, value) |
| 932 | for name, kind, cls, value in classify_class_attrs(object) |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 933 | if visiblename(name, obj=object)] |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 934 | |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 935 | mdict = {} |
| 936 | for key, kind, homecls, value in attrs: |
| 937 | mdict[key] = anchor = '#' + name + '-' + key |
Antoine Pitrou | 86a8a9a | 2011-12-21 09:57:40 +0100 | [diff] [blame] | 938 | try: |
| 939 | value = getattr(object, name) |
| 940 | except Exception: |
| 941 | # Some descriptors may meet a failure in their __get__. |
| 942 | # (bug #1785) |
| 943 | pass |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 944 | try: |
| 945 | # The value may not be hashable (e.g., a data attr with |
| 946 | # a dict or list value). |
| 947 | mdict[value] = anchor |
| 948 | except TypeError: |
| 949 | pass |
| 950 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 951 | while attrs: |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 952 | if mro: |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 953 | thisclass = mro.popleft() |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 954 | else: |
| 955 | thisclass = attrs[0][2] |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 956 | attrs, inherited = _split_list(attrs, lambda t: t[2] is thisclass) |
| 957 | |
Cheryl Sabella | c95c93d | 2019-05-24 06:43:29 -0400 | [diff] [blame] | 958 | if object is not builtins.object and thisclass is builtins.object: |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 959 | attrs = inherited |
| 960 | continue |
| 961 | elif thisclass is object: |
| 962 | tag = 'defined here' |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 963 | else: |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 964 | tag = 'inherited from %s' % self.classlink(thisclass, |
| 965 | object.__module__) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 966 | tag += ':<br>\n' |
| 967 | |
Raymond Hettinger | 95801bb | 2015-08-18 22:25:16 -0700 | [diff] [blame] | 968 | sort_attributes(attrs, object) |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 969 | |
| 970 | # Pump out the attrs, segregated by kind. |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 971 | attrs = spill('Methods %s' % tag, attrs, |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 972 | lambda t: t[1] == 'method') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 973 | attrs = spill('Class methods %s' % tag, attrs, |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 974 | lambda t: t[1] == 'class method') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 975 | attrs = spill('Static methods %s' % tag, attrs, |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 976 | lambda t: t[1] == 'static method') |
Raymond Hettinger | 9dcc095 | 2019-03-25 00:23:39 -0700 | [diff] [blame] | 977 | attrs = spilldescriptors("Readonly properties %s" % tag, attrs, |
Raymond Hettinger | 62be338 | 2019-03-24 17:07:47 -0700 | [diff] [blame] | 978 | lambda t: t[1] == 'readonly property') |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 979 | attrs = spilldescriptors('Data descriptors %s' % tag, attrs, |
| 980 | lambda t: t[1] == 'data descriptor') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 981 | attrs = spilldata('Data and other attributes %s' % tag, attrs, |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 982 | lambda t: t[1] == 'data') |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 983 | assert attrs == [] |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 984 | attrs = inherited |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 985 | |
| 986 | contents = ''.join(contents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 987 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 988 | if name == realname: |
| 989 | title = '<a name="%s">class <strong>%s</strong></a>' % ( |
| 990 | name, realname) |
| 991 | else: |
| 992 | title = '<strong>%s</strong> = <a name="%s">class %s</a>' % ( |
| 993 | name, name, realname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 994 | if bases: |
| 995 | parents = [] |
| 996 | for base in bases: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 997 | parents.append(self.classlink(base, object.__module__)) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 998 | title = title + '(%s)' % ', '.join(parents) |
Serhiy Storchaka | ccb5f3c | 2017-01-23 12:37:00 +0200 | [diff] [blame] | 999 | |
| 1000 | decl = '' |
| 1001 | try: |
| 1002 | signature = inspect.signature(object) |
| 1003 | except (ValueError, TypeError): |
| 1004 | signature = None |
| 1005 | if signature: |
| 1006 | argspec = str(signature) |
Serhiy Storchaka | 213f229 | 2017-01-23 14:02:35 +0200 | [diff] [blame] | 1007 | if argspec and argspec != '()': |
Serhiy Storchaka | ccb5f3c | 2017-01-23 12:37:00 +0200 | [diff] [blame] | 1008 | decl = name + self.escape(argspec) + '\n\n' |
| 1009 | |
| 1010 | doc = getdoc(object) |
| 1011 | if decl: |
| 1012 | doc = decl + (doc or '') |
| 1013 | doc = self.markup(doc, self.preformat, funcs, classes, mdict) |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1014 | doc = doc and '<tt>%s<br> </tt>' % doc |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 1015 | |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1016 | return self.section(title, '#000000', '#ffc8d8', contents, 3, doc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1017 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1018 | def formatvalue(self, object): |
| 1019 | """Format an argument default value as text.""" |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 1020 | return self.grey('=' + self.repr(object)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1021 | |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1022 | def docroutine(self, object, name=None, mod=None, |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1023 | funcs={}, classes={}, methods={}, cl=None): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1024 | """Produce HTML documentation for a function or method object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1025 | realname = object.__name__ |
| 1026 | name = name or realname |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1027 | anchor = (cl and cl.__name__ or '') + '-' + name |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1028 | note = '' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1029 | skipdocs = 0 |
Larry Hastings | 24a882b | 2014-02-20 23:34:46 -0800 | [diff] [blame] | 1030 | if _is_bound_method(object): |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 1031 | imclass = object.__self__.__class__ |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1032 | if cl: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1033 | if imclass is not cl: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 1034 | note = ' from ' + self.classlink(imclass, mod) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1035 | else: |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 1036 | if object.__self__ is not None: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 1037 | note = ' method of %s instance' % self.classlink( |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 1038 | object.__self__.__class__, mod) |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 1039 | else: |
| 1040 | note = ' unbound %s method' % self.classlink(imclass,mod) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1041 | |
Dan Rose | 2a37f8f | 2019-05-24 06:38:01 -0500 | [diff] [blame] | 1042 | if (inspect.iscoroutinefunction(object) or |
| 1043 | inspect.isasyncgenfunction(object)): |
| 1044 | asyncqualifier = 'async ' |
| 1045 | else: |
| 1046 | asyncqualifier = '' |
| 1047 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1048 | if name == realname: |
| 1049 | title = '<a name="%s"><strong>%s</strong></a>' % (anchor, realname) |
| 1050 | else: |
Serhiy Storchaka | a44d34e | 2018-11-08 08:48:11 +0200 | [diff] [blame] | 1051 | if cl and inspect.getattr_static(cl, realname, []) is object: |
Ka-Ping Yee | e280c06 | 2001-03-23 14:05:53 +0000 | [diff] [blame] | 1052 | reallink = '<a href="#%s">%s</a>' % ( |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1053 | cl.__name__ + '-' + realname, realname) |
| 1054 | skipdocs = 1 |
| 1055 | else: |
| 1056 | reallink = realname |
| 1057 | title = '<a name="%s"><strong>%s</strong></a> = %s' % ( |
| 1058 | anchor, name, reallink) |
Larry Hastings | 44e2eaa | 2013-11-23 15:37:55 -0800 | [diff] [blame] | 1059 | argspec = None |
Larry Hastings | 24a882b | 2014-02-20 23:34:46 -0800 | [diff] [blame] | 1060 | if inspect.isroutine(object): |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1061 | try: |
| 1062 | signature = inspect.signature(object) |
| 1063 | except (ValueError, TypeError): |
| 1064 | signature = None |
Larry Hastings | 44e2eaa | 2013-11-23 15:37:55 -0800 | [diff] [blame] | 1065 | if signature: |
| 1066 | argspec = str(signature) |
| 1067 | if realname == '<lambda>': |
| 1068 | title = '<strong>%s</strong> <em>lambda</em> ' % name |
| 1069 | # XXX lambda's won't usually have func_annotations['return'] |
| 1070 | # since the syntax doesn't support but it is possible. |
| 1071 | # So removing parentheses isn't truly safe. |
| 1072 | argspec = argspec[1:-1] # remove parentheses |
| 1073 | if not argspec: |
Tim Peters | 4bcfa31 | 2001-09-20 06:08:24 +0000 | [diff] [blame] | 1074 | argspec = '(...)' |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1075 | |
Dan Rose | 2a37f8f | 2019-05-24 06:38:01 -0500 | [diff] [blame] | 1076 | decl = asyncqualifier + title + self.escape(argspec) + (note and |
| 1077 | self.grey('<font face="helvetica, arial">%s</font>' % note)) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1078 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1079 | if skipdocs: |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 1080 | return '<dl><dt>%s</dt></dl>\n' % decl |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1081 | else: |
| 1082 | doc = self.markup( |
| 1083 | getdoc(object), self.preformat, funcs, classes, methods) |
Tim Peters | 2306d24 | 2001-09-25 03:18:32 +0000 | [diff] [blame] | 1084 | doc = doc and '<dd><tt>%s</tt></dd>' % doc |
| 1085 | return '<dl><dt>%s</dt>%s</dl>\n' % (decl, doc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1086 | |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 1087 | def docdata(self, object, name=None, mod=None, cl=None): |
| 1088 | """Produce html documentation for a data descriptor.""" |
Johannes Gijsbers | 8de645a | 2004-11-07 19:16:05 +0000 | [diff] [blame] | 1089 | results = [] |
| 1090 | push = results.append |
| 1091 | |
| 1092 | if name: |
| 1093 | push('<dl><dt><strong>%s</strong></dt>\n' % name) |
Raymond Hettinger | a694f23 | 2019-03-27 13:16:34 -0700 | [diff] [blame] | 1094 | doc = self.markup(getdoc(object), self.preformat) |
| 1095 | if doc: |
Johannes Gijsbers | 8de645a | 2004-11-07 19:16:05 +0000 | [diff] [blame] | 1096 | push('<dd><tt>%s</tt></dd>\n' % doc) |
Johannes Gijsbers | 8de645a | 2004-11-07 19:16:05 +0000 | [diff] [blame] | 1097 | push('</dl>\n') |
| 1098 | |
| 1099 | return ''.join(results) |
| 1100 | |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 1101 | docproperty = docdata |
Johannes Gijsbers | 8de645a | 2004-11-07 19:16:05 +0000 | [diff] [blame] | 1102 | |
Tim Peters | 8dd7ade | 2001-10-18 19:56:17 +0000 | [diff] [blame] | 1103 | def docother(self, object, name=None, mod=None, *ignored): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1104 | """Produce HTML documentation for a data object.""" |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1105 | lhs = name and '<strong>%s</strong> = ' % name or '' |
| 1106 | return lhs + self.repr(object) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1107 | |
| 1108 | def index(self, dir, shadowed=None): |
| 1109 | """Generate an HTML index for a directory of modules.""" |
| 1110 | modpkgs = [] |
| 1111 | if shadowed is None: shadowed = {} |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1112 | for importer, name, ispkg in pkgutil.iter_modules([dir]): |
Victor Stinner | 4d65224 | 2011-04-12 23:41:50 +0200 | [diff] [blame] | 1113 | if any((0xD800 <= ord(ch) <= 0xDFFF) for ch in name): |
| 1114 | # ignore a module if its name contains a surrogate character |
| 1115 | continue |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1116 | modpkgs.append((name, '', ispkg, name in shadowed)) |
| 1117 | shadowed[name] = 1 |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1118 | |
| 1119 | modpkgs.sort() |
| 1120 | contents = self.multicolumn(modpkgs, self.modpkglink) |
| 1121 | return self.bigsection(dir, '#ffffff', '#ee77aa', contents) |
| 1122 | |
| 1123 | # -------------------------------------------- text documentation generator |
| 1124 | |
| 1125 | class TextRepr(Repr): |
| 1126 | """Class for safely making a text representation of a Python object.""" |
| 1127 | def __init__(self): |
| 1128 | Repr.__init__(self) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1129 | self.maxlist = self.maxtuple = 20 |
| 1130 | self.maxdict = 10 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1131 | self.maxstring = self.maxother = 100 |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1132 | |
| 1133 | def repr1(self, x, level): |
Skip Montanaro | 0fe8fce | 2003-06-27 15:45:41 +0000 | [diff] [blame] | 1134 | if hasattr(type(x), '__name__'): |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1135 | methodname = 'repr_' + '_'.join(type(x).__name__.split()) |
Skip Montanaro | 0fe8fce | 2003-06-27 15:45:41 +0000 | [diff] [blame] | 1136 | if hasattr(self, methodname): |
| 1137 | return getattr(self, methodname)(x, level) |
| 1138 | return cram(stripid(repr(x)), self.maxother) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1139 | |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 1140 | def repr_string(self, x, level): |
| 1141 | test = cram(x, self.maxstring) |
| 1142 | testrepr = repr(test) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1143 | if '\\' in test and '\\' not in replace(testrepr, r'\\', ''): |
Ka-Ping Yee | a2fe103 | 2001-03-02 01:19:14 +0000 | [diff] [blame] | 1144 | # Backslashes are only literal in the string and are never |
| 1145 | # needed to make any special characters, so show a raw string. |
| 1146 | return 'r' + testrepr[0] + test + testrepr[0] |
| 1147 | return testrepr |
| 1148 | |
Skip Montanaro | df70878 | 2002-03-07 22:58:02 +0000 | [diff] [blame] | 1149 | repr_str = repr_string |
| 1150 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1151 | def repr_instance(self, x, level): |
| 1152 | try: |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 1153 | return cram(stripid(repr(x)), self.maxstring) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1154 | except: |
| 1155 | return '<%s instance>' % x.__class__.__name__ |
| 1156 | |
| 1157 | class TextDoc(Doc): |
| 1158 | """Formatter class for text documentation.""" |
| 1159 | |
| 1160 | # ------------------------------------------- text formatting utilities |
| 1161 | |
| 1162 | _repr_instance = TextRepr() |
| 1163 | repr = _repr_instance.repr |
| 1164 | |
| 1165 | def bold(self, text): |
| 1166 | """Format a string in bold by overstriking.""" |
Georg Brandl | cbd2ab1 | 2010-12-04 10:39:14 +0000 | [diff] [blame] | 1167 | return ''.join(ch + '\b' + ch for ch in text) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1168 | |
| 1169 | def indent(self, text, prefix=' '): |
| 1170 | """Indent text by prepending a given prefix to each line.""" |
| 1171 | if not text: return '' |
Collin Winter | 72e110c | 2007-07-17 00:27:30 +0000 | [diff] [blame] | 1172 | lines = [prefix + line for line in text.split('\n')] |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1173 | if lines: lines[-1] = lines[-1].rstrip() |
| 1174 | return '\n'.join(lines) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1175 | |
| 1176 | def section(self, title, contents): |
| 1177 | """Format a section with a given heading.""" |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1178 | clean_contents = self.indent(contents).rstrip() |
| 1179 | return self.bold(title) + '\n' + clean_contents + '\n\n' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1180 | |
| 1181 | # ---------------------------------------------- type-specific routines |
| 1182 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1183 | def formattree(self, tree, modname, parent=None, prefix=''): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1184 | """Render in text a class tree as returned by inspect.getclasstree().""" |
| 1185 | result = '' |
| 1186 | for entry in tree: |
| 1187 | if type(entry) is type(()): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1188 | c, bases = entry |
| 1189 | result = result + prefix + classname(c, modname) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1190 | if bases and bases != (parent,): |
Georg Brandl | cbd2ab1 | 2010-12-04 10:39:14 +0000 | [diff] [blame] | 1191 | parents = (classname(c, modname) for c in bases) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1192 | result = result + '(%s)' % ', '.join(parents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1193 | result = result + '\n' |
| 1194 | elif type(entry) is type([]): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1195 | result = result + self.formattree( |
| 1196 | entry, modname, c, prefix + ' ') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1197 | return result |
| 1198 | |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1199 | def docmodule(self, object, name=None, mod=None): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1200 | """Produce text documentation for a given module object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1201 | name = object.__name__ # ignore the passed-in name |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1202 | synop, desc = splitdoc(getdoc(object)) |
| 1203 | result = self.section('NAME', name + (synop and ' - ' + synop)) |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 1204 | all = getattr(object, '__all__', None) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 1205 | docloc = self.getdocloc(object) |
| 1206 | if docloc is not None: |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 1207 | result = result + self.section('MODULE REFERENCE', docloc + """ |
| 1208 | |
Éric Araujo | 647ef8c | 2011-09-11 00:43:20 +0200 | [diff] [blame] | 1209 | The following documentation is automatically generated from the Python |
| 1210 | source files. It may be incomplete, incorrect or include features that |
| 1211 | are considered implementation detail and may vary between Python |
| 1212 | implementations. When in doubt, consult the module reference at the |
| 1213 | location listed above. |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 1214 | """) |
Skip Montanaro | 4997a69 | 2003-09-10 16:47:51 +0000 | [diff] [blame] | 1215 | |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1216 | if desc: |
| 1217 | result = result + self.section('DESCRIPTION', desc) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1218 | |
| 1219 | classes = [] |
| 1220 | for key, value in inspect.getmembers(object, inspect.isclass): |
Johannes Gijsbers | 4c11f60 | 2004-08-30 14:13:04 +0000 | [diff] [blame] | 1221 | # if __all__ exists, believe it. Otherwise use old heuristic. |
| 1222 | if (all is not None |
| 1223 | or (inspect.getmodule(value) or object) is object): |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 1224 | if visiblename(key, all, object): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1225 | classes.append((key, value)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1226 | funcs = [] |
| 1227 | for key, value in inspect.getmembers(object, inspect.isroutine): |
Johannes Gijsbers | 4c11f60 | 2004-08-30 14:13:04 +0000 | [diff] [blame] | 1228 | # if __all__ exists, believe it. Otherwise use old heuristic. |
| 1229 | if (all is not None or |
| 1230 | inspect.isbuiltin(value) or inspect.getmodule(value) is object): |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 1231 | if visiblename(key, all, object): |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1232 | funcs.append((key, value)) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1233 | data = [] |
| 1234 | for key, value in inspect.getmembers(object, isdata): |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 1235 | if visiblename(key, all, object): |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1236 | data.append((key, value)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1237 | |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 1238 | modpkgs = [] |
| 1239 | modpkgs_names = set() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1240 | if hasattr(object, '__path__'): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1241 | for importer, modname, ispkg in pkgutil.iter_modules(object.__path__): |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 1242 | modpkgs_names.add(modname) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1243 | if ispkg: |
| 1244 | modpkgs.append(modname + ' (package)') |
| 1245 | else: |
| 1246 | modpkgs.append(modname) |
| 1247 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1248 | modpkgs.sort() |
| 1249 | result = result + self.section( |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1250 | 'PACKAGE CONTENTS', '\n'.join(modpkgs)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1251 | |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 1252 | # Detect submodules as sometimes created by C extensions |
| 1253 | submodules = [] |
| 1254 | for key, value in inspect.getmembers(object, inspect.ismodule): |
| 1255 | if value.__name__.startswith(name + '.') and key not in modpkgs_names: |
| 1256 | submodules.append(key) |
| 1257 | if submodules: |
| 1258 | submodules.sort() |
| 1259 | result = result + self.section( |
Amaury Forgeot d'Arc | 768db92 | 2008-04-24 21:00:04 +0000 | [diff] [blame] | 1260 | 'SUBMODULES', '\n'.join(submodules)) |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 1261 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1262 | if classes: |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 1263 | classlist = [value for key, value in classes] |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1264 | contents = [self.formattree( |
| 1265 | inspect.getclasstree(classlist, 1), name)] |
| 1266 | for key, value in classes: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1267 | contents.append(self.document(value, key, name)) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1268 | result = result + self.section('CLASSES', '\n'.join(contents)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1269 | |
| 1270 | if funcs: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1271 | contents = [] |
| 1272 | for key, value in funcs: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1273 | contents.append(self.document(value, key, name)) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1274 | result = result + self.section('FUNCTIONS', '\n'.join(contents)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1275 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1276 | if data: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1277 | contents = [] |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1278 | for key, value in data: |
Georg Brandl | 8b813db | 2005-10-01 16:32:31 +0000 | [diff] [blame] | 1279 | contents.append(self.docother(value, key, name, maxlen=70)) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1280 | result = result + self.section('DATA', '\n'.join(contents)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1281 | |
| 1282 | if hasattr(object, '__version__'): |
| 1283 | version = str(object.__version__) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 1284 | if version[:11] == '$' + 'Revision: ' and version[-1:] == '$': |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1285 | version = version[11:-1].strip() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1286 | result = result + self.section('VERSION', version) |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 1287 | if hasattr(object, '__date__'): |
| 1288 | result = result + self.section('DATE', str(object.__date__)) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1289 | if hasattr(object, '__author__'): |
Ka-Ping Yee | 6f3f9a4 | 2001-02-27 22:42:36 +0000 | [diff] [blame] | 1290 | result = result + self.section('AUTHOR', str(object.__author__)) |
| 1291 | if hasattr(object, '__credits__'): |
| 1292 | result = result + self.section('CREDITS', str(object.__credits__)) |
Alexander Belopolsky | a47bbf5 | 2010-11-18 01:52:54 +0000 | [diff] [blame] | 1293 | try: |
| 1294 | file = inspect.getabsfile(object) |
| 1295 | except TypeError: |
| 1296 | file = '(built-in)' |
| 1297 | result = result + self.section('FILE', file) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1298 | return result |
| 1299 | |
Georg Brandl | 9bd45f99 | 2010-12-03 09:58:38 +0000 | [diff] [blame] | 1300 | def docclass(self, object, name=None, mod=None, *ignored): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1301 | """Produce text documentation for a given class object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1302 | realname = object.__name__ |
| 1303 | name = name or realname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1304 | bases = object.__bases__ |
| 1305 | |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 1306 | def makename(c, m=object.__module__): |
| 1307 | return classname(c, m) |
| 1308 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1309 | if name == realname: |
| 1310 | title = 'class ' + self.bold(realname) |
| 1311 | else: |
| 1312 | title = self.bold(name) + ' = class ' + realname |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1313 | if bases: |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1314 | parents = map(makename, bases) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1315 | title = title + '(%s)' % ', '.join(parents) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1316 | |
Serhiy Storchaka | ccb5f3c | 2017-01-23 12:37:00 +0200 | [diff] [blame] | 1317 | contents = [] |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1318 | push = contents.append |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1319 | |
Serhiy Storchaka | ccb5f3c | 2017-01-23 12:37:00 +0200 | [diff] [blame] | 1320 | try: |
| 1321 | signature = inspect.signature(object) |
| 1322 | except (ValueError, TypeError): |
| 1323 | signature = None |
| 1324 | if signature: |
| 1325 | argspec = str(signature) |
Serhiy Storchaka | 213f229 | 2017-01-23 14:02:35 +0200 | [diff] [blame] | 1326 | if argspec and argspec != '()': |
Serhiy Storchaka | ccb5f3c | 2017-01-23 12:37:00 +0200 | [diff] [blame] | 1327 | push(name + argspec + '\n') |
| 1328 | |
| 1329 | doc = getdoc(object) |
| 1330 | if doc: |
| 1331 | push(doc + '\n') |
| 1332 | |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 1333 | # List the mro, if non-trivial. |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1334 | mro = deque(inspect.getmro(object)) |
Tim Peters | c86f6ca | 2001-09-26 21:31:51 +0000 | [diff] [blame] | 1335 | if len(mro) > 2: |
| 1336 | push("Method resolution order:") |
| 1337 | for base in mro: |
| 1338 | push(' ' + makename(base)) |
| 1339 | push('') |
| 1340 | |
Sanyam Khurana | a323cdc | 2018-10-21 00:22:02 -0700 | [diff] [blame] | 1341 | # List the built-in subclasses, if any: |
| 1342 | subclasses = sorted( |
Sanyam Khurana | b539cef | 2018-12-31 10:44:47 +0530 | [diff] [blame] | 1343 | (str(cls.__name__) for cls in type.__subclasses__(object) |
Sanyam Khurana | a323cdc | 2018-10-21 00:22:02 -0700 | [diff] [blame] | 1344 | if not cls.__name__.startswith("_") and cls.__module__ == "builtins"), |
| 1345 | key=str.lower |
| 1346 | ) |
| 1347 | no_of_subclasses = len(subclasses) |
| 1348 | MAX_SUBCLASSES_TO_DISPLAY = 4 |
| 1349 | if subclasses: |
| 1350 | push("Built-in subclasses:") |
| 1351 | for subclassname in subclasses[:MAX_SUBCLASSES_TO_DISPLAY]: |
| 1352 | push(' ' + subclassname) |
| 1353 | if no_of_subclasses > MAX_SUBCLASSES_TO_DISPLAY: |
| 1354 | push(' ... and ' + |
| 1355 | str(no_of_subclasses - MAX_SUBCLASSES_TO_DISPLAY) + |
| 1356 | ' other subclasses') |
| 1357 | push('') |
| 1358 | |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1359 | # Cute little class to pump out a horizontal rule between sections. |
| 1360 | class HorizontalRule: |
| 1361 | def __init__(self): |
| 1362 | self.needone = 0 |
| 1363 | def maybe(self): |
| 1364 | if self.needone: |
| 1365 | push('-' * 70) |
| 1366 | self.needone = 1 |
| 1367 | hr = HorizontalRule() |
| 1368 | |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1369 | def spill(msg, attrs, predicate): |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1370 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1371 | if ok: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1372 | hr.maybe() |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1373 | push(msg) |
| 1374 | for name, kind, homecls, value in ok: |
Antoine Pitrou | 86a8a9a | 2011-12-21 09:57:40 +0100 | [diff] [blame] | 1375 | try: |
| 1376 | value = getattr(object, name) |
| 1377 | except Exception: |
| 1378 | # Some descriptors may meet a failure in their __get__. |
| 1379 | # (bug #1785) |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 1380 | push(self.docdata(value, name, mod)) |
Antoine Pitrou | 86a8a9a | 2011-12-21 09:57:40 +0100 | [diff] [blame] | 1381 | else: |
| 1382 | push(self.document(value, |
| 1383 | name, mod, object)) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1384 | return attrs |
| 1385 | |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 1386 | def spilldescriptors(msg, attrs, predicate): |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1387 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1388 | if ok: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1389 | hr.maybe() |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1390 | push(msg) |
| 1391 | for name, kind, homecls, value in ok: |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 1392 | push(self.docdata(value, name, mod)) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1393 | return attrs |
Tim Peters | b47879b | 2001-09-24 04:47:19 +0000 | [diff] [blame] | 1394 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1395 | def spilldata(msg, attrs, predicate): |
| 1396 | ok, attrs = _split_list(attrs, predicate) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1397 | if ok: |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1398 | hr.maybe() |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1399 | push(msg) |
| 1400 | for name, kind, homecls, value in ok: |
Serhiy Storchaka | fbf2786 | 2020-04-15 23:00:20 +0300 | [diff] [blame] | 1401 | doc = getdoc(value) |
Serhiy Storchaka | 056eb02 | 2014-02-19 23:05:12 +0200 | [diff] [blame] | 1402 | try: |
| 1403 | obj = getattr(object, name) |
| 1404 | except AttributeError: |
| 1405 | obj = homecls.__dict__[name] |
| 1406 | push(self.docother(obj, name, mod, maxlen=70, doc=doc) + |
| 1407 | '\n') |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1408 | return attrs |
| 1409 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 1410 | attrs = [(name, kind, cls, value) |
| 1411 | for name, kind, cls, value in classify_class_attrs(object) |
Raymond Hettinger | 1103d05 | 2011-03-25 14:15:24 -0700 | [diff] [blame] | 1412 | if visiblename(name, obj=object)] |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 1413 | |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1414 | while attrs: |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 1415 | if mro: |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1416 | thisclass = mro.popleft() |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 1417 | else: |
| 1418 | thisclass = attrs[0][2] |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1419 | attrs, inherited = _split_list(attrs, lambda t: t[2] is thisclass) |
| 1420 | |
Cheryl Sabella | c95c93d | 2019-05-24 06:43:29 -0400 | [diff] [blame] | 1421 | if object is not builtins.object and thisclass is builtins.object: |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1422 | attrs = inherited |
| 1423 | continue |
| 1424 | elif thisclass is object: |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1425 | tag = "defined here" |
| 1426 | else: |
Tim Peters | fa26f7c | 2001-09-24 08:05:11 +0000 | [diff] [blame] | 1427 | tag = "inherited from %s" % classname(thisclass, |
| 1428 | object.__module__) |
Raymond Hettinger | 95801bb | 2015-08-18 22:25:16 -0700 | [diff] [blame] | 1429 | |
| 1430 | sort_attributes(attrs, object) |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1431 | |
| 1432 | # Pump out the attrs, segregated by kind. |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1433 | attrs = spill("Methods %s:\n" % tag, attrs, |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1434 | lambda t: t[1] == 'method') |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1435 | attrs = spill("Class methods %s:\n" % tag, attrs, |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1436 | lambda t: t[1] == 'class method') |
Tim Peters | f4aad8e | 2001-09-24 22:40:47 +0000 | [diff] [blame] | 1437 | attrs = spill("Static methods %s:\n" % tag, attrs, |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1438 | lambda t: t[1] == 'static method') |
Raymond Hettinger | 62be338 | 2019-03-24 17:07:47 -0700 | [diff] [blame] | 1439 | attrs = spilldescriptors("Readonly properties %s:\n" % tag, attrs, |
| 1440 | lambda t: t[1] == 'readonly property') |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 1441 | attrs = spilldescriptors("Data descriptors %s:\n" % tag, attrs, |
| 1442 | lambda t: t[1] == 'data descriptor') |
Ka-Ping Yee | d9e213e | 2003-03-28 16:35:51 +0000 | [diff] [blame] | 1443 | attrs = spilldata("Data and other attributes %s:\n" % tag, attrs, |
| 1444 | lambda t: t[1] == 'data') |
Ethan Furman | b0c84cd | 2013-10-20 22:37:39 -0700 | [diff] [blame] | 1445 | |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1446 | assert attrs == [] |
Tim Peters | 351e362 | 2001-09-27 03:29:51 +0000 | [diff] [blame] | 1447 | attrs = inherited |
Tim Peters | 2835549 | 2001-09-23 21:29:55 +0000 | [diff] [blame] | 1448 | |
| 1449 | contents = '\n'.join(contents) |
| 1450 | if not contents: |
| 1451 | return title + '\n' |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1452 | return title + '\n' + self.indent(contents.rstrip(), ' | ') + '\n' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1453 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1454 | def formatvalue(self, object): |
| 1455 | """Format an argument default value as text.""" |
| 1456 | return '=' + self.repr(object) |
| 1457 | |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1458 | def docroutine(self, object, name=None, mod=None, cl=None): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 1459 | """Produce text documentation for a function or method object.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1460 | realname = object.__name__ |
| 1461 | name = name or realname |
| 1462 | note = '' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1463 | skipdocs = 0 |
Larry Hastings | 24a882b | 2014-02-20 23:34:46 -0800 | [diff] [blame] | 1464 | if _is_bound_method(object): |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 1465 | imclass = object.__self__.__class__ |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1466 | if cl: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1467 | if imclass is not cl: |
| 1468 | note = ' from ' + classname(imclass, mod) |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1469 | else: |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 1470 | if object.__self__ is not None: |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 1471 | note = ' method of %s instance' % classname( |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 1472 | object.__self__.__class__, mod) |
Ka-Ping Yee | b7a4830 | 2001-04-12 20:39:14 +0000 | [diff] [blame] | 1473 | else: |
| 1474 | note = ' unbound %s method' % classname(imclass,mod) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1475 | |
Dan Rose | 2a37f8f | 2019-05-24 06:38:01 -0500 | [diff] [blame] | 1476 | if (inspect.iscoroutinefunction(object) or |
| 1477 | inspect.isasyncgenfunction(object)): |
| 1478 | asyncqualifier = 'async ' |
| 1479 | else: |
| 1480 | asyncqualifier = '' |
| 1481 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1482 | if name == realname: |
| 1483 | title = self.bold(realname) |
| 1484 | else: |
Serhiy Storchaka | a44d34e | 2018-11-08 08:48:11 +0200 | [diff] [blame] | 1485 | if cl and inspect.getattr_static(cl, realname, []) is object: |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1486 | skipdocs = 1 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1487 | title = self.bold(name) + ' = ' + realname |
Larry Hastings | 44e2eaa | 2013-11-23 15:37:55 -0800 | [diff] [blame] | 1488 | argspec = None |
Larry Hastings | 5c66189 | 2014-01-24 06:17:25 -0800 | [diff] [blame] | 1489 | |
| 1490 | if inspect.isroutine(object): |
| 1491 | try: |
| 1492 | signature = inspect.signature(object) |
| 1493 | except (ValueError, TypeError): |
| 1494 | signature = None |
Larry Hastings | 44e2eaa | 2013-11-23 15:37:55 -0800 | [diff] [blame] | 1495 | if signature: |
| 1496 | argspec = str(signature) |
| 1497 | if realname == '<lambda>': |
| 1498 | title = self.bold(name) + ' lambda ' |
| 1499 | # XXX lambda's won't usually have func_annotations['return'] |
| 1500 | # since the syntax doesn't support but it is possible. |
| 1501 | # So removing parentheses isn't truly safe. |
| 1502 | argspec = argspec[1:-1] # remove parentheses |
| 1503 | if not argspec: |
Tim Peters | 4bcfa31 | 2001-09-20 06:08:24 +0000 | [diff] [blame] | 1504 | argspec = '(...)' |
Dan Rose | 2a37f8f | 2019-05-24 06:38:01 -0500 | [diff] [blame] | 1505 | decl = asyncqualifier + title + argspec + note |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1506 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1507 | if skipdocs: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1508 | return decl + '\n' |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1509 | else: |
| 1510 | doc = getdoc(object) or '' |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1511 | return decl + '\n' + (doc and self.indent(doc).rstrip() + '\n') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1512 | |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 1513 | def docdata(self, object, name=None, mod=None, cl=None): |
| 1514 | """Produce text documentation for a data descriptor.""" |
Johannes Gijsbers | 8de645a | 2004-11-07 19:16:05 +0000 | [diff] [blame] | 1515 | results = [] |
| 1516 | push = results.append |
| 1517 | |
| 1518 | if name: |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 1519 | push(self.bold(name)) |
| 1520 | push('\n') |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 1521 | doc = getdoc(object) or '' |
Johannes Gijsbers | 8de645a | 2004-11-07 19:16:05 +0000 | [diff] [blame] | 1522 | if doc: |
| 1523 | push(self.indent(doc)) |
Johannes Gijsbers | 9ddb300 | 2005-01-08 20:16:43 +0000 | [diff] [blame] | 1524 | push('\n') |
| 1525 | return ''.join(results) |
Johannes Gijsbers | 8de645a | 2004-11-07 19:16:05 +0000 | [diff] [blame] | 1526 | |
Serhiy Storchaka | efcf82f | 2019-01-15 10:53:18 +0200 | [diff] [blame] | 1527 | docproperty = docdata |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1528 | |
Georg Brandl | 8b813db | 2005-10-01 16:32:31 +0000 | [diff] [blame] | 1529 | def docother(self, object, name=None, mod=None, parent=None, maxlen=None, doc=None): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1530 | """Produce text documentation for a data object.""" |
| 1531 | repr = self.repr(object) |
| 1532 | if maxlen: |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1533 | line = (name and name + ' = ' or '') + repr |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1534 | chop = maxlen - len(line) |
| 1535 | if chop < 0: repr = repr[:chop] + '...' |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1536 | line = (name and self.bold(name) + ' = ' or '') + repr |
Serhiy Storchaka | fbf2786 | 2020-04-15 23:00:20 +0300 | [diff] [blame] | 1537 | if not doc: |
| 1538 | doc = getdoc(object) |
| 1539 | if doc: |
Serhiy Storchaka | 7e64414 | 2020-04-18 17:13:21 +0300 | [diff] [blame] | 1540 | line += '\n' + self.indent(str(doc)) + '\n' |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1541 | return line |
| 1542 | |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 1543 | class _PlainTextDoc(TextDoc): |
| 1544 | """Subclass of TextDoc which overrides string styling""" |
| 1545 | def bold(self, text): |
| 1546 | return text |
| 1547 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1548 | # --------------------------------------------------------- user interfaces |
| 1549 | |
| 1550 | def pager(text): |
| 1551 | """The first time this is called, determine what kind of pager to use.""" |
| 1552 | global pager |
| 1553 | pager = getpager() |
| 1554 | pager(text) |
| 1555 | |
| 1556 | def getpager(): |
| 1557 | """Decide what method to use for paging through text.""" |
Benjamin Peterson | 159824e | 2014-06-07 20:14:26 -0700 | [diff] [blame] | 1558 | if not hasattr(sys.stdin, "isatty"): |
| 1559 | return plainpager |
Guido van Rossum | a01a8b6 | 2007-05-27 09:20:14 +0000 | [diff] [blame] | 1560 | if not hasattr(sys.stdout, "isatty"): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1561 | return plainpager |
| 1562 | if not sys.stdin.isatty() or not sys.stdout.isatty(): |
| 1563 | return plainpager |
doko@ubuntu.com | 9657545 | 2016-06-14 08:39:31 +0200 | [diff] [blame] | 1564 | use_pager = os.environ.get('MANPAGER') or os.environ.get('PAGER') |
| 1565 | if use_pager: |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1566 | if sys.platform == 'win32': # pipes completely broken in Windows |
doko@ubuntu.com | c8fd192 | 2016-06-14 09:03:52 +0200 | [diff] [blame] | 1567 | return lambda text: tempfilepager(plain(text), use_pager) |
Raymond Hettinger | dbecd93 | 2005-02-06 06:57:08 +0000 | [diff] [blame] | 1568 | elif os.environ.get('TERM') in ('dumb', 'emacs'): |
doko@ubuntu.com | c8fd192 | 2016-06-14 09:03:52 +0200 | [diff] [blame] | 1569 | return lambda text: pipepager(plain(text), use_pager) |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 1570 | else: |
doko@ubuntu.com | c8fd192 | 2016-06-14 09:03:52 +0200 | [diff] [blame] | 1571 | return lambda text: pipepager(text, use_pager) |
Ka-Ping Yee | a487e4e | 2005-11-05 04:49:18 +0000 | [diff] [blame] | 1572 | if os.environ.get('TERM') in ('dumb', 'emacs'): |
| 1573 | return plainpager |
Jesus Cea | 4791a24 | 2012-10-05 03:15:39 +0200 | [diff] [blame] | 1574 | if sys.platform == 'win32': |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1575 | return lambda text: tempfilepager(plain(text), 'more <') |
Skip Montanaro | d404bee | 2002-09-26 21:44:57 +0000 | [diff] [blame] | 1576 | 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] | 1577 | return lambda text: pipepager(text, 'less') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1578 | |
| 1579 | import tempfile |
Guido van Rossum | 3b0a329 | 2002-08-09 16:38:32 +0000 | [diff] [blame] | 1580 | (fd, filename) = tempfile.mkstemp() |
| 1581 | os.close(fd) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1582 | try: |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 1583 | if hasattr(os, 'system') and os.system('more "%s"' % filename) == 0: |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1584 | return lambda text: pipepager(text, 'more') |
| 1585 | else: |
| 1586 | return ttypager |
| 1587 | finally: |
| 1588 | os.unlink(filename) |
| 1589 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1590 | def plain(text): |
| 1591 | """Remove boldface formatting from text.""" |
| 1592 | return re.sub('.\b', '', text) |
| 1593 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1594 | def pipepager(text, cmd): |
| 1595 | """Page through text by feeding it to another program.""" |
Serhiy Storchaka | 5e3d7a4 | 2015-02-20 23:46:06 +0200 | [diff] [blame] | 1596 | import subprocess |
| 1597 | proc = subprocess.Popen(cmd, shell=True, stdin=subprocess.PIPE) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1598 | try: |
R David Murray | 1058cda | 2015-03-29 15:15:40 -0400 | [diff] [blame] | 1599 | with io.TextIOWrapper(proc.stdin, errors='backslashreplace') as pipe: |
R David Murray | e7f5e14 | 2015-03-30 10:14:47 -0400 | [diff] [blame] | 1600 | try: |
| 1601 | pipe.write(text) |
| 1602 | except KeyboardInterrupt: |
| 1603 | # We've hereby abandoned whatever text hasn't been written, |
| 1604 | # but the pager is still in control of the terminal. |
| 1605 | pass |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 1606 | except OSError: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1607 | pass # Ignore broken pipes caused by quitting the pager program. |
R David Murray | 1058cda | 2015-03-29 15:15:40 -0400 | [diff] [blame] | 1608 | while True: |
| 1609 | try: |
| 1610 | proc.wait() |
| 1611 | break |
| 1612 | except KeyboardInterrupt: |
| 1613 | # Ignore ctl-c like the pager itself does. Otherwise the pager is |
| 1614 | # left running and the terminal is in raw mode and unusable. |
| 1615 | pass |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1616 | |
| 1617 | def tempfilepager(text, cmd): |
| 1618 | """Page through text by invoking a program on a temporary file.""" |
| 1619 | import tempfile |
Tim Peters | 550e4e5 | 2003-02-07 01:53:46 +0000 | [diff] [blame] | 1620 | filename = tempfile.mktemp() |
Serhiy Storchaka | 5e3d7a4 | 2015-02-20 23:46:06 +0200 | [diff] [blame] | 1621 | with open(filename, 'w', errors='backslashreplace') as file: |
Giampaolo Rodola' | 2f50aaf | 2013-02-12 02:04:27 +0100 | [diff] [blame] | 1622 | file.write(text) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1623 | try: |
Georg Brandl | 3dbca81 | 2008-07-23 16:10:53 +0000 | [diff] [blame] | 1624 | os.system(cmd + ' "' + filename + '"') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1625 | finally: |
| 1626 | os.unlink(filename) |
| 1627 | |
Serhiy Storchaka | 5e3d7a4 | 2015-02-20 23:46:06 +0200 | [diff] [blame] | 1628 | def _escape_stdout(text): |
| 1629 | # Escape non-encodable characters to avoid encoding errors later |
| 1630 | encoding = getattr(sys.stdout, 'encoding', None) or 'utf-8' |
| 1631 | return text.encode(encoding, 'backslashreplace').decode(encoding) |
| 1632 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1633 | def ttypager(text): |
| 1634 | """Page through text on a text terminal.""" |
Serhiy Storchaka | 5e3d7a4 | 2015-02-20 23:46:06 +0200 | [diff] [blame] | 1635 | lines = plain(_escape_stdout(text)).split('\n') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1636 | try: |
| 1637 | import tty |
| 1638 | fd = sys.stdin.fileno() |
| 1639 | old = tty.tcgetattr(fd) |
| 1640 | tty.setcbreak(fd) |
| 1641 | getchar = lambda: sys.stdin.read(1) |
Serhiy Storchaka | ab5e9b9 | 2014-11-28 00:09:29 +0200 | [diff] [blame] | 1642 | except (ImportError, AttributeError, io.UnsupportedOperation): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1643 | tty = None |
| 1644 | getchar = lambda: sys.stdin.readline()[:-1][:1] |
| 1645 | |
| 1646 | try: |
Serhiy Storchaka | ab5e9b9 | 2014-11-28 00:09:29 +0200 | [diff] [blame] | 1647 | try: |
| 1648 | h = int(os.environ.get('LINES', 0)) |
| 1649 | except ValueError: |
| 1650 | h = 0 |
| 1651 | if h <= 1: |
| 1652 | h = 25 |
| 1653 | r = inc = h - 1 |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1654 | sys.stdout.write('\n'.join(lines[:inc]) + '\n') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1655 | while lines[r:]: |
| 1656 | sys.stdout.write('-- more --') |
| 1657 | sys.stdout.flush() |
| 1658 | c = getchar() |
| 1659 | |
Raymond Hettinger | dbecd93 | 2005-02-06 06:57:08 +0000 | [diff] [blame] | 1660 | if c in ('q', 'Q'): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1661 | sys.stdout.write('\r \r') |
| 1662 | break |
Raymond Hettinger | dbecd93 | 2005-02-06 06:57:08 +0000 | [diff] [blame] | 1663 | elif c in ('\r', '\n'): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1664 | sys.stdout.write('\r \r' + lines[r] + '\n') |
| 1665 | r = r + 1 |
| 1666 | continue |
Raymond Hettinger | dbecd93 | 2005-02-06 06:57:08 +0000 | [diff] [blame] | 1667 | if c in ('b', 'B', '\x1b'): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1668 | r = r - inc - inc |
| 1669 | if r < 0: r = 0 |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1670 | sys.stdout.write('\n' + '\n'.join(lines[r:r+inc]) + '\n') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1671 | r = r + inc |
| 1672 | |
| 1673 | finally: |
| 1674 | if tty: |
| 1675 | tty.tcsetattr(fd, tty.TCSAFLUSH, old) |
| 1676 | |
| 1677 | def plainpager(text): |
| 1678 | """Simply print unformatted text. This is the ultimate fallback.""" |
Serhiy Storchaka | 5e3d7a4 | 2015-02-20 23:46:06 +0200 | [diff] [blame] | 1679 | sys.stdout.write(plain(_escape_stdout(text))) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1680 | |
| 1681 | def describe(thing): |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 1682 | """Produce a short description of the given thing.""" |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1683 | if inspect.ismodule(thing): |
| 1684 | if thing.__name__ in sys.builtin_module_names: |
| 1685 | return 'built-in module ' + thing.__name__ |
| 1686 | if hasattr(thing, '__path__'): |
| 1687 | return 'package ' + thing.__name__ |
| 1688 | else: |
| 1689 | return 'module ' + thing.__name__ |
| 1690 | if inspect.isbuiltin(thing): |
| 1691 | return 'built-in function ' + thing.__name__ |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1692 | if inspect.isgetsetdescriptor(thing): |
| 1693 | return 'getset descriptor %s.%s.%s' % ( |
| 1694 | thing.__objclass__.__module__, thing.__objclass__.__name__, |
| 1695 | thing.__name__) |
| 1696 | if inspect.ismemberdescriptor(thing): |
| 1697 | return 'member descriptor %s.%s.%s' % ( |
| 1698 | thing.__objclass__.__module__, thing.__objclass__.__name__, |
| 1699 | thing.__name__) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1700 | if inspect.isclass(thing): |
| 1701 | return 'class ' + thing.__name__ |
| 1702 | if inspect.isfunction(thing): |
| 1703 | return 'function ' + thing.__name__ |
| 1704 | if inspect.ismethod(thing): |
| 1705 | return 'method ' + thing.__name__ |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1706 | return type(thing).__name__ |
| 1707 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1708 | def locate(path, forceload=0): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1709 | """Locate an object by name or dotted path, importing as necessary.""" |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1710 | parts = [part for part in path.split('.') if part] |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1711 | module, n = None, 0 |
| 1712 | while n < len(parts): |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 1713 | nextmodule = safeimport('.'.join(parts[:n+1]), forceload) |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1714 | if nextmodule: module, n = nextmodule, n + 1 |
| 1715 | else: break |
| 1716 | if module: |
| 1717 | object = module |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1718 | else: |
Éric Araujo | e64e51b | 2011-07-29 17:03:55 +0200 | [diff] [blame] | 1719 | object = builtins |
| 1720 | for part in parts[n:]: |
| 1721 | try: |
| 1722 | object = getattr(object, part) |
| 1723 | except AttributeError: |
| 1724 | return None |
| 1725 | return object |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1726 | |
| 1727 | # --------------------------------------- interactive interpreter interface |
| 1728 | |
| 1729 | text = TextDoc() |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 1730 | plaintext = _PlainTextDoc() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1731 | html = HTMLDoc() |
| 1732 | |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1733 | def resolve(thing, forceload=0): |
| 1734 | """Given an object or a path to an object, get the object and its name.""" |
| 1735 | if isinstance(thing, str): |
| 1736 | object = locate(thing, forceload) |
Serhiy Storchaka | b6076fb | 2015-04-21 21:09:48 +0300 | [diff] [blame] | 1737 | if object is None: |
Serhiy Storchaka | 1c20551 | 2015-03-01 00:42:54 +0200 | [diff] [blame] | 1738 | raise ImportError('''\ |
| 1739 | No Python documentation found for %r. |
| 1740 | Use help() to get the interactive help utility. |
| 1741 | Use help(str) for help on the str class.''' % thing) |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1742 | return object, thing |
| 1743 | else: |
R David Murray | c43125a | 2012-04-23 13:23:57 -0400 | [diff] [blame] | 1744 | name = getattr(thing, '__name__', None) |
| 1745 | return thing, name if isinstance(name, str) else None |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1746 | |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 1747 | def render_doc(thing, title='Python Library Documentation: %s', forceload=0, |
| 1748 | renderer=None): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1749 | """Render text documentation, given an object or a path to an object.""" |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 1750 | if renderer is None: |
| 1751 | renderer = text |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1752 | object, name = resolve(thing, forceload) |
| 1753 | desc = describe(object) |
| 1754 | module = inspect.getmodule(object) |
| 1755 | if name and '.' in name: |
| 1756 | desc += ' in ' + name[:name.rfind('.')] |
| 1757 | elif module and module is not object: |
| 1758 | desc += ' in module ' + module.__name__ |
Amaury Forgeot d'Arc | 768db92 | 2008-04-24 21:00:04 +0000 | [diff] [blame] | 1759 | |
| 1760 | if not (inspect.ismodule(object) or |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1761 | inspect.isclass(object) or |
| 1762 | inspect.isroutine(object) or |
Serhiy Storchaka | fbf2786 | 2020-04-15 23:00:20 +0300 | [diff] [blame] | 1763 | inspect.isdatadescriptor(object) or |
Serhiy Storchaka | 08b47c3 | 2020-05-18 20:25:07 +0300 | [diff] [blame] | 1764 | _getdoc(object)): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1765 | # If the passed object is a piece of data or an instance, |
| 1766 | # document its available methods instead of its value. |
Serhiy Storchaka | 7e64414 | 2020-04-18 17:13:21 +0300 | [diff] [blame] | 1767 | if hasattr(object, '__origin__'): |
| 1768 | object = object.__origin__ |
| 1769 | else: |
| 1770 | object = type(object) |
| 1771 | desc += ' object' |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 1772 | return title % desc + '\n\n' + renderer.document(object, name) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1773 | |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 1774 | def doc(thing, title='Python Library Documentation: %s', forceload=0, |
| 1775 | output=None): |
Ka-Ping Yee | 9aa0d90 | 2001-04-12 10:50:23 +0000 | [diff] [blame] | 1776 | """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] | 1777 | try: |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 1778 | if output is None: |
| 1779 | pager(render_doc(thing, title, forceload)) |
| 1780 | else: |
| 1781 | output.write(render_doc(thing, title, forceload, plaintext)) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 1782 | except (ImportError, ErrorDuringImport) as value: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1783 | print(value) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1784 | |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1785 | def writedoc(thing, forceload=0): |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1786 | """Write HTML documentation to a file in the current directory.""" |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1787 | try: |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 1788 | object, name = resolve(thing, forceload) |
| 1789 | page = html.page(describe(object), html.document(object, name)) |
Serhiy Storchaka | 46ba6c8 | 2015-04-04 11:01:02 +0300 | [diff] [blame] | 1790 | with open(name + '.html', 'w', encoding='utf-8') as file: |
| 1791 | file.write(page) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1792 | print('wrote', name + '.html') |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 1793 | except (ImportError, ErrorDuringImport) as value: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1794 | print(value) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1795 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1796 | def writedocs(dir, pkgpath='', done=None): |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 1797 | """Write out HTML documentation for all modules in a directory tree.""" |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 1798 | if done is None: done = {} |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1799 | for importer, modname, ispkg in pkgutil.walk_packages([dir], pkgpath): |
| 1800 | writedoc(modname) |
| 1801 | return |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 1802 | |
| 1803 | class Helper: |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1804 | |
| 1805 | # These dictionaries map a topic name to either an alias, or a tuple |
| 1806 | # (label, seealso-items). The "label" is the label of the corresponding |
| 1807 | # section in the .rst file under Doc/ and an index into the dictionary |
Georg Brandl | 5617db8 | 2009-04-27 16:28:57 +0000 | [diff] [blame] | 1808 | # in pydoc_data/topics.py. |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1809 | # |
| 1810 | # CAUTION: if you change one of these dictionaries, be sure to adapt the |
Jelle Zijlstra | ac31770 | 2017-10-05 20:24:46 -0700 | [diff] [blame] | 1811 | # list of needed labels in Doc/tools/extensions/pyspecific.py and |
Georg Brandl | 5617db8 | 2009-04-27 16:28:57 +0000 | [diff] [blame] | 1812 | # regenerate the pydoc_data/topics.py file by running |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1813 | # make pydoc-topics |
| 1814 | # in Doc/ and copying the output file into the Lib/ directory. |
| 1815 | |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1816 | keywords = { |
Ezio Melotti | b185a04 | 2011-04-28 07:42:55 +0300 | [diff] [blame] | 1817 | 'False': '', |
| 1818 | 'None': '', |
| 1819 | 'True': '', |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1820 | 'and': 'BOOLEAN', |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1821 | 'as': 'with', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1822 | 'assert': ('assert', ''), |
Jelle Zijlstra | ac31770 | 2017-10-05 20:24:46 -0700 | [diff] [blame] | 1823 | 'async': ('async', ''), |
| 1824 | 'await': ('await', ''), |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1825 | 'break': ('break', 'while for'), |
| 1826 | 'class': ('class', 'CLASSES SPECIALMETHODS'), |
| 1827 | 'continue': ('continue', 'while for'), |
| 1828 | 'def': ('function', ''), |
| 1829 | 'del': ('del', 'BASICMETHODS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1830 | 'elif': 'if', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1831 | 'else': ('else', 'while for'), |
Georg Brandl | 0d85539 | 2008-08-30 19:53:05 +0000 | [diff] [blame] | 1832 | 'except': 'try', |
| 1833 | 'finally': 'try', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1834 | 'for': ('for', 'break continue while'), |
Georg Brandl | 0d85539 | 2008-08-30 19:53:05 +0000 | [diff] [blame] | 1835 | 'from': 'import', |
Georg Brandl | 74abf6f | 2010-11-20 19:54:36 +0000 | [diff] [blame] | 1836 | 'global': ('global', 'nonlocal NAMESPACES'), |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1837 | 'if': ('if', 'TRUTHVALUE'), |
| 1838 | 'import': ('import', 'MODULES'), |
Georg Brandl | 395ed24 | 2009-09-04 08:07:32 +0000 | [diff] [blame] | 1839 | 'in': ('in', 'SEQUENCEMETHODS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1840 | 'is': 'COMPARISON', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1841 | 'lambda': ('lambda', 'FUNCTIONS'), |
Georg Brandl | 74abf6f | 2010-11-20 19:54:36 +0000 | [diff] [blame] | 1842 | 'nonlocal': ('nonlocal', 'global NAMESPACES'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1843 | 'not': 'BOOLEAN', |
| 1844 | 'or': 'BOOLEAN', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1845 | 'pass': ('pass', ''), |
| 1846 | 'raise': ('raise', 'EXCEPTIONS'), |
| 1847 | 'return': ('return', 'FUNCTIONS'), |
| 1848 | 'try': ('try', 'EXCEPTIONS'), |
| 1849 | 'while': ('while', 'break continue if TRUTHVALUE'), |
| 1850 | 'with': ('with', 'CONTEXTMANAGERS EXCEPTIONS yield'), |
| 1851 | 'yield': ('yield', ''), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1852 | } |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 1853 | # Either add symbols to this dictionary or to the symbols dictionary |
| 1854 | # directly: Whichever is easier. They are merged later. |
Andrés Delfino | b2043bb | 2018-05-05 13:07:32 -0300 | [diff] [blame] | 1855 | _strprefixes = [p + q for p in ('b', 'f', 'r', 'u') for q in ("'", '"')] |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 1856 | _symbols_inverse = { |
Andrés Delfino | b2043bb | 2018-05-05 13:07:32 -0300 | [diff] [blame] | 1857 | 'STRINGS' : ("'", "'''", '"', '"""', *_strprefixes), |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 1858 | 'OPERATORS' : ('+', '-', '*', '**', '/', '//', '%', '<<', '>>', '&', |
| 1859 | '|', '^', '~', '<', '>', '<=', '>=', '==', '!=', '<>'), |
| 1860 | 'COMPARISON' : ('<', '>', '<=', '>=', '==', '!=', '<>'), |
| 1861 | 'UNARY' : ('-', '~'), |
| 1862 | 'AUGMENTEDASSIGNMENT' : ('+=', '-=', '*=', '/=', '%=', '&=', '|=', |
| 1863 | '^=', '<<=', '>>=', '**=', '//='), |
| 1864 | 'BITWISE' : ('<<', '>>', '&', '|', '^', '~'), |
| 1865 | 'COMPLEX' : ('j', 'J') |
| 1866 | } |
| 1867 | symbols = { |
| 1868 | '%': 'OPERATORS FORMATTING', |
| 1869 | '**': 'POWER', |
| 1870 | ',': 'TUPLES LISTS FUNCTIONS', |
| 1871 | '.': 'ATTRIBUTES FLOAT MODULES OBJECTS', |
| 1872 | '...': 'ELLIPSIS', |
| 1873 | ':': 'SLICINGS DICTIONARYLITERALS', |
| 1874 | '@': 'def class', |
| 1875 | '\\': 'STRINGS', |
| 1876 | '_': 'PRIVATENAMES', |
| 1877 | '__': 'PRIVATENAMES SPECIALMETHODS', |
| 1878 | '`': 'BACKQUOTES', |
| 1879 | '(': 'TUPLES FUNCTIONS CALLS', |
| 1880 | ')': 'TUPLES FUNCTIONS CALLS', |
| 1881 | '[': 'LISTS SUBSCRIPTS SLICINGS', |
| 1882 | ']': 'LISTS SUBSCRIPTS SLICINGS' |
| 1883 | } |
| 1884 | for topic, symbols_ in _symbols_inverse.items(): |
| 1885 | for symbol in symbols_: |
| 1886 | topics = symbols.get(symbol, topic) |
| 1887 | if topic not in topics: |
| 1888 | topics = topics + ' ' + topic |
| 1889 | symbols[symbol] = topics |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1890 | |
| 1891 | topics = { |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1892 | 'TYPES': ('types', 'STRINGS UNICODE NUMBERS SEQUENCES MAPPINGS ' |
| 1893 | 'FUNCTIONS CLASSES MODULES FILES inspect'), |
| 1894 | 'STRINGS': ('strings', 'str UNICODE SEQUENCES STRINGMETHODS ' |
| 1895 | 'FORMATTING TYPES'), |
| 1896 | 'STRINGMETHODS': ('string-methods', 'STRINGS FORMATTING'), |
| 1897 | 'FORMATTING': ('formatstrings', 'OPERATORS'), |
| 1898 | 'UNICODE': ('strings', 'encodings unicode SEQUENCES STRINGMETHODS ' |
| 1899 | 'FORMATTING TYPES'), |
| 1900 | 'NUMBERS': ('numbers', 'INTEGER FLOAT COMPLEX TYPES'), |
| 1901 | 'INTEGER': ('integers', 'int range'), |
| 1902 | 'FLOAT': ('floating', 'float math'), |
| 1903 | 'COMPLEX': ('imaginary', 'complex cmath'), |
| 1904 | 'SEQUENCES': ('typesseq', 'STRINGMETHODS FORMATTING range LISTS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1905 | 'MAPPINGS': 'DICTIONARIES', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1906 | 'FUNCTIONS': ('typesfunctions', 'def TYPES'), |
| 1907 | 'METHODS': ('typesmethods', 'class def CLASSES TYPES'), |
| 1908 | 'CODEOBJECTS': ('bltin-code-objects', 'compile FUNCTIONS TYPES'), |
| 1909 | 'TYPEOBJECTS': ('bltin-type-objects', 'types TYPES'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1910 | 'FRAMEOBJECTS': 'TYPES', |
| 1911 | 'TRACEBACKS': 'TYPES', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1912 | 'NONE': ('bltin-null-object', ''), |
| 1913 | 'ELLIPSIS': ('bltin-ellipsis-object', 'SLICINGS'), |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1914 | 'SPECIALATTRIBUTES': ('specialattrs', ''), |
| 1915 | 'CLASSES': ('types', 'class SPECIALMETHODS PRIVATENAMES'), |
| 1916 | 'MODULES': ('typesmodules', 'import'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1917 | 'PACKAGES': 'import', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1918 | 'EXPRESSIONS': ('operator-summary', 'lambda or and not in is BOOLEAN ' |
| 1919 | 'COMPARISON BITWISE SHIFTING BINARY FORMATTING POWER ' |
| 1920 | 'UNARY ATTRIBUTES SUBSCRIPTS SLICINGS CALLS TUPLES ' |
| 1921 | 'LISTS DICTIONARIES'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1922 | 'OPERATORS': 'EXPRESSIONS', |
| 1923 | 'PRECEDENCE': 'EXPRESSIONS', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1924 | 'OBJECTS': ('objects', 'TYPES'), |
| 1925 | 'SPECIALMETHODS': ('specialnames', 'BASICMETHODS ATTRIBUTEMETHODS ' |
Georg Brandl | 395ed24 | 2009-09-04 08:07:32 +0000 | [diff] [blame] | 1926 | 'CALLABLEMETHODS SEQUENCEMETHODS MAPPINGMETHODS ' |
| 1927 | 'NUMBERMETHODS CLASSES'), |
Mark Dickinson | a56c467 | 2009-01-27 18:17:45 +0000 | [diff] [blame] | 1928 | 'BASICMETHODS': ('customization', 'hash repr str SPECIALMETHODS'), |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1929 | 'ATTRIBUTEMETHODS': ('attribute-access', 'ATTRIBUTES SPECIALMETHODS'), |
| 1930 | 'CALLABLEMETHODS': ('callable-types', 'CALLS SPECIALMETHODS'), |
Georg Brandl | 395ed24 | 2009-09-04 08:07:32 +0000 | [diff] [blame] | 1931 | 'SEQUENCEMETHODS': ('sequence-types', 'SEQUENCES SEQUENCEMETHODS ' |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1932 | 'SPECIALMETHODS'), |
| 1933 | 'MAPPINGMETHODS': ('sequence-types', 'MAPPINGS SPECIALMETHODS'), |
| 1934 | 'NUMBERMETHODS': ('numeric-types', 'NUMBERS AUGMENTEDASSIGNMENT ' |
| 1935 | 'SPECIALMETHODS'), |
| 1936 | 'EXECUTION': ('execmodel', 'NAMESPACES DYNAMICFEATURES EXCEPTIONS'), |
Georg Brandl | 74abf6f | 2010-11-20 19:54:36 +0000 | [diff] [blame] | 1937 | 'NAMESPACES': ('naming', 'global nonlocal ASSIGNMENT DELETION DYNAMICFEATURES'), |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1938 | 'DYNAMICFEATURES': ('dynamic-features', ''), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1939 | 'SCOPING': 'NAMESPACES', |
| 1940 | 'FRAMES': 'NAMESPACES', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1941 | 'EXCEPTIONS': ('exceptions', 'try except finally raise'), |
| 1942 | 'CONVERSIONS': ('conversions', ''), |
| 1943 | 'IDENTIFIERS': ('identifiers', 'keywords SPECIALIDENTIFIERS'), |
| 1944 | 'SPECIALIDENTIFIERS': ('id-classes', ''), |
| 1945 | 'PRIVATENAMES': ('atom-identifiers', ''), |
| 1946 | 'LITERALS': ('atom-literals', 'STRINGS NUMBERS TUPLELITERALS ' |
| 1947 | 'LISTLITERALS DICTIONARYLITERALS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1948 | 'TUPLES': 'SEQUENCES', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1949 | 'TUPLELITERALS': ('exprlists', 'TUPLES LITERALS'), |
| 1950 | 'LISTS': ('typesseq-mutable', 'LISTLITERALS'), |
| 1951 | 'LISTLITERALS': ('lists', 'LISTS LITERALS'), |
| 1952 | 'DICTIONARIES': ('typesmapping', 'DICTIONARYLITERALS'), |
| 1953 | 'DICTIONARYLITERALS': ('dict', 'DICTIONARIES LITERALS'), |
| 1954 | 'ATTRIBUTES': ('attribute-references', 'getattr hasattr setattr ATTRIBUTEMETHODS'), |
Georg Brandl | 395ed24 | 2009-09-04 08:07:32 +0000 | [diff] [blame] | 1955 | 'SUBSCRIPTS': ('subscriptions', 'SEQUENCEMETHODS'), |
| 1956 | 'SLICINGS': ('slicings', 'SEQUENCEMETHODS'), |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1957 | 'CALLS': ('calls', 'EXPRESSIONS'), |
| 1958 | 'POWER': ('power', 'EXPRESSIONS'), |
| 1959 | 'UNARY': ('unary', 'EXPRESSIONS'), |
| 1960 | 'BINARY': ('binary', 'EXPRESSIONS'), |
| 1961 | 'SHIFTING': ('shifting', 'EXPRESSIONS'), |
| 1962 | 'BITWISE': ('bitwise', 'EXPRESSIONS'), |
| 1963 | 'COMPARISON': ('comparisons', 'EXPRESSIONS BASICMETHODS'), |
| 1964 | 'BOOLEAN': ('booleans', 'EXPRESSIONS TRUTHVALUE'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1965 | 'ASSERTION': 'assert', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1966 | 'ASSIGNMENT': ('assignment', 'AUGMENTEDASSIGNMENT'), |
| 1967 | 'AUGMENTEDASSIGNMENT': ('augassign', 'NUMBERMETHODS'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1968 | 'DELETION': 'del', |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1969 | 'RETURNING': 'return', |
| 1970 | 'IMPORTING': 'import', |
| 1971 | 'CONDITIONAL': 'if', |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 1972 | 'LOOPING': ('compound', 'for while break continue'), |
| 1973 | 'TRUTHVALUE': ('truth', 'if while and or not BASICMETHODS'), |
| 1974 | 'DEBUGGING': ('debugger', 'pdb'), |
| 1975 | 'CONTEXTMANAGERS': ('context-managers', 'with'), |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1976 | } |
| 1977 | |
Georg Brandl | 78aa396 | 2010-07-31 21:51:48 +0000 | [diff] [blame] | 1978 | def __init__(self, input=None, output=None): |
| 1979 | self._input = input |
| 1980 | self._output = output |
| 1981 | |
Serhiy Storchaka | bdf6b91 | 2017-03-19 08:40:32 +0200 | [diff] [blame] | 1982 | @property |
| 1983 | def input(self): |
| 1984 | return self._input or sys.stdin |
| 1985 | |
| 1986 | @property |
| 1987 | def output(self): |
| 1988 | return self._output or sys.stdout |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 1989 | |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1990 | def __repr__(self): |
Ka-Ping Yee | 9bc576b | 2001-04-13 13:57:31 +0000 | [diff] [blame] | 1991 | if inspect.stack()[1][3] == '?': |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1992 | self() |
| 1993 | return '' |
Serhiy Storchaka | 465e60e | 2014-07-25 23:36:00 +0300 | [diff] [blame] | 1994 | return '<%s.%s instance>' % (self.__class__.__module__, |
| 1995 | self.__class__.__qualname__) |
Ka-Ping Yee | 79c009d | 2001-04-13 10:53:25 +0000 | [diff] [blame] | 1996 | |
Alexander Belopolsky | 2e733c9 | 2010-07-04 17:00:20 +0000 | [diff] [blame] | 1997 | _GoInteractive = object() |
| 1998 | def __call__(self, request=_GoInteractive): |
| 1999 | if request is not self._GoInteractive: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2000 | self.help(request) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2001 | else: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2002 | self.intro() |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 2003 | self.interact() |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2004 | self.output.write(''' |
Fred Drake | e61967f | 2001-05-10 18:41:02 +0000 | [diff] [blame] | 2005 | You are now leaving help and returning to the Python interpreter. |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2006 | If you want to ask for help on a particular object directly from the |
| 2007 | interpreter, you can type "help(object)". Executing "help('string')" |
| 2008 | has the same effect as typing a particular string at the help> prompt. |
| 2009 | ''') |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2010 | |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 2011 | def interact(self): |
| 2012 | self.output.write('\n') |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 2013 | while True: |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 2014 | try: |
Johannes Gijsbers | e7691d3 | 2004-08-17 13:21:53 +0000 | [diff] [blame] | 2015 | request = self.getline('help> ') |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 2016 | if not request: break |
Johannes Gijsbers | e7691d3 | 2004-08-17 13:21:53 +0000 | [diff] [blame] | 2017 | except (KeyboardInterrupt, EOFError): |
| 2018 | break |
Andrés Delfino | b2043bb | 2018-05-05 13:07:32 -0300 | [diff] [blame] | 2019 | request = request.strip() |
| 2020 | |
| 2021 | # Make sure significant trailing quoting marks of literals don't |
| 2022 | # get deleted while cleaning input |
| 2023 | if (len(request) > 2 and request[0] == request[-1] in ("'", '"') |
| 2024 | and request[0] not in request[1:-1]): |
| 2025 | request = request[1:-1] |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 2026 | if request.lower() in ('q', 'quit'): break |
Serhiy Storchaka | 1c20551 | 2015-03-01 00:42:54 +0200 | [diff] [blame] | 2027 | if request == 'help': |
| 2028 | self.intro() |
| 2029 | else: |
| 2030 | self.help(request) |
Ka-Ping Yee | dec96e9 | 2001-04-13 09:55:49 +0000 | [diff] [blame] | 2031 | |
Johannes Gijsbers | e7691d3 | 2004-08-17 13:21:53 +0000 | [diff] [blame] | 2032 | def getline(self, prompt): |
Guido van Rossum | 7c086c0 | 2008-01-02 03:52:38 +0000 | [diff] [blame] | 2033 | """Read one line, using input() when appropriate.""" |
Johannes Gijsbers | e7691d3 | 2004-08-17 13:21:53 +0000 | [diff] [blame] | 2034 | if self.input is sys.stdin: |
Guido van Rossum | 7c086c0 | 2008-01-02 03:52:38 +0000 | [diff] [blame] | 2035 | return input(prompt) |
Johannes Gijsbers | e7691d3 | 2004-08-17 13:21:53 +0000 | [diff] [blame] | 2036 | else: |
| 2037 | self.output.write(prompt) |
| 2038 | self.output.flush() |
| 2039 | return self.input.readline() |
| 2040 | |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2041 | def help(self, request): |
| 2042 | if type(request) is type(''): |
R. David Murray | 1f1b9d3 | 2009-05-27 20:56:59 +0000 | [diff] [blame] | 2043 | request = request.strip() |
Serhiy Storchaka | 1c20551 | 2015-03-01 00:42:54 +0200 | [diff] [blame] | 2044 | if request == 'keywords': self.listkeywords() |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 2045 | elif request == 'symbols': self.listsymbols() |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2046 | elif request == 'topics': self.listtopics() |
| 2047 | elif request == 'modules': self.listmodules() |
| 2048 | elif request[:8] == 'modules ': |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 2049 | self.listmodules(request.split()[1]) |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 2050 | elif request in self.symbols: self.showsymbol(request) |
Ezio Melotti | b185a04 | 2011-04-28 07:42:55 +0300 | [diff] [blame] | 2051 | elif request in ['True', 'False', 'None']: |
| 2052 | # special case these keywords since they are objects too |
| 2053 | doc(eval(request), 'Help on %s:') |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 2054 | elif request in self.keywords: self.showtopic(request) |
| 2055 | elif request in self.topics: self.showtopic(request) |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 2056 | elif request: doc(request, 'Help on %s:', output=self._output) |
Serhiy Storchaka | 1c20551 | 2015-03-01 00:42:54 +0200 | [diff] [blame] | 2057 | else: doc(str, 'Help on %s:', output=self._output) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2058 | elif isinstance(request, Helper): self() |
Georg Brandl | d80d5f4 | 2010-12-03 07:47:22 +0000 | [diff] [blame] | 2059 | else: doc(request, 'Help on %s:', output=self._output) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2060 | self.output.write('\n') |
| 2061 | |
| 2062 | def intro(self): |
| 2063 | self.output.write(''' |
Serhiy Storchaka | 885bdc4 | 2016-02-11 13:10:36 +0200 | [diff] [blame] | 2064 | Welcome to Python {0}'s help utility! |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2065 | |
| 2066 | If this is your first time using Python, you should definitely check out |
oldk | e5681b9 | 2017-12-28 22:37:46 +0800 | [diff] [blame] | 2067 | the tutorial on the Internet at https://docs.python.org/{0}/tutorial/. |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2068 | |
| 2069 | Enter the name of any module, keyword, or topic to get help on writing |
| 2070 | Python programs and using Python modules. To quit this help utility and |
| 2071 | return to the interpreter, just type "quit". |
| 2072 | |
Terry Jan Reedy | 3420057 | 2013-02-11 02:23:13 -0500 | [diff] [blame] | 2073 | To get a list of available modules, keywords, symbols, or topics, type |
| 2074 | "modules", "keywords", "symbols", or "topics". Each module also comes |
| 2075 | with a one-line summary of what it does; to list the modules whose name |
| 2076 | or summary contain a given string such as "spam", type "modules spam". |
Serhiy Storchaka | 885bdc4 | 2016-02-11 13:10:36 +0200 | [diff] [blame] | 2077 | '''.format('%d.%d' % sys.version_info[:2])) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2078 | |
| 2079 | def list(self, items, columns=4, width=80): |
Guido van Rossum | 486364b | 2007-06-30 05:01:58 +0000 | [diff] [blame] | 2080 | items = list(sorted(items)) |
| 2081 | colw = width // columns |
| 2082 | rows = (len(items) + columns - 1) // columns |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2083 | for row in range(rows): |
| 2084 | for col in range(columns): |
| 2085 | i = col * rows + row |
| 2086 | if i < len(items): |
| 2087 | self.output.write(items[i]) |
| 2088 | if col < columns - 1: |
Guido van Rossum | 486364b | 2007-06-30 05:01:58 +0000 | [diff] [blame] | 2089 | self.output.write(' ' + ' ' * (colw - 1 - len(items[i]))) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2090 | self.output.write('\n') |
| 2091 | |
| 2092 | def listkeywords(self): |
| 2093 | self.output.write(''' |
| 2094 | Here is a list of the Python keywords. Enter any keyword to get more help. |
| 2095 | |
| 2096 | ''') |
| 2097 | self.list(self.keywords.keys()) |
| 2098 | |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 2099 | def listsymbols(self): |
| 2100 | self.output.write(''' |
| 2101 | Here is a list of the punctuation symbols which Python assigns special meaning |
| 2102 | to. Enter any symbol to get more help. |
| 2103 | |
| 2104 | ''') |
| 2105 | self.list(self.symbols.keys()) |
| 2106 | |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2107 | def listtopics(self): |
| 2108 | self.output.write(''' |
| 2109 | Here is a list of available topics. Enter any topic name to get more help. |
| 2110 | |
| 2111 | ''') |
| 2112 | self.list(self.topics.keys()) |
| 2113 | |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 2114 | def showtopic(self, topic, more_xrefs=''): |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 2115 | try: |
Georg Brandl | 5617db8 | 2009-04-27 16:28:57 +0000 | [diff] [blame] | 2116 | import pydoc_data.topics |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 2117 | except ImportError: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2118 | self.output.write(''' |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 2119 | Sorry, topic and keyword documentation is not available because the |
Georg Brandl | 5617db8 | 2009-04-27 16:28:57 +0000 | [diff] [blame] | 2120 | module "pydoc_data.topics" could not be found. |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2121 | ''') |
| 2122 | return |
| 2123 | target = self.topics.get(topic, self.keywords.get(topic)) |
| 2124 | if not target: |
| 2125 | self.output.write('no documentation found for %s\n' % repr(topic)) |
| 2126 | return |
| 2127 | if type(target) is type(''): |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 2128 | return self.showtopic(target, more_xrefs) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2129 | |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 2130 | label, xrefs = target |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2131 | try: |
Georg Brandl | 5617db8 | 2009-04-27 16:28:57 +0000 | [diff] [blame] | 2132 | doc = pydoc_data.topics.topics[label] |
Georg Brandl | 6b38daa | 2008-06-01 21:05:17 +0000 | [diff] [blame] | 2133 | except KeyError: |
| 2134 | self.output.write('no documentation found for %s\n' % repr(topic)) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2135 | return |
Berker Peksag | d04f46c | 2018-07-23 08:37:47 +0300 | [diff] [blame] | 2136 | doc = doc.strip() + '\n' |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 2137 | if more_xrefs: |
| 2138 | xrefs = (xrefs or '') + ' ' + more_xrefs |
Ka-Ping Yee | da79389 | 2001-04-13 11:02:51 +0000 | [diff] [blame] | 2139 | if xrefs: |
Brett Cannon | 1448ecf | 2013-10-04 11:38:59 -0400 | [diff] [blame] | 2140 | import textwrap |
| 2141 | text = 'Related help topics: ' + ', '.join(xrefs.split()) + '\n' |
| 2142 | wrapped_text = textwrap.wrap(text, 72) |
Berker Peksag | d04f46c | 2018-07-23 08:37:47 +0300 | [diff] [blame] | 2143 | doc += '\n%s\n' % '\n'.join(wrapped_text) |
| 2144 | pager(doc) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2145 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2146 | def _gettopic(self, topic, more_xrefs=''): |
| 2147 | """Return unbuffered tuple of (topic, xrefs). |
| 2148 | |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2149 | If an error occurs here, the exception is caught and displayed by |
| 2150 | the url handler. |
| 2151 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2152 | This function duplicates the showtopic method but returns its |
| 2153 | result directly so it can be formatted for display in an html page. |
| 2154 | """ |
| 2155 | try: |
| 2156 | import pydoc_data.topics |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 2157 | except ImportError: |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2158 | return(''' |
| 2159 | Sorry, topic and keyword documentation is not available because the |
| 2160 | module "pydoc_data.topics" could not be found. |
| 2161 | ''' , '') |
| 2162 | target = self.topics.get(topic, self.keywords.get(topic)) |
| 2163 | if not target: |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2164 | raise ValueError('could not find topic') |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2165 | if isinstance(target, str): |
| 2166 | return self._gettopic(target, more_xrefs) |
| 2167 | label, xrefs = target |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2168 | doc = pydoc_data.topics.topics[label] |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2169 | if more_xrefs: |
| 2170 | xrefs = (xrefs or '') + ' ' + more_xrefs |
| 2171 | return doc, xrefs |
| 2172 | |
Georg Brandl | db7b6b9 | 2009-01-01 15:53:14 +0000 | [diff] [blame] | 2173 | def showsymbol(self, symbol): |
| 2174 | target = self.symbols[symbol] |
| 2175 | topic, _, xrefs = target.partition(' ') |
| 2176 | self.showtopic(topic, xrefs) |
| 2177 | |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2178 | def listmodules(self, key=''): |
| 2179 | if key: |
| 2180 | self.output.write(''' |
Terry Jan Reedy | 3420057 | 2013-02-11 02:23:13 -0500 | [diff] [blame] | 2181 | Here is a list of modules whose name or summary contains '{}'. |
| 2182 | If there are any, enter a module name to get more help. |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2183 | |
Terry Jan Reedy | 3420057 | 2013-02-11 02:23:13 -0500 | [diff] [blame] | 2184 | '''.format(key)) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2185 | apropos(key) |
| 2186 | else: |
| 2187 | self.output.write(''' |
| 2188 | Please wait a moment while I gather a list of all available modules... |
| 2189 | |
| 2190 | ''') |
| 2191 | modules = {} |
| 2192 | def callback(path, modname, desc, modules=modules): |
| 2193 | if modname and modname[-9:] == '.__init__': |
| 2194 | modname = modname[:-9] + ' (package)' |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 2195 | if modname.find('.') < 0: |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2196 | modules[modname] = 1 |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 2197 | def onerror(modname): |
| 2198 | callback(None, modname, None) |
| 2199 | ModuleScanner().run(callback, onerror=onerror) |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2200 | self.list(modules.keys()) |
| 2201 | self.output.write(''' |
| 2202 | Enter any module name to get more help. Or, type "modules spam" to search |
Terry Jan Reedy | 3420057 | 2013-02-11 02:23:13 -0500 | [diff] [blame] | 2203 | for modules whose name or summary contain the string "spam". |
Ka-Ping Yee | 35cf0a3 | 2001-04-12 19:53:52 +0000 | [diff] [blame] | 2204 | ''') |
| 2205 | |
Georg Brandl | 78aa396 | 2010-07-31 21:51:48 +0000 | [diff] [blame] | 2206 | help = Helper() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2207 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2208 | class ModuleScanner: |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2209 | """An interruptible scanner that searches module synopses.""" |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2210 | |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 2211 | def run(self, callback, key=None, completer=None, onerror=None): |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 2212 | if key: key = key.lower() |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 2213 | self.quit = False |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2214 | seen = {} |
| 2215 | |
| 2216 | for modname in sys.builtin_module_names: |
Ka-Ping Yee | 239432a | 2001-03-02 02:45:08 +0000 | [diff] [blame] | 2217 | if modname != '__main__': |
| 2218 | seen[modname] = 1 |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 2219 | if key is None: |
| 2220 | callback(None, modname, '') |
| 2221 | else: |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 2222 | name = __import__(modname).__doc__ or '' |
| 2223 | desc = name.split('\n')[0] |
| 2224 | name = modname + ' - ' + desc |
| 2225 | if name.lower().find(key) >= 0: |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 2226 | callback(None, modname, desc) |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2227 | |
Christian Heimes | d32ed6f | 2008-01-14 18:49:24 +0000 | [diff] [blame] | 2228 | for importer, modname, ispkg in pkgutil.walk_packages(onerror=onerror): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2229 | if self.quit: |
| 2230 | break |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2231 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2232 | if key is None: |
| 2233 | callback(None, modname, '') |
| 2234 | else: |
Georg Brandl | 126c879 | 2009-04-05 15:05:48 +0000 | [diff] [blame] | 2235 | try: |
Eric Snow | 3a62d14 | 2014-01-06 20:42:59 -0700 | [diff] [blame] | 2236 | spec = pkgutil._get_spec(importer, modname) |
Georg Brandl | 126c879 | 2009-04-05 15:05:48 +0000 | [diff] [blame] | 2237 | except SyntaxError: |
| 2238 | # raised by tests for bad coding cookies or BOM |
| 2239 | continue |
Eric Snow | 3a62d14 | 2014-01-06 20:42:59 -0700 | [diff] [blame] | 2240 | loader = spec.loader |
Georg Brandl | 126c879 | 2009-04-05 15:05:48 +0000 | [diff] [blame] | 2241 | if hasattr(loader, 'get_source'): |
Amaury Forgeot d'Arc | 9196dc6 | 2008-06-19 20:54:32 +0000 | [diff] [blame] | 2242 | try: |
| 2243 | source = loader.get_source(modname) |
Nick Coghlan | 2824cb5 | 2012-07-15 22:12:14 +1000 | [diff] [blame] | 2244 | except Exception: |
Amaury Forgeot d'Arc | 9196dc6 | 2008-06-19 20:54:32 +0000 | [diff] [blame] | 2245 | if onerror: |
| 2246 | onerror(modname) |
| 2247 | continue |
Amaury Forgeot d'Arc | 9196dc6 | 2008-06-19 20:54:32 +0000 | [diff] [blame] | 2248 | desc = source_synopsis(io.StringIO(source)) or '' |
Georg Brandl | 126c879 | 2009-04-05 15:05:48 +0000 | [diff] [blame] | 2249 | if hasattr(loader, 'get_filename'): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2250 | path = loader.get_filename(modname) |
Ka-Ping Yee | 6624696 | 2001-04-12 11:59:50 +0000 | [diff] [blame] | 2251 | else: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2252 | path = None |
| 2253 | else: |
Amaury Forgeot d'Arc | 9196dc6 | 2008-06-19 20:54:32 +0000 | [diff] [blame] | 2254 | try: |
Brett Cannon | 2a17bde | 2014-05-30 14:55:29 -0400 | [diff] [blame] | 2255 | module = importlib._bootstrap._load(spec) |
Amaury Forgeot d'Arc | 9196dc6 | 2008-06-19 20:54:32 +0000 | [diff] [blame] | 2256 | except ImportError: |
| 2257 | if onerror: |
| 2258 | onerror(modname) |
| 2259 | continue |
Benjamin Peterson | 54237f9 | 2015-02-16 19:45:01 -0500 | [diff] [blame] | 2260 | desc = module.__doc__.splitlines()[0] if module.__doc__ else '' |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2261 | path = getattr(module,'__file__',None) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 2262 | name = modname + ' - ' + desc |
| 2263 | if name.lower().find(key) >= 0: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2264 | callback(path, modname, desc) |
| 2265 | |
| 2266 | if completer: |
| 2267 | completer() |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2268 | |
| 2269 | def apropos(key): |
| 2270 | """Print all the one-line module summaries that contain a substring.""" |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2271 | def callback(path, modname, desc): |
| 2272 | if modname[-9:] == '.__init__': |
| 2273 | modname = modname[:-9] + ' (package)' |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2274 | print(modname, desc and '- ' + desc) |
Amaury Forgeot d'Arc | 9196dc6 | 2008-06-19 20:54:32 +0000 | [diff] [blame] | 2275 | def onerror(modname): |
| 2276 | pass |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2277 | with warnings.catch_warnings(): |
| 2278 | warnings.filterwarnings('ignore') # ignore problems during import |
| 2279 | ModuleScanner().run(callback, key, onerror=onerror) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2280 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2281 | # --------------------------------------- enhanced Web browser interface |
| 2282 | |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2283 | def _start_server(urlhandler, hostname, port): |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2284 | """Start an HTTP server thread on a specific port. |
| 2285 | |
| 2286 | Start an HTML/text server thread, so HTML or text documents can be |
| 2287 | browsed dynamically and interactively with a Web browser. Example use: |
| 2288 | |
| 2289 | >>> import time |
| 2290 | >>> import pydoc |
| 2291 | |
| 2292 | Define a URL handler. To determine what the client is asking |
| 2293 | for, check the URL and content_type. |
| 2294 | |
| 2295 | Then get or generate some text or HTML code and return it. |
| 2296 | |
| 2297 | >>> def my_url_handler(url, content_type): |
| 2298 | ... text = 'the URL sent was: (%s, %s)' % (url, content_type) |
| 2299 | ... return text |
| 2300 | |
| 2301 | Start server thread on port 0. |
| 2302 | If you use port 0, the server will pick a random port number. |
| 2303 | You can then use serverthread.port to get the port number. |
| 2304 | |
| 2305 | >>> port = 0 |
| 2306 | >>> serverthread = pydoc._start_server(my_url_handler, port) |
| 2307 | |
| 2308 | Check that the server is really started. If it is, open browser |
| 2309 | and get first page. Use serverthread.url as the starting page. |
| 2310 | |
| 2311 | >>> if serverthread.serving: |
| 2312 | ... import webbrowser |
| 2313 | |
| 2314 | The next two lines are commented out so a browser doesn't open if |
| 2315 | doctest is run on this module. |
| 2316 | |
| 2317 | #... webbrowser.open(serverthread.url) |
| 2318 | #True |
| 2319 | |
| 2320 | Let the server do its thing. We just need to monitor its status. |
| 2321 | Use time.sleep so the loop doesn't hog the CPU. |
| 2322 | |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 2323 | >>> starttime = time.monotonic() |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2324 | >>> timeout = 1 #seconds |
| 2325 | |
| 2326 | This is a short timeout for testing purposes. |
| 2327 | |
| 2328 | >>> while serverthread.serving: |
| 2329 | ... time.sleep(.01) |
Victor Stinner | 2cf4c20 | 2018-12-17 09:36:36 +0100 | [diff] [blame] | 2330 | ... if serverthread.serving and time.monotonic() - starttime > timeout: |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2331 | ... serverthread.stop() |
| 2332 | ... break |
| 2333 | |
| 2334 | Print any errors that may have occurred. |
| 2335 | |
| 2336 | >>> print(serverthread.error) |
| 2337 | None |
| 2338 | """ |
| 2339 | import http.server |
| 2340 | import email.message |
| 2341 | import select |
| 2342 | import threading |
| 2343 | |
| 2344 | class DocHandler(http.server.BaseHTTPRequestHandler): |
| 2345 | |
| 2346 | def do_GET(self): |
| 2347 | """Process a request from an HTML browser. |
| 2348 | |
| 2349 | The URL received is in self.path. |
| 2350 | Get an HTML page from self.urlhandler and send it. |
| 2351 | """ |
| 2352 | if self.path.endswith('.css'): |
| 2353 | content_type = 'text/css' |
| 2354 | else: |
| 2355 | content_type = 'text/html' |
| 2356 | self.send_response(200) |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2357 | self.send_header('Content-Type', '%s; charset=UTF-8' % content_type) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2358 | self.end_headers() |
| 2359 | self.wfile.write(self.urlhandler( |
| 2360 | self.path, content_type).encode('utf-8')) |
| 2361 | |
| 2362 | def log_message(self, *args): |
| 2363 | # Don't log messages. |
| 2364 | pass |
| 2365 | |
| 2366 | class DocServer(http.server.HTTPServer): |
| 2367 | |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2368 | def __init__(self, host, port, callback): |
| 2369 | self.host = host |
Senthil Kumaran | 2a42a0b | 2014-09-17 13:17:58 +0800 | [diff] [blame] | 2370 | self.address = (self.host, port) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2371 | self.callback = callback |
| 2372 | self.base.__init__(self, self.address, self.handler) |
| 2373 | self.quit = False |
| 2374 | |
| 2375 | def serve_until_quit(self): |
| 2376 | while not self.quit: |
| 2377 | rd, wr, ex = select.select([self.socket.fileno()], [], [], 1) |
| 2378 | if rd: |
| 2379 | self.handle_request() |
Victor Stinner | a3abd1d | 2011-01-03 16:12:39 +0000 | [diff] [blame] | 2380 | self.server_close() |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2381 | |
| 2382 | def server_activate(self): |
| 2383 | self.base.server_activate(self) |
| 2384 | if self.callback: |
| 2385 | self.callback(self) |
| 2386 | |
| 2387 | class ServerThread(threading.Thread): |
| 2388 | |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2389 | def __init__(self, urlhandler, host, port): |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2390 | self.urlhandler = urlhandler |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2391 | self.host = host |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2392 | self.port = int(port) |
| 2393 | threading.Thread.__init__(self) |
| 2394 | self.serving = False |
| 2395 | self.error = None |
| 2396 | |
| 2397 | def run(self): |
| 2398 | """Start the server.""" |
| 2399 | try: |
| 2400 | DocServer.base = http.server.HTTPServer |
| 2401 | DocServer.handler = DocHandler |
| 2402 | DocHandler.MessageClass = email.message.Message |
| 2403 | DocHandler.urlhandler = staticmethod(self.urlhandler) |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2404 | docsvr = DocServer(self.host, self.port, self.ready) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2405 | self.docserver = docsvr |
| 2406 | docsvr.serve_until_quit() |
| 2407 | except Exception as e: |
| 2408 | self.error = e |
| 2409 | |
| 2410 | def ready(self, server): |
| 2411 | self.serving = True |
| 2412 | self.host = server.host |
| 2413 | self.port = server.server_port |
| 2414 | self.url = 'http://%s:%d/' % (self.host, self.port) |
| 2415 | |
| 2416 | def stop(self): |
| 2417 | """Stop the server and this thread nicely""" |
| 2418 | self.docserver.quit = True |
Victor Stinner | 4cab2cd | 2017-08-21 23:24:40 +0200 | [diff] [blame] | 2419 | self.join() |
| 2420 | # explicitly break a reference cycle: DocServer.callback |
| 2421 | # has indirectly a reference to ServerThread. |
| 2422 | self.docserver = None |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2423 | self.serving = False |
| 2424 | self.url = None |
| 2425 | |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2426 | thread = ServerThread(urlhandler, hostname, port) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2427 | thread.start() |
| 2428 | # Wait until thread.serving is True to make sure we are |
| 2429 | # really up before returning. |
| 2430 | while not thread.error and not thread.serving: |
| 2431 | time.sleep(.01) |
| 2432 | return thread |
| 2433 | |
| 2434 | |
| 2435 | def _url_handler(url, content_type="text/html"): |
| 2436 | """The pydoc url handler for use with the pydoc server. |
| 2437 | |
| 2438 | If the content_type is 'text/css', the _pydoc.css style |
| 2439 | sheet is read and returned if it exits. |
| 2440 | |
| 2441 | If the content_type is 'text/html', then the result of |
| 2442 | get_html_page(url) is returned. |
| 2443 | """ |
| 2444 | class _HTMLDoc(HTMLDoc): |
| 2445 | |
| 2446 | def page(self, title, contents): |
| 2447 | """Format an HTML page.""" |
| 2448 | css_path = "pydoc_data/_pydoc.css" |
| 2449 | css_link = ( |
| 2450 | '<link rel="stylesheet" type="text/css" href="%s">' % |
| 2451 | css_path) |
| 2452 | return '''\ |
| 2453 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2454 | <html><head><title>Pydoc: %s</title> |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2455 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2456 | %s</head><body bgcolor="#f0f0f8">%s<div style="clear:both;padding-top:.5em;">%s</div> |
| 2457 | </body></html>''' % (title, css_link, html_navbar(), contents) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2458 | |
| 2459 | def filelink(self, url, path): |
| 2460 | return '<a href="getfile?key=%s">%s</a>' % (url, path) |
| 2461 | |
| 2462 | |
| 2463 | html = _HTMLDoc() |
| 2464 | |
| 2465 | def html_navbar(): |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2466 | version = html.escape("%s [%s, %s]" % (platform.python_version(), |
| 2467 | platform.python_build()[0], |
| 2468 | platform.python_compiler())) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2469 | return """ |
| 2470 | <div style='float:left'> |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2471 | Python %s<br>%s |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2472 | </div> |
| 2473 | <div style='float:right'> |
| 2474 | <div style='text-align:center'> |
| 2475 | <a href="index.html">Module Index</a> |
| 2476 | : <a href="topics.html">Topics</a> |
| 2477 | : <a href="keywords.html">Keywords</a> |
| 2478 | </div> |
| 2479 | <div> |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2480 | <form action="get" style='display:inline;'> |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2481 | <input type=text name=key size=15> |
| 2482 | <input type=submit value="Get"> |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2483 | </form> |
| 2484 | <form action="search" style='display:inline;'> |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2485 | <input type=text name=key size=15> |
| 2486 | <input type=submit value="Search"> |
| 2487 | </form> |
| 2488 | </div> |
| 2489 | </div> |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2490 | """ % (version, html.escape(platform.platform(terse=True))) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2491 | |
| 2492 | def html_index(): |
| 2493 | """Module Index page.""" |
| 2494 | |
| 2495 | def bltinlink(name): |
| 2496 | return '<a href="%s.html">%s</a>' % (name, name) |
| 2497 | |
| 2498 | heading = html.heading( |
| 2499 | '<big><big><strong>Index of Modules</strong></big></big>', |
| 2500 | '#ffffff', '#7799ee') |
| 2501 | names = [name for name in sys.builtin_module_names |
| 2502 | if name != '__main__'] |
| 2503 | contents = html.multicolumn(names, bltinlink) |
| 2504 | contents = [heading, '<p>' + html.bigsection( |
| 2505 | 'Built-in Modules', '#ffffff', '#ee77aa', contents)] |
| 2506 | |
| 2507 | seen = {} |
| 2508 | for dir in sys.path: |
| 2509 | contents.append(html.index(dir, seen)) |
| 2510 | |
| 2511 | contents.append( |
| 2512 | '<p align=right><font color="#909090" face="helvetica,' |
| 2513 | 'arial"><strong>pydoc</strong> by Ka-Ping Yee' |
| 2514 | '<ping@lfw.org></font>') |
Nick Coghlan | ecace28 | 2010-12-03 16:08:46 +0000 | [diff] [blame] | 2515 | return 'Index of Modules', ''.join(contents) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2516 | |
| 2517 | def html_search(key): |
| 2518 | """Search results page.""" |
| 2519 | # scan for modules |
| 2520 | search_result = [] |
| 2521 | |
| 2522 | def callback(path, modname, desc): |
| 2523 | if modname[-9:] == '.__init__': |
| 2524 | modname = modname[:-9] + ' (package)' |
| 2525 | search_result.append((modname, desc and '- ' + desc)) |
| 2526 | |
| 2527 | with warnings.catch_warnings(): |
| 2528 | warnings.filterwarnings('ignore') # ignore problems during import |
Martin Panter | 9ad0aae | 2015-11-06 00:27:14 +0000 | [diff] [blame] | 2529 | def onerror(modname): |
| 2530 | pass |
| 2531 | ModuleScanner().run(callback, key, onerror=onerror) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2532 | |
| 2533 | # format page |
| 2534 | def bltinlink(name): |
| 2535 | return '<a href="%s.html">%s</a>' % (name, name) |
| 2536 | |
| 2537 | results = [] |
| 2538 | heading = html.heading( |
| 2539 | '<big><big><strong>Search Results</strong></big></big>', |
| 2540 | '#ffffff', '#7799ee') |
| 2541 | for name, desc in search_result: |
| 2542 | results.append(bltinlink(name) + desc) |
| 2543 | contents = heading + html.bigsection( |
| 2544 | 'key = %s' % key, '#ffffff', '#ee77aa', '<br>'.join(results)) |
Nick Coghlan | ecace28 | 2010-12-03 16:08:46 +0000 | [diff] [blame] | 2545 | return 'Search Results', contents |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2546 | |
| 2547 | def html_getfile(path): |
| 2548 | """Get and display a source file listing safely.""" |
Zachary Ware | eb43214 | 2014-07-10 11:18:00 -0500 | [diff] [blame] | 2549 | path = urllib.parse.unquote(path) |
Victor Stinner | 91e0877 | 2011-07-05 14:30:41 +0200 | [diff] [blame] | 2550 | with tokenize.open(path) as fp: |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2551 | lines = html.escape(fp.read()) |
| 2552 | body = '<pre>%s</pre>' % lines |
| 2553 | heading = html.heading( |
| 2554 | '<big><big><strong>File Listing</strong></big></big>', |
| 2555 | '#ffffff', '#7799ee') |
| 2556 | contents = heading + html.bigsection( |
| 2557 | 'File: %s' % path, '#ffffff', '#ee77aa', body) |
Nick Coghlan | ecace28 | 2010-12-03 16:08:46 +0000 | [diff] [blame] | 2558 | return 'getfile %s' % path, contents |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2559 | |
| 2560 | def html_topics(): |
| 2561 | """Index of topic texts available.""" |
| 2562 | |
| 2563 | def bltinlink(name): |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2564 | return '<a href="topic?key=%s">%s</a>' % (name, name) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2565 | |
| 2566 | heading = html.heading( |
| 2567 | '<big><big><strong>INDEX</strong></big></big>', |
| 2568 | '#ffffff', '#7799ee') |
| 2569 | names = sorted(Helper.topics.keys()) |
| 2570 | |
| 2571 | contents = html.multicolumn(names, bltinlink) |
| 2572 | contents = heading + html.bigsection( |
| 2573 | 'Topics', '#ffffff', '#ee77aa', contents) |
Nick Coghlan | ecace28 | 2010-12-03 16:08:46 +0000 | [diff] [blame] | 2574 | return 'Topics', contents |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2575 | |
| 2576 | def html_keywords(): |
| 2577 | """Index of keywords.""" |
| 2578 | heading = html.heading( |
| 2579 | '<big><big><strong>INDEX</strong></big></big>', |
| 2580 | '#ffffff', '#7799ee') |
| 2581 | names = sorted(Helper.keywords.keys()) |
| 2582 | |
| 2583 | def bltinlink(name): |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2584 | return '<a href="topic?key=%s">%s</a>' % (name, name) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2585 | |
| 2586 | contents = html.multicolumn(names, bltinlink) |
| 2587 | contents = heading + html.bigsection( |
| 2588 | 'Keywords', '#ffffff', '#ee77aa', contents) |
Nick Coghlan | ecace28 | 2010-12-03 16:08:46 +0000 | [diff] [blame] | 2589 | return 'Keywords', contents |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2590 | |
| 2591 | def html_topicpage(topic): |
| 2592 | """Topic or keyword help page.""" |
| 2593 | buf = io.StringIO() |
| 2594 | htmlhelp = Helper(buf, buf) |
| 2595 | contents, xrefs = htmlhelp._gettopic(topic) |
| 2596 | if topic in htmlhelp.keywords: |
| 2597 | title = 'KEYWORD' |
| 2598 | else: |
| 2599 | title = 'TOPIC' |
| 2600 | heading = html.heading( |
| 2601 | '<big><big><strong>%s</strong></big></big>' % title, |
| 2602 | '#ffffff', '#7799ee') |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2603 | contents = '<pre>%s</pre>' % html.markup(contents) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2604 | contents = html.bigsection(topic , '#ffffff','#ee77aa', contents) |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2605 | if xrefs: |
| 2606 | xrefs = sorted(xrefs.split()) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2607 | |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2608 | def bltinlink(name): |
| 2609 | return '<a href="topic?key=%s">%s</a>' % (name, name) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2610 | |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2611 | xrefs = html.multicolumn(xrefs, bltinlink) |
| 2612 | xrefs = html.section('Related help topics: ', |
| 2613 | '#ffffff', '#ee77aa', xrefs) |
Nick Coghlan | ecace28 | 2010-12-03 16:08:46 +0000 | [diff] [blame] | 2614 | return ('%s %s' % (title, topic), |
| 2615 | ''.join((heading, contents, xrefs))) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2616 | |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2617 | def html_getobj(url): |
| 2618 | obj = locate(url, forceload=1) |
| 2619 | if obj is None and url != 'None': |
| 2620 | raise ValueError('could not find object') |
| 2621 | title = describe(obj) |
| 2622 | content = html.document(obj, url) |
| 2623 | return title, content |
| 2624 | |
| 2625 | def html_error(url, exc): |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2626 | heading = html.heading( |
| 2627 | '<big><big><strong>Error</strong></big></big>', |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2628 | '#ffffff', '#7799ee') |
| 2629 | contents = '<br>'.join(html.escape(line) for line in |
| 2630 | format_exception_only(type(exc), exc)) |
| 2631 | contents = heading + html.bigsection(url, '#ffffff', '#bb0000', |
| 2632 | contents) |
| 2633 | return "Error - %s" % url, contents |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2634 | |
| 2635 | def get_html_page(url): |
| 2636 | """Generate an HTML page for url.""" |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2637 | complete_url = url |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2638 | if url.endswith('.html'): |
| 2639 | url = url[:-5] |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2640 | try: |
| 2641 | if url in ("", "index"): |
| 2642 | title, content = html_index() |
| 2643 | elif url == "topics": |
| 2644 | title, content = html_topics() |
| 2645 | elif url == "keywords": |
| 2646 | title, content = html_keywords() |
| 2647 | elif '=' in url: |
| 2648 | op, _, url = url.partition('=') |
| 2649 | if op == "search?key": |
| 2650 | title, content = html_search(url) |
| 2651 | elif op == "getfile?key": |
| 2652 | title, content = html_getfile(url) |
| 2653 | elif op == "topic?key": |
| 2654 | # try topics first, then objects. |
| 2655 | try: |
| 2656 | title, content = html_topicpage(url) |
| 2657 | except ValueError: |
| 2658 | title, content = html_getobj(url) |
| 2659 | elif op == "get?key": |
| 2660 | # try objects first, then topics. |
| 2661 | if url in ("", "index"): |
| 2662 | title, content = html_index() |
| 2663 | else: |
| 2664 | try: |
| 2665 | title, content = html_getobj(url) |
| 2666 | except ValueError: |
| 2667 | title, content = html_topicpage(url) |
| 2668 | else: |
| 2669 | raise ValueError('bad pydoc url') |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2670 | else: |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2671 | title, content = html_getobj(url) |
| 2672 | except Exception as exc: |
| 2673 | # Catch any errors and display them in an error page. |
| 2674 | title, content = html_error(complete_url, exc) |
| 2675 | return html.page(title, content) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2676 | |
| 2677 | if url.startswith('/'): |
| 2678 | url = url[1:] |
| 2679 | if content_type == 'text/css': |
| 2680 | path_here = os.path.dirname(os.path.realpath(__file__)) |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2681 | css_path = os.path.join(path_here, url) |
| 2682 | with open(css_path) as fp: |
| 2683 | return ''.join(fp.readlines()) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2684 | elif content_type == 'text/html': |
| 2685 | return get_html_page(url) |
Georg Brandl | d2f3857 | 2011-01-30 08:37:19 +0000 | [diff] [blame] | 2686 | # Errors outside the url handler are caught by the server. |
| 2687 | raise TypeError('unknown content type %r for url %s' % (content_type, url)) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2688 | |
| 2689 | |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2690 | def browse(port=0, *, open_browser=True, hostname='localhost'): |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2691 | """Start the enhanced pydoc Web server and open a Web browser. |
| 2692 | |
| 2693 | Use port '0' to start the server on an arbitrary port. |
| 2694 | Set open_browser to False to suppress opening a browser. |
| 2695 | """ |
| 2696 | import webbrowser |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2697 | serverthread = _start_server(_url_handler, hostname, port) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2698 | if serverthread.error: |
| 2699 | print(serverthread.error) |
| 2700 | return |
| 2701 | if serverthread.serving: |
| 2702 | server_help_msg = 'Server commands: [b]rowser, [q]uit' |
| 2703 | if open_browser: |
| 2704 | webbrowser.open(serverthread.url) |
| 2705 | try: |
| 2706 | print('Server ready at', serverthread.url) |
| 2707 | print(server_help_msg) |
| 2708 | while serverthread.serving: |
| 2709 | cmd = input('server> ') |
| 2710 | cmd = cmd.lower() |
| 2711 | if cmd == 'q': |
| 2712 | break |
| 2713 | elif cmd == 'b': |
| 2714 | webbrowser.open(serverthread.url) |
| 2715 | else: |
| 2716 | print(server_help_msg) |
| 2717 | except (KeyboardInterrupt, EOFError): |
| 2718 | print() |
| 2719 | finally: |
| 2720 | if serverthread.serving: |
| 2721 | serverthread.stop() |
| 2722 | print('Server stopped') |
| 2723 | |
| 2724 | |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2725 | # -------------------------------------------------- command-line interface |
| 2726 | |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2727 | def ispath(x): |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 2728 | return isinstance(x, str) and x.find(os.sep) >= 0 |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2729 | |
Nick Coghlan | 82a9481 | 2018-04-15 21:52:57 +1000 | [diff] [blame] | 2730 | def _get_revised_path(given_path, argv0): |
| 2731 | """Ensures current directory is on returned path, and argv0 directory is not |
| 2732 | |
| 2733 | Exception: argv0 dir is left alone if it's also pydoc's directory. |
| 2734 | |
| 2735 | Returns a new path entry list, or None if no adjustment is needed. |
| 2736 | """ |
| 2737 | # Scripts may get the current directory in their path by default if they're |
| 2738 | # run with the -m switch, or directly from the current directory. |
| 2739 | # The interactive prompt also allows imports from the current directory. |
| 2740 | |
| 2741 | # Accordingly, if the current directory is already present, don't make |
| 2742 | # any changes to the given_path |
| 2743 | if '' in given_path or os.curdir in given_path or os.getcwd() in given_path: |
| 2744 | return None |
| 2745 | |
| 2746 | # Otherwise, add the current directory to the given path, and remove the |
| 2747 | # script directory (as long as the latter isn't also pydoc's directory. |
| 2748 | stdlib_dir = os.path.dirname(__file__) |
| 2749 | script_dir = os.path.dirname(argv0) |
| 2750 | revised_path = given_path.copy() |
| 2751 | if script_dir in given_path and not os.path.samefile(script_dir, stdlib_dir): |
| 2752 | revised_path.remove(script_dir) |
| 2753 | revised_path.insert(0, os.getcwd()) |
| 2754 | return revised_path |
| 2755 | |
| 2756 | |
| 2757 | # Note: the tests only cover _get_revised_path, not _adjust_cli_path itself |
| 2758 | def _adjust_cli_sys_path(): |
Nick Coghlan | 1a5c4bd | 2018-04-15 23:32:05 +1000 | [diff] [blame] | 2759 | """Ensures current directory is on sys.path, and __main__ directory is not. |
Nick Coghlan | 82a9481 | 2018-04-15 21:52:57 +1000 | [diff] [blame] | 2760 | |
| 2761 | Exception: __main__ dir is left alone if it's also pydoc's directory. |
| 2762 | """ |
| 2763 | revised_path = _get_revised_path(sys.path, sys.argv[0]) |
| 2764 | if revised_path is not None: |
| 2765 | sys.path[:] = revised_path |
| 2766 | |
| 2767 | |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 2768 | def cli(): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2769 | """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] | 2770 | import getopt |
Guido van Rossum | 756aa93 | 2007-04-07 03:04:01 +0000 | [diff] [blame] | 2771 | class BadUsage(Exception): pass |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2772 | |
Nick Coghlan | 82a9481 | 2018-04-15 21:52:57 +1000 | [diff] [blame] | 2773 | _adjust_cli_sys_path() |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2774 | |
Ka-Ping Yee | 3bda879 | 2001-03-23 13:17:50 +0000 | [diff] [blame] | 2775 | try: |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2776 | opts, args = getopt.getopt(sys.argv[1:], 'bk:n:p:w') |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2777 | writing = False |
| 2778 | start_server = False |
| 2779 | open_browser = False |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2780 | port = 0 |
| 2781 | hostname = 'localhost' |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2782 | for opt, val in opts: |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2783 | if opt == '-b': |
| 2784 | start_server = True |
| 2785 | open_browser = True |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2786 | if opt == '-k': |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2787 | apropos(val) |
| 2788 | return |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2789 | if opt == '-p': |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2790 | start_server = True |
| 2791 | port = val |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2792 | if opt == '-w': |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2793 | writing = True |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2794 | if opt == '-n': |
| 2795 | start_server = True |
| 2796 | hostname = val |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2797 | |
Benjamin Peterson | b29614e | 2012-10-09 11:16:03 -0400 | [diff] [blame] | 2798 | if start_server: |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2799 | browse(port, hostname=hostname, open_browser=open_browser) |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2800 | return |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2801 | |
| 2802 | if not args: raise BadUsage |
| 2803 | for arg in args: |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 2804 | if ispath(arg) and not os.path.exists(arg): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2805 | print('file %r does not exist' % arg) |
Ka-Ping Yee | 45daeb0 | 2002-08-11 15:11:33 +0000 | [diff] [blame] | 2806 | break |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2807 | try: |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2808 | if ispath(arg) and os.path.isfile(arg): |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2809 | arg = importfile(arg) |
Ka-Ping Yee | 37f7b38 | 2001-03-23 00:12:53 +0000 | [diff] [blame] | 2810 | if writing: |
| 2811 | if ispath(arg) and os.path.isdir(arg): |
| 2812 | writedocs(arg) |
| 2813 | else: |
| 2814 | writedoc(arg) |
| 2815 | else: |
Martin v. Löwis | b8c084e | 2003-06-14 09:03:46 +0000 | [diff] [blame] | 2816 | help.help(arg) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 2817 | except ErrorDuringImport as value: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2818 | print(value) |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2819 | |
| 2820 | except (getopt.error, BadUsage): |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2821 | cmd = os.path.splitext(os.path.basename(sys.argv[0]))[0] |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2822 | print("""pydoc - the Python documentation tool |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2823 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2824 | {cmd} <name> ... |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2825 | 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] | 2826 | Python keyword, topic, function, module, or package, or a dotted |
| 2827 | reference to a class or function within a module or module in a |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2828 | package. If <name> contains a '{sep}', it is used as the path to a |
Martin v. Löwis | b8c084e | 2003-06-14 09:03:46 +0000 | [diff] [blame] | 2829 | Python source file to document. If name is 'keywords', 'topics', |
| 2830 | or 'modules', a listing of these things is displayed. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2831 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2832 | {cmd} -k <keyword> |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2833 | 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] | 2834 | |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2835 | {cmd} -n <hostname> |
| 2836 | Start an HTTP server with the given hostname (default: localhost). |
| 2837 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2838 | {cmd} -p <port> |
| 2839 | Start an HTTP server on the given port on the local machine. Port |
| 2840 | number 0 can be used to get an arbitrary unused port. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2841 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2842 | {cmd} -b |
| 2843 | Start an HTTP server on an arbitrary unused port and open a Web browser |
Feanil Patel | 6a396c9 | 2017-09-14 17:54:09 -0400 | [diff] [blame] | 2844 | to interactively browse documentation. This option can be used in |
| 2845 | combination with -n and/or -p. |
Ka-Ping Yee | dd17534 | 2001-02-27 14:43:46 +0000 | [diff] [blame] | 2846 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2847 | {cmd} -w <name> ... |
Ka-Ping Yee | 66efbc7 | 2001-03-01 13:55:20 +0000 | [diff] [blame] | 2848 | Write out the HTML documentation for a module to a file in the current |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2849 | directory. If <name> contains a '{sep}', it is treated as a filename; if |
Ka-Ping Yee | 5a804ed | 2001-04-10 11:46:02 +0000 | [diff] [blame] | 2850 | it names a directory, documentation is written for all the contents. |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2851 | """.format(cmd=cmd, sep=os.sep)) |
Ka-Ping Yee | 1d38463 | 2001-03-01 00:24:32 +0000 | [diff] [blame] | 2852 | |
Nick Coghlan | 7bb30b7 | 2010-12-03 09:29:11 +0000 | [diff] [blame] | 2853 | if __name__ == '__main__': |
| 2854 | cli() |