python-docs-fa/library/configparser.html at gh-pages · python/python-docs-fa

History

1785 lines (1657 loc) · 176 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<head>

<title>configparser --- Configuration file parser — مستندات Python3.14.6</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

title="جستجو در مستندات Python3.14.6"

href="../_static/opensearch.xml"/>

<style>

@media only screen {

table.full-width-table {

width: 100%;

}

</style>

</head>

<body>

<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">

</label>

</a>

</svg>

</form>

</nav>

Theme

<option value="light">Light</option>

</select>

</label>

<div>

<h3><a href="../contents.html">فهرست عناوین</a></h3>

<ul>

<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">configparser</code> --- Configuration file parser</a><ul>

<li><a class="reference internal" href="#quick-start">Quick Start</a></li>

<li><a class="reference internal" href="#supported-datatypes">Supported Datatypes</a></li>

<li><a class="reference internal" href="#fallback-values">Fallback Values</a></li>

<li><a class="reference internal" href="#supported-ini-file-structure">Supported INI File Structure</a></li>

<li><a class="reference internal" href="#unnamed-sections">Unnamed Sections</a></li>

<li><a class="reference internal" href="#interpolation-of-values">Interpolation of values</a></li>

<li><a class="reference internal" href="#mapping-protocol-access">Mapping Protocol Access</a></li>

<li><a class="reference internal" href="#customizing-parser-behaviour">Customizing Parser Behaviour</a></li>

<li><a class="reference internal" href="#legacy-api-examples">Legacy API Examples</a></li>

<li><a class="reference internal" href="#configparser-objects">ConfigParser Objects</a></li>

<li><a class="reference internal" href="#rawconfigparser-objects">RawConfigParser Objects</a></li>

<li><a class="reference internal" href="#exceptions">Exceptions</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>موضوع قبلی</h4>

<a href="csv.html"

title="فصل قبلی"><code class="xref py py-mod docutils literal notranslate">csv</code> --- CSV File Reading and Writing</a>

</div>

<div>

<h4>موضوع بعدی</h4>

<a href="tomllib.html"

title="فصل بعدی"><code class="xref py py-mod docutils literal notranslate">tomllib</code> --- Parse TOML files</a>

</div>

document.addEventListener('DOMContentLoaded', () => {

const title = document.querySelector('meta[property="og:title"]').content;

const elements = document.querySelectorAll('.improvepage');

const pageurl = window.location.href.split('?')[0];

elements.forEach(element => {

const url = new URL(element.href.split('?')[0].replace("-nojs", ""));

url.searchParams.set('pagetitle', title);

url.searchParams.set('pageurl', pageurl);

url.searchParams.set('pagesource', "library/configparser.rst");

element.href = url.toString();

});

</script>

<li><a href="../bugs.html">گزارش یک اشکال</a></li>

<li><a class="improvepage" href="../improve-page-nojs.html">بهبود این صفحه</a></li>

<li>

<a href="https://github.com/python/cpython/blob/main/Doc/library/configparser.rst?plain=1"

rel="nofollow">نمایش منبع

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/library/configparser.po?plain=1"

rel="nofollow">نمایش منبع ترجمه</a>

</li>

</ul>

</div>

</nav>

</div>

<h3>ناوبری</h3>

<ul>

<a href="../genindex.html" title="فهرست کلی"

accesskey="I">فهرست</a></li>

<a href="../py-modindex.html" title="نمایه ی ماژول های پایتون"

>ماژول ها</a> |</li>

<a href="tomllib.html" title="tomllib --- Parse TOML files"

accesskey="N">بعدی</a> |</li>

<a href="csv.html" title="csv --- CSV File Reading and Writing"

accesskey="P">قبلی</a> |</li>

<li><a href="https://www.python.org/">Python</a> »</li>

</li>

<li>

</li>

<a href="../index.html">3.14.6 Documentation</a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>

<li class="nav-item nav-item-2"><a href="fileformats.html" accesskey="U">File Formats</a> »</li>

<li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">configparser</code> --- Configuration file parser</a></li>

</form>

</div>

</li>

Theme

<option value="light">Light</option>

</select>

</label> |</li>

</ul>

</div>

<h1><code class="xref py py-mod docutils literal notranslate">configparser</code> --- Configuration file parser<a class="headerlink" href="#module-configparser" title="Link to this heading">¶</a></h1>

Source code: <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/3.14/Lib/configparser.py">Lib/configparser.py</a>

This module provides the <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a> class which implements a basic

configuration language which provides a structure similar to what's found in

Microsoft Windows INI files. You can use this to write Python programs which

can be customized by end users easily.

توجه

This library does not interpret or write the value-type prefixes used in

the Windows Registry extended version of INI syntax.

</div>

همچنین ملاحظه نمائید

<dt>Module <a class="reference internal" href="tomllib.html#module-tomllib" title="tomllib: Parse TOML files."><code class="xref py py-mod docutils literal notranslate">tomllib</code></a></dt><dd>TOML is a well-specified format for application configuration files.

It is specifically designed to be an improved version of INI.

</dd>

<dt>Module <a class="reference internal" href="shlex.html#module-shlex" title="shlex: Simple lexical analysis for Unix shell-like languages."><code class="xref py py-mod docutils literal notranslate">shlex</code></a></dt><dd>Support for creating Unix shell-like mini-languages which can also

be used for application configuration files.

</dd>

<dt>Module <a class="reference internal" href="json.html#module-json" title="json: Encode and decode the JSON format."><code class="xref py py-mod docutils literal notranslate">json</code></a></dt><dd>The <code class="docutils literal notranslate">json</code> module implements a subset of JavaScript syntax which is

sometimes used for configuration, but does not support comments.

</dd>

</dl>

</div>

<h2>Quick Start<a class="headerlink" href="#quick-start" title="Link to this heading">¶</a></h2>

Let's take a very basic configuration file that looks like this:

<div class="highlight-ini notranslate"><div class="highlight"><pre>[DEFAULT]

ServerAliveInterval = 45

Compression = yes

CompressionLevel = 9

ForwardX11 = yes

[forge.example]

User = hg

[topsecret.server.example]

Port = 50022

ForwardX11 = no

</pre></div>

</div>

The structure of INI files is described <a class="reference external" href="#supported-ini-file-structure">in the following section</a>. Essentially, the file

consists of sections, each of which contains keys with values.

<code class="xref py py-mod docutils literal notranslate">configparser</code> classes can read and write such files. Let's start by

creating the above configuration file programmatically.

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> import configparser

>>> config['DEFAULT'] = {'ServerAliveInterval': '45',

... 'Compression': 'yes',

... 'CompressionLevel': '9'}

>>> config['forge.example'] = {}

>>> config['forge.example']['User'] = 'hg'

>>> config['topsecret.server.example'] = {}

>>> topsecret = config['topsecret.server.example']

>>> topsecret['Port'] = '50022' # mutates the parser

>>> topsecret['ForwardX11'] = 'no' # same here

>>> config['DEFAULT']['ForwardX11'] = 'yes'

>>> with open('example.ini', 'w') as configfile:

... config.write(configfile)

...

</pre></div>

</div>

As you can see, we can treat a config parser much like a dictionary.

There are differences, <a class="reference external" href="#mapping-protocol-access">outlined later</a>, but

the behavior is very close to what you would expect from a dictionary.

Now that we have created and saved a configuration file, let's read it

back and explore the data it holds.

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> config = configparser.ConfigParser()

>>> config.sections()

[]

>>> config.read('example.ini')

['example.ini']

>>> config.sections()

['forge.example', 'topsecret.server.example']

>>> 'forge.example' in config

True

>>> 'python.org' in config

False

>>> config['forge.example']['User']

'hg'

'yes'

>>> topsecret['ForwardX11']

'no'

>>> topsecret['Port']

'50022'

>>> for key in config['forge.example']:

... print(key)

user

compressionlevel

serveraliveinterval

compression

forwardx11

'yes'

</pre></div>

</div>

As we can see above, the API is pretty straightforward. The only bit of magic

involves the <code class="docutils literal notranslate">DEFAULT</code> section which provides default values for all other

sections <a class="footnote-reference brackets" href="#id16" id="id1" role="doc-noteref">[1]</a>. Note also that keys in sections are

case-insensitive and stored in lowercase <a class="footnote-reference brackets" href="#id16" id="id2" role="doc-noteref">[1]</a>.

It is possible to read several configurations into a single

<a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a>, where the most recently added configuration has the

highest priority. Any conflicting keys are taken from the more recent

configuration while the previously existing keys are retained. The example

below reads in an <code class="docutils literal notranslate">override.ini</code> file, which will override any conflicting

keys from the <code class="docutils literal notranslate">example.ini</code> file.

<div class="highlight-ini notranslate"><div class="highlight"><pre>[DEFAULT]

ServerAliveInterval = -1

</pre></div>

</div>

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> config_override = configparser.ConfigParser()

>>> config_override['DEFAULT'] = {'ServerAliveInterval': '-1'}

>>> with open('override.ini', 'w') as configfile:

... config_override.write(configfile)

...

>>> config_override = configparser.ConfigParser()

>>> config_override.read(['example.ini', 'override.ini'])

['example.ini', 'override.ini']

>>> print(config_override.get('DEFAULT', 'ServerAliveInterval'))

-1

</pre></div>

</div>

This behaviour is equivalent to a <a class="reference internal" href="#configparser.ConfigParser.read" title="configparser.ConfigParser.read"><code class="xref py py-meth docutils literal notranslate">ConfigParser.read()</code></a> call with several

files passed to the filenames parameter.

</section>

<h2>Supported Datatypes<a class="headerlink" href="#supported-datatypes" title="Link to this heading">¶</a></h2>

Config parsers do not guess datatypes of values in configuration files, always

storing them internally as strings. This means that if you need other

datatypes, you should convert on your own:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> int(topsecret['Port'])

50022

>>> float(topsecret['CompressionLevel'])

9.0

</pre></div>

</div>

Since this task is so common, config parsers provide a range of handy getter

methods to handle integers, floats and booleans. The last one is the most

interesting because simply passing the value to <code class="docutils literal notranslate">bool()</code> would do no good

since <code class="docutils literal notranslate">bool('False')</code> is still <code class="docutils literal notranslate">True</code>. This is why config parsers also

provide <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate">getboolean()</code></a>. This method is case-insensitive and

recognizes Boolean values from <code class="docutils literal notranslate">'yes'</code>/<code class="docutils literal notranslate">'no'</code>, <code class="docutils literal notranslate">'on'</code>/<code class="docutils literal notranslate">'off'</code>,

<code class="docutils literal notranslate">'true'</code>/<code class="docutils literal notranslate">'false'</code> and <code class="docutils literal notranslate">'1'</code>/<code class="docutils literal notranslate">'0'</code> <a class="footnote-reference brackets" href="#id16" id="id3" role="doc-noteref">[1]</a>. For example:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> topsecret.getboolean('ForwardX11')

False

>>> config['forge.example'].getboolean('ForwardX11')

True

>>> config.getboolean('forge.example', 'Compression')

True

</pre></div>

</div>

Apart from <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate">getboolean()</code></a>, config parsers also

provide equivalent <a class="reference internal" href="#configparser.ConfigParser.getint" title="configparser.ConfigParser.getint"><code class="xref py py-meth docutils literal notranslate">getint()</code></a> and

<a class="reference internal" href="#configparser.ConfigParser.getfloat" title="configparser.ConfigParser.getfloat"><code class="xref py py-meth docutils literal notranslate">getfloat()</code></a> methods. You can register your own

converters and customize the provided ones. <a class="footnote-reference brackets" href="#id16" id="id4" role="doc-noteref">[1]</a>

</section>

<h2>Fallback Values<a class="headerlink" href="#fallback-values" title="Link to this heading">¶</a></h2>

As with a dictionary, you can use a section's <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate">get()</code></a> method to

provide fallback values:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> topsecret.get('Port')

'50022'

>>> topsecret.get('CompressionLevel')

'9'

>>> topsecret.get('Cipher')

>>> topsecret.get('Cipher', '3des-cbc')

'3des-cbc'

</pre></div>

</div>

Please note that default values have precedence over fallback values.

For instance, in our example the <code class="docutils literal notranslate">'CompressionLevel'</code> key was

specified only in the <code class="docutils literal notranslate">'DEFAULT'</code> section. If we try to get it from

the section <code class="docutils literal notranslate">'topsecret.server.example'</code>, we will always get the default,

even if we specify a fallback:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> topsecret.get('CompressionLevel', '3')

'9'

</pre></div>

</div>

One more thing to be aware of is that the parser-level <a class="reference internal" href="#configparser.ConfigParser.get" title="configparser.ConfigParser.get"><code class="xref py py-meth docutils literal notranslate">get()</code></a> method

provides a custom, more complex interface, maintained for backwards

compatibility. When using this method, a fallback value can be provided via

the <code class="docutils literal notranslate">fallback</code> keyword-only argument:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> config.get('forge.example', 'monster',

... fallback='No such things as monsters')

'No such things as monsters'

</pre></div>

</div>

The same <code class="docutils literal notranslate">fallback</code> argument can be used with the

<a class="reference internal" href="#configparser.ConfigParser.getint" title="configparser.ConfigParser.getint"><code class="xref py py-meth docutils literal notranslate">getint()</code></a>, <a class="reference internal" href="#configparser.ConfigParser.getfloat" title="configparser.ConfigParser.getfloat"><code class="xref py py-meth docutils literal notranslate">getfloat()</code></a> and

<a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate">getboolean()</code></a> methods, for example:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> 'BatchMode' in topsecret

False

>>> topsecret.getboolean('BatchMode', fallback=True)

True

>>> config['DEFAULT']['BatchMode'] = 'no'

False

</pre></div>

</div>

</section>

<h2>Supported INI File Structure<a class="headerlink" href="#supported-ini-file-structure" title="Link to this heading">¶</a></h2>

A configuration file consists of sections, each led by a <code class="docutils literal notranslate">[section]</code> header,

followed by key/value entries separated by a specific string (<code class="docutils literal notranslate">=</code> or <code class="docutils literal notranslate">:</code> by

default <a class="footnote-reference brackets" href="#id16" id="id5" role="doc-noteref">[1]</a>). By default, section names are case sensitive but keys are not

<a class="footnote-reference brackets" href="#id16" id="id6" role="doc-noteref">[1]</a>. Leading and trailing whitespace is removed from keys and values.

Values can be omitted if the parser is configured to allow it <a class="footnote-reference brackets" href="#id16" id="id7" role="doc-noteref">[1]</a>,

in which case the key/value delimiter may also be left

out. Values can also span multiple lines, as long as they are indented deeper

than the first line of the value. Depending on the parser's mode, blank lines

may be treated as parts of multiline values or ignored.

By default, a valid section name can be any string that does not contain '\n'.

To change this, see <a class="reference internal" href="#configparser.ConfigParser.SECTCRE" title="configparser.ConfigParser.SECTCRE"><code class="xref py py-attr docutils literal notranslate">ConfigParser.SECTCRE</code></a>.

The first section name may be omitted if the parser is configured to allow an

unnamed top level section with <code class="docutils literal notranslate">allow_unnamed_section=True</code>. In this case,

the keys/values may be retrieved by <a class="reference internal" href="#configparser.UNNAMED_SECTION" title="configparser.UNNAMED_SECTION"><code class="xref py py-const docutils literal notranslate">UNNAMED_SECTION</code></a> as in

<code class="docutils literal notranslate">config[UNNAMED_SECTION]</code>.

Configuration files may include comments, prefixed by specific

characters (<code class="docutils literal notranslate">#</code> and <code class="docutils literal notranslate">;</code> by default <a class="footnote-reference brackets" href="#id16" id="id8" role="doc-noteref">[1]</a>). Comments may appear on

their own on an otherwise empty line, possibly indented. <a class="footnote-reference brackets" href="#id16" id="id9" role="doc-noteref">[1]</a>

For example:

<div class="highlight-ini notranslate"><div class="highlight"><pre>[Simple Values]

key=value

spaces in keys=allowed

spaces in values=allowed as well

spaces around the delimiter = obviously

you can also use : to delimit keys from values

[All Values Are Strings]

values like this: 1000000

or this: 3.14159265359

are they treated as numbers? : no

integers, floats and booleans are held as: strings

can use the API to get converted values directly: true

[Multiline Values]

chorus: I'm a lumberjack, and I'm okay

I sleep all night and I work all day

[No Values]

key_without_value

empty string value here =

[You can use comments]

# like this

; or this

# By default only in an empty line.

# Inline comments can be harmful because they prevent users

# from using the delimiting characters as parts of values.

# That being said, this can be customized.

[Sections Can Be Indented]

can_values_be_as_well = True

does_that_mean_anything_special = False

purpose = formatting for readability

multiline_values = are

handled just fine as

long as they are indented

deeper than the first line

of a value

# Did I mention we can indent comments, too?

</pre></div>

</div>

</section>

<h2>Unnamed Sections<a class="headerlink" href="#unnamed-sections" title="Link to this heading">¶</a></h2>

The name of the first section (or unique) may be omitted and values

retrieved by the <a class="reference internal" href="#configparser.UNNAMED_SECTION" title="configparser.UNNAMED_SECTION"><code class="xref py py-const docutils literal notranslate">UNNAMED_SECTION</code></a> attribute.

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> config = """

... option = value

...

... [ Section 2 ]

... another = val

... """

>>> unnamed = configparser.ConfigParser(allow_unnamed_section=True)

>>> unnamed.read_string(config)

>>> unnamed.get(configparser.UNNAMED_SECTION, 'option')

'value'

</pre></div>

</div>

</section>

<h2>Interpolation of values<a class="headerlink" href="#interpolation-of-values" title="Link to this heading">¶</a></h2>

On top of the core functionality, <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a> supports

interpolation. This means values can be preprocessed before returning them

from <code class="docutils literal notranslate">get()</code> calls.

class configparser.BasicInterpolation<a class="headerlink" href="#configparser.BasicInterpolation" title="Link to this definition">¶</a></dt>

<dd>The default implementation used by <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a>. It enables

values to contain format strings which refer to other values in the same

section, or values in the special default section <a class="footnote-reference brackets" href="#id16" id="id11" role="doc-noteref">[1]</a>. Additional default

values can be provided on initialization.

For example:

<div class="highlight-ini notranslate"><div class="highlight"><pre>[Paths]

home_dir: /Users

my_dir: %(home_dir)s/lumberjack

my_pictures: %(my_dir)s/Pictures

[Escape]

# use a %% to escape the % sign (% is the only character that needs to be escaped):

gain: 80%%

</pre></div>

</div>

In the example above, <a class="reference internal" href="#configparser.ConfigParser" title="configparser.ConfigParser"><code class="xref py py-class docutils literal notranslate">ConfigParser</code></a> with interpolation set to

<code class="docutils literal notranslate">BasicInterpolation()</code> would resolve <code class="docutils literal notranslate">%(home_dir)s</code> to the value of

<code class="docutils literal notranslate">home_dir</code> (<code class="docutils literal notranslate">/Users</code> in this case). <code class="docutils literal notranslate">%(my_dir)s</code> in effect would

resolve to <code class="docutils literal notranslate">/Users/lumberjack</code>. All interpolations are done on demand so

keys used in the chain of references do not have to be specified in any

specific order in the configuration file.

With <code class="docutils literal notranslate">interpolation</code> set to <code class="docutils literal notranslate">None</code>, the parser would simply return

<code class="docutils literal notranslate">%(my_dir)s/Pictures</code> as the value of <code class="docutils literal notranslate">my_pictures</code> and

<code class="docutils literal notranslate">%(home_dir)s/lumberjack</code> as the value of <code class="docutils literal notranslate">my_dir</code>.

</dd></dl>

class configparser.ExtendedInterpolation<a class="headerlink" href="#configparser.ExtendedInterpolation" title="Link to this definition">¶</a></dt>

<dd>An alternative handler for interpolation which implements a more advanced

syntax, used for instance in <code class="docutils literal notranslate">zc.buildout</code>. Extended interpolation is

using <code class="docutils literal notranslate">${section:option}</code> to denote a value from a foreign section.

Interpolation can span multiple levels. For convenience, if the

<code class="docutils literal notranslate">section:</code> part is omitted, interpolation defaults to the current section

(and possibly the default values from the special section).

For example, the configuration specified above with basic interpolation,

would look like this with extended interpolation:

<div class="highlight-ini notranslate"><div class="highlight"><pre>[Paths]

home_dir: /Users

my_dir: ${home_dir}/lumberjack

my_pictures: ${my_dir}/Pictures

[Escape]

# use a $$ to escape the $ sign ($ is the only character that needs to be escaped):

cost: $$80

</pre></div>

</div>

Values from other sections can be fetched as well:

<div class="highlight-ini notranslate"><div class="highlight"><pre>[Common]

home_dir: /Users

library_dir: /Library

system_dir: /System

macports_dir: /opt/local

[Frameworks]

Python: 3.2

path: ${Common:system_dir}/Library/Frameworks/

[Arthur]

nickname: Two Sheds

last_name: Jackson

my_dir: ${Common:home_dir}/twosheds

my_pictures: ${my_dir}/Pictures

python_dir: ${Frameworks:path}/Python/Versions/${Frameworks:Python}

</pre></div>

</div>

</dd></dl>

</section>

<h2>Mapping Protocol Access<a class="headerlink" href="#mapping-protocol-access" title="Link to this heading">¶</a></h2>

Added in version 3.2.

</div>

Mapping protocol access is a generic name for functionality that enables using

custom objects as if they were dictionaries. In case of <code class="xref py py-mod docutils literal notranslate">configparser</code>,

the mapping interface implementation is using the

<code class="docutils literal notranslate">parser['section']['option']</code> notation.

<code class="docutils literal notranslate">parser['section']</code> in particular returns a proxy for the section's data in

the parser. This means that the values are not copied but they are taken from

the original parser on demand. What's even more important is that when values

are changed on a section proxy, they are actually mutated in the original

parser.

<code class="xref py py-mod docutils literal notranslate">configparser</code> objects behave as close to actual dictionaries as possible.

The mapping interface is complete and adheres to the

<a class="reference internal" href="collections.abc.html#collections.abc.MutableMapping" title="collections.abc.MutableMapping"><code class="xref py py-class docutils literal notranslate">MutableMapping</code></a> ABC.

However, there are a few differences that should be taken into account:

<ul>

<li>By default, all keys in sections are accessible in a case-insensitive manner

<a class="footnote-reference brackets" href="#id16" id="id12" role="doc-noteref">[1]</a>. E.g. <code class="docutils literal notranslate">for option in parser["section"]</code> yields only <code class="docutils literal notranslate">optionxform</code>'ed

option key names. This means lowercased keys by default. At the same time,

for a section that holds the key <code class="docutils literal notranslate">'a'</code>, both expressions return <code class="docutils literal notranslate">True</code>:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>"a" in parser["section"]

"A" in parser["section"]

</pre></div>

</div>

</li>

<li>All sections include <code class="docutils literal notranslate">DEFAULTSECT</code> values as well which means that

<code class="docutils literal notranslate">.clear()</code> on a section may not leave the section visibly empty. This is

because default values cannot be deleted from the section (because technically

they are not there). If they are overridden in the section, deleting causes

the default value to be visible again. Trying to delete a default value

causes a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate">KeyError</code></a>.</li>

<li><code class="docutils literal notranslate">DEFAULTSECT</code> cannot be removed from the parser:

<li>trying to delete it raises <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a>,</li>

<li><code class="docutils literal notranslate">parser.clear()</code> leaves it intact,</li>

<li><code class="docutils literal notranslate">parser.popitem()</code> never returns it.</li>

</ul>

</li>

<li><code class="docutils literal notranslate">parser.get(section, option, **kwargs)</code> - the second argument is not

a fallback value. Note however that the section-level <code class="docutils literal notranslate">get()</code> methods are

compatible both with the mapping protocol and the classic configparser API.</li>

<li><code class="docutils literal notranslate">parser.items()</code> is compatible with the mapping protocol (returns a list of

section_name, section_proxy pairs including the DEFAULTSECT). However,

this method can also be invoked with arguments: <code class="docutils literal notranslate">parser.items(section, raw,

vars)</code>. The latter call returns a list of option, value pairs for

a specified <code class="docutils literal notranslate">section</code>, with all interpolations expanded (unless

<code class="docutils literal notranslate">raw=True</code> is provided).</li>

</ul>

The mapping protocol is implemented on top of the existing legacy API so that

subclasses overriding the original interface still should have mappings working

as expected.

</section>

<h2>Customizing Parser Behaviour<a class="headerlink" href="#customizing-parser-behaviour" title="Link to this heading">¶</a></h2>

There are nearly as many INI format variants as there are applications using it.

<code class="xref py py-mod docutils literal notranslate">configparser</code> goes a long way to provide support for the largest sensible

set of INI styles available. The default functionality is mainly dictated by

historical background and it's very likely that you will want to customize some

of the features.

The most common way to change the way a specific config parser works is to use

the <code class="xref py py-meth docutils literal notranslate">__init__()</code> options:

<ul>

<li>defaults, default value: <code class="docutils literal notranslate">None</code>

This option accepts a dictionary of key-value pairs which will be initially

put in the <code class="docutils literal notranslate">DEFAULT</code> section. This makes for an elegant way to support

concise configuration files that don't specify values which are the same as

the documented default.

Hint: if you want to specify default values for a specific section, use

<a class="reference internal" href="#configparser.ConfigParser.read_dict" title="configparser.ConfigParser.read_dict"><code class="xref py py-meth docutils literal notranslate">read_dict()</code></a> before you read the actual file.

</li>

<li>dict_type, default value: <a class="reference internal" href="stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate">dict</code></a>

This option has a major impact on how the mapping protocol will behave and how

the written configuration files look. With the standard dictionary, every

section is stored in the order they were added to the parser. Same goes for

options within sections.

An alternative dictionary type can be used for example to sort sections and

options on write-back.

Please note: there are ways to add a set of key-value pairs in a single

operation. When you use a regular dictionary in those operations, the order

of the keys will be ordered. For example:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> parser = configparser.ConfigParser()

>>> parser.read_dict({'section1': {'key1': 'value1',

... 'key2': 'value2',

... 'key3': 'value3'},

... 'section2': {'keyA': 'valueA',

... 'keyB': 'valueB',

... 'keyC': 'valueC'},

... 'section3': {'foo': 'x',

... 'bar': 'y',

... 'baz': 'z'}

... })

>>> parser.sections()

['section1', 'section2', 'section3']

>>> [option for option in parser['section3']]

['foo', 'bar', 'baz']

</pre></div>

</div>

</li>

<li>allow_no_value, default value: <code class="docutils literal notranslate">False</code>

Some configuration files are known to include settings without values, but

which otherwise conform to the syntax supported by <code class="xref py py-mod docutils literal notranslate">configparser</code>. The

allow_no_value parameter to the constructor can be used to

indicate that such values should be accepted:

>>> sample_config = """

... [mysqld]

... user = mysql

... pid-file = /var/run/mysqld/mysqld.pid

... skip-external-locking

... old_passwords = 1

... skip-bdb

... # we don't need ACID today

... skip-innodb

... """

>>> config = configparser.ConfigParser(allow_no_value=True)

>>> config.read_string(sample_config)

>>> # Settings with values are treated as before:

>>> config["mysqld"]["user"]

'mysql'

>>> # Settings without values provide None:

>>> config["mysqld"]["skip-bdb"]

>>> # Settings which aren't specified still raise an error:

>>> config["mysqld"]["does-not-exist"]

Traceback (most recent call last):

...

KeyError: 'does-not-exist'

</pre></div>

</div>

</li>

<li>delimiters, default value: <code class="docutils literal notranslate">('=', ':')</code>

Delimiters are substrings that delimit keys from values within a section.

The first occurrence of a delimiting substring on a line is considered

a delimiter. This means values (but not keys) can contain the delimiters.

See also the space_around_delimiters argument to

<a class="reference internal" href="#configparser.ConfigParser.write" title="configparser.ConfigParser.write"><code class="xref py py-meth docutils literal notranslate">ConfigParser.write()</code></a>.

</li>

<li>comment_prefixes, default value: <code class="docutils literal notranslate">('#', ';')</code></li>

<li>inline_comment_prefixes, default value: <code class="docutils literal notranslate">None</code>

Comment prefixes are strings that indicate the start of a valid comment within

a config file. comment_prefixes are used only on otherwise empty lines

(optionally indented) whereas inline_comment_prefixes can be used after

every valid value (e.g. section names, options and empty lines as well). By

default inline comments are disabled and <code class="docutils literal notranslate">'#'</code> and <code class="docutils literal notranslate">';'</code> are used as

prefixes for whole line comments.

تغییر داده شده در نسخه 3.2: In previous versions of <code class="xref py py-mod docutils literal notranslate">configparser</code> behaviour matched

<code class="docutils literal notranslate">comment_prefixes=('#',';')</code> and <code class="docutils literal notranslate">inline_comment_prefixes=(';',)</code>.

</div>

Please note that config parsers don't support escaping of comment prefixes so

using inline_comment_prefixes may prevent users from specifying option

values with characters used as comment prefixes. When in doubt, avoid

setting inline_comment_prefixes. In any circumstances, the only way of

storing comment prefix characters at the beginning of a line in multiline

values is to interpolate the prefix, for example:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> from configparser import ConfigParser, ExtendedInterpolation

>>> parser = ConfigParser(interpolation=ExtendedInterpolation())

>>> # the default BasicInterpolation could be used as well

>>> parser.read_string("""

... [DEFAULT]

... hash = #

...

... [hashes]

... shebang =

... ${hash}!/usr/bin/env python

... ${hash} -*- coding: utf-8 -*-

...

... extensions =

... enabled_extension

... another_extension

... #disabled_by_comment

... yet_another_extension

...

... interpolation not necessary = if # is not at line start

... even in multiline values = line #1

... line #2

... line #3

... """)

>>> print(parser['hashes']['shebang'])

#!/usr/bin/env python

# -*- coding: utf-8 -*-

enabled_extension

another_extension

yet_another_extension

if # is not at line start

line #1

line #2

line #3

</pre></div>

</div>

</li>

<li>strict, default value: <code class="docutils literal notranslate">True</code>

When set to <code class="docutils literal notranslate">True</code>, the parser will not allow for any section or option

duplicates while reading from a single source (using <a class="reference internal" href="#configparser.ConfigParser.read_file" title="configparser.ConfigParser.read_file"><code class="xref py py-meth docutils literal notranslate">read_file()</code></a>,

<a class="reference internal" href="#configparser.ConfigParser.read_string" title="configparser.ConfigParser.read_string"><code class="xref py py-meth docutils literal notranslate">read_string()</code></a> or <a class="reference internal" href="#configparser.ConfigParser.read_dict" title="configparser.ConfigParser.read_dict"><code class="xref py py-meth docutils literal notranslate">read_dict()</code></a>). It is recommended to use strict

parsers in new applications.

<code class="docutils literal notranslate">strict=False</code>.

</div>

</li>

<li>empty_lines_in_values, default value: <code class="docutils literal notranslate">True</code>

In config parsers, values can span multiple lines as long as they are

indented more than the key that holds them. By default parsers also let

empty lines to be parts of values. At the same time, keys can be arbitrarily

indented themselves to improve readability. In consequence, when

configuration files get big and complex, it is easy for the user to lose

track of the file structure. Take for instance:

<div class="highlight-ini notranslate"><div class="highlight"><pre>[Section]

key = multiline

value with a gotcha

this = is still a part of the multiline value of 'key'

</pre></div>

</div>

This can be especially problematic for the user to see if she's using a

proportional font to edit the file. That is why when your application does

not need values with empty lines, you should consider disallowing them. This

will make empty lines split keys every time. In the example above, it would

produce two keys, <code class="docutils literal notranslate">key</code> and <code class="docutils literal notranslate">this</code>.

</li>

<li>default_section, default value: <code class="docutils literal notranslate">configparser.DEFAULTSECT</code> (that is:

<code class="docutils literal notranslate">"DEFAULT"</code>)

The convention of allowing a special section of default values for other

sections or interpolation purposes is a powerful concept of this library,

letting users create complex declarative configurations. This section is

normally called <code class="docutils literal notranslate">"DEFAULT"</code> but this can be customized to point to any

other valid section name. Some typical values include: <code class="docutils literal notranslate">"general"</code> or

<code class="docutils literal notranslate">"common"</code>. The name provided is used for recognizing default sections

when reading from any source and is used when writing configuration back to

a file. Its current value can be retrieved using the

<code class="docutils literal notranslate">parser_instance.default_section</code> attribute and may be modified at runtime

(i.e. to convert files from one format to another).

</li>

<li>interpolation, default value: <code class="docutils literal notranslate">configparser.BasicInterpolation</code>

Interpolation behaviour may be customized by providing a custom handler

through the interpolation argument. <code class="docutils literal notranslate">None</code> can be used to turn off

interpolation completely, <code class="docutils literal notranslate">ExtendedInterpolation()</code> provides a more

advanced variant inspired by <code class="docutils literal notranslate">zc.buildout</code>. More on the subject in the

<a class="reference external" href="#interpolation-of-values">dedicated documentation section</a>.

<a class="reference internal" href="#configparser.RawConfigParser" title="configparser.RawConfigParser"><code class="xref py py-class docutils literal notranslate">RawConfigParser</code></a> has a default value of <code class="docutils literal notranslate">None</code>.

</li>

<li>converters, default value: not set

Config parsers provide option value getters that perform type conversion. By

default <a class="reference internal" href="#configparser.ConfigParser.getint" title="configparser.ConfigParser.getint"><code class="xref py py-meth docutils literal notranslate">getint()</code></a>, <a class="reference internal" href="#configparser.ConfigParser.getfloat" title="configparser.ConfigParser.getfloat"><code class="xref py py-meth docutils literal notranslate">getfloat()</code></a>, and

desirable, users may define them in a subclass or pass a dictionary where each

key is a name of the converter and each value is a callable implementing said

conversion. For instance, passing <code class="docutils literal notranslate">{'decimal': decimal.Decimal}</code> would add

<code class="xref py py-meth docutils literal notranslate">getdecimal()</code> on both the parser object and all section proxies. In

other words, it will be possible to write both

<code class="docutils literal notranslate">parser_instance.getdecimal('section', 'key', fallback=0)</code> and

<code class="docutils literal notranslate">parser_instance['section'].getdecimal('key', 0)</code>.

If the converter needs to access the state of the parser, it can be

implemented as a method on a config parser subclass. If the name of this

method starts with <code class="docutils literal notranslate">get</code>, it will be available on all section proxies, in

the dict-compatible form (see the <code class="docutils literal notranslate">getdecimal()</code> example above).

</li>

</ul>

More advanced customization may be achieved by overriding default values of

these parser attributes. The defaults are defined on the classes, so they may

be overridden by subclasses or by attribute assignment.

ConfigParser.BOOLEAN_STATES<a class="headerlink" href="#configparser.ConfigParser.BOOLEAN_STATES" title="Link to this definition">¶</a></dt>

<dd>By default when using <a class="reference internal" href="#configparser.ConfigParser.getboolean" title="configparser.ConfigParser.getboolean"><code class="xref py py-meth docutils literal notranslate">getboolean()</code></a>, config parsers

consider the following values <code class="docutils literal notranslate">True</code>: <code class="docutils literal notranslate">'1'</code>, <code class="docutils literal notranslate">'yes'</code>, <code class="docutils literal notranslate">'true'</code>,

<code class="docutils literal notranslate">'on'</code> and the following values <code class="docutils literal notranslate">False</code>: <code class="docutils literal notranslate">'0'</code>, <code class="docutils literal notranslate">'no'</code>, <code class="docutils literal notranslate">'false'</code>,

<code class="docutils literal notranslate">'off'</code>. You can override this by specifying a custom dictionary of strings

and their Boolean outcomes. For example:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> custom = configparser.ConfigParser()

>>> custom['section1'] = {'funky': 'nope'}

>>> custom['section1'].getboolean('funky')

Traceback (most recent call last):

...

ValueError: Not a boolean: nope

>>> custom.BOOLEAN_STATES = {'sure': True, 'nope': False}

False

</pre></div>

</div>

Other typical Boolean pairs include <code class="docutils literal notranslate">accept</code>/<code class="docutils literal notranslate">reject</code> or

<code class="docutils literal notranslate">enabled</code>/<code class="docutils literal notranslate">disabled</code>.

</dd></dl>

ConfigParser.optionxform(option)</dt>

<dd>This method transforms option names on every read, get, or set

operation. The default converts the name to lowercase. This also

means that when a configuration file gets written, all keys will be

lowercase. Override this method if that's unsuitable.

For example:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> config = """

... [Section1]

... Key = Value

...

... [Section2]

... AnotherKey = Value

... """

>>> typical = configparser.ConfigParser()

>>> typical.read_string(config)

>>> list(typical['Section1'].keys())

['key']

>>> list(typical['Section2'].keys())

['anotherkey']

>>> custom = configparser.RawConfigParser()

>>> custom.optionxform = lambda option: option

>>> custom.read_string(config)

>>> list(custom['Section1'].keys())

['Key']

>>> list(custom['Section2'].keys())

['AnotherKey']

</pre></div>

</div>

توجه

The optionxform function transforms option names to a canonical form.

This should be an idempotent function: if the name is already in

canonical form, it should be returned unchanged.

</div>

</dd></dl>

ConfigParser.SECTCRE<a class="headerlink" href="#configparser.ConfigParser.SECTCRE" title="Link to this definition">¶</a></dt>

<dd>A compiled regular expression used to parse section headers. The default

matches <code class="docutils literal notranslate">[section]</code> to the name <code class="docutils literal notranslate">"section"</code>. Whitespace is considered

part of the section name, thus <code class="docutils literal notranslate">[  larch  ]</code> will be read as a section of

name <code class="docutils literal notranslate">"  larch  "</code>. Override this attribute if that's unsuitable. For

example:

<div class="highlight-pycon notranslate"><div class="highlight"><pre>>>> import re

>>> config = """

... [Section 1]

... option = value

...

... [ Section 2 ]

... another = val

... """

>>> typical.read_string(config)

>>> typical.sections()

['Section 1', ' Section 2 ']

>>> custom = configparser.ConfigParser()

>>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")

>>> custom.read_string(config)

>>> custom.sections()

['Section 1', 'Section 2']

</pre></div>

</div>

توجه

While ConfigParser objects also use an <code class="docutils literal notranslate">OPTCRE</code> attribute for recognizing

option lines, it's not recommended to override it because that would

interfere with constructor options allow_no_value and delimiters.

</div>

</dd></dl>

</section>

<h2>Legacy API Examples<a class="headerlink" href="#legacy-api-examples" title="Link to this heading">¶</a></h2>

Mainly because of backwards compatibility concerns, <code class="xref py py-mod docutils literal notranslate">configparser</code>

provides also a legacy API with explicit <code class="docutils literal notranslate">get</code>/<code class="docutils literal notranslate">set</code> methods. While there

are valid use cases for the methods outlined below, mapping protocol access is

preferred for new projects. The legacy API is at times more advanced,

low-level and downright counterintuitive.

An example of writing to a configuration file:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>import configparser

config = configparser.RawConfigParser()

# Please note that using RawConfigParser's set functions, you can assign

# non-string values to keys internally, but will receive an error when

# attempting to write to a file or when you get it in non-raw mode. Setting

# values using the mapping protocol or ConfigParser's set() does not allow

# such assignments to take place.

config.add_section('Section1')

config.set('Section1', 'an_int', '15')

config.set('Section1', 'a_bool', 'true')

config.set('Section1', 'a_float', '3.1415')

config.set('Section1', 'baz', 'fun')

config.set('Section1', 'bar', 'Python')

config.set('Section1', 'foo', '%(bar)s is %(baz)s!')

# Writing our configuration file to 'example.cfg'

with open('example.cfg', 'w') as configfile:

config.write(configfile)

</pre></div>

</div>

An example of reading the configuration file again:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>import configparser

config = configparser.RawConfigParser()

config.read('example.cfg')

# getfloat() raises an exception if the value is not a float

# getint() and getboolean() also do this for their respective types

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

configparser.html

Latest commit

History

configparser.html

File metadata and controls