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

History

2308 lines (1884 loc) · 263 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.cbook — 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.cbook</h1><div class="highlight"><pre>

"""

A collection of utility functions and classes. Originally, many

(but not all) were from the Python Cookbook -- hence the name cbook.

This module is safe to import from anywhere within matplotlib;

it imports matplotlib only at runtime.

"""

import collections

import collections.abc

import contextlib

import functools

import glob

import gzip

import itertools

import locale

import numbers

import operator

import os

from pathlib import Path

import re

import subprocess

import sys

import time

import traceback

import types

import warnings

import weakref

from weakref import WeakMethod

import numpy as np

import matplotlib

from .deprecation import (

deprecated, warn_deprecated,

_rename_parameter, _delete_parameter, _make_keyword_only,

_suppress_matplotlib_deprecation_warning,

MatplotlibDeprecationWarning, mplDeprecation)

<div class="viewcode-block" id="unicode_safe"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.unicode_safe">[docs]</a>@deprecated("3.0")

def unicode_safe(s):

if isinstance(s, bytes):

try:

# On some systems, locale.getpreferredencoding returns None,

# which can break unicode; and the sage project reports that

# some systems have incorrect locale specifications, e.g.,

# an encoding instead of a valid locale name. Another

# pathological case that has been reported is an empty string.

# On some systems, getpreferredencoding sets the locale, which has

# side effects. Passing False eliminates those side effects.

preferredencoding = locale.getpreferredencoding(

matplotlib.rcParams['axes.formatter.use_locale']).strip()

if not preferredencoding:

preferredencoding = None

except (ValueError, ImportError, AttributeError):

preferredencoding = None

if preferredencoding is None:

return str(s)

else:

return str(s, preferredencoding)

return s</div>

def _exception_printer(exc):

traceback.print_exc()

class _StrongRef:

"""

Wrapper similar to a weakref, but keeping a strong reference to the object.

"""

def __init__(self, obj):

self._obj = obj

def __call__(self):

return self._obj

def __eq__(self, other):

return isinstance(other, _StrongRef) and self._obj == other._obj

def __hash__(self):

return hash(self._obj)

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

"""Handle registering and disconnecting for a set of signals and callbacks:

>>> def oneat(x):

... print('eat', x)

>>> def ondrink(x):

... print('drink', x)

>>> from matplotlib.cbook import CallbackRegistry

>>> callbacks = CallbackRegistry()

>>> id_eat = callbacks.connect('eat', oneat)

>>> id_drink = callbacks.connect('drink', ondrink)

>>> callbacks.process('drink', 123)

drink 123

>>> callbacks.process('eat', 456)

eat 456

>>> callbacks.process('be merry', 456) # nothing will be called

>>> callbacks.disconnect(id_eat)

>>> callbacks.process('eat', 456) # nothing will be called

In practice, one should always disconnect all callbacks when they are

no longer needed to avoid dangling references (and thus memory leaks).

However, real code in Matplotlib rarely does so, and due to its design,

it is rather difficult to place this kind of code. To get around this,

and prevent this class of memory leaks, we instead store weak references

to bound methods only, so when the destination object needs to die, the

CallbackRegistry won't keep it alive.

Parameters

----------

exception_handler : callable, optional

If provided must have signature ::

def handler(exc: Exception) -> None:

If not None this function will be called with any `Exception`

subclass raised by the callbacks in `CallbackRegistry.process`.

The handler may either consume the exception or re-raise.

The callable must be pickle-able.

The default handler is ::

def h(exc):

traceback.print_exc()

"""

# We maintain two mappings:

# callbacks: signal -> {cid -> callback}

# _func_cid_map: signal -> {callback -> cid}

# (actually, callbacks are weakrefs to the actual callbacks).

def __init__(self, exception_handler=_exception_printer):

self.exception_handler = exception_handler

self.callbacks = {}

self._cid_gen = itertools.count()

self._func_cid_map = {}

# In general, callbacks may not be pickled; thus, we simply recreate an

# empty dictionary at unpickling. In order to ensure that `__setstate__`

# (which just defers to `__init__`) is called, `__getstate__` must

# return a truthy value (for pickle protocol>=3, i.e. Py3, the

# *actual* behavior is that `__setstate__` will be called as long as

# `__getstate__` does not return `None`, but this is undocumented -- see

# http://bugs.python.org/issue12290).

def __getstate__(self):

return {'exception_handler': self.exception_handler}

def __setstate__(self, state):

self.__init__(**state)

<div class="viewcode-block" id="CallbackRegistry.connect"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.CallbackRegistry.connect">[docs]</a> def connect(self, s, func):

"""Register *func* to be called when signal *s* is generated.

"""

self._func_cid_map.setdefault(s, {})

try:

proxy = WeakMethod(func, self._remove_proxy)

except TypeError:

proxy = _StrongRef(func)

if proxy in self._func_cid_map[s]:

return self._func_cid_map[s][proxy]

cid = next(self._cid_gen)

self._func_cid_map[s][proxy] = cid

self.callbacks.setdefault(s, {})

self.callbacks[s][cid] = proxy

return cid</div>

def _remove_proxy(self, proxy):

for signal, proxies in list(self._func_cid_map.items()):

try:

del self.callbacks[signal][proxies[proxy]]

except KeyError:

pass

if len(self.callbacks[signal]) == 0:

del self.callbacks[signal]

del self._func_cid_map[signal]

<div class="viewcode-block" id="CallbackRegistry.disconnect"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.CallbackRegistry.disconnect">[docs]</a> def disconnect(self, cid):

"""Disconnect the callback registered with callback id *cid*.

"""

for eventname, callbackd in list(self.callbacks.items()):

try:

del callbackd[cid]

except KeyError:

continue

else:

for signal, functions in list(self._func_cid_map.items()):

for function, value in list(functions.items()):

if value == cid:

del functions[function]

return</div>

<div class="viewcode-block" id="CallbackRegistry.process"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.CallbackRegistry.process">[docs]</a> def process(self, s, *args, **kwargs):

"""

Process signal *s*.

All of the functions registered to receive callbacks on *s* will be

called with ``*args`` and ``**kwargs``.

"""

for cid, ref in list(self.callbacks.get(s, {}).items()):

func = ref()

if func is not None:

try:

func(*args, **kwargs)

# this does not capture KeyboardInterrupt, SystemExit,

# and GeneratorExit

except Exception as exc:

if self.exception_handler is not None:

self.exception_handler(exc)

else:

raise</div></div>

<div class="viewcode-block" id="silent_list"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.silent_list">[docs]</a>class silent_list(list):

"""

override repr when returning a list of matplotlib artists to

prevent long, meaningless output. This is meant to be used for a

homogeneous list of a given type

"""

def __init__(self, type, seq=None):

self.type = type

if seq is not None:

self.extend(seq)

def __repr__(self):

return '<a list of %d %s objects>' % (len(self), self.type)

__str__ = __repr__

def __getstate__(self):

# store a dictionary of this SilentList's state

return {'type': self.type, 'seq': self[:]}

def __setstate__(self, state):

self.type = state['type']

self.extend(state['seq'])</div>

<div class="viewcode-block" id="IgnoredKeywordWarning"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.IgnoredKeywordWarning">[docs]</a>class IgnoredKeywordWarning(UserWarning):

"""

A class for issuing warnings about keyword arguments that will be ignored

by matplotlib

"""

pass</div>

<div class="viewcode-block" id="local_over_kwdict"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.local_over_kwdict">[docs]</a>def local_over_kwdict(local_var, kwargs, *keys):

"""

Enforces the priority of a local variable over potentially conflicting

argument(s) from a kwargs dict. The following possible output values are

considered in order of priority:

local_var > kwargs[keys[0]] > ... > kwargs[keys[-1]]

The first of these whose value is not None will be returned. If all are

None then None will be returned. Each key in keys will be removed from the

kwargs dict in place.

Parameters

----------

local_var : any object

The local variable (highest priority)

kwargs : dict

Dictionary of keyword arguments; modified in place

keys : str(s)

Name(s) of keyword arguments to process, in descending order of

priority

Returns

-------

out : any object

Either local_var or one of kwargs[key] for key in keys

Raises

------

IgnoredKeywordWarning

For each key in keys that is removed from kwargs but not used as

the output value

"""

out = local_var

for key in keys:

kwarg_val = kwargs.pop(key, None)

if kwarg_val is not None:

if out is None:

out = kwarg_val

else:

_warn_external('"%s" keyword argument will be ignored' % key,

IgnoredKeywordWarning)

return out</div>

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

"""

Remove latex formatting from mathtext.

Only handles fully math and fully non-math strings.

"""

if len(s) >= 2 and s[0] == s[-1] == "$":

s = s[1:-1]

for tex, plain in [

(r"\times", "x"), # Specifically for Formatter support.

(r"\mathdefault", ""),

(r"\rm", ""),

(r"\cal", ""),

(r"\tt", ""),

(r"\it", ""),

("\\", ""),

("{", ""),

("}", ""),

]:

s = s.replace(tex, plain)

return s</div>

<div class="viewcode-block" id="Bunch"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Bunch">[docs]</a>@deprecated('3.0', alternative='types.SimpleNamespace')

class Bunch(types.SimpleNamespace):

"""

Often we want to just collect a bunch of stuff together, naming each

item of the bunch; a dictionary's OK for that, but a small do- nothing

class is even handier, and prettier to use. Whenever you want to

group a few variables::

>>> point = Bunch(datum=2, squared=4, coord=12)

>>> point.datum

"""

pass</div>

<div class="viewcode-block" id="iterable"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.iterable">[docs]</a>@deprecated('3.1', alternative='np.iterable')

def iterable(obj):

"""return true if *obj* is iterable"""

try:

iter(obj)

except TypeError:

return False

return True</div>

<div class="viewcode-block" id="is_hashable"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.is_hashable">[docs]</a>@deprecated("3.1", alternative="isinstance(..., collections.abc.Hashable)")

def is_hashable(obj):

"""Returns true if *obj* can be hashed"""

try:

hash(obj)

except TypeError:

return False

return True</div>

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

"""Return whether *obj* looks like a file object with a *write* method."""

return callable(getattr(obj, 'write', None))</div>

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

"""

Return whether the given writable file-like object requires Unicode to be

written to it.

"""

try:

x.write(b'')

except TypeError:

return True

else:

return False</div>

<div class="viewcode-block" id="is_numlike"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.is_numlike">[docs]</a>@deprecated('3.0', alternative='isinstance(..., numbers.Number)')

def is_numlike(obj):

"""return true if *obj* looks like a number"""

return isinstance(obj, (numbers.Number, np.number))</div>

<div class="viewcode-block" id="to_filehandle"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.to_filehandle">[docs]</a>def to_filehandle(fname, flag='r', return_opened=False, encoding=None):

"""

Convert a path to an open file handle or pass-through a file-like object.

Consider using `open_file_cm` instead, as it allows one to properly close

newly created file objects more easily.

Parameters

----------

fname : str or PathLike or file-like object

If `str` or `os.PathLike`, the file is opened using the flags specified

by *flag* and *encoding*. If a file-like object, it is passed through.

flag : str, default 'r'

Passed as the *mode* argument to `open` when *fname* is `str` or

`os.PathLike`; ignored if *fname* is file-like.

return_opened : bool, default False

If True, return both the file object and a boolean indicating whether

this was a new file (that the caller needs to close). If False, return

only the new file.

encoding : str or None, default None

Passed as the *mode* argument to `open` when *fname* is `str` or

`os.PathLike`; ignored if *fname* is file-like.

Returns

-------

fh : file-like

opened : bool

*opened* is only returned if *return_opened* is True.

"""

if isinstance(fname, os.PathLike):

fname = os.fspath(fname)

if isinstance(fname, str):

if fname.endswith('.gz'):

# get rid of 'U' in flag for gzipped files.

flag = flag.replace('U', '')

fh = gzip.open(fname, flag)

elif fname.endswith('.bz2'):

# python may not be complied with bz2 support,

# bury import until we need it

import bz2

# get rid of 'U' in flag for bz2 files

fh = bz2.BZ2File(fname, flag)

else:

fh = open(fname, flag, encoding=encoding)

opened = True

elif hasattr(fname, 'seek'):

fh = fname

opened = False

else:

raise ValueError('fname must be a PathLike or file handle')

if return_opened:

return fh, opened

return fh</div>

<div class="viewcode-block" id="open_file_cm"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.open_file_cm">[docs]</a>@contextlib.contextmanager

def open_file_cm(path_or_file, mode="r", encoding=None):

r"""Pass through file objects and context-manage `.PathLike`\s."""

fh, opened = to_filehandle(path_or_file, mode, True, encoding)

if opened:

with fh:

yield fh

else:

yield fh</div>

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

"""Return whether the given object is a scalar or string like."""

return isinstance(val, str) or not np.iterable(val)</div>

<div class="viewcode-block" id="get_sample_data"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.get_sample_data">[docs]</a>def get_sample_data(fname, asfileobj=True):

"""

Return a sample data file. *fname* is a path relative to the

`mpl-data/sample_data` directory. If *asfileobj* is `True`

return a file object, otherwise just a file path.

Set the rc parameter examples.directory to the directory where we should

look, if sample_data files are stored in a location different than

default (which is 'mpl-data/sample_data` at the same level of 'matplotlib`

Python module files).

If the filename ends in .gz, the file is implicitly ungzipped.

"""

# Don't trigger deprecation warning when just fetching.

if dict.__getitem__(matplotlib.rcParams, 'examples.directory'):

root = matplotlib.rcParams['examples.directory']

else:

root = os.path.join(matplotlib._get_data_path(), 'sample_data')

path = os.path.join(root, fname)

if asfileobj:

if os.path.splitext(fname)[-1].lower() in ['.csv', '.xrc', '.txt']:

mode = 'r'

else:

mode = 'rb'

base, ext = os.path.splitext(fname)

if ext == '.gz':

return gzip.open(path, mode)

else:

return open(path, mode)

else:

return path</div>

<div class="viewcode-block" id="flatten"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.flatten">[docs]</a>def flatten(seq, scalarp=is_scalar_or_string):

"""

Return a generator of flattened nested containers

For example:

>>> from matplotlib.cbook import flatten

>>> l = (('John', ['Hunter']), (1, 23), [[([42, (5, 23)], )]])

>>> print(list(flatten(l)))

['John', 'Hunter', 1, 23, 42, 5, 23]

By: Composite of Holger Krekel and Luther Blissett

From: https://code.activestate.com/recipes/121294/

and Recipe 1.12 in cookbook

"""

for item in seq:

if scalarp(item) or item is None:

yield item

else:

yield from flatten(item, scalarp)</div>

<div class="viewcode-block" id="mkdirs"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.mkdirs">[docs]</a>@deprecated("3.0")

def mkdirs(newdir, mode=0o777):

"""

make directory *newdir* recursively, and set *mode*. Equivalent to ::

> mkdir -p NEWDIR

> chmod MODE NEWDIR

"""

# this functionality is now in core python as of 3.2

# LPY DROP

os.makedirs(newdir, mode=mode, exist_ok=True)</div>

<div class="viewcode-block" id="GetRealpathAndStat"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.GetRealpathAndStat">[docs]</a>@deprecated('3.0')

class GetRealpathAndStat(object):

def __init__(self):

self._cache = {}

def __call__(self, path):

result = self._cache.get(path)

if result is None:

realpath = os.path.realpath(path)

if sys.platform == 'win32':

stat_key = realpath

else:

stat = os.stat(realpath)

stat_key = (stat.st_ino, stat.st_dev)

result = realpath, stat_key

self._cache[path] = result

return result</div>

<div class="viewcode-block" id="get_realpath_and_stat"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.get_realpath_and_stat">[docs]</a>@functools.lru_cache()

def get_realpath_and_stat(path):

return realpath, stat_key</div>

# A regular expression used to determine the amount of space to

# remove. It looks for the first sequence of spaces immediately

# following the first newline, or at the beginning of the string.

_find_dedent_regex = re.compile(r"(?:(?:\n\r?)|^)( *)\S")

# A cache to hold the regexs that actually remove the indent.

_dedent_regex = {}

<div class="viewcode-block" id="dedent"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.dedent">[docs]</a>@deprecated("3.1", alternative="inspect.cleandoc")

def dedent(s):

"""

Remove excess indentation from docstring *s*.

Discards any leading blank lines, then removes up to n whitespace

characters from each line, where n is the number of leading

whitespace characters in the first line. It differs from

textwrap.dedent in its deletion of leading blank lines and its use

of the first non-blank line to determine the indentation.

It is also faster in most cases.

"""

# This implementation has a somewhat obtuse use of regular

# expressions. However, this function accounted for almost 30% of

# matplotlib startup time, so it is worthy of optimization at all

# costs.

if not s: # includes case of s is None

return ''

match = _find_dedent_regex.match(s)

if match is None:

return s

# This is the number of spaces to remove from the left-hand side.

nshift = match.end(1) - match.start(1)

if nshift == 0:

return s

# Get a regex that will remove *up to* nshift spaces from the

# beginning of each line. If it isn't in the cache, generate it.

unindent = _dedent_regex.get(nshift, None)

if unindent is None:

unindent = re.compile("\n\r? {0,%d}" % nshift)

_dedent_regex[nshift] = unindent

result = unindent.sub("\n", s).strip()

return result</div>

<div class="viewcode-block" id="listFiles"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.listFiles">[docs]</a>@deprecated("3.0")

def listFiles(root, patterns='*', recurse=1, return_folders=0):

"""

Recursively list files

from Parmar and Martelli in the Python Cookbook

"""

import os.path

import fnmatch

# Expand patterns from semicolon-separated string to list

pattern_list = patterns.split(';')

results = []

for dirname, dirs, files in os.walk(root):

# Append to results all relevant files (and perhaps folders)

for name in files:

fullname = os.path.normpath(os.path.join(dirname, name))

if return_folders or os.path.isfile(fullname):

for pattern in pattern_list:

if fnmatch.fnmatch(name, pattern):

results.append(fullname)

break

# Block recursion if recursion was disallowed

if not recurse:

break

return results</div>

<div class="viewcode-block" id="maxdict"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.maxdict">[docs]</a>class maxdict(dict):

"""

A dictionary with a maximum size; this doesn't override all the

relevant methods to constrain the size, just setitem, so use with

caution

"""

def __init__(self, maxsize):

dict.__init__(self)

self.maxsize = maxsize

self._killkeys = []

def __setitem__(self, k, v):

if k not in self:

if len(self) >= self.maxsize:

del self[self._killkeys[0]]

del self._killkeys[0]

self._killkeys.append(k)

dict.__setitem__(self, k, v)</div>

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

"""

Stack of elements with a movable cursor.

Mimics home/back/forward in a web browser.

"""

def __init__(self, default=None):

self.clear()

self._default = default

def __call__(self):

"""Return the current element, or None."""

if not len(self._elements):

return self._default

else:

return self._elements[self._pos]

def __len__(self):

return len(self._elements)

def __getitem__(self, ind):

return self._elements[ind]

<div class="viewcode-block" id="Stack.forward"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Stack.forward">[docs]</a> def forward(self):

"""Move the position forward and return the current element."""

self._pos = min(self._pos + 1, len(self._elements) - 1)

return self()</div>

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

"""Move the position back and return the current element."""

if self._pos > 0:

self._pos -= 1

return self()</div>

<div class="viewcode-block" id="Stack.push"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Stack.push">[docs]</a> def push(self, o):

"""

Push *o* to the stack at current position. Discard all later elements.

*o* is returned.

"""

self._elements = self._elements[:self._pos + 1] + [o]

self._pos = len(self._elements) - 1

return self()</div>

<div class="viewcode-block" id="Stack.home"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Stack.home">[docs]</a> def home(self):

"""

Push the first element onto the top of the stack.

The first element is returned.

"""

return

self.push(self._elements[0])

return self()</div>

<div class="viewcode-block" id="Stack.empty"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Stack.empty">[docs]</a> def empty(self):

"""Return whether the stack is empty."""

return len(self._elements) == 0</div>

<div class="viewcode-block" id="Stack.clear"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Stack.clear">[docs]</a> def clear(self):

"""Empty the stack."""

self._pos = -1

self._elements = []</div>

<div class="viewcode-block" id="Stack.bubble"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Stack.bubble">[docs]</a> def bubble(self, o):

"""

Raise *o* to the top of the stack. *o* must be present in the stack.

*o* is returned.

"""

if o not in self._elements:

raise ValueError('Unknown element o')

old = self._elements[:]

self.clear()

bubbles = []

for thiso in old:

if thiso == o:

bubbles.append(thiso)

else:

self.push(thiso)

for _ in bubbles:

self.push(o)

return o</div>

<div class="viewcode-block" id="Stack.remove"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.Stack.remove">[docs]</a> def remove(self, o):

"""Remove *o* from the stack."""

raise ValueError('Unknown element o')

old = self._elements[:]

self.clear()

for thiso in old:

if thiso != o:

self.push(thiso)</div></div>

<div class="viewcode-block" id="report_memory"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.report_memory">[docs]</a>def report_memory(i=0): # argument may go away

"""Return the memory consumed by the process."""

def call(command, os_name):

try:

return subprocess.check_output(command)

except subprocess.CalledProcessError:

raise NotImplementedError(

"report_memory works on %s only if "

"the '%s' program is found" % (os_name, command[0])

)

pid = os.getpid()

if sys.platform == 'sunos5':

lines = call(['ps', '-p', '%d' % pid, '-o', 'osz'], 'Sun OS')

mem = int(lines[-1].strip())

elif sys.platform == 'linux':

lines = call(['ps', '-p', '%d' % pid, '-o', 'rss,sz'], 'Linux')

mem = int(lines[1].split()[1])

elif sys.platform == 'darwin':

lines = call(['ps', '-p', '%d' % pid, '-o', 'rss,vsz'], 'Mac OS')

mem = int(lines[1].split()[0])

elif sys.platform == 'win32':

lines = call(["tasklist", "/nh", "/fi", "pid eq %d" % pid], 'Windows')

mem = int(lines.strip().split()[-2].replace(',', ''))

else:

raise NotImplementedError(

"We don't have a memory monitor for %s" % sys.platform)

return mem</div>

_safezip_msg = 'In safezip, len(args[0])=%d but len(args[%d])=%d'

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

def safezip(*args):

"""make sure *args* are equal len before zipping"""

Nx = len(args[0])

for i, arg in enumerate(args[1:]):

if len(arg) != Nx:

raise ValueError(_safezip_msg % (Nx, i + 1, len(arg)))

return list(zip(*args))</div>

<div class="viewcode-block" id="safe_masked_invalid"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.safe_masked_invalid">[docs]</a>def safe_masked_invalid(x, copy=False):

x = np.array(x, subok=True, copy=copy)

if not x.dtype.isnative:

# Note that the argument to `byteswap` is 'inplace',

# thus if we have already made a copy, do the byteswap in

# place, else make a copy with the byte order swapped.

# Be explicit that we are swapping the byte order of the dtype

x = x.byteswap(copy).newbyteorder('S')

try:

xm = np.ma.masked_invalid(x, copy=False)

xm.shrink_mask()

except TypeError:

return x

return xm</div>

<div class="viewcode-block" id="print_cycles"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.cbook.print_cycles">[docs]</a>def print_cycles(objects, outstream=sys.stdout, show_progress=False):

"""

*objects*

A list of objects to find cycles in. It is often useful to

pass in gc.garbage to find the cycles that are preventing some

objects from being garbage collected.

*outstream*

The stream for output.

*show_progress*

If True, print the number of objects reached as they are found.

"""

import gc

def print_path(path):

for i, step in enumerate(path):

# next "wraps around"

next = path[(i + 1) % len(path)]

outstream.write(" %s -- " % type(step))

if isinstance(step, dict):

for key, val in step.items():

if val is next:

outstream.write("[{!r}]".format(key))

break

if key is next:

outstream.write("[key] = {!r}".format(val))

break

elif isinstance(step, list):

outstream.write("[%d]" % step.index(next))

elif isinstance(step, tuple):

outstream.write("( tuple )")

else:

outstream.write(repr(step))

outstream.write(" ->\n")

outstream.write("\n")

def recurse(obj, start, all, current_path):

if show_progress:

outstream.write("%d\r" % len(all))

all[id(obj)] = None

referents = gc.get_referents(obj)

for referent in referents:

# If we've found our way back to the start, this is

# a cycle, so print it out

if referent is start:

print_path(current_path)

# Don't go back through the original list of objects, or

# through temporary references to the object, since those

# are just an artifact of the cycle detector itself.

elif referent is objects or isinstance(referent, types.FrameType):

continue

# We haven't seen this object before, so recurse

elif id(referent) not in all:

recurse(referent, start, all, current_path + [obj])

for obj in objects:

outstream.write(f"Examining: {obj!r}\n")

recurse(obj, obj, {}, [])</div>

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

"""

This class provides a lightweight way to group arbitrary objects

together into disjoint sets when a full-blown graph data structure

would be overkill.

Objects can be joined using :meth:`join`, tested for connectedness

View remainder of file in raw view

FilesExpand file tree

cbook.html

Latest commit

History

cbook.html

File metadata and controls