matplotlib.github.com/2.2.4/_modules/matplotlib/cbook.html at main · matplotlib/matplotlib.github.com

History

2991 lines (2425 loc) · 354 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 2.2.4 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.2.4',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.4 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.4). 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 2.2.4</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="../../api/pyplot_summary.html">pyplot</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.

"""

from __future__ import absolute_import, division, print_function

import six

from six.moves import xrange, zip

import collections

import contextlib

import datetime

import errno

import functools

import glob

import gzip

import io

from itertools import repeat

import locale

import numbers

import operator

import os

import re

import sys

import time

import traceback

import types

import warnings

from weakref import ref, WeakKeyDictionary

import numpy as np

import matplotlib

from .deprecation import deprecated, warn_deprecated

from .deprecation import mplDeprecation, MatplotlibDeprecationWarning

<div class="viewcode-block" id="unicode_safe"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.unicode_safe">[docs]</a>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 six.text_type(s)

else:

return six.text_type(s, preferredencoding)

return s</div>

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

class converter(object):

"""

Base class for handling string -> python type with support for

missing values

"""

def __init__(self, missing='Null', missingval=None):

self.missing = missing

self.missingval = missingval

def __call__(self, s):

if s == self.missing:

return self.missingval

return s

<div class="viewcode-block" id="converter.is_missing"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.converter.is_missing">[docs]</a> def is_missing(self, s):

return not s.strip() or s == self.missing</div></div>

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

class tostr(converter):

"""convert to string or None"""

converter.__init__(self, missing=missing, missingval=missingval)</div>

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

class todatetime(converter):

"""convert to a datetime or None"""

def __init__(self, fmt='%Y-%m-%d', missing='Null', missingval=None):

'use a :func:`time.strptime` format string for conversion'

converter.__init__(self, missing, missingval)

self.fmt = fmt

def __call__(self, s):

if self.is_missing(s):

return self.missingval

tup = time.strptime(s, self.fmt)

return datetime.datetime(*tup[:6])</div>

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

class todate(converter):

"""convert to a date or None"""

"""use a :func:`time.strptime` format string for conversion"""

converter.__init__(self, missing, missingval)

self.fmt = fmt

def __call__(self, s):

if self.is_missing(s):

return self.missingval

return datetime.date(*tup[:3])</div>

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

class tofloat(converter):

"""convert to a float or None"""

self.missingval = missingval

def __call__(self, s):

if self.is_missing(s):

return self.missingval

return float(s)</div>

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

class toint(converter):

"""convert to an int or None"""

def __call__(self, s):

if self.is_missing(s):

return self.missingval

return int(s)</div>

class _BoundMethodProxy(object):

"""

Our own proxy object which enables weak references to bound and unbound

methods and arbitrary callables. Pulls information about the function,

class, and instance out of a bound method. Stores a weak reference to the

instance to support garbage collection.

@organization: IBM Corporation

@license: The BSD License

Minor bugfixes by Michael Droettboom

"""

def __init__(self, cb):

self._hash = hash(cb)

self._destroy_callbacks = []

try:

if six.PY3:

self.inst = ref(cb.__self__, self._destroy)

else:

self.inst = ref(cb.im_self, self._destroy)

except TypeError:

self.inst = None

if six.PY3:

self.func = cb.__func__

self.klass = cb.__self__.__class__

else:

self.func = cb.im_func

self.klass = cb.im_class

except AttributeError:

self.inst = None

self.func = cb

self.klass = None

def add_destroy_callback(self, callback):

self._destroy_callbacks.append(_BoundMethodProxy(callback))

def _destroy(self, wk):

for callback in self._destroy_callbacks:

try:

callback(self)

except ReferenceError:

pass

def __getstate__(self):

d = self.__dict__.copy()

# de-weak reference inst

inst = d['inst']

if inst is not None:

d['inst'] = inst()

return d

def __setstate__(self, statedict):

self.__dict__ = statedict

inst = statedict['inst']

# turn inst back into a weakref

if inst is not None:

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

"""

Proxy for a call to the weak referenced object. Take

arbitrary params to pass to the callable.

Raises `ReferenceError`: When the weak reference refers to

a dead object

"""

if self.inst is not None and self.inst() is None:

raise ReferenceError

elif self.inst is not None:

# build a new instance method with a strong reference to the

# instance

mtd = types.MethodType(self.func, self.inst())

else:

# not a bound method, just return the func

mtd = self.func

# invoke the callable and return the result

return mtd(*args, **kwargs)

def __eq__(self, other):

"""

Compare the held function and instance with that held by

another proxy.

"""

try:

if self.inst is None:

return self.func == other.func and other.inst is None

else:

return self.func == other.func and self.inst() == other.inst()

except Exception:

return False

def __ne__(self, other):

"""

Inverse of __eq__.

"""

return not self.__eq__(other)

def __hash__(self):

return self._hash

def _exception_printer(exc):

traceback.print_exc()

<div class="viewcode-block" id="CallbackRegistry"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.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. The Python stdlib weakref module can not create weak

references to bound methods directly, so we need to create a proxy

object to handle weak references to bound methods (or regular free

functions). This technique was shared by Peter Parente on his

`"Mindtrove" blog

<http://mindtrove.info/python-weak-references/>`_.

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

"""

def __init__(self, exception_handler=_exception_printer):

self.exception_handler = exception_handler

self.callbacks = dict()

self._cid = 0

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.backends.backend_pdf.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, WeakKeyDictionary())

# Note proxy not needed in python 3.

# TODO rewrite this when support for python2.x gets dropped.

proxy = _BoundMethodProxy(func)

if proxy in self._func_cid_map[s]:

return self._func_cid_map[s][proxy]

proxy.add_destroy_callback(self._remove_proxy)

self._cid += 1

cid = self._cid

self._func_cid_map[s][proxy] = cid

self.callbacks.setdefault(s, dict())

self.callbacks[s][cid] = proxy

return cid</div>

def _remove_proxy(self, proxy):

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

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.backends.backend_pdf.CallbackRegistry.disconnect">[docs]</a> def disconnect(self, cid):

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

"""

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

try:

del callbackd[cid]

except KeyError:

continue

else:

for signal, functions in list(

six.iteritems(self._func_cid_map)):

for function, value in list(six.iteritems(functions)):

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.backends.backend_pdf.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``.

"""

if s in self.callbacks:

for cid, proxy in list(six.iteritems(self.callbacks[s])):

try:

proxy(*args, **kwargs)

except ReferenceError:

self._remove_proxy(proxy)

# 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.backends.backend_pdf.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)

def __str__(self):

return repr(self)

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.backends.backend_pdf.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.backends.backend_pdf.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:

warnings.warn('"%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.backends.backend_pdf.strip_math">[docs]</a>def strip_math(s):

"""remove latex formatting from mathtext"""

remove = (r'\mathdefault', r'\rm', r'\cal', r'\tt', r'\it', '\\', '{', '}')

s = s[1:-1]

for r in remove:

s = s.replace(r, '')

return s</div>

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

"""

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

By: Alex Martelli

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

"""

def __init__(self, **kwds):

self.__dict__.update(kwds)

def __repr__(self):

return 'Bunch(%s)' % ', '.join(

'%s=%s' % kv for kv in six.iteritems(vars(self)))</div>

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

def unique(x):

"""Return a list of unique elements of *x*"""

return list(set(x))</div>

<div class="viewcode-block" id="iterable"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.iterable">[docs]</a>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_string_like"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.is_string_like">[docs]</a>@deprecated('2.1')

def is_string_like(obj):

"""Return True if *obj* looks like a string"""

# (np.str_ == np.unicode_ on Py3).

return isinstance(obj, (six.string_types, np.str_, np.unicode_))</div>

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

def is_sequence_of_strings(obj):

"""Returns true if *obj* is iterable and contains strings"""

if not iterable(obj):

return False

if is_string_like(obj) and not isinstance(obj, np.ndarray):

try:

obj = obj.values

except AttributeError:

# not pandas

return False

for o in obj:

if not is_string_like(o):

return False

return True</div>

<div class="viewcode-block" id="is_hashable"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.is_hashable">[docs]</a>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.backends.backend_pdf.is_writable_file_like">[docs]</a>def is_writable_file_like(obj):

"""return true if *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.backends.backend_pdf.file_requires_unicode">[docs]</a>def file_requires_unicode(x):

"""

Returns `True` if 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_scalar"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.is_scalar">[docs]</a>@deprecated('2.1')

def is_scalar(obj):

"""return true if *obj* is not string like and is not iterable"""

return not isinstance(obj, six.string_types) and not iterable(obj)</div>

<div class="viewcode-block" id="is_numlike"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.is_numlike">[docs]</a>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.backends.backend_pdf.to_filehandle">[docs]</a>def to_filehandle(fname, flag='rU', return_opened=False, encoding=None):

"""

*fname* can be an `os.PathLike` or a file handle. Support for gzipped

files is automatic, if the filename ends in .gz. *flag* is a

read/write flag for :func:`file`

"""

if hasattr(os, "PathLike") and isinstance(fname, os.PathLike):

return to_filehandle(

os.fspath(fname),

flag=flag, return_opened=return_opened, encoding=encoding)

if isinstance(fname, six.string_types):

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 = io.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.backends.backend_pdf.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.backends.backend_pdf.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, six.string_types) or not iterable(val)</div>

def _string_to_bool(s):

"""Parses the string argument as a boolean"""

if not isinstance(s, six.string_types):

return bool(s)

warn_deprecated("2.2", "Passing one of 'on', 'true', 'off', 'false' as a "

"boolean is deprecated; use an actual boolean "

"(True/False) instead.")

if s.lower() in ['on', 'true']:

return True

if s.lower() in ['off', 'false']:

return False

raise ValueError('String "%s" must be one of: '

'"on", "off", "true", or "false"' % s)

<div class="viewcode-block" id="get_sample_data"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.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.

"""

if 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.backends.backend_pdf.flatten">[docs]</a>def flatten(seq, scalarp=is_scalar_or_string):

"""

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

for subitem in flatten(item, scalarp):

yield subitem</div>

<div class="viewcode-block" id="Sorter"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.Sorter">[docs]</a>@deprecated('2.1', "sorted(..., key=itemgetter(...))")

class Sorter(object):

"""

Sort by attribute or item

Example usage::

sort = Sorter()

list = [(1, 2), (4, 8), (0, 3)]

dict = [{'a': 3, 'b': 4}, {'a': 5, 'b': 2}, {'a': 0, 'b': 0},

{'a': 9, 'b': 9}]

sort(list) # default sort

sort(list, 1) # sort by index 1

sort(dict, 'a') # sort a list of dicts by key 'a'

"""

def _helper(self, data, aux, inplace):

aux.sort()

result = [data[i] for junk, i in aux]

if inplace:

data[:] = result

return result

<div class="viewcode-block" id="Sorter.byItem"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.Sorter.byItem">[docs]</a> def byItem(self, data, itemindex=None, inplace=1):

if itemindex is None:

if inplace:

data.sort()

result = data

else:

result = sorted(data)

return result

else:

aux = [(data[i][itemindex], i) for i in range(len(data))]

return self._helper(data, aux, inplace)</div>

<div class="viewcode-block" id="Sorter.byAttribute"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.Sorter.byAttribute">[docs]</a> def byAttribute(self, data, attributename, inplace=1):

aux = [(getattr(data[i], attributename), i) for i in range(len(data))]

# a couple of handy synonyms

sort = byItem

__call__ = byItem</div>

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

class Xlator(dict):

"""

All-in-one multiple-string-substitution class

Example usage::

text = "Larry Wall is the creator of Perl"

adict = {

"Larry Wall" : "Guido van Rossum",

"creator" : "Benevolent Dictator for Life",

"Perl" : "Python",

}

print(multiple_replace(adict, text))

xlat = Xlator(adict)

print(xlat.xlat(text))

"""

def _make_regex(self):

""" Build re object based on the keys of the current dictionary """

return re.compile("|".join(map(re.escape, self)))

def __call__(self, match):

""" Handler invoked for each regex *match* """

return self[match.group(0)]

<div class="viewcode-block" id="Xlator.xlat"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.Xlator.xlat">[docs]</a> def xlat(self, text):

""" Translate *text*, returns the modified text. """

return self._make_regex().sub(self, text)</div></div>

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

def soundex(name, len=4):

""" soundex module conforming to Odell-Russell algorithm """

# digits holds the soundex values for the alphabet

soundex_digits = '01230120022455012623010202'

sndx = ''

fc = ''

# Translate letters in name to soundex digits

for c in name.upper():

if c.isalpha():

if not fc:

fc = c # Remember first letter

d = soundex_digits[ord(c) - ord('A')]

# Duplicate consecutive soundex digits are skipped

if not sndx or (d != sndx[-1]):

sndx += d

# Replace first digit with first letter

sndx = fc + sndx[1:]

# Remove all 0s from the soundex code

sndx = sndx.replace('0', '')

# Return soundex code truncated or 0-padded to len characters

return (sndx + (len * '0'))[:len]</div>

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

class Null(object):

""" Null objects always and reliably "do nothing." """

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

pass

return self

def __str__(self):

return "Null()"

def __repr__(self):

return "Null()"

if six.PY3:

def __bool__(self):

return 0

else:

def __nonzero__(self):

return 0

def __getattr__(self, name):

return self

def __setattr__(self, name, value):

return self

def __delattr__(self, name):

return self</div>

<div class="viewcode-block" id="mkdirs"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.mkdirs">[docs]</a>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

if six.PY3:

os.makedirs(newdir, mode=mode, exist_ok=True)

else:

try:

except OSError as exception:

if exception.errno != errno.EEXIST:

raise</div>

<div class="viewcode-block" id="GetRealpathAndStat"><a class="viewcode-back" href="../../api/cbook_api.html#matplotlib.backends.backend_pdf.GetRealpathAndStat">[docs]</a>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':

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

cbook.html

Latest commit

History

cbook.html

File metadata and controls