iter_all_en_paths() — fastapi Function Reference

Architecture documentation for the iter_all_en_paths() function in translate.py from the fastapi codebase.

Function python FastAPI Routing called by 1

Entity Profile

FastAPI→ Routing→ iter_all_en_paths() — fastapi Function Reference

Dependency Diagram

graph TD
  b0eae767_88dd_ba23_b36d_fc62457265bb["iter_all_en_paths()"]
  6dda5e35_b655_8af3_cd89_8c1584a092c4["translate.py"]
  b0eae767_88dd_ba23_b36d_fc62457265bb -->|defined in| 6dda5e35_b655_8af3_cd89_8c1584a092c4
  bc2c2b41_a3df_bfc0_e27e_63cb9f8d8f0a["iter_en_paths_to_translate()"]
  bc2c2b41_a3df_bfc0_e27e_63cb9f8d8f0a -->|calls| b0eae767_88dd_ba23_b36d_fc62457265bb
  style b0eae767_88dd_ba23_b36d_fc62457265bb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/translate.py lines 151–172

def iter_all_en_paths() -> Iterable[Path]:
    """
    Iterate on the markdown files to translate in order of priority.
    """
    first_dirs = [
        Path("docs/en/docs/learn"),
        Path("docs/en/docs/tutorial"),
        Path("docs/en/docs/advanced"),
        Path("docs/en/docs/about"),
        Path("docs/en/docs/how-to"),
    ]
    first_parent = Path("docs/en/docs")
    yield from first_parent.glob("*.md")
    for dir_path in first_dirs:
        yield from dir_path.rglob("*.md")
    first_dirs_str = tuple(str(d) for d in first_dirs)
    for path in Path("docs/en/docs").rglob("*.md"):
        if str(path).startswith(first_dirs_str):
            continue
        if path.parent == first_parent:
            continue
        yield path