cpython/Lib/configparser.py at main · python/cpython · GitHub

History

1424 lines (1179 loc) · 54.4 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

"""Configuration file parser.

A configuration file consists of sections, lead by a "[section]" header,

and followed by "name: value" entries, with continuations and such in

the style of RFC 822.

Intrinsic defaults can be specified by passing them into the

ConfigParser constructor as a dictionary.

class:

ConfigParser -- responsible for parsing a list of

configuration files, and managing the parsed database.

methods:

__init__(defaults=None, dict_type=_default_dict, allow_no_value=False,

delimiters=('=', ':'), comment_prefixes=('#', ';'),

inline_comment_prefixes=None, strict=True,

empty_lines_in_values=True, default_section='DEFAULT',

interpolation=<unset>, converters=<unset>,

allow_unnamed_section=False):

Create the parser. When `defaults` is given, it is initialized into the

dictionary or intrinsic defaults. The keys must be strings, the values

must be appropriate for %()s string interpolation.

When `dict_type` is given, it will be used to create the dictionary

objects for the list of sections, for the options within a section, and

for the default values.

When `delimiters` is given, it will be used as the set of substrings

that divide keys from values.

When `comment_prefixes` is given, it will be used as the set of

substrings that prefix comments in empty lines. Comments can be

indented.

When `inline_comment_prefixes` is given, it will be used as the set of

substrings that prefix comments in non-empty lines.

When `strict` is True, the parser won't allow for any section or option

duplicates while reading from a single source (file, string or

dictionary). Default is True.

When `empty_lines_in_values` is False (default: True), each empty line

marks the end of an option. Otherwise, internal empty lines of

a multiline option are kept as part of the value.

When `allow_no_value` is True (default: False), options without

values are accepted; the value presented for these is None.

When `default_section` is given, the name of the special section is

named accordingly. By default it is called ``"DEFAULT"`` but this can

be customized to point to any other valid section name. Its current

value can be retrieved using the ``parser_instance.default_section``

attribute and may be modified at runtime.

When `interpolation` is given, it should be an Interpolation subclass

instance. It will be used as the handler for option value

pre-processing when using getters. RawConfigParser objects don't do

any sort of interpolation, whereas ConfigParser uses an instance of

BasicInterpolation. The library also provides a ``zc.buildout``

inspired ExtendedInterpolation implementation.

When `converters` is given, it should be a dictionary where each key

represents the name of a type converter and each value is a callable

implementing the conversion from string to the desired datatype. Every

converter gets its corresponding get*() method on the parser object and

section proxies.

When `allow_unnamed_section` is True (default: False), options

without section are accepted: the section for these is

``configparser.UNNAMED_SECTION``.

sections()

Return all the configuration section names, sans DEFAULT.

has_section(section)

Return whether the given section exists.

has_option(section, option)

Return whether the given option exists in the given section.

options(section)

Return list of configuration options for the named section.

read(filenames, encoding=None)

Read and parse the iterable of named configuration files, given by

name. A single filename is also allowed. Non-existing files

are ignored. Return list of successfully read files.

read_file(f, filename=None)

Read and parse one configuration file, given as a file object.

The filename defaults to f.name; it is only used in error

messages (if f has no `name` attribute, the string `<???>` is used).

read_string(string)

Read configuration from a given string.

read_dict(dictionary)

Read configuration from a dictionary. Keys are section names,

values are dictionaries with keys and values that should be present

in the section. If the used dictionary type preserves order, sections

and their keys will be added in order. Values are automatically

converted to strings.

get(section, option, raw=False, vars=None, fallback=_UNSET)

Return a string value for the named option. All % interpolations are

expanded in the return values, based on the defaults passed into the

constructor and the DEFAULT section. Additional substitutions may be

provided using the `vars` argument, which must be a dictionary whose

contents override any pre-existing defaults. If `option` is a key in

`vars`, the value from `vars` is used.

getint(section, options, raw=False, vars=None, fallback=_UNSET)

Like get(), but convert value to an integer.

getfloat(section, options, raw=False, vars=None, fallback=_UNSET)

Like get(), but convert value to a float.

getboolean(section, options, raw=False, vars=None, fallback=_UNSET)

Like get(), but convert value to a boolean (currently case

insensitively defined as 0, false, no, off for False, and 1, true,

yes, on for True). Returns False or True.

items(section=_UNSET, raw=False, vars=None)

If section is given, return a list of tuples with (name, value) for

each option in the section. Otherwise, return a list of tuples with

(section_name, section_proxy) for each section, including DEFAULTSECT.

remove_section(section)

Remove the given file section and all its options.

remove_option(section, option)

Remove the given option from the given section.

set(section, option, value)

Set the given option.

write(fp, space_around_delimiters=True)

Write the configuration state in .ini format. If

`space_around_delimiters` is True (the default), delimiters

between keys and values are surrounded by spaces.

"""

# Do not import dataclasses; overhead is unacceptable (gh-117703)

from collections.abc import Iterable, MutableMapping

from collections import ChainMap as _ChainMap

import contextlib

import functools

import io

import itertools

import os

import re

import sys

__all__ = ("NoSectionError", "DuplicateOptionError", "DuplicateSectionError",

"NoOptionError", "InterpolationError", "InterpolationDepthError",

"InterpolationMissingOptionError", "InterpolationSyntaxError",

"ParsingError", "MissingSectionHeaderError",

"MultilineContinuationError", "UnnamedSectionDisabledError",

"InvalidWriteError", "ConfigParser", "RawConfigParser",

"Interpolation", "BasicInterpolation", "ExtendedInterpolation",

"SectionProxy", "ConverterMapping",

"DEFAULTSECT", "MAX_INTERPOLATION_DEPTH", "UNNAMED_SECTION")

_default_dict = dict

DEFAULTSECT = "DEFAULT"

MAX_INTERPOLATION_DEPTH = 10

# exception classes

class Error(Exception):

"""Base class for ConfigParser exceptions."""

def __init__(self, msg=''):

self.message = msg

Exception.__init__(self, msg)

def __repr__(self):

return self.message

__str__ = __repr__

class NoSectionError(Error):

"""Raised when no section matches a requested option."""

def __init__(self, section):

Error.__init__(self, 'No section: %r' % (section,))

self.section = section

self.args = (section, )

class DuplicateSectionError(Error):

"""Raised when a section is repeated in an input source.

Possible repetitions that raise this exception are: multiple creation

using the API or in strict parsers when a section is found more than once

in a single input file, string or dictionary.

"""

def __init__(self, section, source=None, lineno=None):

msg = [repr(section), " already exists"]

if source is not None:

message = ["While reading from ", repr(source)]

if lineno is not None:

message.append(" [line {0:2d}]".format(lineno))

message.append(": section ")

message.extend(msg)

msg = message

else:

msg.insert(0, "Section ")

Error.__init__(self, "".join(msg))

self.section = section

self.source = source

self.lineno = lineno

self.args = (section, source, lineno)

class DuplicateOptionError(Error):

"""Raised by strict parsers when an option is repeated in an input source.

Current implementation raises this exception only when an option is found

more than once in a single file, string or dictionary.

"""

def __init__(self, section, option, source=None, lineno=None):

msg = [repr(option), " in section ", repr(section),

" already exists"]

if source is not None:

message = ["While reading from ", repr(source)]

if lineno is not None:

message.append(" [line {0:2d}]".format(lineno))

message.append(": option ")

message.extend(msg)

msg = message

else:

msg.insert(0, "Option ")

Error.__init__(self, "".join(msg))

self.section = section

self.option = option

self.source = source

self.lineno = lineno

self.args = (section, option, source, lineno)

class NoOptionError(Error):

"""A requested option was not found."""

def __init__(self, option, section):

Error.__init__(self, "No option %r in section: %r" %

(option, section))

self.option = option

self.section = section

self.args = (option, section)

class InterpolationError(Error):

"""Base class for interpolation-related exceptions."""

def __init__(self, option, section, msg):

Error.__init__(self, msg)

self.option = option

self.section = section

self.args = (option, section, msg)

class InterpolationMissingOptionError(InterpolationError):

"""A string substitution required a setting which was not available."""

def __init__(self, option, section, rawval, reference):

msg = ("Bad value substitution: option {!r} in section {!r} contains "

"an interpolation key {!r} which is not a valid option name. "

"Raw value: {!r}".format(option, section, reference, rawval))

InterpolationError.__init__(self, option, section, msg)

self.reference = reference

self.args = (option, section, rawval, reference)

class InterpolationSyntaxError(InterpolationError):

"""Raised when the source text contains invalid syntax.

Current implementation raises this exception when the source text into

which substitutions are made does not conform to the required syntax.

"""

class InterpolationDepthError(InterpolationError):

"""Raised when substitutions are nested too deeply."""

def __init__(self, option, section, rawval):

msg = ("Recursion limit exceeded in value substitution: option {!r} "

"in section {!r} contains an interpolation key which "

"cannot be substituted in {} steps. Raw value: {!r}"

"".format(option, section, MAX_INTERPOLATION_DEPTH,

rawval))

InterpolationError.__init__(self, option, section, msg)

self.args = (option, section, rawval)

class ParsingError(Error):

"""Raised when a configuration file does not follow legal syntax."""

def __init__(self, source, *args):

super().__init__(f'Source contains parsing errors: {source!r}')

self.source = source

self.errors = []

self.args = (source, )

if args:

self.append(*args)

def append(self, lineno, line):

self.errors.append((lineno, line))

self.message += f'\n\t[line {lineno:2d}]: {line!r}'

def combine(self, others):

messages = [self.message]

for other in others:

for lineno, line in other.errors:

self.errors.append((lineno, line))

messages.append(f'\n\t[line {lineno:2d}]: {line!r}')

self.message = "".join(messages)

return self

@staticmethod

def _raise_all(exceptions: Iterable['ParsingError']):

"""

Combine any number of ParsingErrors into one and raise it.

"""

exceptions = iter(exceptions)

with contextlib.suppress(StopIteration):

raise next(exceptions).combine(exceptions)

class MissingSectionHeaderError(ParsingError):

"""Raised when a key-value pair is found before any section header."""

def __init__(self, filename, lineno, line):

Error.__init__(

self,

'File contains no section headers.\nfile: %r, line: %d\n%r' %

(filename, lineno, line))

self.source = filename

self.lineno = lineno

self.line = line

self.args = (filename, lineno, line)

class MultilineContinuationError(ParsingError):

"""Raised when a key without value is followed by continuation line"""

def __init__(self, filename, lineno, line):

Error.__init__(

self,

"Key without value continued with an indented line.\n"

"file: %r, line: %d\n%r"

%(filename, lineno, line))

self.source = filename

self.lineno = lineno

self.line = line

self.args = (filename, lineno, line)

class UnnamedSectionDisabledError(Error):

"""Raised when an attempt to use UNNAMED_SECTION is made with the

feature disabled."""

def __init__(self):

Error.__init__(self, "Support for UNNAMED_SECTION is disabled.")

class _UnnamedSection:

def __repr__(self):

return "<UNNAMED_SECTION>"

class InvalidWriteError(Error):

"""Raised when attempting to write data that the parser would read back differently.

ex: writing a key which begins with the section header pattern would read back as a

new section """

def __init__(self, msg=''):

Error.__init__(self, msg)

UNNAMED_SECTION = _UnnamedSection()

# Used in parser getters to indicate the default behaviour when a specific

# option is not found it to raise an exception. Created to enable `None` as

# a valid fallback value.

_UNSET = object()

class Interpolation:

"""Dummy interpolation that passes the value through with no changes."""

def before_get(self, parser, section, option, value, defaults):

return value

def before_set(self, parser, section, option, value):

return value

def before_read(self, parser, section, option, value):

return value

def before_write(self, parser, section, option, value):

return value

class BasicInterpolation(Interpolation):

"""Interpolation as implemented in the classic ConfigParser.

The option values can contain format strings which refer to other values in

the same section, or values in the special default section.

For example:

something: %(dir)s/whatever

would resolve the "%(dir)s" to the value of dir. All reference

expansions are done late, on demand. If a user needs to use a bare % in

a configuration file, she can escape it by writing %%. Other % usage

is considered a user error and raises `InterpolationSyntaxError`."""

_KEYCRE = re.compile(r"%$([^)]+)$s")

def before_get(self, parser, section, option, value, defaults):

L = []

self._interpolate_some(parser, option, L, value, section, defaults, 1)

return ''.join(L)

def before_set(self, parser, section, option, value):

tmp_value = value.replace('%%', '') # escaped percent signs

tmp_value = self._KEYCRE.sub('', tmp_value) # valid syntax

if '%' in tmp_value:

raise ValueError("invalid interpolation syntax in %r at "

"position %d" % (value, tmp_value.find('%')))

return value

def _interpolate_some(self, parser, option, accum, rest, section, map,

depth):

rawval = parser.get(section, option, raw=True, fallback=rest)

if depth > MAX_INTERPOLATION_DEPTH:

raise InterpolationDepthError(option, section, rawval)

while rest:

p = rest.find("%")

if p < 0:

accum.append(rest)

return

if p > 0:

accum.append(rest[:p])

rest = rest[p:]

# p is no longer used

c = rest[1:2]

if c == "%":

accum.append("%")

rest = rest[2:]

elif c == "(":

m = self._KEYCRE.match(rest)

if m is None:

raise InterpolationSyntaxError(option, section,

"bad interpolation variable reference %r" % rest)

var = parser.optionxform(m.group(1))

rest = rest[m.end():]

try:

v = map[var]

except KeyError:

raise InterpolationMissingOptionError(

option, section, rawval, var) from None

if "%" in v:

self._interpolate_some(parser, option, accum, v,

section, map, depth + 1)

else:

accum.append(v)

else:

raise InterpolationSyntaxError(

option, section,

"'%%' must be followed by '%%' or '(', "

"found: %r" % (rest,))

class ExtendedInterpolation(Interpolation):

"""Advanced variant of interpolation, supports the syntax used by

`zc.buildout`. Enables interpolation between sections."""

_KEYCRE = re.compile(r"\$\{([^}]+)\}")

def before_get(self, parser, section, option, value, defaults):

L = []

self._interpolate_some(parser, option, L, value, section, defaults, 1)

return ''.join(L)

def before_set(self, parser, section, option, value):

tmp_value = value.replace('$$', '') # escaped dollar signs

tmp_value = self._KEYCRE.sub('', tmp_value) # valid syntax

if '$' in tmp_value:

raise ValueError("invalid interpolation syntax in %r at "

"position %d" % (value, tmp_value.find('$')))

return value

def _interpolate_some(self, parser, option, accum, rest, section, map,

depth):

rawval = parser.get(section, option, raw=True, fallback=rest)

if depth > MAX_INTERPOLATION_DEPTH:

raise InterpolationDepthError(option, section, rawval)

while rest:

p = rest.find("$")

if p < 0:

accum.append(rest)

return

if p > 0:

accum.append(rest[:p])

rest = rest[p:]

# p is no longer used

c = rest[1:2]

if c == "$":

accum.append("$")

rest = rest[2:]

elif c == "{":

m = self._KEYCRE.match(rest)

if m is None:

raise InterpolationSyntaxError(option, section,

"bad interpolation variable reference %r" % rest)

path = m.group(1).split(':')

rest = rest[m.end():]

sect = section

opt = option

try:

if len(path) == 1:

opt = parser.optionxform(path[0])

v = map[opt]

elif len(path) == 2:

sect = path[0]

opt = parser.optionxform(path[1])

v = parser.get(sect, opt, raw=True)

else:

raise InterpolationSyntaxError(

option, section,

"More than one ':' found: %r" % (rest,))

except (KeyError, NoSectionError, NoOptionError):

raise InterpolationMissingOptionError(

option, section, rawval, ":".join(path)) from None

if v is None:

continue

if "$" in v:

self._interpolate_some(parser, opt, accum, v, sect,

dict(parser.items(sect, raw=True)),

depth + 1)

else:

accum.append(v)

else:

raise InterpolationSyntaxError(

option, section,

"'$' must be followed by '$' or '{', "

"found: %r" % (rest,))

class _ReadState:

elements_added : set[str]

cursect : dict[str, str] | None = None

sectname : str | None = None

optname : str | None = None

lineno : int = 0

indent_level : int = 0

errors : list[ParsingError]

def __init__(self):

self.elements_added = set()

self.errors = list()

class _Line(str):

__slots__ = 'clean', 'has_comments'

def __new__(cls, val, *args, **kwargs):

return super().__new__(cls, val)

def __init__(self, val, comments):

trimmed = val.strip()

self.clean = comments.strip(trimmed)

self.has_comments = trimmed != self.clean

class _CommentSpec:

def __init__(self, full_prefixes, inline_prefixes):

full_patterns = (

# prefix at the beginning of a line

fr'^({re.escape(prefix)}).*'

for prefix in full_prefixes

)

inline_patterns = (

# prefix at the beginning of the line or following a space

fr'(^|\s)({re.escape(prefix)}.*)'

for prefix in inline_prefixes

)

self.pattern = re.compile('|'.join(itertools.chain(full_patterns, inline_patterns)))

def strip(self, text):

return self.pattern.sub('', text).rstrip()

def wrap(self, text):

return _Line(text, self)

class RawConfigParser(MutableMapping):

"""ConfigParser that does not do interpolation."""

# Regular expressions for parsing section headers and options

_SECT_TMPL = r"""

\[ # [

(?P<header>.+) # very permissive!

\] # ]

"""

_OPT_TMPL = r"""

(?P<option> # very permissive!

(?:(?!{delim})\S)* # non-delimiter non-whitespace

(?:\s+(?:(?!{delim})\S)+)*) # optionally more words

\s*(?P<vi>{delim})\s* # any number of space/tab,

# followed by any of the

# allowed delimiters,

# followed by any space/tab

(?P<value>.*)$ # everything up to eol

"""

_OPT_NV_TMPL = r"""

(?P<option> # very permissive!

(?:(?!{delim})\S)* # non-delimiter non-whitespace

(?:\s+(?:(?!{delim})\S)+)*) # optionally more words

\s*(?: # any number of space/tab,

(?P<vi>{delim})\s* # optionally followed by

# any of the allowed

# delimiters, followed by any

# space/tab

(?P<value>.*))?$ # everything up to eol

"""

# Interpolation algorithm to be used if the user does not specify another

_DEFAULT_INTERPOLATION = Interpolation()

# Compiled regular expression for matching sections

SECTCRE = re.compile(_SECT_TMPL, re.VERBOSE)

# Compiled regular expression for matching options with typical separators

OPTCRE = re.compile(_OPT_TMPL.format(delim="=|:"), re.VERBOSE)

# Compiled regular expression for matching options with optional values

# delimited using typical separators

OPTCRE_NV = re.compile(_OPT_NV_TMPL.format(delim="=|:"), re.VERBOSE)

# Compiled regular expression for matching leading whitespace in a line

NONSPACECRE = re.compile(r"\S")

# Possible boolean values in the configuration.

BOOLEAN_STATES = {'1': True, 'yes': True, 'true': True, 'on': True,

'0': False, 'no': False, 'false': False, 'off': False}

def __init__(self, defaults=None, dict_type=_default_dict,

allow_no_value=False, *, delimiters=('=', ':'),

comment_prefixes=('#', ';'), inline_comment_prefixes=None,

strict=True, empty_lines_in_values=True,

default_section=DEFAULTSECT,

interpolation=_UNSET, converters=_UNSET,

allow_unnamed_section=False,):

self._dict = dict_type

self._sections = self._dict()

self._defaults = self._dict()

self._converters = ConverterMapping(self)

self._proxies = self._dict()

self._proxies[default_section] = SectionProxy(self, default_section)

self._delimiters = tuple(delimiters)

if delimiters == ('=', ':'):

self._optcre = self.OPTCRE_NV if allow_no_value else self.OPTCRE

else:

d = "|".join(re.escape(d) for d in delimiters)

if allow_no_value:

self._optcre = re.compile(self._OPT_NV_TMPL.format(delim=d),

re.VERBOSE)

else:

self._optcre = re.compile(self._OPT_TMPL.format(delim=d),

re.VERBOSE)

self._comments = _CommentSpec(comment_prefixes or (), inline_comment_prefixes or ())

self._strict = strict

self._allow_no_value = allow_no_value

self._empty_lines_in_values = empty_lines_in_values

self.default_section=default_section

self._interpolation = interpolation

if self._interpolation is _UNSET:

self._interpolation = self._DEFAULT_INTERPOLATION

if self._interpolation is None:

self._interpolation = Interpolation()

if not isinstance(self._interpolation, Interpolation):

raise TypeError(

f"interpolation= must be None or an instance of Interpolation;"

f" got an object of type {type(self._interpolation)}"

)

if converters is not _UNSET:

self._converters.update(converters)

if defaults:

self._read_defaults(defaults)

self._allow_unnamed_section = allow_unnamed_section

def defaults(self):

return self._defaults

def sections(self):

"""Return a list of section names, excluding [DEFAULT]"""

# self._sections will never have [DEFAULT] in it

return list(self._sections.keys())

def add_section(self, section):

"""Create a new section in the configuration.

Raise DuplicateSectionError if a section by the specified name

already exists. Raise ValueError if name is DEFAULT.

"""

if section == self.default_section:

raise ValueError('Invalid section name: %r' % section)

if section is UNNAMED_SECTION:

if not self._allow_unnamed_section:

raise UnnamedSectionDisabledError

if section in self._sections:

raise DuplicateSectionError(section)

self._sections[section] = self._dict()

self._proxies[section] = SectionProxy(self, section)

def has_section(self, section):

"""Indicate whether the named section is present in the configuration.

The DEFAULT section is not acknowledged.

"""

return section in self._sections

def options(self, section):

"""Return a list of option names for the given section name."""

try:

opts = self._sections[section].copy()

except KeyError:

raise NoSectionError(section) from None

opts.update(self._defaults)

return list(opts.keys())

def read(self, filenames, encoding=None):

"""Read and parse a filename or an iterable of filenames.

Files that cannot be opened are silently ignored; this is

designed so that you can specify an iterable of potential

configuration file locations (e.g. current directory, user's

home directory, systemwide directory), and all existing

configuration files in the iterable will be read. A single

filename may also be given.

Return list of successfully read files.

"""

if isinstance(filenames, (str, bytes, os.PathLike)):

filenames = [filenames]

encoding = io.text_encoding(encoding)

read_ok = []

for filename in filenames:

try:

with open(filename, encoding=encoding) as fp:

self._read(fp, filename)

except OSError:

continue

if isinstance(filename, os.PathLike):

filename = os.fspath(filename)

read_ok.append(filename)

return read_ok

def read_file(self, f, source=None):

"""Like read() but the argument must be a file-like object.

The `f` argument must be iterable, returning one line at a time.

Optional second argument is the `source` specifying the name of the

file being read. If not given, it is taken from f.name. If `f` has no

`name` attribute, `<???>` is used.

"""

if source is None:

try:

source = f.name

except AttributeError:

source = '<???>'

self._read(f, source)

def read_string(self, string, source='<string>'):

"""Read configuration from a given string."""

sfile = io.StringIO(string)

self.read_file(sfile, source)

def read_dict(self, dictionary, source='<dict>'):

"""Read configuration from a dictionary.

Keys are section names, values are dictionaries with keys and values

that should be present in the section. If the used dictionary type

preserves order, sections and their keys will be added in order.

All types held in the dictionary are converted to strings during

reading, including section names, option names and keys.

Optional second argument is the `source` specifying the name of the

dictionary being read.

"""

elements_added = set()

for section, keys in dictionary.items():

if section is not UNNAMED_SECTION:

section = str(section)

try:

self.add_section(section)

except (DuplicateSectionError, ValueError):

if self._strict and section in elements_added:

raise

elements_added.add(section)

for key, value in keys.items():

key = self.optionxform(str(key))

if value is not None:

value = str(value)

if self._strict and (section, key) in elements_added:

raise DuplicateOptionError(section, key, source)

elements_added.add((section, key))

self.set(section, key, value)

def get(self, section, option, *, raw=False, vars=None, fallback=_UNSET):

"""Get an option value for a given section.

If `vars` is provided, it must be a dictionary. The option is looked up

in `vars` (if provided), `section`, and in `DEFAULTSECT` in that order.

If the key is not found and `fallback` is provided, it is used as

a fallback value. `None` can be provided as a `fallback` value.

If interpolation is enabled and the optional argument `raw` is False,

all interpolations are expanded in the return values.

Arguments `raw`, `vars`, and `fallback` are keyword only.

The section DEFAULT is special.

"""

try:

d = self._unify_values(section, vars)

except NoSectionError:

if fallback is _UNSET:

raise

else:

return fallback

option = self.optionxform(option)

try:

value = d[option]

except KeyError:

if fallback is _UNSET:

raise NoOptionError(option, section)

else:

return fallback

if raw or value is None:

return value

else:

return self._interpolation.before_get(self, section, option, value,

def _get(self, section, conv, option, **kwargs):

return conv(self.get(section, option, **kwargs))

def _get_conv(self, section, option, conv, *, raw=False, vars=None,

fallback=_UNSET, **kwargs):

try:

return self._get(section, conv, option, raw=raw, vars=vars,

**kwargs)

except (NoSectionError, NoOptionError):

if fallback is _UNSET:

raise

return fallback

# getint, getfloat and getboolean provided directly for backwards compat

def getint(self, section, option, *, raw=False, vars=None,

fallback=_UNSET, **kwargs):

return self._get_conv(section, option, int, raw=raw, vars=vars,

fallback=fallback, **kwargs)

def getfloat(self, section, option, *, raw=False, vars=None,

fallback=_UNSET, **kwargs):

return self._get_conv(section, option, float, raw=raw, vars=vars,

fallback=fallback, **kwargs)

def getboolean(self, section, option, *, raw=False, vars=None,

fallback=_UNSET, **kwargs):

return self._get_conv(section, option, self._convert_to_boolean,

raw=raw, vars=vars, fallback=fallback, **kwargs)

def items(self, section=_UNSET, raw=False, vars=None):

"""Return a list of (name, value) tuples for each option in a section.

All % interpolations are expanded in the return values, based on the

defaults passed into the constructor, unless the optional argument

`raw` is true. Additional substitutions may be provided using the

`vars` argument, which must be a dictionary whose contents overrides

any pre-existing defaults.

The section DEFAULT is special.

"""

if section is _UNSET:

return super().items()

d = self._defaults.copy()

try:

d.update(self._sections[section])

except KeyError:

if section != self.default_section:

raise NoSectionError(section)

orig_keys = list(d.keys())

# Update with the entry specific variables

if vars:

for key, value in vars.items():

d[self.optionxform(key)] = value

value_getter = lambda option: self._interpolation.before_get(self,

section, option, d[option], d)

if raw:

value_getter = lambda option: d[option]

return [(option, value_getter(option)) for option in orig_keys]

def popitem(self):

"""Remove a section from the parser and return it as

a (section_name, section_proxy) tuple. If no section is present, raise

KeyError.

The section DEFAULT is never returned because it cannot be removed.

"""

for key in self.sections():

value = self[key]

del self[key]

return key, value

raise KeyError

def optionxform(self, optionstr):

return optionstr.lower()

def has_option(self, section, option):

"""Check for the existence of a given option in a given section.

If the specified `section` is None or an empty string, DEFAULT is

assumed. If the specified `section` does not exist, returns False."""

if not section or section == self.default_section:

option = self.optionxform(option)

return option in self._defaults

elif section not in self._sections:

return False

else:

option = self.optionxform(option)

return (option in self._sections[section]

or option in self._defaults)

def set(self, section, option, value=None):

"""Set an option."""

if value:

value = self._interpolation.before_set(self, section, option,

value)

if not section or section == self.default_section:

sectdict = self._defaults

else:

try:

sectdict = self._sections[section]

except KeyError:

raise NoSectionError(section) from None

sectdict[self.optionxform(option)] = value

def write(self, fp, space_around_delimiters=True):

"""Write an .ini-format representation of the configuration state.

If `space_around_delimiters` is True (the default), delimiters

between keys and values are surrounded by spaces.

Please note that comments in the original configuration file are not

preserved when writing the configuration back.

"""

if space_around_delimiters:

d = " {} ".format(self._delimiters[0])

else:

d = self._delimiters[0]

if self._defaults:

self._write_section(fp, self.default_section,

self._defaults.items(), d)

if UNNAMED_SECTION in self._sections and self._sections[UNNAMED_SECTION]:

self._write_section(fp, UNNAMED_SECTION, self._sections[UNNAMED_SECTION].items(), d, unnamed=True)

for section in self._sections:

if section is UNNAMED_SECTION:

continue

self._write_section(fp, section,

self._sections[section].items(), d)

def _write_section(self, fp, section_name, section_items, delimiter, unnamed=False):

"""Write a single section to the specified 'fp'."""

if not unnamed:

fp.write("[{}]\n".format(section_name))

for key, value in section_items:

self._validate_key_contents(key)

value = self._interpolation.before_write(self, section_name, key,

value)

if value is not None or not self._allow_no_value:

# Convert all possible line-endings into '\n\t'

value = (delimiter + str(value).replace('\r\n', '\n')

.replace('\r', '\n').replace('\n', '\n\t'))

else:

value = ""

fp.write("{}{}\n".format(key, value))

View remainder of file in raw view

cpython/Lib/configparser.py at main · python/cpython · GitHub

Uh oh!

Uh oh!

cpython/Lib/configparser.py at main · python/cpython · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

configparser.py

Latest commit

History

Breadcrumbs

configparser.py

File metadata and controls