summaryrefslogtreecommitdiffstats
path: root/Doc/libuserdict.tex
blob: 099334ea7b3fad29df0dea878e28da22283bf3d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
\section{Standard Modules \sectcode{UserDict} and \sectcode{UserList}}
\nodename{UserDict and UserList}
\stmodindex{UserDict}
\stmodindex{UserList}
\label{module-UserDict}
\label{module-UserList}

Each of these modules defines a class that acts as a wrapper around
either dictionary or list objects.  They're useful base classes for
your own dictionary-like or list-like classes, which can inherit from
them and override existing methods or add new ones.  In this way one
can add new behaviours to dictionaries or lists.

\renewcommand{\indexsubitem}{(in module UserDict)}
The \code{UserDict} module defines the \code{UserDict} class:

\begin{funcdesc}{UserDict}{}
Return a class instance that simulates a dictionary.  The instance's
contents are kept in a regular dictionary, which is accessible via the
\code{data} attribute of \code{UserDict} instances.
\end{funcdesc}

\stmodindex{UserList}
\renewcommand{\indexsubitem}{(in module UserList)}
The \code{UserList} module defines the \code{UserList} class:

\begin{funcdesc}{UserList}{\optional{list}}
Return a class instance that simulates a list.  The instance's
contents are kept in a regular list, which is accessible via the
\code{data} attribute of \code{UserList} instances.  The instance's
contents are initially set to a copy of \var{list}, defaulting to the
empty list \code{[]}.  \var{list} can be either a regular Python list,
or an instance of \code{UserList} (or a subclass).
\end{funcdesc}