annotate Doc/lib/libuserdict.tex @ 5817:48b94de85bf3 legacy-trunk

Extensive changes by AMK.
author Guido van Rossum <guido@python.org>
date Thu, 17 Jul 1997 16:29:42 +0000
parents e1f613322b23
children ab4d604822d0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5220
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 \section{Standard Modules \sectcode{UserDict} and \sectcode{UserList}}
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 Each of these modules defines a class that acts as a wrapper around
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 either dictionary or list objects. They're useful base classes for
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 your own dictionary-like or list-like classes, which can inherit from
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 them and override existing methods or add new ones. In this way one
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 can add new behaviours to dictionaries or lists.
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
7
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 \renewcommand{\indexsubitem}{(in module UserDict)}
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 The \code{UserDict} module defines the \code{UserDict} class:
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
10
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 \begin{funcdesc}{UserDict}{}
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 Return a class instance that simulates a dictionary. The instance's
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 contents are kept in a regular dictionary, which is accessible via the
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 \code{data} attribute of \code{UserDict} instances.
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 \end{funcdesc}
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
16
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 \renewcommand{\indexsubitem}{(in module UserList)}
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 The \code{UserList} module defines the \code{UserList} class:
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
19
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 \begin{funcdesc}{UserList}{\optional{list}}
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 Return a class instance that simulates a list. The instance's
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
22 contents are kept in a regular list, which is accessible via the
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 \code{data} attribute of \code{UserList} instances. The instance's
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 contents are initially set to c copy of \var{list}, defaulting to the
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 empty list \code{[]}. \var{list} can be either a regular Python list,
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 or an instance of \code{UserList} (or a subclass).
e1f613322b23 Added docs for UserDict,UserList
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 \end{funcdesc}