Home / Function/ replace_placeholders_with_code_includes() — fastapi Function Reference

replace_placeholders_with_code_includes() — fastapi Function Reference

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

Entity Profile

Dependency Diagram

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

Relationship Graph

Source Code

scripts/doc_parsing_utils.py lines 109–134

def replace_placeholders_with_code_includes(
    text: list[str], original_includes: list[CodeIncludeInfo]
) -> list[str]:
    """
    Replace code includes placeholders with actual code includes from the original (English) document.
    Fail if the number of placeholders does not match the number of original includes.
    """

    code_include_lines = [
        line_no
        for line_no, line in enumerate(text)
        if line.strip() == CODE_INCLUDE_PLACEHOLDER
    ]

    if len(code_include_lines) != len(original_includes):
        raise ValueError(
            "Number of code include placeholders does not match the number of code includes "
            "in the original document "
            f"({len(code_include_lines)} vs {len(original_includes)})"
        )

    modified_text = text.copy()
    for i, line_no in enumerate(code_include_lines):
        modified_text[line_no] = original_includes[i]["line"]

    return modified_text

Domain

Subdomains

Frequently Asked Questions

What does replace_placeholders_with_code_includes() do?
replace_placeholders_with_code_includes() is a function in the fastapi codebase, defined in scripts/doc_parsing_utils.py.
Where is replace_placeholders_with_code_includes() defined?
replace_placeholders_with_code_includes() is defined in scripts/doc_parsing_utils.py at line 109.
What calls replace_placeholders_with_code_includes()?
replace_placeholders_with_code_includes() is called by 1 function(s): check_translation.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free