From 7f3b0421deb42d5dbf049f734e6d49ff816608a3 Mon Sep 17 00:00:00 2001 From: Guido van Rossum Date: Thu, 27 Mar 1997 14:56:18 +0000 Subject: Added docs for UserDict,UserList --- Doc/Makefile | 3 ++- Doc/lib.tex | 1 + Doc/lib/lib.tex | 1 + Doc/lib/libpython.tex | 3 +++ Doc/lib/libuserdict.tex | 27 +++++++++++++++++++++++++++ Doc/libpython.tex | 3 +++ Doc/libuserdict.tex | 27 +++++++++++++++++++++++++++ 7 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 Doc/lib/libuserdict.tex create mode 100644 Doc/libuserdict.tex diff --git a/Doc/Makefile b/Doc/Makefile index a0eebc6..c556213 100644 --- 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 index c6ca392..c6fd107 100644 --- a/Doc/lib.tex +++ b/Doc/lib.tex @@ -77,6 +77,7 @@ to Python and how to embed it in other applications. \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 index c6ca392..c6fd107 100644 --- a/Doc/lib/lib.tex +++ b/Doc/lib/lib.tex @@ -77,6 +77,7 @@ to Python and how to embed it in other applications. \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 index 6b7195a..5b3e7a9 100644 --- a/Doc/lib/libpython.tex +++ b/Doc/lib/libpython.tex @@ -12,6 +12,9 @@ environment. Here's an overview: \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 new file mode 100644 index 0000000..e47babd --- /dev/null +++ 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 index 6b7195a..5b3e7a9 100644 --- a/Doc/libpython.tex +++ b/Doc/libpython.tex @@ -12,6 +12,9 @@ environment. Here's an overview: \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 new file mode 100644 index 0000000..e47babd --- /dev/null +++ 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} -- cgit v0.12