Added docs for UserDict,UserList

gvanrossum · gvanrossum · commit 7f3b0421deb4 · 1997-03-27T14:56:18.000Z
diff --git a/Doc/Makefile b/Doc/Makefile
@@ -113,7 +113,8 @@ LIBFILES = lib.tex \
     libxdrlib.tex libimghdr.tex \
     librestricted.tex librexec.tex libbastion.tex \
     libformatter.tex liboperator.tex libsoundex.tex libresource.tex \
-    libstat.tex libstrio.tex libundoc.tex libmailcap.tex libglob.tex
+    libstat.tex libstrio.tex libundoc.tex libmailcap.tex libglob.tex \
+    libuser.tex
 
 # Library document
 lib.dvi: $(LIBFILES)
diff --git a/Doc/lib.tex b/Doc/lib.tex
@@ -77,6 +77,7 @@
 \input{libpython}		% Python Services
 \input{libsys}
 \input{libtypes2}		% types is already taken :-(
+\input{libuser}
 \input{liboperator}
 \input{libtraceback}
 \input{libpickle}
diff --git a/Doc/lib/lib.tex b/Doc/lib/lib.tex
@@ -77,6 +77,7 @@
 \input{libpython}		% Python Services
 \input{libsys}
 \input{libtypes2}		% types is already taken :-(
+\input{libuser}
 \input{liboperator}
 \input{libtraceback}
 \input{libpickle}
diff --git a/Doc/lib/libpython.tex b/Doc/lib/libpython.tex
@@ -12,6 +12,9 @@ \chapter{Python Services}
 \item[types]
 --- Names for all built-in types.
 
+\item[UserDict, UserList]
+--- Class wrappers for dictionary and list objects.
+
 \item[traceback]
 --- Print or retrieve a stack traceback.
 
diff --git a/Doc/lib/libuserdict.tex b/Doc/lib/libuserdict.tex
@@ -0,0 +1,27 @@
+\section{Standard Modules \sectcode{UserDict} and \sectcode{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}
+
+\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 c 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}
diff --git a/Doc/libpython.tex b/Doc/libpython.tex
@@ -12,6 +12,9 @@ \chapter{Python Services}
 \item[types]
 --- Names for all built-in types.
 
+\item[UserDict, UserList]
+--- Class wrappers for dictionary and list objects.
+
 \item[traceback]
 --- Print or retrieve a stack traceback.
 
diff --git a/Doc/libuserdict.tex b/Doc/libuserdict.tex
@@ -0,0 +1,27 @@
+\section{Standard Modules \sectcode{UserDict} and \sectcode{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}
+
+\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 c 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}
