]> granicus.if.org Git - python/commitdiff
ConfigParser.optionxform(): Document this since it is available for
authorFred Drake <fdrake@acm.org>
Mon, 19 Feb 2001 22:37:24 +0000 (22:37 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 19 Feb 2001 22:37:24 +0000 (22:37 +0000)
    sub-classes and application code to override.

Doc/lib/libcfgparser.tex

index fc2d1c11b7d94b8f2fb2a8d9b304818520c9a929..65c27ce203e97eea47eb02d707481cecdd0eaeee 100644 (file)
@@ -97,6 +97,7 @@ allowed recursion depth.
                     for application configuration files.}
 \end{seealso}
 
+
 \subsection{ConfigParser Objects \label{ConfigParser-objects}}
 
 \class{ConfigParser} instances have the following methods:
@@ -189,3 +190,12 @@ Remove the specified \var{section} from the configuration.
 If the section in fact existed, return 1.  Otherwise return 0.
 \end{methoddesc}
 
+\begin{methoddesc}{optionxform}{option}
+Transforms the option name \var{option} as found in an input file or
+as passed in by  client code to the form that should be used in the
+internal structures.  The default implementation returns a lower-case
+version of \var{option}; subclasses may override this or client code
+can set an attribute of this name on instances to affect this
+behavior.  Setting this to \function{str()}, for example, would make
+option names case sensitive.
+\end{methoddesc}