1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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
|
from __future__ import annotations
import colorsys
import importlib.util
import itertools
import re
# import cmcrameri
# import cmocean
import colorcet
import matplotlib as mpl
from matplotlib.colors import CSS4_COLORS
from matplotlib.colors import TABLEAU_COLORS
import numpy as np
import pytest
import vtk
import pyvista as pv
from pyvista.plotting.colors import _CMCRAMERI_CMAPS
from pyvista.plotting.colors import _CMOCEAN_CMAPS
from pyvista.plotting.colors import _COLORCET_CMAPS
from pyvista.plotting.colors import _MATPLOTLIB_CMAPS
from pyvista.plotting.colors import color_scheme_to_cycler
from pyvista.plotting.colors import get_cmap_safe
COLORMAPS = ['Greys', mpl.colormaps['viridis'], ['red', 'green', 'blue']]
if importlib.util.find_spec('cmocean'):
COLORMAPS.append('algae')
if importlib.util.find_spec('colorcet'):
COLORMAPS.append('fire')
if importlib.util.find_spec('cmcrameri'):
COLORMAPS.append('batlow')
@pytest.mark.parametrize('cmap', COLORMAPS)
def test_get_cmap_safe(cmap):
assert isinstance(get_cmap_safe(cmap), mpl.colors.Colormap)
@pytest.mark.parametrize('scheme', [object(), 1.0, None])
def test_color_scheme_to_cycler_raises(scheme):
with pytest.raises(TypeError, match=f'Color scheme not understood: {scheme}'):
color_scheme_to_cycler(scheme=scheme)
def test_color():
name, name2 = 'blue', 'b'
i_rgba, f_rgba = (0, 0, 255, 255), (0.0, 0.0, 1.0, 1.0)
h = '0000ffff'
i_opacity, f_opacity, h_opacity = 153, 0.6, '99'
i_types = (int, np.int16, np.int32, np.int64, np.uint8, np.uint16, np.uint32, np.uint64)
f_types = (float, np.float16, np.float32, np.float64)
h_prefixes = ('', '0x', '#')
assert pv.Color(name) == i_rgba
assert pv.Color(name2) == i_rgba
# Check integer types
for i_type in i_types:
i_color = [i_type(c) for c in i_rgba]
# Check list, tuple and numpy array
assert pv.Color(i_color) == i_rgba
assert pv.Color(tuple(i_color)) == i_rgba
assert pv.Color(np.asarray(i_color, dtype=i_type)) == i_rgba
# Check float types
for f_type in f_types:
f_color = [f_type(c) for c in f_rgba]
# Check list, tuple and numpy array
assert pv.Color(f_color) == i_rgba
assert pv.Color(tuple(f_color)) == i_rgba
assert pv.Color(np.asarray(f_color, dtype=f_type)) == i_rgba
# Check hex
for h_prefix in h_prefixes:
assert pv.Color(h_prefix + h) == i_rgba
# Check dict
for channels in itertools.product(*pv.Color.CHANNEL_NAMES):
dct = dict(zip(channels, i_rgba))
assert pv.Color(dct) == i_rgba
# Check opacity
for opacity in (i_opacity, f_opacity, h_opacity):
# No opacity in color provided => use opacity
assert pv.Color(name, opacity) == (*i_rgba[:3], i_opacity)
# Opacity in color provided => overwrite using opacity
assert pv.Color(i_rgba, opacity) == (*i_rgba[:3], i_opacity)
# Check default_opacity
for opacity in (i_opacity, f_opacity, h_opacity):
# No opacity in color provided => use default_opacity
assert pv.Color(name, default_opacity=opacity) == (*i_rgba[:3], i_opacity)
# Opacity in color provided => keep that opacity
assert pv.Color(i_rgba, default_opacity=opacity) == i_rgba
# Check default_color
assert pv.Color(None, default_color=name) == i_rgba
# Check hex and name getters
assert pv.Color(name).hex_rgba == f'#{h}'
assert pv.Color(name).hex_rgb == f'#{h[:-2]}'
assert pv.Color('b').name == 'blue'
# Check sRGB conversion
assert pv.Color('gray', 0.5).linear_to_srgb() == '#bcbcbcbc'
assert pv.Color('#bcbcbcbc').srgb_to_linear() == '#80808080'
# Check iteration and indexing
c = pv.Color(i_rgba)
assert all(ci == fi for ci, fi in zip(c, f_rgba))
for i, cnames in enumerate(pv.Color.CHANNEL_NAMES):
assert c[i] == f_rgba[i]
assert all(c[i] == c[cname] for cname in cnames)
assert c[-1] == f_rgba[-1]
assert c[1:3] == f_rgba[1:3]
with pytest.raises(TypeError):
c[None] # Invalid index type
with pytest.raises(ValueError): # noqa: PT011
c['invalid_name'] # Invalid string index
with pytest.raises(IndexError):
c[4] # Invalid integer index
@pytest.mark.parametrize('opacity', [275, -50, 2.4, -1.2, '#zz'])
def test_color_invalid_opacity(opacity):
match = (
'Must be an integer, float or string. For example:'
"\n\t\topacity='1.0'"
"\n\t\topacity='255'"
"\n\t\topacity='#FF'"
)
with pytest.raises(ValueError, match=re.escape(match)):
pv.Color('b', opacity)
@pytest.mark.parametrize(
'color',
[
(300, 0, 0),
(0, -10, 0),
(0, 0, 1.5),
np.array((0, 0, 1.5), dtype=np.float16),
(-0.5, 0, 0),
(0, 0),
'#hh0000',
'invalid_name',
{'invalid_name': 100},
],
)
def test_color_invalid_values(color):
match = (
'Must be a string, rgb(a) sequence, or hex color string. For example:'
"\n\t\tcolor='white'"
"\n\t\tcolor='w'"
'\n\t\tcolor=[1.0, 1.0, 1.0]'
'\n\t\tcolor=[255, 255, 255]'
"\n\t\tcolor='#FFFFFF'"
)
with pytest.raises(ValueError, match=re.escape(match)):
pv.Color(color)
def test_color_invalid_type():
match = 'color must be an instance of'
with pytest.raises(TypeError, match=match):
pv.Color(range(3))
@pytest.mark.parametrize('delimiter', ['-', '_', ' '])
def test_color_name_delimiter(delimiter):
name = f'medium{delimiter}spring{delimiter}green'
c = pv.Color(name)
assert c.name == name.replace(delimiter, '')
def test_color_hls():
lime = pv.Color('lime')
actual_hls = lime._float_hls
expected_hls = colorsys.rgb_to_hls(*lime.float_rgb)
assert actual_hls == expected_hls
def test_color_opacity():
color = pv.Color(opacity=0.5)
assert color.opacity == 128
def pytest_generate_tests(metafunc):
"""Generate parametrized tests."""
if 'css4_color' in metafunc.fixturenames:
color_names = list(CSS4_COLORS.keys())
color_values = list(CSS4_COLORS.values())
test_cases = zip(color_names, color_values)
metafunc.parametrize('css4_color', test_cases, ids=color_names)
if 'tab_color' in metafunc.fixturenames:
color_names = list(TABLEAU_COLORS.keys())
color_values = list(TABLEAU_COLORS.values())
test_cases = zip(color_names, color_values)
metafunc.parametrize('tab_color', test_cases, ids=color_names)
if 'vtk_color' in metafunc.fixturenames:
color_names = list(pv.plotting.colors._VTK_COLORS.keys())
color_values = list(pv.plotting.colors._VTK_COLORS.values())
test_cases = zip(color_names, color_values)
metafunc.parametrize('vtk_color', test_cases, ids=color_names)
if 'color_synonym' in metafunc.fixturenames:
synonyms = list(pv.colors.color_synonyms.keys())
metafunc.parametrize('color_synonym', synonyms, ids=synonyms)
@pytest.mark.skip_check_gc
def test_css4_colors(css4_color):
# Test value
name, value = css4_color
assert pv.Color(name).hex_rgb.lower() == value.lower()
# Test name
if name not in pv.plotting.colors._CSS_COLORS:
alt_name = pv.plotting.colors.color_synonyms[name]
assert alt_name in pv.plotting.colors._CSS_COLORS
@pytest.mark.skip_check_gc
def test_tab_colors(tab_color):
# Test value
name, value = tab_color
assert pv.Color(name).hex_rgb.lower() == value.lower()
# Test name
assert name in pv.plotting.colors._TABLEAU_COLORS
@pytest.mark.skip_check_gc
def test_vtk_colors(vtk_color):
name, value = vtk_color
# Some pyvista colors are technically not valid VTK colors. We need to map their
# synonym manually for the tests
vtk_synonyms = { # pyvista_color : vtk_color
'light_slate_blue': 'slate_blue_light',
'deep_cadmium_red': 'cadmium_red_deep',
'light_cadmium_red': 'cadmium_red_light',
'light_cadmium_yellow': 'cadmium_yellow_light',
'deep_cobalt_violet': 'cobalt_violet_deep',
'deep_naples_yellow': 'naples_yellow_deep',
'light_viridian': 'viridian_light',
}
name = vtk_synonyms.get(name, name)
# Get expected hex value from vtkNamedColors
color3ub = vtk.vtkNamedColors().GetColor3ub(name)
int_rgb = (color3ub.GetRed(), color3ub.GetGreen(), color3ub.GetBlue())
if int_rgb == (0.0, 0.0, 0.0) and name != 'black':
pytest.fail(f"Color '{name}' is not a valid VTK color.")
expected_hex = pv.Color(int_rgb).hex_rgb
assert value.lower() == expected_hex
@pytest.mark.skip_check_gc
def test_color_synonyms(color_synonym):
color = pv.Color(color_synonym)
assert isinstance(color, pv.Color)
def test_unique_colors():
duplicates = np.rec.find_duplicate(pv.hexcolors.values())
if len(duplicates) > 0:
pytest.fail(f'The following colors have duplicate definitions: {duplicates}.')
@pytest.fixture
def reset_matplotlib_cmaps():
# Need to unregister all 3rd-party cmaps
for cmap in list(mpl.colormaps):
try:
mpl.colormaps.unregister(cmap)
except (ValueError, AttributeError):
continue
def maybe_xfail_mpl():
missing_colormaps = {'berlin', 'vanimo', 'managua'}
if not missing_colormaps.issubset(mpl.colormaps):
pytest.xfail(
reason='Older Matplotlib is missing colormaps: berlin, vanimo, managua.',
)
@pytest.mark.usefixtures('reset_matplotlib_cmaps')
def test_cmaps_matplotlib_allowed():
maybe_xfail_mpl()
# Test that cmaps listed in colors module matches the actual cmaps available
actual = set(mpl.colormaps)
expected = set(_MATPLOTLIB_CMAPS)
assert actual == expected
@pytest.mark.usefixtures('reset_matplotlib_cmaps')
def test_cmaps_colorcet_required():
# Test that cmaps listed in colors module matches the actual cmaps available
actual = set(colorcet.cm.keys()) - set(mpl.colormaps)
expected = set(_COLORCET_CMAPS)
assert actual == expected
@pytest.mark.usefixtures('reset_matplotlib_cmaps')
@pytest.mark.xfail(reason="cmocean not available as debian package")
def test_cmaps_cmocean_required():
# Test that cmaps listed in colors module matches the actual cmaps available
actual = set(cmocean.cm.cmap_d.keys()) - set(mpl.colormaps)
expected = set(_CMOCEAN_CMAPS)
assert actual == expected
@pytest.mark.usefixtures('reset_matplotlib_cmaps')
@pytest.mark.xfail(reason="cmcrameri not available as debian package")
def test_cmaps_cmcrameri_required():
maybe_xfail_mpl()
# Test that cmaps listed in colors module matches the actual cmaps available
actual = set(cmcrameri.cm.cmaps.keys()) - set(mpl.colormaps)
expected = set(_CMCRAMERI_CMAPS)
assert actual == expected
|