rangekeeper 0.8.4__tar.gz → 0.8.6__tar.gz

{rangekeeper-0.8.4 → rangekeeper-0.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.4
+Version: 0.8.6
 Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
 Author-email: Daniel Fink <danfink@mit.edu>
 License-Expression: MPL-2.0

{rangekeeper-0.8.4 → rangekeeper-0.8.6}/Rangekeeper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.4
+Version: 0.8.6
 Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
 Author-email: Daniel Fink <danfink@mit.edu>
 License-Expression: MPL-2.0

{rangekeeper-0.8.4 → rangekeeper-0.8.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Rangekeeper"
-version = "0.8.4"
+version = "0.8.6"
 description = "A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis."
 authors = [
     { name = "Daniel Fink", email = "danfink@mit.edu" }

{rangekeeper-0.8.4 → rangekeeper-0.8.6}/rangekeeper/flux.py

@@ -448,6 +448,21 @@ class Flow:
             frequency=frequency,
         )
 
+    def clean(self, clean_zeroes: bool = True) -> Flow:
+        """
+        Returns a Flow with movements cleaned of NaN and zero values
+        """
+        movements = self.movements.copy(deep=True)
+        if clean_zeroes:
+            movements = movements[(movements != 0) & (movements != -0.0)]
+        movements = movements[~movements.isna()]
+
+        return self.__class__(
+            movements=movements,
+            units=self.units,
+            name=self.name,
+        )
+
 
 class Stream:
     name: str

{rangekeeper-0.8.4 → rangekeeper-0.8.6}/rangekeeper/formula/financial.py

@@ -131,7 +131,7 @@ class Account:
 
         self.name = f"{name}Account"
 
-        self.startings = rk.flux.Flow(
+        startings = rk.flux.Flow(
             movements=pd.Series(
                 startings,
                 index=transactions.movements.index,
@@ -139,7 +139,9 @@ class Account:
             units=transactions.units,
             name=f"{name}Start Balance",
         )
-        self.endings = rk.flux.Flow(
+        self.startings = startings.clean()
+
+        endings = rk.flux.Flow(
             movements=pd.Series(
                 endings,
                 index=transactions.movements.index,
@@ -147,7 +149,9 @@ class Account:
             units=transactions.units,
             name=f"{name}End Balance",
         )
-        self.overdraft = rk.flux.Flow(
+        self.endings = endings.clean()
+
+        overdraft = rk.flux.Flow(
             movements=pd.Series(
                 overdraft,
                 index=transactions.movements.index,
@@ -155,7 +159,9 @@ class Account:
             units=transactions.units,
             name=f"{name}Overdraft",
         )
-        self.interest = rk.flux.Flow(
+        self.overdraft = overdraft.clean()
+
+        interest = rk.flux.Flow(
             movements=pd.Series(
                 interest,
                 index=transactions.movements.index,
@@ -163,19 +169,19 @@ class Account:
             units=transactions.units,
             name=f"{name}Interest Amounts",
         )
+        self.interest = interest.clean()
 
     def diff(self, name: str = None) -> rk.flux.Flow:
         """
         Calculate the difference between the start and end balances.
         """
         name = self.name if name is None else name
-        movements = self.endings.movements - self.startings.movements
-
-        return rk.flux.Flow(
-            movements=movements.where(movements != 0, np.nan),
+        result = rk.flux.Flow(
+            movements=self.endings.movements - self.startings.movements,
             units=self.startings.units,
             name=f"{self.startings.name} (diff)",
         )
+        return result.clean()
 
 
 # class Balance: