fastapi Architecture Docs
Home / Function/ field_annotation_is_scalar_sequence() — fastapi Function Reference

field_annotation_is_scalar_sequence() — fastapi Function Reference

Architecture documentation for the field_annotation_is_scalar_sequence() function in shared.py from the fastapi codebase.

Function python FastAPI Routing calls 2

Entity Profile

Dependency Diagram

graph TD
  4dfe14d4_f887_9fbf_e35f_b0033e4779c0["field_annotation_is_scalar_sequence()"]
  3e898b29_4dd8_c417_2d9b_a84d867423b4["shared.py"]
  4dfe14d4_f887_9fbf_e35f_b0033e4779c0 -->|defined in| 3e898b29_4dd8_c417_2d9b_a84d867423b4
  935832d6_93ad_1258_7852_84ffec4ea5d4["field_annotation_is_scalar()"]
  4dfe14d4_f887_9fbf_e35f_b0033e4779c0 -->|calls| 935832d6_93ad_1258_7852_84ffec4ea5d4
  8270df11_9596_bb04_cf3e_ab064ec2d09a["field_annotation_is_sequence()"]
  4dfe14d4_f887_9fbf_e35f_b0033e4779c0 -->|calls| 8270df11_9596_bb04_cf3e_ab064ec2d09a
  style 4dfe14d4_f887_9fbf_e35f_b0033e4779c0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/_compat/shared.py lines 111–125

def field_annotation_is_scalar_sequence(annotation: Union[type[Any], None]) -> bool:
    origin = get_origin(annotation)
    if origin is Union or origin is UnionType:
        at_least_one_scalar_sequence = False
        for arg in get_args(annotation):
            if field_annotation_is_scalar_sequence(arg):
                at_least_one_scalar_sequence = True
                continue
            elif not field_annotation_is_scalar(arg):
                return False
        return at_least_one_scalar_sequence
    return field_annotation_is_sequence(annotation) and all(
        field_annotation_is_scalar(sub_annotation)
        for sub_annotation in get_args(annotation)
    )

Domain

Subdomains

Defined In

Calls

Source

Frequently Asked Questions

What does field_annotation_is_scalar_sequence() do?
field_annotation_is_scalar_sequence() is a function in the fastapi codebase, defined in fastapi/_compat/shared.py.
Where is field_annotation_is_scalar_sequence() defined?
field_annotation_is_scalar_sequence() is defined in fastapi/_compat/shared.py at line 111.
What does field_annotation_is_scalar_sequence() call?
field_annotation_is_scalar_sequence() calls 2 function(s): field_annotation_is_scalar, field_annotation_is_sequence.

Analyze Your Own Codebase

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

Try Supermodel Free