cpython/Lib/optparse.py at 3.5 · python/cpython · GitHub

Repository navigation

History

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

"""A powerful, extensible, and easy-to-use option parser.

By Greg Ward <gward@python.net>

Originally distributed as Optik.

For support, use the optik-users@lists.sourceforge.net mailing list

(http://lists.sourceforge.net/lists/listinfo/optik-users).

Simple usage example:

from optparse import OptionParser

parser = OptionParser()

parser.add_option("-f", "--file", dest="filename",

help="write report to FILE", metavar="FILE")

parser.add_option("-q", "--quiet",

action="store_false", dest="verbose", default=True,

help="don't print status messages to stdout")

(options, args) = parser.parse_args()

"""

__version__ = "1.5.3"

__all__ = ['Option',

'make_option',

'SUPPRESS_HELP',

'SUPPRESS_USAGE',

'Values',

'OptionContainer',

'OptionGroup',

'OptionParser',

'HelpFormatter',

'IndentedHelpFormatter',

'TitledHelpFormatter',

'OptParseError',

'OptionError',

'OptionConflictError',

'OptionValueError',

'BadOptionError']

__copyright__ = """

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are

met:

* Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright

notice, this list of conditions and the following disclaimer in the

documentation and/or other materials provided with the distribution.

* Neither the name of the author nor the names of its

contributors may be used to endorse or promote products derived from

this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED

TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR

CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""

import sys, os

import textwrap

def _repr(self):

return "<%s at 0x%x: %s>" % (self.__class__.__name__, id(self), self)

# This file was generated from:

# Id: option_parser.py 527 2006-07-23 15:21:30Z greg

# Id: option.py 522 2006-06-11 16:22:03Z gward

# Id: help.py 527 2006-07-23 15:21:30Z greg

# Id: errors.py 509 2006-04-20 00:58:24Z gward

try:

from gettext import gettext, ngettext

except ImportError:

def gettext(message):

return message

def ngettext(singular, plural, n):

if n == 1:

return singular

return plural

_ = gettext

class OptParseError (Exception):

def __init__(self, msg):

self.msg = msg

def __str__(self):

return self.msg

class OptionError (OptParseError):

"""

Raised if an Option instance is created with invalid or

inconsistent arguments.

"""

def __init__(self, msg, option):

self.msg = msg

self.option_id = str(option)

def __str__(self):

if self.option_id:

return "option %s: %s" % (self.option_id, self.msg)

else:

return self.msg

class OptionConflictError (OptionError):

"""

Raised if conflicting options are added to an OptionParser.

"""

class OptionValueError (OptParseError):

"""

Raised if an invalid option value is encountered on the command

line.

"""

class BadOptionError (OptParseError):

"""

Raised if an invalid option is seen on the command line.

"""

def __init__(self, opt_str):

self.opt_str = opt_str

def __str__(self):

return _("no such option: %s") % self.opt_str

class AmbiguousOptionError (BadOptionError):

"""

Raised if an ambiguous option is seen on the command line.

"""

def __init__(self, opt_str, possibilities):

BadOptionError.__init__(self, opt_str)

self.possibilities = possibilities

def __str__(self):

return (_("ambiguous option: %s (%s?)")

% (self.opt_str, ", ".join(self.possibilities)))

class HelpFormatter:

"""

Abstract base class for formatting option help. OptionParser

instances should use one of the HelpFormatter subclasses for

formatting help; by default IndentedHelpFormatter is used.

Instance attributes:

parser : OptionParser

the controlling OptionParser instance

indent_increment : int

the number of columns to indent per nesting level

max_help_position : int

the maximum starting column for option help text

help_position : int

the calculated starting column for option help text;

initially the same as the maximum

width : int

total number of columns for output (pass None to constructor for

this value to be taken from the $COLUMNS environment variable)

level : int

current indentation level

current_indent : int

current indentation level (in columns)

help_width : int

number of columns available for option help text (calculated)

default_tag : str

text to replace with each option's default value, "%default"

by default. Set to false value to disable default value expansion.

option_strings : { Option : str }

maps Option instances to the snippet of help text explaining

the syntax of that option, e.g. "-h, --help" or

"-fFILE, --file=FILE"

_short_opt_fmt : str

format string controlling how short options with values are

printed in help text. Must be either "%s%s" ("-fFILE") or

"%s %s" ("-f FILE"), because those are the two syntaxes that

Optik supports.

_long_opt_fmt : str

similar but for long options; must be either "%s %s" ("--file FILE")

or "%s=%s" ("--file=FILE").

"""

NO_DEFAULT_VALUE = "none"

def __init__(self,

indent_increment,

max_help_position,

width,

short_first):

self.parser = None

self.indent_increment = indent_increment

if width is None:

try:

width = int(os.environ['COLUMNS'])

except (KeyError, ValueError):

width = 80

width -= 2

self.width = width

self.help_position = self.max_help_position = \

min(max_help_position, max(width - 20, indent_increment * 2))

self.current_indent = 0

self.level = 0

self.help_width = None # computed later

self.short_first = short_first

self.default_tag = "%default"

self.option_strings = {}

self._short_opt_fmt = "%s %s"

self._long_opt_fmt = "%s=%s"

def set_parser(self, parser):

self.parser = parser

def set_short_opt_delimiter(self, delim):

if delim not in ("", " "):

raise ValueError(

"invalid metavar delimiter for short options: %r" % delim)

self._short_opt_fmt = "%s" + delim + "%s"

def set_long_opt_delimiter(self, delim):

if delim not in ("=", " "):

raise ValueError(

"invalid metavar delimiter for long options: %r" % delim)

self._long_opt_fmt = "%s" + delim + "%s"

def indent(self):

self.current_indent += self.indent_increment

self.level += 1

def dedent(self):

self.current_indent -= self.indent_increment

assert self.current_indent >= 0, "Indent decreased below 0."

self.level -= 1

def format_usage(self, usage):

raise NotImplementedError("subclasses must implement")

def format_heading(self, heading):

raise NotImplementedError("subclasses must implement")

def _format_text(self, text):

"""

Format a paragraph of free-form text for inclusion in the

help output at the current indentation level.

"""

text_width = max(self.width - self.current_indent, 11)

indent = " "*self.current_indent

return textwrap.fill(text,

text_width,

initial_indent=indent,

subsequent_indent=indent)

def format_description(self, description):

if description:

return self._format_text(description) + "\n"

else:

return ""

def format_epilog(self, epilog):

if epilog:

return "\n" + self._format_text(epilog) + "\n"

else:

return ""

def expand_default(self, option):

if self.parser is None or not self.default_tag:

return option.help

default_value = self.parser.defaults.get(option.dest)

if default_value is NO_DEFAULT or default_value is None:

default_value = self.NO_DEFAULT_VALUE

return option.help.replace(self.default_tag, str(default_value))

def format_option(self, option):

# The help for each option consists of two parts:

# * the opt strings and metavars

# eg. ("-x", or "-fFILENAME, --file=FILENAME")

# * the user-supplied help string

# eg. ("turn on expert mode", "read data from FILENAME")

# If possible, we write both of these on the same line:

# -x turn on expert mode

# But if the opt string list is too long, we put the help

# string on a second line, indented to the same column it would

# start in if it fit on the first line.

# -fFILENAME, --file=FILENAME

# read data from FILENAME

result = []

opts = self.option_strings[option]

opt_width = self.help_position - self.current_indent - 2

if len(opts) > opt_width:

opts = "%*s%s\n" % (self.current_indent, "", opts)

indent_first = self.help_position

else: # start help on same line as opts

opts = "%*s%-*s " % (self.current_indent, "", opt_width, opts)

indent_first = 0

result.append(opts)

if option.help:

help_text = self.expand_default(option)

help_lines = textwrap.wrap(help_text, self.help_width)

result.append("%*s%s\n" % (indent_first, "", help_lines[0]))

result.extend(["%*s%s\n" % (self.help_position, "", line)

for line in help_lines[1:]])

elif opts[-1] != "\n":

result.append("\n")

return "".join(result)

def store_option_strings(self, parser):

self.indent()

max_len = 0

for opt in parser.option_list:

strings = self.format_option_strings(opt)

self.option_strings[opt] = strings

max_len = max(max_len, len(strings) + self.current_indent)

self.indent()

for group in parser.option_groups:

for opt in group.option_list:

strings = self.format_option_strings(opt)

self.option_strings[opt] = strings

max_len = max(max_len, len(strings) + self.current_indent)

self.dedent()

self.help_position = min(max_len + 2, self.max_help_position)

self.help_width = max(self.width - self.help_position, 11)

def format_option_strings(self, option):

"""Return a comma-separated list of option strings & metavariables."""

if option.takes_value():

metavar = option.metavar or option.dest.upper()

short_opts = [self._short_opt_fmt % (sopt, metavar)

for sopt in option._short_opts]

long_opts = [self._long_opt_fmt % (lopt, metavar)

for lopt in option._long_opts]

else:

short_opts = option._short_opts

long_opts = option._long_opts

if self.short_first:

opts = short_opts + long_opts

else:

opts = long_opts + short_opts

return ", ".join(opts)

class IndentedHelpFormatter (HelpFormatter):

"""Format help with indented section bodies.

"""

def __init__(self,

indent_increment=2,

max_help_position=24,

width=None,

short_first=1):

HelpFormatter.__init__(

self, indent_increment, max_help_position, width, short_first)

def format_usage(self, usage):

return _("Usage: %s\n") % usage

def format_heading(self, heading):

return "%*s%s:\n" % (self.current_indent, "", heading)

class TitledHelpFormatter (HelpFormatter):

"""Format help with underlined section headers.

"""

def __init__(self,

indent_increment=0,

max_help_position=24,

width=None,

short_first=0):

HelpFormatter.__init__ (

self, indent_increment, max_help_position, width, short_first)

def format_usage(self, usage):

return "%s %s\n" % (self.format_heading(_("Usage")), usage)

def format_heading(self, heading):

return "%s\n%s\n" % (heading, "=-"[self.level] * len(heading))

def _parse_num(val, type):

if val[:2].lower() == "0x": # hexadecimal

radix = 16

elif val[:2].lower() == "0b": # binary

radix = 2

val = val[2:] or "0" # have to remove "0b" prefix

elif val[:1] == "0": # octal

radix = 8

else: # decimal

radix = 10

return type(val, radix)

def _parse_int(val):

return _parse_num(val, int)

_builtin_cvt = { "int" : (_parse_int, _("integer")),

"long" : (_parse_int, _("integer")),

"float" : (float, _("floating-point")),

"complex" : (complex, _("complex")) }

def check_builtin(option, opt, value):

(cvt, what) = _builtin_cvt[option.type]

try:

return cvt(value)

except ValueError:

raise OptionValueError(

_("option %s: invalid %s value: %r") % (opt, what, value))

def check_choice(option, opt, value):

if value in option.choices:

return value

else:

choices = ", ".join(map(repr, option.choices))

raise OptionValueError(

_("option %s: invalid choice: %r (choose from %s)")

% (opt, value, choices))

# Not supplying a default is different from a default of None,

# so we need an explicit "not supplied" value.

NO_DEFAULT = ("NO", "DEFAULT")

class Option:

"""

Instance attributes:

_short_opts : [string]

_long_opts : [string]

action : string

type : string

dest : string

default : any

nargs : int

const : any

choices : [string]

callback : function

callback_args : (any*)

callback_kwargs : { string : any }

help : string

metavar : string

"""

# The list of instance attributes that may be set through

# keyword args to the constructor.

ATTRS = ['action',

'type',

'dest',

'default',

'nargs',

'const',

'choices',

'callback',

'callback_args',

'callback_kwargs',

'help',

'metavar']

# The set of actions allowed by option parsers. Explicitly listed

# here so the constructor can validate its arguments.

ACTIONS = ("store",

"store_const",

"store_true",

"store_false",

"append",

"append_const",

"count",

"callback",

"help",

"version")

# The set of actions that involve storing a value somewhere;

# also listed just for constructor argument validation. (If

# the action is one of these, there must be a destination.)

STORE_ACTIONS = ("store",

"store_const",

"store_true",

"store_false",

"append",

"append_const",

"count")

# The set of actions for which it makes sense to supply a value

# type, ie. which may consume an argument from the command line.

TYPED_ACTIONS = ("store",

"append",

"callback")

# The set of actions which *require* a value type, ie. that

# always consume an argument from the command line.

ALWAYS_TYPED_ACTIONS = ("store",

"append")

# The set of actions which take a 'const' attribute.

CONST_ACTIONS = ("store_const",

"append_const")

# The set of known types for option parsers. Again, listed here for

# constructor argument validation.

TYPES = ("string", "int", "long", "float", "complex", "choice")

# Dictionary of argument checking functions, which convert and

# validate option arguments according to the option type.

# Signature of checking functions is:

# check(option : Option, opt : string, value : string) -> any

# where

# option is the Option instance calling the checker

# opt is the actual option seen on the command-line

# (eg. "-a", "--file")

# value is the option argument seen on the command-line

# The return value should be in the appropriate Python type

# for option.type -- eg. an integer if option.type == "int".

# If no checker is defined for a type, arguments will be

# unchecked and remain strings.

TYPE_CHECKER = { "int" : check_builtin,

"long" : check_builtin,

"float" : check_builtin,

"complex": check_builtin,

"choice" : check_choice,

}

# CHECK_METHODS is a list of unbound method objects; they are called

# by the constructor, in order, after all attributes are

# initialized. The list is created and filled in later, after all

# the methods are actually defined. (I just put it here because I

# like to define and document all class attributes in the same

# place.) Subclasses that add another _check_*() method should

# define their own CHECK_METHODS list that adds their check method

# to those from this class.

CHECK_METHODS = None

# -- Constructor/initialization methods ----------------------------

def __init__(self, *opts, **attrs):

# Set _short_opts, _long_opts attrs from 'opts' tuple.

# Have to be set now, in case no option strings are supplied.

self._short_opts = []

self._long_opts = []

opts = self._check_opt_strings(opts)

self._set_opt_strings(opts)

# Set all other attrs (action, type, etc.) from 'attrs' dict

self._set_attrs(attrs)

# Check all the attributes we just set. There are lots of

# complicated interdependencies, but luckily they can be farmed

# out to the _check_*() methods listed in CHECK_METHODS -- which

# could be handy for subclasses! The one thing these all share

# is that they raise OptionError if they discover a problem.

for checker in self.CHECK_METHODS:

checker(self)

def _check_opt_strings(self, opts):

# Filter out None because early versions of Optik had exactly

# one short option and one long option, either of which

# could be None.

opts = [opt for opt in opts if opt]

if not opts:

raise TypeError("at least one option string must be supplied")

return opts

def _set_opt_strings(self, opts):

for opt in opts:

if len(opt) < 2:

raise OptionError(

"invalid option string %r: "

"must be at least two characters long" % opt, self)

elif len(opt) == 2:

if not (opt[0] == "-" and opt[1] != "-"):

raise OptionError(

"invalid short option string %r: "

"must be of the form -x, (x any non-dash char)" % opt,

self)

self._short_opts.append(opt)

else:

if not (opt[0:2] == "--" and opt[2] != "-"):

raise OptionError(

"invalid long option string %r: "

"must start with --, followed by non-dash" % opt,

self)

self._long_opts.append(opt)

def _set_attrs(self, attrs):

for attr in self.ATTRS:

if attr in attrs:

setattr(self, attr, attrs[attr])

del attrs[attr]

else:

if attr == 'default':

setattr(self, attr, NO_DEFAULT)

else:

setattr(self, attr, None)

if attrs:

attrs = sorted(attrs.keys())

raise OptionError(

"invalid keyword arguments: %s" % ", ".join(attrs),

self)

# -- Constructor validation methods --------------------------------

def _check_action(self):

if self.action is None:

self.action = "store"

elif self.action not in self.ACTIONS:

raise OptionError("invalid action: %r" % self.action, self)

def _check_type(self):

if self.type is None:

if self.action in self.ALWAYS_TYPED_ACTIONS:

if self.choices is not None:

# The "choices" attribute implies "choice" type.

self.type = "choice"

else:

# No type given? "string" is the most sensible default.

self.type = "string"

else:

# Allow type objects or builtin type conversion functions

# (int, str, etc.) as an alternative to their names.

if isinstance(self.type, type):

self.type = self.type.__name__

if self.type == "str":

self.type = "string"

if self.type not in self.TYPES:

raise OptionError("invalid option type: %r" % self.type, self)

if self.action not in self.TYPED_ACTIONS:

raise OptionError(

"must not supply a type for action %r" % self.action, self)

def _check_choice(self):

if self.type == "choice":

if self.choices is None:

raise OptionError(

"must supply a list of choices for type 'choice'", self)

elif not isinstance(self.choices, (tuple, list)):

raise OptionError(

"choices must be a list of strings ('%s' supplied)"

% str(type(self.choices)).split("'")[1], self)

elif self.choices is not None:

raise OptionError(

"must not supply choices for type %r" % self.type, self)

def _check_dest(self):

# No destination given, and we need one for this action. The

# self.type check is for callbacks that take a value.

takes_value = (self.action in self.STORE_ACTIONS or

self.type is not None)

if self.dest is None and takes_value:

# Glean a destination from the first long option string,

# or from the first short option string if no long options.

if self._long_opts:

# eg. "--foo-bar" -> "foo_bar"

self.dest = self._long_opts[0][2:].replace('-', '_')

else:

self.dest = self._short_opts[0][1]

def _check_const(self):

if self.action not in self.CONST_ACTIONS and self.const is not None:

raise OptionError(

"'const' must not be supplied for action %r" % self.action,

self)

def _check_nargs(self):

if self.action in self.TYPED_ACTIONS:

if self.nargs is None:

self.nargs = 1

elif self.nargs is not None:

raise OptionError(

"'nargs' must not be supplied for action %r" % self.action,

self)

def _check_callback(self):

if self.action == "callback":

if not callable(self.callback):

raise OptionError(

"callback not callable: %r" % self.callback, self)

if (self.callback_args is not None and

not isinstance(self.callback_args, tuple)):

raise OptionError(

"callback_args, if supplied, must be a tuple: not %r"

% self.callback_args, self)

if (self.callback_kwargs is not None and

not isinstance(self.callback_kwargs, dict)):

raise OptionError(

"callback_kwargs, if supplied, must be a dict: not %r"

% self.callback_kwargs, self)

else:

if self.callback is not None:

raise OptionError(

"callback supplied (%r) for non-callback option"

% self.callback, self)

if self.callback_args is not None:

raise OptionError(

"callback_args supplied for non-callback option", self)

if self.callback_kwargs is not None:

raise OptionError(

"callback_kwargs supplied for non-callback option", self)

CHECK_METHODS = [_check_action,

_check_type,

_check_choice,

_check_dest,

_check_const,

_check_nargs,

_check_callback]

# -- Miscellaneous methods -----------------------------------------

def __str__(self):

return "/".join(self._short_opts + self._long_opts)

__repr__ = _repr

def takes_value(self):

return self.type is not None

def get_opt_string(self):

if self._long_opts:

return self._long_opts[0]

else:

return self._short_opts[0]

# -- Processing methods --------------------------------------------

def check_value(self, opt, value):

checker = self.TYPE_CHECKER.get(self.type)

if checker is None:

return value

else:

return checker(self, opt, value)

def convert_value(self, opt, value):

if value is not None:

if self.nargs == 1:

return self.check_value(opt, value)

else:

return tuple([self.check_value(opt, v) for v in value])

def process(self, opt, value, values, parser):

# First, convert the value(s) to the right type. Howl if any

# value(s) are bogus.

value = self.convert_value(opt, value)

# And then take whatever action is expected of us.

# This is a separate method to make life easier for

# subclasses to add new actions.

return self.take_action(

self.action, self.dest, opt, value, values, parser)

def take_action(self, action, dest, opt, value, values, parser):

if action == "store":

setattr(values, dest, value)

elif action == "store_const":

setattr(values, dest, self.const)

elif action == "store_true":

setattr(values, dest, True)

elif action == "store_false":

setattr(values, dest, False)

elif action == "append":

values.ensure_value(dest, []).append(value)

elif action == "append_const":

values.ensure_value(dest, []).append(self.const)

elif action == "count":

setattr(values, dest, values.ensure_value(dest, 0) + 1)

elif action == "callback":

args = self.callback_args or ()

kwargs = self.callback_kwargs or {}

self.callback(self, opt, value, parser, *args, **kwargs)

elif action == "help":

parser.print_help()

parser.exit()

elif action == "version":

parser.print_version()

parser.exit()

else:

raise ValueError("unknown action %r" % self.action)

return 1

# class Option

SUPPRESS_HELP = "SUPPRESS"+"HELP"

SUPPRESS_USAGE = "SUPPRESS"+"USAGE"

class Values:

def __init__(self, defaults=None):

if defaults:

for (attr, val) in defaults.items():

setattr(self, attr, val)

def __str__(self):

return str(self.__dict__)

__repr__ = _repr

def __eq__(self, other):

if isinstance(other, Values):

return self.__dict__ == other.__dict__

elif isinstance(other, dict):

return self.__dict__ == other

else:

return NotImplemented

def _update_careful(self, dict):

"""

Update the option values from an arbitrary dictionary, but only

use keys from dict that already have a corresponding attribute

in self. Any keys in dict without a corresponding attribute

are silently ignored.

"""

for attr in dir(self):

if attr in dict:

dval = dict[attr]

if dval is not None:

setattr(self, attr, dval)

def _update_loose(self, dict):

"""

Update the option values from an arbitrary dictionary,

using all keys from the dictionary regardless of whether

they have a corresponding attribute in self or not.

"""

self.__dict__.update(dict)

def _update(self, dict, mode):

if mode == "careful":

self._update_careful(dict)

elif mode == "loose":

self._update_loose(dict)

else:

raise ValueError("invalid update mode: %r" % mode)

def read_module(self, modname, mode="careful"):

__import__(modname)

mod = sys.modules[modname]

self._update(vars(mod), mode)

def read_file(self, filename, mode="careful"):

vars = {}

exec(open(filename).read(), vars)

self._update(vars, mode)

def ensure_value(self, attr, value):

if not hasattr(self, attr) or getattr(self, attr) is None:

setattr(self, attr, value)

return getattr(self, attr)

class OptionContainer:

"""

Abstract base class.

Class attributes:

standard_option_list : [Option]

list of standard options that will be accepted by all instances

of this parser class (intended to be overridden by subclasses).

Instance attributes:

option_list : [Option]

the list of Option objects contained by this OptionContainer

_short_opt : { string : Option }

dictionary mapping short option strings, eg. "-f" or "-X",

to the Option instances that implement them. If an Option

has multiple short option strings, it will appear in this

dictionary multiple times. [1]

_long_opt : { string : Option }

dictionary mapping long option strings, eg. "--file" or

"--exclude", to the Option instances that implement them.

Again, a given Option can occur multiple times in this

dictionary. [1]

defaults : { string : any }

dictionary mapping option destination names to default

values for each destination [1]

[1] These mappings are common to (shared by) all components of the

controlling OptionParser, where they are initially created.

"""

def __init__(self, option_class, conflict_handler, description):

# Initialize the option list and related data structures.

# This method must be provided by subclasses, and it must

# initialize at least the following instance attributes:

# option_list, _short_opt, _long_opt, defaults.

self._create_option_list()

self.option_class = option_class

self.set_conflict_handler(conflict_handler)

self.set_description(description)

def _create_option_mappings(self):

# For use by OptionParser constructor -- create the master

# option mappings used by this OptionParser and all

# OptionGroups that it owns.

self._short_opt = {} # single letter -> Option instance

self._long_opt = {} # long option -> Option instance

self.defaults = {} # maps option dest -> default value

def _share_option_mappings(self, parser):

# For use by OptionGroup constructor -- use shared option

# mappings from the OptionParser that owns this OptionGroup.

self._short_opt = parser._short_opt

self._long_opt = parser._long_opt

self.defaults = parser.defaults

def set_conflict_handler(self, handler):

if handler not in ("error", "resolve"):

raise ValueError("invalid conflict_resolution value %r" % handler)

self.conflict_handler = handler

def set_description(self, description):

self.description = description

def get_description(self):

return self.description

def destroy(self):

"""see OptionParser.destroy()."""

del self._short_opt

del self._long_opt

del self.defaults

# -- Option-adding methods -----------------------------------------

def _check_conflict(self, option):

conflict_opts = []

for opt in option._short_opts:

if opt in self._short_opt:

conflict_opts.append((opt, self._short_opt[opt]))

for opt in option._long_opts:

if opt in self._long_opt:

conflict_opts.append((opt, self._long_opt[opt]))

if conflict_opts:

handler = self.conflict_handler

if handler == "error":

raise OptionConflictError(

"conflicting option string(s): %s"

% ", ".join([co[0] for co in conflict_opts]),

option)

elif handler == "resolve":

for (opt, c_option) in conflict_opts:

if opt.startswith("--"):

c_option._long_opts.remove(opt)

del self._long_opt[opt]

else:

c_option._short_opts.remove(opt)

del self._short_opt[opt]

if not (c_option._short_opts or c_option._long_opts):

c_option.container.option_list.remove(c_option)

def add_option(self, *args, **kwargs):

"""add_option(Option)

add_option(opt_str, ..., kwarg=val, ...)

"""

if isinstance(args[0], str):

option = self.option_class(*args, **kwargs)

elif len(args) == 1 and not kwargs:

View remainder of file in raw view

cpython/Lib/optparse.py at 3.5 · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

optparse.py

Latest commit

History

Breadcrumbs

optparse.py

File metadata and controls