Skip to content

ModelObjectGlue

Source

django_glue.glue.model_object.glue.ModelObjectGlue

Bases: BaseGlue

Source code in django_glue/glue/model_object/glue.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def __init__(
        self,
        unique_name: str,
        model_object: Model,
        access: Union[Access, str] = Access.VIEW,
        included_fields: tuple = (ALL_DUNDER_KEY,),
        excluded_fields: tuple = (NONE_DUNDER_KEY,),
        included_methods: tuple = (NONE_DUNDER_KEY,),
):
    super().__init__(unique_name, GlueType.MODEL_OBJECT, access)

    self.model_object = model_object
    self.model = model_object._meta.model

    self.included_fields = included_fields
    self.excluded_fields = excluded_fields
    self.included_methods = included_methods

    self.fields: ModelFieldsGlue = self.generate_field_data()

model_object = model_object instance-attribute

model = model_object._meta.model instance-attribute

included_fields = included_fields instance-attribute

excluded_fields = excluded_fields instance-attribute

included_methods = included_methods instance-attribute

fields = self.generate_field_data() instance-attribute

call_method

Source code in django_glue/glue/model_object/glue.py 
37
38
39
40
41
42
43
44
45
46
def call_method(self, method_name: str, method_kwargs: dict) -> Callable | None:
    if method_name in self.included_methods and hasattr(self.model, method_name):
        method = getattr(self.model_object, method_name)

        if check_valid_method_kwargs(method, method_kwargs):
            type_set_kwargs = type_set_method_kwargs(method, method_kwargs)

            return method(**type_set_kwargs)

    return None

generate_field_data

Source code in django_glue/glue/model_object/glue.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
def generate_field_data(self, include_values: bool = True) -> ModelFieldsGlue:

    model_fields = model_object_fields_glue_from_model(
        model=self.model,
        included_fields=self.included_fields,
        excluded_fields=self.excluded_fields
    )

    if include_values:
        for field in model_fields:
            field.value = get_field_value_from_model_object(self.model_object, field)

    return model_fields

generate_method_data

Source code in django_glue/glue/model_object/glue.py 
62
63
64
65
66
67
68
69
70
71
72
73
def generate_method_data(self) -> list[str]:
    methods_list = list()

    for method in self.included_methods:
        if hasattr(self.model_object, method):
            methods_list.append(method)
        elif method == NONE_DUNDER_KEY:
            pass
        else:
            raise KeyError(f'Method "{method}" is invalid for model type "{self.model.__class__.__name__}"')

    return methods_list

to_session_data

Source code in django_glue/glue/model_object/glue.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
def to_session_data(self) -> ModelObjectGlueSessionData:
    return ModelObjectGlueSessionData(
        glue_type=self.glue_type,
        access=self.access,
        unique_name=self.unique_name,
        fields=self.generate_field_data(include_values=False).to_dict(),
        app_label=self.model_object._meta.app_label,
        model_name=self.model_object._meta.model_name,
        object_pk=self.model_object.pk,
        included_fields=self.included_fields,
        exclude_fields=self.excluded_fields,
        methods=self.generate_method_data(),
    )

update

Source code in django_glue/glue/model_object/glue.py 
89
90
91
92
93
94
95
96
def update(self, updated_fields: dict[str, Any]):
    for key, value in updated_fields.items():
        if hasattr(self.model_object, key):
            setattr(self.model_object, key, value)

    self.model_object.save()

    self.fields = self.generate_field_data()