Added descriptor for builtins.open.__doc__

tiran · tiran · commit a33eb06e3b29 · 2007-12-08T17:47:40.000Z
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.
diff --git 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)
 
