Home / Function/ serialize_sequence_value() — fastapi Function Reference

serialize_sequence_value() — fastapi Function Reference

Architecture documentation for the serialize_sequence_value() function in v2.py from the fastapi codebase.

Entity Profile

Dependency Diagram

graph TD
  4cb58f37_8a19_439e_3001_0c4e74bf4bf8["serialize_sequence_value()"]
  3e134d50_38c1_8523_f518_6686c1d9752b["v2.py"]
  4cb58f37_8a19_439e_3001_0c4e74bf4bf8 -->|defined in| 3e134d50_38c1_8523_f518_6686c1d9752b
  2ba6fe9a_aa45_5cc7_6934_e5c187b8ae12["test_serialize_sequence_value_with_optional_list()"]
  2ba6fe9a_aa45_5cc7_6934_e5c187b8ae12 -->|calls| 4cb58f37_8a19_439e_3001_0c4e74bf4bf8
  29d33501_9dd3_6b17_1a69_884fc0fe5d65["test_serialize_sequence_value_with_optional_list_pipe_union()"]
  29d33501_9dd3_6b17_1a69_884fc0fe5d65 -->|calls| 4cb58f37_8a19_439e_3001_0c4e74bf4bf8
  2752ad44_65fc_e352_d5f9_362f3f6fab6b["test_serialize_sequence_value_with_none_first_in_union()"]
  2752ad44_65fc_e352_d5f9_362f3f6fab6b -->|calls| 4cb58f37_8a19_439e_3001_0c4e74bf4bf8
  style 4cb58f37_8a19_439e_3001_0c4e74bf4bf8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/_compat/v2.py lines 308–318

def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:
    origin_type = get_origin(field.field_info.annotation) or field.field_info.annotation
    if origin_type is Union or origin_type is UnionType:  # Handle optional sequences
        union_args = get_args(field.field_info.annotation)
        for union_arg in union_args:
            if union_arg is type(None):
                continue
            origin_type = get_origin(union_arg) or union_arg
            break
    assert issubclass(origin_type, shared.sequence_types)  # type: ignore[arg-type]
    return shared.sequence_annotation_to_type[origin_type](value)  # type: ignore[no-any-return,index]

Domain

Subdomains

Frequently Asked Questions

What does serialize_sequence_value() do?
serialize_sequence_value() is a function in the fastapi codebase, defined in fastapi/_compat/v2.py.
Where is serialize_sequence_value() defined?
serialize_sequence_value() is defined in fastapi/_compat/v2.py at line 308.
What calls serialize_sequence_value()?
serialize_sequence_value() is called by 3 function(s): test_serialize_sequence_value_with_none_first_in_union, test_serialize_sequence_value_with_optional_list, test_serialize_sequence_value_with_optional_list_pipe_union.

Analyze Your Own Codebase

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

Try Supermodel Free