cpython/Doc/libuserdict.tex

50 lines
1.7 KiB
TeX
Raw Normal View History

\section{Standard Module \module{UserDict}}
\stmodindex{UserDict}
\label{module-UserDict}
This module defines a class that acts as a wrapper around
dictionary objects. It is a useful base class for
your own dictionary-like classes, which can inherit from
1997-03-27 10:56:18 -04:00
them and override existing methods or add new ones. In this way one
can add new behaviours to dictionaries.
1997-03-27 10:56:18 -04:00
The \module{UserDict} module defines the \class{UserDict} class:
1997-03-27 10:56:18 -04:00
\begin{classdesc}{UserDict}{}
1997-03-27 10:56:18 -04:00
Return a class instance that simulates a dictionary. The instance's
contents are kept in a regular dictionary, which is accessible via the
\member{data} attribute of \class{UserDict} instances.
\end{classdesc}
1997-03-27 10:56:18 -04:00
\begin{memberdesc}{data}
A real dictionary used to store the contents of the \class{UserDict}
class.
\end{memberdesc}
\section{Standard Module \module{UserList}}
\stmodindex{UserList}
\label{module-UserList}
This module defines a class that acts as a wrapper around
list objects. It is a useful base class for
your own 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 lists.
The \module{UserList} module defines the \class{UserList} class:
1997-03-27 10:56:18 -04:00
\begin{classdesc}{UserList}{\optional{list}}
1997-03-27 10:56:18 -04:00
Return a class instance that simulates a list. The instance's
contents are kept in a regular list, which is accessible via the
\member{data} attribute of \class{UserList} instances. The instance's
contents are initially set to a copy of \var{list}, defaulting to the
1997-03-27 10:56:18 -04:00
empty list \code{[]}. \var{list} can be either a regular Python list,
or an instance of \class{UserList} (or a subclass).
\end{classdesc}
\begin{memberdesc}{data}
A real Python list object used to store the contents of the
\class{UserList} class.
\end{memberdesc}