remove_header_permalinks() — fastapi Function Reference

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

Function python FastAPI Applications

Entity Profile

FastAPI→ Applications→ remove_header_permalinks() — fastapi Function Reference

Dependency Diagram

graph TD
  d36ac2da_eaa2_50dd_c3cb_878fcbc33d92["remove_header_permalinks()"]
  c463d6a9_085f_f272_b9fc_455b7e9b6a57["doc_parsing_utils.py"]
  d36ac2da_eaa2_50dd_c3cb_878fcbc33d92 -->|defined in| c463d6a9_085f_f272_b9fc_455b7e9b6a57
  style d36ac2da_eaa2_50dd_c3cb_878fcbc33d92 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/doc_parsing_utils.py lines 192–206

def remove_header_permalinks(lines: list[str]) -> list[str]:
    """
    Remove permalinks from headers in the given lines.
    """

    modified_lines: list[str] = []
    for line in lines:
        header_match = HEADER_WITH_PERMALINK_RE.match(line)
        if header_match:
            hashes, title, _permalink = header_match.groups()
            modified_line = f"{hashes} {title}"
            modified_lines.append(modified_line)
        else:
            modified_lines.append(line)
    return modified_lines