8000 Warn if a non-str is passed to an rcParam requiring a str. by anntzer · Pull Request #20311 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Warn if a non-str is passed to an rcParam requiring a str. #20311

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 1 commit into from
May 26, 2021
Merged

Warn if a non-str is passed to an rcParam requiring a str. #20311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/deprecations/20311-AL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
rcParams will no longer cast inputs to str
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After a deprecation period, rcParams that expect a (non-pathlike) str will no
longer cast non-str inputs using `str`. This will avoid confusing errors in
subsequent code if e.g. a list input gets implicitly cast to a str.
23 changes: 19 additions & 4 deletions lib/matplotlib/rcsetup.py
View file
Open in desktop
10000
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from functools import lru_cache, reduce
from numbers import Number
import operator
import os
import re

import numpy as np
Expand Down Expand Up @@ -198,6 +199,11 @@ def validator(s):
if (allow_none and
(s is None or isinstance(s, str) and s.lower() == "none")):
return None
if cls is str and not isinstance(s, str):
_api.warn_deprecated(
"3.5", message="Support for setting an rcParam that expects a "
"str value to a non-str value is deprecated since %(since)s "
"and support will be removed %(removal)s.")
try:
return cls(s)
except (TypeError, ValueError) as e:
Expand All @@ -224,6 +230,15 @@ def validator(s):
validate_float, doc='return a list of floats')


def _validate_pathlike(s):
if isinstance(s, (str, os.PathLike)):
# Store value as str because savefig.directory needs to distinguish
# between "" (cwd) and "." (cwd, but gets updated by user selections).
return os.fsdecode(s)
else:
return validate_string(s) # Emit deprecation warning.


def validate_fonttype(s):
"""
Confirm that this is a Postscript or PDF font type that we know how to
Expand Down Expand Up @@ -1154,7 +1169,7 @@ def _convert_validator_spec(key, conv):
"savefig.bbox": validate_bbox, # "tight", or "standard" (= None)
"savefig.pad_inches": validate_float,
# default directory in savefig dialog box
"savefig.directory": validate_string,
"savefig.directory": _validate_pathlike,
"savefig.transparent": validate_bool,

"tk.window_focus": validate_bool, # Maintain shell focus for TkAgg
Expand Down Expand Up @@ -1224,15 +1239,15 @@ def _convert_validator_spec(key, conv):
# Additional arguments for HTML writer
"animation.html_args": validate_stringlist,
# Path to ffmpeg binary. If just binary name, subprocess uses $PATH.
"animation.ffmpeg_path": validate_string,
"animation.ffmpeg_path": _validate_pathlike,
# Additional arguments for ffmpeg movie writer (using pipes)
"animation.ffmpeg_args": validate_stringlist,
# Path to AVConv binary. If just binary name, subprocess uses $PATH.
"animation.avconv_path": validate_string,
"animation.avconv_path": _validate_pathlike,
# Additional arguments for avconv movie writer (using pipes)
"animation.avconv_args": validate_stringlist,
# Path to convert binary. If just binary name, subprocess uses $PATH.
"animation.convert_path": validate_string,
"animation.convert_path": _validate_pathlike,
# Additional arguments for convert movie writer (using pipes)
"animation.convert_args": validate_stringlist,

Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/tests/test_rcparams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,11 +225,11 @@ def generate_validator_testcases(valid):
(('a', 'b'), ['a', 'b']),
(iter(['a', 'b']), ['a', 'b']),
(np.array(['a', 'b']), ['a', 'b']),
((1, 2), ['1', '2']),
(np.array([1, 2]), ['1', '2']),
),
'fail': ((set(), ValueError),
(1, ValueError),
((1, 2), _api.MatplotlibDeprecationWarning),
(np.array([1, 2]), _api.MatplotlibDeprecationWarning),
)
},
{'validator': _listify_validator(validate_int, n=2),
Expand Down
0