Updated docstrings for ResultMatrix model.

Author: python3-dev

core/models.py

@@ -221,13 +221,31 @@ def find_fund(self, fund_name):
 
 
 class ResultMatrix():
+    """
+    Result Matrix stores the overlap comparisons and other details
+    like the fund which is being compared and the portfolio with
+    which comparison is made.
+
+    Args:
+        current_portfolio (Portfolio): Portfolio instance to which
+        comparison is made.
+        other_fund (Fund): Fund instance which is being compared.
+    """
     def __init__(self, current_portfolio, other_fund) -> None:
+        """
+        Initialises the ResultMatrix model and generate the
+        overlap matrix which holds information of overlap of given
+        fund with each fund in the portfolio.
+        """
         self.other_fund = other_fund
         self.current_portfolio = current_portfolio
         self.overlap_matrix = {}
         self.__store_overlap()
 
     def __store_overlap(self):
+        """
+        Generates the overlap data.
+        """
         if not(self.other_fund is None):
             for current_fund in self.current_portfolio.get_fund_list():
                 self.overlap_matrix[
@@ -237,7 +255,22 @@ def __store_overlap(self):
                         )
 
     def fetch(self):
+        """
+        Returns the overlap matrix.
+
+        Returns:
+            (dict): Matrix containing information on
+            fund names and corresponding overlap with
+            the given fund.
+        """
         return(self.overlap_matrix)
 
     def get_other_fund_name(self):
+        """
+        Returns the name of the fund instance to which
+        comparison is made.
+
+        Returns:
+            (str): Name of the fund instance.
+        """
         return(self.other_fund.get_fund_name())

core/utils.py

@@ -54,7 +54,8 @@ def create_portfolio(fund_names):
 
 def compare(fund_name, current_portfolio):
     """
-    Compares fund_name with each Fund instances in the current_portfolio.
+    Compares the Fund instance corresponding fund_name with
+    each Fund instances in the current_portfolio.
 
     Args:
         fund_name (str): Name of the fund for which overlap
@@ -72,10 +73,19 @@ def compare(fund_name, current_portfolio):
 
 
 def process_result(result_matrix):
-    for fund_name, overlap in result_matrix.fetch().items():
+    """
+    Process the Result Matrix instance and output according to the
+    problem requirements.
+
+    Args:
+        result_matrix (ResultMatrix): Result matrix for a given case.
+    """
+    result_dict = result_matrix.fetch()
+    other_fund_name = result_matrix.get_other_fund_name()
+    for fund_name, overlap in result_dict.items():
         if overlap > 0:
             print(
-                f"{result_matrix.get_other_fund_name()} {fund_name} {overlap:.2f}%"
+                f"{other_fund_name} {fund_name} {overlap:.2f}%"
                 )
 
 

portfolio_overlap.tar.gz

@@ -30,4 +30,3 @@ def test_getinput_2(self, mock_stdout):
             expected_out = f.read()
         getinput('test/fixtures/input3.txt')
         self.assertEqual(mock_stdout.getvalue(), expected_out)
-