% $Id: ldap-cidict.tex,v 1.2 2007/03/27 22:10:17 stroeder Exp $

\section{\module{ldap.cidict} ---
  LDAP filter handling }

\declaremodule{standard}{ldap.cidict}

% Author of the module code;
\moduleauthor{Michael Str\"oder}{python-ldap-dev@lists.sourceforge.net}
% Author of the documentation,
\sectionauthor{Michael Str\"oder}{michael@stroeder.com}
\sectionauthor{James Andrewartha}{trs80@ucc.asn.au}

\modulesynopsis{Case insensitive dictionary.}

The \module{ldap.cidict} module is a convenience wrapper for 
dictionaries returned from LDAP servers containing attribute names of variable
case. It defines the following class:
\begin{classdesc}{cidict}{\optional{default=\constant{None}}}

This module is a subclass of \class{UserDict} and provides
a case-insensitive but case-respecting dictionary.
\end{classdesc}

The \module{ldap.cidict} module defines the following functions:

\begin{funcdesc}{strlist_minus}{a,b} % -> list

Returns a list of all items in \var{a} which are not in \var{b} (\var{a} - \var{b}).
\var{a},\var{b} are supposed to be lists of case-insensitive strings.

\end{funcdesc}

\begin{funcdesc}{strlist_intersection}{a,b} % -> list

Returns the intersection of two lists of case-insensitive strings \var{a},\var{b}.

\end{funcdesc}

\begin{funcdesc}{strlist_union}{a,b} % -> list

Returns the union of two lists of case-insensitive strings \var{a},\var{b}.

\end{funcdesc}
