8000 Escape octothorpe characters in matplotlibrc by janniklasrose · Pull Request #19289 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Escape octothorpe characters in matplotlibrc #19289

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

Closed
wants to merge 4 commits into from
Closed

Escape octothorpe characters in matplotlibrc #19289

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ad8f2f
Escape octothorpe characters in matplotlibrc
janniklasrose Jan 13, 2021
07e66be
Add parsing support for quoted string values
janniklasrose Apr 12, 2021
60afd0e
Rename helper methods
janniklasrose Apr 12, 2021
e0a11b5
Tidy up docstrings
janniklasrose Apr 12, 2021
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
48 changes: 47 additions & 1 deletion lib/matplotlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -751,6 +751,47 @@ def _open_file_or_url(fname):
yield f


def _strip_comment(line):
"""
Strip line and remove comment line.
Only removes comments at the start of a line (may have leading whitespace)
"""
line = line.strip()
if re.match('^#', line): # line starts with a comment
line = ''
return line


def _parse_keyval(key, val):
"""
Parse a key-value pair.
We are only passing key in case we want to conditionally allow quoted strings
"""
# remove whitespace
val = val.strip()
# regex
quoted = re.compile(r"""
^ # beginning of line
(?P<quote>['"]) # $1: opening quote (cannot make this non-capturing)
(. *?) # $2: non-greedy anything, the quoted text
(?P=quote) # closing quote, not stored
(. *?) # $3: non-greedy anything, the rest
$ # end of line
""", re.VERBOSE)
match = quoted.match(val)
if match: # a quoted string
val2 = match.group(2)
# ensure the rest is just a comment
rest = match.group(3).strip()
if rest and not re.match('^#', rest):
return None # let it fail
else: # treat as a regular value
val2 = val.split('#', 1)[0] # remove optional comments at the end
val2 = val2.strip()

return val2


def _rc_params_in_file(fname, transform=lambda x: x, fail_on_error=False):
"""
Construct a `RcParams` instance from file *fname*.
Expand All @@ -773,7 +814,7 @@ def _rc_params_in_file(fname, transform=lambda x: x, fail_on_error=False):
try:
for line_no, line in enumerate(fd, 1):
line = transform(line)
strippedline = line.split('#', 1)[0].strip()
strippedline = _strip_comment(line).strip()
if not strippedline:
continue
tup = strippedline.split(':', 1)
Expand All @@ -784,6 +825,11 @@ def _rc_params_in_file(fname, transform=lambda x: x, fail_on_error=False):
key, val = tup
key = key.strip()
val = val.strip()
val = _parse_keyval(key, val)
if val is None:
_log.warning('Cannot parse key value in file %r, line %d (%r)',
fname, line_no, line.rstrip('\n'))
continue
if key in rc_temp:
_log.warning('Duplicate key in file %r, line %d (%r)',
fname, line_no, line.rstrip('\n'))
Expand Down
0