matplotlib.github.com/_modules/matplotlib/rcsetup.html at master · pjastr/matplotlib.github.com

History

1639 lines (1372 loc) · 229 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 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.rcsetup — Matplotlib 3.1.0 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.0 documentation"

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

</head>

<body>

The 2019 SciPy John Hunter Excellence in Plotting Contest is accepting submissions!

<a href="https://docs.google.com/forms/d/e/1FAIpQLSe-_AnKvYSzeQWfNDRoXgW0vl7_8q6jj3QbLIac8eUcb9lSAA/viewform?usp=sf_link" style="font-weight: bold;">Apply by June 8th</a>

</div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.1.0</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li><a href="../../gallery/index.html">examples</a>| </li>

<li><a href="../../tutorials/index.html">tutorials</a>| </li>

<li><a href="../../contents.html">contents</a> »</li>

<li><a href="../index.html" >Module code</a> »</li>

<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.rcsetup</h1><div class="highlight"><pre>

"""

The rcsetup module contains the default values and the validation code for

customization using matplotlib's rc settings.

Each rc setting is assigned a default value and a function used to validate

any attempted changes to that setting. The default values and validation

functions are defined in the rcsetup module, and are used to construct the

rcParams global object which stores the settings and is referenced throughout

matplotlib.

These default values should be consistent with the default matplotlibrc file

that actually reflects the values given here. Any additions or deletions to the

parameter set listed here should also be visited to the

:file:`matplotlibrc.template` in matplotlib's root source directory.

"""

from collections.abc import Iterable, Mapping

from functools import reduce

import operator

import os

import re

from matplotlib import cbook

from matplotlib.cbook import ls_mapper

from matplotlib.fontconfig_pattern import parse_fontconfig_pattern

from matplotlib.colors import is_color_like

# Don't let the original cycler collide with our validating cycler

from cycler import Cycler, cycler as ccycler

# The capitalized forms are needed for ipython at present; this may

# change for later versions.

interactive_bk = ['GTK3Agg', 'GTK3Cairo',

'MacOSX',

'nbAgg',

'Qt4Agg', 'Qt4Cairo', 'Qt5Agg', 'Qt5Cairo',

'TkAgg', 'TkCairo',

'WebAgg',

'WX', 'WXAgg', 'WXCairo']

non_interactive_bk = ['agg', 'cairo',

'pdf', 'pgf', 'ps', 'svg', 'template']

all_backends = interactive_bk + non_interactive_bk

<div class="viewcode-block" id="ValidateInStrings"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.ValidateInStrings">[docs]</a>class ValidateInStrings(object):

def __init__(self, key, valid, ignorecase=False):

'valid is a list of legal strings'

self.key = key

self.ignorecase = ignorecase

def func(s):

if ignorecase:

return s.lower()

else:

return s

self.valid = {func(k): k for k in valid}

def __call__(self, s):

if self.ignorecase:

s = s.lower()

if s in self.valid:

return self.valid[s]

raise ValueError('Unrecognized %s string %r: valid strings are %s'

% (self.key, s, list(self.valid.values())))</div>

def _listify_validator(scalar_validator, allow_stringlist=False):

def f(s):

if isinstance(s, str):

try:

return [scalar_validator(v.strip()) for v in s.split(',')

if v.strip()]

except Exception:

if allow_stringlist:

# Sometimes, a list of colors might be a single string

# of single-letter colornames. So give that a shot.

for v in s if v.strip()]

else:

raise

# We should allow any generic sequence type, including generators,

# Numpy ndarrays, and pandas data structures. However, unordered

# sequences, such as sets, should be allowed but discouraged unless the

# user desires pseudorandom behavior.

elif isinstance(s, Iterable) and not isinstance(s, Mapping):

# The condition on this list comprehension will preserve the

# behavior of filtering out any empty strings (behavior was

# from the original validate_stringlist()), while allowing

# any non-string/text scalar values such as numbers and arrays.

return [scalar_validator(v) for v in s

if not isinstance(v, str) or v]

else:

raise ValueError("{!r} must be of type: string or non-dictionary "

"iterable".format(s))

try:

f.__name__ = "{}list".format(scalar_validator.__name__)

except AttributeError: # class instance.

f.__name__ = "{}List".format(type(scalar_validator).__name__)

f.__doc__ = scalar_validator.__doc__

return f

<div class="viewcode-block" id="validate_any"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_any">[docs]</a>def validate_any(s):

return s</div>

validate_anylist = _listify_validator(validate_any)

<div class="viewcode-block" id="validate_path_exists"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_path_exists">[docs]</a>def validate_path_exists(s):

"""If s is a path, return s, else False"""

if s is None:

return None

if os.path.exists(s):

return s

else:

raise RuntimeError('"%s" should be a path but it does not exist' % s)</div>

<div class="viewcode-block" id="validate_bool"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_bool">[docs]</a>def validate_bool(b):

"""Convert b to a boolean or raise"""

if isinstance(b, str):

b = b.lower()

if b in ('t', 'y', 'yes', 'on', 'true', '1', 1, True):

return True

elif b in ('f', 'n', 'no', 'off', 'false', '0', 0, False):

return False

else:

raise ValueError('Could not convert "%s" to boolean' % b)</div>

<div class="viewcode-block" id="validate_bool_maybe_none"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_bool_maybe_none">[docs]</a>def validate_bool_maybe_none(b):

'Convert b to a boolean or raise'

if isinstance(b, str):

b = b.lower()

if b is None or b == 'none':

return None

return True

return False

else:

<div class="viewcode-block" id="validate_float"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_float">[docs]</a>def validate_float(s):

"""convert s to float or raise"""

try:

return float(s)

except ValueError:

raise ValueError('Could not convert "%s" to float' % s)</div>

validate_floatlist = _listify_validator(validate_float)

<div class="viewcode-block" id="validate_float_or_None"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_float_or_None">[docs]</a>def validate_float_or_None(s):

"""convert s to float, None or raise"""

# values directly from the rc file can only be strings,

# so we need to recognize the string "None" and convert

# it into the object. We will be case-sensitive here to

# avoid confusion between string values of 'none', which

# can be a valid string value for some other parameters.

if s is None or s == 'None':

return None

try:

return float(s)

except ValueError:

raise ValueError('Could not convert "%s" to float or None' % s)</div>

<div class="viewcode-block" id="validate_string_or_None"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_string_or_None">[docs]</a>def validate_string_or_None(s):

"""convert s to string or raise"""

if s is None:

return None

try:

return validate_string(s)

except ValueError:

raise ValueError('Could not convert "%s" to string' % s)</div>

def _validate_tex_preamble(s):

return ""

try:

if isinstance(s, str):

return s

elif isinstance(s, Iterable):

return '\n'.join(s)

else:

raise TypeError

except TypeError:

raise ValueError('Could not convert "%s" to string' % s)

<div class="viewcode-block" id="validate_axisbelow"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_axisbelow">[docs]</a>def validate_axisbelow(s):

try:

return validate_bool(s)

except ValueError:

if isinstance(s, str):

s = s.lower()

if s.startswith('line'):

return 'line'

raise ValueError('%s cannot be interpreted as'

' True, False, or "line"' % s)</div>

<div class="viewcode-block" id="validate_dpi"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_dpi">[docs]</a>def validate_dpi(s):

"""confirm s is string 'figure' or convert s to float or raise"""

if s == 'figure':

return s

try:

return float(s)

except ValueError:

raise ValueError('"%s" is not string "figure" or'

' could not convert "%s" to float' % (s, s))</div>

<div class="viewcode-block" id="validate_int"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_int">[docs]</a>def validate_int(s):

"""convert s to int or raise"""

try:

return int(s)

except ValueError:

raise ValueError('Could not convert "%s" to int' % s)</div>

<div class="viewcode-block" id="validate_int_or_None"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_int_or_None">[docs]</a>def validate_int_or_None(s):

"""if not None, tries to validate as an int"""

if s == 'None':

s = None

if s is None:

return None

try:

return int(s)

except ValueError:

raise ValueError('Could not convert "%s" to int' % s)</div>

<div class="viewcode-block" id="validate_fonttype"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_fonttype">[docs]</a>def validate_fonttype(s):

"""

confirm that this is a Postscript of PDF font type that we know how to

convert to

"""

fonttypes = {'type3': 3,

'truetype': 42}

try:

fonttype = validate_int(s)

except ValueError:

try:

return fonttypes[s.lower()]

except KeyError:

raise ValueError(

'Supported Postscript/PDF font types are %s' % list(fonttypes))

else:

if fonttype not in fonttypes.values():

raise ValueError(

'Supported Postscript/PDF font types are %s' %

list(fonttypes.values()))

return fonttype</div>

_validate_standard_backends = ValidateInStrings(

'backend', all_backends, ignorecase=True)

_auto_backend_sentinel = object()

<div class="viewcode-block" id="validate_backend"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_backend">[docs]</a>def validate_backend(s):

backend = (

s if s is _auto_backend_sentinel or s.startswith("module://")

else _validate_standard_backends(s))

return backend</div>

<div class="viewcode-block" id="validate_qt4"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_qt4">[docs]</a>@cbook.deprecated("3.1")

def validate_qt4(s):

if s is None:

return None

return ValidateInStrings("backend.qt4", ['PyQt4', 'PySide', 'PyQt4v2'])(s)</div>

<div class="viewcode-block" id="validate_qt5"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_qt5">[docs]</a>@cbook.deprecated("3.1")

def validate_qt5(s):

if s is None:

return None

return ValidateInStrings("backend.qt5", ['PyQt5', 'PySide2'])(s)</div>

<div class="viewcode-block" id="validate_toolbar"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_toolbar">[docs]</a>def validate_toolbar(s):

validator = ValidateInStrings(

'toolbar',

['None', 'toolbar2', 'toolmanager'],

ignorecase=True)

return validator(s)</div>

_seq_err_msg = ('You must supply exactly {n} values, you provided {num} '

'values: {s}')

_str_err_msg = ('You must supply exactly {n} comma-separated values, you '

'provided {num} comma-separated values: {s}')

<div class="viewcode-block" id="validate_nseq_float"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_nseq_float">[docs]</a>class validate_nseq_float(object):

def __init__(self, n=None, allow_none=False):

self.n = n

self.allow_none = allow_none

def __call__(self, s):

"""return a seq of n floats or raise"""

if isinstance(s, str):

s = [x.strip() for x in s.split(',')]

err_msg = _str_err_msg

else:

err_msg = _seq_err_msg

if self.n is not None and len(s) != self.n:

raise ValueError(err_msg.format(n=self.n, num=len(s), s=s))

try:

return [float(val)

if not self.allow_none or val is not None

else val

for val in s]

except ValueError:

raise ValueError('Could not convert all entries to floats')</div>

<div class="viewcode-block" id="validate_nseq_int"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_nseq_int">[docs]</a>class validate_nseq_int(object):

self.n = n

def __call__(self, s):

"""return a seq of n ints or raise"""

if isinstance(s, str):

err_msg = _str_err_msg

else:

err_msg = _seq_err_msg

try:

return [int(val) for val in s]

except ValueError:

raise ValueError('Could not convert all entries to ints')</div>

<div class="viewcode-block" id="validate_color_or_inherit"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color_or_inherit">[docs]</a>def validate_color_or_inherit(s):

'return a valid color arg'

if s == 'inherit':

return s

return validate_color(s)</div>

<div class="viewcode-block" id="validate_color_or_auto"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color_or_auto">[docs]</a>def validate_color_or_auto(s):

if s == 'auto':

return s

return validate_color(s)</div>

<div class="viewcode-block" id="validate_color_for_prop_cycle"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color_for_prop_cycle">[docs]</a>def validate_color_for_prop_cycle(s):

# Special-case the N-th color cycle syntax, this obviously can not

# go in the color cycle.

if isinstance(s, bytes):

match = re.match(b'^C[0-9]$', s)

if match is not None:

raise ValueError('Can not put cycle reference ({cn!r}) in '

'prop_cycler'.format(cn=s))

elif isinstance(s, str):

match = re.match('^C[0-9]$', s)

if match is not None:

return validate_color(s)</div>

<div class="viewcode-block" id="validate_color"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_color">[docs]</a>def validate_color(s):

'return a valid color arg'

try:

if s.lower() == 'none':

return 'none'

except AttributeError:

pass

if isinstance(s, str):

if len(s) == 6 or len(s) == 8:

stmp = '#' + s

if is_color_like(stmp):

return stmp

if is_color_like(s):

return s

# If it is still valid, it must be a tuple.

colorarg = s

msg = ''

if s.find(',') >= 0:

# get rid of grouping symbols

stmp = ''.join([c for c in s if c.isdigit() or c == '.' or c == ','])

vals = stmp.split(',')

if len(vals) not in [3, 4]:

msg = '\nColor tuples must be of length 3 or 4'

else:

try:

colorarg = [float(val) for val in vals]

except ValueError:

msg = '\nCould not convert all entries to floats'

if not msg and is_color_like(colorarg):

return colorarg

raise ValueError('%s does not look like a color arg%s' % (s, msg))</div>

validate_colorlist = _listify_validator(validate_color, allow_stringlist=True)

validate_colorlist.__doc__ = 'return a list of colorspecs'

<div class="viewcode-block" id="validate_string"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_string">[docs]</a>def validate_string(s):

if isinstance(s, str):

# Always leave str as str and unicode as unicode

return s

else:

return str(s)</div>

validate_stringlist = _listify_validator(str)

validate_stringlist.__doc__ = 'return a list'

validate_orientation = ValidateInStrings(

'orientation', ['landscape', 'portrait'])

<div class="viewcode-block" id="validate_aspect"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_aspect">[docs]</a>def validate_aspect(s):

if s in ('auto', 'equal'):

return s

try:

return float(s)

except ValueError:

raise ValueError('not a valid aspect specification')</div>

<div class="viewcode-block" id="validate_fontsize_None"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_fontsize_None">[docs]</a>def validate_fontsize_None(s):

return None

else:

return validate_fontsize(s)</div>

<div class="viewcode-block" id="validate_fontsize"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_fontsize">[docs]</a>def validate_fontsize(s):

fontsizes = ['xx-small', 'x-small', 'small', 'medium', 'large',

'x-large', 'xx-large', 'smaller', 'larger']

if isinstance(s, str):

s = s.lower()

if s in fontsizes:

return s

try:

return float(s)

except ValueError:

raise ValueError("%s is not a valid font size. Valid font sizes "

"are %s." % (s, ", ".join(fontsizes)))</div>

validate_fontsizelist = _listify_validator(validate_fontsize)

<div class="viewcode-block" id="validate_font_properties"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_font_properties">[docs]</a>def validate_font_properties(s):

parse_fontconfig_pattern(s)

return s</div>

validate_fontset = ValidateInStrings(

'fontset',

['dejavusans', 'dejavuserif', 'cm', 'stix', 'stixsans', 'custom'])

<div class="viewcode-block" id="validate_mathtext_default"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_mathtext_default">[docs]</a>def validate_mathtext_default(s):

if s == "circled":

cbook.warn_deprecated(

"3.1", message="Support for setting the mathtext.default rcParam "

"to 'circled' is deprecated since %(since)s and will be removed "

"%(removal)s.")

return ValidateInStrings(

'default',

"rm cal it tt sf bf default bb frak circled scr regular".split())(s)</div>

_validate_alignment = ValidateInStrings(

'alignment',

['center', 'top', 'bottom', 'baseline',

'center_baseline'])

_validate_verbose = ValidateInStrings(

'verbose',

['silent', 'helpful', 'debug', 'debug-annoying'])

<div class="viewcode-block" id="validate_verbose"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_verbose">[docs]</a>@cbook.deprecated("3.1")

def validate_verbose(s):

return _validate_verbose(s)</div>

<div class="viewcode-block" id="validate_whiskers"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_whiskers">[docs]</a>def validate_whiskers(s):

if s == 'range':

return 'range'

else:

try:

v = validate_nseq_float(2)(s)

return v

except (TypeError, ValueError):

try:

v = float(s)

return v

except ValueError:

raise ValueError("Not a valid whisker value ['range', float, "

"(float, float)]")</div>

<div class="viewcode-block" id="update_savefig_format"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.update_savefig_format">[docs]</a>def update_savefig_format(value):

# The old savefig.extension could also have a value of "auto", but

# the new savefig.format does not. We need to fix this here.

value = validate_string(value)

if value == 'auto':

value = 'png'

return value</div>

validate_ps_papersize = ValidateInStrings(

'ps_papersize',

['auto', 'letter', 'legal', 'ledger',

'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'a7', 'a8', 'a9', 'a10',

'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'b7', 'b8', 'b9', 'b10',

], ignorecase=True)

<div class="viewcode-block" id="validate_ps_distiller"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_ps_distiller">[docs]</a>def validate_ps_distiller(s):

if isinstance(s, str):

s = s.lower()

if s in ('none', None):

return None

elif s in ('false', False):

return False

elif s in ('ghostscript', 'xpdf'):

return s

else:

raise ValueError('matplotlibrc ps.usedistiller must either be none, '

'ghostscript or xpdf')</div>

validate_joinstyle = ValidateInStrings('joinstyle',

['miter', 'round', 'bevel'],

ignorecase=True)

validate_joinstylelist = _listify_validator(validate_joinstyle)

validate_capstyle = ValidateInStrings('capstyle',

['butt', 'round', 'projecting'],

ignorecase=True)

validate_capstylelist = _listify_validator(validate_capstyle)

validate_fillstyle = ValidateInStrings('markers.fillstyle',

['full', 'left', 'right', 'bottom',

'top', 'none'])

validate_fillstylelist = _listify_validator(validate_fillstyle)

_validate_negative_linestyle = ValidateInStrings('negative_linestyle',

['solid', 'dashed'],

ignorecase=True)

<div class="viewcode-block" id="validate_markevery"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_markevery">[docs]</a>def validate_markevery(s):

"""

Validate the markevery property of a Line2D object.

Parameters

----------

s : None, int, float, slice, length-2 tuple of ints,

length-2 tuple of floats, list of ints

Returns

-------

s : None, int, float, slice, length-2 tuple of ints,

length-2 tuple of floats, list of ints

"""

# Validate s against type slice

if isinstance(s, slice):

return s

# Validate s against type tuple

if isinstance(s, tuple):

tupMaxLength = 2

tupType = type(s[0])

if len(s) != tupMaxLength:

raise TypeError("'markevery' tuple must have a length of "

"%d" % (tupMaxLength))

if tupType is int and not all(isinstance(e, int) for e in s):

raise TypeError("'markevery' tuple with first element of "

"type int must have all elements of type "

"int")

if tupType is float and not all(isinstance(e, float) for e in s):

raise TypeError("'markevery' tuple with first element of "

"type float must have all elements of type "

"float")

if tupType is not float and tupType is not int:

raise TypeError("'markevery' tuple contains an invalid type")

# Validate s against type list

elif isinstance(s, list):

if not all(isinstance(e, int) for e in s):

raise TypeError("'markevery' list must have all elements of "

"type int")

# Validate s against type float int and None

elif not isinstance(s, (float, int)):

if s is not None:

raise TypeError("'markevery' is of an invalid type")

return s</div>

validate_markeverylist = _listify_validator(validate_markevery)

validate_legend_loc = ValidateInStrings(

'legend_loc',

['best',

'upper right',

'upper left',

'lower left',

'lower right',

'right',

'center left',

'center right',

'lower center',

'upper center',

'center'], ignorecase=True)

<div class="viewcode-block" id="validate_svg_fonttype"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_svg_fonttype">[docs]</a>def validate_svg_fonttype(s):

if s in ["none", "path"]:

return s

raise ValueError("Unrecognized svg.fonttype string '{}'; "

"valid strings are 'none', 'path'")</div>

<div class="viewcode-block" id="validate_hinting"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_hinting">[docs]</a>def validate_hinting(s):

if s in (True, False):

return s

if s.lower() in ('auto', 'native', 'either', 'none'):

return s.lower()

raise ValueError("hinting should be 'auto', 'native', 'either' or 'none'")</div>

validate_pgf_texsystem = ValidateInStrings('pgf.texsystem',

['xelatex', 'lualatex', 'pdflatex'])

validate_movie_writer = ValidateInStrings('animation.writer',

['ffmpeg', 'ffmpeg_file',

'avconv', 'avconv_file',

'imagemagick', 'imagemagick_file',

'html'])

validate_movie_frame_fmt = ValidateInStrings('animation.frame_format',

['png', 'jpeg', 'tiff', 'raw', 'rgba'])

validate_axis_locator = ValidateInStrings('major', ['minor', 'both', 'major'])

validate_movie_html_fmt = ValidateInStrings('animation.html',

['html5', 'jshtml', 'none'])

<div class="viewcode-block" id="validate_bbox"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_bbox">[docs]</a>def validate_bbox(s):

if isinstance(s, str):

s = s.lower()

if s == 'tight':

return s

if s == 'standard':

return None

raise ValueError("bbox should be 'tight' or 'standard'")

elif s is not None:

# Backwards compatibility. None is equivalent to 'standard'.

raise ValueError("bbox should be 'tight' or 'standard'")

return s</div>

<div class="viewcode-block" id="validate_sketch"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_sketch">[docs]</a>def validate_sketch(s):

if isinstance(s, str):

s = s.lower()

if s == 'none' or s is None:

return None

if isinstance(s, str):

result = tuple([float(v.strip()) for v in s.split(',')])

elif isinstance(s, (list, tuple)):

if len(result) != 3:

raise ValueError("path.sketch must be a tuple (scale, length, randomness)")

return result</div>

<div class="viewcode-block" id="ValidateInterval"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.ValidateInterval">[docs]</a>class ValidateInterval(object):

"""

Value must be in interval

"""

def __init__(self, vmin, vmax, closedmin=True, closedmax=True):

self.vmin = vmin

self.vmax = vmax

self.cmin = closedmin

self.cmax = closedmax

def __call__(self, s):

try:

s = float(s)

except ValueError:

raise RuntimeError('Value must be a float; found "%s"' % s)

if self.cmin and s < self.vmin:

raise RuntimeError('Value must be >= %f; found "%f"' %

(self.vmin, s))

elif not self.cmin and s <= self.vmin:

raise RuntimeError('Value must be > %f; found "%f"' %

(self.vmin, s))

if self.cmax and s > self.vmax:

raise RuntimeError('Value must be <= %f; found "%f"' %

(self.vmax, s))

elif not self.cmax and s >= self.vmax:

raise RuntimeError('Value must be < %f; found "%f"' %

(self.vmax, s))

return s</div>

validate_grid_axis = ValidateInStrings('axes.grid.axis', ['x', 'y', 'both'])

<div class="viewcode-block" id="validate_hatch"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_hatch">[docs]</a>def validate_hatch(s):

"""

Validate a hatch pattern.

A hatch pattern string can have any sequence of the following

characters: ``\\ / | - + * . x o O``.

"""

if not isinstance(s, str):

raise ValueError("Hatch pattern must be a string")

unknown = set(s) - {'\\', '/', '|', '-', '+', '*', '.', 'x', 'o', 'O'}

if unknown:

raise ValueError("Unknown hatch symbol(s): %s" % list(unknown))

return s</div>

validate_hatchlist = _listify_validator(validate_hatch)

validate_dashlist = _listify_validator(validate_nseq_float(allow_none=True))

_prop_validators = {

'color': _listify_validator(validate_color_for_prop_cycle,

allow_stringlist=True),

'linewidth': validate_floatlist,

'linestyle': validate_stringlist,

'facecolor': validate_colorlist,

'edgecolor': validate_colorlist,

'joinstyle': validate_joinstylelist,

'capstyle': validate_capstylelist,

'fillstyle': validate_fillstylelist,

'markerfacecolor': validate_colorlist,

'markersize': validate_floatlist,

'markeredgewidth': validate_floatlist,

'markeredgecolor': validate_colorlist,

'markevery': validate_markeverylist,

'alpha': validate_floatlist,

'marker': validate_stringlist,

'hatch': validate_hatchlist,

'dashes': validate_dashlist,

}

_prop_aliases = {

'c': 'color',

'lw': 'linewidth',

'ls': 'linestyle',

'fc': 'facecolor',

'ec': 'edgecolor',

'mfc': 'markerfacecolor',

'mec': 'markeredgecolor',

'mew': 'markeredgewidth',

'ms': 'markersize',

}

<div class="viewcode-block" id="cycler"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.cycler">[docs]</a>def cycler(*args, **kwargs):

"""

Creates a `~cycler.Cycler` object much like :func:`cycler.cycler`,

but includes input validation.

Call signatures::

cycler(cycler)

cycler(label=values[, label2=values2[, ...]])

cycler(label, values)

Form 1 copies a given `~cycler.Cycler` object.

Form 2 creates a `~cycler.Cycler` which cycles over one or more

properties simultaneously. If multiple properties are given, their

value lists must have the same length.

Form 3 creates a `~cycler.Cycler` for a single property. This form

exists for compatibility with the original cycler. Its use is

discouraged in favor of the kwarg form, i.e. ``cycler(label=values)``.

Parameters

----------

cycler : Cycler

Copy constructor for Cycler.

label : str

The property key. Must be a valid `.Artist` property.

For example, 'color' or 'linestyle'. Aliases are allowed,

such as 'c' for 'color' and 'lw' for 'linewidth'.

values : iterable

Finite-length iterable of the property values. These values

are validated and will raise a ValueError if invalid.

Returns

-------

cycler : Cycler

A new :class:`~cycler.Cycler` for the given properties.

Examples

--------

Creating a cycler for a single property:

>>> c = cycler(color=['red', 'green', 'blue'])

Creating a cycler for simultaneously cycling over multiple properties

(e.g. red circle, green plus, blue cross):

>>> c = cycler(color=['red', 'green', 'blue'],

... marker=['o', '+', 'x'])

"""

if args and kwargs:

raise TypeError("cycler() can only accept positional OR keyword "

"arguments -- not both.")

elif not args and not kwargs:

raise TypeError("cycler() must have positional OR keyword arguments")

if len(args) == 1:

if not isinstance(args[0], Cycler):

raise TypeError("If only one positional argument given, it must "

" be a Cycler instance.")

return validate_cycler(args[0])

elif len(args) == 2:

pairs = [(args[0], args[1])]

elif len(args) > 2:

raise TypeError("No more than 2 positional arguments allowed")

else:

pairs = kwargs.items()

validated = []

for prop, vals in pairs:

norm_prop = _prop_aliases.get(prop, prop)

validator = _prop_validators.get(norm_prop, None)

if validator is None:

raise TypeError("Unknown artist property: %s" % prop)

vals = validator(vals)

# We will normalize the property names as well to reduce

# the amount of alias handling code elsewhere.

validated.append((norm_prop, vals))

return reduce(operator.add, (ccycler(k, v) for k, v in validated))</div>

<div class="viewcode-block" id="validate_cycler"><a class="viewcode-back" href="../../api/rcsetup_api.html#matplotlib.rcsetup.validate_cycler">[docs]</a>def validate_cycler(s):

'return a Cycler object from a string repr or the object itself'

if isinstance(s, str):

try:

# TODO: We might want to rethink this...

# While I think I have it quite locked down,

# it is execution of arbitrary code without

# sanitation.

# Combine this with the possibility that rcparams

# might come from the internet (future plans), this

# could be downright dangerous.

# I locked it down by only having the 'cycler()' function

# available.

# UPDATE: Partly plugging a security hole.

# I really should have read this:

# http://nedbatchelder.com/blog/201206/eval_really_is_dangerous.html

# We should replace this eval with a combo of PyParsing and

# ast.literal_eval()

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

rcsetup.html

Latest commit

History

rcsetup.html

File metadata and controls