extract_code_includes() — fastapi Function Reference

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

Function python FastAPI Responses called by 2

Entity Profile

FastAPI→ Responses→ extract_code_includes() — fastapi Function Reference

Dependency Diagram

graph TD
  3711a338_7888_f097_07f9_412de0a8e2c7["extract_code_includes()"]
  c463d6a9_085f_f272_b9fc_455b7e9b6a57["doc_parsing_utils.py"]
  3711a338_7888_f097_07f9_412de0a8e2c7 -->|defined in| c463d6a9_085f_f272_b9fc_455b7e9b6a57
  b0ee4e17_e68b_9c14_69e8_8a23e32a567e["replace_code_includes_with_placeholders()"]
  b0ee4e17_e68b_9c14_69e8_8a23e32a567e -->|calls| 3711a338_7888_f097_07f9_412de0a8e2c7
  63822d7d_03fc_4331_3f93_3026c9c03415["check_translation()"]
  63822d7d_03fc_4331_3f93_3026c9c03415 -->|calls| 3711a338_7888_f097_07f9_412de0a8e2c7
  style 3711a338_7888_f097_07f9_412de0a8e2c7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/doc_parsing_utils.py lines 81–94

def extract_code_includes(lines: list[str]) -> list[CodeIncludeInfo]:
    """
    Extract lines that contain code includes.

    Return list of CodeIncludeInfo, where each dict contains:
    - `line_no` - line number (1-based)
    - `line` - text of the line
    """

    includes: list[CodeIncludeInfo] = []
    for line_no, line in enumerate(lines, start=1):
        if CODE_INCLUDE_RE.match(line):
            includes.append(CodeIncludeInfo(line_no=line_no, line=line))
    return includes