_split_hash_comment() — fastapi Function Reference

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

Function python FastAPI Routing called by 1

Entity Profile

FastAPI→ Routing→ _split_hash_comment() — fastapi Function Reference

Dependency Diagram

graph TD
  37002dc8_e4b0_59f2_57f8_e9102dcb3c6b["_split_hash_comment()"]
  c463d6a9_085f_f272_b9fc_455b7e9b6a57["doc_parsing_utils.py"]
  37002dc8_e4b0_59f2_57f8_e9102dcb3c6b -->|defined in| c463d6a9_085f_f272_b9fc_455b7e9b6a57
  49a5cb30_408f_f3be_8707_68a8c1644c3d["replace_multiline_code_block()"]
  49a5cb30_408f_f3be_8707_68a8c1644c3d -->|calls| 37002dc8_e4b0_59f2_57f8_e9102dcb3c6b
  style 37002dc8_e4b0_59f2_57f8_e9102dcb3c6b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

scripts/doc_parsing_utils.py lines 552–558

def _split_hash_comment(line: str) -> tuple[str, Union[str, None]]:
    match = HASH_COMMENT_RE.match(line)
    if match:
        code = match.group("code").rstrip()
        comment = match.group("comment")
        return code, comment
    return line.rstrip(), None