Coverage for /usr/lib/python3/dist-packages/matplotlib/rcsetup.py : 77%

""" 

The rcsetup module contains the default values and the validation code for 

customization using matplotlib's rc settings. 

Each rc setting is assigned a default value and a function used to validate 

any attempted changes to that setting. The default values and 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. 

These default values should be consistent with the default matplotlibrc file 

that actually reflects the values given here. Any additions or deletions to the 

parameter set listed here should also be visited to the 

:file:`matplotlibrc.template` in matplotlib's root source directory. 

""" 

from collections.abc import Iterable, Mapping 

from functools import reduce 

import operator 

import os 

import re 

import sys 

from matplotlib import cbook 

from matplotlib.cbook import ls_mapper 

from matplotlib.fontconfig_pattern import parse_fontconfig_pattern 

from matplotlib.colors import is_color_like 

# Don't let the original cycler collide with our validating cycler 

from cycler import Cycler, cycler as ccycler 

# The capitalized forms are needed for ipython at present; this may 

# change for later versions. 

interactive_bk = ['GTK3Agg', 'GTK3Cairo', 

'MacOSX', 

'nbAgg', 

'Qt4Agg', 'Qt4Cairo', 'Qt5Agg', 'Qt5Cairo', 

'TkAgg', 'TkCairo', 

'WebAgg', 

'WX', 'WXAgg', 'WXCairo'] 

non_interactive_bk = ['agg', 'cairo', 

'pdf', 'pgf', 'ps', 'svg', 'template'] 

all_backends = interactive_bk + non_interactive_bk 

class ValidateInStrings(object): 

def __init__(self, key, valid, ignorecase=False): 

'valid is a list of legal strings' 

self.key = key 

self.ignorecase = ignorecase 

def func(s): 

if ignorecase: 

return s.lower() 

else: 

return s 

self.valid = {func(k): k for k in valid} 

def __call__(self, s): 

if self.ignorecase: 

s = s.lower() 

if s in self.valid: 

return self.valid[s] 

raise ValueError('Unrecognized %s string %r: valid strings are %s' 

% (self.key, s, list(self.valid.values()))) 

def _listify_validator(scalar_validator, allow_stringlist=False): 

def f(s): 

if isinstance(s, str): 

try: 

return [scalar_validator(v.strip()) for v in s.split(',') 

if v.strip()] 

except Exception: 

if allow_stringlist: 

# Sometimes, a list of colors might be a single string 

# of single-letter colornames. So give that a shot. 

return [scalar_validator(v.strip()) for v in s if v.strip()] 

else: 

raise 

# We should allow any generic sequence type, including generators, 

# Numpy ndarrays, and pandas data structures. However, unordered 

# sequences, such as sets, should be allowed but discouraged unless the 

# user desires pseudorandom behavior. 

elif isinstance(s, Iterable) and not isinstance(s, Mapping): 

# The condition on this list comprehension will preserve the 

# behavior of filtering out any empty strings (behavior was 

# from the original validate_stringlist()), while allowing 

# any non-string/text scalar values such as numbers and arrays. 

return [scalar_validator(v) for v in s 

if not isinstance(v, str) or v] 

else: 

raise ValueError("{!r} must be of type: string or non-dictionary " 

"iterable".format(s)) 

try: 

f.__name__ = "{}list".format(scalar_validator.__name__) 

except AttributeError: # class instance. 

f.__name__ = "{}List".format(type(scalar_validator).__name__) 

f.__doc__ = scalar_validator.__doc__ 

return f 

def validate_any(s): 

return s 

validate_anylist = _listify_validator(validate_any) 

def validate_path_exists(s): 

"""If s is a path, return s, else False""" 

if s is None: 

return None 

if os.path.exists(s): 

return s 

else: 

raise RuntimeError('"%s" should be a path but it does not exist' % s) 

def validate_bool(b): 

"""Convert b to a boolean or raise""" 

if isinstance(b, str): 

b = b.lower() 

if b in ('t', 'y', 'yes', 'on', 'true', '1', 1, True): 

return True 

elif b in ('f', 'n', 'no', 'off', 'false', '0', 0, False): 

return False 

else: 

raise ValueError('Could not convert "%s" to boolean' % b) 

def validate_bool_maybe_none(b): 

'Convert b to a boolean or raise' 

if isinstance(b, str): 

b = b.lower() 

if b is None or b == 'none': 

return None 

if b in ('t', 'y', 'yes', 'on', 'true', '1', 1, True): 

return True 

elif b in ('f', 'n', 'no', 'off', 'false', '0', 0, False): 

return False 

else: 

raise ValueError('Could not convert "%s" to boolean' % b) 

def validate_float(s): 

"""convert s to float or raise""" 

try: 

return float(s) 

except ValueError: 

raise ValueError('Could not convert "%s" to float' % s) 

validate_floatlist = _listify_validator(validate_float) 

def validate_float_or_None(s): 

"""convert s to float, None or raise""" 

# values directly from the rc file can only be strings, 

# so we need to recognize the string "None" and convert 

# it into the object. We will be case-sensitive here to 

# avoid confusion between string values of 'none', which 

# can be a valid string value for some other parameters. 

if s is None or s == 'None': 

return None 

try: 

return float(s) 

except ValueError: 

raise ValueError('Could not convert "%s" to float or None' % s) 

def validate_string_or_None(s): 

"""convert s to string or raise""" 

if s is None: 

return None 

try: 

return validate_string(s) 

except ValueError: 

raise ValueError('Could not convert "%s" to string' % s) 

def validate_axisbelow(s): 

try: 

return validate_bool(s) 

except ValueError: 

if isinstance(s, str): 

s = s.lower() 

if s.startswith('line'): 

return 'line' 

raise ValueError('%s cannot be interpreted as' 

' True, False, or "line"' % s) 

def validate_dpi(s): 

"""confirm s is string 'figure' or convert s to float or raise""" 

if s == 'figure': 

return s 

try: 

return float(s) 

except ValueError: 

raise ValueError('"%s" is not string "figure" or' 

' could not convert "%s" to float' % (s, s)) 

def validate_int(s): 

"""convert s to int or raise""" 

try: 

return int(s) 

except ValueError: 

raise ValueError('Could not convert "%s" to int' % s) 

def validate_int_or_None(s): 

"""if not None, tries to validate as an int""" 

if s=='None': 

s = None 

if s is None: 

return None 

try: 

return int(s) 

except ValueError: 

raise ValueError('Could not convert "%s" to int' % s) 

def validate_fonttype(s): 

""" 

confirm that this is a Postscript of PDF font type that we know how to 

convert to 

""" 

fonttypes = {'type3': 3, 

'truetype': 42} 

try: 

fonttype = validate_int(s) 

except ValueError: 

try: 

return fonttypes[s.lower()] 

except KeyError: 

raise ValueError( 

'Supported Postscript/PDF font types are %s' % list(fonttypes)) 

else: 

if fonttype not in fonttypes.values(): 

raise ValueError( 

'Supported Postscript/PDF font types are %s' % 

list(fonttypes.values())) 

return fonttype 

_validate_standard_backends = ValidateInStrings( 

'backend', all_backends, ignorecase=True) 

_auto_backend_sentinel = object() 

def validate_backend(s): 

backend = ( 

s if s is _auto_backend_sentinel or s.startswith("module://") 

else _validate_standard_backends(s)) 

return backend 

def validate_qt4(s): 

if s is None: 

return None 

return ValidateInStrings("backend.qt4", ['PyQt4', 'PySide', 'PyQt4v2'])(s) 

def validate_qt5(s): 

if s is None: 

return None 

return ValidateInStrings("backend.qt5", ['PyQt5', 'PySide2'])(s) 

def validate_toolbar(s): 

validator = ValidateInStrings( 

'toolbar', 

['None', 'toolbar2', 'toolmanager'], 

ignorecase=True) 

return validator(s) 

_seq_err_msg = ('You must supply exactly {n} values, you provided {num} ' 

'values: {s}') 

_str_err_msg = ('You must supply exactly {n} comma-separated values, you ' 

'provided {num} comma-separated values: {s}') 

class validate_nseq_float(object): 

def __init__(self, n=None, allow_none=False): 

self.n = n 

self.allow_none = allow_none 

def __call__(self, s): 

"""return a seq of n floats or raise""" 

if isinstance(s, str): 

s = [x.strip() for x in s.split(',')] 

err_msg = _str_err_msg 

else: 

err_msg = _seq_err_msg 

if self.n is not None and len(s) != self.n: 

raise ValueError(err_msg.format(n=self.n, num=len(s), s=s)) 

try: 

return [float(val) 

if not self.allow_none or val is not None 

else val 

for val in s] 

except ValueError: 

raise ValueError('Could not convert all entries to floats') 

class validate_nseq_int(object): 

def __init__(self, n=None): 

self.n = n 

def __call__(self, s): 

"""return a seq of n ints or raise""" 

if isinstance(s, str): 

s = [x.strip() for x in s.split(',')] 

err_msg = _str_err_msg 

else: 

err_msg = _seq_err_msg 

if self.n is not None and len(s) != self.n: 

raise ValueError(err_msg.format(n=self.n, num=len(s), s=s)) 

try: 

return [int(val) for val in s] 

except ValueError: 

raise ValueError('Could not convert all entries to ints') 

def validate_color_or_inherit(s): 

'return a valid color arg' 

if s == 'inherit': 

return s 

return validate_color(s) 

def validate_color_or_auto(s): 

if s == 'auto': 

return s 

return validate_color(s) 

def validate_color_for_prop_cycle(s): 

# Special-case the N-th color cycle syntax, this obviously can not 

# go in the color cycle. 

if isinstance(s, bytes): 

match = re.match(b'^C[0-9]$', s) 

if match is not None: 

raise ValueError('Can not put cycle reference ({cn!r}) in ' 

'prop_cycler'.format(cn=s)) 

elif isinstance(s, str): 

match = re.match('^C[0-9]$', s) 

if match is not None: 

raise ValueError('Can not put cycle reference ({cn!r}) in ' 

'prop_cycler'.format(cn=s)) 

return validate_color(s) 

def validate_color(s): 

'return a valid color arg' 

try: 

if s.lower() == 'none': 

return 'none' 

except AttributeError: 

pass 

if isinstance(s, str): 

if len(s) == 6 or len(s) == 8: 

stmp = '#' + s 

if is_color_like(stmp): 

return stmp 

if is_color_like(s): 

return s 

# If it is still valid, it must be a tuple. 

colorarg = s 

msg = '' 

if s.find(',') >= 0: 

# get rid of grouping symbols 

stmp = ''.join([c for c in s if c.isdigit() or c == '.' or c == ',']) 

vals = stmp.split(',') 

if len(vals) not in [3, 4]: 

msg = '\nColor tuples must be of length 3 or 4' 

else: 

try: 

colorarg = [float(val) for val in vals] 

except ValueError: 

msg = '\nCould not convert all entries to floats' 

if not msg and is_color_like(colorarg): 

return colorarg 

raise ValueError('%s does not look like a color arg%s' % (s, msg)) 

validate_colorlist = _listify_validator(validate_color, allow_stringlist=True) 

validate_colorlist.__doc__ = 'return a list of colorspecs' 

def validate_string(s): 

if isinstance(s, (str, str)): 

# Always leave str as str and unicode as unicode 

return s 

else: 

return str(s) 

validate_stringlist = _listify_validator(str) 

validate_stringlist.__doc__ = 'return a list' 

validate_orientation = ValidateInStrings( 

'orientation', ['landscape', 'portrait']) 

def validate_aspect(s): 

if s in ('auto', 'equal'): 

return s 

try: 

return float(s) 

except ValueError: 

raise ValueError('not a valid aspect specification') 

def validate_fontsize_None(s): 

if s is None or s == 'None': 

return None 

else: 

return validate_fontsize(s) 

def validate_fontsize(s): 

fontsizes = ['xx-small', 'x-small', 'small', 'medium', 'large', 

'x-large', 'xx-large', 'smaller', 'larger'] 

if isinstance(s, str): 

s = s.lower() 

if s in fontsizes: 

return s 

try: 

return float(s) 

except ValueError: 

raise ValueError("%s is not a valid font size. Valid font sizes " 

"are %s." % (s, ", ".join(fontsizes))) 

validate_fontsizelist = _listify_validator(validate_fontsize) 

def validate_font_properties(s): 

parse_fontconfig_pattern(s) 

return s 

validate_fontset = ValidateInStrings( 

'fontset', 

['dejavusans', 'dejavuserif', 'cm', 'stix', 'stixsans', 'custom']) 

validate_mathtext_default = ValidateInStrings( 

'default', 

"rm cal it tt sf bf default bb frak circled scr regular".split()) 

validate_verbose = ValidateInStrings( 

'verbose', 

['silent', 'helpful', 'debug', 'debug-annoying']) 

_validate_alignment = ValidateInStrings( 

'alignment', 

['center', 'top', 'bottom', 'baseline', 

'center_baseline']) 

def validate_whiskers(s): 

if s == 'range': 

return 'range' 

else: 

try: 

v = validate_nseq_float(2)(s) 

return v 

except (TypeError, ValueError): 

try: 

v = float(s) 

return v 

except ValueError: 

raise ValueError("Not a valid whisker value ['range', float, " 

"(float, float)]") 

def update_savefig_format(value): 

# The old savefig.extension could also have a value of "auto", but 

# the new savefig.format does not. We need to fix this here. 

value = validate_string(value) 

if value == 'auto': 

value = 'png' 

return value 

validate_ps_papersize = ValidateInStrings( 

'ps_papersize', 

['auto', 'letter', 'legal', 'ledger', 

'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'a7', 'a8', 'a9', 'a10', 

'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'b7', 'b8', 'b9', 'b10', 

], ignorecase=True) 

def validate_ps_distiller(s): 

if isinstance(s, str): 

s = s.lower() 

if s in ('none', None): 

return None 

elif s in ('false', False): 

return False 

elif s in ('ghostscript', 'xpdf'): 

return s 

else: 

raise ValueError('matplotlibrc ps.usedistiller must either be none, ' 

'ghostscript or xpdf') 

validate_joinstyle = ValidateInStrings('joinstyle', 

['miter', 'round', 'bevel'], 

ignorecase=True) 

validate_joinstylelist = _listify_validator(validate_joinstyle) 

validate_capstyle = ValidateInStrings('capstyle', 

['butt', 'round', 'projecting'], 

ignorecase=True) 

validate_capstylelist = _listify_validator(validate_capstyle) 

validate_fillstyle = ValidateInStrings('markers.fillstyle', 

['full', 'left', 'right', 'bottom', 

'top', 'none']) 

validate_fillstylelist = _listify_validator(validate_fillstyle) 

_validate_negative_linestyle = ValidateInStrings('negative_linestyle', 

['solid', 'dashed'], 

ignorecase=True) 

def validate_markevery(s): 

""" 

Validate the markevery property of a Line2D object. 

Parameters 

---------- 

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

length-2 tuple of floats, list of ints 

Returns 

------- 

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

length-2 tuple of floats, list of ints 

""" 

# Validate s against type slice 

if isinstance(s, slice): 

return s 

# Validate s against type tuple 

if isinstance(s, tuple): 

tupMaxLength = 2 

tupType = type(s[0]) 

if len(s) != tupMaxLength: 

raise TypeError("'markevery' tuple must have a length of " 

"%d" % (tupMaxLength)) 

if tupType is int and not all(isinstance(e, int) for e in s): 

raise TypeError("'markevery' tuple with first element of " 

"type int must have all elements of type " 

"int") 

if tupType is float and not all(isinstance(e, float) for e in s): 

raise TypeError("'markevery' tuple with first element of " 

"type float must have all elements of type " 

"float") 

if tupType is not float and tupType is not int: 

raise TypeError("'markevery' tuple contains an invalid type") 

# Validate s against type list 

elif isinstance(s, list): 

if not all(isinstance(e, int) for e in s): 

raise TypeError("'markevery' list must have all elements of " 

"type int") 

# Validate s against type float int and None 

elif not isinstance(s, (float, int)): 

if s is not None: 

raise TypeError("'markevery' is of an invalid type") 

return s 

validate_markeverylist = _listify_validator(validate_markevery) 

validate_legend_loc = ValidateInStrings( 

'legend_loc', 

['best', 

'upper right', 

'upper left', 

'lower left', 

'lower right', 

'right', 

'center left', 

'center right', 

'lower center', 

'upper center', 

'center'], ignorecase=True) 

def validate_svg_fonttype(s): 

if s in ["none", "path"]: 

return s 

if s == "svgfont": 

cbook.warn_deprecated( 

"2.2", "'svgfont' support for svg.fonttype is deprecated.") 

return s 

raise ValueError("Unrecognized svg.fonttype string '{}'; " 

"valid strings are 'none', 'path'") 

def validate_hinting(s): 

if s in (True, False): 

return s 

if s.lower() in ('auto', 'native', 'either', 'none'): 

return s.lower() 

raise ValueError("hinting should be 'auto', 'native', 'either' or 'none'") 

validate_pgf_texsystem = ValidateInStrings('pgf.texsystem', 

['xelatex', 'lualatex', 'pdflatex']) 

validate_movie_writer = ValidateInStrings('animation.writer', 

['ffmpeg', 'ffmpeg_file', 

'avconv', 'avconv_file', 

'imagemagick', 'imagemagick_file', 

'html']) 

validate_movie_frame_fmt = ValidateInStrings('animation.frame_format', 

['png', 'jpeg', 'tiff', 'raw', 'rgba']) 

validate_axis_locator = ValidateInStrings('major', ['minor', 'both', 'major']) 

validate_movie_html_fmt = ValidateInStrings('animation.html', 

['html5', 'jshtml', 'none']) 

def validate_bbox(s): 

if isinstance(s, str): 

s = s.lower() 

if s == 'tight': 

return s 

if s == 'standard': 

return None 

raise ValueError("bbox should be 'tight' or 'standard'") 

elif s is not None: 

# Backwards compatibility. None is equivalent to 'standard'. 

raise ValueError("bbox should be 'tight' or 'standard'") 

return s 

def validate_sketch(s): 

if isinstance(s, str): 

s = s.lower() 

if s == 'none' or s is None: 

return None 

if isinstance(s, str): 

result = tuple([float(v.strip()) for v in s.split(',')]) 

elif isinstance(s, (list, tuple)): 

result = tuple([float(v) for v in s]) 

if len(result) != 3: 

raise ValueError("path.sketch must be a tuple (scale, length, randomness)") 

return result 

class ValidateInterval(object): 

""" 

Value must be in interval 

""" 

def __init__(self, vmin, vmax, closedmin=True, closedmax=True): 

self.vmin = vmin 

self.vmax = vmax 

self.cmin = closedmin 

self.cmax = closedmax 

def __call__(self, s): 

try: 

s = float(s) 

except ValueError: 

raise RuntimeError('Value must be a float; found "%s"' % s) 

if self.cmin and s < self.vmin: 

raise RuntimeError('Value must be >= %f; found "%f"' % 

(self.vmin, s)) 

elif not self.cmin and s <= self.vmin: 

raise RuntimeError('Value must be > %f; found "%f"' % 

(self.vmin, s)) 

if self.cmax and s > self.vmax: 

raise RuntimeError('Value must be <= %f; found "%f"' % 

(self.vmax, s)) 

elif not self.cmax and s >= self.vmax: 

raise RuntimeError('Value must be < %f; found "%f"' % 

(self.vmax, s)) 

return s 

validate_grid_axis = ValidateInStrings('axes.grid.axis', ['x', 'y', 'both']) 

def validate_hatch(s): 

""" 

Validate a hatch pattern. 

A hatch pattern string can have any sequence of the following 

characters: ``\\ / | - + * . x o O``. 

""" 

if not isinstance(s, str): 

raise ValueError("Hatch pattern must be a string") 

unknown = set(s) - {'\\', '/', '|', '-', '+', '*', '.', 'x', 'o', 'O'} 

if unknown: 

raise ValueError("Unknown hatch symbol(s): %s" % list(unknown)) 

return s 

validate_hatchlist = _listify_validator(validate_hatch) 

validate_dashlist = _listify_validator(validate_nseq_float(allow_none=True)) 

_prop_validators = { 

'color': _listify_validator(validate_color_for_prop_cycle, 

allow_stringlist=True), 

'linewidth': validate_floatlist, 

'linestyle': validate_stringlist, 

'facecolor': validate_colorlist, 

'edgecolor': validate_colorlist, 

'joinstyle': validate_joinstylelist, 

'capstyle': validate_capstylelist, 

'fillstyle': validate_fillstylelist, 

'markerfacecolor': validate_colorlist, 

'markersize': validate_floatlist, 

'markeredgewidth': validate_floatlist, 

'markeredgecolor': validate_colorlist, 

'markevery': validate_markeverylist, 

'alpha': validate_floatlist, 

'marker': validate_stringlist, 

'hatch': validate_hatchlist, 

'dashes': validate_dashlist, 

} 

_prop_aliases = { 

'c': 'color', 

'lw': 'linewidth', 

'ls': 'linestyle', 

'fc': 'facecolor', 

'ec': 'edgecolor', 

'mfc': 'markerfacecolor', 

'mec': 'markeredgecolor', 

'mew': 'markeredgewidth', 

'ms': 'markersize', 

} 

def cycler(*args, **kwargs): 

""" 

Creates a `~cycler.Cycler` object much like :func:`cycler.cycler`, 

but includes input validation. 

Call signatures:: 

cycler(cycler) 

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

cycler(label, values) 

Form 1 copies a given `~cycler.Cycler` object. 

Form 2 creates a `~cycler.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.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 

---------- 

cycler : Cycler 

Copy constructor for Cycler. 

label : str 

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'. 

values : iterable 

Finite-length iterable of the property values. These values 

are validated and will raise a ValueError if invalid. 

Returns 

------- 

cycler : Cycler 

A new :class:`~cycler.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']) 

""" 

if args and kwargs: 

raise TypeError("cycler() can only accept positional OR keyword " 

"arguments -- not both.") 

elif not args and not kwargs: 

raise TypeError("cycler() must have positional OR keyword arguments") 

if len(args) == 1: 

if not isinstance(args[0], Cycler): 

raise TypeError("If only one positional argument given, it must " 

" be a Cycler instance.") 

return validate_cycler(args[0]) 

elif len(args) == 2: 

pairs = [(args[0], args[1])] 

elif len(args) > 2: 

raise TypeError("No more than 2 positional arguments allowed") 

else: 

pairs = kwargs.items() 

validated = [] 

for prop, vals in pairs: 

norm_prop = _prop_aliases.get(prop, prop) 

validator = _prop_validators.get(norm_prop, None) 

if validator is None: 

raise TypeError("Unknown artist property: %s" % prop) 

vals = validator(vals) 

# We will normalize the property names as well to reduce 

# the amount of alias handling code elsewhere.