Kaydet (Commit) 3bffd289 authored tarafından Andrew M. Kuchling's avatar Andrew M. Kuchling

Mention the os.SEEK_* constants

üst a9b9ae46
...@@ -90,10 +90,10 @@ performance optimizations previously implemented in the ...@@ -90,10 +90,10 @@ performance optimizations previously implemented in the
\begin{methoddesc}[BZ2File]{seek}{offset\optional{, whence}} \begin{methoddesc}[BZ2File]{seek}{offset\optional{, whence}}
Move to new file position. Argument \var{offset} is a byte count. Optional Move to new file position. Argument \var{offset} is a byte count. Optional
argument \var{whence} defaults to \code{0} (offset from start of file, argument \var{whence} defaults to \code{os.SEEK_SET} or \code{0} (offset from start of file;
offset should be \code{>= 0}); other values are \code{1} (move relative to offset should be \code{>= 0}); other values are \code{os.SEEK_CUR} or \code{1} (move relative to
current position, positive or negative), and \code{2} (move relative to end current position; offset can be positive or negative), and \code{os.SEEK_END} or \code{2} (move relative to end
of file, usually negative, although many platforms allow seeking beyond of file; offset is usually negative, although many platforms allow seeking beyond
the end of a file). the end of a file).
Note that seeking of bz2 files is emulated, and depending on the parameters Note that seeking of bz2 files is emulated, and depending on the parameters
......
...@@ -140,8 +140,9 @@ Memory-mapped file objects support the following methods: ...@@ -140,8 +140,9 @@ Memory-mapped file objects support the following methods:
\begin{methoddesc}{seek}{pos\optional{, whence}} \begin{methoddesc}{seek}{pos\optional{, whence}}
Set the file's current position. \var{whence} argument is optional Set the file's current position. \var{whence} argument is optional
and defaults to \code{0} (absolute file positioning); other values and defaults to \code{os.SEEK_SET} or \code{0} (absolute file
are \code{1} (seek relative to the current position) and \code{2} positioning); other values are \code{os.SEEK_CUR} or \code{1} (seek
relative to the current position) and \code{os.SEEK_END} or \code{2}
(seek relative to the file's end). (seek relative to the file's end).
\end{methoddesc} \end{methoddesc}
......
...@@ -1678,9 +1678,12 @@ flush the read-ahead buffer. ...@@ -1678,9 +1678,12 @@ flush the read-ahead buffer.
\begin{methoddesc}[file]{seek}{offset\optional{, whence}} \begin{methoddesc}[file]{seek}{offset\optional{, whence}}
Set the file's current position, like \code{stdio}'s \cfunction{fseek()}. Set the file's current position, like \code{stdio}'s \cfunction{fseek()}.
The \var{whence} argument is optional and defaults to \code{0} The \var{whence} argument is optional and defaults to
(absolute file positioning); other values are \code{1} (seek \code{os.SEEK_SET} or \code{0}
relative to the current position) and \code{2} (seek relative to the (absolute file positioning); other values are \code{os.SEEK_CUR} or \code{1}
(seek
relative to the current position) and \code{os.SEEK_END} or \code{2}
(seek relative to the
file's end). There is no return value. Note that if the file is file's end). There is no return value. Note that if the file is
opened for appending (mode \code{'a'} or \code{'a+'}), any opened for appending (mode \code{'a'} or \code{'a+'}), any
\method{seek()} operations will be undone at the next write. If the \method{seek()} operations will be undone at the next write. If the
......
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