~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.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 class="navbar">   <a class="navbar"

19

href="pythonutils.configobj-module.html">Home</a>   </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

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

40

</tr>

41

</table>

42

43

44

45

46

Package pythonutils ::

47

<a href="pythonutils.configobj-module.html">Module configobj</a> ::

48

Class ConfigObj

49

</span>

50

</td>

51

<td>

52

53

54

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

55

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

56

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

57

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

58

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

59

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

60

</table>

61

</td>

62

</tr>

63

</table>

64

65

<h2 class="class">Class ConfigObj

66

<br/><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj">source code</a></span></h2>

67

68

object --+

69

|

70

dict --+

71

|

72

<a href="pythonutils.configobj.Section-class.html">Section</a> --+

73

|

74

<strong class="uidshort">ConfigObj</strong>

75

</pre>

76

77

<hr />

78

An object to read, create, and write config files.<br /><br />

79

80

81

82

<table class="summary" border="1" cellpadding="3"

83

cellspacing="0" width="100%" bgcolor="white">

84

85

86

87

88

<th align="left" class="summary">Instance Methods</th>

89

<td align="right" valign="top"

90

><span class="options">[<a href="#section-InstanceMethods"

91

class="privatelink" onclick="toggle_private();"

92

>hide private</a>]</span></td>

93

</tr>

94

</table>

95

</td>

96

</tr>

97

<tr>

98

99

100

</td>

101

<td>

102

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#__init__" class="sig-name">__init__</a>(<span class="sig-arg">self</span>,

103

<span class="sig-arg">infile</span>=<span class="sig-default">None</span>,

104

<span class="sig-arg">options</span>=<span class="sig-default">None</span>,

105

<span class="sig-arg">**kwargs</span>)</span>

106

<br />Parse or create a config file object.

107

</td>

108

</tr>

109

<tr>

110

111

112

</td>

113

<td>

114

115

<br />repr(x)

116

</td>

117

</tr>

118

119

120

121

</td>

122

<td>

123

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_handle_bom" class="sig-name">_handle_bom</a>(<span class="sig-arg">self</span>,

124

<span class="sig-arg">infile</span>)</span>

125

<br />Handle any BOM, and decode if necessary.

126

</td>

127

</tr>

128

129

130

131

</td>

132

<td>

133

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_a_to_u" class="sig-name">_a_to_u</a>(<span class="sig-arg">self</span>,

134

<span class="sig-arg">string</span>)</span>

135

<br />Decode ascii strings to unicode if a self.encoding is specified.

136

</td>

137

</tr>

138

139

140

141

</td>

142

<td>

143

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_decode" class="sig-name">_decode</a>(<span class="sig-arg">self</span>,

144

<span class="sig-arg">infile</span>,

145

<span class="sig-arg">encoding</span>)</span>

146

<br />Decode infile to unicode.

147

</td>

148

</tr>

149

150

151

152

</td>

153

<td>

154

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_decode_element" class="sig-name">_decode_element</a>(<span class="sig-arg">self</span>,

155

156

<br />Decode element to unicode if necessary.

157

</td>

158

</tr>

159

160

161

162

</td>

163

<td>

164

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_str" class="sig-name">_str</a>(<span class="sig-arg">self</span>,

165

<span class="sig-arg">value</span>)</span>

166

<br />Used by <tt class="docutils literal"><span class="pre">stringify</span></tt> within validate, to turn non-string values

167

into strings.

168

</td>

169

</tr>

170

171

172

173

</td>

174

<td>

175

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_parse" class="sig-name">_parse</a>(<span class="sig-arg">self</span>,

176

<span class="sig-arg">infile</span>)</span>

177

<br />Actually parse the config file.

178

</td>

179

</tr>

180

181

182

183

</td>

184

<td>

185

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_match_depth" class="sig-name">_match_depth</a>(<span class="sig-arg">self</span>,

186

<span class="sig-arg">sect</span>,

187

<span class="sig-arg">depth</span>)</span>

188

<br />Given a section and a depth level, walk back through the sections

189

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

190

</td>

191

</tr>

192

193

194

195

</td>

196

<td>

197

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_handle_error" class="sig-name">_handle_error</a>(<span class="sig-arg">self</span>,

198

<span class="sig-arg">text</span>,

199

<span class="sig-arg">ErrorClass</span>,

200

<span class="sig-arg">infile</span>,

201

<span class="sig-arg">cur_index</span>)</span>

202

<br />Handle an error according to the error settings.

203

</td>

204

</tr>

205

206

207

208

</td>

209

<td>

210

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_unquote" class="sig-name">_unquote</a>(<span class="sig-arg">self</span>,

211

<span class="sig-arg">value</span>)</span>

212

<br />Return an unquoted version of a value

213

</td>

214

</tr>

215

216

217

218

</td>

219

<td>

220

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_quote" class="sig-name">_quote</a>(<span class="sig-arg">self</span>,

221

<span class="sig-arg">value</span>,

222

<span class="sig-arg">multiline</span>=<span class="sig-default">True</span>)</span>

223

<br />Return a safely quoted version of a value.

224

</td>

225

</tr>

226

227

228

229

</td>

230

<td>

231

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_handle_value" class="sig-name">_handle_value</a>(<span class="sig-arg">self</span>,

232

<span class="sig-arg">value</span>)</span>

233

<br />Given a value string, unquote, remove comment,

234

handle lists.

235

</td>

236

</tr>

237

238

239

240

</td>

241

<td>

242

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_multiline" class="sig-name">_multiline</a>(<span class="sig-arg">self</span>,

243

<span class="sig-arg">value</span>,

244

<span class="sig-arg">infile</span>,

245

<span class="sig-arg">cur_index</span>,

246

<span class="sig-arg">maxline</span>)</span>

247

<br />Extract the value, where we are in a multiline situation.

248

</td>

249

</tr>

250

251

252

253

</td>

254

<td>

255

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_handle_configspec" class="sig-name">_handle_configspec</a>(<span class="sig-arg">self</span>,

256

<span class="sig-arg">configspec</span>)</span>

257

<br />Parse the configspec.

258

</td>

259

</tr>

260

261

262

263

</td>

264

<td>

265

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_set_configspec_value" class="sig-name">_set_configspec_value</a>(<span class="sig-arg">self</span>,

266

<span class="sig-arg">configspec</span>,

267

<span class="sig-arg">section</span>)</span>

268

<br />Used to recursively set configspec values.

269

</td>

270

</tr>

271

272

273

274

</td>

275

<td>

276

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_handle_repeat" class="sig-name">_handle_repeat</a>(<span class="sig-arg">self</span>,

277

<span class="sig-arg">section</span>,

278

<span class="sig-arg">configspec</span>)</span>

279

<br />Dynamically assign configspec for repeated section.

280

</td>

281

</tr>

282

283

284

285

</td>

286

<td>

287

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_write_line" class="sig-name">_write_line</a>(<span class="sig-arg">self</span>,

288

<span class="sig-arg">indent_string</span>,

289

<span class="sig-arg">entry</span>,

290

<span class="sig-arg">this_entry</span>,

291

<span class="sig-arg">comment</span>)</span>

292

<br />Write an individual line, for the write method

293

</td>

294

</tr>

295

296

297

298

</td>

299

<td>

300

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_write_marker" class="sig-name">_write_marker</a>(<span class="sig-arg">self</span>,

301

<span class="sig-arg">indent_string</span>,

302

<span class="sig-arg">depth</span>,

303

<span class="sig-arg">entry</span>,

304

<span class="sig-arg">comment</span>)</span>

305

<br />Write a section marker line

306

</td>

307

</tr>

308

309

310

311

</td>

312

<td>

313

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_handle_comment" class="sig-name">_handle_comment</a>(<span class="sig-arg">self</span>,

314

<span class="sig-arg">comment</span>)</span>

315

<br />Deal with a comment.

316

</td>

317

</tr>

318

319

320

321

</td>

322

<td>

323

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#_compute_indent_string" class="sig-name">_compute_indent_string</a>(<span class="sig-arg">self</span>,

324

<span class="sig-arg">depth</span>)</span>

325

<br />Compute the indent string, according to current indent_type and depth

326

</td>

327

</tr>

328

<tr>

329

330

331

</td>

332

<td>

333

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#write" class="sig-name">write</a>(<span class="sig-arg">self</span>,

334

<span class="sig-arg">outfile</span>=<span class="sig-default">None</span>,

335

<span class="sig-arg">section</span>=<span class="sig-default">None</span>)</span>

336

<br />Write the current ConfigObj as a file

337

</td>

338

</tr>

339

<tr>

340

341

342

</td>

343

<td>

344

<span class="sig"><a href="pythonutils.configobj.ConfigObj-class.html#validate" class="sig-name">validate</a>(<span class="sig-arg">self</span>,

345

<span class="sig-arg">validator</span>,

346

<span class="sig-arg">preserve_errors</span>=<span class="sig-default">False</span>,

347

<span class="sig-arg">copy</span>=<span class="sig-default">False</span>,

348

<span class="sig-arg">section</span>=<span class="sig-default">None</span>)</span>

349

<br />Test the ConfigObj against a configspec.

350

</td>

351

</tr>

352

<tr>

353

354

<p class="varlist"><span class="varlist-header">Inherited from <code>dict</code></span>:

355

<code>__cmp__</code>,

356

<code>__contains__</code>,

357

<code>__eq__</code>,

358

<code>__ge__</code>,

359

<code>__getattribute__</code>,

360

<code>__gt__</code>,

361

<code>__hash__</code>,

362

<code>__le__</code>,

363

<code>__len__</code>,

364

<code>__lt__</code>,

365

<code>__ne__</code>,

366

<code>__new__</code>,

367

<code>copy</code>,

368

<code>fromkeys</code>,

369

370

</p>

371

<p class="varlist"><span class="varlist-header">Inherited from <code>object</code></span>:

372

<code>__delattr__</code>,

373

<code>__reduce__</code>,

374

<code>__reduce_ex__</code>,

375

<code>__setattr__</code>

376

</p>

377

</td>

378

</tr>

379

380

<th colspan="2" class="group"

381

>    Inherited from <a href="pythonutils.configobj.Section-class.html">Section</a></th></tr>

382

<tr>

383

384

385

</td>

386

<td>

387

<span class="sig"><a href="pythonutils.configobj.Section-class.html#__delitem__" class="sig-name">__delitem__</a>(<span class="sig-arg">self</span>,

388

389

<br />Remove items from the sequence when deleting.

390

</td>

391

</tr>

392

<tr>

393

394

395

</td>

396

<td>

397

<span class="sig"><a href="pythonutils.configobj.Section-class.html#__getitem__" class="sig-name">__getitem__</a>(<span class="sig-arg">self</span>,

398

399

<br />Fetch the item and do string interpolation.

400

</td>

401

</tr>

402

<tr>

403

404

405

</td>

406

<td>

407

408

<br />iter(x)

409

</td>

410

</tr>

411

<tr>

412

413

414

</td>

415

<td>

416

<span class="sig"><a href="pythonutils.configobj.Section-class.html#__setitem__" class="sig-name">__setitem__</a>(<span class="sig-arg">self</span>,

417

<span class="sig-arg">key</span>,

418

<span class="sig-arg">value</span>,

419

<span class="sig-arg">unrepr</span>=<span class="sig-default">False</span>)</span>

420

<br />Correctly set a value.

421

</td>

422

</tr>

423

<tr>

424

425

426

</td>

427

<td>

428

429

<br />repr(x)

430

</td>

431

</tr>

432

433

434

435

</td>

436

<td>

437

<span class="sig"><a href="pythonutils.configobj.Section-class.html#_interpolate" class="sig-name">_interpolate</a>(<span class="sig-arg">self</span>,

438

<span class="sig-arg">value</span>)</span>

439

<br />Nicked from ConfigParser.

440

</td>

441

</tr>

442

443

444

445

</td>

446

<td>

447

<span class="sig"><a href="pythonutils.configobj.Section-class.html#_interpolation_replace" class="sig-name">_interpolation_replace</a>(<span class="sig-arg">self</span>,

448

<span class="sig-arg">match</span>)</span>

449

450

</td>

451

</tr>

452

<tr>

453

454

455

</td>

456

<td>

457

<span class="sig"><a href="pythonutils.configobj.Section-class.html#as_bool" class="sig-name">as_bool</a>(<span class="sig-arg">self</span>,

458

459

<br />Accepts a key as input.

460

</td>

461

</tr>

462

<tr>

463

464

465

</td>

466

<td>

467

<span class="sig"><a href="pythonutils.configobj.Section-class.html#as_float" class="sig-name">as_float</a>(<span class="sig-arg">self</span>,

468

469

<br />A convenience method which coerces the specified value to a float.

470

</td>

471

</tr>

472

<tr>

473

474

475

</td>

476

<td>

477

<span class="sig"><a href="pythonutils.configobj.Section-class.html#as_int" class="sig-name">as_int</a>(<span class="sig-arg">self</span>,

478

479

<br />A convenience method which coerces the specified value to an integer.

480

</td>

481

</tr>

482

<tr>

483

484

485

</td>

486

<td>

487

<span class="sig"><a href="pythonutils.configobj.Section-class.html#clear" class="sig-name">clear</a>(<span class="sig-arg">self</span>)</span>

488

<br />A version of clear that also affects scalars/sections

489

Also clears comments and configspec.

490

</td>

491

</tr>

492

<tr>

493

494

495

</td>

496

<td>

497

<span class="sig"><a href="pythonutils.configobj.Section-class.html#decode" class="sig-name">decode</a>(<span class="sig-arg">self</span>,

498

<span class="sig-arg">encoding</span>)</span>

499

<br />Decode all strings and values to unicode, using the specified encoding.

500

</td>

501

</tr>

502

<tr>

503

504

505

</td>

506

<td>

507

508

<br />Return a deepcopy of self as a dictionary.

509

</td>

510

</tr>

511

<tr>

512

513

514

</td>

515

<td>

516

<span class="sig"><a href="pythonutils.configobj.Section-class.html#encode" class="sig-name">encode</a>(<span class="sig-arg">self</span>,

517

<span class="sig-arg">encoding</span>)</span>

518

<br />Encode all strings and values from unicode,

519

using the specified encoding.

520

</td>

521

</tr>

522

<tr>

523

524

525

</td>

526

<td>

527

<span class="sig"><a href="pythonutils.configobj.Section-class.html#get" class="sig-name">get</a>(<span class="sig-arg">self</span>,

528

<span class="sig-arg">key</span>,

529

<span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span>

530

<br />A version of <tt class="docutils literal"><span class="pre">get</span></tt> that doesn't bypass string interpolation.

531

</td>

532

</tr>

533

<tr>

534

535

536

</td>

537

<td>

538

<span class="sig"><a href="pythonutils.configobj.Section-class.html#istrue" class="sig-name">istrue</a>(<span class="sig-arg">self</span>,

539

540

<br />A deprecated version of <tt class="docutils literal"><span class="pre">as_bool</span></tt>.

541

</td>

542

</tr>

543

<tr>

544

545

546

</td>

547

<td>

548

<span class="sig"><a href="pythonutils.configobj.Section-class.html#items" class="sig-name">items</a>(<span class="sig-arg">self</span>)</span>

549

550

</td>

551

</tr>

552

<tr>

553

554

555

</td>

556

<td>

557

<span class="sig"><a href="pythonutils.configobj.Section-class.html#iteritems" class="sig-name">iteritems</a>(<span class="sig-arg">self</span>)</span>

558

559

</td>

560

</tr>

561

<tr>

562

563

564

</td>

565

<td>

566

<span class="sig"><a href="pythonutils.configobj.Section-class.html#iterkeys" class="sig-name">iterkeys</a>(<span class="sig-arg">self</span>)</span>

567

<br />iter(x)

568

</td>

569

</tr>

570

<tr>

571

572

573

</td>

574

<td>

575

<span class="sig"><a href="pythonutils.configobj.Section-class.html#itervalues" class="sig-name">itervalues</a>(<span class="sig-arg">self</span>)</span>

576

577

</td>

578

</tr>

579

<tr>

580

581

582

</td>

583

<td>

584

585

586

</td>

587

</tr>

588

<tr>

589

590

591

</td>

592

<td>

593

<span class="sig"><a href="pythonutils.configobj.Section-class.html#merge" class="sig-name">merge</a>(<span class="sig-arg">self</span>,

594

<span class="sig-arg">indict</span>)</span>

595

<br />A recursive update - useful for merging config files.

596

</td>

597

</tr>

598

<tr>

599

600

601

</td>

602

<td>

603

<span class="sig"><a href="pythonutils.configobj.Section-class.html#pop" class="sig-name">pop</a>(<span class="sig-arg">self</span>,

604

<span class="sig-arg">key</span>,

605

606

<br />If key is not found, d is returned if given, otherwise KeyError is raised

607

</td>

608

</tr>

609

<tr>

610

611

612

</td>

613

<td>

614

<span class="sig"><a href="pythonutils.configobj.Section-class.html#popitem" class="sig-name">popitem</a>(<span class="sig-arg">self</span>)</span>

615

<br />Pops the first (key,val)

616

</td>

617

</tr>

618

<tr>

619

620

621

</td>

622

<td>

623

<span class="sig"><a href="pythonutils.configobj.Section-class.html#rename" class="sig-name">rename</a>(<span class="sig-arg">self</span>,

624

<span class="sig-arg">oldkey</span>,

625

<span class="sig-arg">newkey</span>)</span>

626

<br />Change a keyname to another, without changing position in sequence.

627

</td>

628

</tr>

629

<tr>

630

631

632

</td>

633

<td>

634

<span class="sig"><a href="pythonutils.configobj.Section-class.html#setdefault" class="sig-name">setdefault</a>(<span class="sig-arg">self</span>,

635

<span class="sig-arg">key</span>,

636

<span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span>

637

<br />A version of setdefault that sets sequence if appropriate.

638

</td>

639

</tr>

640

<tr>

641

642

643

</td>

644

<td>

645

<span class="sig"><a href="pythonutils.configobj.Section-class.html#update" class="sig-name">update</a>(<span class="sig-arg">self</span>,

646

<span class="sig-arg">indict</span>)</span>

647

<br />A version of update that uses our <tt class="docutils literal"><span class="pre">__setitem__</span></tt>.

648

</td>

649

</tr>

650

<tr>

651

652

653

</td>

654

<td>

655

<span class="sig"><a href="pythonutils.configobj.Section-class.html#values" class="sig-name">values</a>(<span class="sig-arg">self</span>)</span>

656

657

</td>

658

</tr>

659

<tr>

660

661

662

</td>

663

<td>

664

<span class="sig"><a href="pythonutils.configobj.Section-class.html#walk" class="sig-name">walk</a>(<span class="sig-arg">self</span>,

665

<span class="sig-arg">function</span>,

666

<span class="sig-arg">raise_errors</span>=<span class="sig-default">True</span>,

667

<span class="sig-arg">call_on_sections</span>=<span class="sig-default">False</span>,

668

<span class="sig-arg">**keywargs</span>)</span>

669

<br />Walk every member and call a function on the keyword and value.

670

</td>

671

</tr>

672

</table>

673

674

<br />

675

676

677

<table class="summary" border="1" cellpadding="3"

678

cellspacing="0" width="100%" bgcolor="white">

679

680

681

682

683

<th align="left" class="summary">Class Variables</th>

684

<td align="right" valign="top"

685

><span class="options">[<a href="#section-ClassVariables"

686

class="privatelink" onclick="toggle_private();"

687

>hide private</a>]</span></td>

688

</tr>

689

</table>

690

</td>

691

</tr>

692

693

694

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_keyword">_keyword</a></strong></td>

695

696

</tr>

697

698

699

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_sectionmarker">_sectionmarker</a></strong></td>

700

701

</tr>

702

703

704

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_valueexp">_valueexp</a></strong></td>

705

706

</tr>

707

708

709

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_listvalueexp">_listvalueexp</a></strong></td>

710

711

</tr>

712

713

714

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_nolistvalue">_nolistvalue</a></strong></td>

715

716

</tr>

717

718

719

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_single_line_single">_single_line_single</a></strong></td>

720

721

</tr>

722

723

724

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_single_line_double">_single_line_double</a></strong></td>

725

726

</tr>

727

728

729

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_multi_line_single">_multi_line_single</a></strong></td>

730

731

</tr>

732

733

734

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_multi_line_double">_multi_line_double</a></strong></td>

735

736

</tr>

737

738

739

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_triple_quote">_triple_quote</a></strong></td>

740

741

</tr>

742

743

744

<strong><a href="pythonutils.configobj.ConfigObj-class.html#_bools">_bools</a></strong></td>

745

746

</tr>

747

<tr>

748

749

<p class="varlist"><span class="varlist-header">Inherited from <code>object</code></span>:

750

<code>__class__</code>

751

</p>

752

</td>

753

</tr>

754

755

<th colspan="2" class="group"

756

>    Inherited from <a href="pythonutils.configobj.Section-class.html">Section</a></th></tr>

757

758

759

<strong><a href="pythonutils.configobj.Section-class.html#_KEYCRE">_KEYCRE</a></strong></td>

760

761

</tr>

762

</table>

763

764

<br />

765

766

767

<table class="details" border="1" cellpadding="3"

768

cellspacing="0" width="100%" bgcolor="white">

769

770

771

772

773

<th align="left" class="details">Method Details</th>

774

<td align="right" valign="top"

775

><span class="options">[<a href="#section-MethodDetails"

776

class="privatelink" onclick="toggle_private();"

777

>hide private</a>]</span></td>

778

</tr>

779

</table>

780

</td>

781

</tr>

782

</table>

783

784

<div>

785

786

787

788

<h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,

789

<span class="sig-arg">infile</span>=<span class="sig-default">None</span>,

790

<span class="sig-arg">options</span>=<span class="sig-default">None</span>,

791

<span class="sig-arg">**kwargs</span>)</span>

792

<br /><em class="fname">(Constructor)</em>

793

</h3>

794

</td><td align="right" valign="top"

795

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj.__init__">source code</a></span> </span

796

></td>

797

</table>

798

799

<p>Parse or create a config file object.</p>

800

<p><tt class="docutils literal"><span class="pre">ConfigObj(infile=None,</span> <span class="pre">options=None,</span> <span class="pre">**kwargs)</span></tt></p>

801

802

<dl><dt>Overrides:

803

<a href="pythonutils.configobj.Section-class.html#__init__">Section.__init__</a>

804

</dt></dl>

805

</dd></dl>

806

</td></tr></table>

807

</div>

808

809

<div>

810

811

812

813

814

<br /><em class="fname">(Representation operator)</em>

815

</h3>

816

</td><td align="right" valign="top"

817

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj.__repr__">source code</a></span> </span

818

></td>

819

</table>

820

821

repr(x)

822

823

<dl><dt>Overrides:

824

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

825

</dt></dl>

826

</dd></dl>

827

</td></tr></table>

828

</div>

829

830

831

832

833

834

<h3><span class="sig"><span class="sig-name">_handle_bom</span>(<span class="sig-arg">self</span>,

835

<span class="sig-arg">infile</span>)</span>

836

</h3>

837

</td><td align="right" valign="top"

838

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._handle_bom">source code</a></span> </span

839

></td>

840

</table>

841

842

<p>Handle any BOM, and decode if necessary.</p>

843

<p>If an encoding is specified, that <em>must</em> be used - but the BOM should

844

still be removed (and the BOM attribute set).</p>

845

<p>(If the encoding is wrongly specified, then a BOM for an alternative

846

encoding won't be discovered or removed.)</p>

847

<p>If an encoding is not specified, UTF8 or UTF16 BOM will be detected and

848

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

849

unicode.</p>

850

<p>NOTE: This method must not be called with an empty <tt class="docutils literal"><span class="pre">infile</span></tt>.</p>

851

<p>Specifying the <em>wrong</em> encoding is likely to cause a

852

<tt class="docutils literal"><span class="pre">UnicodeDecodeError</span></tt>.</p>

853

<p><tt class="docutils literal"><span class="pre">infile</span></tt> must always be returned as a list of lines, but may be

854

passed in as a single string.</p>

855

856

</dd></dl>

857

</td></tr></table>

858

</div>

859

860

861

862

863

864

<h3><span class="sig"><span class="sig-name">_a_to_u</span>(<span class="sig-arg">self</span>,

865

<span class="sig-arg">string</span>)</span>

866

</h3>

867

</td><td align="right" valign="top"

868

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._a_to_u">source code</a></span> </span

869

></td>

870

</table>

871

872

Decode ascii strings to unicode if a self.encoding is specified.

873

874

</dd></dl>

875

</td></tr></table>

876

</div>

877

878

879

880

881

882

<h3><span class="sig"><span class="sig-name">_decode</span>(<span class="sig-arg">self</span>,

883

<span class="sig-arg">infile</span>,

884

<span class="sig-arg">encoding</span>)</span>

885

</h3>

886

</td><td align="right" valign="top"

887

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._decode">source code</a></span> </span

888

></td>

889

</table>

890

891

<p>Decode infile to unicode. Using the specified encoding.</p>

892

<p>if is a string, it also needs converting to a list.</p>

893

894

</dd></dl>

895

</td></tr></table>

896

</div>

897

898

899

900

901

902

<h3><span class="sig"><span class="sig-name">_decode_element</span>(<span class="sig-arg">self</span>,

903

904

</h3>

905

</td><td align="right" valign="top"

906

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._decode_element">source code</a></span> </span

907

></td>

908

</table>

909

910

Decode element to unicode if necessary.

911

912

</dd></dl>

913

</td></tr></table>

914

</div>

915

916

917

918

919

920

<h3><span class="sig"><span class="sig-name">_str</span>(<span class="sig-arg">self</span>,

921

<span class="sig-arg">value</span>)</span>

922

</h3>

923

</td><td align="right" valign="top"

924

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._str">source code</a></span> </span

925

></td>

926

</table>

927

928

Used by <tt class="docutils literal docutils literal"><span class="pre">stringify</span></tt> within validate, to turn non-string values

929

into strings.

930

931

</dd></dl>

932

</td></tr></table>

933

</div>

934

935

936

937

938

939

<h3><span class="sig"><span class="sig-name">_parse</span>(<span class="sig-arg">self</span>,

940

<span class="sig-arg">infile</span>)</span>

941

</h3>

942

</td><td align="right" valign="top"

943

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._parse">source code</a></span> </span

944

></td>

945

</table>

946

947

Actually parse the config file.

948

949

</dd></dl>

950

</td></tr></table>

951

</div>

952

953

954

955

956

957

<h3><span class="sig"><span class="sig-name">_match_depth</span>(<span class="sig-arg">self</span>,

958

<span class="sig-arg">sect</span>,

959

<span class="sig-arg">depth</span>)</span>

960

</h3>

961

</td><td align="right" valign="top"

962

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._match_depth">source code</a></span> </span

963

></td>

964

</table>

965

966

<p>Given a section and a depth level, walk back through the sections

967

parents to see if the depth level matches a previous section.</p>

968

<p>Return a reference to the right section,

969

or raise a SyntaxError.</p>

970

971

</dd></dl>

972

</td></tr></table>

973

</div>

974

975

976

977

978

979

<h3><span class="sig"><span class="sig-name">_handle_error</span>(<span class="sig-arg">self</span>,

980

<span class="sig-arg">text</span>,

981

<span class="sig-arg">ErrorClass</span>,

982

<span class="sig-arg">infile</span>,

983

<span class="sig-arg">cur_index</span>)</span>

984

</h3>

985

</td><td align="right" valign="top"

986

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._handle_error">source code</a></span> </span

987

></td>

988

</table>

989

990

<p>Handle an error according to the error settings.</p>

991

<p>Either raise the error or store it.

992

The error will have occured at <tt class="docutils literal"><span class="pre">cur_index</span></tt></p>

993

994

</dd></dl>

995

</td></tr></table>

996

</div>

997

998

999

1000

1001

1002

<h3><span class="sig"><span class="sig-name">_unquote</span>(<span class="sig-arg">self</span>,

1003

<span class="sig-arg">value</span>)</span>

1004

</h3>

1005

</td><td align="right" valign="top"

1006

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._unquote">source code</a></span> </span

1007

></td>

1008

</table>

1009

1010

Return an unquoted version of a value

1011

1012

</dd></dl>

1013

</td></tr></table>

1014

</div>

1015

1016

1017

1018

1019

1020

<h3><span class="sig"><span class="sig-name">_quote</span>(<span class="sig-arg">self</span>,

1021

<span class="sig-arg">value</span>,

1022

<span class="sig-arg">multiline</span>=<span class="sig-default">True</span>)</span>

1023

</h3>

1024

</td><td align="right" valign="top"

1025

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._quote">source code</a></span> </span

1026

></td>

1027

</table>

1028

1029

1030

<p>Return a safely quoted version of a value.</p>

1031

<p>Raise a ConfigObjError if the value cannot be safely quoted.

1032

If multiline is <tt class="docutils literal"><span class="pre">True</span></tt> (default) then use triple quotes

1033

if necessary.</p>

1034

<p>Don't quote values that don't need it.

1035

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

1036

Multiline is <tt class="docutils literal"><span class="pre">False</span></tt> for lists.

1037

Obey list syntax for empty and single member lists.</p>

1038

<p>If <tt class="docutils literal"><span class="pre">list_values=False</span></tt> then the value is only quoted if it contains

1039

a ``</p>

1040

</blockquote>

1041

<p>`` (is multiline).</p>

1042

1043

If <tt class="docutils literal"><span class="pre">write_empty_values</span></tt> is set, and the value is an empty string, it

1044

won't be quoted.</blockquote>

1045

1046

</dd></dl>

1047

</td></tr></table>

1048

</div>

1049

1050

1051

1052

1053

1054

<h3><span class="sig"><span class="sig-name">_handle_value</span>(<span class="sig-arg">self</span>,

1055

<span class="sig-arg">value</span>)</span>

1056

</h3>

1057

</td><td align="right" valign="top"

1058

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._handle_value">source code</a></span> </span

1059

></td>

1060

</table>

1061

1062

Given a value string, unquote, remove comment,

1063

handle lists. (including empty and single member lists)

1064

1065

</dd></dl>

1066

</td></tr></table>

1067

</div>

1068

1069

1070

1071

1072

1073

<h3><span class="sig"><span class="sig-name">_multiline</span>(<span class="sig-arg">self</span>,

1074

<span class="sig-arg">value</span>,

1075

<span class="sig-arg">infile</span>,

1076

<span class="sig-arg">cur_index</span>,

1077

<span class="sig-arg">maxline</span>)</span>

1078

</h3>

1079

</td><td align="right" valign="top"

1080

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._multiline">source code</a></span> </span

1081

></td>

1082

</table>

1083

1084

Extract the value, where we are in a multiline situation.

1085

1086

</dd></dl>

1087

</td></tr></table>

1088

</div>

1089

1090

1091

1092

1093

1094

<h3><span class="sig"><span class="sig-name">_handle_configspec</span>(<span class="sig-arg">self</span>,

1095

<span class="sig-arg">configspec</span>)</span>

1096

</h3>

1097

</td><td align="right" valign="top"

1098

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._handle_configspec">source code</a></span> </span

1099

></td>

1100

</table>

1101

1102

Parse the configspec.

1103

1104

</dd></dl>

1105

</td></tr></table>

1106

</div>

1107

1108

1109

1110

1111

1112

<h3><span class="sig"><span class="sig-name">_set_configspec_value</span>(<span class="sig-arg">self</span>,

1113

<span class="sig-arg">configspec</span>,

1114

<span class="sig-arg">section</span>)</span>

1115

</h3>

1116

</td><td align="right" valign="top"

1117

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._set_configspec_value">source code</a></span> </span

1118

></td>

1119

</table>

1120

1121

Used to recursively set configspec values.

1122

1123

</dd></dl>

1124

</td></tr></table>

1125

</div>

1126

1127

1128

1129

1130

1131

<h3><span class="sig"><span class="sig-name">_handle_repeat</span>(<span class="sig-arg">self</span>,

1132

<span class="sig-arg">section</span>,

1133

<span class="sig-arg">configspec</span>)</span>

1134

</h3>

1135

</td><td align="right" valign="top"

1136

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._handle_repeat">source code</a></span> </span

1137

></td>

1138

</table>

1139

1140

Dynamically assign configspec for repeated section.

1141

1142

</dd></dl>

1143

</td></tr></table>

1144

</div>

1145

1146

1147

1148

1149

1150

<h3><span class="sig"><span class="sig-name">_write_line</span>(<span class="sig-arg">self</span>,

1151

<span class="sig-arg">indent_string</span>,

1152

<span class="sig-arg">entry</span>,

1153

<span class="sig-arg">this_entry</span>,

1154

<span class="sig-arg">comment</span>)</span>

1155

</h3>

1156

</td><td align="right" valign="top"

1157

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._write_line">source code</a></span> </span

1158

></td>

1159

</table>

1160

1161

Write an individual line, for the write method

1162

1163

</dd></dl>

1164

</td></tr></table>

1165

</div>

1166

1167

1168

1169

1170

1171

<h3><span class="sig"><span class="sig-name">_write_marker</span>(<span class="sig-arg">self</span>,

1172

<span class="sig-arg">indent_string</span>,

1173

<span class="sig-arg">depth</span>,

1174

<span class="sig-arg">entry</span>,

1175

<span class="sig-arg">comment</span>)</span>

1176

</h3>

1177

</td><td align="right" valign="top"

1178

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._write_marker">source code</a></span> </span

1179

></td>

1180

</table>

1181

1182

Write a section marker line

1183

1184

</dd></dl>

1185

</td></tr></table>

1186

</div>

1187

1188

1189

1190

1191

1192

<h3><span class="sig"><span class="sig-name">_handle_comment</span>(<span class="sig-arg">self</span>,

1193

<span class="sig-arg">comment</span>)</span>

1194

</h3>

1195

</td><td align="right" valign="top"

1196

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._handle_comment">source code</a></span> </span

1197

></td>

1198

</table>

1199

1200

Deal with a comment.

1201

1202

</dd></dl>

1203

</td></tr></table>

1204

</div>

1205

1206

1207

1208

1209

1210

<h3><span class="sig"><span class="sig-name">_compute_indent_string</span>(<span class="sig-arg">self</span>,

1211

<span class="sig-arg">depth</span>)</span>

1212

</h3>

1213

</td><td align="right" valign="top"

1214

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj._compute_indent_string">source code</a></span> </span

1215

></td>

1216

</table>

1217

1218

Compute the indent string, according to current indent_type and depth

1219

1220

</dd></dl>

1221

</td></tr></table>

1222

</div>

1223

1224

<div>

1225

1226

1227

1228

<h3><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,

1229

<span class="sig-arg">outfile</span>=<span class="sig-default">None</span>,

1230

<span class="sig-arg">section</span>=<span class="sig-default">None</span>)</span>

1231

</h3>

1232

</td><td align="right" valign="top"

1233

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj.write">source code</a></span> </span

1234

></td>

1235

</table>

1236

1237

<p>Write the current ConfigObj as a file</p>

1238

<p>tekNico: FIXME: use StringIO instead of real files</p>

1239

1240

>>> filename = a.filename

1241

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

1242

>>> a.write()

1243

>>> a.filename = filename

1244

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

1245

1

1246

</pre>

1247

1248

</dd></dl>

1249

</td></tr></table>

1250

</div>

1251

1252

<div>

1253

1254

1255

1256

<h3><span class="sig"><span class="sig-name">validate</span>(<span class="sig-arg">self</span>,

1257

<span class="sig-arg">validator</span>,

1258

<span class="sig-arg">preserve_errors</span>=<span class="sig-default">False</span>,

1259

<span class="sig-arg">copy</span>=<span class="sig-default">False</span>,

1260

<span class="sig-arg">section</span>=<span class="sig-default">None</span>)</span>

1261

</h3>

1262

</td><td align="right" valign="top"

1263

><span class="codelink"><a href="pythonutils.configobj-pysrc.html#ConfigObj.validate">source code</a></span> </span

1264

></td>

1265

</table>

1266

1267

<p>Test the ConfigObj against a configspec.</p>

1268

<p>It uses the <tt class="docutils literal"><span class="pre">validator</span></tt> object from <em>validate.py</em>.</p>

1269

<p>To run <tt class="docutils literal"><span class="pre">validate</span></tt> on the current ConfigObj, call:</p>

1270

1271

test = config.validate(validator)

1272

</pre>

1273

<p>(Normally having previously passed in the configspec when the ConfigObj

1274

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

1275

<tt class="docutils literal"><span class="pre">configspec</span></tt> attribute of a section though).</p>

1276

<p>It returns <tt class="docutils literal"><span class="pre">True</span></tt> if everything passes, or a dictionary of

1277

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

1278

will just have the value <tt class="docutils literal"><span class="pre">True</span></tt>. (It also returns <tt class="docutils literal"><span class="pre">False</span></tt> if all

1279

members fail).</p>

1280

<p>In addition, it converts the values from strings to their native

1281

types if their checks pass (and <tt class="docutils literal"><span class="pre">stringify</span></tt> is set).</p>

1282

<p>If <tt class="docutils literal"><span class="pre">preserve_errors</span></tt> is <tt class="docutils literal"><span class="pre">True</span></tt> (<tt class="docutils literal"><span class="pre">False</span></tt> is default) then instead

1283

of a marking a fail with a <tt class="docutils literal"><span class="pre">False</span></tt>, it will preserve the actual

1284

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

1285

For example the <tt class="docutils literal"><span class="pre">VdtValueTooSmallError</span></tt> indeicates that the value

1286

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

1287

still be marked as <tt class="docutils literal"><span class="pre">False</span></tt>.</p>

1288

<p>You must have the validate module to use <tt class="docutils literal"><span class="pre">preserve_errors=True</span></tt>.</p>

1289

<p>You can then use the <tt class="docutils literal"><span class="pre">flatten_errors</span></tt> function to turn your nested

1290

results dictionary into a flattened list of failures - useful for

1291

displaying meaningful error messages.</p>

1292

1293

</dd></dl>

1294

</td></tr></table>

1295

</div>

1296

<br />

1297

1298

1299

<table class="details" border="1" cellpadding="3"

1300

cellspacing="0" width="100%" bgcolor="white">

1301

1302

1303

1304

1305

<th align="left" class="details">Class Variable Details</th>

1306

<td align="right" valign="top"

1307

><span class="options">[<a href="#section-ClassVariableDetails"

1308

class="privatelink" onclick="toggle_private();"

1309

>hide private</a>]</span></td>

1310

</tr>

1311

</table>

1312

</td>

1313

</tr>

1314

</table>

1315

1316

1317

1318

<h3>_keyword</h3>

1319

1320

1321

<dl title="<_sre.SRE_Pattern object at 0x01F20D68>"><dt>Value:</dt>

1322

1323

1324

</pre></td></tr></table></dd>

1325

</dl>

1326

</dd></dl>

1327

</td></tr></table>

1328

</div>

1329

1330

1331

1332

<h3>_sectionmarker</h3>

1333

1334

1335

<dl title="<_sre.SRE_Pattern object at 0x00BDC318>"><dt>Value:</dt>

1336

1337

1338

</span><span class="re-group">(</span><span class="re-group">(?:</span><span class="re-char">\s</span><span class="re-op">*</span><span class="re-char">\]</span><span class="re-group">)</span><span class="re-op">+</span><span class="re-group">)</span><span class="re-char">\s</span><span class="re-op">*</span><span class="re-group">(</span>#<span class="re-char">.</span><span class="re-op">*</span><span class="re-group">)</span><span class="re-op">?</span><span class="re-char">$</span></span>

1339

</pre></td></tr></table></dd>

1340

</dl>

1341

</dd></dl>

1342

</td></tr></table>

1343

</div>

1344

1345

1346

1347

<h3>_valueexp</h3>

1348

1349

1350

<dl title="<_sre.SRE_Pattern object at 0x01F20958>"><dt>Value:</dt>

1351

1352

1353

?</span>"<span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(?:</span>'<span class="re-char">.</span><span class="re-op">*?</span>'<span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(?:</span><span class="re-group">[</span><span class="re-group">^</span>'",#<span class="re-char">\s</span><span class="re-group">]</span><span class="re-group">[^</span>,<span class="re-group">]</span><span class="re-op">*?</span><span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(?:</span><span class="re-group">(?!</span>,<span class="re-group">)</span><span class="re-group">)</span><span class="re-group">)</span><span class="re-op">?</span><span class="re-group">)</span><span class="re-op">|</span><span class="re-group">(</span>,<span class="re-group">)</span><span class="re-group">)</span><span class="re-char">\s</span><span class="re-op">*</span><span class="re-group">(</span>#<span class="re-char">.</span><span class="re-op">*</span><span class="re-group">)</span><span class="re-op">?</span><span class="re-char">$</span></span>

1354

</pre></td></tr></table></dd>

1355

</dl>

1356

</dd></dl>

1357

</td></tr></table>

1358

</div>

1359

1360

1361

1362

<h3>_listvalueexp</h3>

1363

1364

1365

<dl title="<_sre.SRE_Pattern object at 0x01E1BAA0>"><dt>Value:</dt>

1366

1367

1368

</pre></td></tr></table></dd>

1369

</dl>

1370

</dd></dl>

1371

</td></tr></table>

1372

</div>

1373

1374

1375

1376

<h3>_nolistvalue</h3>

1377

1378

1379

<dl title="<_sre.SRE_Pattern object at 0x01E87380>"><dt>Value:</dt>

1380

1381

1382

</pre></td></tr></table></dd>

1383

</dl>

1384

</dd></dl>

1385

</td></tr></table>

1386

</div>

1387

1388

1389

1390

<h3>_single_line_single</h3>

1391

1392

1393

<dl title="<_sre.SRE_Pattern object at 0x01EDA608>"><dt>Value:</dt>

1394

1395

1396

</pre></td></tr></table></dd>

1397

</dl>

1398

</dd></dl>

1399

</td></tr></table>

1400

</div>

1401

1402

1403

1404

<h3>_single_line_double</h3>

1405

1406

1407

<dl title="<_sre.SRE_Pattern object at 0x01EDA6B0>"><dt>Value:</dt>

1408

1409

1410

</pre></td></tr></table></dd>

1411

</dl>

1412

</dd></dl>

1413

</td></tr></table>

1414

</div>

1415

1416

1417

1418

<h3>_multi_line_single</h3>

1419

1420

1421

<dl title="<_sre.SRE_Pattern object at 0x01E61D30>"><dt>Value:</dt>

1422

1423

1424

</pre></td></tr></table></dd>

1425

</dl>

1426

</dd></dl>

1427

</td></tr></table>

1428

</div>

1429

1430

1431

1432

<h3>_multi_line_double</h3>

1433

1434

1435

<dl title="<_sre.SRE_Pattern object at 0x01F34020>"><dt>Value:</dt>

1436

1437

1438

</pre></td></tr></table></dd>

1439

</dl>

1440

</dd></dl>

1441

</td></tr></table>

1442

</div>

1443

1444

1445

1446

<h3>_triple_quote</h3>

1447

1448

1449

<dl title="{"'''": (<_sre.SRE_Pattern object at 0x01EDA608>, <_sre.SRE_Pattern object at 0x01E61D30>), '"""': (<_sre.SRE_Pattern object at 0x01EDA6B0>, <_sre.SRE_Pattern object at 0x01F34020>)}"><dt>Value:</dt>

1450

1451

{'"""': (<_sre.SRE_Pattern object at 0x01EDA6B0>,

1452

<_sre.SRE_Pattern object at 0x01F34020>),

1453

"'''": (<_sre.SRE_Pattern object at 0x01EDA608>,

1454

<_sre.SRE_Pattern object at 0x01E61D30>)}

1455

</pre></td></tr></table></dd>

1456

</dl>

1457

</dd></dl>

1458

</td></tr></table>

1459

</div>

1460

1461

1462

1463

<h3>_bools</h3>

1464

1465

1466

<dl title="{'on': True, 'off': False, 'no': False, '1': True, '0': False, 'false': False, 'yes': True, 'true': True}"><dt>Value:</dt>

1467

1468

{'0': False,

1469

'1': True,

1470

'false': False,

1471

'no': False,

1472

'off': False,

1473

'on': True,

1474

'true': True,

1475

'yes': True}

1476

</pre></td></tr></table></dd>

1477

</dl>

1478

</dd></dl>

1479

</td></tr></table>

1480

</div>

1481

<br />

1482

1483

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

1484

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

1485

1486

1487

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

1488

href="pythonutils.configobj-module.html">Home</a>   </th>

1489

1490

1491

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

1492

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

1493

1494

1495

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

1496

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

1497

1498

1499

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

1500

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

1501

1502

1503

1504

1505

1506

1507

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

1508

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

1509

</tr>

1510

</table>

1511

1512

<tr>

1513

<td align="left" class="footer">Generated by Epydoc

1514

3.0alpha2 on Sat Apr 29 11:33:52 2006</td>

1515

1516

<a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>

1517

</td>

1518

</tr>

1519

</table>

1520

1521

1522

<!--

1523

// Private objects are initially displayed (because if

1524

// javascript is turned off then we want them to be

1525

// visible); but by default, we want to hide them. So hide

1526

// them unless we have a cookie that says to show them.

1527

checkCookie()

1528

// -->

1529

</script>

1530

1531

</body>

1532

</html>