mirror of https://github.com/python/cpython.git
Remove obsolete \setindexsubitem macro.
Logical markup, methoddesc, etc.
This commit is contained in:
parent
61f45c7cb5
commit
81acc2e988
|
@ -1,18 +1,20 @@
|
||||||
\section{Built-in Module \sectcode{md5}}
|
\section{Built-in Module \module{md5}}
|
||||||
\label{module-md5}
|
\label{module-md5}
|
||||||
\bimodindex{md5}
|
\bimodindex{md5}
|
||||||
|
|
||||||
This module implements the interface to RSA's MD5 message digest
|
This module implements the interface to RSA's MD5 message digest
|
||||||
|
\index{message digest, MD5}
|
||||||
algorithm (see also Internet \rfc{1321}). Its use is quite
|
algorithm (see also Internet \rfc{1321}). Its use is quite
|
||||||
straightforward:\ use the \code{md5.new()} to create an md5 object.
|
straightforward:\ use the \function{new()} to create an md5 object.
|
||||||
You can now feed this object with arbitrary strings using the
|
You can now feed this object with arbitrary strings using the
|
||||||
\code{update()} method, and at any point you can ask it for the
|
\method{update()} method, and at any point you can ask it for the
|
||||||
\dfn{digest} (a strong kind of 128-bit checksum,
|
\dfn{digest} (a strong kind of 128-bit checksum,
|
||||||
a.k.a. ``fingerprint'') of the contatenation of the strings fed to it
|
a.k.a. ``fingerprint'') of the contatenation of the strings fed to it
|
||||||
so far using the \code{digest()} method.
|
so far using the \method{digest()} method.
|
||||||
|
\index{checksum!MD5}
|
||||||
|
|
||||||
For example, to obtain the digest of the string {\tt"Nobody inspects
|
For example, to obtain the digest of the string \code{'Nobody inspects
|
||||||
the spammish repetition"}:
|
the spammish repetition'}:
|
||||||
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
>>> import md5
|
>>> import md5
|
||||||
|
@ -22,15 +24,13 @@ the spammish repetition"}:
|
||||||
>>> m.digest()
|
>>> m.digest()
|
||||||
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
%
|
|
||||||
More condensed:
|
More condensed:
|
||||||
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
>>> md5.new("Nobody inspects the spammish repetition").digest()
|
>>> md5.new("Nobody inspects the spammish repetition").digest()
|
||||||
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
%
|
|
||||||
\setindexsubitem{(in module md5)}
|
|
||||||
|
|
||||||
\begin{funcdesc}{new}{\optional{arg}}
|
\begin{funcdesc}{new}{\optional{arg}}
|
||||||
Return a new md5 object. If \var{arg} is present, the method call
|
Return a new md5 object. If \var{arg} is present, the method call
|
||||||
|
@ -39,27 +39,26 @@ Return a new md5 object. If \var{arg} is present, the method call
|
||||||
|
|
||||||
\begin{funcdesc}{md5}{\optional{arg}}
|
\begin{funcdesc}{md5}{\optional{arg}}
|
||||||
For backward compatibility reasons, this is an alternative name for the
|
For backward compatibility reasons, this is an alternative name for the
|
||||||
\code{new()} function.
|
\function{new()} function.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
An md5 object has the following methods:
|
An md5 object has the following methods:
|
||||||
|
|
||||||
\setindexsubitem{(md5 method)}
|
\begin{methoddesc}[md5]{update}{arg}
|
||||||
\begin{funcdesc}{update}{arg}
|
|
||||||
Update the md5 object with the string \var{arg}. Repeated calls are
|
Update the md5 object with the string \var{arg}. Repeated calls are
|
||||||
equivalent to a single call with the concatenation of all the
|
equivalent to a single call with the concatenation of all the
|
||||||
arguments, i.e.\ \code{m.update(a); m.update(b)} is equivalent to
|
arguments, i.e.\ \code{m.update(a); m.update(b)} is equivalent to
|
||||||
\code{m.update(a+b)}.
|
\code{m.update(a+b)}.
|
||||||
\end{funcdesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{funcdesc}{digest}{}
|
\begin{methoddesc}[md5]{digest}{}
|
||||||
Return the digest of the strings passed to the \code{update()}
|
Return the digest of the strings passed to the \method{update()}
|
||||||
method so far. This is an 16-byte string which may contain
|
method so far. This is an 16-byte string which may contain
|
||||||
non-\ASCII{} characters, including null bytes.
|
non-\ASCII{} characters, including null bytes.
|
||||||
\end{funcdesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{funcdesc}{copy}{}
|
\begin{methoddesc}[md5]{copy}{}
|
||||||
Return a copy (``clone'') of the md5 object. This can be used to
|
Return a copy (``clone'') of the md5 object. This can be used to
|
||||||
efficiently compute the digests of strings that share a common initial
|
efficiently compute the digests of strings that share a common initial
|
||||||
substring.
|
substring.
|
||||||
\end{funcdesc}
|
\end{methoddesc}
|
||||||
|
|
|
@ -1,18 +1,20 @@
|
||||||
\section{Built-in Module \sectcode{md5}}
|
\section{Built-in Module \module{md5}}
|
||||||
\label{module-md5}
|
\label{module-md5}
|
||||||
\bimodindex{md5}
|
\bimodindex{md5}
|
||||||
|
|
||||||
This module implements the interface to RSA's MD5 message digest
|
This module implements the interface to RSA's MD5 message digest
|
||||||
|
\index{message digest, MD5}
|
||||||
algorithm (see also Internet \rfc{1321}). Its use is quite
|
algorithm (see also Internet \rfc{1321}). Its use is quite
|
||||||
straightforward:\ use the \code{md5.new()} to create an md5 object.
|
straightforward:\ use the \function{new()} to create an md5 object.
|
||||||
You can now feed this object with arbitrary strings using the
|
You can now feed this object with arbitrary strings using the
|
||||||
\code{update()} method, and at any point you can ask it for the
|
\method{update()} method, and at any point you can ask it for the
|
||||||
\dfn{digest} (a strong kind of 128-bit checksum,
|
\dfn{digest} (a strong kind of 128-bit checksum,
|
||||||
a.k.a. ``fingerprint'') of the contatenation of the strings fed to it
|
a.k.a. ``fingerprint'') of the contatenation of the strings fed to it
|
||||||
so far using the \code{digest()} method.
|
so far using the \method{digest()} method.
|
||||||
|
\index{checksum!MD5}
|
||||||
|
|
||||||
For example, to obtain the digest of the string {\tt"Nobody inspects
|
For example, to obtain the digest of the string \code{'Nobody inspects
|
||||||
the spammish repetition"}:
|
the spammish repetition'}:
|
||||||
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
>>> import md5
|
>>> import md5
|
||||||
|
@ -22,15 +24,13 @@ the spammish repetition"}:
|
||||||
>>> m.digest()
|
>>> m.digest()
|
||||||
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
%
|
|
||||||
More condensed:
|
More condensed:
|
||||||
|
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
>>> md5.new("Nobody inspects the spammish repetition").digest()
|
>>> md5.new("Nobody inspects the spammish repetition").digest()
|
||||||
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
'\273d\234\203\335\036\245\311\331\336\311\241\215\360\377\351'
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
%
|
|
||||||
\setindexsubitem{(in module md5)}
|
|
||||||
|
|
||||||
\begin{funcdesc}{new}{\optional{arg}}
|
\begin{funcdesc}{new}{\optional{arg}}
|
||||||
Return a new md5 object. If \var{arg} is present, the method call
|
Return a new md5 object. If \var{arg} is present, the method call
|
||||||
|
@ -39,27 +39,26 @@ Return a new md5 object. If \var{arg} is present, the method call
|
||||||
|
|
||||||
\begin{funcdesc}{md5}{\optional{arg}}
|
\begin{funcdesc}{md5}{\optional{arg}}
|
||||||
For backward compatibility reasons, this is an alternative name for the
|
For backward compatibility reasons, this is an alternative name for the
|
||||||
\code{new()} function.
|
\function{new()} function.
|
||||||
\end{funcdesc}
|
\end{funcdesc}
|
||||||
|
|
||||||
An md5 object has the following methods:
|
An md5 object has the following methods:
|
||||||
|
|
||||||
\setindexsubitem{(md5 method)}
|
\begin{methoddesc}[md5]{update}{arg}
|
||||||
\begin{funcdesc}{update}{arg}
|
|
||||||
Update the md5 object with the string \var{arg}. Repeated calls are
|
Update the md5 object with the string \var{arg}. Repeated calls are
|
||||||
equivalent to a single call with the concatenation of all the
|
equivalent to a single call with the concatenation of all the
|
||||||
arguments, i.e.\ \code{m.update(a); m.update(b)} is equivalent to
|
arguments, i.e.\ \code{m.update(a); m.update(b)} is equivalent to
|
||||||
\code{m.update(a+b)}.
|
\code{m.update(a+b)}.
|
||||||
\end{funcdesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{funcdesc}{digest}{}
|
\begin{methoddesc}[md5]{digest}{}
|
||||||
Return the digest of the strings passed to the \code{update()}
|
Return the digest of the strings passed to the \method{update()}
|
||||||
method so far. This is an 16-byte string which may contain
|
method so far. This is an 16-byte string which may contain
|
||||||
non-\ASCII{} characters, including null bytes.
|
non-\ASCII{} characters, including null bytes.
|
||||||
\end{funcdesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{funcdesc}{copy}{}
|
\begin{methoddesc}[md5]{copy}{}
|
||||||
Return a copy (``clone'') of the md5 object. This can be used to
|
Return a copy (``clone'') of the md5 object. This can be used to
|
||||||
efficiently compute the digests of strings that share a common initial
|
efficiently compute the digests of strings that share a common initial
|
||||||
substring.
|
substring.
|
||||||
\end{funcdesc}
|
\end{methoddesc}
|
||||||
|
|
Loading…
Reference in New Issue