diff options
author | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-15 11:11:28 (GMT) |
---|---|---|
committer | Antoine Pitrou <solipsis@pitrou.net> | 2010-09-15 11:11:28 (GMT) |
commit | 11cb961b38550443d287b2b55174e504c2309af2 (patch) | |
tree | 51b2972800e593dde1b5f5154b9b044058a350d7 /Doc/library/mmap.rst | |
parent | 6a11a98b7c8f576d7663182cbd09123eb108a928 (diff) | |
download | cpython-11cb961b38550443d287b2b55174e504c2309af2.zip cpython-11cb961b38550443d287b2b55174e504c2309af2.tar.gz cpython-11cb961b38550443d287b2b55174e504c2309af2.tar.bz2 |
Add cross-references to the glossary entry for file objects.
Diffstat (limited to 'Doc/library/mmap.rst')
-rw-r--r-- | Doc/library/mmap.rst | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst index 779a5e8..128bc90 100644 --- a/Doc/library/mmap.rst +++ b/Doc/library/mmap.rst @@ -5,14 +5,13 @@ :synopsis: Interface to memory-mapped files for Unix and Windows. -Memory-mapped file objects behave like both :class:`bytes` and like file -objects. Unlike normal :class:`bytes` objects, however, these are mutable. -You can use mmap objects in most places where :class:`bytes` are expected; for -example, you can use the :mod:`re` module to search through a memory-mapped file. -Since they're mutable, you can change a single byte by doing ``obj[index] = 97``, -or change a subsequence by assigning to a slice: ``obj[i1:i2] = b'...'``. -You can also read and write data starting at the current file position, and -:meth:`seek` through the file to different positions. +Memory-mapped file objects behave like both :class:`bytearray` and like +:term:`file objects <file object>`. You can use mmap objects in most places +where :class:`bytearray` are expected; for example, you can use the :mod:`re` +module to search through a memory-mapped file. You can also change a single +byte by doing ``obj[index] = 97``, or change a subsequence by assigning to a +slice: ``obj[i1:i2] = b'...'``. You can also read and write data starting at +the current file position, and :meth:`seek` through the file to different positions. A memory-mapped file is created by the :class:`mmap` constructor, which is different on Unix and on Windows. In either case you must provide a file |