matplotlib.github.com/3.3.4/_modules/matplotlib.html at gh-pages · matplotlib/matplotlib.github.com

History

1624 lines (1337 loc) · 174 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 — Matplotlib 3.3.4 documentation</title>

title="Search within Matplotlib 3.3.4 documentation"

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

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.4). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<!--

</div>

-->

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

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

</div>

<ul>

<li><a href="../users/installing.html">Installation</a></li>

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

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

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

<li><a href="../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<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="../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> »</li>

<li class="nav-item nav-item-this"><a href="">matplotlib</a></li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

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

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

</ul></li>

</ul>

</div>

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

"""

An object-oriented plotting library.

A procedural interface is provided by the companion pyplot module,

which may be imported directly, e.g.::

import matplotlib.pyplot as plt

or using ipython::

ipython

at your terminal, followed by::

In [1]: %matplotlib

In [2]: import matplotlib.pyplot as plt

at the ipython shell prompt.

For the most part, direct use of the object-oriented library is encouraged when

programming; pyplot is primarily for working interactively. The exceptions are

the pyplot functions `.pyplot.figure`, `.pyplot.subplot`, `.pyplot.subplots`,

and `.pyplot.savefig`, which can greatly simplify scripting.

Modules include:

:mod:`matplotlib.axes`

The `~.axes.Axes` class. Most pyplot functions are wrappers for

`~.axes.Axes` methods. The axes module is the highest level of OO

access to the library.

:mod:`matplotlib.figure`

The `.Figure` class.

:mod:`matplotlib.artist`

The `.Artist` base class for all classes that draw things.

:mod:`matplotlib.lines`

The `.Line2D` class for drawing lines and markers.

:mod:`matplotlib.patches`

Classes for drawing polygons.

:mod:`matplotlib.text`

The `.Text` and `.Annotation` classes.

:mod:`matplotlib.image`

The `.AxesImage` and `.FigureImage` classes.

:mod:`matplotlib.collections`

Classes for efficient drawing of groups of lines or polygons.

:mod:`matplotlib.colors`

Color specifications and making colormaps.

:mod:`matplotlib.cm`

Colormaps, and the `.ScalarMappable` mixin class for providing color

mapping functionality to other classes.

:mod:`matplotlib.ticker`

Calculation of tick mark locations and formatting of tick labels.

:mod:`matplotlib.backends`

A subpackage with modules for various GUI libraries and output formats.

The base matplotlib namespace includes:

`~matplotlib.rcParams`

Default configuration settings; their defaults may be overridden using

a :file:`matplotlibrc` file.

`~matplotlib.use`

Setting the Matplotlib backend. This should be called before any

figure is created, because it is not possible to switch between

different GUI backends after that.

Matplotlib was initially written by John D. Hunter (1968-2012) and is now

developed and maintained by a host of others.

Occasionally the internal documentation (python docstrings) will refer

to MATLAB&reg;, a registered trademark of The MathWorks, Inc.

"""

import atexit

from collections import namedtuple

from collections.abc import MutableMapping

import contextlib

from distutils.version import LooseVersion

import functools

import importlib

import inspect

from inspect import Parameter

import locale

import logging

import os

from pathlib import Path

import pprint

import re

import shutil

import subprocess

import sys

import tempfile

import warnings

# cbook must import matplotlib only within function

# definitions, so it is safe to import from it here.

from . import cbook, rcsetup

from matplotlib.cbook import MatplotlibDeprecationWarning, sanitize_sequence

from matplotlib.cbook import mplDeprecation # deprecated

from matplotlib.rcsetup import validate_backend, cycler

import numpy

# Get the version from the _version.py versioneer file. For a git checkout,

# this is computed based on the number of commits since the last tag.

from ._version import get_versions

__version__ = str(get_versions()['version'])

del get_versions

_log = logging.getLogger(__name__)

__bibtex__ = r"""@Article{Hunter:2007,

Author = {Hunter, J. D.},

Title = {Matplotlib: A 2D graphics environment},

Journal = {Computing in Science \& Engineering},

Volume = {9},

Number = {3},

Pages = {90--95},

abstract = {Matplotlib is a 2D graphics package used for Python

for application development, interactive scripting, and

publication-quality image generation across user

interfaces and operating systems.},

publisher = {IEEE COMPUTER SOC},

year = 2007

}"""

@cbook.deprecated("3.2")

def compare_versions(a, b):

"""Return whether version *a* is greater than or equal to version *b*."""

if isinstance(a, bytes):

cbook.warn_deprecated(

"3.0", message="compare_versions arguments should be strs.")

a = a.decode('ascii')

if isinstance(b, bytes):

cbook.warn_deprecated(

b = b.decode('ascii')

if a:

return LooseVersion(a) >= LooseVersion(b)

else:

return False

def _check_versions():

# Quickfix to ensure Microsoft Visual C++ redistributable

# DLLs are loaded before importing kiwisolver

from . import ft2font

for modname, minver in [

("cycler", "0.10"),

("dateutil", "2.1"),

("kiwisolver", "1.0.1"),

("numpy", "1.15"),

("pyparsing", "2.0.1"),

]:

module = importlib.import_module(modname)

if LooseVersion(module.__version__) < minver:

raise ImportError("Matplotlib requires {}>={}; you have {}"

.format(modname, minver, module.__version__))

_check_versions()

# The decorator ensures this always returns the same handler (and it is only

# attached once).

@functools.lru_cache()

def _ensure_handler():

"""

The first time this function is called, attach a `StreamHandler` using the

same format as `logging.basicConfig` to the Matplotlib root logger.

Return this handler every time this function is called.

"""

handler = logging.StreamHandler()

handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT))

_log.addHandler(handler)

return handler

<div class="viewcode-block" id="set_loglevel"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.set_loglevel">[docs]</a>def set_loglevel(level):

"""

Set Matplotlib's root logger and root logger handler level, creating

the handler if it does not exist yet.

Typically, one should call ``set_loglevel("info")`` or

``set_loglevel("debug")`` to get additional debugging information.

Parameters

----------

level : {"notset", "debug", "info", "warning", "error", "critical"}

The log level of the handler.

Notes

-----

The first time this function is called, an additional handler is attached

to Matplotlib's root handler; this handler is reused every time and this

function simply manipulates the logger and handler's level.

"""

_log.setLevel(level.upper())

_ensure_handler().setLevel(level.upper())</div>

def _logged_cached(fmt, func=None):

"""

Decorator that logs a function's return value, and memoizes that value.

After ::

@_logged_cached(fmt)

def func(): ...

the first call to *func* will log its return value at the DEBUG level using

%-format string *fmt*, and memoize it; later calls to *func* will directly

return that value.

"""

if func is None: # Return the actual decorator.

return functools.partial(_logged_cached, fmt)

called = False

ret = None

@functools.wraps(func)

def wrapper(**kwargs):

nonlocal called, ret

if not called:

ret = func(**kwargs)

called = True

_log.debug(fmt, ret)

return ret

return wrapper

_ExecInfo = namedtuple("_ExecInfo", "executable version")

class ExecutableNotFoundError(FileNotFoundError):

"""

Error raised when an executable that Matplotlib optionally

depends on can't be found.

"""

pass

@functools.lru_cache()

def _get_executable_info(name):

"""

Get the version of some executable that Matplotlib optionally depends on.

.. warning:

The list of executables that this function supports is set according to

Matplotlib's internal needs, and may change without notice.

Parameters

----------

name : str

The executable to query. The following values are currently supported:

"dvipng", "gs", "inkscape", "magick", "pdftops". This list is subject

to change without notice.

Returns

-------

If the executable is found, a namedtuple with fields ``executable`` (`str`)

and ``version`` (`distutils.version.LooseVersion`, or ``None`` if the

version cannot be determined).

Raises

------

ExecutableNotFoundError

If the executable is not found or older than the oldest version

supported by Matplotlib.

ValueError

If the executable is not one that we know how to query.

"""

def impl(args, regex, min_ver=None, ignore_exit_code=False):

# Execute the subprocess specified by args; capture stdout and stderr.

# Search for a regex match in the output; if the match succeeds, the

# first group of the match is the version.

# Return an _ExecInfo if the executable exists, and has a version of

# at least min_ver (if set); else, raise ExecutableNotFoundError.

try:

output = subprocess.check_output(

args, stderr=subprocess.STDOUT,

universal_newlines=True, errors="replace")

except subprocess.CalledProcessError as _cpe:

if ignore_exit_code:

output = _cpe.output

else:

raise ExecutableNotFoundError(str(_cpe)) from _cpe

except OSError as _ose:

raise ExecutableNotFoundError(str(_ose)) from _ose

match = re.search(regex, output)

if match:

version = LooseVersion(match.group(1))

if min_ver is not None and version < min_ver:

raise ExecutableNotFoundError(

f"You have {args[0]} version {version} but the minimum "

f"version supported by Matplotlib is {min_ver}")

return _ExecInfo(args[0], version)

else:

raise ExecutableNotFoundError(

f"Failed to determine the version of {args[0]} from "

f"{' '.join(args)}, which output {output}")

if name == "dvipng":

return impl(["dvipng", "-version"], "(?m)^dvipng(?: .*)? (.+)", "1.6")

elif name == "gs":

execs = (["gswin32c", "gswin64c", "mgs", "gs"] # "mgs" for miktex.

if sys.platform == "win32" else

["gs"])

for e in execs:

try:

return impl([e, "--version"], "(.*)", "9")

except ExecutableNotFoundError:

pass

message = "Failed to find a Ghostscript installation"

raise ExecutableNotFoundError(message)

elif name == "inkscape":

try:

# Try headless option first (needed for Inkscape version < 1.0):

return impl(["inkscape", "--without-gui", "-V"],

"Inkscape ([^ ]*)")

except ExecutableNotFoundError:

pass # Suppress exception chaining.

# If --without-gui is not accepted, we may be using Inkscape >= 1.0 so

# try without it:

return impl(["inkscape", "-V"], "Inkscape ([^ ]*)")

elif name == "magick":

path = None

if sys.platform == "win32":

# Check the registry to avoid confusing ImageMagick's convert with

# Windows's builtin convert.exe.

import winreg

binpath = ""

for flag in [0, winreg.KEY_WOW64_32KEY, winreg.KEY_WOW64_64KEY]:

try:

with winreg.OpenKeyEx(

winreg.HKEY_LOCAL_MACHINE,

r"Software\Imagemagick\Current",

0, winreg.KEY_QUERY_VALUE | flag) as hkey:

binpath = winreg.QueryValueEx(hkey, "BinPath")[0]

except OSError:

pass

if binpath:

for name in ["convert.exe", "magick.exe"]:

candidate = Path(binpath, name)

if candidate.exists():

path = str(candidate)

break

else:

path = "convert"

if path is None:

raise ExecutableNotFoundError(

"Failed to find an ImageMagick installation")

return impl([path, "--version"], r"^Version: ImageMagick (\S*)")

elif name == "pdftops":

info = impl(["pdftops", "-v"], "^pdftops version (.*)",

ignore_exit_code=True)

if info and not ("3.0" <= info.version

# poppler version numbers.

or "0.9" <= info.version <= "1.0"):

raise ExecutableNotFoundError(

f"You have pdftops version {info.version} but the minimum "

f"version supported by Matplotlib is 3.0")

return info

else:

raise ValueError("Unknown executable: {!r}".format(name))

@cbook.deprecated("3.2")

def checkdep_ps_distiller(s):

if not s:

return False

try:

_get_executable_info("gs")

except ExecutableNotFoundError:

_log.warning(

"Setting rcParams['ps.usedistiller'] requires ghostscript.")

return False

if s == "xpdf":

try:

_get_executable_info("pdftops")

except ExecutableNotFoundError:

_log.warning(

"Setting rcParams['ps.usedistiller'] to 'xpdf' requires xpdf.")

return False

return s

def checkdep_usetex(s):

if not s:

return False

if not shutil.which("tex"):

_log.warning("usetex mode requires TeX.")

return False

try:

_get_executable_info("dvipng")

except ExecutableNotFoundError:

_log.warning("usetex mode requires dvipng.")

return False

try:

_get_executable_info("gs")

except ExecutableNotFoundError:

_log.warning("usetex mode requires ghostscript.")

return False

return True

@cbook.deprecated("3.2", alternative="os.path.expanduser('~')")

@_logged_cached('$HOME=%s')

def get_home():

"""

Return the user's home directory.

If the user's home directory cannot be found, return None.

"""

try:

return str(Path.home())

except Exception:

return None

def _get_xdg_config_dir():

"""

Return the XDG configuration directory, according to the XDG base

directory spec:

https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

"""

return os.environ.get('XDG_CONFIG_HOME') or str(Path.home() / ".config")

def _get_xdg_cache_dir():

"""

Return the XDG cache directory, according to the XDG base directory spec:

https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

"""

return os.environ.get('XDG_CACHE_HOME') or str(Path.home() / ".cache")

def _get_config_or_cache_dir(xdg_base):

configdir = os.environ.get('MPLCONFIGDIR')

if configdir:

configdir = Path(configdir).resolve()

elif sys.platform.startswith(('linux', 'freebsd')) and xdg_base:

configdir = Path(xdg_base, "matplotlib")

else:

configdir = Path.home() / ".matplotlib"

try:

configdir.mkdir(parents=True, exist_ok=True)

except OSError:

pass

else:

if os.access(str(configdir), os.W_OK) and configdir.is_dir():

return str(configdir)

# If the config or cache directory cannot be created or is not a writable

# directory, create a temporary one.

tmpdir = os.environ["MPLCONFIGDIR"] = \

tempfile.mkdtemp(prefix="matplotlib-")

atexit.register(shutil.rmtree, tmpdir)

_log.warning(

"Matplotlib created a temporary config/cache directory at %s because "

"the default path (%s) is not a writable directory; it is highly "

"recommended to set the MPLCONFIGDIR environment variable to a "

"writable directory, in particular to speed up the import of "

"Matplotlib and to better support multiprocessing.",

tmpdir, configdir)

return tmpdir

<div class="viewcode-block" id="get_configdir"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.get_configdir">[docs]</a>@_logged_cached('CONFIGDIR=%s')

def get_configdir():

"""

Return the string path of the the configuration directory.

The directory is chosen as follows:

1. If the MPLCONFIGDIR environment variable is supplied, choose that.

2. On Linux, follow the XDG specification and look first in

``$XDG_CONFIG_HOME``, if defined, or ``$HOME/.config``. On other

platforms, choose ``$HOME/.matplotlib``.

3. If the chosen directory exists and is writable, use that as the

configuration directory.

4. Else, create a temporary directory, and use it as the configuration

directory.

"""

return _get_config_or_cache_dir(_get_xdg_config_dir())</div>

<div class="viewcode-block" id="get_cachedir"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.get_cachedir">[docs]</a>@_logged_cached('CACHEDIR=%s')

def get_cachedir():

"""

Return the string path of the cache directory.

The procedure used to find the directory is the same as for

_get_config_dir, except using ``$XDG_CACHE_HOME``/``$HOME/.cache`` instead.

"""

return _get_config_or_cache_dir(_get_xdg_cache_dir())</div>

<div class="viewcode-block" id="get_data_path"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.get_data_path">[docs]</a>@_logged_cached('matplotlib data path: %s')

def get_data_path(*, _from_rc=None):

"""Return the path to Matplotlib data."""

if _from_rc is not None:

cbook.warn_deprecated(

"3.2",

message=("Setting the datapath via matplotlibrc is deprecated "

"%(since)s and will be removed %(removal)s."),

removal='3.4')

path = Path(_from_rc)

if path.is_dir():

return str(path)

else:

warnings.warn(f"You passed datapath: {_from_rc!r} in your "

f"matplotribrc file ({matplotlib_fname()}). "

"However this path does not exist, falling back "

"to standard paths.")

return _get_data_path()</div>

@_logged_cached('(private) matplotlib data path: %s')

def _get_data_path():

path = Path(__file__).with_name("mpl-data")

if path.is_dir():

return str(path)

cbook.warn_deprecated(

"3.2", message="Matplotlib installs where the data is not in the "

"mpl-data subdirectory of the package are deprecated since %(since)s "

"and support for them will be removed %(removal)s.")

def get_candidate_paths():

# setuptools' namespace_packages may hijack this init file

# so need to try something known to be in Matplotlib, not basemap.

import matplotlib.afm

yield Path(matplotlib.afm.__file__).with_name('mpl-data')

# py2exe zips pure python, so still need special check.

if getattr(sys, 'frozen', None):

yield Path(sys.executable).with_name('mpl-data')

# Try again assuming we need to step up one more directory.

yield Path(sys.executable).parent.with_name('mpl-data')

# Try again assuming sys.path[0] is a dir not a exe.

yield Path(sys.path[0]) / 'mpl-data'

for path in get_candidate_paths():

if path.is_dir():

defaultParams['datapath'][0] = str(path)

return str(path)

raise RuntimeError('Could not find the matplotlib data files')

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

"""

Get the location of the config file.

The file location is determined in the following order

- ``$PWD/matplotlibrc``

- ``$MATPLOTLIBRC`` if it is not a directory

- ``$MATPLOTLIBRC/matplotlibrc``

- ``$MPLCONFIGDIR/matplotlibrc``

- On Linux,

- ``$XDG_CONFIG_HOME/matplotlib/matplotlibrc`` (if ``$XDG_CONFIG_HOME``

is defined)

- or ``$HOME/.config/matplotlib/matplotlibrc`` (if ``$XDG_CONFIG_HOME``

is not defined)

- On other platforms,

- ``$HOME/.matplotlib/matplotlibrc`` if ``$HOME`` is defined

- Lastly, it looks in ``$MATPLOTLIBDATA/matplotlibrc``, which should always

exist.

"""

def gen_candidates():

yield os.path.join(os.getcwd(), 'matplotlibrc')

try:

matplotlibrc = os.environ['MATPLOTLIBRC']

except KeyError:

pass

else:

yield matplotlibrc

yield os.path.join(matplotlibrc, 'matplotlibrc')

yield os.path.join(get_configdir(), 'matplotlibrc')

yield os.path.join(_get_data_path(), 'matplotlibrc')

for fname in gen_candidates():

if os.path.exists(fname) and not os.path.isdir(fname):

return fname

raise RuntimeError("Could not find matplotlibrc file; your Matplotlib "

"install is broken")</div>

# rcParams deprecated and automatically mapped to another key.

# Values are tuples of (version, new_name, f_old2new, f_new2old).

_deprecated_map = {}

# rcParams deprecated; some can manually be mapped to another key.

# Values are tuples of (version, new_name_or_None).

_deprecated_ignore_map = {

}

# rcParams deprecated; can use None to suppress warnings; remain actually

# listed in the rcParams (not included in _all_deprecated).

# Values are tuples of (version,)

_deprecated_remain_as_none = {

'datapath': ('3.2.1',),

'animation.avconv_path': ('3.3',),

'animation.avconv_args': ('3.3',),

'animation.html_args': ('3.3',),

'mathtext.fallback_to_cm': ('3.3',),

'keymap.all_axes': ('3.3',),

'savefig.jpeg_quality': ('3.3',),

'text.latex.preview': ('3.3',),

}

_all_deprecated = {*_deprecated_map, *_deprecated_ignore_map}

<div class="viewcode-block" id="RcParams"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.RcParams">[docs]</a>class RcParams(MutableMapping, dict):

"""

A dictionary object including validation.

Validating functions are defined and associated with rc parameters in

:mod:`matplotlib.rcsetup`.

See Also

--------

:ref:`customizing-with-matplotlibrc-files`

"""

validate = rcsetup._validators

# validate values on the way in

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

self.update(*args, **kwargs)

def __setitem__(self, key, val):

try:

if key in _deprecated_map:

version, alt_key, alt_val, inverse_alt = _deprecated_map[key]

cbook.warn_deprecated(

version, name=key, obj_type="rcparam", alternative=alt_key)

key = alt_key

val = alt_val(val)

elif key in _deprecated_remain_as_none and val is not None:

version, = _deprecated_remain_as_none[key]

cbook.warn_deprecated(

elif key in _deprecated_ignore_map:

version, alt_key = _deprecated_ignore_map[key]

cbook.warn_deprecated(

return

elif key == 'backend':

if val is rcsetup._auto_backend_sentinel:

if 'backend' in self:

return

try:

cval = self.validate[key](val)

except ValueError as ve:

raise ValueError(f"Key {key}: {ve}") from None

dict.__setitem__(self, key, cval)

except KeyError as err:

raise KeyError(

f"{key} is not a valid rc parameter (see rcParams.keys() for "

f"a list of valid parameters)") from err

def __getitem__(self, key):

if key in _deprecated_map:

cbook.warn_deprecated(

return inverse_alt(dict.__getitem__(self, alt_key))

elif key in _deprecated_ignore_map:

cbook.warn_deprecated(

return dict.__getitem__(self, alt_key) if alt_key else None

elif key == "backend":

val = dict.__getitem__(self, key)

from matplotlib import pyplot as plt

plt.switch_backend(rcsetup._auto_backend_sentinel)

elif key == "datapath":

return get_data_path()

def __repr__(self):

class_name = self.__class__.__name__

indent = len(class_name) + 1

with cbook._suppress_matplotlib_deprecation_warning():

repr_split = pprint.pformat(dict(self), indent=1,

width=80 - indent).split('\n')

repr_indented = ('\n' + ' ' * indent).join(repr_split)

return '{}({})'.format(class_name, repr_indented)

def __str__(self):

return '\n'.join(map('{0[0]}: {0[1]}'.format, sorted(self.items())))

def __iter__(self):

"""Yield sorted list of keys."""

with cbook._suppress_matplotlib_deprecation_warning():

yield from sorted(dict.__iter__(self))

def __len__(self):

return dict.__len__(self)

<div class="viewcode-block" id="RcParams.find_all"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.RcParams.find_all">[docs]</a> def find_all(self, pattern):

"""

Return the subset of this RcParams dictionary whose keys match,

using :func:`re.search`, the given ``pattern``.

.. note::

Changes to the returned dictionary are *not* propagated to

the parent RcParams dictionary.

"""

pattern_re = re.compile(pattern)

return RcParams((key, value)

for key, value in self.items()

if pattern_re.search(key))</div>

def copy(self):

return {k: dict.__getitem__(self, k) for k in self}</div>

<div class="viewcode-block" id="rc_params"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.rc_params">[docs]</a>def rc_params(fail_on_error=False):

"""Construct a `RcParams` instance from the default Matplotlib rc file."""

return rc_params_from_file(matplotlib_fname(), fail_on_error)</div>

URL_REGEX = re.compile(r'^http://|^https://|^ftp://|^file:')

def is_url(filename):

"""Return True if string is an http, ftp, or file URL path."""

return URL_REGEX.match(filename) is not None

@functools.lru_cache()

def _get_ssl_context():

try:

import certifi

except ImportError:

_log.debug("Could not import certifi.")

return None

import ssl

return ssl.create_default_context(cafile=certifi.where())

@contextlib.contextmanager

def _open_file_or_url(fname):

if not isinstance(fname, Path) and is_url(fname):

import urllib.request

ssl_ctx = _get_ssl_context()

if ssl_ctx is None:

_log.debug(

"Could not get certifi ssl context, https may not work."

)

with urllib.request.urlopen(fname, context=ssl_ctx) as f:

yield (line.decode('utf-8') for line in f)

else:

fname = os.path.expanduser(fname)

encoding = locale.getpreferredencoding(do_setlocale=False)

if encoding is None:

encoding = "utf-8"

with open(fname, encoding=encoding) as f:

yield f

def _rc_params_in_file(fname, transform=lambda x: x, fail_on_error=False):

"""

Construct a `RcParams` instance from file *fname*.

Unlike `rc_params_from_file`, the configuration class only contains the

parameters specified in the file (i.e. default values are not filled in).

Parameters

----------

fname : path-like

The loaded file.

transform : callable, default: the identity function

A function called on each individual line of the file to transform it,

before further parsing.

fail_on_error : bool, default: False

Whether invalid entries should result in an exception or a warning.

"""

rc_temp = {}

with _open_file_or_url(fname) as fd:

try:

for line_no, line in enumerate(fd, 1):

line = transform(line)

strippedline = line.split('#', 1)[0].strip()

if not strippedline:

continue

tup = strippedline.split(':', 1)

if len(tup) != 2:

_log.warning('Missing colon in file %r, line %d (%r)',

fname, line_no, line.rstrip('\n'))

continue

key, val = tup

key = key.strip()

val = val.strip()

if key in rc_temp:

_log.warning('Duplicate key in file %r, line %d (%r)',

rc_temp[key] = (val, line, line_no)

except UnicodeDecodeError:

_log.warning('Cannot decode configuration file %s with encoding '

'%s, check LANG and LC_* variables.',

fname,

locale.getpreferredencoding(do_setlocale=False)

or 'utf-8 (default)')

raise

config = RcParams()

for key, (val, line, line_no) in rc_temp.items():

if key in rcsetup._validators:

if fail_on_error:

config[key] = val # try to convert to proper type or raise

else:

try:

except Exception as msg:

_log.warning('Bad value in file %r, line %d (%r): %s',

elif key in _deprecated_ignore_map:

cbook.warn_deprecated(

version, name=key, alternative=alt_key,

addendum="Please update your matplotlibrc.")

else:

version = 'master' if '.post' in __version__ else f'v{__version__}'

_log.warning("""

Bad key %(key)s in file %(fname)s, line %(line_no)s (%(line)r)

You probably need to get an updated matplotlibrc file from

https://github.com/matplotlib/matplotlib/blob/%(version)s/matplotlibrc.template

or from the matplotlib source distribution""",

dict(key=key, fname=fname, line_no=line_no,

line=line.rstrip('\n'), version=version))

return config

<div class="viewcode-block" id="rc_params_from_file"><a class="viewcode-back" href="../api/matplotlib_configuration_api.html#matplotlib.rc_params_from_file">[docs]</a>def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):

"""

Construct a `RcParams` from file *fname*.

Parameters

----------

fname : str or path-like

A file with Matplotlib rc settings.

fail_on_error : bool

If True, raise an error when the parser fails to convert a parameter.

use_default_template : bool

If True, initialize with default parameters before updating with those

in the given file. If False, the configuration class only contains the

parameters specified in the file. (Useful for updating dicts.)

"""

config_from_file = _rc_params_in_file(fname, fail_on_error=fail_on_error)

if not use_default_template:

return config_from_file

with cbook._suppress_matplotlib_deprecation_warning():

config = RcParams({**rcParamsDefault, **config_from_file})

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

matplotlib.html

Latest commit

History

matplotlib.html

File metadata and controls