Skip to content
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

Jump to bottom

escape base_uri in extlinks #10263

Merged
merged 3 commits into from Mar 27, 2022
Merged

escape base_uri in extlinks #10263

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
554f589
escape base_uri in extlinks to avoid regex issues with URIs containin…
nicoa Mar 13, 2022
aee4e42
extlink: Strip a leading backslash on compiling pattern
tk0miya Mar 27, 2022
81830cc
Fix a flake8 warning
tk0miya Mar 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 8 additions & 1 deletion sphinx/ext/extlinks.py
View file
Open in desktop
Expand Up @@ -26,6 +26,7 @@
"""

import re
import sys
import warnings
from typing import Any, Dict, List, Tuple

Expand Down Expand Up @@ -70,7 +71,13 @@ def check_uri(self, refnode: nodes.reference) -> None:
title = refnode.astext()

for alias, (base_uri, _caption) in self.app.config.extlinks.items():
uri_pattern = re.compile(base_uri.replace('%s', '(?P<value>.+)'))
if sys.version_info < (3, 7):
# Replace a leading backslash because re.escape() inserts a backslash before %
# on python 3.6
uri_pattern = re.compile(re.escape(base_uri).replace('\\%s', '(?P<value>.+)'))
else:
uri_pattern = re.compile(re.escape(base_uri).replace('%s', '(?P<value>.+)'))

match = uri_pattern.match(uri)
if match and match.groupdict().get('value'):
# build a replacement suggestion
Expand Down