entity: moved name to _name to prevent nameclash with "name" property #29

Author: dan-obx

objectbox/model/entity.py

@@ -33,7 +33,7 @@ class _Entity(object):
     def __init__(self, user_type, uid: int = 0):
         self.user_type = user_type
         self.iduid = IdUid(0, uid)
-        self.name = user_type.__name__
+        self._name = user_type.__name__
         self.last_property_iduid = IdUid(0, 0)
 
         self.properties: List[Property] = list()  # List[Property]
@@ -64,7 +64,7 @@ def __call__(self, **properties):
         object_ = self.user_type()
         for prop_name, prop_val in properties.items():
             if not hasattr(object_, prop_name):
-                raise Exception(f"Entity {self.name} has no property \"{prop_name}\"")
+                raise Exception(f"Entity {self._name} has no property \"{prop_name}\"")
             setattr(object_, prop_name, prop_val)
         return object_
 
@@ -119,7 +119,7 @@ def get_property(self, name: str):
         for prop in self.properties:
             if prop.name == name:
                 return prop
-        raise Exception(f"Property \"{name}\" not found in Entity: \"{self.name}\"")
+        raise Exception(f"Property \"{name}\" not found in Entity: \"{self._name}\"")
 
     def get_property_id(self, prop: Union[int, str, Property]) -> int:
         """ A convenient way to get the property ID regardless having its ID, name or Property. """

objectbox/model/idsync.py

@@ -86,7 +86,7 @@ def _save_model_json(self):
         for entity in self.model.entities:
             entity_json = {
                 "id": str(entity.iduid),
-                "name": entity.name,
+                "name": entity._name,
                 "lastPropertyId": str(entity.last_property_iduid),
                 "properties": []
             }
@@ -178,7 +178,7 @@ def _validate_matching_prop(self, entity: _Entity, prop: Property, prop_json: Di
             elif prop.index is not None and "indexId" not in prop_json:
                 raise ValueError("property has index, but index not found in JSON")
         except ValueError as error:
-            raise ValueError(f"Property {entity.name}.{prop.name} mismatches property found in JSON file: {error}")
+            raise ValueError(f"Property {entity._name}.{prop.name} mismatches property found in JSON file: {error}")
 
     def _sync_index(self, entity: _Entity, prop: Property, prop_json: Optional[Dict[str, Any]]) -> bool:
         assert prop.index is not None
@@ -251,9 +251,9 @@ def _sync_entity(self, entity: _Entity) -> bool:
                 # User provided a UID not matching any entity, make sure it's not assigned elsewhere
                 self._validate_uid_unassigned(entity.uid)
             else:
-                write_json = entity.name != entity_json["name"]  # If renaming we shall update the JSON
+                write_json = entity._name != entity_json["name"]  # If renaming we shall update the JSON
         else:
-            entity_json = self._find_entity_json_by_name(entity.name)
+            entity_json = self._find_entity_json_by_name(entity._name)
 
         # Write JSON if the number of properties differs (to handle removed property)
         if entity_json is not None:

objectbox/model/model.py

@@ -40,8 +40,8 @@ def entity(self, entity: _Entity):
             raise Exception(f"The given type is not an Entity: {type(entity)}. "
                             f"Ensure to have an @Entity annotation on the class.")
         for other_entity in self.entities:  # Linear search (we should't have many entities)
-            if entity.name == other_entity.name:
-                raise Exception(f"Duplicate entity: \"{entity.name}\"")
+            if entity._name == other_entity._name:
+                raise Exception(f"Duplicate entity: \"{entity._name}\"")
         self.entities.append(entity)
 
     def validate_ids_assigned(self):
@@ -51,16 +51,16 @@ def validate_ids_assigned(self):
         for entity in self.entities:
             has_properties = len(entity.properties) > 0
             if not entity.iduid.is_assigned():
-                raise ValueError(f"Entity \"{entity.name}\" ID/UID not assigned")
+                raise ValueError(f"Entity \"{entity._name}\" ID/UID not assigned")
             for prop in entity.properties:
                 if not prop.iduid.is_assigned():
-                    raise ValueError(f"Property \"{entity.name}.{prop.name}\" ID/UID not assigned")
+                    raise ValueError(f"Property \"{entity._name}.{prop.name}\" ID/UID not assigned")
                 if prop.index is not None:
                     has_indices = True
                     if not prop.index.iduid.is_assigned():
-                        raise ValueError(f"Property index \"{entity.name}.{prop.name}\" ID/UID not assigned")
+                        raise ValueError(f"Property index \"{entity._name}.{prop.name}\" ID/UID not assigned")
             if has_properties and not entity.last_property_iduid.is_assigned():
-                raise ValueError(f"Entity \"{entity.name}\" last property ID/UID not assigned")
+                raise ValueError(f"Entity \"{entity._name}\" last property ID/UID not assigned")
         if has_entities and not self.last_entity_iduid.is_assigned():
             raise ValueError("Last entity ID/UID not assigned")
         if has_indices and not self.last_index_iduid.is_assigned():
@@ -96,7 +96,7 @@ def _create_property(self, prop: Property):
             self._create_index(prop.index)
 
     def _create_entity(self, entity: _Entity):
-        obx_model_entity(self._c_model, c_str(entity.name), entity.id, entity.uid)
+        obx_model_entity(self._c_model, c_str(entity._name), entity.id, entity.uid)
         for prop in entity.properties:
             self._create_property(prop)
         obx_model_entity_last_property_id(self._c_model, entity.last_property_iduid.id, entity.last_property_iduid.uid)