Commit e31e330f authored by Yakubov, Sergey's avatar Yakubov, Sergey
Browse files

Merge branch '6-update-mvvm-lib-to-work-with-pydantic-models' into 'main' 

Update library to work with Pydantic models

Closes #6

See merge request ndip/public-packages/py-mvvm!6
parents 7926a3c0 e118bf0a

pyproject.toml

+1 −1
Original line number Diff line number Diff line 
[tool.poetry]

name = "mvvm-lib"

version = "0.3.1"

version = "0.4.0"

description = "A Python Package for Model-View-ViewModel pattern"

authors = ["Yakubov, Sergey <yakubovs@ornl.gov>"]

readme = "README.md"

src/mvvm_lib/__init__.py

+4 −0
Original line number Diff line number Diff line 
import importlib.metadata



from .bindings_map import bindings_map



__version__ = importlib.metadata.version(__package__)



__all__ = ["bindings_map"]

src/mvvm_lib/bindings_map.py

0 → 100644
+17 −0
Original line number Diff line number Diff line 
"""Module for bindings map ant it's utils."""



from typing import Any, Dict



from pydantic import BaseModel



from mvvm_lib.utils import rget_list_of_fields



bindings_map: Dict[str, Any] = {}





def update_bindings_map(source: Any, value: Any) -> None:

    #    if isinstance(source, BaseModel):

    if issubclass(type(source), BaseModel):

        fields = rget_list_of_fields(source)

        for field in fields:

            bindings_map[field] = value

src/mvvm_lib/interface.py

+2 −2
Original line number Diff line number Diff line 
"""Abstract interfaces and type definitions."""



from abc import ABC, abstractmethod

from typing import Any, Callable, Dict, Optional, Union

from typing import Any, Callable, Optional, Union



LinkedObjectType = Optional[Union[object, Dict[str, Any], Callable]]

LinkedObjectType = Optional[Any]

LinkedObjectAttributesType = Optional[list[str]]

CallbackAfterUpdateType = Optional[Callable[[Optional[str]], None]]

ConnectCallbackType = Union[None, Callable[[Any, Optional[str]], None]]

src/mvvm_lib/pydantic_utils.py

0 → 100644
+72 −0
Original line number Diff line number Diff line 
"""Pydantic utils."""



import logging

import re

from typing import Any



from pydantic import BaseModel, ValidationError

from pydantic.fields import FieldInfo



from mvvm_lib import bindings_map



logger = logging.getLogger(__name__)





def get_nested_pydantic_field(model: BaseModel, field_path: str) -> FieldInfo:

    fields = field_path.split(".")

    current_model: Any = model



    for field in fields:

        if "[" in field:

            base = field.split("[")[0]

            current_model = getattr(current_model, base)

            for _ in range(field.count("[")):

                current_model = current_model[0]

            continue

        if issubclass(type(getattr(current_model, field)), BaseModel):

            current_model = getattr(current_model, field)

        else:

            return current_model.__fields__[field]



    raise Exception(f"Cannot find field {field_path}")





def get_field_info(field_name: str) -> FieldInfo:

    binding = bindings_map.get(field_name, None)

    if not binding:

        raise Exception(f"Cannot find field {field_name}")

    return get_nested_pydantic_field(binding.viewmodel_linked_object, field_name)





def validate_pydantic_parameter(name: str, value: Any, index: int) -> str | None:

    if name not in bindings_map:

        logger.warning(f"cannot find {name} in bindings_map")  # no error, just do not validate for now

        return None

    binding = bindings_map[name]

    current_model = binding.viewmodel_linked_object

    # get list of nested fields (if any) and get the corresponding model

    fields = name.split(".")

    for field in fields[:-1]:

        if "[" in field:

            base = field.split("[")[0]

            indices = re.findall(r"\[(\d+)\]", field)

            indices = [int(num) for num in indices]

            for i in indices:

                current_model = getattr(current_model, base)[i]

        else:

            current_model = getattr(current_model, field)

    final_field = fields[-1]

    # copy model so we do not modify the current one

    model = current_model.copy(deep=True)

    # force set field value

    setattr(model, final_field, value)

    # validate changed model

    try:

        model.__class__(**model.model_dump(warnings=False))

    except ValidationError as e:

        for error in e.errors():

            if (len(error["loc"]) > 0 and final_field in str(error["loc"][0])) or (

                len(error["loc"]) == 0 and e.title == current_model.__class__.__name__

            ):

                return error["msg"]

    return None