matplotlib.github.com/3.4.1/_modules/matplotlib/_api.html at main · matplotlib/matplotlib.github.com

History

338 lines (278 loc) · 30.5 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

<!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.1 documentation</title>

title="Search within Matplotlib 3.4.1 documentation"

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

</head><body>

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

<!--

</div>

-->

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

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

</div>

<ul>

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

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

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

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

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

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

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

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

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

>modules</a> |</li>

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

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

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

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

</ul>

</div>

</div>

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

"""

Helper functions for managing the Matplotlib API.

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

.. warning:

This module and its submodules are for internal use only. Do not use them

in your own code. We may change the API at any time with no warning.

"""

import itertools

import re

import sys

import warnings

from .deprecation import (

deprecated, warn_deprecated,

rename_parameter, delete_parameter, make_keyword_only,

deprecate_method_override, deprecate_privatize_attribute,

suppress_matplotlib_deprecation_warning,

MatplotlibDeprecationWarning)

<div class="viewcode-block" id="classproperty"><a class="viewcode-back" href="../../api/_api_api.html#matplotlib._api.classproperty">[docs]</a>class classproperty:

"""

Like `property`, but also triggers on access via the class, and it is the

*class* that's passed as argument.

Examples

--------

::

class C:

@classproperty

def foo(cls):

return cls.__name__

assert C.foo == "C"

"""

def __init__(self, fget, fset=None, fdel=None, doc=None):

self._fget = fget

if fset is not None or fdel is not None:

raise ValueError('classproperty only implements fget.')

self.fset = fset

self.fdel = fdel

# docs are ignored for now

self._doc = doc

def __get__(self, instance, owner):

return self._fget(owner)

@property

def fget(self):

return self._fget</div>

# In the following check_foo() functions, the first parameter starts with an

# underscore because it is intended to be positional-only (e.g., so that

# `_api.check_isinstance([...], types=foo)` doesn't fail.

<div class="viewcode-block" id="check_isinstance"><a class="viewcode-back" href="../../api/_api_api.html#matplotlib._api.check_isinstance">[docs]</a>def check_isinstance(_types, **kwargs):

"""

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 ``None`` entry in *_types* is treated as NoneType.

Examples

--------

>>> _api.check_isinstance((SomeClass, None), arg=arg)

"""

types = _types

none_type = type(None)

types = ((types,) if isinstance(types, type) else

(none_type,) if types is None else

tuple(none_type if tp is None else tp for tp in types))

def type_name(tp):

return ("None" if tp is none_type

else tp.__qualname__ if tp.__module__ == "builtins"

else f"{tp.__module__}.{tp.__qualname__}")

for k, v in kwargs.items():

if not isinstance(v, types):

names = [*map(type_name, types)]

if "None" in names: # Move it to the end for better wording.

names.remove("None")

names.append("None")

raise TypeError(

"{!r} must be an instance of {}, not a {}".format(

k,

", ".join(names[:-1]) + " or " + names[-1]

if len(names) > 1 else names[0],

type_name(type(v))))</div>

<div class="viewcode-block" id="check_in_list"><a class="viewcode-back" href="../../api/_api_api.html#matplotlib._api.check_in_list">[docs]</a>def check_in_list(_values, *, _print_supported_values=True, **kwargs):

"""

For each *key, value* pair in *kwargs*, check that *value* is in *_values*.

Parameters

----------

_values : iterable

Sequence of values to check on.

_print_supported_values : bool, default: True

Whether to print *_values* when raising ValueError.

**kwargs : dict

*key, value* pairs as keyword arguments to find in *_values*.

Raises

------

ValueError

If any *value* in *kwargs* is not found in *_values*.

Examples

--------

>>> _api.check_in_list(["foo", "bar"], arg=arg, other_arg=other_arg)

"""

values = _values

for key, val in kwargs.items():

if val not in values:

if _print_supported_values:

raise ValueError(

f"{val!r} is not a valid value for {key}; "

f"supported values are {', '.join(map(repr, values))}")

else:

raise ValueError(f"{val!r} is not a valid value for {key}")</div>

<div class="viewcode-block" id="check_shape"><a class="viewcode-back" href="../../api/_api_api.html#matplotlib._api.check_shape">[docs]</a>def check_shape(_shape, **kwargs):

"""

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

>>> _api.check_shape((None, 2), arg=arg, other_arg=other_arg)

"""

target_shape = _shape

data_shape = v.shape

if len(target_shape) != len(data_shape) or any(

t not in [s, None]

for t, s in zip(target_shape, data_shape)

):

dim_labels = iter(itertools.chain(

'MNLIJKLH',

(f"D{i}" for i in itertools.count())))

text_shape = ", ".join((str(n)

if n is not None

else next(dim_labels)

for n in target_shape))

raise ValueError(

f"{k!r} must be {len(target_shape)}D "

f"with shape ({text_shape}). "

f"Your input has shape {v.shape}."

)</div>

<div class="viewcode-block" id="check_getitem"><a class="viewcode-back" href="../../api/_api_api.html#matplotlib._api.check_getitem">[docs]</a>def check_getitem(_mapping, **kwargs):

"""

*kwargs* must consist of a single *key, value* pair. If *key* is in

*_mapping*, return ``_mapping[value]``; else, raise an appropriate

ValueError.

Examples

--------

>>> _api.check_getitem({"foo": "bar"}, arg=arg)

"""

mapping = _mapping

if len(kwargs) != 1:

raise ValueError("check_getitem takes a single keyword argument")

(k, v), = kwargs.items()

try:

return mapping[v]

except KeyError:

raise ValueError(

"{!r} is not a valid value for {}; supported values are {}"

.format(v, k, ', '.join(map(repr, mapping)))) from None</div>

<div class="viewcode-block" id="warn_external"><a class="viewcode-back" href="../../api/_api_api.html#matplotlib._api.warn_external">[docs]</a>def warn_external(message, category=None):

"""

`warnings.warn` wrapper that sets *stacklevel* to "outside Matplotlib".

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

function back to `warnings.warn`, i.e. ``_api.warn_external =

warnings.warn`` (or ``functools.partial(warnings.warn, stacklevel=2)``,

etc.).

"""

frame = sys._getframe()

for stacklevel in itertools.count(1): # lgtm[py/unused-loop-variable]

if frame is None:

# when called in embedded context may hit frame is None

break

if not re.match(r"\A(matplotlib|mpl_toolkits)(\Z|\.(?!tests\.))",

# Work around sphinx-gallery not setting __name__.

frame.f_globals.get("__name__", "")):

break

frame = frame.f_back

warnings.warn(message, category, stacklevel)</div>

</pre></div>

</div>

</div>

Last updated on Mar 31, 2021.

Created using

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

Doc version v3.4.1-3-gc6d08c6a8b-dirty.

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

_api.html

Latest commit

History

_api.html

File metadata and controls