Skip to content

parsers

Parse a Pydantic model so it is usable by SQLAlchemy.

is_pydantic(obj)

Checks whether an object is pydantic.

Parameters:

Name Type Description Default
obj object

An arbitrary Python object to evaluate

 required

Returns

(bool): `True` if `obj` is of Pydantic type `ModelMetaClass`
(bool): `False` if `obj` is not of Pydatic type `ModelMetaClass`
Source code in src/red_utils/ext/pydantic_utils/parsers.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
def is_pydantic(obj: object) -> bool:
    """Checks whether an object is pydantic.

    Params:
        obj (object): An arbitrary Python object to evaluate

    Returns
    -------
        (bool): `True` if `obj` is of Pydantic type `ModelMetaClass`
        (bool): `False` if `obj` is not of Pydatic type `ModelMetaClass`
    """
    return type(obj).__class__.__name__ == "ModelMetaclass"

parse_pydantic_schema(schema)

Iterates through pydantic schema and parses nested schemas to a dictionary containing SQLAlchemy models. Only works if nested schemas have specified the Meta.orm_model.

Make sure to add this line to Pydantic schemas that have an ORM class:

1
2
class Meta:
    orm_model = "SQLAModelName"
Source code in src/red_utils/ext/pydantic_utils/parsers.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def parse_pydantic_schema(schema):
    """Iterates through pydantic schema and parses nested schemas
    to a dictionary containing SQLAlchemy models.
    Only works if nested schemas have specified the Meta.orm_model.

    Make sure to add this line to Pydantic schemas that have an ORM class:

    ``` py linenums="1"
    class Meta:
        orm_model = "SQLAModelName"
    ```
    """
    parsed_schema: dict = dict(schema)

    for key, value in parsed_schema.items():
        try:
            if isinstance(value, list) and len(value):
                if is_pydantic(value[0]):
                    parsed_schema[key] = [
                        schema.Meta.orm_model(**schema.dict()) for schema in value
                    ]

            else:
                if is_pydantic(value):
                    parsed_schema[key] = value.Meta.orm_model(**value.dict())

        except AttributeError:
            raise AttributeError(
                "Found nested Pydantic model but Meta.orm_model was not specified."
            )

    return parsed_schema