added unit test to verify partial attribute mapping

added file encodings, docstrings, and new line at end of files
using new style of class declaration and docstrings
removed parameters to datetime that were using the default values

Author: ramiabughazaleh

Diff for: CHANGES.py

@@ -0,0 +1,4 @@
+# coding=utf-8
+"""
+Copyright (C) 2015, marazt. All rights reserved.
+"""

Diff for: MANIFEST.py

@@ -0,0 +1,4 @@
+# coding=utf-8
+"""
+Copyright (C) 2015, marazt. All rights reserved.
+"""

Diff for: README.py

@@ -0,0 +1,4 @@
+# coding=utf-8
+"""
+Copyright (C) 2015, marazt. All rights reserved.
+"""

Diff for: mapper/casedict.py

@@ -1,5 +1,8 @@
-# Copyright (c) 2013 Optiflows
-# https://bitbucket.org/optiflowsrd/obelus/src/tip/obelus/casedict.py
+# coding=utf-8
+"""
+Copyright (c) 2013 Optiflows
+https://bitbucket.org/optiflowsrd/obelus/src/tip/obelus/casedict.py
+"""
 
 from collections import MutableMapping
 
@@ -45,9 +48,20 @@ def __contains__(self, key):
         return key.lower() in self._data
 
     def clear(self):
+        """
+        Removes all items from dictionary
+        """
         self._data.clear()
 
     def get(self, key, default=_sentinel):
+        """
+        Gets the value from the key.
+        If the key doesn't exist, the default value is returned, otherwise None.
+
+        :param key: The key
+        :param default: The default value
+        :return: The value
+        """
         tup = self._data.get(key.lower())
         if tup is not None:
             return tup[1]
@@ -57,6 +71,14 @@ def get(self, key, default=_sentinel):
             return None
 
     def pop(self, key, default=_sentinel):
+        """
+        Removes the specified key and returns the corresponding value.
+        If key is not found, the default is returned if given, otherwise KeyError is raised.
+
+        :param key: The key
+        :param default: The default value
+        :return: The value
+        """
         if default is not _sentinel:
             tup = self._data.pop(key.lower(), default)
         else:

Diff for: mapper/object_mapper.py

@@ -1,9 +1,12 @@
-# Copyright (C) 2015, marazt. All rights reserved.
+# coding=utf-8
+"""
+Copyright (C) 2015, marazt. All rights reserved.
+"""
 from mapper.object_mapper_exception import ObjectMapperException
 from casedict import CaseDict
 
 
-class ObjectMapper:
+class ObjectMapper(object):
     """
     Base class for mapping class attributes from one class to another one
     Supports mapping conversions too
@@ -72,8 +75,7 @@ class 'B' with attributes 'name' and 'age' and we want to map 'A' to 'B' in a wa
             In this case, the value of A.Name will be copied into B.name and
             the value of A.Age will be copied into B.age.
 
-        Returns:
-            Instance of the ObjectMapper
+        :return: Instance of the ObjectMapper
         """
         # self.to_type = to_type
         self.mappings = {}
@@ -82,14 +84,12 @@ class 'B' with attributes 'name' and 'age' and we want to map 'A' to 'B' in a wa
     def create_map(self, type_from, type_to, mapping=None):
         """Method for adding mapping definitions
 
-        Args:
-            type_from: source type
-            type_to: target type
-            mapping: dictionary of mapping definitions in a form {'target_property_name',
-            lambda function from rhe source}
-
-        Returns:
+        :param type_from: source type
+        :param type_to: target type
+        :param mapping: dictionary of mapping definitions in a form {'target_property_name',
+                        lambda function from rhe source}
 
+        :return: None
         """
         key_from = type_from.__name__
         key_to = type_to.__name__
@@ -110,14 +110,12 @@ def create_map(self, type_from, type_to, mapping=None):
     def map(self, from_obj, to_type, ignore_case=False, allow_none=False):
         """Method for creating target object instance
 
-        Args:
-          from_obj: source object to be mapped from
-          to_type: target type
-          ignore_case: if set to true, ignores attribute case when performing the mapping
-          allow_none: if set to true, returns None if the source object is None; otherwise throws an exception
+        :param from_obj: source object to be mapped from
+        :param to_type: target type
+        :param ignore_case: if set to true, ignores attribute case when performing the mapping
+        :param allow_none: if set to true, returns None if the source object is None; otherwise throws an exception
 
-        Returns:
-          Instance of the target class with mapped attributes
+        :return: Instance of the target class with mapped attributes
         """
         if (from_obj is None) and allow_none:
             return None
@@ -156,4 +154,4 @@ def map(self, from_obj, to_type, ignore_case=False, allow_none=False):
             else:
                 raise ObjectMapperException("No mapping defined for {0} -> {1}".format(key_from, key_to))
 
-        return inst
+        return inst

Diff for: mapper/object_mapper_exception.py

@@ -1,8 +1,11 @@
-# Copyright (C) 2015, marazt. All rights reserved.
+# coding=utf-8
+"""
+Copyright (C) 2015, marazt. All rights reserved.
+"""
 
 
 class ObjectMapperException(Exception):
     """
     Object Mapper exception
     """
-    pass
+    pass

Diff for: run.py

@@ -0,0 +1,4 @@
+# coding=utf-8
+"""
+Copyright (C) 2015, marazt. All rights reserved.
+"""

Diff for: setup.py

@@ -1,3 +1,4 @@
+# coding=utf-8
 """
 Package setup configuration needed for correct package creation
 Taken from: https://www.digitalocean.com/community/tutorials/how-to-package-and-distribute-python-applications
@@ -40,4 +41,4 @@
         "datetime",
         "nose",
     ],
-)
+)

Diff for: tests/object_mapper_test.py

@@ -1,34 +1,41 @@
-# Copyright (C) 2015, marazt. All rights reserved.
+# coding=utf-8
+"""
+Copyright (C) 2015, marazt. All rights reserved.
+"""
 import unittest
 
 from datetime import datetime
 from mapper.object_mapper import ObjectMapper
 from mapper.object_mapper_exception import ObjectMapperException
 
 
-class ToTestClass:
+class ToTestClass(object):
+    """ To Test Class """
     def __init__(self):
         self.name = ""
         self.date = ""
         pass
 
 
-class ToTestClassTwo:
+class ToTestClassTwo(object):
+    """ To Test Class Two """
     def __init__(self):
         self.all = ""
         pass
 
 
-class ToTestClassEmpty:
+class ToTestClassEmpty(object):
+    """ To Test Class Empty """
     def __init__(self):
         pass
 
 
-class FromTestClass:
+class FromTestClass(object):
+    """ From Test Class """
     def __init__(self):
         self.name = "Igor"
         self.surname = "Hnizdo"
-        self.date = datetime(2015, 1, 1, 0, 0)
+        self.date = datetime(2015, 1, 1)
         pass
 
 
@@ -37,10 +44,8 @@ class ObjectMapperTest(unittest.TestCase):
     Unit tests for the `ObjectMapper` module.
     """
 
-    def setUp(self):
-        pass
-
     def test_mapping_creation_without_mappings_correct(self):
+        """ Test mapping creation without mappings """
 
         # Arrange
         from_class = FromTestClass()
@@ -57,6 +62,7 @@ def test_mapping_creation_without_mappings_correct(self):
         self.assertNotIn("surname", result.__dict__, "To class must not contain surname")
 
     def test_mapping_creation_with_mappings_correct(self):
+        """ Test mapping creation with mappings """
 
         # Arrange
         from_class = FromTestClass()
@@ -92,6 +98,7 @@ def test_mapping_creation_with_mappings_correct(self):
         self.assertTrue(len(result3.__dict__) == 0, "There must be no attributes")
 
     def test_mapping_creation_duplicate_mapping(self):
+        """ Test mapping creation with duplicate mappings """
 
         # Arrange
         exc = False
@@ -111,6 +118,7 @@ def test_mapping_creation_duplicate_mapping(self):
         self.assertTrue(exc, "Exception must be thrown")
 
     def test_mapping_creation_invalid_mapping_function(self):
+        """ Test mapping creation with invalid mapping function """
 
         # Arrange
         exc = False
@@ -129,6 +137,8 @@ def test_mapping_creation_invalid_mapping_function(self):
         self.assertTrue(exc, "Exception must be thrown")
 
     def test_mapping_creation_none_target(self):
+        """ Test mapping creation with none target """
+
         # Arrange
         exc = None
         from_class = None
@@ -152,6 +162,8 @@ def test_mapping_creation_none_target(self):
         self.assertEqual("'NoneType' object has no attribute '__dict__'", exc.message)
 
     def test_mapping_with_none_source_and_allow_none_returns_none(self):
+        """ Test mapping with none source and allow none returns none """
+
         # Arrange
         from_class = None
         mappings = \
@@ -170,6 +182,8 @@ def test_mapping_with_none_source_and_allow_none_returns_none(self):
         self.assertEqual(None, result)
 
     def test_mapping_creation_no_mapping_defined(self):
+        """ Test mapping creation with no mapping defined """
+
         # Arrange
         exc = False
         msg = "No mapping defined for FromTestClass -> ToTestClass"
@@ -188,6 +202,7 @@ def test_mapping_creation_no_mapping_defined(self):
         self.assertTrue(exc, "Exception must be thrown")
 
     def test_mapping_creation_with_mapping_suppression(self):
+        """ Test mapping creation with mapping suppression """
 
         # Arrange
         from_class = FromTestClass()
@@ -205,13 +220,16 @@ def test_mapping_creation_with_mapping_suppression(self):
         self.assertNotIn("surname", result1.__dict__, "To class must not contain surname")
 
     def test_mapping_with_case_insensitivity(self):
+        """ Test mapping with case insensitivity """
 
         # Arrange
-        class ToTestClass2:
+        class ToTestClass2(object):
+            """ To Test Class 2 """
             def __init__(self):
                 self.name = ""
 
-        class FromTestClass2:
+        class FromTestClass2(object):
+            """ From Test Class 2 """
             def __init__(self):
                 self.Name = "Name"
 
@@ -223,4 +241,23 @@ def __init__(self):
         result = mapper.map(FromTestClass2(), ToTestClass2, ignore_case=True)
 
         # Assert
-        self.assertEqual(result.name, from_class.Name, "Name mapping must be equal")
+        self.assertEqual(result.name, from_class.Name, "Name mapping must be equal")
+
+    def test_mapping_creation_with_partial_mapping_correct(self):
+        """ Test mapping creation with partial mapping """
+
+        # Arrange
+        from_class = FromTestClass()
+        mapper = ObjectMapper()
+        mapper.create_map(FromTestClass, ToTestClass,
+                          {"name": lambda x: "{0} {1}".format(x.name, x.surname)})
+
+        # Act
+        result1 = mapper.map(from_class, ToTestClass)
+
+        # Assert
+        self.assertTrue(isinstance(result1, ToTestClass), "Type must be ToTestClass")
+        self.assertEqual(result1.name, "{0} {1}".format(from_class.name, from_class.surname),
+                         "Name mapping must be equal")
+        self.assertEqual(result1.date, from_class.date, "Date mapping must be equal")
+        self.assertNotIn("surname", result1.__dict__, "To class must not contain surname")