replace_markdown_links() — fastapi Function Reference

Architecture documentation for the replace_markdown_links() function in doc_parsing_utils.py from the fastapi codebase.

Function python FastAPI Routing calls 1 called by 1

Entity Profile

FastAPI→ Routing→ replace_markdown_links() — fastapi Function Reference

Dependency Diagram

graph TD
  ed2c5129_3dfc_5c6c_1e50_515c9e4e6284["replace_markdown_links()"]
  c463d6a9_085f_f272_b9fc_455b7e9b6a57["doc_parsing_utils.py"]
  ed2c5129_3dfc_5c6c_1e50_515c9e4e6284 -->|defined in| c463d6a9_085f_f272_b9fc_455b7e9b6a57
  63822d7d_03fc_4331_3f93_3026c9c03415["check_translation()"]
  63822d7d_03fc_4331_3f93_3026c9c03415 -->|calls| ed2c5129_3dfc_5c6c_1e50_515c9e4e6284
  88c955bc_31b8_3ca8_ac86_c3d85778b519["_construct_markdown_link()"]
  ed2c5129_3dfc_5c6c_1e50_515c9e4e6284 -->|calls| 88c955bc_31b8_3ca8_ac86_c3d85778b519
  style ed2c5129_3dfc_5c6c_1e50_515c9e4e6284 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/doc_parsing_utils.py lines 310–350

def replace_markdown_links(
    text: list[str],
    links: list[MarkdownLinkInfo],
    original_links: list[MarkdownLinkInfo],
    lang_code: str,
) -> list[str]:
    """
    Replace markdown links in the given text with the original links.

    Fail if the number of links does not match the original.
    """

    if len(links) != len(original_links):
        raise ValueError(
            "Number of markdown links does not match the number in the "
            "original document "
            f"({len(links)} vs {len(original_links)})"
        )

    modified_text = text.copy()
    for i, link_info in enumerate(links):
        link_text = link_info["text"]
        link_title = link_info["title"]
        original_link_info = original_links[i]

        # Replace
        replacement_link = _construct_markdown_link(
            url=original_link_info["url"],
            text=link_text,
            title=link_title,
            attributes=original_link_info["attributes"],
            lang_code=lang_code,
        )
        line_no = link_info["line_no"] - 1
        modified_line = modified_text[line_no]
        modified_line = modified_line.replace(
            link_info["full_match"], replacement_link, 1
        )
        modified_text[line_no] = modified_line

    return modified_text