copyright.tex: Add 1995 to copyright message.

lib.tex: add libimp; remove bogus warning about lineii.
libmath.tex: document hypot().
libmd5.tex: rename md5.md5() to md5.new().
libposix.tex: document chown().
libposixfile.tex: openfile() instead of fileopen().
libsocket.tex: document gethostbyaddr().
libtypes.tex: add footnote explaining why readline() keeps the newline.
ref3.tex: correct typos, add back*quotes to index.
ref4.tex: don't use \verb inside footnote.
ref5.tex: explain repr() and str() and add them + back*quotes to index.
ref6.tex: correct typo, don't use \verb in footnote.
ref7.tex: don't use \verb in footnote.
This commit is contained in:
Guido van Rossum 1995-01-04 19:17:34 +00:00
parent e5f8b60429
commit 31cce97374
26 changed files with 134 additions and 40 deletions

View File

@ -1,5 +1,5 @@
Copyright 1991, 1992, 1993, 1994 by Stichting Mathematisch Centrum,
Amsterdam, The Netherlands.
Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
The Netherlands.
\begin{center}
All Rights Reserved

View File

@ -50,6 +50,7 @@ language.
\input{libmods} % Built-in modules
\input{libsys}
\input{libbltin} % really __builtin__
\input{libimp}
\input{libmain} % really __main__
\input{libarray}
\input{libmath}
@ -73,7 +74,7 @@ language.
\input{libgdbm}
\input{libgrp}
\input{libposix}
\input{libposixfile} % XXX this uses lineii which partparse.py doesn't know
\input{libposixfile}
\input{libppath} % really posixpath
\input{libpwd}
\input{libselect}

View File

@ -50,6 +50,7 @@ language.
\input{libmods} % Built-in modules
\input{libsys}
\input{libbltin} % really __builtin__
\input{libimp}
\input{libmain} % really __main__
\input{libarray}
\input{libmath}
@ -73,7 +74,7 @@ language.
\input{libgdbm}
\input{libgrp}
\input{libposix}
\input{libposixfile} % XXX this uses lineii which partparse.py doesn't know
\input{libposixfile}
\input{libppath} % really posixpath
\input{libpwd}
\input{libselect}

View File

@ -44,6 +44,7 @@ They are:
\code{floor(\varvars{x})},
\code{fmod(\varvars{x\, y})},
\code{frexp(\varvars{x})},
\code{hypot(\varvars{x\, y})},
\code{ldexp(\varvars{x\, y})},
\code{log(\varvars{x})},
\code{log10(\varvars{x})},
@ -61,6 +62,9 @@ pattern than their C equivalents: they take a single argument and
return a pair of values, rather than returning their second return
value through an `output parameter' (there is no such thing in Python).
The \code{hypot} function, which is not standard C, is not available
on all platforms.
The module also defines two mathematical constants:
\iftexi
\begin{datadesc}{pi}

View File

@ -15,8 +15,8 @@ example will be helpful:
to obtain the digest of the string \code{'abc'}, use \ldots
\bcode\begin{verbatim}
>>> from md5 import md5
>>> m = md5()
>>> import md5
>>> m = md5.new()
>>> m.update('abc')
>>> m.digest()
'\220\001P\230<\322O\260\326\226?}(\341\177r'
@ -25,16 +25,22 @@ to obtain the digest of the string \code{'abc'}, use \ldots
More condensed:
\bcode\begin{verbatim}
>>> md5('abc').digest()
>>> md5.new('abc').digest()
'\220\001P\230<\322O\260\326\226?}(\341\177r'
\end{verbatim}\ecode
\renewcommand{\indexsubitem}{(in module md5)}
\begin{funcdesc}{md5}{\optional{arg}}
\begin{funcdesc}{new}{\optional{arg}}
Create a new md5-object. If \var{arg} is present, an initial
\code{update} method is called with \var{arg} as argument.
\end{funcdesc}
\begin{funcdesc}{md5}{\optional{arg}}
For backward compatibility reasons, this is an alternative name for the
\code{new} function.
\end{funcdesc}
An md5-object has the following methods:
\renewcommand{\indexsubitem}{(md5 method)}

View File

@ -50,6 +50,12 @@ Change the current working directory to \var{path}.
Change the mode of \var{path} to the numeric \var{mode}.
\end{funcdesc}
\begin{funcdesc}{chown}{path\, uid, gid}
Change the owner and group id of \var{path} to the numeric \var{uid}
and \var{gid}.
(Not on MS-DOS.)
\end{funcdesc}
\begin{funcdesc}{close}{fd}
Close file descriptor \var{fd}.
\end{funcdesc}

View File

@ -38,7 +38,7 @@ The posixfile module defines the following functions:
builtin function.
\end{funcdesc}
\begin{funcdesc}{openfile}{fileobject}
\begin{funcdesc}{fileopen}{fileobject}
Create a new posixfile object with the given standard file object.
The resulting object has the same filename and mode as the original
file object.

View File

@ -79,7 +79,16 @@ is an IP address itself it is returned unchanged.
Return a string containing the hostname of the machine where
the Python interpreter is currently executing. If you want to know the
current machine's IP address, use
\code{socket.gethostbyname( socket.gethostname() )} instead.
\code{socket.gethostbyname(socket.gethostname())} instead.
\end{funcdesc}
\begin{funcdesc}{gethostbyaddr}{ip_address}
Return a triple \code{(hostname, aliaslist, ipaddrlist)} where
\code{hostname} is the primary host name responding to the given
\var{ip_address}, \code{aliaslist} is a (possibly empty) list of
alternative host names for the same address, and \code{ipaddrlist} is
a list of IP addresses for the same interface on the same
host (most likely containing only a single address).
\end{funcdesc}
\begin{funcdesc}{getservbyname}{servicename\, protocolname}

View File

@ -580,7 +580,14 @@ Files have the following methods:
\begin{funcdesc}{readline}{}
Read one entire line from the file. A trailing newline character is
kept in the string (but may be absent when a file ends with an
kept in the string%
\footnote{The advantage of leaving the newline on is that an empty string
can be returned to mean \EOF{} without being ambiguous. Another
advantage is that (in cases where it might matter, e.g. if you
want to make an exact copy of a file while scanning its lines)
you can tell whether the last line of a file ended in a newline
or not (yes this happens!).}
(but may be absent when a file ends with an
incomplete line). An empty string is returned when \EOF{} is hit
immediately. Note: unlike \code{stdio}'s \code{fgets()}, the returned
string contains null characters (\code{'\e 0'}) if they occurred in the

View File

@ -44,6 +44,7 @@ They are:
\code{floor(\varvars{x})},
\code{fmod(\varvars{x\, y})},
\code{frexp(\varvars{x})},
\code{hypot(\varvars{x\, y})},
\code{ldexp(\varvars{x\, y})},
\code{log(\varvars{x})},
\code{log10(\varvars{x})},
@ -61,6 +62,9 @@ pattern than their C equivalents: they take a single argument and
return a pair of values, rather than returning their second return
value through an `output parameter' (there is no such thing in Python).
The \code{hypot} function, which is not standard C, is not available
on all platforms.
The module also defines two mathematical constants:
\iftexi
\begin{datadesc}{pi}

View File

@ -15,8 +15,8 @@ example will be helpful:
to obtain the digest of the string \code{'abc'}, use \ldots
\bcode\begin{verbatim}
>>> from md5 import md5
>>> m = md5()
>>> import md5
>>> m = md5.new()
>>> m.update('abc')
>>> m.digest()
'\220\001P\230<\322O\260\326\226?}(\341\177r'
@ -25,16 +25,22 @@ to obtain the digest of the string \code{'abc'}, use \ldots
More condensed:
\bcode\begin{verbatim}
>>> md5('abc').digest()
>>> md5.new('abc').digest()
'\220\001P\230<\322O\260\326\226?}(\341\177r'
\end{verbatim}\ecode
\renewcommand{\indexsubitem}{(in module md5)}
\begin{funcdesc}{md5}{\optional{arg}}
\begin{funcdesc}{new}{\optional{arg}}
Create a new md5-object. If \var{arg} is present, an initial
\code{update} method is called with \var{arg} as argument.
\end{funcdesc}
\begin{funcdesc}{md5}{\optional{arg}}
For backward compatibility reasons, this is an alternative name for the
\code{new} function.
\end{funcdesc}
An md5-object has the following methods:
\renewcommand{\indexsubitem}{(md5 method)}

View File

@ -50,6 +50,12 @@ Change the current working directory to \var{path}.
Change the mode of \var{path} to the numeric \var{mode}.
\end{funcdesc}
\begin{funcdesc}{chown}{path\, uid, gid}
Change the owner and group id of \var{path} to the numeric \var{uid}
and \var{gid}.
(Not on MS-DOS.)
\end{funcdesc}
\begin{funcdesc}{close}{fd}
Close file descriptor \var{fd}.
\end{funcdesc}

View File

@ -38,7 +38,7 @@ The posixfile module defines the following functions:
builtin function.
\end{funcdesc}
\begin{funcdesc}{openfile}{fileobject}
\begin{funcdesc}{fileopen}{fileobject}
Create a new posixfile object with the given standard file object.
The resulting object has the same filename and mode as the original
file object.

View File

@ -79,7 +79,16 @@ is an IP address itself it is returned unchanged.
Return a string containing the hostname of the machine where
the Python interpreter is currently executing. If you want to know the
current machine's IP address, use
\code{socket.gethostbyname( socket.gethostname() )} instead.
\code{socket.gethostbyname(socket.gethostname())} instead.
\end{funcdesc}
\begin{funcdesc}{gethostbyaddr}{ip_address}
Return a triple \code{(hostname, aliaslist, ipaddrlist)} where
\code{hostname} is the primary host name responding to the given
\var{ip_address}, \code{aliaslist} is a (possibly empty) list of
alternative host names for the same address, and \code{ipaddrlist} is
a list of IP addresses for the same interface on the same
host (most likely containing only a single address).
\end{funcdesc}
\begin{funcdesc}{getservbyname}{servicename\, protocolname}

View File

@ -580,7 +580,14 @@ Files have the following methods:
\begin{funcdesc}{readline}{}
Read one entire line from the file. A trailing newline character is
kept in the string (but may be absent when a file ends with an
kept in the string%
\footnote{The advantage of leaving the newline on is that an empty string
can be returned to mean \EOF{} without being ambiguous. Another
advantage is that (in cases where it might matter, e.g. if you
want to make an exact copy of a file while scanning its lines)
you can tell whether the last line of a file ended in a newline
or not (yes this happens!).}
(but may be absent when a file ends with an
incomplete line). An empty string is returned when \EOF{} is hit
immediately. Note: unlike \code{stdio}'s \code{fgets()}, the returned
string contains null characters (\code{'\e 0'}) if they occurred in the

View File

@ -470,7 +470,7 @@ A file object represents an open file. (It is a wrapper around a C
\verb@open()@ built-in function, and also by \verb@posix.popen()@ and
the \verb@makefile@ method of socket objects. \verb@sys.stdin@,
\verb@sys.stdout@ and \verb@sys.stderr@ are file objects corresponding
the the interpreter's standard input, output and error streams.
to the interpreter's standard input, output and error streams.
See the Python Library Reference for methods of file objects and other
details.
\obindex{file}
@ -498,7 +498,7 @@ but they are mentioned here for completeness.
Code objects represent executable code. The difference between a code
object and a function object is that the function object contains an
explicit reference to the function's context (the module in which it
was defined) which a code object contains no context. There is no way
was defined) while a code object contains no context. There is no way
to execute a bare code object.
\obindex{code}
@ -622,8 +622,12 @@ former decrements the reference count for \code{x} by one, but
\code{x,__del__} is only called when its reference count reaches zero.
\item[\tt __repr__(self)]
Called by the \verb@repr()@ built-in function and by conversions
(reverse quotes) to compute the string representation of an object.
Called by the \verb@repr()@ built-in function and by string conversions
(reverse or backward quotes) to compute the string representation of an object.
\indexii{string}{conversion}
\indexii{reverse}{quotes}
\indexii{backward}{quotes}
\index{back-quotes}
\item[\tt __str__(self)]
Called by the \verb@str()@ built-in function and by the \verb@print@

View File

@ -72,9 +72,9 @@ When a global name is not found in the global name space, it is
searched in the list of ``built-in'' names (which is actually the
global name space of the module \verb@__builtin__@). When a name is not
found at all, the \verb@NameError@ exception is raised.%
\footnote{If the code block contains \verb@exec@ statements or the
construct \verb@from ... import *@, the semantics of names not
explicitly mentioned in a \verb@global@ statement change subtly: name
\footnote{If the code block contains {\tt exec} statements or the
construct {\tt from \ldots import *}, the semantics of names not
explicitly mentioned in a {\tt global} statement change subtly: name
lookup first searches the local name space, then the global one, then
the built-in one.}

View File

@ -187,6 +187,9 @@ value prevails.
\subsection{String conversions}
\indexii{string}{conversion}
\indexii{reverse}{quotes}
\indexii{backward}{quotes}
\index{back-quotes}
A string conversion is a condition list enclosed in reverse (or
backward) quotes:
@ -214,6 +217,13 @@ dictionaries that contain a reference to themselves, directly or
indirectly.)
\obindex{recursive}
The built-in function \verb@repr()@ performs exactly the same
conversion in its argument as enclosing it it reverse quotes does.
The built-in function \verb@str()@ performs a similar but more
user-friendly conversion.
\bifuncindex{repr}
\bifuncindex{str}
\section{Primaries} \label{primaries}
\index{primary}

View File

@ -166,7 +166,7 @@ sequence cannot add new items to a list).
If the primary is a mapping (dictionary) object, the subscript must
have a type compatible with the mapping's key type, and the mapping is
then asked to to create a key/datum pair which maps the subscript to
then asked to create a key/datum pair which maps the subscript to
the assigned object. This can either replace an existing key/value
pair with the same key value, or insert a new key/value pair (if no
key with the same value existed).
@ -369,7 +369,7 @@ continue_stmt: "continue"
\verb@continue@ may only occur syntactically nested in a \verb@for@ or
\verb@while@ loop, but not nested in a function or class definition or
\verb@try@ statement within that loop.\footnote{Except that it may
currently occur within an \verb@except@ clause.}
currently occur within an {\tt except} clause.}
\stindex{for}
\stindex{while}
\indexii{loop}{statement}

View File

@ -299,7 +299,7 @@ default value is substituted. If a parameter has a default value, all
following parameters must also have a default value --- this is a
syntactic restriction that is not expressed by the grammar.%
\footnote{Currently this is not checked; instead,
\verb@def f(a=1,b)@ is interpreted as \verb@def f(a=1,b=None)@.}
{\tt def f(a=1,b)} is interpreted as {\tt def f(a=1,b=None)}.}
\indexiii{default}{parameter}{value}
Function call semantics are described in section \ref{calls}. When a

View File

@ -470,7 +470,7 @@ A file object represents an open file. (It is a wrapper around a C
\verb@open()@ built-in function, and also by \verb@posix.popen()@ and
the \verb@makefile@ method of socket objects. \verb@sys.stdin@,
\verb@sys.stdout@ and \verb@sys.stderr@ are file objects corresponding
the the interpreter's standard input, output and error streams.
to the interpreter's standard input, output and error streams.
See the Python Library Reference for methods of file objects and other
details.
\obindex{file}
@ -498,7 +498,7 @@ but they are mentioned here for completeness.
Code objects represent executable code. The difference between a code
object and a function object is that the function object contains an
explicit reference to the function's context (the module in which it
was defined) which a code object contains no context. There is no way
was defined) while a code object contains no context. There is no way
to execute a bare code object.
\obindex{code}
@ -622,8 +622,12 @@ former decrements the reference count for \code{x} by one, but
\code{x,__del__} is only called when its reference count reaches zero.
\item[\tt __repr__(self)]
Called by the \verb@repr()@ built-in function and by conversions
(reverse quotes) to compute the string representation of an object.
Called by the \verb@repr()@ built-in function and by string conversions
(reverse or backward quotes) to compute the string representation of an object.
\indexii{string}{conversion}
\indexii{reverse}{quotes}
\indexii{backward}{quotes}
\index{back-quotes}
\item[\tt __str__(self)]
Called by the \verb@str()@ built-in function and by the \verb@print@

View File

@ -72,9 +72,9 @@ When a global name is not found in the global name space, it is
searched in the list of ``built-in'' names (which is actually the
global name space of the module \verb@__builtin__@). When a name is not
found at all, the \verb@NameError@ exception is raised.%
\footnote{If the code block contains \verb@exec@ statements or the
construct \verb@from ... import *@, the semantics of names not
explicitly mentioned in a \verb@global@ statement change subtly: name
\footnote{If the code block contains {\tt exec} statements or the
construct {\tt from \ldots import *}, the semantics of names not
explicitly mentioned in a {\tt global} statement change subtly: name
lookup first searches the local name space, then the global one, then
the built-in one.}

View File

@ -187,6 +187,9 @@ value prevails.
\subsection{String conversions}
\indexii{string}{conversion}
\indexii{reverse}{quotes}
\indexii{backward}{quotes}
\index{back-quotes}
A string conversion is a condition list enclosed in reverse (or
backward) quotes:
@ -214,6 +217,13 @@ dictionaries that contain a reference to themselves, directly or
indirectly.)
\obindex{recursive}
The built-in function \verb@repr()@ performs exactly the same
conversion in its argument as enclosing it it reverse quotes does.
The built-in function \verb@str()@ performs a similar but more
user-friendly conversion.
\bifuncindex{repr}
\bifuncindex{str}
\section{Primaries} \label{primaries}
\index{primary}

View File

@ -166,7 +166,7 @@ sequence cannot add new items to a list).
If the primary is a mapping (dictionary) object, the subscript must
have a type compatible with the mapping's key type, and the mapping is
then asked to to create a key/datum pair which maps the subscript to
then asked to create a key/datum pair which maps the subscript to
the assigned object. This can either replace an existing key/value
pair with the same key value, or insert a new key/value pair (if no
key with the same value existed).
@ -369,7 +369,7 @@ continue_stmt: "continue"
\verb@continue@ may only occur syntactically nested in a \verb@for@ or
\verb@while@ loop, but not nested in a function or class definition or
\verb@try@ statement within that loop.\footnote{Except that it may
currently occur within an \verb@except@ clause.}
currently occur within an {\tt except} clause.}
\stindex{for}
\stindex{while}
\indexii{loop}{statement}

View File

@ -299,7 +299,7 @@ default value is substituted. If a parameter has a default value, all
following parameters must also have a default value --- this is a
syntactic restriction that is not expressed by the grammar.%
\footnote{Currently this is not checked; instead,
\verb@def f(a=1,b)@ is interpreted as \verb@def f(a=1,b=None)@.}
{\tt def f(a=1,b)} is interpreted as {\tt def f(a=1,b=None)}.}
\indexiii{default}{parameter}{value}
Function call semantics are described in section \ref{calls}. When a

View File

@ -1,5 +1,5 @@
Copyright 1991, 1992, 1993, 1994 by Stichting Mathematisch Centrum,
Amsterdam, The Netherlands.
Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
The Netherlands.
\begin{center}
All Rights Reserved