edward/add-links
1
0
Fork 0
Code Issues 9 Pull requests Packages Projects Releases Wiki Activity

Add type hints and docstrings

Browse source
This commit is contained in:
Edward Betts 2023-12-09 18:42:03 +00:00
parent 113dfd3630
commit 1da620875a
1 changed files with 14 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
add_links/match.py
View file

@ -11,7 +11,7 @@ re_link_in_text = re.compile(r"\[\[[^]]+?\]\]", re.I | re.S)
class LinkReplace(Exception): class LinkReplace(Exception):
pass """Replaces and existing link."""
en_dash = "\u2013" en_dash = "\u2013"
@ -54,7 +54,7 @@ patterns = [
class NoMatch(Exception): class NoMatch(Exception):
pass """No match."""
re_cite = re.compile( re_cite = re.compile(
@ -98,7 +98,7 @@ def section_iter(text: str) -> typing.Iterator[tuple[str | None, str]]:
def get_subsections(text: str, section_num: int) -> str: def get_subsections(text: str, section_num: int) -> str:
"retrieve the text of subsections for a given section number within an article" """Retrieve the text of subsections for a given section number within an article."""
found = "" found = ""
collection_level = None collection_level = None
for num, (heading, body) in enumerate(section_iter(text)): for num, (heading, body) in enumerate(section_iter(text)):
@ -120,7 +120,7 @@ def get_subsections(text: str, section_num: int) -> str:
return found return found
def match_found(m, q, linkto): def match_found(m: re.Match[str], q: str, linkto: str | None) -> str:
if q[1:] == m.group(0)[1:]: if q[1:] == m.group(0)[1:]:
replacement = m.group(1) + q[1:] replacement = m.group(1) + q[1:]
elif any(c.isupper() for c in q[1:]) or m.group(0) == m.group(0).upper(): elif any(c.isupper() for c in q[1:]) or m.group(0) == m.group(0).upper():
@ -159,14 +159,16 @@ def parse_links(text: str) -> typing.Iterator[tuple[str, str]]:
yield ("text", text[prev:]) yield ("text", text[prev:])
def mk_link_matcher(q): def mk_link_matcher(q: str) -> typing.Callable[[str], re.Match[str] | None]:
"""Make link matcher."""
re_links = [p(q) for p in patterns] re_links = [p(q) for p in patterns]
def search_for_link(text): def search_for_link(text: str) -> re.Match[str] | None:
for re_link in re_links: for re_link in re_links:
m = re_link.search(text) m = re_link.search(text)
if m and m.group(0).count("[[") < 4: if m and m.group(0).count("[[") < 4:
return m return m
return None
return search_for_link return search_for_link
@ -175,7 +177,10 @@ def add_link(m, replacement, text):
return m.re.sub(lambda m: "[[%s]]" % replacement, text, count=1) return m.re.sub(lambda m: "[[%s]]" % replacement, text, count=1)
def find_link_in_chunk(q, content, linkto=None): def find_link_in_chunk(
q: str, content: str, linkto: str | None = None
) -> tuple[str, str | None, str | None]:
"""Find link in chunk."""
search_for_link = mk_link_matcher(q) search_for_link = mk_link_matcher(q)
new_content = "" new_content = ""
replacement = None replacement = None
@ -245,7 +250,7 @@ def find_link_in_chunk(q, content, linkto=None):
return (new_content, replacement, found_text_to_link) return (new_content, replacement, found_text_to_link)
def find_link_in_text(q, content): def find_link_in_text(q: str, content: str) -> tuple[str, str]:
(new_content, replacement) = find_link_in_chunk(q, content) (new_content, replacement) = find_link_in_chunk(q, content)
if replacement: if replacement:
return (new_content, replacement) return (new_content, replacement)
@ -280,7 +285,7 @@ def find_link_in_content(q, content, linkto=None):
raise LinkReplace if link_replace else NoMatch raise LinkReplace if link_replace else NoMatch
def find_link_and_section(q, content, linkto=None): def find_link_and_section(q: str, content: str, linkto: str | None = None):
if linkto: if linkto:
try: try:
return find_link_and_section(linkto, content) return find_link_and_section(linkto, content)