added support for aliases function for names

Author: phenobarbital

datamodel/abstract.py

@@ -43,6 +43,7 @@ class Meta:
     validate_assignment: bool = False
     as_objects: bool = False
     no_nesting: bool = False
+    alias_function: Optional[Callable] = None
 
 
 def set_connection(cls, conn: Callable):
@@ -283,6 +284,13 @@ def __init__(cls, *args, **kwargs) -> None:
 
     def __call__(cls, *args, **kwargs):
         #    rename any kwargs that match an alias ONLY if there are aliases defined.
+        alias_func = getattr(cls.Meta, "alias_function", None)
+        if callable(alias_func):
+            new_kwargs = {}
+            for k, v in kwargs.items():
+                new_k = alias_func(k)
+                new_kwargs[new_k] = v
+            kwargs = new_kwargs
         if cls.__aliases__:
             new_kwargs = {}
             for k, v in kwargs.items():
@@ -291,6 +299,5 @@ def __call__(cls, *args, **kwargs):
                     new_kwargs[real_field] = v
                 else:
                     new_kwargs[k] = v
-        else:
-            new_kwargs = kwargs
-        return super().__call__(*args, **new_kwargs)
+            kwargs = new_kwargs
+        return super().__call__(*args, **kwargs)

datamodel/aliases/__init__.py

@@ -0,0 +1,16 @@
+# Aliases Functions:
+import re
+
+_RE_FIRST_CAP = re.compile(r"(.)([A-Z][a-z]+)")
+_RE_ALL_CAPS = re.compile(r"([a-z0-9])([A-Z])")
+
+
+def to_snakecase(name: str) -> str:
+    """
+    Convert a CamelCase or PascalCase string into snake_case.
+    Example: "EmailAddress" -> "email_address"
+    """
+    import re
+    # Insert underscores before capital letters, then lower-case
+    s1 = _RE_FIRST_CAP.sub(r"\1_\2", name)
+    return _RE_ALL_CAPS.sub(r"\1_\2", s1).lower()

datamodel/models.py

@@ -170,9 +170,7 @@ def __convert_enums__(self, obj: Any) -> dict[str, Any]:
                 key: self.__convert_enums__(value) for key, value in obj.items()
             }
         else:
-            if isinstance(obj, Enum):
-                return obj.value
-            return obj
+            return obj.value if isinstance(obj, Enum) else obj
 
     def to_dict(
         self,
@@ -185,7 +183,7 @@ def to_dict(
         d = as_dict(self, dict_factory=dict)
         if convert_enums:
             d = self.__convert_enums__(d)
-        if self.Meta.remove_nulls is True or remove_nulls is True:
+        if self.Meta.remove_nulls is True or remove_nulls:
             return self.remove_nulls(d)
         # 4) If as_values => convert sub-models to pk-value
         return d

datamodel/version.py

@@ -4,7 +4,7 @@
 __title__ = 'python-datamodel'
 __description__ = ('simple library based on python +3.8 to use Dataclass-syntax'
                    'for interacting with Data')
-__version__ = '0.8.7'
+__version__ = '0.8.8'
 __author__ = 'Jesus Lara'
 __author_email__ = '[email protected]'
 __license__ = 'BSD'

examples/test_alias.py

@@ -1,9 +1,55 @@
+from typing import List, Optional
 from datamodel import BaseModel, Field
 
+data = {
+    'store_name': "0002 Conn's HomePlus - Winston NC",
+    'store_address': '3925 Oxford Station Way',
+    'city': 'Winston-Salem', 'zipcode': '27103', 'phone_number': None,
+    'emailAddress': "[email protected]",
+    'store_number': None, 'store_status': 't',
+    'latitude': '36.068799', 'longitude': '-80.328457',
+    'timezone': 'America/New_York', 'account_id': 24, 'country_id': 'USA',
+    'store_type': 'FreeStanding', 'account_name': "Conn's",
+    'store_id': 24252, 'visit_rule': [],
+    'visit_category': [],
+    'client_name': ['HISENSE', 'FLEX-ROC', 'ASSEMBLY'],
+    'market_name': '10', 'region_name': 'Assembly - Region',
+    'district_name': 'Assembly - District',
+    'org_name': 'assembly'
+}
+
+# class Store(BaseModel):
+#     email_address: str = Field(alias="emailAddress")  # The user sees "emailAddress"
 
 class Store(BaseModel):
-    email_address: str = Field(alias="emailAddress")  # The user sees "emailAddress"
+    org_name: str = Field(required=True)
+    store_id: int = Field(primary_key=True, required=True)
+    store_name: str = Field(required=True)
+    store_address: str
+    city: str
+    zipcode: str
+    phone_number: Optional[str]
+    email_address: str = Field(alias="emailAddress")
+    store_number: Optional[str]
+    store_status: str
+    latitude: float
+    longitude: float
+    timezone: str
+    account_id: int
+    country_id: str
+    store_type: str
+    account_name: str
+    visit_rule: List[str]
+    visit_category: List[str]
+    client_name: List[str]
+    market_name: str
+    region_name: str
+    district_name: str
+
+    class Meta:
+        strict = True
+        as_objects = True
 
-store = Store(emailAddress="[email protected]")
+store = Store(**data)
 print('Store > ', store)
 print(store.email_address)  # "[email protected]"

examples/test_aliases.py

@@ -0,0 +1,18 @@
+from typing import List, Optional
+from datamodel import BaseModel, Field
+from datamodel.aliases import to_snakecase
+
+
+class Store(BaseModel):
+    email_address: str
+    status: str
+    store_id: int = Field(primary_key=True)
+
+    class Meta:
+        strict = True
+        as_objects = True
+        alias_function = to_snakecase
+
+# Example Usage:
+store = Store(EmailAddress="[email protected]", Status="ACTIVE", StoreId=1)
+print(store)

tests/test_aliases.py

@@ -0,0 +1,42 @@
+# tests/test_alias_function.py
+import pytest
+from datamodel import BaseModel, Field
+from datamodel.aliases import to_snakecase
+
+class Store(BaseModel):
+    # Fields (with normal pythonic names)
+    email_address: str
+    status: str
+    store_id: int = Field(primary_key=True)
+
+    class Meta:
+        strict = True
+        as_objects = True
+        # The function that transforms keys (e.g., EmailAddress -> email_address)
+        alias_function = to_snakecase
+
+class User(BaseModel):
+    email_address: str = Field(alias='emailAddress')
+
+def test_alias_function_store():
+    """Ensure that the alias_function (to_snakecase) properly converts keys."""
+    # We pass in uppercase/camelcase versions of the fields:
+    store = Store(emailAddress="[email protected]", Status="ACTIVE", StoreId=123)
+    # Now we verify that the model's actual attributes got populated correctly:
+    assert store.email_address == "[email protected]"
+    assert store.status == "ACTIVE"
+    assert store.store_id == 123
+
+    # Check the model's type and printing
+    assert isinstance(store, Store)
+    print(f"Created store: {store}")
+
+
+def test_alias_simple_store():
+    """Ensure that Alias on Field is properly managed."""
+    # We pass in uppercase/camelcase versions of the fields:
+    user = User(emailAddress="Test@Test")
+    assert user.email_address == "Test@Test"
+
+    # Check the model's type and printing
+    assert isinstance(user, User)