moving utils to separate file

Author: anikolaienko

automapper/mapper.py

@@ -1,6 +1,5 @@
 import inspect
 from copy import deepcopy
-from enum import Enum
 from typing import (
     Any,
     Callable,
@@ -22,6 +21,7 @@
     DuplicatedRegistrationError,
     MappingError,
 )
+from .utils import is_enum, is_primitive, is_sequence, object_contains
 
 # Custom Types
 S = TypeVar("S")
@@ -30,32 +30,6 @@
 SpecFunction = Callable[[Type[T]], Iterable[str]]
 FieldsMap = Optional[Dict[str, Any]]
 
-__PRIMITIVE_TYPES = {int, float, complex, str, bytes, bytearray, bool}
-
-
-def _is_sequence(obj: Any) -> bool:
-    """Check if object implements `__iter__` method"""
-    return hasattr(obj, "__iter__")
-
-
-def _is_subscriptable(obj: Any) -> bool:
-    """Check if object implements `__getitem__` method"""
-    return hasattr(obj, "__getitem__")
-
-
-def _object_contains(obj: Any, field_name: str) -> bool:
-    return _is_subscriptable(obj) and field_name in obj
-
-
-def _is_primitive(obj: Any) -> bool:
-    """Check if object type is primitive"""
-    return type(obj) in __PRIMITIVE_TYPES
-
-
-def _is_enum(obj: Any) -> bool:
-    """Check if object type is enum"""
-    return issubclass(type(obj), Enum)
-
 
 def _try_get_field_value(
     field_name: str, original_obj: Any, custom_mapping: FieldsMap
@@ -64,7 +38,7 @@ def _try_get_field_value(
         return True, custom_mapping[field_name]  # type: ignore [index]
     if hasattr(original_obj, field_name):
         return True, getattr(original_obj, field_name)
-    if _object_contains(original_obj, field_name):
+    if object_contains(original_obj, field_name):
         return True, original_obj[field_name]
     return False, None
 
@@ -275,7 +249,7 @@ def _map_subobject(
         self, obj: S, _visited_stack: Set[int], skip_none_values: bool = False
     ) -> Any:
         """Maps subobjects recursively"""
-        if _is_primitive(obj) or _is_enum(obj):
+        if is_primitive(obj) or is_enum(obj):
             return obj
 
         obj_id = id(obj)
@@ -290,7 +264,7 @@ def _map_subobject(
         else:
             _visited_stack.add(obj_id)
 
-            if _is_sequence(obj):
+            if is_sequence(obj):
                 if isinstance(obj, dict):
                     result = {
                         k: self._map_subobject(

automapper/utils.py

@@ -0,0 +1,28 @@
+from enum import Enum
+from typing import Any
+
+__PRIMITIVE_TYPES = {int, float, complex, str, bytes, bytearray, bool}
+
+
+def is_sequence(obj: Any) -> bool:
+    """Check if object implements `__iter__` method"""
+    return hasattr(obj, "__iter__")
+
+
+def is_subscriptable(obj: Any) -> bool:
+    """Check if object implements `__getitem__` method"""
+    return hasattr(obj, "__getitem__")
+
+
+def object_contains(obj: Any, field_name: str) -> bool:
+    return is_subscriptable(obj) and field_name in obj
+
+
+def is_primitive(obj: Any) -> bool:
+    """Check if object type is primitive"""
+    return type(obj) in __PRIMITIVE_TYPES
+
+
+def is_enum(obj: Any) -> bool:
+    """Check if object type is enum"""
+    return issubclass(type(obj), Enum)

tests/test_issue_18_implicit_child_field_mapping.py

@@ -12,30 +12,32 @@ class UserDomain:
 
 
 @dataclass
-class TodoDomain:
+class InputDomain:
     description: str
     user: UserDomain
 
 
 @dataclass
-class TodoModel:
+class OutputModel:
     description: str
     user: UserDomain
     user_id: Optional[int] = None
 
 
 def test_map__implicit_mapping_of_child_obj_field_to_parent_obj_field_not_supported():
     user = UserDomain(id=123, name="carlo", email="mail_carlo")
-    todo = TodoDomain(description="todo_carlo", user=user)
+    domain = InputDomain(description="todo_carlo", user=user)
 
-    mapper.add(TodoDomain, TodoModel)
-    todo_model: TodoModel = mapper.map(todo)
+    mapper.add(InputDomain, OutputModel)
+    model_with_none_user_id: OutputModel = mapper.map(domain)
 
     # Implicit field mapping between parent and child objects is not supported
-    # TodoDomain.user.user_id should not map to TodoModel.user_id implicitly
-    assert todo_model.user_id is None
+    # InputDomain.user.user_id should not map to OutputModel.user_id implicitly
+    assert model_with_none_user_id.user_id is None
 
     # Workaround: use explicit mapping
-    todo_model1: TodoModel = mapper.map(todo, fields_mapping={"user_id": todo.user.id})
+    todo_model_complete: OutputModel = mapper.map(
+        domain, fields_mapping={"user_id": domain.user.id}
+    )
 
-    assert todo_model1.user_id == 123
+    assert todo_model_complete.user_id == 123