summaryrefslogtreecommitdiffstats
path: root/Doc/library/inspect.rst
diff options
context:
space:
mode:
authorChristian Heimes <christian@cheimes.de>2008-01-11 16:17:00 (GMT)
committerChristian Heimes <christian@cheimes.de>2008-01-11 16:17:00 (GMT)
commit25bb783c030cd1c4f13297f3e2e1b6246d3f0a0c (patch)
tree82773afa7d71ea9b6c971f4402128c6a3967bf75 /Doc/library/inspect.rst
parent222e1279f8d4d271a74486081f77d7346ea93105 (diff)
downloadcpython-25bb783c030cd1c4f13297f3e2e1b6246d3f0a0c.zip
cpython-25bb783c030cd1c4f13297f3e2e1b6246d3f0a0c.tar.gz
cpython-25bb783c030cd1c4f13297f3e2e1b6246d3f0a0c.tar.bz2
Merged revisions 59883-59920 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r59887 | neal.norwitz | 2008-01-10 06:42:58 +0100 (Thu, 10 Jan 2008) | 1 line Reword entry, not sure I made it much better though. ........ r59888 | andrew.kuchling | 2008-01-10 14:37:12 +0100 (Thu, 10 Jan 2008) | 1 line Check for fd of -1 to save fsync() and fstat() call ........ r59891 | thomas.heller | 2008-01-10 19:45:40 +0100 (Thu, 10 Jan 2008) | 1 line Reflow a paragraph, and fix a typo. ........ r59892 | raymond.hettinger | 2008-01-10 20:15:10 +0100 (Thu, 10 Jan 2008) | 1 line Examples for named tuple subclassing should include __slots__ ........ r59895 | raymond.hettinger | 2008-01-10 21:37:12 +0100 (Thu, 10 Jan 2008) | 1 line Clarify how to add a field to a named tuple. ........ r59896 | amaury.forgeotdarc | 2008-01-10 22:59:42 +0100 (Thu, 10 Jan 2008) | 12 lines Closing issue1761. Surprising behaviour of the "$" regexp: it matches the end of the string, AND just before the newline at the end of the string:: re.sub('$', '#', 'foo\n') == 'foo#\n#' Python is consistent with Perl and the pcre library, so we just document it. Guido prefers "\Z" to match only the end of the string. ........ r59898 | raymond.hettinger | 2008-01-11 00:00:01 +0100 (Fri, 11 Jan 2008) | 1 line Neaten-up the named tuple docs ........ r59900 | raymond.hettinger | 2008-01-11 01:23:13 +0100 (Fri, 11 Jan 2008) | 1 line Run doctests on the collections module ........ r59903 | raymond.hettinger | 2008-01-11 02:25:54 +0100 (Fri, 11 Jan 2008) | 1 line Doctest results return a named tuple for readability ........ r59904 | raymond.hettinger | 2008-01-11 03:12:33 +0100 (Fri, 11 Jan 2008) | 1 line Comment-out missing constant (from rev 59819) ........ r59905 | raymond.hettinger | 2008-01-11 03:24:13 +0100 (Fri, 11 Jan 2008) | 1 line Have Decimal.as_tuple return a named tuple. ........ r59906 | raymond.hettinger | 2008-01-11 04:04:50 +0100 (Fri, 11 Jan 2008) | 1 line Let most inspect functions return named tuples ........ r59907 | raymond.hettinger | 2008-01-11 04:20:54 +0100 (Fri, 11 Jan 2008) | 1 line Improve usability of the SequenceMatcher by returning named tuples describing match ranges. ........ r59909 | thomas.heller | 2008-01-11 09:04:03 +0100 (Fri, 11 Jan 2008) | 1 line Add an important missing blank. ........ r59910 | georg.brandl | 2008-01-11 10:19:11 +0100 (Fri, 11 Jan 2008) | 2 lines Guard definition of TIPC_SUB_CANCEL with an #ifdef. ........ r59911 | georg.brandl | 2008-01-11 10:20:58 +0100 (Fri, 11 Jan 2008) | 2 lines News entries for rev. 5990[567]. ........ r59912 | georg.brandl | 2008-01-11 10:55:53 +0100 (Fri, 11 Jan 2008) | 2 lines Documentation for r5990[3567]. ........ r59913 | thomas.heller | 2008-01-11 13:41:39 +0100 (Fri, 11 Jan 2008) | 4 lines The sqlite3 dll, when compiled in debug mode, must be linked with /MDd to use the debug runtime library. Further, the dll will be named sqlite3_d.dll. ........ r59919 | thomas.heller | 2008-01-11 16:38:46 +0100 (Fri, 11 Jan 2008) | 6 lines Revert revision 59913, because it was wrong: The sqlite3 dll, when compiled in debug mode, must be linked with /MDd to use the debug runtime library. Further, the dll will be named sqlite3_d.dll. ........ r59920 | christian.heimes | 2008-01-11 16:42:29 +0100 (Fri, 11 Jan 2008) | 1 line Removed unused variable ........
Diffstat (limited to 'Doc/library/inspect.rst')
-rw-r--r--Doc/library/inspect.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index e5008f6..5daa496 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -188,7 +188,8 @@ attributes:
.. function:: getmoduleinfo(path)
- Return a tuple of values that describe how Python will interpret the file
+ Returns a :term:`named tuple` ``ModuleInfo(name, suffix, mode,
+ module_type)`` of values that describe how Python will interpret the file
identified by *path* if it is a module, or ``None`` if it would not be
identified as a module. The return tuple is ``(name, suffix, mode, mtype)``,
where *name* is the name of the module without the name of any enclosing
@@ -377,8 +378,9 @@ Classes and functions
.. function:: getargspec(func)
- Get the names and default values of a function's arguments. A tuple of four
- things is returned: ``(args, varargs, varkw, defaults)``. *args* is a list of
+ Get the names and default values of a function's arguments. A
+ :term:`named tuple` ``ArgSpec(args, varargs, keywords,
+ defaults)`` is returned. *args* is a list of
the argument names. *varargs* and *varkw* are the names of the ``*`` and
``**`` arguments or ``None``. *defaults* is a tuple of default argument
values or None if there are no default arguments; if this tuple has *n*
@@ -391,10 +393,10 @@ Classes and functions
.. function:: getfullargspec(func)
- Get the names and default values of a function's arguments. A tuple of seven
- things is returned:
+ Get the names and default values of a function's arguments. A :term:`named tuple`
+ is returned:
- ``(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)``
+ ``FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations)``
*args* is a list of the argument names. *varargs* and *varkw* are the names
of the ``*`` and ``**`` arguments or ``None``. *defaults* is an n-tuple of
@@ -408,8 +410,8 @@ Classes and functions
.. function:: getargvalues(frame)
- Get information about arguments passed into a particular frame. A tuple of four
- things is returned: ``(args, varargs, varkw, locals)``. *args* is a list of the
+ Get information about arguments passed into a particular frame. A :term:`named tuple`
+ ``ArgInfo(args, varargs, keywords, locals)`` is returned. *args* is a list of the
argument names (it may contain nested lists). *varargs* and *varkw* are the
names of the ``*`` and ``**`` arguments or ``None``. *locals* is the locals
dictionary of the given frame.
@@ -476,8 +478,8 @@ line.
.. function:: getframeinfo(frame[, context])
- Get information about a frame or traceback object. A 5-tuple is returned, the
- last five elements of the frame's frame record.
+ Get information about a frame or traceback object. A :term:`named tuple`
+ ``Traceback(filename, lineno, function, code_context, index)`` is returned.
.. function:: getouterframes(frame[, context])