~ubuntu-branches/debian/squeeze/configobj/squeeze : revision 1

1

<?xml version="1.0" encoding="ascii"?>

2

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

3

"DTD/xhtml1-transitional.dtd">

4

5

<head>

6

<title>pythonutils.configobj</title>

7

8

9

</head>

10

11

<body bgcolor="white" text="black" link="blue" vlink="#204080"

12

alink="#204080">

13

14

<table class="navbar" border="0" width="100%" cellpadding="0"

15

bgcolor="#a0c0ff" cellspacing="0">

16

17

18

<th bgcolor="#70b0f0" class="navselect"

19

>   Home   </th>

20

21

22

<th class="navbar">   <a class="navbar"

23

href="trees.html">Trees</a>   </th>

24

25

26

<th class="navbar">   <a class="navbar"

27

href="indices.html">Index</a>   </th>

28

29

30

<th class="navbar">   <a class="navbar"

31

href="help.html">Help</a>   </th>

32

33

34

35

36

37

38

<a class="navbar" target="_top" href="http://www.voidspace.org.uk/python/configobj.html">ConfigObj</a>

39

</th></tr></table></th>

40

</tr>

41

</table>

42

43

44

45

46

Package pythonutils ::

47

Module configobj

48

49

</td>

50

<td>

51

52

53

<tr><td align="right">[<a href="javascript: void(0);" class="privatelink"

54

onclick="toggle_private();">hide private</a>]</td></tr>

55

<tr><td align="right"><span class="options"

56

>[<a href="frames.html" target="_top">frames</a

57

>] | <a href="pythonutils.configobj-pysrc.html"

58

target="_top">no frames</a>]</td></tr>

59

</table>

60

</td>

61

</tr>

62

</table>

63

<h2 class="py-src">Source Code for <a href="pythonutils.configobj-module.html">Module pythonutils.configobj</a></h2>

64

65

66

1 # configobj.py

67

2 # A config file reader/writer that supports nested sections in config files.

68

69

4 # E-mail: fuzzyman AT voidspace DOT org DOT uk

70

5 # nico AT tekNico DOT net

71

6

72

7 # ConfigObj 4

73

8 # http://www.voidspace.org.uk/python/configobj.html

74

9

75

10 # Released subject to the BSD License

76

11 # Please see http://www.voidspace.org.uk/python/license.shtml

77

12

78

13 # Scripts maintained at http://www.voidspace.org.uk/python/index.shtml

79

14 # For information about bugfixes, updates and support, please join the

80

15 # ConfigObj mailing list:

81

16 # http://lists.sourceforge.net/lists/listinfo/configobj-develop

82

17 # Comments, suggestions and bug reports welcome.

83

18

84

19 from __future__ import <a class="py-name" href="pythonutils.configobj-module.html#generators">generators</a>

85

20

86

21 import sys

87

22 <a class="py-name" href="pythonutils.configobj-module.html#INTP_VER">INTP_VER</a> = sys.version_info[:2]

88

23 if <a class="py-name" href="pythonutils.configobj-module.html#INTP_VER">INTP_VER</a> < (2, 2):

89

24 raise RuntimeError("Python v.2.2 or later needed")

90

25

91

26 import os, re

92

27 import compiler

93

28 from types import StringTypes

94

29 from warnings import warn

95

30 from codecs import BOM_UTF8, BOM_UTF16, BOM_UTF16_BE, BOM_UTF16_LE

96

31

97

32 # A dictionary mapping BOM to

98

33 # the encoding to decode with, and what to set the

99

34 # encoding attribute to.

100

35 <a class="py-name" href="pythonutils.configobj-module.html#BOMS">BOMS</a> = {

101

36 BOM_UTF8: ('utf_8', None),

102

37 BOM_UTF16_BE: ('utf16_be', 'utf_16'),

103

38 BOM_UTF16_LE: ('utf16_le', 'utf_16'),

104

39 BOM_UTF16: ('utf_16', 'utf_16'),

105

40 }

106

41 # All legal variants of the BOM codecs.

107

42 # TODO: the list of aliases is not meant to be exhaustive, is there a

108

43 # better way ?

109

44 <a class="py-name" href="pythonutils.configobj-module.html#BOM_LIST">BOM_LIST</a> = {

110

45 'utf_16': 'utf_16',

111

46 'u16': 'utf_16',

112

47 'utf16': 'utf_16',

113

48 'utf-16': 'utf_16',

114

49 'utf16_be': 'utf16_be',

115

50 'utf_16_be': 'utf16_be',

116

51 'utf-16be': 'utf16_be',

117

52 'utf16_le': 'utf16_le',

118

53 'utf_16_le': 'utf16_le',

119

54 'utf-16le': 'utf16_le',

120

55 'utf_8': 'utf_8',

121

56 'u8': 'utf_8',

122

57 'utf': 'utf_8',

123

58 'utf8': 'utf_8',

124

59 'utf-8': 'utf_8',

125

60 }

126

61

127

62 # Map of encodings to the BOM to write.

128

63 <a class="py-name" href="pythonutils.configobj-module.html#BOM_SET">BOM_SET</a> = {

129

64 'utf_8': BOM_UTF8,

130

65 'utf_16': BOM_UTF16,

131

66 'utf16_be': BOM_UTF16_BE,

132

67 'utf16_le': BOM_UTF16_LE,

133

68 None: BOM_UTF8

134

69 }

135

70

136

71 try:

137

72 from <a title="pythonutils.configobj.ConfigObj.validate" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#validate">validate</a> import VdtMissingValue

138

73 except ImportError:

139

74 VdtMissingValue = None

140

75

141

76 try:

142

77 <a title="pythonutils.configobj.enumerate" class="py-name" href="pythonutils.configobj-module.html#enumerate">enumerate</a>

143

78 except NameError:

144

79 def enumerate(obj):

145

80 """enumerate for Python 2.2."""

146

81 i = -1

147

82 for item in obj:

148

83 i += 1

149

84 yield i, item

150

</div> 85

151

86 try:

152

87 True, False

153

88 except NameError:

154

89 True, False = 1, 0

155

90

156

91

157

92 <a class="py-name" href="pythonutils.configobj-module.html#__version__">__version__</a> = '4.3.1'

158

93

159

94 <a class="py-name" href="pythonutils.configobj-module.html#__revision__">__revision__</a> = '$Id: configobj.py 156 2006-01-31 14:57:08Z fuzzyman $'

160

95

161

96 __docformat__ = "restructuredtext en"

162

97

163

98 # NOTE: Does it make sense to have the following in __all__ ?

164

99 # NOTE: DEFAULT_INDENT_TYPE, NUM_INDENT_SPACES, MAX_INTERPOL_DEPTH

165

100 # NOTE: If used via ``from configobj import...``

166

101 # NOTE: They are effectively read only

167

102 __all__ = (

168

103 '__version__',

169

104 'DEFAULT_INDENT_TYPE',

170

105 'NUM_INDENT_SPACES',

171

106 'MAX_INTERPOL_DEPTH',

172

107 'ConfigObjError',

173

108 'NestingError',

174

109 'ParseError',

175

110 'DuplicateError',

176

111 'ConfigspecError',

177

112 'ConfigObj',

178

113 'SimpleVal',

179

114 'InterpolationError',

180

115 'InterpolationDepthError',

181

116 'MissingInterpolationOption',

182

117 'RepeatSectionError',

183

118 'UnknownType',

184

119 '__docformat__',

185

120 'flatten_errors',

186

121 )

187

122

188

123 <a class="py-name" href="pythonutils.configobj-module.html#DEFAULT_INDENT_TYPE">DEFAULT_INDENT_TYPE</a> = ' '

189

124 <a class="py-name" href="pythonutils.configobj-module.html#NUM_INDENT_SPACES">NUM_INDENT_SPACES</a> = 4

190

125 <a class="py-name" href="pythonutils.configobj-module.html#MAX_INTERPOL_DEPTH">MAX_INTERPOL_DEPTH</a> = 10

191

126

192

127 <a class="py-name" href="pythonutils.configobj-module.html#OPTION_DEFAULTS">OPTION_DEFAULTS</a> = {

193

128 'interpolation': True,

194

129 'raise_errors': False,

195

130 'list_values': True,

196

131 'create_empty': False,

197

132 'file_error': False,

198

133 'configspec': None,

199

134 'stringify': True,

200

135 # option may be set to one of ('', ' ', '\t')

201

136 'indent_type': None,

202

137 'encoding': None,

203

138 'default_encoding': None,

204

139 'unrepr': False,

205

140 'write_empty_values': False,

206

141 }

207

142

208

143

209

<a name="getObj"></a><div id="getObj-def"> 144 <a class="pysrc-toggle" href="#" id="getObj-toggle" onclick="toggle('getObj'); return false;">-</a>def <a class="py-def-name" href="pythonutils.configobj-module.html#getObj">getObj</a>(s):

210

</div><div id="getObj-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="getObj-expanded"> 145 s = "a=" + s

211

146 p = compiler.parse(s)

212

147 return p.getChildren()[1].getChildren()[0].getChildren()[1]

213

</div> 148

214

<a name="UnknownType"></a><div id="UnknownType-def"> 149 <a class="pysrc-toggle" href="#" id="UnknownType-toggle" onclick="toggle('UnknownType'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.UnknownType-class.html">UnknownType</a>(Exception):

215

</div><div id="UnknownType-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="UnknownType-expanded"> 150 pass

216

</div> 151

217

<a name="Builder"></a><div id="Builder-def"> 152 <a class="pysrc-toggle" href="#" id="Builder-toggle" onclick="toggle('Builder'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.Builder-class.html">Builder</a>:

218

</div><div id="Builder-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Builder-expanded"> 153

219

<a name="Builder.build"></a><div id="Builder.build-def"> 154 <a class="pysrc-toggle" href="#" id="Builder.build-toggle" onclick="toggle('Builder.build'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build">build</a>(self, o):

220

</div><div id="Builder.build-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build-expanded"> 155 m = getattr(self, 'build_' + o.__class__.__name__, None)

221

156 if m is None:

222

157 raise <a title="pythonutils.configobj.UnknownType" class="py-name" href="pythonutils.configobj.UnknownType-class.html">UnknownType</a>(o.__class__.__name__)

223

158 return m(o)

224

</div> 159

225

<a name="Builder.build_List"></a><div id="Builder.build_List-def"> 160 <a class="pysrc-toggle" href="#" id="Builder.build_List-toggle" onclick="toggle('Builder.build_List'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_List">build_List</a>(self, o):

226

</div><div id="Builder.build_List-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_List-expanded"> 161 return map(self.<a title="pythonutils.configobj.Builder.build" class="py-name" href="pythonutils.configobj.Builder-class.html#build">build</a>, o.getChildren())

227

</div> 162

228

<a name="Builder.build_Const"></a><div id="Builder.build_Const-def"> 163 <a class="pysrc-toggle" href="#" id="Builder.build_Const-toggle" onclick="toggle('Builder.build_Const'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_Const">build_Const</a>(self, o):

229

</div><div id="Builder.build_Const-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_Const-expanded"> 164 return o.value

230

</div> 165

231

<a name="Builder.build_Dict"></a><div id="Builder.build_Dict-def"> 166 <a class="pysrc-toggle" href="#" id="Builder.build_Dict-toggle" onclick="toggle('Builder.build_Dict'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_Dict">build_Dict</a>(self, o):

232

</div><div id="Builder.build_Dict-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_Dict-expanded"> 167 d = {}

233

168 i = iter(map(self.<a title="pythonutils.configobj.Builder.build" class="py-name" href="pythonutils.configobj.Builder-class.html#build">build</a>, o.getChildren()))

234

169 for el in i:

235

170 d[el] = i.next()

236

171 return d

237

</div> 172

238

<a name="Builder.build_Tuple"></a><div id="Builder.build_Tuple-def"> 173 <a class="pysrc-toggle" href="#" id="Builder.build_Tuple-toggle" onclick="toggle('Builder.build_Tuple'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_Tuple">build_Tuple</a>(self, o):

239

</div><div id="Builder.build_Tuple-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_Tuple-expanded"> 174 return tuple(self.<a title="pythonutils.configobj.Builder.build_List" class="py-name" href="pythonutils.configobj.Builder-class.html#build_List">build_List</a>(o))

240

</div> 175

241

<a name="Builder.build_Name"></a><div id="Builder.build_Name-def"> 176 <a class="pysrc-toggle" href="#" id="Builder.build_Name-toggle" onclick="toggle('Builder.build_Name'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_Name">build_Name</a>(self, o):

242

</div><div id="Builder.build_Name-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_Name-expanded"> 177 if o.name == 'None':

243

178 return None

244

179 if o.name == 'True':

245

180 return True

246

181 if o.name == 'False':

247

182 return False

248

183

249

184 # An undefinted Name

250

185 raise <a title="pythonutils.configobj.UnknownType" class="py-name" href="pythonutils.configobj.UnknownType-class.html">UnknownType</a>('Undefined Name')

251

</div> 186

252

<a name="Builder.build_Add"></a><div id="Builder.build_Add-def"> 187 <a class="pysrc-toggle" href="#" id="Builder.build_Add-toggle" onclick="toggle('Builder.build_Add'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_Add">build_Add</a>(self, o):

253

</div><div id="Builder.build_Add-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_Add-expanded"> 188 real, imag = map(self.<a title="pythonutils.configobj.Builder.build_Const" class="py-name" href="pythonutils.configobj.Builder-class.html#build_Const">build_Const</a>, o.getChildren())

254

189 try:

255

190 real = float(real)

256

191 except TypeError:

257

192 raise <a title="pythonutils.configobj.UnknownType" class="py-name" href="pythonutils.configobj.UnknownType-class.html">UnknownType</a>('Add')

258

193 if not isinstance(imag, complex) or imag.real != 0.0:

259

194 raise <a title="pythonutils.configobj.UnknownType" class="py-name" href="pythonutils.configobj.UnknownType-class.html">UnknownType</a>('Add')

260

195 return real+imag

261

</div> 196

262

<a name="Builder.build_Getattr"></a><div id="Builder.build_Getattr-def"> 197 <a class="pysrc-toggle" href="#" id="Builder.build_Getattr-toggle" onclick="toggle('Builder.build_Getattr'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_Getattr">build_Getattr</a>(self, o):

263

</div><div id="Builder.build_Getattr-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_Getattr-expanded"> 198 parent = self.<a title="pythonutils.configobj.Builder.build" class="py-name" href="pythonutils.configobj.Builder-class.html#build">build</a>(o.expr)

264

199 return getattr(parent, o.attrname)

265

</div> 200

266

<a name="Builder.build_UnarySub"></a><div id="Builder.build_UnarySub-def"> 201 <a class="pysrc-toggle" href="#" id="Builder.build_UnarySub-toggle" onclick="toggle('Builder.build_UnarySub'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_UnarySub">build_UnarySub</a>(self, o):

267

</div><div id="Builder.build_UnarySub-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_UnarySub-expanded"> 202 return -self.<a title="pythonutils.configobj.Builder.build_Const" class="py-name" href="pythonutils.configobj.Builder-class.html#build_Const">build_Const</a>(o.getChildren()[0])

268

</div> 203

269

<a name="Builder.build_UnaryAdd"></a><div id="Builder.build_UnaryAdd-def"> 204 <a class="pysrc-toggle" href="#" id="Builder.build_UnaryAdd-toggle" onclick="toggle('Builder.build_UnaryAdd'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Builder-class.html#build_UnaryAdd">build_UnaryAdd</a>(self, o):

270

</div><div id="Builder.build_UnaryAdd-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Builder.build_UnaryAdd-expanded"> 205 return self.<a title="pythonutils.configobj.Builder.build_Const" class="py-name" href="pythonutils.configobj.Builder-class.html#build_Const">build_Const</a>(o.getChildren()[0])

271

</div></div> 206

272

<a name="unrepr"></a><div id="unrepr-def"> 207 <a class="pysrc-toggle" href="#" id="unrepr-toggle" onclick="toggle('unrepr'); return false;">-</a>def <a class="py-def-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>(s):

273

</div><div id="unrepr-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="unrepr-expanded"> 208 if not s:

274

209 return s

275

210 return <a title="pythonutils.configobj.Builder" class="py-name" href="pythonutils.configobj.Builder-class.html">Builder</a>().<a title="pythonutils.configobj.Builder.build" class="py-name" href="pythonutils.configobj.Builder-class.html#build">build</a>(<a title="pythonutils.configobj.getObj" class="py-name" href="pythonutils.configobj-module.html#getObj">getObj</a>(s))

276

</div> 211

277

212

278

<a name="ConfigObjError"></a><div id="ConfigObjError-def"> 213 <a class="pysrc-toggle" href="#" id="ConfigObjError-toggle" onclick="toggle('ConfigObjError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.ConfigObjError-class.html">ConfigObjError</a>(SyntaxError):

279

</div><div id="ConfigObjError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ConfigObjError-expanded"> 214 """

280

215 This is the base class for all errors that ConfigObj raises.

281

216 It is a subclass of SyntaxError.

282

217 """

283

<a name="ConfigObjError.__init__"></a><div id="ConfigObjError.__init__-def"> 218 <a class="pysrc-toggle" href="#" id="ConfigObjError.__init__-toggle" onclick="toggle('ConfigObjError.__init__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObjError-class.html#__init__">__init__</a>(self, message='', line_number=None, line=''):

284

</div><div id="ConfigObjError.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObjError.__init__-expanded"> 219 self.line = line

285

220 self.line_number = line_number

286

221 self.message = message

287

222 SyntaxError.<a title="pythonutils.configobj.ConfigObj.__init__

288

pythonutils.configobj.ConfigObjError.__init__

289

pythonutils.configobj.InterpolationDepthError.__init__

290

pythonutils.configobj.MissingInterpolationOption.__init__

291

pythonutils.configobj.Section.__init__

292

pythonutils.configobj.SimpleVal.__init__" class="py-name" href="#" onclick="doclink('link-0', '__init__', 'Method ConfigObj.__init__()=pythonutils.configobj.ConfigObj-class.html#__init__,Method __init__()=pythonutils.configobj.ConfigObjError-class.html#__init__,Method InterpolationDepthError.__init__()=pythonutils.configobj.InterpolationDepthError-class.html#__init__,Method MissingInterpolationOption.__init__()=pythonutils.configobj.MissingInterpolationOption-class.html#__init__,Method Section.__init__()=pythonutils.configobj.Section-class.html#__init__,Method SimpleVal.__init__()=pythonutils.configobj.SimpleVal-class.html#__init__'); return false;">__init__</a>(self, message)

293

</div></div> 223

294

<a name="NestingError"></a><div id="NestingError-def"> 224 <a class="pysrc-toggle" href="#" id="NestingError-toggle" onclick="toggle('NestingError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.NestingError-class.html">NestingError</a>(ConfigObjError):

295

</div><div id="NestingError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="NestingError-expanded"> 225 """

296

226 This error indicates a level of nesting that doesn't match.

297

227 """

298

</div> 228

299

<a name="ParseError"></a><div id="ParseError-def"> 229 <a class="pysrc-toggle" href="#" id="ParseError-toggle" onclick="toggle('ParseError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.ParseError-class.html">ParseError</a>(ConfigObjError):

300

</div><div id="ParseError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ParseError-expanded"> 230 """

301

231 This error indicates that a line is badly written.

302

232 It is neither a valid ``key = value`` line,

303

233 nor a valid section marker line.

304

234 """

305

</div> 235

306

<a name="DuplicateError"></a><div id="DuplicateError-def"> 236 <a class="pysrc-toggle" href="#" id="DuplicateError-toggle" onclick="toggle('DuplicateError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.DuplicateError-class.html">DuplicateError</a>(ConfigObjError):

307

</div><div id="DuplicateError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="DuplicateError-expanded"> 237 """

308

238 The keyword or section specified already exists.

309

239 """

310

</div> 240

311

<a name="ConfigspecError"></a><div id="ConfigspecError-def"> 241 <a class="pysrc-toggle" href="#" id="ConfigspecError-toggle" onclick="toggle('ConfigspecError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.ConfigspecError-class.html">ConfigspecError</a>(ConfigObjError):

312

</div><div id="ConfigspecError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ConfigspecError-expanded"> 242 """

313

243 An error occured whilst parsing a configspec.

314

244 """

315

</div> 245

316

<a name="InterpolationError"></a><div id="InterpolationError-def"> 246 <a class="pysrc-toggle" href="#" id="InterpolationError-toggle" onclick="toggle('InterpolationError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.InterpolationError-class.html">InterpolationError</a>(ConfigObjError):

317

</div><div id="InterpolationError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="InterpolationError-expanded"> 247 """Base class for the two interpolation errors."""

318

</div> 248

319

<a name="InterpolationDepthError"></a><div id="InterpolationDepthError-def"> 249 <a class="pysrc-toggle" href="#" id="InterpolationDepthError-toggle" onclick="toggle('InterpolationDepthError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.InterpolationDepthError-class.html">InterpolationDepthError</a>(InterpolationError):

320

</div><div id="InterpolationDepthError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="InterpolationDepthError-expanded"> 250 """Maximum interpolation depth exceeded in string interpolation."""

321

251

322

<a name="InterpolationDepthError.__init__"></a><div id="InterpolationDepthError.__init__-def"> 252 <a class="pysrc-toggle" href="#" id="InterpolationDepthError.__init__-toggle" onclick="toggle('InterpolationDepthError.__init__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.InterpolationDepthError-class.html#__init__">__init__</a>(self, option):

323

</div><div id="InterpolationDepthError.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="InterpolationDepthError.__init__-expanded"> 253 <a title="pythonutils.configobj.InterpolationError" class="py-name" href="pythonutils.configobj.InterpolationError-class.html">InterpolationError</a>.<a title="pythonutils.configobj.ConfigObj.__init__

324

pythonutils.configobj.ConfigObjError.__init__

325

pythonutils.configobj.InterpolationDepthError.__init__

326

pythonutils.configobj.MissingInterpolationOption.__init__

327

pythonutils.configobj.Section.__init__

328

pythonutils.configobj.SimpleVal.__init__" class="py-name" href="#" onclick="doclink('link-1', '__init__', 'Method ConfigObj.__init__()=pythonutils.configobj.ConfigObj-class.html#__init__,Method ConfigObjError.__init__()=pythonutils.configobj.ConfigObjError-class.html#__init__,Method __init__()=pythonutils.configobj.InterpolationDepthError-class.html#__init__,Method MissingInterpolationOption.__init__()=pythonutils.configobj.MissingInterpolationOption-class.html#__init__,Method Section.__init__()=pythonutils.configobj.Section-class.html#__init__,Method SimpleVal.__init__()=pythonutils.configobj.SimpleVal-class.html#__init__'); return false;">__init__</a>(

329

254 self,

330

255 'max interpolation depth exceeded in value "%s".' % option)

331

</div></div> 256

332

<a name="RepeatSectionError"></a><div id="RepeatSectionError-def"> 257 <a class="pysrc-toggle" href="#" id="RepeatSectionError-toggle" onclick="toggle('RepeatSectionError'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.RepeatSectionError-class.html">RepeatSectionError</a>(ConfigObjError):

333

</div><div id="RepeatSectionError-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="RepeatSectionError-expanded"> 258 """

334

259 This error indicates additional sections in a section with a

335

260 ``__many__`` (repeated) section.

336

261 """

337

</div> 262

338

<a name="MissingInterpolationOption"></a><div id="MissingInterpolationOption-def"> 263 <a class="pysrc-toggle" href="#" id="MissingInterpolationOption-toggle" onclick="toggle('MissingInterpolationOption'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.MissingInterpolationOption-class.html">MissingInterpolationOption</a>(InterpolationError):

339

</div><div id="MissingInterpolationOption-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="MissingInterpolationOption-expanded"> 264 """A value specified for interpolation was missing."""

340

265

341

<a name="MissingInterpolationOption.__init__"></a><div id="MissingInterpolationOption.__init__-def"> 266 <a class="pysrc-toggle" href="#" id="MissingInterpolationOption.__init__-toggle" onclick="toggle('MissingInterpolationOption.__init__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.MissingInterpolationOption-class.html#__init__">__init__</a>(self, option):

342

</div><div id="MissingInterpolationOption.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="MissingInterpolationOption.__init__-expanded"> 267 <a title="pythonutils.configobj.InterpolationError" class="py-name" href="pythonutils.configobj.InterpolationError-class.html">InterpolationError</a>.<a title="pythonutils.configobj.ConfigObj.__init__

343

pythonutils.configobj.ConfigObjError.__init__

344

pythonutils.configobj.InterpolationDepthError.__init__

345

pythonutils.configobj.MissingInterpolationOption.__init__

346

pythonutils.configobj.Section.__init__

347

pythonutils.configobj.SimpleVal.__init__" class="py-name" href="#" onclick="doclink('link-2', '__init__', 'Method ConfigObj.__init__()=pythonutils.configobj.ConfigObj-class.html#__init__,Method ConfigObjError.__init__()=pythonutils.configobj.ConfigObjError-class.html#__init__,Method InterpolationDepthError.__init__()=pythonutils.configobj.InterpolationDepthError-class.html#__init__,Method __init__()=pythonutils.configobj.MissingInterpolationOption-class.html#__init__,Method Section.__init__()=pythonutils.configobj.Section-class.html#__init__,Method SimpleVal.__init__()=pythonutils.configobj.SimpleVal-class.html#__init__'); return false;">__init__</a>(

348

268 self,

349

269 'missing option "%s" in interpolation.' % option)

350

</div></div> 270

351

<a name="Section"></a><div id="Section-def"> 271 <a class="pysrc-toggle" href="#" id="Section-toggle" onclick="toggle('Section'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.Section-class.html">Section</a>(dict):

352

</div><div id="Section-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="Section-expanded"> 272 """

353

273 A dictionary-like object that represents a section in a config file.

354

274

355

275 It does string interpolation if the 'interpolate' attribute

356

276 of the 'main' object is set to True.

357

277

358

278 Interpolation is tried first from the 'DEFAULT' section of this object,

359

279 next from the 'DEFAULT' section of the parent, lastly the main object.

360

280

361

281 A Section will behave like an ordered dictionary - following the

362

282 order of the ``scalars`` and ``sections`` attributes.

363

283 You can use this to change the order of members.

364

284

365

285 Iteration follows the order: scalars, then sections.

366

286 """

367

287

368

288 <a class="py-name" href="pythonutils.configobj.Section-class.html#_KEYCRE">_KEYCRE</a> = re.compile(r"%$([^)]*)$s|.")

369

289

370

<a name="Section.__init__"></a><div id="Section.__init__-def"> 290 <a class="pysrc-toggle" href="#" id="Section.__init__-toggle" onclick="toggle('Section.__init__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#__init__">__init__</a>(self, parent, depth, main, indict=None, name=None):

371

</div><div id="Section.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.__init__-expanded"> 291 """

372

292 * parent is the section above

373

293 * depth is the depth level of this section

374

294 * main is the main ConfigObj

375

295 * indict is a dictionary to initialise the section with

376

296 """

377

297 if indict is None:

378

298 indict = {}

379

299 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.ConfigObj.__init__

380

pythonutils.configobj.ConfigObjError.__init__

381

pythonutils.configobj.InterpolationDepthError.__init__

382

pythonutils.configobj.MissingInterpolationOption.__init__

383

pythonutils.configobj.Section.__init__

384

pythonutils.configobj.SimpleVal.__init__" class="py-name" href="#" onclick="doclink('link-3', '__init__', 'Method ConfigObj.__init__()=pythonutils.configobj.ConfigObj-class.html#__init__,Method ConfigObjError.__init__()=pythonutils.configobj.ConfigObjError-class.html#__init__,Method InterpolationDepthError.__init__()=pythonutils.configobj.InterpolationDepthError-class.html#__init__,Method MissingInterpolationOption.__init__()=pythonutils.configobj.MissingInterpolationOption-class.html#__init__,Method __init__()=pythonutils.configobj.Section-class.html#__init__,Method SimpleVal.__init__()=pythonutils.configobj.SimpleVal-class.html#__init__'); return false;">__init__</a>(self)

385

300 # used for nesting level *and* interpolation

386

301 self.parent = parent

387

302 # used for the interpolation attribute

388

303 self.main = main

389

304 # level of nesting depth of this Section

390

305 self.depth = depth

391

306 # the sequence of scalar values in this Section

392

307 self.scalars = []

393

308 # the sequence of sections in this Section

394

309 self.sections = []

395

310 # purely for information

396

311 self.name = name

397

312 # for comments :-)

398

313 self.comments = {}

399

314 self.inline_comments = {}

400

315 # for the configspec

401

316 self.configspec = {}

402

317 self._order = []

403

318 self._configspec_comments = {}

404

319 self._configspec_inline_comments = {}

405

320 self._cs_section_comments = {}

406

321 self._cs_section_inline_comments = {}

407

322 # for defaults

408

323 self.defaults = []

409

324 #

410

325 # we do this explicitly so that __setitem__ is used properly

411

326 # (rather than just passing to ``dict.__init__``)

412

327 for entry in indict:

413

328 self[entry] = indict[entry]

414

</div> 329

415

<a name="Section._interpolate"></a><div id="Section._interpolate-def"> 330 <a class="pysrc-toggle" href="#" id="Section._interpolate-toggle" onclick="toggle('Section._interpolate'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#_interpolate">_interpolate</a>(self, value):

416

</div><div id="Section._interpolate-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section._interpolate-expanded"> 331 """Nicked from ConfigParser."""

417

332 depth = <a title="pythonutils.configobj.MAX_INTERPOL_DEPTH" class="py-name" href="pythonutils.configobj-module.html#MAX_INTERPOL_DEPTH">MAX_INTERPOL_DEPTH</a>

418

333 # loop through this until it's done

419

334 while depth:

420

335 depth -= 1

421

336 if value.find("%(") != -1:

422

337 value = self.<a title="pythonutils.configobj.Section._KEYCRE" class="py-name" href="pythonutils.configobj.Section-class.html#_KEYCRE">_KEYCRE</a>.sub(self.<a title="pythonutils.configobj.Section._interpolation_replace" class="py-name" href="pythonutils.configobj.Section-class.html#_interpolation_replace">_interpolation_replace</a>, value)

423

338 else:

424

339 break

425

340 else:

426

341 raise <a title="pythonutils.configobj.InterpolationDepthError" class="py-name" href="pythonutils.configobj.InterpolationDepthError-class.html">InterpolationDepthError</a>(value)

427

342 return value

428

</div> 343

429

<a name="Section._interpolation_replace"></a><div id="Section._interpolation_replace-def"> 344 <a class="pysrc-toggle" href="#" id="Section._interpolation_replace-toggle" onclick="toggle('Section._interpolation_replace'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#_interpolation_replace">_interpolation_replace</a>(self, match):

430

</div><div id="Section._interpolation_replace-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section._interpolation_replace-expanded"> 345 """ """

431

346 s = match.group(1)

432

347 if s is None:

433

348 return match.group()

434

349 else:

435

350 # switch off interpolation before we try and fetch anything !

436

351 self.main.interpolation = False

437

352 # try the 'DEFAULT' member of *this section* first

438

353 val = self.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>('DEFAULT', {}).<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(s)

439

354 # try the 'DEFAULT' member of the *parent section* next

440

355 if val is None:

441

356 val = self.parent.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>('DEFAULT', {}).<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(s)

442

357 # last, try the 'DEFAULT' member of the *main section*

443

358 if val is None:

444

359 val = self.main.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>('DEFAULT', {}).<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(s)

445

360 self.main.interpolation = True

446

361 if val is None:

447

362 raise <a title="pythonutils.configobj.MissingInterpolationOption" class="py-name" href="pythonutils.configobj.MissingInterpolationOption-class.html">MissingInterpolationOption</a>(s)

448

363 return val

449

</div> 364

450

<a name="Section.__getitem__"></a><div id="Section.__getitem__-def"> 365 <a class="pysrc-toggle" href="#" id="Section.__getitem__-toggle" onclick="toggle('Section.__getitem__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#__getitem__">__getitem__</a>(self, key):

451

</div><div id="Section.__getitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.__getitem__-expanded"> 366 """Fetch the item and do string interpolation."""

452

367 val = <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.__getitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__getitem__">__getitem__</a>(self, key)

453

368 if self.main.interpolation and isinstance(val, StringTypes):

454

369 return self.<a title="pythonutils.configobj.Section._interpolate" class="py-name" href="pythonutils.configobj.Section-class.html#_interpolate">_interpolate</a>(val)

455

370 return val

456

</div> 371

457

<a name="Section.__setitem__"></a><div id="Section.__setitem__-def"> 372 <a class="pysrc-toggle" href="#" id="Section.__setitem__-toggle" onclick="toggle('Section.__setitem__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#__setitem__">__setitem__</a>(self, key, value, unrepr=False):

458

</div><div id="Section.__setitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.__setitem__-expanded"> 373 """

459

374 Correctly set a value.

460

375

461

376 Making dictionary values Section instances.

462

377 (We have to special case 'Section' instances - which are also dicts)

463

378

464

379 Keys must be strings.

465

380 Values need only be strings (or lists of strings) if

466

381 ``main.stringify`` is set.

467

382

468

383 `unrepr`` must be set when setting a value to a dictionary, without

469

384 creating a new sub-section.

470

385 """

471

386 if not isinstance(key, StringTypes):

472

387 raise ValueError, 'The key "%s" is not a string.' % key

473

388 # add the comment

474

389 if not self.comments.has_key(key):

475

390 self.comments[key] = []

476

391 self.inline_comments[key] = ''

477

392 # remove the entry from defaults

478

393 if key in self.defaults:

479

394 self.defaults.remove(key)

480

395 #

481

396 if isinstance(value, <a title="pythonutils.configobj.Section" class="py-name" href="pythonutils.configobj.Section-class.html">Section</a>):

482

397 if not self.has_key(key):

483

398 self.sections.append(key)

484

399 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.__setitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__setitem__">__setitem__</a>(self, key, value)

485

400 elif isinstance(value, <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>)and not <a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>:

486

401 # First create the new depth level,

487

402 # then create the section

488

403 if not self.has_key(key):

489

404 self.sections.append(key)

490

405 new_depth = self.depth + 1

491

406 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.__setitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__setitem__">__setitem__</a>(

492

407 self,

493

408 key,

494

409 <a title="pythonutils.configobj.Section" class="py-name" href="pythonutils.configobj.Section-class.html">Section</a>(

495

410 self,

496

411 new_depth,

497

412 self.main,

498

413 indict=value,

499

414 name=key))

500

415 else:

501

416 if not self.has_key(key):

502

417 self.scalars.append(key)

503

418 if not self.main.stringify:

504

419 if isinstance(value, StringTypes):

505

420 pass

506

421 elif isinstance(value, (list, tuple)):

507

422 for entry in value:

508

423 if not isinstance(entry, StringTypes):

509

424 raise TypeError, (

510

425 'Value is not a string "%s".' % entry)

511

426 else:

512

427 raise TypeError, 'Value is not a string "%s".' % value

513

428 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.__setitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__setitem__">__setitem__</a>(self, key, value)

514

</div> 429

515

<a name="Section.__delitem__"></a><div id="Section.__delitem__-def"> 430 <a class="pysrc-toggle" href="#" id="Section.__delitem__-toggle" onclick="toggle('Section.__delitem__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#__delitem__">__delitem__</a>(self, key):

516

</div><div id="Section.__delitem__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.__delitem__-expanded"> 431 """Remove items from the sequence when deleting."""

517

432 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>. <a title="pythonutils.configobj.Section.__delitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__delitem__">__delitem__</a>(self, key)

518

433 if key in self.scalars:

519

434 self.scalars.remove(key)

520

435 else:

521

436 self.sections.remove(key)

522

437 del self.comments[key]

523

438 del self.inline_comments[key]

524

</div> 439

525

<a name="Section.get"></a><div id="Section.get-def"> 440 <a class="pysrc-toggle" href="#" id="Section.get-toggle" onclick="toggle('Section.get'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#get">get</a>(self, key, default=None):

526

</div><div id="Section.get-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.get-expanded"> 441 """A version of ``get`` that doesn't bypass string interpolation."""

527

442 try:

528

443 return self[key]

529

444 except KeyError:

530

445 return default

531

</div> 446

532

<a name="Section.update"></a><div id="Section.update-def"> 447 <a class="pysrc-toggle" href="#" id="Section.update-toggle" onclick="toggle('Section.update'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#update">update</a>(self, indict):

533

</div><div id="Section.update-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.update-expanded"> 448 """

534

449 A version of update that uses our ``__setitem__``.

535

450 """

536

451 for entry in indict:

537

452 self[entry] = indict[entry]

538

</div> 453

539

<a name="Section.pop"></a><div id="Section.pop-def"> 454 <a class="pysrc-toggle" href="#" id="Section.pop-toggle" onclick="toggle('Section.pop'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#pop">pop</a>(self, key, *args):

540

</div><div id="Section.pop-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.pop-expanded"> 455 """ """

541

456 val = <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.pop" class="py-name" href="pythonutils.configobj.Section-class.html#pop">pop</a>(self, key, *args)

542

457 if key in self.scalars:

543

458 del self.comments[key]

544

459 del self.inline_comments[key]

545

460 self.scalars.remove(key)

546

461 elif key in self.sections:

547

462 del self.comments[key]

548

463 del self.inline_comments[key]

549

464 self.sections.remove(key)

550

465 if self.main.interpolation and isinstance(val, StringTypes):

551

466 return self.<a title="pythonutils.configobj.Section._interpolate" class="py-name" href="pythonutils.configobj.Section-class.html#_interpolate">_interpolate</a>(val)

552

467 return val

553

</div> 468

554

<a name="Section.popitem"></a><div id="Section.popitem-def"> 469 <a class="pysrc-toggle" href="#" id="Section.popitem-toggle" onclick="toggle('Section.popitem'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#popitem">popitem</a>(self):

555

</div><div id="Section.popitem-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.popitem-expanded"> 470 """Pops the first (key,val)"""

556

471 sequence = (self.scalars + self.sections)

557

472 if not sequence:

558

473 raise KeyError, ": 'popitem(): dictionary is empty'"

559

474 key = sequence[0]

560

475 val = self[key]

561

476 del self[key]

562

477 return key, val

563

</div> 478

564

<a name="Section.clear"></a><div id="Section.clear-def"> 479 <a class="pysrc-toggle" href="#" id="Section.clear-toggle" onclick="toggle('Section.clear'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#clear">clear</a>(self):

565

</div><div id="Section.clear-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.clear-expanded"> 480 """

566

481 A version of clear that also affects scalars/sections

567

482 Also clears comments and configspec.

568

483

569

484 Leaves other attributes alone :

570

485 depth/main/parent are not affected

571

486 """

572

487 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.clear" class="py-name" href="pythonutils.configobj.Section-class.html#clear">clear</a>(self)

573

488 self.scalars = []

574

489 self.sections = []

575

490 self.comments = {}

576

491 self.inline_comments = {}

577

492 self.configspec = {}

578

</div> 493

579

<a name="Section.setdefault"></a><div id="Section.setdefault-def"> 494 <a class="pysrc-toggle" href="#" id="Section.setdefault-toggle" onclick="toggle('Section.setdefault'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#setdefault">setdefault</a>(self, key, default=None):

580

</div><div id="Section.setdefault-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.setdefault-expanded"> 495 """A version of setdefault that sets sequence if appropriate."""

581

496 try:

582

497 return self[key]

583

498 except KeyError:

584

499 self[key] = default

585

500 return self[key]

586

</div> 501

587

<a name="Section.items"></a><div id="Section.items-def"> 502 <a class="pysrc-toggle" href="#" id="Section.items-toggle" onclick="toggle('Section.items'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#items">items</a>(self):

588

</div><div id="Section.items-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.items-expanded"> 503 """ """

589

504 return zip((self.scalars + self.sections), self.<a title="pythonutils.configobj.Section.values" class="py-name" href="pythonutils.configobj.Section-class.html#values">values</a>())

590

</div> 505

591

<a name="Section.keys"></a><div id="Section.keys-def"> 506 <a class="pysrc-toggle" href="#" id="Section.keys-toggle" onclick="toggle('Section.keys'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#keys">keys</a>(self):

592

</div><div id="Section.keys-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.keys-expanded"> 507 """ """

593

508 return (self.scalars + self.sections)

594

</div> 509

595

<a name="Section.values"></a><div id="Section.values-def"> 510 <a class="pysrc-toggle" href="#" id="Section.values-toggle" onclick="toggle('Section.values'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#values">values</a>(self):

596

</div><div id="Section.values-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.values-expanded"> 511 """ """

597

512 return [self[key] for key in (self.scalars + self.sections)]

598

</div> 513

599

<a name="Section.iteritems"></a><div id="Section.iteritems-def"> 514 <a class="pysrc-toggle" href="#" id="Section.iteritems-toggle" onclick="toggle('Section.iteritems'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#iteritems">iteritems</a>(self):

600

</div><div id="Section.iteritems-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.iteritems-expanded"> 515 """ """

601

516 return iter(self.<a title="pythonutils.configobj.Section.items" class="py-name" href="pythonutils.configobj.Section-class.html#items">items</a>())

602

</div> 517

603

<a name="Section.iterkeys"></a><div id="Section.iterkeys-def"> 518 <a class="pysrc-toggle" href="#" id="Section.iterkeys-toggle" onclick="toggle('Section.iterkeys'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#iterkeys">iterkeys</a>(self):

604

</div><div id="Section.iterkeys-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.iterkeys-expanded"> 519 """ """

605

520 return iter((self.scalars + self.sections))

606

</div> 521

607

522 <a class="py-name" href="pythonutils.configobj.Section-class.html#__iter__">__iter__</a> = <a class="py-name" href="pythonutils.configobj.Section-class.html#iterkeys">iterkeys</a>

608

523

609

<a name="Section.itervalues"></a><div id="Section.itervalues-def"> 524 <a class="pysrc-toggle" href="#" id="Section.itervalues-toggle" onclick="toggle('Section.itervalues'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#itervalues">itervalues</a>(self):

610

</div><div id="Section.itervalues-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.itervalues-expanded"> 525 """ """

611

526 return iter(self.<a title="pythonutils.configobj.Section.values" class="py-name" href="pythonutils.configobj.Section-class.html#values">values</a>())

612

</div> 527

613

<a name="Section.__repr__"></a><div id="Section.__repr__-def"> 528 <a class="pysrc-toggle" href="#" id="Section.__repr__-toggle" onclick="toggle('Section.__repr__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#__repr__">__repr__</a>(self):

614

</div><div id="Section.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.__repr__-expanded"> 529 return '{%s}' % ', '.join([('%s: %s' % (repr(key), repr(self[key])))

615

530 for key in (self.scalars + self.sections)])

616

</div> 531

617

532 <a class="py-name" href="pythonutils.configobj.Section-class.html#__str__">__str__</a> = <a class="py-name" href="pythonutils.configobj.Section-class.html#__repr__">__repr__</a>

618

533

619

534 # Extra methods - not in a normal dictionary

620

535

621

<a name="Section.dict"></a><div id="Section.dict-def"> 536 <a class="pysrc-toggle" href="#" id="Section.dict-toggle" onclick="toggle('Section.dict'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>(self):

622

</div><div id="Section.dict-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.dict-expanded"> 537 """

623

538 Return a deepcopy of self as a dictionary.

624

539

625

540 All members that are ``Section`` instances are recursively turned to

626

541 ordinary dictionaries - by calling their ``dict`` method.

627

542

628

543 >>> n = a.dict()

629

544 >>> n == a

630

545 1

631

546 >>> n is a

632

547 0

633

548 """

634

549 newdict = {}

635

550 for entry in self:

636

551 this_entry = self[entry]

637

552 if isinstance(this_entry, <a title="pythonutils.configobj.Section" class="py-name" href="pythonutils.configobj.Section-class.html">Section</a>):

638

553 this_entry = this_entry.<a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>()

639

554 elif isinstance(this_entry, list):

640

555 # create a copy rather than a reference

641

556 this_entry = list(this_entry)

642

557 elif isinstance(this_entry, tuple):

643

558 # create a copy rather than a reference

644

559 this_entry = tuple(this_entry)

645

560 newdict[entry] = this_entry

646

561 return newdict

647

</div> 562

648

<a name="Section.merge"></a><div id="Section.merge-def"> 563 <a class="pysrc-toggle" href="#" id="Section.merge-toggle" onclick="toggle('Section.merge'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#merge">merge</a>(self, indict):

649

</div><div id="Section.merge-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.merge-expanded"> 564 """

650

565 A recursive update - useful for merging config files.

651

566

652

567 >>> a = '''[section1]

653

568 ... option1 = True

654

569 ... [[subsection]]

655

570 ... more_options = False

656

571 ... # end of file'''.splitlines()

657

572 >>> b = '''# File is user.ini

658

573 ... [section1]

659

574 ... option1 = False

660

575 ... # end of file'''.splitlines()

661

576 >>> c1 = ConfigObj(b)

662

577 >>> c2 = ConfigObj(a)

663

578 >>> c2.merge(c1)

664

579 >>> c2

665

580 {'section1': {'option1': 'False', 'subsection': {'more_options': 'False'}}}

666

581 """

667

582 for key, val in indict.<a title="pythonutils.configobj.Section.items" class="py-name" href="pythonutils.configobj.Section-class.html#items">items</a>():

668

583 if (key in self and isinstance(self[key], <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>) and

669

584 isinstance(val, <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>)):

670

585 self[key].<a title="pythonutils.configobj.Section.merge" class="py-name" href="pythonutils.configobj.Section-class.html#merge">merge</a>(val)

671

586 else:

672

587 self[key] = val

673

</div> 588

674

<a name="Section.rename"></a><div id="Section.rename-def"> 589 <a class="pysrc-toggle" href="#" id="Section.rename-toggle" onclick="toggle('Section.rename'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#rename">rename</a>(self, oldkey, newkey):

675

</div><div id="Section.rename-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.rename-expanded"> 590 """

676

591 Change a keyname to another, without changing position in sequence.

677

592

678

593 Implemented so that transformations can be made on keys,

679

594 as well as on values. (used by encode and decode)

680

595

681

596 Also renames comments.

682

597 """

683

598 if oldkey in self.scalars:

684

599 the_list = self.scalars

685

600 elif oldkey in self.sections:

686

601 the_list = self.sections

687

602 else:

688

603 raise KeyError, 'Key "%s" not found.' % oldkey

689

604 pos = the_list.index(oldkey)

690

605 #

691

606 val = self[oldkey]

692

607 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.__delitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__delitem__">__delitem__</a>(self, oldkey)

693

608 <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>.<a title="pythonutils.configobj.Section.__setitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__setitem__">__setitem__</a>(self, newkey, val)

694

609 the_list.remove(oldkey)

695

610 the_list.insert(pos, newkey)

696

611 comm = self.comments[oldkey]

697

612 inline_comment = self.inline_comments[oldkey]

698

613 del self.comments[oldkey]

699

614 del self.inline_comments[oldkey]

700

615 self.comments[newkey] = comm

701

616 self.inline_comments[newkey] = inline_comment

702

</div> 617

703

<a name="Section.walk"></a><div id="Section.walk-def"> 618 <a class="pysrc-toggle" href="#" id="Section.walk-toggle" onclick="toggle('Section.walk'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#walk">walk</a>(self, function, raise_errors=True,

704

619 call_on_sections=False, **keywargs):

705

</div><div id="Section.walk-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.walk-expanded"> 620 """

706

621 Walk every member and call a function on the keyword and value.

707

622

708

623 Return a dictionary of the return values

709

624

710

625 If the function raises an exception, raise the errror

711

626 unless ``raise_errors=False``, in which case set the return value to

712

627 ``False``.

713

628

714

629 Any unrecognised keyword arguments you pass to walk, will be pased on

715

630 to the function you pass in.

716

631

717

632 Note: if ``call_on_sections`` is ``True`` then - on encountering a

718

633 subsection, *first* the function is called for the *whole* subsection,

719

634 and then recurses into it's members. This means your function must be

720

635 able to handle strings, dictionaries and lists. This allows you

721

636 to change the key of subsections as well as for ordinary members. The

722

637 return value when called on the whole subsection has to be discarded.

723

638

724

639 See the encode and decode methods for examples, including functions.

725

640

726

641 .. caution::

727

642

728

643 You can use ``walk`` to transform the names of members of a section

729

644 but you mustn't add or delete members.

730

645

731

646 >>> config = '''[XXXXsection]

732

647 ... XXXXkey = XXXXvalue'''.splitlines()

733

648 >>> cfg = ConfigObj(config)

734

649 >>> cfg

735

650 {'XXXXsection': {'XXXXkey': 'XXXXvalue'}}

736

651 >>> def transform(section, key):

737

652 ... val = section[key]

738

653 ... newkey = key.replace('XXXX', 'CLIENT1')

739

654 ... section.rename(key, newkey)

740

655 ... if isinstance(val, (tuple, list, dict)):

741

656 ... pass

742

657 ... else:

743

658 ... val = val.replace('XXXX', 'CLIENT1')

744

659 ... section[newkey] = val

745

660 >>> cfg.walk(transform, call_on_sections=True)

746

661 {'CLIENT1section': {'CLIENT1key': None}}

747

662 >>> cfg

748

663 {'CLIENT1section': {'CLIENT1key': 'CLIENT1value'}}

749

664 """

750

665 out = {}

751

666 # scalars first

752

667 for i in range(len(self.scalars)):

753

668 entry = self.scalars[i]

754

669 try:

755

670 val = function(self, entry, **keywargs)

756

671 # bound again in case name has changed

757

672 entry = self.scalars[i]

758

673 out[entry] = val

759

674 except Exception:

760

675 if raise_errors:

761

676 raise

762

677 else:

763

678 entry = self.scalars[i]

764

679 out[entry] = False

765

680 # then sections

766

681 for i in range(len(self.sections)):

767

682 entry = self.sections[i]

768

683 if call_on_sections:

769

684 try:

770

685 function(self, entry, **keywargs)

771

686 except Exception:

772

687 if raise_errors:

773

688 raise

774

689 else:

775

690 entry = self.sections[i]

776

691 out[entry] = False

777

692 # bound again in case name has changed

778

693 entry = self.sections[i]

779

694 # previous result is discarded

780

695 out[entry] = self[entry].<a title="pythonutils.configobj.Section.walk" class="py-name" href="pythonutils.configobj.Section-class.html#walk">walk</a>(

781

696 function,

782

697 raise_errors=raise_errors,

783

698 call_on_sections=call_on_sections,

784

699 **keywargs)

785

700 return out

786

</div> 701

787

<a name="Section.decode"></a><div id="Section.decode-def"> 702 <a class="pysrc-toggle" href="#" id="Section.decode-toggle" onclick="toggle('Section.decode'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>(self, encoding):

788

</div><div id="Section.decode-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.decode-expanded"> 703 """

789

704 Decode all strings and values to unicode, using the specified encoding.

790

705

791

706 Works with subsections and list values.

792

707

793

708 Uses the ``walk`` method.

794

709

795

710 Testing ``encode`` and ``decode``.

796

711 >>> m = ConfigObj(a)

797

712 >>> m.decode('ascii')

798

713 >>> def testuni(val):

799

714 ... for entry in val:

800

715 ... if not isinstance(entry, unicode):

801

716 ... print >> sys.stderr, type(entry)

802

717 ... raise AssertionError, 'decode failed.'

803

718 ... if isinstance(val[entry], dict):

804

719 ... testuni(val[entry])

805

720 ... elif not isinstance(val[entry], unicode):

806

721 ... raise AssertionError, 'decode failed.'

807

722 >>> testuni(m)

808

723 >>> m.encode('ascii')

809

724 >>> a == m

810

725 1

811

726 """

812

727 warn('use of ``decode`` is deprecated.', DeprecationWarning)

813

<a name="Section.decode.decode"></a><div id="Section.decode.decode-def"> 728 <a class="pysrc-toggle" href="#" id="Section.decode.decode-toggle" onclick="toggle('Section.decode.decode'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section.decode-class.html#decode">decode</a>(section, key, encoding=encoding, warn=True):

814

</div><div id="Section.decode.decode-collapsed" style="display:none;" pad="++++" indent="++++++++++++++++"></div><div id="Section.decode.decode-expanded"> 729 """ """

815

730 val = section[key]

816

731 if isinstance(val, (list, tuple)):

817

732 newval = []

818

733 for entry in val:

819

734 newval.append(entry.<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>(encoding))

820

735 elif isinstance(val, <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>):

821

736 newval = val

822

737 else:

823

738 newval = val.<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>(encoding)

824

739 newkey = key.<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>(encoding)

825

740 section.<a title="pythonutils.configobj.Section.rename" class="py-name" href="pythonutils.configobj.Section-class.html#rename">rename</a>(key, newkey)

826

741 section[newkey] = newval

827

</div> 742 # using ``call_on_sections`` allows us to modify section names

828

743 self.<a title="pythonutils.configobj.Section.walk" class="py-name" href="pythonutils.configobj.Section-class.html#walk">walk</a>(<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>, call_on_sections=True)

829

</div> 744

830

<a name="Section.encode"></a><div id="Section.encode-def"> 745 <a class="pysrc-toggle" href="#" id="Section.encode-toggle" onclick="toggle('Section.encode'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#encode">encode</a>(self, encoding):

831

</div><div id="Section.encode-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.encode-expanded"> 746 """

832

747 Encode all strings and values from unicode,

833

748 using the specified encoding.

834

749

835

750 Works with subsections and list values.

836

751 Uses the ``walk`` method.

837

752 """

838

753 warn('use of ``encode`` is deprecated.', DeprecationWarning)

839

<a name="Section.encode.encode"></a><div id="Section.encode.encode-def"> 754 <a class="pysrc-toggle" href="#" id="Section.encode.encode-toggle" onclick="toggle('Section.encode.encode'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section.encode-class.html#encode">encode</a>(section, key, encoding=encoding):

840

</div><div id="Section.encode.encode-collapsed" style="display:none;" pad="++++" indent="++++++++++++++++"></div><div id="Section.encode.encode-expanded"> 755 """ """

841

756 val = section[key]

842

757 if isinstance(val, (list, tuple)):

843

758 newval = []

844

759 for entry in val:

845

760 newval.append(entry.<a title="pythonutils.configobj.Section.encode" class="py-name" href="pythonutils.configobj.Section-class.html#encode">encode</a>(encoding))

846

761 elif isinstance(val, <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>):

847

762 newval = val

848

763 else:

849

764 newval = val.<a title="pythonutils.configobj.Section.encode" class="py-name" href="pythonutils.configobj.Section-class.html#encode">encode</a>(encoding)

850

765 newkey = key.<a title="pythonutils.configobj.Section.encode" class="py-name" href="pythonutils.configobj.Section-class.html#encode">encode</a>(encoding)

851

766 section.<a title="pythonutils.configobj.Section.rename" class="py-name" href="pythonutils.configobj.Section-class.html#rename">rename</a>(key, newkey)

852

767 section[newkey] = newval

853

</div> 768 self.<a title="pythonutils.configobj.Section.walk" class="py-name" href="pythonutils.configobj.Section-class.html#walk">walk</a>(<a title="pythonutils.configobj.Section.encode" class="py-name" href="pythonutils.configobj.Section-class.html#encode">encode</a>, call_on_sections=True)

854

</div> 769

855

<a name="Section.istrue"></a><div id="Section.istrue-def"> 770 <a class="pysrc-toggle" href="#" id="Section.istrue-toggle" onclick="toggle('Section.istrue'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#istrue">istrue</a>(self, key):

856

</div><div id="Section.istrue-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.istrue-expanded"> 771 """A deprecated version of ``as_bool``."""

857

772 warn('use of ``istrue`` is deprecated. Use ``as_bool`` method '

858

773 'instead.', DeprecationWarning)

859

774 return self.<a title="pythonutils.configobj.Section.as_bool" class="py-name" href="pythonutils.configobj.Section-class.html#as_bool">as_bool</a>(key)

860

</div> 775

861

<a name="Section.as_bool"></a><div id="Section.as_bool-def"> 776 <a class="pysrc-toggle" href="#" id="Section.as_bool-toggle" onclick="toggle('Section.as_bool'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#as_bool">as_bool</a>(self, key):

862

</div><div id="Section.as_bool-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.as_bool-expanded"> 777 """

863

778 Accepts a key as input. The corresponding value must be a string or

864

779 the objects (``True`` or 1) or (``False`` or 0). We allow 0 and 1 to

865

780 retain compatibility with Python 2.2.

866

781

867

782 If the string is one of ``True``, ``On``, ``Yes``, or ``1`` it returns

868

783 ``True``.

869

784

870

785 If the string is one of ``False``, ``Off``, ``No``, or ``0`` it returns

871

786 ``False``.

872

787

873

788 ``as_bool`` is not case sensitive.

874

789

875

790 Any other input will raise a ``ValueError``.

876

791

877

792 >>> a = ConfigObj()

878

793 >>> a['a'] = 'fish'

879

794 >>> a.as_bool('a')

880

795 Traceback (most recent call last):

881

796 ValueError: Value "fish" is neither True nor False

882

797 >>> a['b'] = 'True'

883

798 >>> a.as_bool('b')

884

799 1

885

800 >>> a['b'] = 'off'

886

801 >>> a.as_bool('b')

887

802 0

888

803 """

889

804 val = self[key]

890

805 if val == True:

891

806 return True

892

807 elif val == False:

893

808 return False

894

809 else:

895

810 try:

896

811 if not isinstance(val, StringTypes):

897

812 raise KeyError

898

813 else:

899

814 return self.main.<a title="pythonutils.configobj.ConfigObj._bools" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_bools">_bools</a>[val.lower()]

900

815 except KeyError:

901

816 raise ValueError('Value "%s" is neither True nor False' % val)

902

</div> 817

903

<a name="Section.as_int"></a><div id="Section.as_int-def"> 818 <a class="pysrc-toggle" href="#" id="Section.as_int-toggle" onclick="toggle('Section.as_int'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#as_int">as_int</a>(self, key):

904

</div><div id="Section.as_int-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.as_int-expanded"> 819 """

905

820 A convenience method which coerces the specified value to an integer.

906

821

907

822 If the value is an invalid literal for ``int``, a ``ValueError`` will

908

823 be raised.

909

824

910

825 >>> a = ConfigObj()

911

826 >>> a['a'] = 'fish'

912

827 >>> a.as_int('a')

913

828 Traceback (most recent call last):

914

829 ValueError: invalid literal for int(): fish

915

830 >>> a['b'] = '1'

916

831 >>> a.as_int('b')

917

832 1

918

833 >>> a['b'] = '3.2'

919

834 >>> a.as_int('b')

920

835 Traceback (most recent call last):

921

836 ValueError: invalid literal for int(): 3.2

922

837 """

923

838 return int(self[key])

924

</div> 839

925

<a name="Section.as_float"></a><div id="Section.as_float-def"> 840 <a class="pysrc-toggle" href="#" id="Section.as_float-toggle" onclick="toggle('Section.as_float'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.Section-class.html#as_float">as_float</a>(self, key):

926

</div><div id="Section.as_float-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="Section.as_float-expanded"> 841 """

927

842 A convenience method which coerces the specified value to a float.

928

843

929

844 If the value is an invalid literal for ``float``, a ``ValueError`` will

930

845 be raised.

931

846

932

847 >>> a = ConfigObj()

933

848 >>> a['a'] = 'fish'

934

849 >>> a.as_float('a')

935

850 Traceback (most recent call last):

936

851 ValueError: invalid literal for float(): fish

937

852 >>> a['b'] = '1'

938

853 >>> a.as_float('b')

939

854 1.0

940

855 >>> a['b'] = '3.2'

941

856 >>> a.as_float('b')

942

857 3.2000000000000002

943

858 """

944

859 return float(self[key])

945

</div></div> 860

946

861

947

<a name="ConfigObj"></a><div id="ConfigObj-def"> 862 <a class="pysrc-toggle" href="#" id="ConfigObj-toggle" onclick="toggle('ConfigObj'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html">ConfigObj</a>(Section):

948

</div><div id="ConfigObj-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="ConfigObj-expanded"> 863 """An object to read, create, and write config files."""

949

864

950

865 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_keyword">_keyword</a> = re.compile(r'''^ # line start

951

866 (\s*) # indentation

952

867 ( # keyword

953

868 (?:".*?")| # double quotes

954

869 (?:'.*?')| # single quotes

955

870 (?:[^'"=].*?) # no quotes

956

871 )

957

872 \s*=\s* # divider

958

873 (.*) # value (including list values and comments)

959

874 $ # line end

960

875 ''',

961

876 re.VERBOSE)

962

877

963

878 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_sectionmarker">_sectionmarker</a> = re.compile(r'''^

964

879 (\s*) # 1: indentation

965

880 ((?:\[\s*)+) # 2: section marker open

966

881 ( # 3: section name open

967

882 (?:"\s*\S.*?\s*")| # at least one non-space with double quotes

968

883 (?:'\s*\S.*?\s*')| # at least one non-space with single quotes

969

884 (?:[^'"\s].*?) # at least one non-space unquoted

970

885 ) # section name close

971

886 ((?:\s*\])+) # 4: section marker close

972

887 \s*(\#.*)? # 5: optional comment

973

888 $''',

974

889 re.VERBOSE)

975

890

976

891 # this regexp pulls list values out as a single string

977

892 # or single values and comments

978

893 # FIXME: this regex adds a '' to the end of comma terminated lists

979

894 # workaround in ``_handle_value``

980

895 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_valueexp">_valueexp</a> = re.compile(r'''^

981

896 (?:

982

897 (?:

983

898 (

984

899 (?:

985

900 (?:

986

901 (?:".*?")| # double quotes

987

902 (?:'.*?')| # single quotes

988

903 (?:[^'",\#][^,\#]*?) # unquoted

989

904 )

990

905 \s*,\s* # comma

991

906 )* # match all list items ending in a comma (if any)

992

907 )

993

908 (

994

909 (?:".*?")| # double quotes

995

910 (?:'.*?')| # single quotes

996

911 (?:[^'",\#\s][^,]*?)| # unquoted

997

912 (?:(?<!,)) # Empty value

998

913 )? # last item in a list - or string value

999

914 )|

1000

915 (,) # alternatively a single comma - empty list

1001

916 )

1002

917 \s*(\#.*)? # optional comment

1003

918 $''',

1004

919 re.VERBOSE)

1005

920

1006

921 # use findall to get the members of a list value

1007

922 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_listvalueexp">_listvalueexp</a> = re.compile(r'''

1008

923 (

1009

924 (?:".*?")| # double quotes

1010

925 (?:'.*?')| # single quotes

1011

926 (?:[^'",\#].*?) # unquoted

1012

927 )

1013

928 \s*,\s* # comma

1014

929 ''',

1015

930 re.VERBOSE)

1016

931

1017

932 # this regexp is used for the value

1018

933 # when lists are switched off

1019

934 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_nolistvalue">_nolistvalue</a> = re.compile(r'''^

1020

935 (

1021

936 (?:".*?")| # double quotes

1022

937 (?:'.*?')| # single quotes

1023

938 (?:[^'"\#].*?)| # unquoted

1024

939 (?:) # Empty value

1025

940 )

1026

941 \s*(\#.*)? # optional comment

1027

942 $''',

1028

943 re.VERBOSE)

1029

944

1030

945 # regexes for finding triple quoted values on one line

1031

946 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_single_line_single">_single_line_single</a> = re.compile(r"^'''(.*?)'''\s*(#.*)?$")

1032

947 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_single_line_double">_single_line_double</a> = re.compile(r'^"""(.*?)"""\s*(#.*)?$')

1033

948 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_multi_line_single">_multi_line_single</a> = re.compile(r"^(.*?)'''\s*(#.*)?$")

1034

949 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_multi_line_double">_multi_line_double</a> = re.compile(r'^(.*?)"""\s*(#.*)?$')

1035

950

1036

951 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_triple_quote">_triple_quote</a> = {

1037

952 "'''": (<a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_single_line_single">_single_line_single</a>, <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_multi_line_single">_multi_line_single</a>),

1038

953 '"""': (<a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_single_line_double">_single_line_double</a>, <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_multi_line_double">_multi_line_double</a>),

1039

954 }

1040

955

1041

956 # Used by the ``istrue`` Section method

1042

957 <a class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_bools">_bools</a> = {

1043

958 'yes': True, 'no': False,

1044

959 'on': True, 'off': False,

1045

960 '1': True, '0': False,

1046

961 'true': True, 'false': False,

1047

962 }

1048

963

1049

<a name="ConfigObj.__init__"></a><div id="ConfigObj.__init__-def"> 964 <a class="pysrc-toggle" href="#" id="ConfigObj.__init__-toggle" onclick="toggle('ConfigObj.__init__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#__init__">__init__</a>(self, infile=None, options=None, **kwargs):

1050

</div><div id="ConfigObj.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj.__init__-expanded"> 965 """

1051

966 Parse or create a config file object.

1052

967

1053

968 ``ConfigObj(infile=None, options=None, **kwargs)``

1054

969 """

1055

970 if infile is None:

1056

971 infile = []

1057

972 if options is None:

1058

973 options = {}

1059

974 else:

1060

975 options = <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>(options)

1061

976 # keyword arguments take precedence over an options dictionary

1062

977 options.<a title="pythonutils.configobj.Section.update" class="py-name" href="pythonutils.configobj.Section-class.html#update">update</a>(kwargs)

1063

978 # init the superclass

1064

979 <a title="pythonutils.configobj.Section" class="py-name" href="pythonutils.configobj.Section-class.html">Section</a>.<a title="pythonutils.configobj.ConfigObj.__init__

1065

pythonutils.configobj.ConfigObjError.__init__

1066

pythonutils.configobj.InterpolationDepthError.__init__

1067

pythonutils.configobj.MissingInterpolationOption.__init__

1068

pythonutils.configobj.Section.__init__

1069

pythonutils.configobj.SimpleVal.__init__" class="py-name" href="#" onclick="doclink('link-4', '__init__', 'Method __init__()=pythonutils.configobj.ConfigObj-class.html#__init__,Method ConfigObjError.__init__()=pythonutils.configobj.ConfigObjError-class.html#__init__,Method InterpolationDepthError.__init__()=pythonutils.configobj.InterpolationDepthError-class.html#__init__,Method MissingInterpolationOption.__init__()=pythonutils.configobj.MissingInterpolationOption-class.html#__init__,Method Section.__init__()=pythonutils.configobj.Section-class.html#__init__,Method SimpleVal.__init__()=pythonutils.configobj.SimpleVal-class.html#__init__'); return false;">__init__</a>(self, self, 0, self)

1070

980 #

1071

981 defaults = <a title="pythonutils.configobj.OPTION_DEFAULTS" class="py-name" href="pythonutils.configobj-module.html#OPTION_DEFAULTS">OPTION_DEFAULTS</a>.copy()

1072

982 for entry in options.<a title="pythonutils.configobj.Section.keys" class="py-name" href="pythonutils.configobj.Section-class.html#keys">keys</a>():

1073

983 if entry not in defaults.<a title="pythonutils.configobj.Section.keys" class="py-name" href="pythonutils.configobj.Section-class.html#keys">keys</a>():

1074

984 raise TypeError, 'Unrecognised option "%s".' % entry

1075

985 # TODO: check the values too.

1076

986 #

1077

987 # Add any explicit options to the defaults

1078

988 defaults.<a title="pythonutils.configobj.Section.update" class="py-name" href="pythonutils.configobj.Section-class.html#update">update</a>(options)

1079

989 #

1080

990 # initialise a few variables

1081

991 self.filename = None

1082

992 self._errors = []

1083

993 self.raise_errors = defaults['raise_errors']

1084

994 self.interpolation = defaults['interpolation']

1085

995 self.list_values = defaults['list_values']

1086

996 self.create_empty = defaults['create_empty']

1087

997 self.file_error = defaults['file_error']

1088

998 self.stringify = defaults['stringify']

1089

999 self.indent_type = defaults['indent_type']

1090

1000 self.encoding = defaults['encoding']

1091

1001 self.default_encoding = defaults['default_encoding']

1092

1002 self.BOM = False

1093

1003 self.newlines = None

1094

1004 self.write_empty_values = defaults['write_empty_values']

1095

1005 self.<a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a> = defaults['unrepr']

1096

1006 #

1097

1007 self.initial_comment = []

1098

1008 self.final_comment = []

1099

1009 #

1100

1010 if isinstance(infile, StringTypes):

1101

1011 self.filename = infile

1102

1012 if os.path.isfile(infile):

1103

1013 infile = open(infile).read() or []

1104

1014 elif self.file_error:

1105

1015 # raise an error if the file doesn't exist

1106

1016 raise IOError, 'Config file not found: "%s".' % self.filename

1107

1017 else:

1108

1018 # file doesn't already exist

1109

1019 if self.create_empty:

1110

1020 # this is a good test that the filename specified

1111

1021 # isn't impossible - like on a non existent device

1112

1022 h = open(infile, 'w')

1113

1023 h.<a title="pythonutils.configobj.ConfigObj.write" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#write">write</a>('')

1114

1024 h.close()

1115

1025 infile = []

1116

1026 elif isinstance(infile, (list, tuple)):

1117

1027 infile = list(infile)

1118

1028 elif isinstance(infile, <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>):

1119

1029 # initialise self

1120

1030 # the Section class handles creating subsections

1121

1031 if isinstance(infile, <a title="pythonutils.configobj.ConfigObj" class="py-name" href="pythonutils.configobj.ConfigObj-class.html">ConfigObj</a>):

1122

1032 # get a copy of our ConfigObj

1123

1033 infile = infile.<a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>()

1124

1034 for entry in infile:

1125

1035 self[entry] = infile[entry]

1126

1036 del self._errors

1127

1037 if defaults['configspec'] is not None:

1128

1038 self.<a title="pythonutils.configobj.ConfigObj._handle_configspec" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_configspec">_handle_configspec</a>(defaults['configspec'])

1129

1039 else:

1130

1040 self.configspec = None

1131

1041 return

1132

1042 elif hasattr(infile, 'read'):

1133

1043 # This supports file like objects

1134

1044 infile = infile.read() or []

1135

1045 # needs splitting into lines - but needs doing *after* decoding

1136

1046 # in case it's not an 8 bit encoding

1137

1047 else:

1138

1048 raise TypeError, ('infile must be a filename,'

1139

1049 ' file like object, or list of lines.')

1140

1050 #

1141

1051 if infile:

1142

1052 # don't do it for the empty ConfigObj

1143

1053 infile = self.<a title="pythonutils.configobj.ConfigObj._handle_bom" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_bom">_handle_bom</a>(infile)

1144

1054 # infile is now *always* a list

1145

1055 #

1146

1056 # Set the newlines attribute (first line ending it finds)

1147

1057 # and strip trailing '\n' or '\r' from lines

1148

1058 for line in infile:

1149

1059 if (not line) or (line[-1] not in '\r\n'):

1150

1060 continue

1151

1061 for end in ('\r\n', '\n', '\r'):

1152

1062 if line.endswith(end):

1153

1063 self.newlines = end

1154

1064 break

1155

1065 break

1156

1066 infile = [line.rstrip('\r\n') for line in infile]

1157

1067 #

1158

1068 self.<a title="pythonutils.configobj.ConfigObj._parse" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_parse">_parse</a>(infile)

1159

1069 # if we had any errors, now is the time to raise them

1160

1070 if self._errors:

1161

1071 error = <a title="pythonutils.configobj.ConfigObjError" class="py-name" href="pythonutils.configobj.ConfigObjError-class.html">ConfigObjError</a>("Parsing failed.")

1162

1072 # set the errors attribute; it's a list of tuples:

1163

1073 # (error_type, message, line_number)

1164

1074 error.errors = self._errors

1165

1075 # set the config attribute

1166

1076 error.config = self

1167

1077 raise error

1168

1078 # delete private attributes

1169

1079 del self._errors

1170

1080 #

1171

1081 if defaults['configspec'] is None:

1172

1082 self.configspec = None

1173

1083 else:

1174

1084 self.<a title="pythonutils.configobj.ConfigObj._handle_configspec" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_configspec">_handle_configspec</a>(defaults['configspec'])

1175

</div>1085

1176

<a name="ConfigObj.__repr__"></a><div id="ConfigObj.__repr__-def">1086 <a class="pysrc-toggle" href="#" id="ConfigObj.__repr__-toggle" onclick="toggle('ConfigObj.__repr__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#__repr__">__repr__</a>(self):

1177

</div><div id="ConfigObj.__repr__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj.__repr__-expanded">1087 return 'ConfigObj({%s})' % ', '.join(

1178

1088 [('%s: %s' % (repr(key), repr(self[key]))) for key in

1179

1089 (self.scalars + self.sections)])

1180

</div>1090

1181

<a name="ConfigObj._handle_bom"></a><div id="ConfigObj._handle_bom-def">1091 <a class="pysrc-toggle" href="#" id="ConfigObj._handle_bom-toggle" onclick="toggle('ConfigObj._handle_bom'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_bom">_handle_bom</a>(self, infile):

1182

</div><div id="ConfigObj._handle_bom-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._handle_bom-expanded">1092 """

1183

1093 Handle any BOM, and decode if necessary.

1184

1094

1185

1095 If an encoding is specified, that *must* be used - but the BOM should

1186

1096 still be removed (and the BOM attribute set).

1187

1097

1188

1098 (If the encoding is wrongly specified, then a BOM for an alternative

1189

1099 encoding won't be discovered or removed.)

1190

1100

1191

1101 If an encoding is not specified, UTF8 or UTF16 BOM will be detected and

1192

1102 removed. The BOM attribute will be set. UTF16 will be decoded to

1193

1103 unicode.

1194

1104

1195

1105 NOTE: This method must not be called with an empty ``infile``.

1196

1106

1197

1107 Specifying the *wrong* encoding is likely to cause a

1198

1108 ``UnicodeDecodeError``.

1199

1109

1200

1110 ``infile`` must always be returned as a list of lines, but may be

1201

1111 passed in as a single string.

1202

1112 """

1203

1113 if ((self.encoding is not None) and

1204

1114 (self.encoding.lower() not in <a title="pythonutils.configobj.BOM_LIST" class="py-name" href="pythonutils.configobj-module.html#BOM_LIST">BOM_LIST</a>)):

1205

1115 # No need to check for a BOM

1206

1116 # encoding specified doesn't have one

1207

1117 # just decode

1208

1118 return self.<a title="pythonutils.configobj.ConfigObj._decode" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode">_decode</a>(infile, self.encoding)

1209

1119 #

1210

1120 if isinstance(infile, (list, tuple)):

1211

1121 line = infile[0]

1212

1122 else:

1213

1123 line = infile

1214

1124 if self.encoding is not None:

1215

1125 # encoding explicitly supplied

1216

1126 # And it could have an associated BOM

1217

1127 # TODO: if encoding is just UTF16 - we ought to check for both

1218

1128 # TODO: big endian and little endian versions.

1219

1129 enc = <a title="pythonutils.configobj.BOM_LIST" class="py-name" href="pythonutils.configobj-module.html#BOM_LIST">BOM_LIST</a>[self.encoding.lower()]

1220

1130 if enc == 'utf_16':

1221

1131 # For UTF16 we try big endian and little endian

1222

1132 for BOM, (encoding, final_encoding) in <a title="pythonutils.configobj.BOMS" class="py-name" href="pythonutils.configobj-module.html#BOMS">BOMS</a>.<a title="pythonutils.configobj.Section.items" class="py-name" href="pythonutils.configobj.Section-class.html#items">items</a>():

1223

1133 if not final_encoding:

1224

1134 # skip UTF8

1225

1135 continue

1226

1136 if infile.startswith(BOM):

1227

1137 ### BOM discovered

1228

1138 ##self.BOM = True

1229

1139 # Don't need to remove BOM

1230

1140 return self.<a title="pythonutils.configobj.ConfigObj._decode" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode">_decode</a>(infile, encoding)

1231

1141 #

1232

1142 # If we get this far, will *probably* raise a DecodeError

1233

1143 # As it doesn't appear to start with a BOM

1234

1144 return self.<a title="pythonutils.configobj.ConfigObj._decode" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode">_decode</a>(infile, self.encoding)

1235

1145 #

1236

1146 # Must be UTF8

1237

1147 BOM = <a title="pythonutils.configobj.BOM_SET" class="py-name" href="pythonutils.configobj-module.html#BOM_SET">BOM_SET</a>[enc]

1238

1148 if not line.startswith(BOM):

1239

1149 return self.<a title="pythonutils.configobj.ConfigObj._decode" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode">_decode</a>(infile, self.encoding)

1240

1150 #

1241

1151 newline = line[len(BOM):]

1242

1152 #

1243

1153 # BOM removed

1244

1154 if isinstance(infile, (list, tuple)):

1245

1155 infile[0] = newline

1246

1156 else:

1247

1157 infile = newline

1248

1158 self.BOM = True

1249

1159 return self.<a title="pythonutils.configobj.ConfigObj._decode" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode">_decode</a>(infile, self.encoding)

1250

1160 #

1251

1161 # No encoding specified - so we need to check for UTF8/UTF16

1252

1162 for BOM, (encoding, final_encoding) in <a title="pythonutils.configobj.BOMS" class="py-name" href="pythonutils.configobj-module.html#BOMS">BOMS</a>.<a title="pythonutils.configobj.Section.items" class="py-name" href="pythonutils.configobj.Section-class.html#items">items</a>():

1253

1163 if not line.startswith(BOM):

1254

1164 continue

1255

1165 else:

1256

1166 # BOM discovered

1257

1167 self.encoding = final_encoding

1258

1168 if not final_encoding:

1259

1169 self.BOM = True

1260

1170 # UTF8

1261

1171 # remove BOM

1262

1172 newline = line[len(BOM):]

1263

1173 if isinstance(infile, (list, tuple)):

1264

1174 infile[0] = newline

1265

1175 else:

1266

1176 infile = newline

1267

1177 # UTF8 - don't decode

1268

1178 if isinstance(infile, StringTypes):

1269

1179 return infile.splitlines(True)

1270

1180 else:

1271

1181 return infile

1272

1182 # UTF16 - have to decode

1273

1183 return self.<a title="pythonutils.configobj.ConfigObj._decode" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode">_decode</a>(infile, encoding)

1274

1184 #

1275

1185 # No BOM discovered and no encoding specified, just return

1276

1186 if isinstance(infile, StringTypes):

1277

1187 # infile read from a file will be a single string

1278

1188 return infile.splitlines(True)

1279

1189 else:

1280

1190 return infile

1281

</div>1191

1282

<a name="ConfigObj._a_to_u"></a><div id="ConfigObj._a_to_u-def">1192 <a class="pysrc-toggle" href="#" id="ConfigObj._a_to_u-toggle" onclick="toggle('ConfigObj._a_to_u'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>(self, string):

1283

</div><div id="ConfigObj._a_to_u-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._a_to_u-expanded">1193 """Decode ascii strings to unicode if a self.encoding is specified."""

1284

1194 if not self.encoding:

1285

1195 return string

1286

1196 else:

1287

1197 return string.<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>('ascii')

1288

</div>1198

1289

<a name="ConfigObj._decode"></a><div id="ConfigObj._decode-def">1199 <a class="pysrc-toggle" href="#" id="ConfigObj._decode-toggle" onclick="toggle('ConfigObj._decode'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_decode">_decode</a>(self, infile, encoding):

1290

</div><div id="ConfigObj._decode-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._decode-expanded">1200 """

1291

1201 Decode infile to unicode. Using the specified encoding.

1292

1202

1293

1203 if is a string, it also needs converting to a list.

1294

1204 """

1295

1205 if isinstance(infile, StringTypes):

1296

1206 # can't be unicode

1297

1207 # NOTE: Could raise a ``UnicodeDecodeError``

1298

1208 return infile.<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>(encoding).splitlines(True)

1299

1209 for i, line in <a title="pythonutils.configobj.enumerate" class="py-name" href="pythonutils.configobj-module.html#enumerate">enumerate</a>(infile):

1300

1210 if not isinstance(line, unicode):

1301

1211 # NOTE: The isinstance test here handles mixed lists of unicode/string

1302

1212 # NOTE: But the decode will break on any non-string values

1303

1213 # NOTE: Or could raise a ``UnicodeDecodeError``

1304

1214 infile[i] = line.<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>(encoding)

1305

1215 return infile

1306

</div>1216

1307

<a name="ConfigObj._decode_element"></a><div id="ConfigObj._decode_element-def">1217 <a class="pysrc-toggle" href="#" id="ConfigObj._decode_element-toggle" onclick="toggle('ConfigObj._decode_element'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(self, line):

1308

</div><div id="ConfigObj._decode_element-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._decode_element-expanded">1218 """Decode element to unicode if necessary."""

1309

1219 if not self.encoding:

1310

1220 return line

1311

1221 if isinstance(line, str) and self.default_encoding:

1312

1222 return line.<a title="pythonutils.configobj.Section.decode" class="py-name" href="pythonutils.configobj.Section-class.html#decode">decode</a>(self.default_encoding)

1313

1223 return line

1314

</div>1224

1315

<a name="ConfigObj._str"></a><div id="ConfigObj._str-def">1225 <a class="pysrc-toggle" href="#" id="ConfigObj._str-toggle" onclick="toggle('ConfigObj._str'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_str">_str</a>(self, value):

1316

</div><div id="ConfigObj._str-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._str-expanded">1226 """

1317

1227 Used by ``stringify`` within validate, to turn non-string values

1318

1228 into strings.

1319

1229 """

1320

1230 if not isinstance(value, StringTypes):

1321

1231 return str(value)

1322

1232 else:

1323

1233 return value

1324

</div>1234

1325

<a name="ConfigObj._parse"></a><div id="ConfigObj._parse-def">1235 <a class="pysrc-toggle" href="#" id="ConfigObj._parse-toggle" onclick="toggle('ConfigObj._parse'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_parse">_parse</a>(self, infile):

1326

</div><div id="ConfigObj._parse-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._parse-expanded">1236 """Actually parse the config file."""

1327

1237 temp_list_values = self.list_values

1328

1238 if self.<a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>:

1329

1239 self.list_values = False

1330

1240 comment_list = []

1331

1241 done_start = False

1332

1242 this_section = self

1333

1243 maxline = len(infile) - 1

1334

1244 cur_index = -1

1335

1245 reset_comment = False

1336

1246 while cur_index < maxline:

1337

1247 if reset_comment:

1338

1248 comment_list = []

1339

1249 cur_index += 1

1340

1250 line = infile[cur_index]

1341

1251 sline = line.strip()

1342

1252 # do we have anything on the line ?

1343

1253 if not sline or sline.startswith('#'):

1344

1254 reset_comment = False

1345

1255 comment_list.append(line)

1346

1256 continue

1347

1257 if not done_start:

1348

1258 # preserve initial comment

1349

1259 self.initial_comment = comment_list

1350

1260 comment_list = []

1351

1261 done_start = True

1352

1262 reset_comment = True

1353

1263 # first we check if it's a section marker

1354

1264 mat = self.<a title="pythonutils.configobj.ConfigObj._sectionmarker" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_sectionmarker">_sectionmarker</a>.match(line)

1355

1265 if mat is not None:

1356

1266 # is a section line

1357

1267 (indent, sect_open, sect_name, sect_close, comment) = (

1358

1268 mat.groups())

1359

1269 if indent and (self.indent_type is None):

1360

1270 self.indent_type = indent[0]

1361

1271 cur_depth = sect_open.count('[')

1362

1272 if cur_depth != sect_close.count(']'):

1363

1273 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1364

1274 "Cannot compute the section depth at line %s.",

1365

1275 <a title="pythonutils.configobj.NestingError" class="py-name" href="pythonutils.configobj.NestingError-class.html">NestingError</a>, infile, cur_index)

1366

1276 continue

1367

1277 if cur_depth < this_section.depth:

1368

1278 # the new section is dropping back to a previous level

1369

1279 try:

1370

1280 parent = self.<a title="pythonutils.configobj.ConfigObj._match_depth" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_match_depth">_match_depth</a>(

1371

1281 this_section,

1372

1282 cur_depth).parent

1373

1283 except SyntaxError:

1374

1284 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1375

1285 "Cannot compute nesting level at line %s.",

1376

1286 <a title="pythonutils.configobj.NestingError" class="py-name" href="pythonutils.configobj.NestingError-class.html">NestingError</a>, infile, cur_index)

1377

1287 continue

1378

1288 elif cur_depth == this_section.depth:

1379

1289 # the new section is a sibling of the current section

1380

1290 parent = this_section.parent

1381

1291 elif cur_depth == this_section.depth + 1:

1382

1292 # the new section is a child the current section

1383

1293 parent = this_section

1384

1294 else:

1385

1295 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1386

1296 "Section too nested at line %s.",

1387

1297 <a title="pythonutils.configobj.NestingError" class="py-name" href="pythonutils.configobj.NestingError-class.html">NestingError</a>, infile, cur_index)

1388

1298 #

1389

1299 sect_name = self.<a title="pythonutils.configobj.ConfigObj._unquote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_unquote">_unquote</a>(sect_name)

1390

1300 if parent.has_key(sect_name):

1391

1301 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1392

1302 'Duplicate section name at line %s.',

1393

1303 <a title="pythonutils.configobj.DuplicateError" class="py-name" href="pythonutils.configobj.DuplicateError-class.html">DuplicateError</a>, infile, cur_index)

1394

1304 continue

1395

1305 # create the new section

1396

1306 this_section = <a title="pythonutils.configobj.Section" class="py-name" href="pythonutils.configobj.Section-class.html">Section</a>(

1397

1307 parent,

1398

1308 cur_depth,

1399

1309 self,

1400

1310 name=sect_name)

1401

1311 parent[sect_name] = this_section

1402

1312 parent.inline_comments[sect_name] = comment

1403

1313 parent.comments[sect_name] = comment_list

1404

1314 continue

1405

1315 #

1406

1316 # it's not a section marker,

1407

1317 # so it should be a valid ``key = value`` line

1408

1318 mat = self.<a title="pythonutils.configobj.ConfigObj._keyword" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_keyword">_keyword</a>.match(line)

1409

1319 if mat is not None:

1410

1320 # is a keyword value

1411

1321 # value will include any inline comment

1412

1322 (indent, key, value) = mat.groups()

1413

1323 if indent and (self.indent_type is None):

1414

1324 self.indent_type = indent[0]

1415

1325 # check for a multiline value

1416

1326 if value[:3] in ['"""', "'''"]:

1417

1327 try:

1418

1328 (value, comment, cur_index) = self.<a title="pythonutils.configobj.ConfigObj._multiline" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_multiline">_multiline</a>(

1419

1329 value, infile, cur_index, maxline)

1420

1330 except SyntaxError:

1421

1331 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1422

1332 'Parse error in value at line %s.',

1423

1333 <a title="pythonutils.configobj.ParseError" class="py-name" href="pythonutils.configobj.ParseError-class.html">ParseError</a>, infile, cur_index)

1424

1334 continue

1425

1335 else:

1426

1336 if self.<a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>:

1427

1337 value = <a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>(value)

1428

1338 else:

1429

1339 # extract comment and lists

1430

1340 try:

1431

1341 (value, comment) = self.<a title="pythonutils.configobj.ConfigObj._handle_value" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_value">_handle_value</a>(value)

1432

1342 except SyntaxError:

1433

1343 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1434

1344 'Parse error in value at line %s.',

1435

1345 <a title="pythonutils.configobj.ParseError" class="py-name" href="pythonutils.configobj.ParseError-class.html">ParseError</a>, infile, cur_index)

1436

1346 continue

1437

1347 #

1438

1348 key = self.<a title="pythonutils.configobj.ConfigObj._unquote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_unquote">_unquote</a>(key)

1439

1349 if this_section.has_key(key):

1440

1350 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1441

1351 'Duplicate keyword name at line %s.',

1442

1352 <a title="pythonutils.configobj.DuplicateError" class="py-name" href="pythonutils.configobj.DuplicateError-class.html">DuplicateError</a>, infile, cur_index)

1443

1353 continue

1444

1354 # add the key.

1445

1355 # we set unrepr because if we have got this far we will never

1446

1356 # be creating a new section

1447

1357 this_section.<a title="pythonutils.configobj.Section.__setitem__" class="py-name" href="pythonutils.configobj.Section-class.html#__setitem__">__setitem__</a>(key, value, <a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>=True)

1448

1358 this_section.inline_comments[key] = comment

1449

1359 this_section.comments[key] = comment_list

1450

1360 continue

1451

1361 #

1452

1362 # it neither matched as a keyword

1453

1363 # or a section marker

1454

1364 self.<a title="pythonutils.configobj.ConfigObj._handle_error" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(

1455

1365 'Invalid line at line "%s".',

1456

1366 <a title="pythonutils.configobj.ParseError" class="py-name" href="pythonutils.configobj.ParseError-class.html">ParseError</a>, infile, cur_index)

1457

1367 if self.indent_type is None:

1458

1368 # no indentation used, set the type accordingly

1459

1369 self.indent_type = ''

1460

1370 # preserve the final comment

1461

1371 if not self and not self.initial_comment:

1462

1372 self.initial_comment = comment_list

1463

1373 elif not reset_comment:

1464

1374 self.final_comment = comment_list

1465

1375 self.list_values = temp_list_values

1466

</div>1376

1467

<a name="ConfigObj._match_depth"></a><div id="ConfigObj._match_depth-def">1377 <a class="pysrc-toggle" href="#" id="ConfigObj._match_depth-toggle" onclick="toggle('ConfigObj._match_depth'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_match_depth">_match_depth</a>(self, sect, depth):

1468

</div><div id="ConfigObj._match_depth-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._match_depth-expanded">1378 """

1469

1379 Given a section and a depth level, walk back through the sections

1470

1380 parents to see if the depth level matches a previous section.

1471

1381

1472

1382 Return a reference to the right section,

1473

1383 or raise a SyntaxError.

1474

1384 """

1475

1385 while depth < sect.depth:

1476

1386 if sect is sect.parent:

1477

1387 # we've reached the top level already

1478

1388 raise SyntaxError

1479

1389 sect = sect.parent

1480

1390 if sect.depth == depth:

1481

1391 return sect

1482

1392 # shouldn't get here

1483

1393 raise SyntaxError

1484

</div>1394

1485

<a name="ConfigObj._handle_error"></a><div id="ConfigObj._handle_error-def">1395 <a class="pysrc-toggle" href="#" id="ConfigObj._handle_error-toggle" onclick="toggle('ConfigObj._handle_error'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_error">_handle_error</a>(self, text, ErrorClass, infile, cur_index):

1486

</div><div id="ConfigObj._handle_error-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._handle_error-expanded">1396 """

1487

1397 Handle an error according to the error settings.

1488

1398

1489

1399 Either raise the error or store it.

1490

1400 The error will have occured at ``cur_index``

1491

1401 """

1492

1402 line = infile[cur_index]

1493

1403 message = text % cur_index

1494

1404 error = ErrorClass(message, cur_index, line)

1495

1405 if self.raise_errors:

1496

1406 # raise the error - parsing stops here

1497

1407 raise error

1498

1408 # store the error

1499

1409 # reraise when parsing has finished

1500

1410 self._errors.append(error)

1501

</div>1411

1502

<a name="ConfigObj._unquote"></a><div id="ConfigObj._unquote-def">1412 <a class="pysrc-toggle" href="#" id="ConfigObj._unquote-toggle" onclick="toggle('ConfigObj._unquote'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_unquote">_unquote</a>(self, value):

1503

</div><div id="ConfigObj._unquote-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._unquote-expanded">1413 """Return an unquoted version of a value"""

1504

1414 if (value[0] == value[-1]) and (value[0] in ('"', "'")):

1505

1415 value = value[1:-1]

1506

1416 return value

1507

</div>1417

1508

<a name="ConfigObj._quote"></a><div id="ConfigObj._quote-def">1418 <a class="pysrc-toggle" href="#" id="ConfigObj._quote-toggle" onclick="toggle('ConfigObj._quote'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_quote">_quote</a>(self, value, multiline=True):

1509

</div><div id="ConfigObj._quote-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._quote-expanded">1419 """

1510

1420 Return a safely quoted version of a value.

1511

1421

1512

1422 Raise a ConfigObjError if the value cannot be safely quoted.

1513

1423 If multiline is ``True`` (default) then use triple quotes

1514

1424 if necessary.

1515

1425

1516

1426 Don't quote values that don't need it.

1517

1427 Recursively quote members of a list and return a comma joined list.

1518

1428 Multiline is ``False`` for lists.

1519

1429 Obey list syntax for empty and single member lists.

1520

1430

1521

1431 If ``list_values=False`` then the value is only quoted if it contains

1522

1432 a ``\n`` (is multiline).

1523

1433

1524

1434 If ``write_empty_values`` is set, and the value is an empty string, it

1525

1435 won't be quoted.

1526

1436 """

1527

1437 if multiline and self.write_empty_values and value == '':

1528

1438 # Only if multiline is set, so that it is used for values not

1529

1439 # keys, and not values that are part of a list

1530

1440 return ''

1531

1441 if multiline and isinstance(value, (list, tuple)):

1532

1442 if not value:

1533

1443 return ','

1534

1444 elif len(value) == 1:

1535

1445 return self.<a title="pythonutils.configobj.ConfigObj._quote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_quote">_quote</a>(value[0], multiline=False) + ','

1536

1446 return ', '.join([self.<a title="pythonutils.configobj.ConfigObj._quote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_quote">_quote</a>(val, multiline=False)

1537

1447 for val in value])

1538

1448 if not isinstance(value, StringTypes):

1539

1449 if self.stringify:

1540

1450 value = str(value)

1541

1451 else:

1542

1452 raise TypeError, 'Value "%s" is not a string.' % value

1543

1453 squot = "'%s'"

1544

1454 dquot = '"%s"'

1545

1455 noquot = "%s"

1546

1456 wspace_plus = ' \r\t\n\v\t\'"'

1547

1457 tsquot = '"""%s"""'

1548

1458 tdquot = "'''%s'''"

1549

1459 if not value:

1550

1460 return '""'

1551

1461 if (not self.list_values and '\n' not in value) or not (multiline and

1552

1462 ((("'" in value) and ('"' in value)) or ('\n' in value))):

1553

1463 if not self.list_values:

1554

1464 # we don't quote if ``list_values=False``

1555

1465 quot = noquot

1556

1466 # for normal values either single or double quotes will do

1557

1467 elif '\n' in value:

1558

1468 # will only happen if multiline is off - e.g. '\n' in key

1559

1469 raise <a title="pythonutils.configobj.ConfigObjError" class="py-name" href="pythonutils.configobj.ConfigObjError-class.html">ConfigObjError</a>, ('Value "%s" cannot be safely quoted.' %

1560

1470 value)

1561

1471 elif ((value[0] not in wspace_plus) and

1562

1472 (value[-1] not in wspace_plus) and

1563

1473 (',' not in value)):

1564

1474 quot = noquot

1565

1475 else:

1566

1476 if ("'" in value) and ('"' in value):

1567

1477 raise <a title="pythonutils.configobj.ConfigObjError" class="py-name" href="pythonutils.configobj.ConfigObjError-class.html">ConfigObjError</a>, (

1568

1478 'Value "%s" cannot be safely quoted.' % value)

1569

1479 elif '"' in value:

1570

1480 quot = squot

1571

1481 else:

1572

1482 quot = dquot

1573

1483 else:

1574

1484 # if value has '\n' or "'" *and* '"', it will need triple quotes

1575

1485 if (value.find('"""') != -1) and (value.find("'''") != -1):

1576

1486 raise <a title="pythonutils.configobj.ConfigObjError" class="py-name" href="pythonutils.configobj.ConfigObjError-class.html">ConfigObjError</a>, (

1577

1487 'Value "%s" cannot be safely quoted.' % value)

1578

1488 if value.find('"""') == -1:

1579

1489 quot = tdquot

1580

1490 else:

1581

1491 quot = tsquot

1582

1492 return quot % value

1583

</div>1493

1584

<a name="ConfigObj._handle_value"></a><div id="ConfigObj._handle_value-def">1494 <a class="pysrc-toggle" href="#" id="ConfigObj._handle_value-toggle" onclick="toggle('ConfigObj._handle_value'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_value">_handle_value</a>(self, value):

1585

</div><div id="ConfigObj._handle_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._handle_value-expanded">1495 """

1586

1496 Given a value string, unquote, remove comment,

1587

1497 handle lists. (including empty and single member lists)

1588

1498 """

1589

1499 # do we look for lists in values ?

1590

1500 if not self.list_values:

1591

1501 mat = self.<a title="pythonutils.configobj.ConfigObj._nolistvalue" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_nolistvalue">_nolistvalue</a>.match(value)

1592

1502 if mat is None:

1593

1503 raise SyntaxError

1594

1504 (value, comment) = mat.groups()

1595

1505 if not self.<a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>:

1596

1506 # NOTE: we don't unquote here

1597

1507 return (value, comment)

1598

1508 else:

1599

1509 return (<a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>(value), comment)

1600

1510 mat = self.<a title="pythonutils.configobj.ConfigObj._valueexp" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_valueexp">_valueexp</a>.match(value)

1601

1511 if mat is None:

1602

1512 # the value is badly constructed, probably badly quoted,

1603

1513 # or an invalid list

1604

1514 raise SyntaxError

1605

1515 (list_values, single, empty_list, comment) = mat.groups()

1606

1516 if (list_values == '') and (single is None):

1607

1517 # change this if you want to accept empty values

1608

1518 raise SyntaxError

1609

1519 # NOTE: note there is no error handling from here if the regex

1610

1520 # is wrong: then incorrect values will slip through

1611

1521 if empty_list is not None:

1612

1522 # the single comma - meaning an empty list

1613

1523 return ([], comment)

1614

1524 if single is not None:

1615

1525 # handle empty values

1616

1526 if list_values and not single:

1617

1527 # FIXME: the '' is a workaround because our regex now matches

1618

1528 # '' at the end of a list if it has a trailing comma

1619

1529 single = None

1620

1530 else:

1621

1531 single = single or '""'

1622

1532 single = self.<a title="pythonutils.configobj.ConfigObj._unquote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_unquote">_unquote</a>(single)

1623

1533 if list_values == '':

1624

1534 # not a list value

1625

1535 return (single, comment)

1626

1536 the_list = self.<a title="pythonutils.configobj.ConfigObj._listvalueexp" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_listvalueexp">_listvalueexp</a>.findall(list_values)

1627

1537 the_list = [self.<a title="pythonutils.configobj.ConfigObj._unquote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_unquote">_unquote</a>(val) for val in the_list]

1628

1538 if single is not None:

1629

1539 the_list += [single]

1630

1540 return (the_list, comment)

1631

</div>1541

1632

<a name="ConfigObj._multiline"></a><div id="ConfigObj._multiline-def">1542 <a class="pysrc-toggle" href="#" id="ConfigObj._multiline-toggle" onclick="toggle('ConfigObj._multiline'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_multiline">_multiline</a>(self, value, infile, cur_index, maxline):

1633

</div><div id="ConfigObj._multiline-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._multiline-expanded">1543 """Extract the value, where we are in a multiline situation."""

1634

1544 quot = value[:3]

1635

1545 newvalue = value[3:]

1636

1546 single_line = self.<a title="pythonutils.configobj.ConfigObj._triple_quote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_triple_quote">_triple_quote</a>[quot][0]

1637

1547 multi_line = self.<a title="pythonutils.configobj.ConfigObj._triple_quote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_triple_quote">_triple_quote</a>[quot][1]

1638

1548 mat = single_line.match(value)

1639

1549 if mat is not None:

1640

1550 retval = list(mat.groups())

1641

1551 retval.append(cur_index)

1642

1552 return retval

1643

1553 elif newvalue.find(quot) != -1:

1644

1554 # somehow the triple quote is missing

1645

1555 raise SyntaxError

1646

1556 #

1647

1557 while cur_index < maxline:

1648

1558 cur_index += 1

1649

1559 newvalue += '\n'

1650

1560 line = infile[cur_index]

1651

1561 if line.find(quot) == -1:

1652

1562 newvalue += line

1653

1563 else:

1654

1564 # end of multiline, process it

1655

1565 break

1656

1566 else:

1657

1567 # we've got to the end of the config, oops...

1658

1568 raise SyntaxError

1659

1569 mat = multi_line.match(line)

1660

1570 if mat is None:

1661

1571 # a badly formed line

1662

1572 raise SyntaxError

1663

1573 (value, comment) = mat.groups()

1664

1574 return (newvalue + value, comment, cur_index)

1665

</div>1575

1666

<a name="ConfigObj._handle_configspec"></a><div id="ConfigObj._handle_configspec-def">1576 <a class="pysrc-toggle" href="#" id="ConfigObj._handle_configspec-toggle" onclick="toggle('ConfigObj._handle_configspec'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_configspec">_handle_configspec</a>(self, configspec):

1667

</div><div id="ConfigObj._handle_configspec-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._handle_configspec-expanded">1577 """Parse the configspec."""

1668

1578 # FIXME: Should we check that the configspec was created with the

1669

1579 # correct settings ? (i.e. ``list_values=False``)

1670

1580 if not isinstance(configspec, <a title="pythonutils.configobj.ConfigObj" class="py-name" href="pythonutils.configobj.ConfigObj-class.html">ConfigObj</a>):

1671

1581 try:

1672

1582 configspec = <a title="pythonutils.configobj.ConfigObj" class="py-name" href="pythonutils.configobj.ConfigObj-class.html">ConfigObj</a>(

1673

1583 configspec,

1674

1584 raise_errors=True,

1675

1585 file_error=True,

1676

1586 list_values=False)

1677

1587 except <a title="pythonutils.configobj.ConfigObjError" class="py-name" href="pythonutils.configobj.ConfigObjError-class.html">ConfigObjError</a>, e:

1678

1588 # FIXME: Should these errors have a reference

1679

1589 # to the already parsed ConfigObj ?

1680

1590 raise <a title="pythonutils.configobj.ConfigspecError" class="py-name" href="pythonutils.configobj.ConfigspecError-class.html">ConfigspecError</a>('Parsing configspec failed: %s' % e)

1681

1591 except IOError, e:

1682

1592 raise IOError('Reading configspec failed: %s' % e)

1683

1593 self.<a title="pythonutils.configobj.ConfigObj._set_configspec_value" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_set_configspec_value">_set_configspec_value</a>(configspec, self)

1684

</div>1594

1685

<a name="ConfigObj._set_configspec_value"></a><div id="ConfigObj._set_configspec_value-def">1595 <a class="pysrc-toggle" href="#" id="ConfigObj._set_configspec_value-toggle" onclick="toggle('ConfigObj._set_configspec_value'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_set_configspec_value">_set_configspec_value</a>(self, configspec, section):

1686

</div><div id="ConfigObj._set_configspec_value-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._set_configspec_value-expanded">1596 """Used to recursively set configspec values."""

1687

1597 if '__many__' in configspec.sections:

1688

1598 section.configspec['__many__'] = configspec['__many__']

1689

1599 if len(configspec.sections) > 1:

1690

1600 # FIXME: can we supply any useful information here ?

1691

1601 raise <a title="pythonutils.configobj.RepeatSectionError" class="py-name" href="pythonutils.configobj.RepeatSectionError-class.html">RepeatSectionError</a>

1692

1602 if hasattr(configspec, 'initial_comment'):

1693

1603 section._configspec_initial_comment = configspec.initial_comment

1694

1604 section._configspec_final_comment = configspec.final_comment

1695

1605 section._configspec_encoding = configspec.encoding

1696

1606 section._configspec_BOM = configspec.BOM

1697

1607 section._configspec_newlines = configspec.newlines

1698

1608 section._configspec_indent_type = configspec.indent_type

1699

1609 for entry in configspec.scalars:

1700

1610 section._configspec_comments[entry] = configspec.comments[entry]

1701

1611 section._configspec_inline_comments[entry] = (

1702

1612 configspec.inline_comments[entry])

1703

1613 section.configspec[entry] = configspec[entry]

1704

1614 section._order.append(entry)

1705

1615 for entry in configspec.sections:

1706

1616 if entry == '__many__':

1707

1617 continue

1708

1618 section._cs_section_comments[entry] = configspec.comments[entry]

1709

1619 section._cs_section_inline_comments[entry] = (

1710

1620 configspec.inline_comments[entry])

1711

1621 if not section.has_key(entry):

1712

1622 section[entry] = {}

1713

1623 self.<a title="pythonutils.configobj.ConfigObj._set_configspec_value" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_set_configspec_value">_set_configspec_value</a>(configspec[entry], section[entry])

1714

</div>1624

1715

<a name="ConfigObj._handle_repeat"></a><div id="ConfigObj._handle_repeat-def">1625 <a class="pysrc-toggle" href="#" id="ConfigObj._handle_repeat-toggle" onclick="toggle('ConfigObj._handle_repeat'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_repeat">_handle_repeat</a>(self, section, configspec):

1716

</div><div id="ConfigObj._handle_repeat-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._handle_repeat-expanded">1626 """Dynamically assign configspec for repeated section."""

1717

1627 try:

1718

1628 section_keys = configspec.sections

1719

1629 scalar_keys = configspec.scalars

1720

1630 except AttributeError:

1721

1631 section_keys = [entry for entry in configspec

1722

1632 if isinstance(configspec[entry], <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>)]

1723

1633 scalar_keys = [entry for entry in configspec

1724

1634 if not isinstance(configspec[entry], <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>)]

1725

1635 if '__many__' in section_keys and len(section_keys) > 1:

1726

1636 # FIXME: can we supply any useful information here ?

1727

1637 raise <a title="pythonutils.configobj.RepeatSectionError" class="py-name" href="pythonutils.configobj.RepeatSectionError-class.html">RepeatSectionError</a>

1728

1638 scalars = {}

1729

1639 sections = {}

1730

1640 for entry in scalar_keys:

1731

1641 val = configspec[entry]

1732

1642 scalars[entry] = val

1733

1643 for entry in section_keys:

1734

1644 val = configspec[entry]

1735

1645 if entry == '__many__':

1736

1646 scalars[entry] = val

1737

1647 continue

1738

1648 sections[entry] = val

1739

1649 #

1740

1650 section.configspec = scalars

1741

1651 for entry in sections:

1742

1652 if not section.has_key(entry):

1743

1653 section[entry] = {}

1744

1654 self.<a title="pythonutils.configobj.ConfigObj._handle_repeat" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_repeat">_handle_repeat</a>(section[entry], sections[entry])

1745

</div>1655

1746

<a name="ConfigObj._write_line"></a><div id="ConfigObj._write_line-def">1656 <a class="pysrc-toggle" href="#" id="ConfigObj._write_line-toggle" onclick="toggle('ConfigObj._write_line'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_write_line">_write_line</a>(self, indent_string, entry, this_entry, comment):

1747

</div><div id="ConfigObj._write_line-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._write_line-expanded">1657 """Write an individual line, for the write method"""

1748

1658 # NOTE: the calls to self._quote here handles non-StringType values.

1749

1659 if not self.<a title="pythonutils.configobj.unrepr" class="py-name" href="pythonutils.configobj-module.html#unrepr">unrepr</a>:

1750

1660 val = self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(self.<a title="pythonutils.configobj.ConfigObj._quote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_quote">_quote</a>(this_entry))

1751

1661 else:

1752

1662 val = repr(this_entry)

1753

1663 return '%s%s%s%s%s' % (

1754

1664 indent_string,

1755

1665 self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(self.<a title="pythonutils.configobj.ConfigObj._quote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_quote">_quote</a>(entry, multiline=False)),

1756

1666 self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>(' = '),

1757

1667 val,

1758

1668 self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(comment))

1759

</div>1669

1760

<a name="ConfigObj._write_marker"></a><div id="ConfigObj._write_marker-def">1670 <a class="pysrc-toggle" href="#" id="ConfigObj._write_marker-toggle" onclick="toggle('ConfigObj._write_marker'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_write_marker">_write_marker</a>(self, indent_string, depth, entry, comment):

1761

</div><div id="ConfigObj._write_marker-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._write_marker-expanded">1671 """Write a section marker line"""

1762

1672 return '%s%s%s%s%s' % (

1763

1673 indent_string,

1764

1674 self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>('[' * depth),

1765

1675 self.<a title="pythonutils.configobj.ConfigObj._quote" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_quote">_quote</a>(self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(entry), multiline=False),

1766

1676 self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>(']' * depth),

1767

1677 self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(comment))

1768

</div>1678

1769

<a name="ConfigObj._handle_comment"></a><div id="ConfigObj._handle_comment-def">1679 <a class="pysrc-toggle" href="#" id="ConfigObj._handle_comment-toggle" onclick="toggle('ConfigObj._handle_comment'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_comment">_handle_comment</a>(self, comment):

1770

</div><div id="ConfigObj._handle_comment-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._handle_comment-expanded">1680 """Deal with a comment."""

1771

1681 if not comment:

1772

1682 return ''

1773

1683 if self.indent_type == '\t':

1774

1684 start = self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>('\t')

1775

1685 else:

1776

1686 start = self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>(' ' * <a title="pythonutils.configobj.NUM_INDENT_SPACES" class="py-name" href="pythonutils.configobj-module.html#NUM_INDENT_SPACES">NUM_INDENT_SPACES</a>)

1777

1687 if not comment.startswith('#'):

1778

1688 start += <a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>('# ')

1779

1689 return (start + comment)

1780

</div>1690

1781

<a name="ConfigObj._compute_indent_string"></a><div id="ConfigObj._compute_indent_string-def">1691 <a class="pysrc-toggle" href="#" id="ConfigObj._compute_indent_string-toggle" onclick="toggle('ConfigObj._compute_indent_string'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#_compute_indent_string">_compute_indent_string</a>(self, depth):

1782

</div><div id="ConfigObj._compute_indent_string-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj._compute_indent_string-expanded">1692 """

1783

1693 Compute the indent string, according to current indent_type and depth

1784

1694 """

1785

1695 if self.indent_type == '':

1786

1696 # no indentation at all

1787

1697 return ''

1788

1698 if self.indent_type == '\t':

1789

1699 return '\t' * depth

1790

1700 if self.indent_type == ' ':

1791

1701 return ' ' * <a title="pythonutils.configobj.NUM_INDENT_SPACES" class="py-name" href="pythonutils.configobj-module.html#NUM_INDENT_SPACES">NUM_INDENT_SPACES</a> * depth

1792

1702 raise SyntaxError

1793

</div>1703

1794

1704 # Public methods

1795

1705

1796

<a name="ConfigObj.write"></a><div id="ConfigObj.write-def">1706 <a class="pysrc-toggle" href="#" id="ConfigObj.write-toggle" onclick="toggle('ConfigObj.write'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#write">write</a>(self, outfile=None, section=None):

1797

</div><div id="ConfigObj.write-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj.write-expanded">1707 """

1798

1708 Write the current ConfigObj as a file

1799

1709

1800

1710 tekNico: FIXME: use StringIO instead of real files

1801

1711

1802

1712 >>> filename = a.filename

1803

1713 >>> a.filename = 'test.ini'

1804

1714 >>> a.write()

1805

1715 >>> a.filename = filename

1806

1716 >>> a == ConfigObj('test.ini', raise_errors=True)

1807

1717 1

1808

1718 """

1809

1719 if self.indent_type is None:

1810

1720 # this can be true if initialised from a dictionary

1811

1721 self.indent_type = <a title="pythonutils.configobj.DEFAULT_INDENT_TYPE" class="py-name" href="pythonutils.configobj-module.html#DEFAULT_INDENT_TYPE">DEFAULT_INDENT_TYPE</a>

1812

1722 #

1813

1723 out = []

1814

1724 cs = self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>('#')

1815

1725 csp = self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>('# ')

1816

1726 if section is None:

1817

1727 int_val = self.interpolation

1818

1728 self.interpolation = False

1819

1729 section = self

1820

1730 for line in self.initial_comment:

1821

1731 line = self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(line)

1822

1732 stripped_line = line.strip()

1823

1733 if stripped_line and not stripped_line.startswith(cs):

1824

1734 line = csp + line

1825

1735 out.append(line)

1826

1736 #

1827

1737 indent_string = self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>(

1828

1738 self.<a title="pythonutils.configobj.ConfigObj._compute_indent_string" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_compute_indent_string">_compute_indent_string</a>(section.depth))

1829

1739 for entry in (section.scalars + section.sections):

1830

1740 if entry in section.defaults:

1831

1741 # don't write out default values

1832

1742 continue

1833

1743 for comment_line in section.comments[entry]:

1834

1744 comment_line = self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(comment_line.lstrip())

1835

1745 if comment_line and not comment_line.startswith(cs):

1836

1746 comment_line = csp + comment_line

1837

1747 out.append(indent_string + comment_line)

1838

1748 this_entry = section[entry]

1839

1749 comment = self.<a title="pythonutils.configobj.ConfigObj._handle_comment" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_comment">_handle_comment</a>(section.inline_comments[entry])

1840

1750 #

1841

1751 if isinstance(this_entry, <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>):

1842

1752 # a section

1843

1753 out.append(self.<a title="pythonutils.configobj.ConfigObj._write_marker" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_write_marker">_write_marker</a>(

1844

1754 indent_string,

1845

1755 this_entry.depth,

1846

1756 entry,

1847

1757 comment))

1848

1758 out.extend(self.<a title="pythonutils.configobj.ConfigObj.write" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#write">write</a>(section=this_entry))

1849

1759 else:

1850

1760 out.append(self.<a title="pythonutils.configobj.ConfigObj._write_line" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_write_line">_write_line</a>(

1851

1761 indent_string,

1852

1762 entry,

1853

1763 this_entry,

1854

1764 comment))

1855

1765 #

1856

1766 if section is self:

1857

1767 for line in self.final_comment:

1858

1768 line = self.<a title="pythonutils.configobj.ConfigObj._decode_element" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_decode_element">_decode_element</a>(line)

1859

1769 stripped_line = line.strip()

1860

1770 if stripped_line and not stripped_line.startswith(cs):

1861

1771 line = csp + line

1862

1772 out.append(line)

1863

1773 self.interpolation = int_val

1864

1774 #

1865

1775 if section is not self:

1866

1776 return out

1867

1777 #

1868

1778 if (self.filename is None) and (outfile is None):

1869

1779 # output a list of lines

1870

1780 # might need to encode

1871

1781 # NOTE: This will *screw* UTF16, each line will start with the BOM

1872

1782 if self.encoding:

1873

1783 out = [l.<a title="pythonutils.configobj.Section.encode" class="py-name" href="pythonutils.configobj.Section-class.html#encode">encode</a>(self.encoding) for l in out]

1874

1784 if (self.BOM and ((self.encoding is None) or

1875

1785 (<a title="pythonutils.configobj.BOM_LIST" class="py-name" href="pythonutils.configobj-module.html#BOM_LIST">BOM_LIST</a>.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(self.encoding.lower()) == 'utf_8'))):

1876

1786 # Add the UTF8 BOM

1877

1787 if not out:

1878

1788 out.append('')

1879

1789 out[0] = BOM_UTF8 + out[0]

1880

1790 return out

1881

1791 #

1882

1792 # Turn the list to a string, joined with correct newlines

1883

1793 output = (self.<a title="pythonutils.configobj.ConfigObj._a_to_u" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_a_to_u">_a_to_u</a>(self.newlines or os.linesep)

1884

1794 ).join(out)

1885

1795 if self.encoding:

1886

1796 output = output.<a title="pythonutils.configobj.Section.encode" class="py-name" href="pythonutils.configobj.Section-class.html#encode">encode</a>(self.encoding)

1887

1797 if (self.BOM and ((self.encoding is None) or

1888

1798 (<a title="pythonutils.configobj.BOM_LIST" class="py-name" href="pythonutils.configobj-module.html#BOM_LIST">BOM_LIST</a>.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(self.encoding.lower()) == 'utf_8'))):

1889

1799 # Add the UTF8 BOM

1890

1800 output = BOM_UTF8 + output

1891

1801 if outfile is not None:

1892

1802 outfile.<a title="pythonutils.configobj.ConfigObj.write" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#write">write</a>(output)

1893

1803 else:

1894

1804 h = open(self.filename, 'wb')

1895

1805 h.<a title="pythonutils.configobj.ConfigObj.write" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#write">write</a>(output)

1896

1806 h.close()

1897

</div>1807

1898

<a name="ConfigObj.validate"></a><div id="ConfigObj.validate-def">1808 <a class="pysrc-toggle" href="#" id="ConfigObj.validate-toggle" onclick="toggle('ConfigObj.validate'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.ConfigObj-class.html#validate">validate</a>(self, validator, preserve_errors=False, copy=False,

1899

1809 section=None):

1900

</div><div id="ConfigObj.validate-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="ConfigObj.validate-expanded">1810 """

1901

1811 Test the ConfigObj against a configspec.

1902

1812

1903

1813 It uses the ``validator`` object from *validate.py*.

1904

1814

1905

1815 To run ``validate`` on the current ConfigObj, call: ::

1906

1816

1907

1817 test = config.validate(validator)

1908

1818

1909

1819 (Normally having previously passed in the configspec when the ConfigObj

1910

1820 was created - you can dynamically assign a dictionary of checks to the

1911

1821 ``configspec`` attribute of a section though).

1912

1822

1913

1823 It returns ``True`` if everything passes, or a dictionary of

1914

1824 pass/fails (True/False). If every member of a subsection passes, it

1915

1825 will just have the value ``True``. (It also returns ``False`` if all

1916

1826 members fail).

1917

1827

1918

1828 In addition, it converts the values from strings to their native

1919

1829 types if their checks pass (and ``stringify`` is set).

1920

1830

1921

1831 If ``preserve_errors`` is ``True`` (``False`` is default) then instead

1922

1832 of a marking a fail with a ``False``, it will preserve the actual

1923

1833 exception object. This can contain info about the reason for failure.

1924

1834 For example the ``VdtValueTooSmallError`` indeicates that the value

1925

1835 supplied was too small. If a value (or section) is missing it will

1926

1836 still be marked as ``False``.

1927

1837

1928

1838 You must have the validate module to use ``preserve_errors=True``.

1929

1839

1930

1840 You can then use the ``flatten_errors`` function to turn your nested

1931

1841 results dictionary into a flattened list of failures - useful for

1932

1842 displaying meaningful error messages.

1933

1843 """

1934

1844 if section is None:

1935

1845 if self.configspec is None:

1936

1846 raise ValueError, 'No configspec supplied.'

1937

1847 if preserve_errors:

1938

1848 if VdtMissingValue is None:

1939

1849 raise ImportError('Missing validate module.')

1940

1850 section = self

1941

1851 #

1942

1852 spec_section = section.configspec

1943

1853 if copy and hasattr(section, '_configspec_initial_comment'):

1944

1854 section.initial_comment = section._configspec_initial_comment

1945

1855 section.final_comment = section._configspec_final_comment

1946

1856 section.encoding = section._configspec_encoding

1947

1857 section.BOM = section._configspec_BOM

1948

1858 section.newlines = section._configspec_newlines

1949

1859 section.indent_type = section._configspec_indent_type

1950

1860 if '__many__' in section.configspec:

1951

1861 many = spec_section['__many__']

1952

1862 # dynamically assign the configspecs

1953

1863 # for the sections below

1954

1864 for entry in section.sections:

1955

1865 self.<a title="pythonutils.configobj.ConfigObj._handle_repeat" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_handle_repeat">_handle_repeat</a>(section[entry], many)

1956

1866 #

1957

1867 out = {}

1958

1868 ret_true = True

1959

1869 ret_false = True

1960

1870 order = [k for k in section._order if k in spec_section]

1961

1871 order += [k for k in spec_section if k not in order]

1962

1872 for entry in order:

1963

1873 if entry == '__many__':

1964

1874 continue

1965

1875 if (not entry in section.scalars) or (entry in section.defaults):

1966

1876 # missing entries

1967

1877 # or entries from defaults

1968

1878 missing = True

1969

1879 val = None

1970

1880 if copy and not entry in section.scalars:

1971

1881 # copy comments

1972

1882 section.comments[entry] = (

1973

1883 section._configspec_comments.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(entry, []))

1974

1884 section.inline_comments[entry] = (

1975

1885 section._configspec_inline_comments.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(entry, ''))

1976

1886 #

1977

1887 else:

1978

1888 missing = False

1979

1889 val = section[entry]

1980

1890 try:

1981

1891 <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> = validator.<a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a>(spec_section[entry],

1982

1892 val,

1983

1893 missing=missing

1984

1894 )

1985

1895 except validator.baseErrorClass, e:

1986

1896 if not preserve_errors or isinstance(e, VdtMissingValue):

1987

1897 out[entry] = False

1988

1898 else:

1989

1899 # preserve the error

1990

1900 out[entry] = e

1991

1901 ret_false = False

1992

1902 ret_true = False

1993

1903 else:

1994

1904 ret_false = False

1995

1905 out[entry] = True

1996

1906 if self.stringify or missing:

1997

1907 # if we are doing type conversion

1998

1908 # or the value is a supplied default

1999

1909 if not self.stringify:

2000

1910 if isinstance(<a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a>, (list, tuple)):

2001

1911 # preserve lists

2002

1912 <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> = [self.<a title="pythonutils.configobj.ConfigObj._str" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_str">_str</a>(item) for item in <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a>]

2003

1913 elif missing and <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> is None:

2004

1914 # convert the None from a default to a ''

2005

1915 <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> = ''

2006

1916 else:

2007

1917 <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> = self.<a title="pythonutils.configobj.ConfigObj._str" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#_str">_str</a>(<a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a>)

2008

1918 if (<a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> != val) or missing:

2009

1919 section[entry] = <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a>

2010

1920 if not copy and missing and entry not in section.defaults:

2011

1921 section.defaults.append(entry)

2012

1922 #

2013

1923 # Missing sections will have been created as empty ones when the

2014

1924 # configspec was read.

2015

1925 for entry in section.sections:

2016

1926 # FIXME: this means DEFAULT is not copied in copy mode

2017

1927 if section is self and entry == 'DEFAULT':

2018

1928 continue

2019

1929 if copy:

2020

1930 section.comments[entry] = section._cs_section_comments[entry]

2021

1931 section.inline_comments[entry] = (

2022

1932 section._cs_section_inline_comments[entry])

2023

1933 <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> = self.<a title="pythonutils.configobj.ConfigObj.validate" class="py-name" href="pythonutils.configobj.ConfigObj-class.html#validate">validate</a>(validator, preserve_errors=preserve_errors,

2024

1934 copy=copy, section=section[entry])

2025

1935 out[entry] = <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a>

2026

1936 if <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> == False:

2027

1937 ret_true = False

2028

1938 elif <a title="pythonutils.configobj.SimpleVal.check" class="py-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a> == True:

2029

1939 ret_false = False

2030

1940 else:

2031

1941 ret_true = False

2032

1942 ret_false = False

2033

1943 #

2034

1944 if ret_true:

2035

1945 return True

2036

1946 elif ret_false:

2037

1947 return False

2038

1948 else:

2039

1949 return out

2040

</div></div>1950

2041

<a name="SimpleVal"></a><div id="SimpleVal-def">1951 <a class="pysrc-toggle" href="#" id="SimpleVal-toggle" onclick="toggle('SimpleVal'); return false;">-</a>class <a class="py-def-name" href="pythonutils.configobj.SimpleVal-class.html">SimpleVal</a>(object):

2042

</div><div id="SimpleVal-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="SimpleVal-expanded">1952 """

2043

1953 A simple validator.

2044

1954 Can be used to check that all members expected are present.

2045

1955

2046

1956 To use it, provide a configspec with all your members in (the value given

2047

1957 will be ignored). Pass an instance of ``SimpleVal`` to the ``validate``

2048

1958 method of your ``ConfigObj``. ``validate`` will return ``True`` if all

2049

1959 members are present, or a dictionary with True/False meaning

2050

1960 present/missing. (Whole missing sections will be replaced with ``False``)

2051

1961 """

2052

1962

2053

<a name="SimpleVal.__init__"></a><div id="SimpleVal.__init__-def">1963 <a class="pysrc-toggle" href="#" id="SimpleVal.__init__-toggle" onclick="toggle('SimpleVal.__init__'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.SimpleVal-class.html#__init__">__init__</a>(self):

2054

</div><div id="SimpleVal.__init__-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="SimpleVal.__init__-expanded">1964 self.baseErrorClass = <a title="pythonutils.configobj.ConfigObjError" class="py-name" href="pythonutils.configobj.ConfigObjError-class.html">ConfigObjError</a>

2055

</div>1965

2056

<a name="SimpleVal.check"></a><div id="SimpleVal.check-def">1966 <a class="pysrc-toggle" href="#" id="SimpleVal.check-toggle" onclick="toggle('SimpleVal.check'); return false;">-</a> def <a class="py-def-name" href="pythonutils.configobj.SimpleVal-class.html#check">check</a>(self, check, member, missing=False):

2057

</div><div id="SimpleVal.check-collapsed" style="display:none;" pad="++++" indent="++++++++"></div><div id="SimpleVal.check-expanded">1967 """A dummy check method, always returns the value unchanged."""

2058

1968 if missing:

2059

1969 raise self.baseErrorClass

2060

1970 return member

2061

</div></div>1971

2062

1972 # Check / processing functions for options

2063

<a name="flatten_errors"></a><div id="flatten_errors-def">1973 <a class="pysrc-toggle" href="#" id="flatten_errors-toggle" onclick="toggle('flatten_errors'); return false;">-</a>def <a class="py-def-name" href="pythonutils.configobj-module.html#flatten_errors">flatten_errors</a>(cfg, res, levels=None, results=None):

2064

</div><div id="flatten_errors-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="flatten_errors-expanded">1974 """

2065

1975 An example function that will turn a nested dictionary of results

2066

1976 (as returned by ``ConfigObj.validate``) into a flat list.

2067

1977

2068

1978 ``cfg`` is the ConfigObj instance being checked, ``res`` is the results

2069

1979 dictionary returned by ``validate``.

2070

1980

2071

1981 (This is a recursive function, so you shouldn't use the ``levels`` or

2072

1982 ``results`` arguments - they are used by the function.

2073

1983

2074

1984 Returns a list of keys that failed. Each member of the list is a tuple :

2075

1985 ::

2076

1986

2077

1987 ([list of sections...], key, result)

2078

1988

2079

1989 If ``validate`` was called with ``preserve_errors=False`` (the default)

2080

1990 then ``result`` will always be ``False``.

2081

1991

2082

1992 *list of sections* is a flattened list of sections that the key was found

2083

1993 in.

2084

1994

2085

1995 If the section was missing then key will be ``None``.

2086

1996

2087

1997 If the value (or section) was missing then ``result`` will be ``False``.

2088

1998

2089

1999 If ``validate`` was called with ``preserve_errors=True`` and a value

2090

2000 was present, but failed the check, then ``result`` will be the exception

2091

2001 object returned. You can use this as a string that describes the failure.

2092

2002

2093

2003 For example *The value "3" is of the wrong type*.

2094

2004

2095

2005 >>> import validate

2096

2006 >>> vtor = validate.Validator()

2097

2007 >>> my_ini = '''

2098

2008 ... option1 = True

2099

2009 ... [section1]

2100

2010 ... option1 = True

2101

2011 ... [section2]

2102

2012 ... another_option = Probably

2103

2013 ... [section3]

2104

2014 ... another_option = True

2105

2015 ... [[section3b]]

2106

2016 ... value = 3

2107

2017 ... value2 = a

2108

2018 ... value3 = 11

2109

2019 ... '''

2110

2020 >>> my_cfg = '''

2111

2021 ... option1 = boolean()

2112

2022 ... option2 = boolean()

2113

2023 ... option3 = boolean(default=Bad_value)

2114

2024 ... [section1]

2115

2025 ... option1 = boolean()

2116

2026 ... option2 = boolean()

2117

2027 ... option3 = boolean(default=Bad_value)

2118

2028 ... [section2]

2119

2029 ... another_option = boolean()

2120

2030 ... [section3]

2121

2031 ... another_option = boolean()

2122

2032 ... [[section3b]]

2123

2033 ... value = integer

2124

2034 ... value2 = integer

2125

2035 ... value3 = integer(0, 10)

2126

2036 ... [[[section3b-sub]]]

2127

2037 ... value = string

2128

2038 ... [section4]

2129

2039 ... another_option = boolean()

2130

2040 ... '''

2131

2041 >>> cs = my_cfg.split('\\n')

2132

2042 >>> ini = my_ini.split('\\n')

2133

2043 >>> cfg = ConfigObj(ini, configspec=cs)

2134

2044 >>> res = cfg.validate(vtor, preserve_errors=True)

2135

2045 >>> errors = []

2136

2046 >>> for entry in flatten_errors(cfg, res):

2137

2047 ... section_list, key, error = entry

2138

2048 ... section_list.insert(0, '[root]')

2139

2049 ... if key is not None:

2140

2050 ... section_list.append(key)

2141

2051 ... else:

2142

2052 ... section_list.append('[missing]')

2143

2053 ... section_string = ', '.join(section_list)

2144

2054 ... errors.append((section_string, ' = ', error))

2145

2055 >>> errors.sort()

2146

2056 >>> for entry in errors:

2147

2057 ... print entry[0], entry[1], (entry[2] or 0)

2148

2058 [root], option2 = 0

2149

2059 [root], option3 = the value "Bad_value" is of the wrong type.

2150

2060 [root], section1, option2 = 0

2151

2061 [root], section1, option3 = the value "Bad_value" is of the wrong type.

2152

2062 [root], section2, another_option = the value "Probably" is of the wrong type.

2153

2063 [root], section3, section3b, section3b-sub, [missing] = 0

2154

2064 [root], section3, section3b, value2 = the value "a" is of the wrong type.

2155

2065 [root], section3, section3b, value3 = the value "11" is too big.

2156

2066 [root], section4, [missing] = 0

2157

2067 """

2158

2068 if levels is None:

2159

2069 # first time called

2160

2070 levels = []

2161

2071 results = []

2162

2072 if res is True:

2163

2073 return results

2164

2074 if res is False:

2165

2075 results.append((levels[:], None, False))

2166

2076 if levels:

2167

2077 levels.<a title="pythonutils.configobj.Section.pop" class="py-name" href="pythonutils.configobj.Section-class.html#pop">pop</a>()

2168

2078 return results

2169

2079 for (key, val) in res.<a title="pythonutils.configobj.Section.items" class="py-name" href="pythonutils.configobj.Section-class.html#items">items</a>():

2170

2080 if val == True:

2171

2081 continue

2172

2082 if isinstance(cfg.<a title="pythonutils.configobj.Section.get" class="py-name" href="pythonutils.configobj.Section-class.html#get">get</a>(key), <a title="pythonutils.configobj.Section.dict" class="py-name" href="pythonutils.configobj.Section-class.html#dict">dict</a>):

2173

2083 # Go down one level

2174

2084 levels.append(key)

2175

2085 <a title="pythonutils.configobj.flatten_errors" class="py-name" href="pythonutils.configobj-module.html#flatten_errors">flatten_errors</a>(cfg[key], val, levels, results)

2176

2086 continue

2177

2087 results.append((levels[:], key, val))

2178

2088 #

2179

2089 # Go up one level

2180

2090 if levels:

2181

2091 levels.<a title="pythonutils.configobj.Section.pop" class="py-name" href="pythonutils.configobj.Section-class.html#pop">pop</a>()

2182

2092 #

2183

2093 return results

2184

</div>2094

2185

2095 """*A programming language is a medium of expression.* - Paul Graham"""

2186

2096 <script type="text/javascript">

2187

<!--

2188

expandto(location.href);

2189

// -->

2190

</script>

2191

</pre>

2192

</div>

2193

2194

2195

<table class="navbar" border="0" width="100%" cellpadding="0"

2196

bgcolor="#a0c0ff" cellspacing="0">

2197

2198

2199

<th bgcolor="#70b0f0" class="navselect"

2200

>   Home   </th>

2201

2202

2203

<th class="navbar">   <a class="navbar"

2204

href="trees.html">Trees</a>   </th>

2205

2206

2207

<th class="navbar">   <a class="navbar"

2208

href="indices.html">Index</a>   </th>

2209

2210

2211

<th class="navbar">   <a class="navbar"

2212

href="help.html">Help</a>   </th>

2213

2214

2215

2216

2217

2218

2219

<a class="navbar" target="_top" href="http://www.voidspace.org.uk/python/configobj.html">ConfigObj</a>

2220

</th></tr></table></th>

2221

</tr>

2222

</table>

2223

2224

<tr>

2225

<td align="left" class="footer">Generated by Epydoc

2226

3.0alpha2 on Sat Apr 29 11:33:54 2006</td>

2227

2228

<a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>

2229

</td>

2230

</tr>

2231

</table>

2232

2233

2234

<!--

2235

// Private objects are initially displayed (because if

2236

// javascript is turned off then we want them to be

2237

// visible); but by default, we want to hide them. So hide

2238

// them unless we have a cookie that says to show them.

2239

checkCookie()

2240

// -->

2241

</script>

2242

2243

</body>

2244

</html>