matplotlib.github.com/3.0.3/_modules/matplotlib.html at main · matplotlib/matplotlib.github.com

History

1951 lines (1599 loc) · 215 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.0.3 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.0.3 documentation"

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

</head>

<body>

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

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.0.3</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="index.html" accesskey="U">Module code</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>

</ul></li>

</ul>

</div>

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

"""

This is 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 commands :func:`~matplotlib.pyplot.figure`,

:func:`~matplotlib.pyplot.subplot`,

:func:`~matplotlib.pyplot.subplots`, and

:func:`~pyplot.savefig`, which can greatly simplify scripting.

Modules include:

:mod:`matplotlib.axes`

defines the :class:`~matplotlib.axes.Axes` class. Most pyplot

commands are wrappers for :class:`~matplotlib.axes.Axes`

methods. The axes module is the highest level of OO access to

the library.

:mod:`matplotlib.figure`

defines the :class:`~matplotlib.figure.Figure` class.

:mod:`matplotlib.artist`

defines the :class:`~matplotlib.artist.Artist` base class for

all classes that draw things.

:mod:`matplotlib.lines`

defines the :class:`~matplotlib.lines.Line2D` class for

drawing lines and markers

:mod:`matplotlib.patches`

defines classes for drawing polygons

:mod:`matplotlib.text`

defines the :class:`~matplotlib.text.Text`,

:class:`~matplotlib.text.TextWithDash`, and

:class:`~matplotlib.text.Annotate` classes

:mod:`matplotlib.image`

defines the :class:`~matplotlib.image.AxesImage` and

:class:`~matplotlib.image.FigureImage` classes

:mod:`matplotlib.collections`

classes for efficient drawing of groups of lines or polygons

:mod:`matplotlib.colors`

classes for interpreting color specifications and for making

colormaps

:mod:`matplotlib.cm`

colormaps and the :class:`~matplotlib.image.ScalarMappable`

mixin class for providing color mapping functionality to other

classes

:mod:`matplotlib.ticker`

classes for calculating tick mark locations and for formatting

tick labels

:mod:`matplotlib.backends`

a subpackage with modules for various gui libraries and output

formats

The base matplotlib namespace includes:

:data:`~matplotlib.rcParams`

a global dictionary of default configuration settings. It is

initialized by code which may be overridden by a matplotlibrc

file.

:func:`~matplotlib.rc`

a function for setting groups of rcParams values

:func:`~matplotlib.use`

a function for setting the matplotlib backend. If used, this

function must be called immediately after importing matplotlib

for the first time. In particular, it must be called

**before** importing pyplot (if pyplot is imported).

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.

"""

# NOTE: This file must remain Python 2 compatible for the foreseeable future,

# to ensure that we error out properly for existing editable installs.

import sys

if sys.version_info < (3, 5): # noqa: E402

raise ImportError("""

Matplotlib 3.0+ does not support Python 2.x, 3.0, 3.1, 3.2, 3.3, or 3.4.

Beginning with Matplotlib 3.0, Python 3.5 and above is required.

See Matplotlib `INSTALL.rst` file for more information:

https://github.com/matplotlib/matplotlib/blob/master/INSTALL.rst

""")

import atexit

from collections.abc import MutableMapping

import contextlib

import distutils.version

import functools

import io

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 stat

import subprocess

import tempfile

import urllib.request

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, dedent, get_label, sanitize_sequence)

from matplotlib.cbook import mplDeprecation # deprecated

from matplotlib.rcsetup import defaultParams, 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__)

__version__numpy__ = '1.10.0' # minimum required numpy version

__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

}"""

def compare_versions(a, b):

"return True if a is greater than or equal to b"

if isinstance(a, bytes):

cbook.warn_deprecated(

"3.0", "compare_version arguments should be strs.")

a = a.decode('ascii')

if isinstance(b, bytes):

cbook.warn_deprecated(

"3.0", "compare_version arguments should be strs.")

b = b.decode('ascii')

if a:

a = distutils.version.LooseVersion(a)

b = distutils.version.LooseVersion(b)

return a >= b

else:

return False

try:

import dateutil

except ImportError:

raise ImportError("Matplotlib requires dateutil")

try:

import pyparsing

except ImportError:

raise ImportError("Matplotlib requires pyparsing")

else:

if not compare_versions(pyparsing.__version__, '2.0.1'):

raise ImportError(

"Matplotlib requires pyparsing>=2.0.1; you have %s"

% pyparsing.__version__)

if not compare_versions(numpy.__version__, __version__numpy__):

raise ImportError(

"Matplotlib requires numpy>=%s; you have %s" % (

__version__numpy__, numpy.__version__))

if not hasattr(sys, 'argv'): # for modpython

sys.argv = ['modpython']

_verbose_msg = """\

matplotlib.verbose is deprecated;

Command line argument --verbose-LEVEL is deprecated.

This functionality is now provided by the standard

python logging library. To get more (or less) logging output:

import logging

logger = logging.getLogger('matplotlib')

logger.set_level(logging.INFO)"""

def _set_logger_verbose_level(level_str='silent', file_str='sys.stdout'):

"""

Use a --verbose-LEVEL level to set the logging level:

"""

levelmap = {'silent': logging.WARNING, 'helpful': logging.INFO,

'debug': logging.DEBUG, 'debug-annoying': logging.DEBUG,

'info': logging.INFO, 'warning': logging.WARNING}

# Check that current state of logger isn't already more verbose

# than the requested level. If it is more verbose, then leave more

# verbose.

newlev = levelmap[level_str]

oldlev = _log.getEffectiveLevel()

if newlev < oldlev:

_log.setLevel(newlev)

std = {

'sys.stdout': sys.stdout,

'sys.stderr': sys.stderr,

}

if file_str in std:

fileo = std[file_str]

else:

fileo = sys.stdout

try:

fileo = open(file_str, 'w')

# if this fails, we will just write to stdout

except IOError:

warnings.warn('could not open log file "{0}"'

'for writing. Check your '

'matplotlibrc'.format(file_str))

console = logging.StreamHandler(fileo)

console.setLevel(newlev)

_log.addHandler(console)

def _parse_commandline():

"""

Check for --verbose-LEVEL type command line arguments and

set logging level appropriately.

"""

levels = ('silent', 'helpful', 'debug', 'debug-annoying',

'info', 'warning')

for arg in sys.argv[1:]:

if arg.startswith('--verbose-'):

level_str = arg[10:]

# If it doesn't match one of ours, then don't even

# bother noting it, we are just a 3rd-party library

# to somebody else's script.

if level_str in levels:

_set_logger_verbose_level(level_str)

_parse_commandline()

class Verbose(object):

"""

A class to handle reporting. Set the fileo attribute to any file

instance to handle the output. Default is sys.stdout

"""

vald = {level: i for i, level in enumerate(levels)}

# parse the verbosity from the command line; flags look like

# --verbose-silent or --verbose-helpful

_commandLineVerbose = None

if not arg.startswith('--verbose-'):

continue

level_str = arg[10:]

# If it doesn't match one of ours, then don't even

# bother noting it, we are just a 3rd-party library

# to somebody else's script.

if level_str in levels:

_commandLineVerbose = level_str

@cbook.deprecated("2.2", message=_verbose_msg)

def __init__(self):

self.set_level('silent')

self.fileo = sys.stdout

def set_level(self, level):

'set the verbosity to one of the Verbose.levels strings'

if self._commandLineVerbose is not None:

level = self._commandLineVerbose

if level not in self.levels:

warnings.warn('matplotlib: unrecognized --verbose-* string "%s".'

' Legal values are %s' % (level, self.levels))

else:

self.level = level

def set_fileo(self, fname):

std = {

'sys.stdout': sys.stdout,

'sys.stderr': sys.stderr,

}

if fname in std:

self.fileo = std[fname]

else:

try:

fileo = open(fname, 'w')

except IOError:

raise ValueError('Verbose object could not open log file "{0}"'

' for writing.\nCheck your matplotlibrc '

'verbose.fileo setting'.format(fname))

else:

self.fileo = fileo

def report(self, s, level='helpful'):

"""

print message s to self.fileo if self.level>=level. Return

value indicates whether a message was issued

"""

if self.ge(level):

print(s, file=self.fileo)

return True

return False

def wrap(self, fmt, func, level='helpful', always=True):

"""

return a callable function that wraps func and reports it

output through the verbose handler if current verbosity level

is higher than level

if always is True, the report will occur on every function

call; otherwise only on the first time the function is called

"""

assert callable(func)

def wrapper(*args, **kwargs):

ret = func(*args, **kwargs)

if (always or not wrapper._spoke):

spoke = self.report(fmt % ret, level)

if not wrapper._spoke:

wrapper._spoke = spoke

return ret

wrapper._spoke = False

wrapper.__doc__ = func.__doc__

return wrapper

def ge(self, level):

'return true if self.level is >= level'

return self.vald[self.level] >= self.vald[level]

with warnings.catch_warnings():

warnings.simplefilter("ignore")

verbose = Verbose()

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():

nonlocal called, ret

if not called:

ret = func()

called = True

_log.debug(fmt, ret)

return ret

return wrapper

def checkdep_dvipng():

try:

stdout=subprocess.PIPE,

stderr=subprocess.PIPE)

stdout, stderr = s.communicate()

line = stdout.decode('ascii').split('\n')[1]

v = line.split()[-1]

return v

except (IndexError, ValueError, OSError):

return None

def checkdep_ghostscript():

if checkdep_ghostscript.executable is None:

if sys.platform == 'win32':

# mgs is the name in miktex

gs_execs = ['gswin32c', 'gswin64c', 'mgs', 'gs']

else:

gs_execs = ['gs']

for gs_exec in gs_execs:

try:

s = subprocess.Popen(

[gs_exec, '--version'], stdout=subprocess.PIPE,

stderr=subprocess.PIPE)

if s.returncode == 0:

v = stdout[:-1].decode('ascii')

checkdep_ghostscript.executable = gs_exec

checkdep_ghostscript.version = v

pass

return checkdep_ghostscript.executable, checkdep_ghostscript.version

checkdep_ghostscript.executable = None

checkdep_ghostscript.version = None

def checkdep_pdftops():

try:

s = subprocess.Popen(['pdftops', '-v'], stdout=subprocess.PIPE,

stderr=subprocess.PIPE)

lines = stderr.decode('ascii').split('\n')

for line in lines:

if 'version' in line:

return v

return None

def checkdep_inkscape():

if checkdep_inkscape.version is None:

try:

stdout=subprocess.PIPE,

stderr=subprocess.PIPE)

lines = stdout.decode('ascii').split('\n')

for line in lines:

if 'Inkscape' in line:

break

checkdep_inkscape.version = v

pass

return checkdep_inkscape.version

checkdep_inkscape.version = None

def checkdep_ps_distiller(s):

if not s:

return False

flag = True

gs_req = '8.60'

gs_exec, gs_v = checkdep_ghostscript()

if not compare_versions(gs_v, gs_req):

flag = False

warnings.warn(('matplotlibrc ps.usedistiller option can not be used '

'unless ghostscript-%s or later is installed on your '

'system') % gs_req)

if s == 'xpdf':

pdftops_req = '3.0'

pdftops_req_alt = '0.9' # poppler version numbers, ugh

pdftops_v = checkdep_pdftops()

if compare_versions(pdftops_v, pdftops_req):

pass

elif (compare_versions(pdftops_v, pdftops_req_alt) and not

compare_versions(pdftops_v, '1.0')):

pass

else:

flag = False

warnings.warn(('matplotlibrc ps.usedistiller can not be set to '

'xpdf unless xpdf-%s or later is installed on '

'your system') % pdftops_req)

if flag:

return s

else:

return False

def checkdep_usetex(s):

if not s:

return False

gs_req = '9.00'

dvipng_req = '1.6'

flag = True

if shutil.which("tex") is None:

flag = False

warnings.warn('matplotlibrc text.usetex option can not be used unless '

'TeX is installed on your system')

dvipng_v = checkdep_dvipng()

if not compare_versions(dvipng_v, dvipng_req):

flag = False

warnings.warn('matplotlibrc text.usetex can not be used with *Agg '

'backend unless dvipng-%s or later is installed on '

'your system' % dvipng_req)

gs_exec, gs_v = checkdep_ghostscript()

flag = False

warnings.warn('matplotlibrc text.usetex can not be used unless '

'ghostscript-%s or later is installed on your system'

% gs_req)

return flag

@_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 _create_tmp_config_dir():

"""

If the config directory can not be created, create a temporary directory.

"""

configdir = os.environ['MPLCONFIGDIR'] = (

tempfile.mkdtemp(prefix='matplotlib-'))

atexit.register(shutil.rmtree, configdir)

return configdir

def _get_xdg_config_dir():

"""

Returns the XDG configuration directory, according to the `XDG

base directory spec

<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.

"""

return (os.environ.get('XDG_CONFIG_HOME')

or (str(Path(get_home(), ".config"))

if get_home()

else None))

def _get_xdg_cache_dir():

"""

Returns the XDG cache directory, according to the `XDG

base directory spec

<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.

"""

if get_home()

else None))

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")

elif get_home():

configdir = Path(get_home(), ".matplotlib")

else:

configdir = None

if configdir:

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)

return _create_tmp_config_dir()

@_logged_cached('CONFIGDIR=%s')

def get_configdir():

"""

Return the string representing the configuration directory.

The directory is chosen as follows:

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

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

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

2b. On other platforms, choose `$HOME/.matplotlib`.

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

configuration directory.

4. If possible, create a temporary directory, and use it as the

configuration directory.

5. A writable directory could not be found or created; return None.

"""

return _get_config_or_cache_dir(_get_xdg_config_dir())

@_logged_cached('CACHEDIR=%s')

def get_cachedir():

"""

Return the location of the cache directory.

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

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

"""

return _get_config_or_cache_dir(_get_xdg_cache_dir())

def _get_data_path():

'get the path to matplotlib data'

if 'MATPLOTLIBDATA' in os.environ:

path = os.environ['MATPLOTLIBDATA']

if not os.path.isdir(path):

raise RuntimeError('Path in environment MATPLOTLIBDATA not a '

'directory')

return path

def get_candidate_paths():

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

# setuptools' namespace_packages may highjack 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():

return str(path)

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

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

def get_data_path():

if defaultParams['datapath'][0] is None:

defaultParams['datapath'][0] = _get_data_path()

return defaultParams['datapath'][0]

def get_py2exe_datafiles():

data_path = Path(get_data_path())

d = {}

for path in filter(Path.is_file, data_path.glob("**/*")):

(d.setdefault(str(path.parent.relative_to(data_path.parent)), [])

.append(str(path)))

return list(d.items())

<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 a file (or a named pipe, which can be created

e.g. by process substitution)

- `$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` for a

system-defined copy.

"""

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):

st_mode = os.stat(fname).st_mode

if stat.S_ISREG(st_mode) or stat.S_ISFIFO(st_mode):

break

# Return first candidate that is a file, or last candidate if none is

# valid (in that case, a warning is raised at startup by `rc_params`).

return fname</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 = {

'text.dvipnghack': ('2.1', None),

'nbagg.transparent': ('2.2', 'figure.facecolor'),

'plugins.directory': ('2.2', None),

'pgf.debug': ('3.0', None),

}

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

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

# Values are typles of (version,)

_deprecated_remain_as_none = {

'axes.hold': ('2.1',),

'backend.qt4': ('2.2',),

'backend.qt5': ('2.2',),

'text.latex.unicode': ('3.0',),

}

_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`

"""

validate = {key: converter

for key, (default, converter) in defaultParams.items()

if key not in _all_deprecated}

@property

@cbook.deprecated("3.0")

def msg_depr(self):

return "%s is deprecated and replaced with %s; please use the latter."

@property

@cbook.deprecated("3.0")

def msg_depr_ignore(self):

return "%s is deprecated and ignored. Use %s instead."

@property

@cbook.deprecated("3.0")

def msg_depr_set(self):

return ("%s is deprecated. Please remove it from your matplotlibrc "

"and/or style files.")

@property

@cbook.deprecated("3.0")

def msg_obsolete(self):

return ("%s is obsolete. Please remove it from your matplotlibrc "

"and/or style files.")

@property

@cbook.deprecated("3.0")

def msg_backend_obsolete(self):

return ("The {} rcParam was deprecated in version 2.2. In order to "

"force the use of a specific Qt binding, either import that "

"binding first, or set the QT_API environment variable.")

# 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, 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]

addendum = ''

if key.startswith('backend'):

addendum = (

"In order to force the use of a specific Qt binding, "

"either import that binding first, or set the QT_API "

"environment variable.")

cbook.warn_deprecated(

"2.2", name=key, obj_type="rcparam", addendum=addendum)

elif key in _deprecated_ignore_map:

version, alt_key = _deprecated_ignore_map[key]

cbook.warn_deprecated(

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

return

elif key == 'examples.directory':

cbook.warn_deprecated(

"3.0", "{} is deprecated; in the future, examples will be "

"found relative to the 'datapath' directory.".format(key))

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("Key %s: %s" % (key, str(ve)))

dict.__setitem__(self, key, cval)

except KeyError:

raise KeyError(

'%s is not a valid rc parameter. See rcParams.keys() for a '

'list of valid parameters.' % (key,))

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 == 'examples.directory':

cbook.warn_deprecated(

"3.0", "{} is deprecated; in the future, examples will be "

"found relative to the 'datapath' directory.".format(key))

elif key == "backend":

val = dict.__getitem__(self, key)

from matplotlib import pyplot as plt

plt.switch_backend(rcsetup._auto_backend_sentinel)

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