]> granicus.if.org Git - python/commitdiff
Add a glossary entry for file objects.
authorAntoine Pitrou <solipsis@pitrou.net>
Wed, 15 Sep 2010 09:58:26 +0000 (09:58 +0000)
committerAntoine Pitrou <solipsis@pitrou.net>
Wed, 15 Sep 2010 09:58:26 +0000 (09:58 +0000)
Doc/glossary.rst
Doc/library/socket.rst
Doc/reference/datamodel.rst

index 8a36939268efa489aa606867648f96dce2fc9dec..5374e731fe687840fd18d6fb735ebd119b2462ea 100644 (file)
@@ -184,6 +184,23 @@ Glossary
       A module written in C or C++, using Python's C API to interact with the core and
       with user code.
 
+   file object
+      An object exposing a file-oriented API (with methods such as
+      :meth:`read()` or :meth:`write()`) to an underlying resource.
+      Depending on the way it was created, a file object can mediate access
+      to a real on-disk file or to another other type of storage or
+      communication device (for example standard input/output, in-memory
+      buffers, sockets, pipes, etc.).  File objects are also called
+      :dfn:`file-like objects` or :dfn:`streams`.
+
+      There are actually three categories of file objects: raw binary
+      files, buffered binary files and text files.  Their interfaces are
+      defined in the :mod:`io` module.  The canonical way to create a
+      file object is by using the :func:`open` function.
+
+   file-like object
+      A synonym for :term:`file object`.
+
    finder
       An object that tries to find the :term:`loader` for a module. It must
       implement a method named :meth:`find_module`. See :pep:`302` for
index e3c9723f4105daed5dd78a91998ebd6bfc68c654..c061b041e9c5827d31badec7cc119397ed6e7666 100644 (file)
@@ -617,7 +617,7 @@ correspond to Unix system calls applicable to sockets.
 
    .. index:: single: I/O control; buffering
 
-   Return a :dfn:`file object` associated with the socket.  The exact
+   Return a :term:`file object` associated with the socket.  The exact
    returned type depends on the arguments given to :meth:`makefile`.  These
    arguments are interpreted the same way as by the built-in :func:`open`
    function.
index fc64b84187aa488dd7b17317b3250f884ef08217..ac94ef2ec12a70659b5f7548b69e87bb7a5f9930 100644 (file)
@@ -781,9 +781,9 @@ I/O objects (also known as file objects)
       single: stdout (in module sys)
       single: stderr (in module sys)
 
-   A file object represents an open file.  Various shortcuts are available
-   to create file objects: the :func:`open` built-in function, and also
-   :func:`os.popen`, :func:`os.fdopen`, and the :meth:`makefile` method
+   A :term:`file object` represents an open file.  Various shortcuts are
+   available to create file objects: the :func:`open` built-in function, and
+   also :func:`os.popen`, :func:`os.fdopen`, and the :meth:`makefile` method
    of socket objects (and perhaps by other functions or methods provided
    by extension modules).