Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove support for multiple-color strings in to_rgba_array #18069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 27, 2020
Merged

Remove support for multiple-color strings in to_rgba_array #18069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3476c71
Remove support for multiple-color strings in to_rgba_array
dstansby Jul 26, 2020
02e1396
Add removal note
dstansby Jul 26, 2020
1e01d28
Improve removal note
dstansby Jul 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/api/next_api_changes/removals/18069.DS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Removed support for single color strings in `~.colors.to_rgba_array`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Converting a string with single color characters (e.g. ``'cymk'``) in
`~.colors.to_rgba_array` is no longer supported. Instead, the colors can be
passed individually in a list (e.g. ``['c', 'y', 'm', 'k']``).
19 changes: 3 additions & 16 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,23 +322,10 @@ def to_rgba_array(c, alpha=None):
except (ValueError, TypeError):
pass

# Convert one at a time.
if isinstance(c, str):
# Single string as color sequence.
# This is deprecated and will be removed in the future.
try:
result = np.array([to_rgba(cc, alpha) for cc in c])
except ValueError as err:
raise ValueError(
"'%s' is neither a valid single color nor a color sequence "
"consisting of single character color specifiers such as "
"'rgb'. Note also that the latter is deprecated." % c) from err
else:
cbook.warn_deprecated(
"3.2", message="Using a string of single character colors as "
"a color sequence is deprecated since %(since)s and will be "
"removed %(removal)s. Use an explicit list instead.")
return result
raise ValueError("Using a string of single character colors as "
"a color sequence is not supported. The colors can "
"be passed as an explicit list instead.")

if len(c) == 0:
return np.zeros((0, 4), float)
Expand Down
14 changes: 4 additions & 10 deletions lib/matplotlib/tests/test_colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1057,17 +1057,11 @@ def test_to_rgba_array_single_str():
# single color name is valid
assert_array_equal(mcolors.to_rgba_array("red"), [(1, 0, 0, 1)])

# single char color sequence is deprecated
with pytest.warns(cbook.MatplotlibDeprecationWarning,
match="Using a string of single character colors as a "
"color sequence is deprecated"):
array = mcolors.to_rgba_array("rgb")
assert_array_equal(array, [(1, 0, 0, 1), (0, 0.5, 0, 1), (0, 0, 1, 1)])

# single char color sequence is invalid
with pytest.raises(ValueError,
match="neither a valid single color nor a color "
"sequence"):
mcolors.to_rgba_array("rgbx")
match="Using a string of single character colors as "
"a color sequence is not supported."):
array = mcolors.to_rgba_array("rgb")


def test_failed_conversions():
Expand Down