matplotlib.rcsetup

The rcsetup module contains the validation code for customization using Matplotlib's rc settings.

Each rc setting is assigned a function used to validate any attempted changes to that setting. The validation functions are defined in the rcsetup module, and are used to construct the rcParams global object which stores the settings and is referenced throughout Matplotlib.

The default values of the rc settings are set in the default matplotlibrc file. Any additions or deletions to the parameter set listed here should also be propagated to the matplotlibrc.template in Matplotlib's root source directory.

class matplotlib.rcsetup.ValidateInStrings(key, valid, ignorecase=False, *, _deprecated_since=None)

Bases: object

valid is a list of legal strings.

matplotlib.rcsetup.cycler(*args, **kwargs)

Create a Cycler object much like cycler.cycler(), but includes input validation.

Call signatures:

cycler(cycler)
cycler(label=values[, label2=values2[, ...]])
cycler(label, values)

Form 1 copies a given Cycler object.

Form 2 creates a Cycler which cycles over one or more properties simultaneously. If multiple properties are given, their value lists must have the same length.

Form 3 creates a Cycler for a single property. This form exists for compatibility with the original cycler. Its use is discouraged in favor of the kwarg form, i.e. cycler(label=values).

Parameters:

cyclerCycler

Copy constructor for Cycler.

labelstr

The property key. Must be a valid Artist property. For example, 'color' or 'linestyle'. Aliases are allowed, such as 'c' for 'color' and 'lw' for 'linewidth'.

valuesiterable

Finite-length iterable of the property values. These values are validated and will raise a ValueError if invalid.

Returns:

Cycler

A new Cycler for the given properties.

Examples

Creating a cycler for a single property:

>>> c = cycler(color=['red', 'green', 'blue'])

Creating a cycler for simultaneously cycling over multiple properties (e.g. red circle, green plus, blue cross):

>>> c = cycler(color=['red', 'green', 'blue'],
...            marker=['o', '+', 'x'])

matplotlib.rcsetup.update_savefig_format(value)

[Deprecated]

Notes

Deprecated since version 3.2:

matplotlib.rcsetup.validate_animation_writer_path(p)

[Deprecated]

Notes

Deprecated since version 3.2:

matplotlib.rcsetup.validate_any(s)

matplotlib.rcsetup.validate_anylist(s)

matplotlib.rcsetup.validate_aspect(s)

matplotlib.rcsetup.validate_axisbelow(s)

matplotlib.rcsetup.validate_backend(s)

matplotlib.rcsetup.validate_bbox(s)

matplotlib.rcsetup.validate_bool(b)

Convert b to bool or raise.

matplotlib.rcsetup.validate_bool_maybe_none(b)

[Deprecated] Convert b to bool or raise, passing through None.

Notes

Deprecated since version 3.3.

matplotlib.rcsetup.validate_capstyle(s)

matplotlib.rcsetup.validate_capstylelist(s)

matplotlib.rcsetup.validate_color(s)

Return a valid color arg.

matplotlib.rcsetup.validate_color_for_prop_cycle(s)

matplotlib.rcsetup.validate_color_or_auto(s)

matplotlib.rcsetup.validate_color_or_inherit(s)

Return a valid color arg.

matplotlib.rcsetup.validate_colorlist(s)

return a list of colorspecs

matplotlib.rcsetup.validate_cycler(s)

Return a Cycler object from a string repr or the object itself.

matplotlib.rcsetup.validate_dashlist(s)

return a list of floats

matplotlib.rcsetup.validate_dpi(s)

Confirm s is string 'figure' or convert s to float or raise.

matplotlib.rcsetup.validate_fillstylelist(s)

matplotlib.rcsetup.validate_float(s)

matplotlib.rcsetup.validate_float_or_None(s)

matplotlib.rcsetup.validate_floatlist(s)

return a list of floats

matplotlib.rcsetup.validate_font_properties(s)

matplotlib.rcsetup.validate_fontsize(s)

matplotlib.rcsetup.validate_fontsize_None(s)

matplotlib.rcsetup.validate_fontsizelist(s)

matplotlib.rcsetup.validate_fonttype(s)

Confirm that this is a Postscript or PDF font type that we know how to convert to.

matplotlib.rcsetup.validate_fontweight(s)

matplotlib.rcsetup.validate_hatch(s)

Validate a hatch pattern. A hatch pattern string can have any sequence of the following characters: \ / | - + * . x o O.

matplotlib.rcsetup.validate_hatchlist(s)

Validate a hatch pattern. A hatch pattern string can have any sequence of the following characters: \ / | - + * . x o O.

matplotlib.rcsetup.validate_hinting(s)

[Deprecated]

Notes

Deprecated since version 3.3:

matplotlib.rcsetup.validate_hist_bins(s)

matplotlib.rcsetup.validate_int(s)

matplotlib.rcsetup.validate_int_or_None(s)

matplotlib.rcsetup.validate_joinstyle(s)

matplotlib.rcsetup.validate_joinstylelist(s)

matplotlib.rcsetup.validate_markevery(s)

Validate the markevery property of a Line2D object.

Parameters:

sNone, int, float, slice, length-2 tuple of ints,

length-2 tuple of floats, list of ints

Returns:

None, int, float, slice, length-2 tuple of ints,

length-2 tuple of floats, list of ints

matplotlib.rcsetup.validate_markeverylist(s)

Validate the markevery property of a Line2D object.

Parameters:

sNone, int, float, slice, length-2 tuple of ints,

length-2 tuple of floats, list of ints

Returns:

None, int, float, slice, length-2 tuple of ints,

length-2 tuple of floats, list of ints

matplotlib.rcsetup.validate_movie_writer(s)

[Deprecated]

Notes

Deprecated since version 3.3:

matplotlib.rcsetup.validate_nseq_float(n)

[Deprecated]

Notes

Deprecated since version 3.3:

matplotlib.rcsetup.validate_nseq_int(n)

[Deprecated]

Notes

Deprecated since version 3.3:

matplotlib.rcsetup.validate_path_exists(s)

[Deprecated] If s is a path, return s, else False

Notes

Deprecated since version 3.2.

matplotlib.rcsetup.validate_ps_distiller(s)

matplotlib.rcsetup.validate_sketch(s)

matplotlib.rcsetup.validate_string(s)

matplotlib.rcsetup.validate_string_or_None(s)

matplotlib.rcsetup.validate_stringlist(s)

return a list of strings

matplotlib.rcsetup.validate_webagg_address(s)

[Deprecated]

Notes

Deprecated since version 3.3:

matplotlib.rcsetup.validate_whiskers(s)