Skip to content

bpo-38786: Add parsing of https links to pydoc #17143

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
taleinat merged 2 commits into from
Nov 13, 2019
Merged

bpo-38786: Add parsing of https links to pydoc #17143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8c6528
pydoc html: parse https links
python273 Nov 13, 2019
00f7a93
add a NEWS entry
taleinat Nov 13, 2019
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
2 changes: 1 addition & 1 deletion Lib/pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ def markup(self, text, escape=None, funcs={}, classes={}, methods={}):
escape = escape or self.escape
results = []
here = 0
pattern = re.compile(r'\b((http|ftp)://\S+[\w/]|'
pattern = re.compile(r'\b((http|https|ftp)://\S+[\w/]|'
r'RFC[- ]?(\d+)|'
r'PEP[- ]?(\d+)|'
r'(self\.)?(\w+))')
Expand Down
11 changes: 11 additions & 0 deletions Lib/test/test_pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1311,6 +1311,17 @@ async def an_async_generator():
'async <a name="-an_async_generator"><strong>an_async_generator',
html)

def test_html_for_https_links(self):
def a_fn_with_https_link():
"""a link https://localhost/"""
pass

html = pydoc.HTMLDoc().document(a_fn_with_https_link)
self.assertIn(
'<a href="https://localhost/">https://localhost/</a>',
html
)

class PydocServerTest(unittest.TestCase):
"""Tests for pydoc._start_server"""

Expand Down
2 changes: 1 addition & 1 deletion Lib/xmlrpc/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,7 +732,7 @@ def markup(self, text, escape=None, funcs={}, classes={}, methods={}):
# hyperlinking of arbitrary strings being used as method
# names. Only methods with names consisting of word characters
# and '.'s are hyperlinked.
pattern = re.compile(r'\b((http|ftp)://\S+[\w/]|'
pattern = re.compile(r'\b((http|https|ftp)://\S+[\w/]|'
r'RFC[- ]?(\d+)|'
r'PEP[- ]?(\d+)|'
r'(self\.)?((?:\w|\.)+))\b')
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2019-11-13-16-49-03.bpo-38786.gNOwKh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pydoc now recognizes and parses HTTPS URLs. Patch by python273.