summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-02-19 22:37:24 (GMT)
committerFred Drake <fdrake@acm.org>2001-02-19 22:37:24 (GMT)
commit5b0705d26647fd72dd1be045faef4c0fab3ca3b0 (patch)
tree819cfcbf3a7ce1a76f494009bae8419eba5518f1
parentffd93282398c68920fdbf60cbf52ac175cd916fa (diff)
downloadcpython-5b0705d26647fd72dd1be045faef4c0fab3ca3b0.zip
cpython-5b0705d26647fd72dd1be045faef4c0fab3ca3b0.tar.gz
cpython-5b0705d26647fd72dd1be045faef4c0fab3ca3b0.tar.bz2
ConfigParser.optionxform(): Document this since it is available for
sub-classes and application code to override.
-rw-r--r--Doc/lib/libcfgparser.tex10
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex
index fc2d1c1..65c27ce 100644
--- a/Doc/lib/libcfgparser.tex
+++ b/Doc/lib/libcfgparser.tex
@@ -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}