blob: 1bfdac899ccce262441f066773c869c538553632 [file] [log] [blame]
Guido van Rossum3d209861997-12-09 16:10:31 +00001"""Configuration file parser.
2
Georg Brandl96a60ae2010-07-28 13:13:46 +00003A configuration file consists of sections, lead by a "[section]" header,
Guido van Rossum3d209861997-12-09 16:10:31 +00004and followed by "name: value" entries, with continuations and such in
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00005the style of RFC 822.
Guido van Rossum3d209861997-12-09 16:10:31 +00006
Guido van Rossum3d209861997-12-09 16:10:31 +00007Intrinsic defaults can be specified by passing them into the
Łukasz Langa7f64c8a2010-12-16 01:16:22 +00008ConfigParser constructor as a dictionary.
Guido van Rossum3d209861997-12-09 16:10:31 +00009
10class:
11
Łukasz Langa7f64c8a2010-12-16 01:16:22 +000012ConfigParser -- responsible for parsing a list of
Łukasz Langab6a6f5f2010-12-03 16:28:00 +000013 configuration files, and managing the parsed database.
Guido van Rossum3d209861997-12-09 16:10:31 +000014
15 methods:
16
Fred Drakecc645b92010-09-04 04:35:34 +000017 __init__(defaults=None, dict_type=_default_dict, allow_no_value=False,
Łukasz Langab25a7912010-12-17 01:32:29 +000018 delimiters=('=', ':'), comment_prefixes=('#', ';'),
19 inline_comment_prefixes=None, strict=True,
20 empty_lines_in_values=True):
Georg Brandl96a60ae2010-07-28 13:13:46 +000021 Create the parser. When `defaults' is given, it is initialized into the
22 dictionary or intrinsic defaults. The keys must be strings, the values
Łukasz Langa5c863392010-11-21 13:41:35 +000023 must be appropriate for %()s string interpolation.
Georg Brandl96a60ae2010-07-28 13:13:46 +000024
25 When `dict_type' is given, it will be used to create the dictionary
26 objects for the list of sections, for the options within a section, and
27 for the default values.
28
29 When `delimiters' is given, it will be used as the set of substrings
30 that divide keys from values.
31
32 When `comment_prefixes' is given, it will be used as the set of
Łukasz Langab25a7912010-12-17 01:32:29 +000033 substrings that prefix comments in empty lines. Comments can be
34 indented.
35
36 When `inline_comment_prefixes' is given, it will be used as the set of
37 substrings that prefix comments in non-empty lines.
Georg Brandl96a60ae2010-07-28 13:13:46 +000038
Fred Drakea4923622010-08-09 12:52:45 +000039 When `strict` is True, the parser won't allow for any section or option
40 duplicates while reading from a single source (file, string or
Łukasz Langab25a7912010-12-17 01:32:29 +000041 dictionary). Default is True.
Fred Drakea4923622010-08-09 12:52:45 +000042
Georg Brandl96a60ae2010-07-28 13:13:46 +000043 When `empty_lines_in_values' is False (default: True), each empty line
44 marks the end of an option. Otherwise, internal empty lines of
45 a multiline option are kept as part of the value.
46
47 When `allow_no_value' is True (default: False), options without
48 values are accepted; the value presented for these is None.
Guido van Rossum3d209861997-12-09 16:10:31 +000049
Barry Warsawf09f6a51999-01-26 22:01:37 +000050 sections()
Georg Brandl96a60ae2010-07-28 13:13:46 +000051 Return all the configuration section names, sans DEFAULT.
Guido van Rossum3d209861997-12-09 16:10:31 +000052
Guido van Rossuma5a24b71999-10-04 19:58:22 +000053 has_section(section)
Georg Brandl96a60ae2010-07-28 13:13:46 +000054 Return whether the given section exists.
Guido van Rossuma5a24b71999-10-04 19:58:22 +000055
Eric S. Raymond649685a2000-07-14 14:28:22 +000056 has_option(section, option)
Georg Brandl96a60ae2010-07-28 13:13:46 +000057 Return whether the given option exists in the given section.
Eric S. Raymond649685a2000-07-14 14:28:22 +000058
Barry Warsawf09f6a51999-01-26 22:01:37 +000059 options(section)
Georg Brandl96a60ae2010-07-28 13:13:46 +000060 Return list of configuration options for the named section.
Guido van Rossum3d209861997-12-09 16:10:31 +000061
Georg Brandl8dcaa732010-07-29 12:17:40 +000062 read(filenames, encoding=None)
Georg Brandl96a60ae2010-07-28 13:13:46 +000063 Read and parse the list of named configuration files, given by
Guido van Rossum6a8d84b1999-10-04 18:57:27 +000064 name. A single filename is also allowed. Non-existing files
Fred Drake82903142004-05-18 04:24:02 +000065 are ignored. Return list of successfully read files.
Guido van Rossum6a8d84b1999-10-04 18:57:27 +000066
Fred Drakea4923622010-08-09 12:52:45 +000067 read_file(f, filename=None)
Georg Brandl96a60ae2010-07-28 13:13:46 +000068 Read and parse one configuration file, given as a file object.
Fred Drakea4923622010-08-09 12:52:45 +000069 The filename defaults to f.name; it is only used in error
70 messages (if f has no `name' attribute, the string `<???>' is used).
71
72 read_string(string)
73 Read configuration from a given string.
74
75 read_dict(dictionary)
76 Read configuration from a dictionary. Keys are section names,
77 values are dictionaries with keys and values that should be present
78 in the section. If the used dictionary type preserves order, sections
Fred Drakecc645b92010-09-04 04:35:34 +000079 and their keys will be added in order. Values are automatically
80 converted to strings.
Guido van Rossum3d209861997-12-09 16:10:31 +000081
Łukasz Langa26d513c2010-11-10 18:57:39 +000082 get(section, option, raw=False, vars=None, fallback=_UNSET)
Georg Brandl96a60ae2010-07-28 13:13:46 +000083 Return a string value for the named option. All % interpolations are
Barry Warsawf09f6a51999-01-26 22:01:37 +000084 expanded in the return values, based on the defaults passed into the
85 constructor and the DEFAULT section. Additional substitutions may be
86 provided using the `vars' argument, which must be a dictionary whose
Fred Drakecc645b92010-09-04 04:35:34 +000087 contents override any pre-existing defaults. If `option' is a key in
88 `vars', the value from `vars' is used.
Guido van Rossum3d209861997-12-09 16:10:31 +000089
Łukasz Langa26d513c2010-11-10 18:57:39 +000090 getint(section, options, raw=False, vars=None, fallback=_UNSET)
Georg Brandl96a60ae2010-07-28 13:13:46 +000091 Like get(), but convert value to an integer.
Guido van Rossum3d209861997-12-09 16:10:31 +000092
Łukasz Langa26d513c2010-11-10 18:57:39 +000093 getfloat(section, options, raw=False, vars=None, fallback=_UNSET)
Georg Brandl96a60ae2010-07-28 13:13:46 +000094 Like get(), but convert value to a float.
Guido van Rossum3d209861997-12-09 16:10:31 +000095
Łukasz Langa26d513c2010-11-10 18:57:39 +000096 getboolean(section, options, raw=False, vars=None, fallback=_UNSET)
Georg Brandl96a60ae2010-07-28 13:13:46 +000097 Like get(), but convert value to a boolean (currently case
Neal Norwitzf680cc42002-12-17 01:56:47 +000098 insensitively defined as 0, false, no, off for False, and 1, true,
99 yes, on for True). Returns False or True.
Eric S. Raymond649685a2000-07-14 14:28:22 +0000100
Łukasz Langa71b37a52010-12-17 21:56:32 +0000101 items(section=_UNSET, raw=False, vars=None)
102 If section is given, return a list of tuples with (section_name,
103 section_proxy) for each section, including DEFAULTSECT. Otherwise,
104 return a list of tuples with (name, value) for each option
Fred Drake2ca041f2002-09-27 15:49:56 +0000105 in the section.
106
Eric S. Raymond649685a2000-07-14 14:28:22 +0000107 remove_section(section)
Georg Brandl96a60ae2010-07-28 13:13:46 +0000108 Remove the given file section and all its options.
Eric S. Raymond649685a2000-07-14 14:28:22 +0000109
110 remove_option(section, option)
Georg Brandl96a60ae2010-07-28 13:13:46 +0000111 Remove the given option from the given section.
Eric S. Raymond649685a2000-07-14 14:28:22 +0000112
113 set(section, option, value)
Georg Brandl96a60ae2010-07-28 13:13:46 +0000114 Set the given option.
Eric S. Raymond649685a2000-07-14 14:28:22 +0000115
Georg Brandl96a60ae2010-07-28 13:13:46 +0000116 write(fp, space_around_delimiters=True)
117 Write the configuration state in .ini format. If
118 `space_around_delimiters' is True (the default), delimiters
119 between keys and values are surrounded by spaces.
Guido van Rossum3d209861997-12-09 16:10:31 +0000120"""
121
Raymond Hettingere6603602011-02-21 19:38:53 +0000122from collections import MutableMapping, OrderedDict as _default_dict, _ChainMap
Łukasz Langa26d513c2010-11-10 18:57:39 +0000123import functools
Fred Drakea4923622010-08-09 12:52:45 +0000124import io
Łukasz Langa26d513c2010-11-10 18:57:39 +0000125import itertools
Barry Warsawbfa3f6b1998-07-01 20:41:12 +0000126import re
Georg Brandl96a60ae2010-07-28 13:13:46 +0000127import sys
Fred Drakea4923622010-08-09 12:52:45 +0000128import warnings
Guido van Rossum3d209861997-12-09 16:10:31 +0000129
Fred Drakea4923622010-08-09 12:52:45 +0000130__all__ = ["NoSectionError", "DuplicateOptionError", "DuplicateSectionError",
131 "NoOptionError", "InterpolationError", "InterpolationDepthError",
Fred Drake8d5dd982002-12-30 23:51:45 +0000132 "InterpolationSyntaxError", "ParsingError",
David Goodger1cbf2062004-10-03 15:55:09 +0000133 "MissingSectionHeaderError",
134 "ConfigParser", "SafeConfigParser", "RawConfigParser",
Fred Drakec2ff9052002-09-27 15:33:11 +0000135 "DEFAULTSECT", "MAX_INTERPOLATION_DEPTH"]
Skip Montanaroe99d5ea2001-01-20 19:54:20 +0000136
Guido van Rossum3d209861997-12-09 16:10:31 +0000137DEFAULTSECT = "DEFAULT"
138
Fred Drake2a37f9f2000-09-27 22:43:54 +0000139MAX_INTERPOLATION_DEPTH = 10
140
Guido van Rossum3d209861997-12-09 16:10:31 +0000141
Tim Peters88869f92001-01-14 23:36:06 +0000142
Guido van Rossum3d209861997-12-09 16:10:31 +0000143# exception classes
Fred Drake7c1e5ad2000-12-11 18:13:19 +0000144class Error(Exception):
Fred Drake8d5dd982002-12-30 23:51:45 +0000145 """Base class for ConfigParser exceptions."""
146
Guido van Rossum360e4b82007-05-14 22:51:27 +0000147 def _get_message(self):
148 """Getter for 'message'; needed only to override deprecation in
Georg Brandl96a60ae2010-07-28 13:13:46 +0000149 BaseException.
150 """
Guido van Rossum360e4b82007-05-14 22:51:27 +0000151 return self.__message
152
153 def _set_message(self, value):
154 """Setter for 'message'; needed only to override deprecation in
Georg Brandl96a60ae2010-07-28 13:13:46 +0000155 BaseException.
156 """
Guido van Rossum360e4b82007-05-14 22:51:27 +0000157 self.__message = value
158
159 # BaseException.message has been deprecated since Python 2.6. To prevent
Fred Drakea4923622010-08-09 12:52:45 +0000160 # DeprecationWarning from popping up over this pre-existing attribute, use
161 # a new property that takes lookup precedence.
Guido van Rossum360e4b82007-05-14 22:51:27 +0000162 message = property(_get_message, _set_message)
163
Guido van Rossum3d209861997-12-09 16:10:31 +0000164 def __init__(self, msg=''):
Fred Drakee2c64912002-12-31 17:23:27 +0000165 self.message = msg
Fred Drake7c1e5ad2000-12-11 18:13:19 +0000166 Exception.__init__(self, msg)
Fred Drake8d5dd982002-12-30 23:51:45 +0000167
Guido van Rossum3d209861997-12-09 16:10:31 +0000168 def __repr__(self):
Fred Drakee2c64912002-12-31 17:23:27 +0000169 return self.message
Fred Drake8d5dd982002-12-30 23:51:45 +0000170
Fred Drake7c1e5ad2000-12-11 18:13:19 +0000171 __str__ = __repr__
Guido van Rossum3d209861997-12-09 16:10:31 +0000172
Georg Brandl96a60ae2010-07-28 13:13:46 +0000173
Guido van Rossum3d209861997-12-09 16:10:31 +0000174class NoSectionError(Error):
Fred Drake8d5dd982002-12-30 23:51:45 +0000175 """Raised when no section matches a requested option."""
176
Guido van Rossum3d209861997-12-09 16:10:31 +0000177 def __init__(self, section):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000178 Error.__init__(self, 'No section: %r' % (section,))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000179 self.section = section
Michael Foordbd6c0792010-07-25 23:09:25 +0000180 self.args = (section, )
Guido van Rossum3d209861997-12-09 16:10:31 +0000181
Georg Brandl96a60ae2010-07-28 13:13:46 +0000182
Guido van Rossum3d209861997-12-09 16:10:31 +0000183class DuplicateSectionError(Error):
Fred Drakea4923622010-08-09 12:52:45 +0000184 """Raised when a section is repeated in an input source.
Fred Drake8d5dd982002-12-30 23:51:45 +0000185
Fred Drakea4923622010-08-09 12:52:45 +0000186 Possible repetitions that raise this exception are: multiple creation
187 using the API or in strict parsers when a section is found more than once
188 in a single input file, string or dictionary.
189 """
190
191 def __init__(self, section, source=None, lineno=None):
192 msg = [repr(section), " already exists"]
193 if source is not None:
194 message = ["While reading from ", source]
195 if lineno is not None:
196 message.append(" [line {0:2d}]".format(lineno))
197 message.append(": section ")
198 message.extend(msg)
199 msg = message
200 else:
201 msg.insert(0, "Section ")
202 Error.__init__(self, "".join(msg))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000203 self.section = section
Fred Drakea4923622010-08-09 12:52:45 +0000204 self.source = source
205 self.lineno = lineno
206 self.args = (section, source, lineno)
207
208
209class DuplicateOptionError(Error):
210 """Raised by strict parsers when an option is repeated in an input source.
211
212 Current implementation raises this exception only when an option is found
213 more than once in a single file, string or dictionary.
214 """
215
216 def __init__(self, section, option, source=None, lineno=None):
217 msg = [repr(option), " in section ", repr(section),
218 " already exists"]
219 if source is not None:
220 message = ["While reading from ", source]
221 if lineno is not None:
222 message.append(" [line {0:2d}]".format(lineno))
223 message.append(": option ")
224 message.extend(msg)
225 msg = message
226 else:
227 msg.insert(0, "Option ")
228 Error.__init__(self, "".join(msg))
229 self.section = section
230 self.option = option
231 self.source = source
232 self.lineno = lineno
233 self.args = (section, option, source, lineno)
Guido van Rossum3d209861997-12-09 16:10:31 +0000234
Georg Brandl96a60ae2010-07-28 13:13:46 +0000235
Guido van Rossum3d209861997-12-09 16:10:31 +0000236class NoOptionError(Error):
Fred Drake8d5dd982002-12-30 23:51:45 +0000237 """A requested option was not found."""
238
Guido van Rossum3d209861997-12-09 16:10:31 +0000239 def __init__(self, option, section):
Fred Drakee2c64912002-12-31 17:23:27 +0000240 Error.__init__(self, "No option %r in section: %r" %
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000241 (option, section))
242 self.option = option
243 self.section = section
Michael Foordbd6c0792010-07-25 23:09:25 +0000244 self.args = (option, section)
Guido van Rossum3d209861997-12-09 16:10:31 +0000245
Georg Brandl96a60ae2010-07-28 13:13:46 +0000246
Guido van Rossum3d209861997-12-09 16:10:31 +0000247class InterpolationError(Error):
Fred Drakee2c64912002-12-31 17:23:27 +0000248 """Base class for interpolation-related exceptions."""
Fred Drake8d5dd982002-12-30 23:51:45 +0000249
Fred Drakee2c64912002-12-31 17:23:27 +0000250 def __init__(self, option, section, msg):
251 Error.__init__(self, msg)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000252 self.option = option
253 self.section = section
Michael Foordbd6c0792010-07-25 23:09:25 +0000254 self.args = (option, section, msg)
Guido van Rossum3d209861997-12-09 16:10:31 +0000255
Georg Brandl96a60ae2010-07-28 13:13:46 +0000256
Fred Drakee2c64912002-12-31 17:23:27 +0000257class InterpolationMissingOptionError(InterpolationError):
258 """A string substitution required a setting which was not available."""
259
260 def __init__(self, option, section, rawval, reference):
261 msg = ("Bad value substitution:\n"
262 "\tsection: [%s]\n"
263 "\toption : %s\n"
264 "\tkey : %s\n"
265 "\trawval : %s\n"
266 % (section, option, reference, rawval))
267 InterpolationError.__init__(self, option, section, msg)
268 self.reference = reference
Michael Foordbd6c0792010-07-25 23:09:25 +0000269 self.args = (option, section, rawval, reference)
Fred Drakee2c64912002-12-31 17:23:27 +0000270
Georg Brandl96a60ae2010-07-28 13:13:46 +0000271
Fred Drakee2c64912002-12-31 17:23:27 +0000272class InterpolationSyntaxError(InterpolationError):
Fred Drakea4923622010-08-09 12:52:45 +0000273 """Raised when the source text contains invalid syntax.
274
Łukasz Langa7f64c8a2010-12-16 01:16:22 +0000275 Current implementation raises this exception when the source text into
276 which substitutions are made does not conform to the required syntax.
Fred Drakea4923622010-08-09 12:52:45 +0000277 """
Neal Norwitzce1d9442002-12-30 23:38:47 +0000278
Georg Brandl96a60ae2010-07-28 13:13:46 +0000279
Fred Drakee2c64912002-12-31 17:23:27 +0000280class InterpolationDepthError(InterpolationError):
Fred Drake8d5dd982002-12-30 23:51:45 +0000281 """Raised when substitutions are nested too deeply."""
282
Fred Drake2a37f9f2000-09-27 22:43:54 +0000283 def __init__(self, option, section, rawval):
Fred Drakee2c64912002-12-31 17:23:27 +0000284 msg = ("Value interpolation too deeply recursive:\n"
285 "\tsection: [%s]\n"
286 "\toption : %s\n"
287 "\trawval : %s\n"
288 % (section, option, rawval))
289 InterpolationError.__init__(self, option, section, msg)
Michael Foordbd6c0792010-07-25 23:09:25 +0000290 self.args = (option, section, rawval)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +0000291
Georg Brandl96a60ae2010-07-28 13:13:46 +0000292
Barry Warsawbfa3f6b1998-07-01 20:41:12 +0000293class ParsingError(Error):
Fred Drake8d5dd982002-12-30 23:51:45 +0000294 """Raised when a configuration file does not follow legal syntax."""
295
Fred Drakea4923622010-08-09 12:52:45 +0000296 def __init__(self, source=None, filename=None):
297 # Exactly one of `source'/`filename' arguments has to be given.
298 # `filename' kept for compatibility.
299 if filename and source:
300 raise ValueError("Cannot specify both `filename' and `source'. "
301 "Use `source'.")
302 elif not filename and not source:
303 raise ValueError("Required argument `source' not given.")
304 elif filename:
305 source = filename
306 Error.__init__(self, 'Source contains parsing errors: %s' % source)
307 self.source = source
Barry Warsawbfa3f6b1998-07-01 20:41:12 +0000308 self.errors = []
Fred Drakea4923622010-08-09 12:52:45 +0000309 self.args = (source, )
310
311 @property
312 def filename(self):
313 """Deprecated, use `source'."""
314 warnings.warn(
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000315 "The 'filename' attribute will be removed in future versions. "
Fred Drakea4923622010-08-09 12:52:45 +0000316 "Use 'source' instead.",
Łukasz Langa49afa382010-11-11 19:53:23 +0000317 DeprecationWarning, stacklevel=2
Fred Drakea4923622010-08-09 12:52:45 +0000318 )
319 return self.source
320
321 @filename.setter
322 def filename(self, value):
323 """Deprecated, user `source'."""
324 warnings.warn(
325 "The 'filename' attribute will be removed in future versions. "
326 "Use 'source' instead.",
Łukasz Langa49afa382010-11-11 19:53:23 +0000327 DeprecationWarning, stacklevel=2
Fred Drakea4923622010-08-09 12:52:45 +0000328 )
329 self.source = value
Barry Warsawbfa3f6b1998-07-01 20:41:12 +0000330
331 def append(self, lineno, line):
332 self.errors.append((lineno, line))
Fred Drakee2c64912002-12-31 17:23:27 +0000333 self.message += '\n\t[line %2d]: %s' % (lineno, line)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +0000334
Georg Brandl96a60ae2010-07-28 13:13:46 +0000335
Fred Drake2a37f9f2000-09-27 22:43:54 +0000336class MissingSectionHeaderError(ParsingError):
Fred Drake8d5dd982002-12-30 23:51:45 +0000337 """Raised when a key-value pair is found before any section header."""
338
Fred Drake2a37f9f2000-09-27 22:43:54 +0000339 def __init__(self, filename, lineno, line):
340 Error.__init__(
341 self,
Walter Dörwald70a6b492004-02-12 17:35:32 +0000342 'File contains no section headers.\nfile: %s, line: %d\n%r' %
Fred Drake2a37f9f2000-09-27 22:43:54 +0000343 (filename, lineno, line))
Fred Drakea4923622010-08-09 12:52:45 +0000344 self.source = filename
Fred Drake2a37f9f2000-09-27 22:43:54 +0000345 self.lineno = lineno
346 self.line = line
Michael Foordbd6c0792010-07-25 23:09:25 +0000347 self.args = (filename, lineno, line)
Guido van Rossum3d209861997-12-09 16:10:31 +0000348
Georg Brandl96a60ae2010-07-28 13:13:46 +0000349
Fred Drakecc645b92010-09-04 04:35:34 +0000350# Used in parser getters to indicate the default behaviour when a specific
351# option is not found it to raise an exception. Created to enable `None' as
352# a valid fallback value.
353_UNSET = object()
354
355
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000356class Interpolation:
357 """Dummy interpolation that passes the value through with no changes."""
358
359 def before_get(self, parser, section, option, value, defaults):
360 return value
361
362 def before_set(self, parser, section, option, value):
363 return value
364
365 def before_read(self, parser, section, option, value):
366 return value
367
368 def before_write(self, parser, section, option, value):
369 return value
370
371
372class BasicInterpolation(Interpolation):
Łukasz Langa7f64c8a2010-12-16 01:16:22 +0000373 """Interpolation as implemented in the classic ConfigParser.
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000374
375 The option values can contain format strings which refer to other values in
376 the same section, or values in the special default section.
377
378 For example:
379
380 something: %(dir)s/whatever
381
382 would resolve the "%(dir)s" to the value of dir. All reference
383 expansions are done late, on demand. If a user needs to use a bare % in
384 a configuration file, she can escape it by writing %%. Other other % usage
385 is considered a user error and raises `InterpolationSyntaxError'."""
386
387 _KEYCRE = re.compile(r"%\(([^)]+)\)s")
388
389 def before_get(self, parser, section, option, value, defaults):
390 L = []
391 self._interpolate_some(parser, option, L, value, section, defaults, 1)
392 return ''.join(L)
393
394 def before_set(self, parser, section, option, value):
395 tmp_value = value.replace('%%', '') # escaped percent signs
396 tmp_value = self._KEYCRE.sub('', tmp_value) # valid syntax
397 if '%' in tmp_value:
398 raise ValueError("invalid interpolation syntax in %r at "
399 "position %d" % (value, tmp_value.find('%')))
400 return value
401
402 def _interpolate_some(self, parser, option, accum, rest, section, map,
403 depth):
404 if depth > MAX_INTERPOLATION_DEPTH:
405 raise InterpolationDepthError(option, section, rest)
406 while rest:
407 p = rest.find("%")
408 if p < 0:
409 accum.append(rest)
410 return
411 if p > 0:
412 accum.append(rest[:p])
413 rest = rest[p:]
414 # p is no longer used
415 c = rest[1:2]
416 if c == "%":
417 accum.append("%")
418 rest = rest[2:]
419 elif c == "(":
420 m = self._KEYCRE.match(rest)
421 if m is None:
422 raise InterpolationSyntaxError(option, section,
423 "bad interpolation variable reference %r" % rest)
424 var = parser.optionxform(m.group(1))
425 rest = rest[m.end():]
426 try:
427 v = map[var]
428 except KeyError:
429 raise InterpolationMissingOptionError(
430 option, section, rest, var)
431 if "%" in v:
432 self._interpolate_some(parser, option, accum, v,
433 section, map, depth + 1)
434 else:
435 accum.append(v)
436 else:
437 raise InterpolationSyntaxError(
438 option, section,
439 "'%%' must be followed by '%%' or '(', "
440 "found: %r" % (rest,))
441
442
443class ExtendedInterpolation(Interpolation):
444 """Advanced variant of interpolation, supports the syntax used by
445 `zc.buildout'. Enables interpolation between sections."""
446
447 _KEYCRE = re.compile(r"\$\{([^}]+)\}")
448
449 def before_get(self, parser, section, option, value, defaults):
450 L = []
451 self._interpolate_some(parser, option, L, value, section, defaults, 1)
452 return ''.join(L)
453
454 def before_set(self, parser, section, option, value):
455 tmp_value = value.replace('$$', '') # escaped dollar signs
456 tmp_value = self._KEYCRE.sub('', tmp_value) # valid syntax
457 if '$' in tmp_value:
458 raise ValueError("invalid interpolation syntax in %r at "
459 "position %d" % (value, tmp_value.find('%')))
460 return value
461
462 def _interpolate_some(self, parser, option, accum, rest, section, map,
463 depth):
464 if depth > MAX_INTERPOLATION_DEPTH:
465 raise InterpolationDepthError(option, section, rest)
466 while rest:
467 p = rest.find("$")
468 if p < 0:
469 accum.append(rest)
470 return
471 if p > 0:
472 accum.append(rest[:p])
473 rest = rest[p:]
474 # p is no longer used
475 c = rest[1:2]
476 if c == "$":
477 accum.append("$")
478 rest = rest[2:]
479 elif c == "{":
480 m = self._KEYCRE.match(rest)
481 if m is None:
482 raise InterpolationSyntaxError(option, section,
483 "bad interpolation variable reference %r" % rest)
484 path = parser.optionxform(m.group(1)).split(':')
485 rest = rest[m.end():]
486 sect = section
487 opt = option
488 try:
489 if len(path) == 1:
490 opt = path[0]
491 v = map[opt]
492 elif len(path) == 2:
493 sect = path[0]
494 opt = path[1]
495 v = parser.get(sect, opt, raw=True)
496 else:
497 raise InterpolationSyntaxError(
498 option, section,
499 "More than one ':' found: %r" % (rest,))
Łukasz Langa71b37a52010-12-17 21:56:32 +0000500 except (KeyError, NoSectionError, NoOptionError):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000501 raise InterpolationMissingOptionError(
Łukasz Langa71b37a52010-12-17 21:56:32 +0000502 option, section, rest, ":".join(path))
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000503 if "$" in v:
504 self._interpolate_some(parser, opt, accum, v, sect,
505 dict(parser.items(sect, raw=True)),
506 depth + 1)
507 else:
508 accum.append(v)
509 else:
510 raise InterpolationSyntaxError(
511 option, section,
512 "'$' must be followed by '$' or '{', "
513 "found: %r" % (rest,))
514
515
Łukasz Langa7f64c8a2010-12-16 01:16:22 +0000516class LegacyInterpolation(Interpolation):
517 """Deprecated interpolation used in old versions of ConfigParser.
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000518 Use BasicInterpolation or ExtendedInterpolation instead."""
519
520 _KEYCRE = re.compile(r"%\(([^)]*)\)s|.")
521
522 def before_get(self, parser, section, option, value, vars):
523 rawval = value
524 depth = MAX_INTERPOLATION_DEPTH
525 while depth: # Loop through this until it's done
526 depth -= 1
527 if value and "%(" in value:
528 replace = functools.partial(self._interpolation_replace,
529 parser=parser)
530 value = self._KEYCRE.sub(replace, value)
531 try:
532 value = value % vars
533 except KeyError as e:
534 raise InterpolationMissingOptionError(
535 option, section, rawval, e.args[0])
536 else:
537 break
538 if value and "%(" in value:
539 raise InterpolationDepthError(option, section, rawval)
540 return value
541
542 def before_set(self, parser, section, option, value):
543 return value
544
545 @staticmethod
546 def _interpolation_replace(match, parser):
547 s = match.group(1)
548 if s is None:
549 return match.group()
550 else:
551 return "%%(%s)s" % parser.optionxform(s)
552
553
Łukasz Langa26d513c2010-11-10 18:57:39 +0000554class RawConfigParser(MutableMapping):
Georg Brandl96a60ae2010-07-28 13:13:46 +0000555 """ConfigParser that does not do interpolation."""
556
557 # Regular expressions for parsing section headers and options
558 _SECT_TMPL = r"""
559 \[ # [
560 (?P<header>[^]]+) # very permissive!
561 \] # ]
562 """
563 _OPT_TMPL = r"""
564 (?P<option>.*?) # very permissive!
565 \s*(?P<vi>{delim})\s* # any number of space/tab,
566 # followed by any of the
567 # allowed delimiters,
568 # followed by any space/tab
569 (?P<value>.*)$ # everything up to eol
570 """
571 _OPT_NV_TMPL = r"""
572 (?P<option>.*?) # very permissive!
573 \s*(?: # any number of space/tab,
574 (?P<vi>{delim})\s* # optionally followed by
575 # any of the allowed
576 # delimiters, followed by any
577 # space/tab
578 (?P<value>.*))?$ # everything up to eol
579 """
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000580 # Interpolation algorithm to be used if the user does not specify another
581 _DEFAULT_INTERPOLATION = Interpolation()
Georg Brandl96a60ae2010-07-28 13:13:46 +0000582 # Compiled regular expression for matching sections
583 SECTCRE = re.compile(_SECT_TMPL, re.VERBOSE)
584 # Compiled regular expression for matching options with typical separators
585 OPTCRE = re.compile(_OPT_TMPL.format(delim="=|:"), re.VERBOSE)
586 # Compiled regular expression for matching options with optional values
587 # delimited using typical separators
588 OPTCRE_NV = re.compile(_OPT_NV_TMPL.format(delim="=|:"), re.VERBOSE)
589 # Compiled regular expression for matching leading whitespace in a line
590 NONSPACECRE = re.compile(r"\S")
Fred Drakecc645b92010-09-04 04:35:34 +0000591 # Possible boolean values in the configuration.
592 BOOLEAN_STATES = {'1': True, 'yes': True, 'true': True, 'on': True,
593 '0': False, 'no': False, 'false': False, 'off': False}
Georg Brandl96a60ae2010-07-28 13:13:46 +0000594
Fred Drake03c44a32010-02-19 06:08:41 +0000595 def __init__(self, defaults=None, dict_type=_default_dict,
Fred Drakea4923622010-08-09 12:52:45 +0000596 allow_no_value=False, *, delimiters=('=', ':'),
Łukasz Langab25a7912010-12-17 01:32:29 +0000597 comment_prefixes=('#', ';'), inline_comment_prefixes=None,
598 strict=True, empty_lines_in_values=True,
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000599 default_section=DEFAULTSECT,
600 interpolation=_UNSET):
601
Thomas Wouters89f507f2006-12-13 04:49:30 +0000602 self._dict = dict_type
603 self._sections = self._dict()
604 self._defaults = self._dict()
Łukasz Langa49afa382010-11-11 19:53:23 +0000605 self._proxies = self._dict()
Łukasz Langac264c092010-11-20 16:15:37 +0000606 self._proxies[default_section] = SectionProxy(self, default_section)
David Goodger68a1abd2004-10-03 15:40:25 +0000607 if defaults:
608 for key, value in defaults.items():
609 self._defaults[self.optionxform(key)] = value
Georg Brandl96a60ae2010-07-28 13:13:46 +0000610 self._delimiters = tuple(delimiters)
611 if delimiters == ('=', ':'):
612 self._optcre = self.OPTCRE_NV if allow_no_value else self.OPTCRE
613 else:
Fred Drakea4923622010-08-09 12:52:45 +0000614 d = "|".join(re.escape(d) for d in delimiters)
Georg Brandl96a60ae2010-07-28 13:13:46 +0000615 if allow_no_value:
Fred Drakea4923622010-08-09 12:52:45 +0000616 self._optcre = re.compile(self._OPT_NV_TMPL.format(delim=d),
Georg Brandl96a60ae2010-07-28 13:13:46 +0000617 re.VERBOSE)
618 else:
Fred Drakea4923622010-08-09 12:52:45 +0000619 self._optcre = re.compile(self._OPT_TMPL.format(delim=d),
Georg Brandl96a60ae2010-07-28 13:13:46 +0000620 re.VERBOSE)
Łukasz Langab25a7912010-12-17 01:32:29 +0000621 self._comment_prefixes = tuple(comment_prefixes or ())
622 self._inline_comment_prefixes = tuple(inline_comment_prefixes or ())
Fred Drakea4923622010-08-09 12:52:45 +0000623 self._strict = strict
Łukasz Langa26d513c2010-11-10 18:57:39 +0000624 self._allow_no_value = allow_no_value
Georg Brandl96a60ae2010-07-28 13:13:46 +0000625 self._empty_lines_in_values = empty_lines_in_values
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000626 if interpolation is _UNSET:
627 self._interpolation = self._DEFAULT_INTERPOLATION
628 else:
629 self._interpolation = interpolation
630 self.default_section=default_section
Guido van Rossum3d209861997-12-09 16:10:31 +0000631
632 def defaults(self):
Fred Drakefce65572002-10-25 18:08:18 +0000633 return self._defaults
Guido van Rossum3d209861997-12-09 16:10:31 +0000634
635 def sections(self):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000636 """Return a list of section names, excluding [DEFAULT]"""
Fred Drakefce65572002-10-25 18:08:18 +0000637 # self._sections will never have [DEFAULT] in it
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000638 return list(self._sections.keys())
Guido van Rossum3d209861997-12-09 16:10:31 +0000639
640 def add_section(self, section):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000641 """Create a new section in the configuration.
Guido van Rossum3d209861997-12-09 16:10:31 +0000642
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000643 Raise DuplicateSectionError if a section by the specified name
Łukasz Langac264c092010-11-20 16:15:37 +0000644 already exists. Raise ValueError if name is DEFAULT.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000645 """
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000646 if section == self.default_section:
Łukasz Langa3a11e712010-12-03 22:15:19 +0000647 raise ValueError('Invalid section name: %r' % section)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000648
Fred Drakefce65572002-10-25 18:08:18 +0000649 if section in self._sections:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000650 raise DuplicateSectionError(section)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000651 self._sections[section] = self._dict()
Łukasz Langa49afa382010-11-11 19:53:23 +0000652 self._proxies[section] = SectionProxy(self, section)
Guido van Rossum3d209861997-12-09 16:10:31 +0000653
654 def has_section(self, section):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000655 """Indicate whether the named section is present in the configuration.
Guido van Rossum3d209861997-12-09 16:10:31 +0000656
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000657 The DEFAULT section is not acknowledged.
658 """
Fred Drakefce65572002-10-25 18:08:18 +0000659 return section in self._sections
Guido van Rossum3d209861997-12-09 16:10:31 +0000660
661 def options(self, section):
Guido van Rossuma5a24b71999-10-04 19:58:22 +0000662 """Return a list of option names for the given section name."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000663 try:
Fred Drakefce65572002-10-25 18:08:18 +0000664 opts = self._sections[section].copy()
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000665 except KeyError:
666 raise NoSectionError(section)
Fred Drakefce65572002-10-25 18:08:18 +0000667 opts.update(self._defaults)
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000668 return list(opts.keys())
Guido van Rossum3d209861997-12-09 16:10:31 +0000669
Georg Brandl8dcaa732010-07-29 12:17:40 +0000670 def read(self, filenames, encoding=None):
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000671 """Read and parse a filename or a list of filenames.
Tim Peters88869f92001-01-14 23:36:06 +0000672
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000673 Files that cannot be opened are silently ignored; this is
Barry Warsaw25394511999-10-12 16:12:48 +0000674 designed so that you can specify a list of potential
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000675 configuration file locations (e.g. current directory, user's
676 home directory, systemwide directory), and all existing
677 configuration files in the list will be read. A single
678 filename may also be given.
Fred Drake82903142004-05-18 04:24:02 +0000679
680 Return list of successfully read files.
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000681 """
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000682 if isinstance(filenames, str):
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000683 filenames = [filenames]
Fred Drake82903142004-05-18 04:24:02 +0000684 read_ok = []
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000685 for filename in filenames:
686 try:
Florent Xicluna42d54452010-09-22 22:35:38 +0000687 with open(filename, encoding=encoding) as fp:
688 self._read(fp, filename)
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000689 except IOError:
690 continue
Fred Drake82903142004-05-18 04:24:02 +0000691 read_ok.append(filename)
692 return read_ok
Guido van Rossum3d209861997-12-09 16:10:31 +0000693
Fred Drakea4923622010-08-09 12:52:45 +0000694 def read_file(self, f, source=None):
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000695 """Like read() but the argument must be a file-like object.
696
Fred Drakea4923622010-08-09 12:52:45 +0000697 The `f' argument must have a `readline' method. Optional second
698 argument is the `source' specifying the name of the file being read. If
699 not given, it is taken from f.name. If `f' has no `name' attribute,
700 `<???>' is used.
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000701 """
Fred Drakea4923622010-08-09 12:52:45 +0000702 if source is None:
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000703 try:
Florent Xicluna42d54452010-09-22 22:35:38 +0000704 source = f.name
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000705 except AttributeError:
Fred Drakea4923622010-08-09 12:52:45 +0000706 source = '<???>'
707 self._read(f, source)
708
709 def read_string(self, string, source='<string>'):
710 """Read configuration from a given string."""
711 sfile = io.StringIO(string)
712 self.read_file(sfile, source)
713
714 def read_dict(self, dictionary, source='<dict>'):
715 """Read configuration from a dictionary.
716
717 Keys are section names, values are dictionaries with keys and values
718 that should be present in the section. If the used dictionary type
719 preserves order, sections and their keys will be added in order.
720
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +0000721 All types held in the dictionary are converted to strings during
722 reading, including section names, option names and keys.
723
Fred Drakea4923622010-08-09 12:52:45 +0000724 Optional second argument is the `source' specifying the name of the
725 dictionary being read.
726 """
727 elements_added = set()
728 for section, keys in dictionary.items():
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +0000729 section = str(section)
Fred Drakea4923622010-08-09 12:52:45 +0000730 try:
731 self.add_section(section)
Łukasz Langa26d513c2010-11-10 18:57:39 +0000732 except (DuplicateSectionError, ValueError):
Fred Drakea4923622010-08-09 12:52:45 +0000733 if self._strict and section in elements_added:
734 raise
Łukasz Langa71b37a52010-12-17 21:56:32 +0000735 elements_added.add(section)
Fred Drakea4923622010-08-09 12:52:45 +0000736 for key, value in keys.items():
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +0000737 key = self.optionxform(str(key))
Fred Drakecc645b92010-09-04 04:35:34 +0000738 if value is not None:
739 value = str(value)
Fred Drakea4923622010-08-09 12:52:45 +0000740 if self._strict and (section, key) in elements_added:
741 raise DuplicateOptionError(section, key, source)
742 elements_added.add((section, key))
743 self.set(section, key, value)
744
745 def readfp(self, fp, filename=None):
746 """Deprecated, use read_file instead."""
747 warnings.warn(
748 "This method will be removed in future versions. "
749 "Use 'parser.read_file()' instead.",
Łukasz Langa49afa382010-11-11 19:53:23 +0000750 DeprecationWarning, stacklevel=2
Fred Drakea4923622010-08-09 12:52:45 +0000751 )
752 self.read_file(fp, source=filename)
Guido van Rossum6a8d84b1999-10-04 18:57:27 +0000753
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000754 def get(self, section, option, *, raw=False, vars=None, fallback=_UNSET):
Fred Drakecc645b92010-09-04 04:35:34 +0000755 """Get an option value for a given section.
756
757 If `vars' is provided, it must be a dictionary. The option is looked up
758 in `vars' (if provided), `section', and in `DEFAULTSECT' in that order.
Łukasz Langa26d513c2010-11-10 18:57:39 +0000759 If the key is not found and `fallback' is provided, it is used as
760 a fallback value. `None' can be provided as a `fallback' value.
761
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000762 If interpolation is enabled and the optional argument `raw' is False,
763 all interpolations are expanded in the return values.
764
765 Arguments `raw', `vars', and `fallback' are keyword only.
766
767 The section DEFAULT is special.
Fred Drakecc645b92010-09-04 04:35:34 +0000768 """
769 try:
770 d = self._unify_values(section, vars)
771 except NoSectionError:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000772 if fallback is _UNSET:
Fred Drakecc645b92010-09-04 04:35:34 +0000773 raise
Fred Drakefce65572002-10-25 18:08:18 +0000774 else:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000775 return fallback
Fred Drakecc645b92010-09-04 04:35:34 +0000776 option = self.optionxform(option)
777 try:
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000778 value = d[option]
Fred Drakecc645b92010-09-04 04:35:34 +0000779 except KeyError:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000780 if fallback is _UNSET:
Fred Drakefce65572002-10-25 18:08:18 +0000781 raise NoOptionError(option, section)
Fred Drakecc645b92010-09-04 04:35:34 +0000782 else:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000783 return fallback
Fred Drake2a37f9f2000-09-27 22:43:54 +0000784
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000785 if raw or value is None:
786 return value
787 else:
788 return self._interpolation.before_get(self, section, option, value,
789 d)
Fred Drake2ca041f2002-09-27 15:49:56 +0000790
Łukasz Langa26d513c2010-11-10 18:57:39 +0000791 def _get(self, section, conv, option, **kwargs):
792 return conv(self.get(section, option, **kwargs))
Guido van Rossum3d209861997-12-09 16:10:31 +0000793
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000794 def getint(self, section, option, *, raw=False, vars=None,
795 fallback=_UNSET):
Fred Drakecc645b92010-09-04 04:35:34 +0000796 try:
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000797 return self._get(section, int, option, raw=raw, vars=vars)
Fred Drakecc645b92010-09-04 04:35:34 +0000798 except (NoSectionError, NoOptionError):
Łukasz Langa26d513c2010-11-10 18:57:39 +0000799 if fallback is _UNSET:
Fred Drakecc645b92010-09-04 04:35:34 +0000800 raise
801 else:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000802 return fallback
Guido van Rossum3d209861997-12-09 16:10:31 +0000803
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000804 def getfloat(self, section, option, *, raw=False, vars=None,
805 fallback=_UNSET):
Fred Drakecc645b92010-09-04 04:35:34 +0000806 try:
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000807 return self._get(section, float, option, raw=raw, vars=vars)
Fred Drakecc645b92010-09-04 04:35:34 +0000808 except (NoSectionError, NoOptionError):
Łukasz Langa26d513c2010-11-10 18:57:39 +0000809 if fallback is _UNSET:
Fred Drakecc645b92010-09-04 04:35:34 +0000810 raise
811 else:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000812 return fallback
Guido van Rossum3d209861997-12-09 16:10:31 +0000813
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000814 def getboolean(self, section, option, *, raw=False, vars=None,
815 fallback=_UNSET):
Fred Drakecc645b92010-09-04 04:35:34 +0000816 try:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000817 return self._get(section, self._convert_to_boolean, option,
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000818 raw=raw, vars=vars)
Fred Drakecc645b92010-09-04 04:35:34 +0000819 except (NoSectionError, NoOptionError):
Łukasz Langa26d513c2010-11-10 18:57:39 +0000820 if fallback is _UNSET:
Fred Drakecc645b92010-09-04 04:35:34 +0000821 raise
822 else:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000823 return fallback
Guido van Rossum3d209861997-12-09 16:10:31 +0000824
Łukasz Langa71b37a52010-12-17 21:56:32 +0000825 def items(self, section=_UNSET, raw=False, vars=None):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000826 """Return a list of (name, value) tuples for each option in a section.
827
828 All % interpolations are expanded in the return values, based on the
829 defaults passed into the constructor, unless the optional argument
830 `raw' is true. Additional substitutions may be provided using the
831 `vars' argument, which must be a dictionary whose contents overrides
832 any pre-existing defaults.
833
834 The section DEFAULT is special.
835 """
Łukasz Langa71b37a52010-12-17 21:56:32 +0000836 if section is _UNSET:
837 return super().items()
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000838 d = self._defaults.copy()
839 try:
840 d.update(self._sections[section])
841 except KeyError:
842 if section != self.default_section:
843 raise NoSectionError(section)
844 # Update with the entry specific variables
845 if vars:
846 for key, value in vars.items():
847 d[self.optionxform(key)] = value
Łukasz Langa24bcc612010-12-04 11:48:11 +0000848 value_getter = lambda option: self._interpolation.before_get(self,
849 section, option, d[option], d)
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000850 if raw:
Łukasz Langa24bcc612010-12-04 11:48:11 +0000851 value_getter = lambda option: d[option]
852 return [(option, value_getter(option)) for option in d.keys()]
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000853
Guido van Rossum9e480ad1999-06-17 18:41:42 +0000854 def optionxform(self, optionstr):
Eric S. Raymond9eb54d92001-02-09 05:19:09 +0000855 return optionstr.lower()
Guido van Rossum9e480ad1999-06-17 18:41:42 +0000856
Eric S. Raymond417c4892000-07-10 18:11:00 +0000857 def has_option(self, section, option):
Łukasz Langa71b37a52010-12-17 21:56:32 +0000858 """Check for the existence of a given option in a given section.
859 If the specified `section' is None or an empty string, DEFAULT is
860 assumed. If the specified `section' does not exist, returns False."""
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000861 if not section or section == self.default_section:
Fred Drakec2ff9052002-09-27 15:33:11 +0000862 option = self.optionxform(option)
Fred Drakefce65572002-10-25 18:08:18 +0000863 return option in self._defaults
864 elif section not in self._sections:
Neal Norwitzf680cc42002-12-17 01:56:47 +0000865 return False
Eric S. Raymond417c4892000-07-10 18:11:00 +0000866 else:
Fred Drake3c823aa2001-02-26 21:55:34 +0000867 option = self.optionxform(option)
Fred Drakefce65572002-10-25 18:08:18 +0000868 return (option in self._sections[section]
869 or option in self._defaults)
Eric S. Raymond417c4892000-07-10 18:11:00 +0000870
Fred Drake03c44a32010-02-19 06:08:41 +0000871 def set(self, section, option, value=None):
Eric S. Raymond417c4892000-07-10 18:11:00 +0000872 """Set an option."""
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000873 if value:
874 value = self._interpolation.before_set(self, section, option,
875 value)
876 if not section or section == self.default_section:
Fred Drakefce65572002-10-25 18:08:18 +0000877 sectdict = self._defaults
Eric S. Raymond417c4892000-07-10 18:11:00 +0000878 else:
879 try:
Fred Drakefce65572002-10-25 18:08:18 +0000880 sectdict = self._sections[section]
Eric S. Raymond417c4892000-07-10 18:11:00 +0000881 except KeyError:
882 raise NoSectionError(section)
Fred Drakec2ff9052002-09-27 15:33:11 +0000883 sectdict[self.optionxform(option)] = value
Eric S. Raymond417c4892000-07-10 18:11:00 +0000884
Georg Brandl96a60ae2010-07-28 13:13:46 +0000885 def write(self, fp, space_around_delimiters=True):
886 """Write an .ini-format representation of the configuration state.
887
888 If `space_around_delimiters' is True (the default), delimiters
889 between keys and values are surrounded by spaces.
890 """
891 if space_around_delimiters:
892 d = " {} ".format(self._delimiters[0])
893 else:
894 d = self._delimiters[0]
Fred Drakefce65572002-10-25 18:08:18 +0000895 if self._defaults:
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000896 self._write_section(fp, self.default_section,
Łukasz Langac264c092010-11-20 16:15:37 +0000897 self._defaults.items(), d)
Fred Drakefce65572002-10-25 18:08:18 +0000898 for section in self._sections:
Georg Brandl96a60ae2010-07-28 13:13:46 +0000899 self._write_section(fp, section,
900 self._sections[section].items(), d)
901
902 def _write_section(self, fp, section_name, section_items, delimiter):
903 """Write a single section to the specified `fp'."""
904 fp.write("[{}]\n".format(section_name))
905 for key, value in section_items:
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000906 value = self._interpolation.before_write(self, section_name, key,
907 value)
Łukasz Langa26d513c2010-11-10 18:57:39 +0000908 if value is not None or not self._allow_no_value:
Georg Brandl96a60ae2010-07-28 13:13:46 +0000909 value = delimiter + str(value).replace('\n', '\n\t')
910 else:
911 value = ""
912 fp.write("{}{}\n".format(key, value))
913 fp.write("\n")
Eric S. Raymond417c4892000-07-10 18:11:00 +0000914
Thomas Woutersff4df6d2000-07-21 05:19:59 +0000915 def remove_option(self, section, option):
Eric S. Raymond649685a2000-07-14 14:28:22 +0000916 """Remove an option."""
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000917 if not section or section == self.default_section:
Fred Drakefce65572002-10-25 18:08:18 +0000918 sectdict = self._defaults
Eric S. Raymond649685a2000-07-14 14:28:22 +0000919 else:
920 try:
Fred Drakefce65572002-10-25 18:08:18 +0000921 sectdict = self._sections[section]
Eric S. Raymond649685a2000-07-14 14:28:22 +0000922 except KeyError:
923 raise NoSectionError(section)
Fred Drake3c823aa2001-02-26 21:55:34 +0000924 option = self.optionxform(option)
Raymond Hettinger54f02222002-06-01 14:18:47 +0000925 existed = option in sectdict
Eric S. Raymond649685a2000-07-14 14:28:22 +0000926 if existed:
Fred Drakeff4a23b2000-12-04 16:29:13 +0000927 del sectdict[option]
Eric S. Raymond649685a2000-07-14 14:28:22 +0000928 return existed
929
Thomas Woutersff4df6d2000-07-21 05:19:59 +0000930 def remove_section(self, section):
Eric S. Raymond649685a2000-07-14 14:28:22 +0000931 """Remove a file section."""
Fred Drakefce65572002-10-25 18:08:18 +0000932 existed = section in self._sections
Fred Drakec2ff9052002-09-27 15:33:11 +0000933 if existed:
Fred Drakefce65572002-10-25 18:08:18 +0000934 del self._sections[section]
Łukasz Langa49afa382010-11-11 19:53:23 +0000935 del self._proxies[section]
Fred Drakec2ff9052002-09-27 15:33:11 +0000936 return existed
Eric S. Raymond649685a2000-07-14 14:28:22 +0000937
Łukasz Langa26d513c2010-11-10 18:57:39 +0000938 def __getitem__(self, key):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000939 if key != self.default_section and not self.has_section(key):
Łukasz Langa26d513c2010-11-10 18:57:39 +0000940 raise KeyError(key)
Łukasz Langa49afa382010-11-11 19:53:23 +0000941 return self._proxies[key]
Łukasz Langa26d513c2010-11-10 18:57:39 +0000942
943 def __setitem__(self, key, value):
944 # To conform with the mapping protocol, overwrites existing values in
945 # the section.
946
947 # XXX this is not atomic if read_dict fails at any point. Then again,
948 # no update method in configparser is atomic in this implementation.
949 self.remove_section(key)
950 self.read_dict({key: value})
951
952 def __delitem__(self, key):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000953 if key == self.default_section:
Łukasz Langa26d513c2010-11-10 18:57:39 +0000954 raise ValueError("Cannot remove the default section.")
955 if not self.has_section(key):
956 raise KeyError(key)
957 self.remove_section(key)
958
959 def __contains__(self, key):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000960 return key == self.default_section or self.has_section(key)
Łukasz Langa26d513c2010-11-10 18:57:39 +0000961
962 def __len__(self):
963 return len(self._sections) + 1 # the default section
964
965 def __iter__(self):
966 # XXX does it break when underlying container state changed?
Łukasz Langab6a6f5f2010-12-03 16:28:00 +0000967 return itertools.chain((self.default_section,), self._sections.keys())
Łukasz Langa26d513c2010-11-10 18:57:39 +0000968
Fred Drakefce65572002-10-25 18:08:18 +0000969 def _read(self, fp, fpname):
Georg Brandl96a60ae2010-07-28 13:13:46 +0000970 """Parse a sectioned configuration file.
Guido van Rossum3d209861997-12-09 16:10:31 +0000971
Fred Drakea4923622010-08-09 12:52:45 +0000972 Each section in a configuration file contains a header, indicated by
973 a name in square brackets (`[]'), plus key/value options, indicated by
Georg Brandl96a60ae2010-07-28 13:13:46 +0000974 `name' and `value' delimited with a specific substring (`=' or `:' by
975 default).
976
Fred Drakea4923622010-08-09 12:52:45 +0000977 Values can span multiple lines, as long as they are indented deeper
978 than the first line of the value. Depending on the parser's mode, blank
979 lines may be treated as parts of multiline values or ignored.
Georg Brandl96a60ae2010-07-28 13:13:46 +0000980
981 Configuration files may include comments, prefixed by specific
Fred Drakea4923622010-08-09 12:52:45 +0000982 characters (`#' and `;' by default). Comments may appear on their own
983 in an otherwise empty line or may be entered in lines holding values or
Georg Brandl96a60ae2010-07-28 13:13:46 +0000984 section names.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000985 """
Fred Drakea4923622010-08-09 12:52:45 +0000986 elements_added = set()
Brian Curtin9a27b0c2010-07-26 00:27:10 +0000987 cursect = None # None, or a dictionary
Fred Drakea4923622010-08-09 12:52:45 +0000988 sectname = None
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000989 optname = None
990 lineno = 0
Georg Brandl96a60ae2010-07-28 13:13:46 +0000991 indent_level = 0
Brian Curtin9a27b0c2010-07-26 00:27:10 +0000992 e = None # None, or an exception
Georg Brandl96a60ae2010-07-28 13:13:46 +0000993 for lineno, line in enumerate(fp, start=1):
Georg Brandl96a60ae2010-07-28 13:13:46 +0000994 comment_start = None
Georg Brandl96a60ae2010-07-28 13:13:46 +0000995 # strip inline comments
Łukasz Langab25a7912010-12-17 01:32:29 +0000996 for prefix in self._inline_comment_prefixes:
Georg Brandl96a60ae2010-07-28 13:13:46 +0000997 index = line.find(prefix)
998 if index == 0 or (index > 0 and line[index-1].isspace()):
999 comment_start = index
1000 break
Łukasz Langab25a7912010-12-17 01:32:29 +00001001 # strip full line comments
1002 for prefix in self._comment_prefixes:
1003 if line.strip().startswith(prefix):
1004 comment_start = 0
1005 break
Georg Brandl96a60ae2010-07-28 13:13:46 +00001006 value = line[:comment_start].strip()
1007 if not value:
Georg Brandlf206d0e2010-07-29 11:56:20 +00001008 if self._empty_lines_in_values:
Georg Brandl96a60ae2010-07-28 13:13:46 +00001009 # add empty line to the value, but only if there was no
1010 # comment on the line
Georg Brandlf206d0e2010-07-29 11:56:20 +00001011 if (comment_start is None and
1012 cursect is not None and
1013 optname and
1014 cursect[optname] is not None):
1015 cursect[optname].append('') # newlines added at join
Georg Brandl96a60ae2010-07-28 13:13:46 +00001016 else:
1017 # empty line marks end of value
1018 indent_level = sys.maxsize
Guido van Rossum45e2fbc1998-03-26 21:13:24 +00001019 continue
1020 # continuation line?
Georg Brandl96a60ae2010-07-28 13:13:46 +00001021 first_nonspace = self.NONSPACECRE.search(line)
1022 cur_indent_level = first_nonspace.start() if first_nonspace else 0
1023 if (cursect is not None and optname and
1024 cur_indent_level > indent_level):
1025 cursect[optname].append(value)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001026 # a section header or option header?
Guido van Rossum45e2fbc1998-03-26 21:13:24 +00001027 else:
Georg Brandl96a60ae2010-07-28 13:13:46 +00001028 indent_level = cur_indent_level
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001029 # is it a section header?
Georg Brandl96a60ae2010-07-28 13:13:46 +00001030 mo = self.SECTCRE.match(value)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001031 if mo:
1032 sectname = mo.group('header')
Fred Drakefce65572002-10-25 18:08:18 +00001033 if sectname in self._sections:
Fred Drakea4923622010-08-09 12:52:45 +00001034 if self._strict and sectname in elements_added:
1035 raise DuplicateSectionError(sectname, fpname,
1036 lineno)
Fred Drakefce65572002-10-25 18:08:18 +00001037 cursect = self._sections[sectname]
Fred Drakea4923622010-08-09 12:52:45 +00001038 elements_added.add(sectname)
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001039 elif sectname == self.default_section:
Fred Drakefce65572002-10-25 18:08:18 +00001040 cursect = self._defaults
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001041 else:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001042 cursect = self._dict()
Fred Drakefce65572002-10-25 18:08:18 +00001043 self._sections[sectname] = cursect
Łukasz Langa49afa382010-11-11 19:53:23 +00001044 self._proxies[sectname] = SectionProxy(self, sectname)
Fred Drakea4923622010-08-09 12:52:45 +00001045 elements_added.add(sectname)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001046 # So sections can't start with a continuation line
1047 optname = None
1048 # no section header in the file?
1049 elif cursect is None:
Walter Dörwald70a6b492004-02-12 17:35:32 +00001050 raise MissingSectionHeaderError(fpname, lineno, line)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001051 # an option line?
1052 else:
Georg Brandl96a60ae2010-07-28 13:13:46 +00001053 mo = self._optcre.match(value)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001054 if mo:
Fred Drakec517b9b2000-02-28 20:59:03 +00001055 optname, vi, optval = mo.group('option', 'vi', 'value')
Georg Brandl96a60ae2010-07-28 13:13:46 +00001056 if not optname:
1057 e = self._handle_error(e, fpname, lineno, line)
Brian Curtin9a27b0c2010-07-26 00:27:10 +00001058 optname = self.optionxform(optname.rstrip())
Fred Drakea4923622010-08-09 12:52:45 +00001059 if (self._strict and
1060 (sectname, optname) in elements_added):
1061 raise DuplicateOptionError(sectname, optname,
1062 fpname, lineno)
1063 elements_added.add((sectname, optname))
Fred Drake03c44a32010-02-19 06:08:41 +00001064 # This check is fine because the OPTCRE cannot
1065 # match if it would set optval to None
1066 if optval is not None:
Fred Drake03c44a32010-02-19 06:08:41 +00001067 optval = optval.strip()
Brian Curtin9a27b0c2010-07-26 00:27:10 +00001068 cursect[optname] = [optval]
1069 else:
1070 # valueless option handling
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001071 cursect[optname] = None
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001072 else:
Georg Brandl96a60ae2010-07-28 13:13:46 +00001073 # a non-fatal parsing error occurred. set up the
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001074 # exception but keep going. the exception will be
1075 # raised at the end of the file and will contain a
1076 # list of all bogus lines
Georg Brandl96a60ae2010-07-28 13:13:46 +00001077 e = self._handle_error(e, fpname, lineno, line)
Barry Warsawbfa3f6b1998-07-01 20:41:12 +00001078 # if any parsing errors occurred, raise an exception
1079 if e:
1080 raise e
Georg Brandl96a60ae2010-07-28 13:13:46 +00001081 self._join_multiline_values()
Fred Drakefce65572002-10-25 18:08:18 +00001082
Georg Brandl96a60ae2010-07-28 13:13:46 +00001083 def _join_multiline_values(self):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001084 defaults = self.default_section, self._defaults
1085 all_sections = itertools.chain((defaults,),
1086 self._sections.items())
1087 for section, options in all_sections:
Brian Curtin9a27b0c2010-07-26 00:27:10 +00001088 for name, val in options.items():
1089 if isinstance(val, list):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001090 val = '\n'.join(val).rstrip()
1091 options[name] = self._interpolation.before_read(self,
1092 section,
1093 name, val)
Fred Drakefce65572002-10-25 18:08:18 +00001094
Georg Brandl96a60ae2010-07-28 13:13:46 +00001095 def _handle_error(self, exc, fpname, lineno, line):
1096 if not exc:
1097 exc = ParsingError(fpname)
1098 exc.append(lineno, repr(line))
1099 return exc
1100
Fred Drakecc645b92010-09-04 04:35:34 +00001101 def _unify_values(self, section, vars):
Raymond Hettingere6603602011-02-21 19:38:53 +00001102 """Create a sequence of lookups with 'vars' taking priority over
1103 the 'section' which takes priority over the DEFAULTSECT.
1104
Fred Drakefce65572002-10-25 18:08:18 +00001105 """
Raymond Hettingere6603602011-02-21 19:38:53 +00001106 sectiondict = {}
Fred Drakefce65572002-10-25 18:08:18 +00001107 try:
Raymond Hettingere6603602011-02-21 19:38:53 +00001108 sectiondict = self._sections[section]
Fred Drakefce65572002-10-25 18:08:18 +00001109 except KeyError:
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001110 if section != self.default_section:
Fred Drakefce65572002-10-25 18:08:18 +00001111 raise NoSectionError(section)
1112 # Update with the entry specific variables
Raymond Hettingere6603602011-02-21 19:38:53 +00001113 vardict = {}
David Goodger68a1abd2004-10-03 15:40:25 +00001114 if vars:
1115 for key, value in vars.items():
Fred Drakecc645b92010-09-04 04:35:34 +00001116 if value is not None:
1117 value = str(value)
Raymond Hettingere6603602011-02-21 19:38:53 +00001118 vardict[self.optionxform(key)] = value
1119 return _ChainMap(vardict, sectiondict, self._defaults)
Fred Drakecc645b92010-09-04 04:35:34 +00001120
1121 def _convert_to_boolean(self, value):
1122 """Return a boolean value translating from other types if necessary.
1123 """
1124 if value.lower() not in self.BOOLEAN_STATES:
1125 raise ValueError('Not a boolean: %s' % value)
1126 return self.BOOLEAN_STATES[value.lower()]
1127
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +00001128 def _validate_value_types(self, *, section="", option="", value=""):
Łukasz Langa26d513c2010-11-10 18:57:39 +00001129 """Raises a TypeError for non-string values.
1130
1131 The only legal non-string value if we allow valueless
1132 options is None, so we need to check if the value is a
1133 string if:
1134 - we do not allow valueless options, or
1135 - we allow valueless options but the value is not None
1136
1137 For compatibility reasons this method is not used in classic set()
Łukasz Langa7f64c8a2010-12-16 01:16:22 +00001138 for RawConfigParsers. It is invoked in every case for mapping protocol
1139 access and in ConfigParser.set().
Łukasz Langa26d513c2010-11-10 18:57:39 +00001140 """
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +00001141 if not isinstance(section, str):
1142 raise TypeError("section names must be strings")
1143 if not isinstance(option, str):
1144 raise TypeError("option keys must be strings")
Łukasz Langa26d513c2010-11-10 18:57:39 +00001145 if not self._allow_no_value or value:
1146 if not isinstance(value, str):
1147 raise TypeError("option values must be strings")
1148
1149
Fred Drakecc645b92010-09-04 04:35:34 +00001150class ConfigParser(RawConfigParser):
1151 """ConfigParser implementing interpolation."""
1152
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001153 _DEFAULT_INTERPOLATION = BasicInterpolation()
David Goodger1cbf2062004-10-03 15:55:09 +00001154
Fred Drake03c44a32010-02-19 06:08:41 +00001155 def set(self, section, option, value=None):
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001156 """Set an option. Extends RawConfigParser.set by validating type and
1157 interpolation syntax on the value."""
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +00001158 self._validate_value_types(option=option, value=value)
Łukasz Langab6a6f5f2010-12-03 16:28:00 +00001159 super().set(section, option, value)
Łukasz Langa26d513c2010-11-10 18:57:39 +00001160
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +00001161 def add_section(self, section):
1162 """Create a new section in the configuration. Extends
1163 RawConfigParser.add_section by validating if the section name is
1164 a string."""
1165 self._validate_value_types(section=section)
1166 super().add_section(section)
1167
Łukasz Langa26d513c2010-11-10 18:57:39 +00001168
Łukasz Langa7f64c8a2010-12-16 01:16:22 +00001169class SafeConfigParser(ConfigParser):
1170 """ConfigParser alias for backwards compatibility purposes."""
1171
1172 def __init__(self, *args, **kwargs):
1173 super().__init__(*args, **kwargs)
1174 warnings.warn(
1175 "The SafeConfigParser class has been renamed to ConfigParser "
1176 "in Python 3.2. This alias will be removed in future versions."
1177 " Use ConfigParser directly instead.",
1178 DeprecationWarning, stacklevel=2
1179 )
1180
1181
Łukasz Langa26d513c2010-11-10 18:57:39 +00001182class SectionProxy(MutableMapping):
1183 """A proxy for a single section from a parser."""
1184
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001185 def __init__(self, parser, name):
1186 """Creates a view on a section of the specified `name` in `parser`."""
Łukasz Langa26d513c2010-11-10 18:57:39 +00001187 self._parser = parser
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001188 self._name = name
Łukasz Langa26d513c2010-11-10 18:57:39 +00001189
1190 def __repr__(self):
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001191 return '<Section: {}>'.format(self._name)
Łukasz Langa26d513c2010-11-10 18:57:39 +00001192
1193 def __getitem__(self, key):
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001194 if not self._parser.has_option(self._name, key):
Łukasz Langa26d513c2010-11-10 18:57:39 +00001195 raise KeyError(key)
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001196 return self._parser.get(self._name, key)
Łukasz Langa26d513c2010-11-10 18:57:39 +00001197
1198 def __setitem__(self, key, value):
Łukasz Langa2cf9ddb2010-12-04 12:46:01 +00001199 self._parser._validate_value_types(option=key, value=value)
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001200 return self._parser.set(self._name, key, value)
Łukasz Langa26d513c2010-11-10 18:57:39 +00001201
1202 def __delitem__(self, key):
Łukasz Langa71b37a52010-12-17 21:56:32 +00001203 if not (self._parser.has_option(self._name, key) and
1204 self._parser.remove_option(self._name, key)):
Łukasz Langa26d513c2010-11-10 18:57:39 +00001205 raise KeyError(key)
Łukasz Langa26d513c2010-11-10 18:57:39 +00001206
1207 def __contains__(self, key):
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001208 return self._parser.has_option(self._name, key)
Łukasz Langa26d513c2010-11-10 18:57:39 +00001209
1210 def __len__(self):
Łukasz Langa71b37a52010-12-17 21:56:32 +00001211 return len(self._options())
Łukasz Langa26d513c2010-11-10 18:57:39 +00001212
1213 def __iter__(self):
Łukasz Langa71b37a52010-12-17 21:56:32 +00001214 return self._options().__iter__()
1215
1216 def _options(self):
1217 if self._name != self._parser.default_section:
1218 return self._parser.options(self._name)
1219 else:
1220 return self._parser.defaults()
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001221
Łukasz Langa2f0fd0f2010-12-04 17:48:18 +00001222 def get(self, option, fallback=None, *, raw=False, vars=None):
1223 return self._parser.get(self._name, option, raw=raw, vars=vars,
1224 fallback=fallback)
1225
1226 def getint(self, option, fallback=None, *, raw=False, vars=None):
1227 return self._parser.getint(self._name, option, raw=raw, vars=vars,
1228 fallback=fallback)
1229
1230 def getfloat(self, option, fallback=None, *, raw=False, vars=None):
1231 return self._parser.getfloat(self._name, option, raw=raw, vars=vars,
1232 fallback=fallback)
1233
1234 def getboolean(self, option, fallback=None, *, raw=False, vars=None):
1235 return self._parser.getboolean(self._name, option, raw=raw, vars=vars,
1236 fallback=fallback)
1237
Łukasz Langaa73dc9d2010-11-21 13:56:42 +00001238 @property
1239 def parser(self):
1240 # The parser object of the proxy is read-only.
1241 return self._parser
1242
1243 @property
1244 def name(self):
1245 # The name of the section on a proxy is read-only.
1246 return self._name