Added further documentation for aggregate method

Author: RobHam99

hazelcast/aggregator.py

@@ -7,6 +7,7 @@
 # Marker class, no implementation. Document it.
 class Aggregator(object):
     """Add documentation."""
+
     pass
 
 
@@ -140,7 +141,6 @@ def get_class_id(self):
         return 13
 
 
-
 def count_(attribute_path=None):
     """Creates count aggregator.
 
@@ -212,14 +212,14 @@ def floating_point_sum(attribute_path=None):
         attribute_path: extracts values from this path if given
 
     Returns:
-        _DoubleSumAggregator: an aggregator that calculates the sum of the
+        _FloatingPointSumAggregator: an aggregator that calculates the sum of the
         input values
     """
     return _FloatingPointSumAggregator(attribute_path)
 
 
 def max_(attribute_path=None):
-    """Creates max aggregator
+    """Creates max aggregator.
 
     Args:
         attribute_path: extracts values from this path if given
@@ -232,65 +232,65 @@ def max_(attribute_path=None):
 
 
 def min_(attribute_path=None):
-    """Creates double sum aggregator
+    """Creates min aggregator.
 
     Args:
         attribute_path: extracts values from this path if given
 
     Returns:
-        _DoubleSumAggregator: an aggregator that calculates the min of the
+        _Min: an aggregator that calculates the min of the
         input values
     """
     return _MinAggregator(attribute_path)
 
 
 def int_avg(attribute_path=None):
-    """Creates double sum aggregator
+    """Creates int average aggregator.
 
     Args:
         attribute_path: extracts values from this path if given
 
     Returns:
-        _DoubleSumAggregator: an aggregator that calculates the average of the
+        _IntegerAverage: an aggregator that calculates the average of the
         input values
     """
     return _IntegerAverageAggregator(attribute_path)
 
 
 def int_sum(attribute_path=None):
-    """Creates double sum aggregator
+    """Creates int sum aggregator.
 
     Args:
         attribute_path: extracts values from this path if given
 
     Returns:
-        _DoubleSumAggregator: an aggregator that calculates the sum of the
+        _IntegerSumAggregator: an aggregator that calculates the sum of the
         input values
     """
     return _IntegerSumAggregator(attribute_path)
 
 
 def long_avg(attribute_path=None):
-    """Creates double sum aggregator
+    """Creates long average aggregator.
 
     Args:
         attribute_path: extracts values from this path if given
 
     Returns:
-        _DoubleSumAggregator: an aggregator that calculates the average of the
+        _LongAverageAggregator: an aggregator that calculates the average of the
         input values
     """
     return _LongAverageAggregator(attribute_path)
 
 
 def long_sum(attribute_path=None):
-    """Creates double sum aggregator
+    """Creates long sum aggregator.
 
     Args:
         attribute_path: extracts values from this path if given
 
     Returns:
-        _DoubleSumAggregator: an aggregator that calculates the sum of the
+        _LongSumAggregator: an aggregator that calculates the sum of the
         input values
     """
     return _LongSumAggregator(attribute_path)

hazelcast/proxy/map.py

@@ -319,20 +319,22 @@ def aggregate(self, aggregator, predicate=None):
             predicate (hazelcast.predicate.Predicate): Predicate for the map to filter entries.
 
         Returns:
-            hazelcast.future.Future[]:
+            hazelcast.future.Future: The result of the aggregation.
 
         """
         check_not_none(aggregator, "aggregator can't be none")
         aggregator_data = self._to_data(aggregator)
         if predicate:
             if isinstance(predicate, PagingPredicate):
-                raise AssertionError('Paging predicate is not supported.')
+                raise AssertionError("Paging predicate is not supported.")
 
             def handler(message):
                 return self._to_object(map_aggregate_with_predicate_codec.decode_response(message))
 
             predicate_data = self._to_data(predicate)
-            request = map_aggregate_with_predicate_codec.encode_request(self.name, aggregator_data, predicate_data)
+            request = map_aggregate_with_predicate_codec.encode_request(
+                self.name, aggregator_data, predicate_data
+            )
             return self._invoke(request, handler)
 
         def handler(message):

tests/integration/backward_compatible/proxy/map_test.py

@@ -30,6 +30,7 @@
 import unittest
 from hazelcast.aggregator import *
 
+
 class EntryProcessor(IdentifiedDataSerializable):
     FACTORY_ID = 66
     CLASS_ID = 1
@@ -760,10 +761,7 @@ def configure_client(cls, config):
 
     def setUp(self):
         self.map = self.client.get_map(random_string()).blocking()
-        self.map.put_all({
-            "key-%d" % i: i
-            for i in range(50)
-        })
+        self.map.put_all({"key-%d" % i: i for i in range(50)})
 
     def tearDown(self):
         self.map.destroy()
@@ -804,6 +802,7 @@ def test_fixed_point_sum_with_predicate(self):
         sum = self.map.aggregate(fixed_point_sum(), predicate=greater_or_equal("this", 47))
         self.assertEqual(144, sum)
 
+
 @unittest.skipIf(
     is_client_version_older_than("4.2.1"), "Tests the features added in 4.2.1 version of the client"
 )
@@ -816,10 +815,7 @@ def configure_client(cls, config):
 
     def setUp(self):
         self.map = self.client.get_map(random_string()).blocking()
-        self.map.put_all({
-            "key-%d" % i: i
-            for i in range(50)
-        })
+        self.map.put_all({"key-%d" % i: i for i in range(50)})
 
     def tearDown(self):
         self.map.destroy()
@@ -849,7 +845,6 @@ def test_long_sum_with_predicate(self):
         self.assertEqual(144, sum)
 
 
-
 @unittest.skipIf(
     is_client_version_older_than("4.2.1"), "Tests the features added in 4.2.1 version of the client"
 )
@@ -861,10 +856,7 @@ def configure_client(cls, config):
 
     def setUp(self):
         self.map = self.client.get_map(random_string()).blocking()
-        self.map.put_all({
-            "key-%d" % i: float(i)
-            for i in range(50)
-        })
+        self.map.put_all({"key-%d" % i: float(i) for i in range(50)})
 
     def tearDown(self):
         self.map.destroy()