matplotlib.github.com/3.4.3/api/_api_api.html at main · matplotlib/matplotlib.github.com

History

467 lines (428 loc) · 40.1 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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

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

<head>

<title>matplotlib._api — Matplotlib 3.4.3 documentation</title>

title="Search within Matplotlib 3.4.3 documentation"

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

</head><body>

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

<!--

</div>

-->

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

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

</div>

<ul>

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

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

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

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

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

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

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

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

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

>modules</a> |</li>

<a href="_enums_api.html" title="matplotlib._enums"

accesskey="N">next</a> |</li>

<a href="widgets_api.html" title="matplotlib.widgets"

accesskey="P">previous</a> |</li>

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

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

<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate">matplotlib._api</code></a></li>

</ul>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/api/_api_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<h1><code class="docutils literal notranslate">matplotlib._api</code><a class="headerlink" href="#module-matplotlib._api" title="Permalink to this headline">¶</a></h1>

Helper functions for managing the Matplotlib API.

This documentation is only relevant for Matplotlib developers, not for users.

<code class="descclassname">matplotlib._api.</code><code class="descname">check_getitem</code>(_mapping, **kwargs)<a class="reference internal" href="../_modules/matplotlib/_api.html#check_getitem">[source]</a><a class="headerlink" href="#matplotlib._api.check_getitem" title="Permalink to this definition">¶</a></dt>

<dd>kwargs must consist of a single key, value pair. If key is in

_mapping, return <code class="docutils literal notranslate">_mapping[value]</code>; else, raise an appropriate

ValueError.

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> _api.check_getitem({"foo": "bar"}, arg=arg)

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib._api.</code><code class="descname">check_in_list</code>(_values, *, _print_supported_values=True, **kwargs)<a class="reference internal" href="../_modules/matplotlib/_api.html#check_in_list">[source]</a><a class="headerlink" href="#matplotlib._api.check_in_list" title="Permalink to this definition">¶</a></dt>

<dd>For each key, value pair in kwargs, check that value is in _values.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>_valuesiterable</dt><dd>Sequence of values to check on.

</dd>

<dt>_print_supported_valuesbool, default: True</dt><dd>Whether to print _values when raising ValueError.

</dd>

<dt>**kwargsdict</dt><dd>key, value pairs as keyword arguments to find in _values.

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><dl class="first last docutils">

<dt>ValueError</dt><dd>If any value in kwargs is not found in _values.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> _api.check_in_list(["foo", "bar"], arg=arg, other_arg=other_arg)

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib._api.</code><code class="descname">check_isinstance</code>(_types, **kwargs)<a class="reference internal" href="../_modules/matplotlib/_api.html#check_isinstance">[source]</a><a class="headerlink" href="#matplotlib._api.check_isinstance" title="Permalink to this definition">¶</a></dt>

<dd>For each key, value pair in kwargs, check that value is an instance

of one of _types; if not, raise an appropriate TypeError.

As a special case, a <code class="docutils literal notranslate">None</code> entry in _types is treated as NoneType.

Examples

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> _api.check_isinstance((SomeClass, None), arg=arg)

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib._api.</code><code class="descname">check_shape</code>(_shape, **kwargs)<a class="reference internal" href="../_modules/matplotlib/_api.html#check_shape">[source]</a><a class="headerlink" href="#matplotlib._api.check_shape" title="Permalink to this definition">¶</a></dt>

<dd>For each key, value pair in kwargs, check that value has the shape

_shape, if not, raise an appropriate ValueError.

None in the shape is treated as a "free" size that can have any length.

e.g. (None, 2) -> (N, 2)

The values checked must be numpy arrays.

Examples

To check for (N, 2) shaped arrays

<div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> _api.check_shape((None, 2), arg=arg, other_arg=other_arg)

</pre></div>

</div>

</dd></dl>

class <code class="descclassname">matplotlib._api.</code><code class="descname">classproperty</code>(fget, fset=None, fdel=None, doc=None)<a class="reference internal" href="../_modules/matplotlib/_api.html#classproperty">[source]</a><a class="headerlink" href="#matplotlib._api.classproperty" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate">object</code></a>

Like <a class="reference external" href="https://docs.python.org/3/library/functions.html#property" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate">property</code></a>, but also triggers on access via the class, and it is the

class that's passed as argument.

Examples

<div class="highlight-default notranslate"><div class="highlight"><pre>class C:

@classproperty

def foo(cls):

return cls.__name__

assert C.foo == "C"

</pre></div>

</div>

property <code class="descname">fget</code><a class="headerlink" href="#matplotlib._api.classproperty.fget" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<code class="descclassname">matplotlib._api.</code><code class="descname">warn_external</code>(message, category=None)<a class="reference internal" href="../_modules/matplotlib/_api.html#warn_external">[source]</a><a class="headerlink" href="#matplotlib._api.warn_external" title="Permalink to this definition">¶</a></dt>

<dd><a class="reference external" href="https://docs.python.org/3/library/warnings.html#warnings.warn" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate">warnings.warn</code></a> wrapper that sets stacklevel to "outside Matplotlib".

The original emitter of the warning can be obtained by patching this

function back to <a class="reference external" href="https://docs.python.org/3/library/warnings.html#warnings.warn" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate">warnings.warn</code></a>, i.e. <code class="docutils literal notranslate">_api.warn_external =

warnings.warn</code> (or <code class="docutils literal notranslate">functools.partial(warnings.warn, stacklevel=2)</code>,

etc.).

</dd></dl>

Helper functions for deprecating parts of the Matplotlib API.

This documentation is only relevant for Matplotlib developers, not for users.

exception <code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">MatplotlibDeprecationWarning</code><a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#MatplotlibDeprecationWarning">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.MatplotlibDeprecationWarning" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#UserWarning" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate">UserWarning</code></a>

A class for issuing deprecation warnings for Matplotlib users.

In light of the fact that Python builtin DeprecationWarnings are ignored

by default as of Python 2.7 (see link below), this class was put in to

allow for the signaling of deprecation, but via UserWarnings which are not

ignored by default.

<a class="reference external" href="https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x">https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x</a>

</dd></dl>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">delete_parameter</code>(since, name, func=None, **kwargs)<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#delete_parameter">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.delete_parameter" title="Permalink to this definition">¶</a></dt>

<dd>Decorator indicating that parameter name of func is being deprecated.

The actual implementation of func should keep the name parameter in its

signature, or accept a <code class="docutils literal notranslate">**kwargs</code> argument (through which name would be

passed).

Parameters that come after the deprecated parameter effectively become

keyword-only (as they cannot be passed positionally without triggering the

DeprecationWarning on the deprecated parameter), and should be marked as

such after the deprecation period has passed and the deprecated parameter

is removed.

Parameters other than since, name, and func are keyword-only and

forwarded to <a class="reference internal" href="#matplotlib._api.deprecation.warn_deprecated" title="matplotlib._api.deprecation.warn_deprecated"><code class="xref py py-obj docutils literal notranslate">warn_deprecated</code></a>.

Examples

<div class="highlight-default notranslate"><div class="highlight"><pre>@_api.delete_parameter("3.1", "unused")

def func(used_arg, other_arg, unused, more_args): ...

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">deprecate_method_override</code>(method, obj, *, allow_empty=False, **kwargs)<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#deprecate_method_override">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.deprecate_method_override" title="Permalink to this definition">¶</a></dt>

<dd>Return <code class="docutils literal notranslate">obj.method</code> with a deprecation if it was overridden, else None.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>method</dt><dd>An unbound method, i.e. an expression of the form

<code class="docutils literal notranslate">Class.method_name</code>. Remember that within the body of a method, one

can always use <code class="docutils literal notranslate">__class__</code> to refer to the class that is currently

being defined.

</dd>

<dt>obj</dt><dd>Either an object of the class where method is defined, or a subclass

of that class.

</dd>

<dt>allow_emptybool, default: False</dt><dd>Whether to allow overrides by "empty" methods without emitting a

warning.

</dd>

<dt>**kwargs</dt><dd>Additional parameters passed to <a class="reference internal" href="#matplotlib._api.deprecation.warn_deprecated" title="matplotlib._api.deprecation.warn_deprecated"><code class="xref py py-obj docutils literal notranslate">warn_deprecated</code></a> to generate the

deprecation warning; must at least include the "since" key.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">deprecate_privatize_attribute</code>(*args, **kwargs)<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#deprecate_privatize_attribute">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.deprecate_privatize_attribute" title="Permalink to this definition">¶</a></dt>

Helper to deprecate public access to an attribute.

This helper should only be used at class scope, as follows:

<div class="highlight-default notranslate"><div class="highlight"><pre>class Foo:

attr = _deprecate_privatize_attribute(*args, **kwargs)

</pre></div>

</div>

where all parameters are forwarded to <a class="reference internal" href="#matplotlib._api.deprecation.deprecated" title="matplotlib._api.deprecation.deprecated"><code class="xref py py-obj docutils literal notranslate">deprecated</code></a>. This form makes

<code class="docutils literal notranslate">attr</code> a property which forwards access to <code class="docutils literal notranslate">self._attr</code> (same name but

with a leading underscore), with a deprecation warning. Note that the

attribute name is derived from the name this helper is assigned to.

</dd></dl>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">deprecated</code>(since, *, message='', name='', alternative='', pending=False, obj_type=None, addendum='', removal='')<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#deprecated">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.deprecated" title="Permalink to this definition">¶</a></dt>

<dd>Decorator to mark a function, a class, or a property as deprecated.

When deprecating a classmethod, a staticmethod, or a property, the

<code class="docutils literal notranslate">@deprecated</code> decorator should go under <code class="docutils literal notranslate">@classmethod</code> and

<code class="docutils literal notranslate">@staticmethod</code> (i.e., <a class="reference internal" href="#matplotlib._api.deprecation.deprecated" title="matplotlib._api.deprecation.deprecated"><code class="xref py py-obj docutils literal notranslate">deprecated</code></a> should directly decorate the

underlying callable), but over <code class="docutils literal notranslate">@property</code>.

When deprecating a class <code class="docutils literal notranslate">C</code> intended to be used as a base class in a

multiple inheritance hierarchy, <code class="docutils literal notranslate">C</code> must define an <code class="docutils literal notranslate">__init__</code> method

(if <code class="docutils literal notranslate">C</code> instead inherited its <code class="docutils literal notranslate">__init__</code> from its own base class, then

<code class="docutils literal notranslate">@deprecated</code> would mess up <code class="docutils literal notranslate">__init__</code> inheritance when installing its

own (deprecation-emitting) <code class="docutils literal notranslate">C.__init__</code>).

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>sincestr</dt><dd>The release at which this API became deprecated.

</dd>

<dt>messagestr, optional</dt><dd>Override the default deprecation message. The <code class="docutils literal notranslate">%(since)s</code>,

<code class="docutils literal notranslate">%(name)s</code>, <code class="docutils literal notranslate">%(alternative)s</code>, <code class="docutils literal notranslate">%(obj_type)s</code>, <code class="docutils literal notranslate">%(addendum)s</code>,

and <code class="docutils literal notranslate">%(removal)s</code> format specifiers will be replaced by the values

of the respective arguments passed to this function.

</dd>

<dt>namestr, optional</dt><dd>The name used in the deprecation message; if not provided, the name

is automatically determined from the deprecated object.

</dd>

<dt>alternativestr, optional</dt><dd>An alternative API that the user may use in place of the deprecated

API. The deprecation warning will tell the user about this alternative

if provided.

</dd>

<dt>pendingbool, optional</dt><dd>If True, uses a PendingDeprecationWarning instead of a

DeprecationWarning. Cannot be used together with removal.

</dd>

<dt>obj_typestr, optional</dt><dd>The object type being deprecated; by default, 'class' if decorating

a class, 'attribute' if decorating a property, 'function' otherwise.

</dd>

<dt>addendumstr, optional</dt><dd>Additional text appended directly to the final message.

</dd>

<dt>removalstr, optional</dt><dd>The expected removal version. With the default (an empty string), a

removal version is automatically computed from since. Set to other

Falsy values to not schedule a removal date. Cannot be used together

with pending.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

Basic example:

<div class="highlight-default notranslate"><div class="highlight"><pre>@deprecated('1.4.0')

def the_function_to_deprecate():

pass

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">make_keyword_only</code>(since, name, func=None)<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#make_keyword_only">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.make_keyword_only" title="Permalink to this definition">¶</a></dt>

<dd>Decorator indicating that passing parameter name (or any of the following

ones) positionally to func is being deprecated.

</dd></dl>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">mplDeprecation</code><a class="headerlink" href="#matplotlib._api.deprecation.mplDeprecation" title="Permalink to this definition">¶</a></dt>

<dd>alias of <a class="reference internal" href="#matplotlib._api.deprecation.MatplotlibDeprecationWarning" title="matplotlib._api.deprecation.MatplotlibDeprecationWarning"><code class="xref py py-class docutils literal notranslate">matplotlib._api.deprecation.MatplotlibDeprecationWarning</code></a>

</dd></dl>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">rename_parameter</code>(since, old, new, func=None)<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#rename_parameter">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.rename_parameter" title="Permalink to this definition">¶</a></dt>

<dd>Decorator indicating that parameter old of func is renamed to new.

The actual implementation of func should use new, not old. If old

is passed to func, a DeprecationWarning is emitted, and its value is

used, even if new is also passed by keyword (this is to simplify pyplot

wrapper functions, which always pass new explicitly to the Axes method).

If new is also passed but positionally, a TypeError will be raised by the

underlying function during argument binding.

Examples

<div class="highlight-default notranslate"><div class="highlight"><pre>@_api.rename_parameter("3.1", "bad_name", "good_name")

def func(good_name): ...

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">suppress_matplotlib_deprecation_warning</code>()<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#suppress_matplotlib_deprecation_warning">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.suppress_matplotlib_deprecation_warning" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib._api.deprecation.</code><code class="descname">warn_deprecated</code>(since, *, message='', name='', alternative='', pending=False, obj_type='', addendum='', removal='')<a class="reference internal" href="../_modules/matplotlib/_api/deprecation.html#warn_deprecated">[source]</a><a class="headerlink" href="#matplotlib._api.deprecation.warn_deprecated" title="Permalink to this definition">¶</a></dt>

<dd>Display a standardized deprecation.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>sincestr</dt><dd>The release at which this API became deprecated.

</dd>

and <code class="docutils literal notranslate">%(removal)s</code> format specifiers will be replaced by the values

of the respective arguments passed to this function.

</dd>

<dt>namestr, optional</dt><dd>The name of the deprecated object.

</dd>

<dt>alternativestr, optional</dt><dd>An alternative API that the user may use in place of the deprecated

API. The deprecation warning will tell the user about this alternative

if provided.

</dd>

<dt>pendingbool, optional</dt><dd>If True, uses a PendingDeprecationWarning instead of a

DeprecationWarning. Cannot be used together with removal.

</dd>

<dt>obj_typestr, optional</dt><dd>The object type being deprecated.

</dd>

<dt>addendumstr, optional</dt><dd>Additional text appended directly to the final message.

</dd>

<dt>removalstr, optional</dt><dd>The expected removal version. With the default (an empty string), a

removal version is automatically computed from since. Set to other

Falsy values to not schedule a removal date. Cannot be used together

with pending.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Examples

Basic example:

<div class="highlight-default notranslate"><div class="highlight"><pre># To warn of the deprecation of "matplotlib.name_of_module"

warn_deprecated('1.4.0', name='matplotlib.name_of_module',

obj_type='module')

</pre></div>

</div>

</dd></dl>

</div>

</div>

Last updated on Aug 13, 2021.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.

Doc version v3.4.3-2-ge48e4acce0.

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

_api_api.html

Latest commit

History

_api_api.html

File metadata and controls