mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 10:19:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

SF bug #997050: Document, test, & check for non-string values in ConfigParser. Moved the new string-only restriction added in rev. 1.65 to the SafeConfigParser class, leaving existing ConfigParser & RawConfigParser behavior alone, and documented the conditions under which non-string values work.

Browse source
This commit is contained in:
David Goodger 2004-10-03 15:55:09 +00:00
parent 68a1abdade
commit 1cbf206d32
4 changed files with 78 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

26
Doc/lib/libcfgparser.tex
View file

@ -238,10 +238,12 @@ option in the given \var{section}.
\end{methoddesc}
\begin{methoddesc}{set}{section, option, value}
If the given section exists, set the given option to the specified value;
otherwise raise \exception{NoSectionError}. \var{value} must be a
string (\class{str} or \class{unicode}); if not, \exception{TypeError}
is raised.
If the given section exists, set the given option to the specified
value; otherwise raise \exception{NoSectionError}. While it is
possible to use \class{RawConfigParser} (or \class{ConfigParser} with
\var{raw} parameters set to true) for \emph{internal} storage of
non-string values, full functionality (including interpolation and
output to files) can only be achieved using string values.
\versionadded{1.6}
\end{methoddesc}
@ -281,8 +283,6 @@ option names case sensitive.
The \class{ConfigParser} class extends some methods of the
\class{RawConfigParser} interface, adding some optional arguments.
The \class{SafeConfigParser} class implements the same extended
interface.
\begin{methoddesc}{get}{section, option\optional{, raw\optional{, vars}}}
Get an \var{option} value for the named \var{section}. All the
@ -297,3 +297,17 @@ option in the given \var{section}. Optional arguments have the
same meaning as for the \method{get()} method.
\versionadded{2.3}
\end{methoddesc}
\subsection{SafeConfigParser Objects \label{SafeConfigParser-objects}}
The \class{SafeConfigParser} class implements the same extended
interface as \class{ConfigParser}, with the following addition:
\begin{methoddesc}{set}{section, option, value}
If the given section exists, set the given option to the specified
value; otherwise raise \exception{NoSectionError}. \var{value} must
be a string (\class{str} or \class{unicode}); if not,
\exception{TypeError} is raised.
\versionadded{2.4}
\end{methoddesc}