summaryrefslogtreecommitdiffstats
path: root/Lib/io.py
diff options
context:
space:
mode:
authorChristian Heimes <christian@cheimes.de>2007-12-08 17:47:40 (GMT)
committerChristian Heimes <christian@cheimes.de>2007-12-08 17:47:40 (GMT)
commita33eb06e3b29cc5df520bbb28261bd370f510932 (patch)
treec5b1b9e1d8e263a3b05f05be0a1f6292b538e372 /Lib/io.py
parent895627ff27aad563b2ae5b272998f17521b6e415 (diff)
downloadcpython-a33eb06e3b29cc5df520bbb28261bd370f510932.zip
cpython-a33eb06e3b29cc5df520bbb28261bd370f510932.tar.gz
cpython-a33eb06e3b29cc5df520bbb28261bd370f510932.tar.bz2
Added descriptor for builtins.open.__doc__
Before the change help(open) didn't return anything helpful but the doc string of io.OpenWrapper. Now it shows the user the documentation of io.open.
Diffstat (limited to 'Lib/io.py')
-rw-r--r--Lib/io.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/Lib/io.py b/Lib/io.py
index 5066c49..05ea94b 100644
--- a/Lib/io.py
+++ b/Lib/io.py
@@ -189,6 +189,14 @@ def open(file, mode="r", buffering=None, encoding=None, errors=None,
text.mode = mode
return text
+class _DocDescriptor:
+ """Helper for builtins.open.__doc__
+ """
+ def __get__(self, obj, typ):
+ return (
+ "open(file, mode='r', buffering=None, encoding=None, "
+ "errors=None, newline=None, closefd=True)\n\n" +
+ open.__doc__)
class OpenWrapper:
"""Wrapper for builtins.open
@@ -198,6 +206,8 @@ class OpenWrapper:
See initstdio() in Python/pythonrun.c.
"""
+ __doc__ = _DocDescriptor()
+
def __new__(cls, *args, **kwargs):
return open(*args, **kwargs)