Commit 70781f54 authored by Antoine Pitrou's avatar Antoine Pitrou

Add a glossary entry for file objects.

parent 55bfaa3b
...@@ -184,6 +184,23 @@ Glossary ...@@ -184,6 +184,23 @@ Glossary
A module written in C or C++, using Python's C API to interact with the core and A module written in C or C++, using Python's C API to interact with the core and
with user code. 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 finder
An object that tries to find the :term:`loader` for a module. It must 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 implement a method named :meth:`find_module`. See :pep:`302` for
......
...@@ -617,7 +617,7 @@ correspond to Unix system calls applicable to sockets. ...@@ -617,7 +617,7 @@ correspond to Unix system calls applicable to sockets.
.. index:: single: I/O control; buffering .. 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 returned type depends on the arguments given to :meth:`makefile`. These
arguments are interpreted the same way as by the built-in :func:`open` arguments are interpreted the same way as by the built-in :func:`open`
function. function.
......
...@@ -781,9 +781,9 @@ I/O objects (also known as file objects) ...@@ -781,9 +781,9 @@ I/O objects (also known as file objects)
single: stdout (in module sys) single: stdout (in module sys)
single: stderr (in module sys) single: stderr (in module sys)
A file object represents an open file. Various shortcuts are available A :term:`file object` represents an open file. Various shortcuts are
to create file objects: the :func:`open` built-in function, and also available to create file objects: the :func:`open` built-in function, and
:func:`os.popen`, :func:`os.fdopen`, and the :meth:`makefile` method also :func:`os.popen`, :func:`os.fdopen`, and the :meth:`makefile` method
of socket objects (and perhaps by other functions or methods provided of socket objects (and perhaps by other functions or methods provided
by extension modules). by extension modules).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment