Rangekeeper 0.8.24__tar.gz → 0.8.26__tar.gz

{rangekeeper-0.8.24 → rangekeeper-0.8.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.24
+Version: 0.8.26
 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.24 → rangekeeper-0.8.26}/Rangekeeper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.24
+Version: 0.8.26
 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.24 → rangekeeper-0.8.26}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Rangekeeper"
-version = "0.8.24"
+version = "0.8.26"
 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.24 → rangekeeper-0.8.26}/rangekeeper/extrapolation.py

@@ -8,10 +8,12 @@ from abc import abstractmethod
 
 
 class Type(enum.Enum):
-    STRAIGHT_LINE = 'StraightLine'  # A constant-change (linearly growing (or decaying)) projection form, originating from an initial value.
-    COMPOUNDING = 'Compounding'  # An exponentially growing (compounding) or decaying projection at a specified rate per period.
-    RECURRING = 'Recurring'  # A projection form that repeats a specified sequence of values.
-    DYNAMIC = 'Dynamic'  # A projection form generated by a stochastic process.
+    STRAIGHT_LINE = "StraightLine"  # A constant-change (linearly growing (or decaying)) projection form, originating from an initial value.
+    COMPOUNDING = "Compounding"  # An exponentially growing (compounding) or decaying projection at a specified rate per period.
+    RECURRING = (
+        "Recurring"  # A projection form that repeats a specified sequence of values.
+    )
+    DYNAMIC = "Dynamic"  # A projection form generated by a stochastic process.
 
 
 class Form:
@@ -21,9 +23,7 @@ class Form:
     """
 
     @abstractmethod
-    def terms(
-            self,
-            sequence: pd.RangeIndex) -> [float]:
+    def terms(self, sequence: pd.RangeIndex) -> [float]:
         """
         Returns the set of terms that define the projection's form at each value in the sequence.
         """
@@ -37,15 +37,11 @@ class StraightLine(Form):
     To calculate the factor, the projection is modelled as a linear function of (slope * period) + 1
     """
 
-    def __init__(
-            self,
-            slope: float):
+    def __init__(self, slope: float):
         self.type = Type.STRAIGHT_LINE
         self.slope = slope
 
-    def terms(
-            self,
-            sequence: pd.RangeIndex) -> [float]:
+    def terms(self, sequence: pd.RangeIndex) -> [float]:
         """
         Returns the additive terms to the projection at each value in the sequence.
         """
@@ -65,15 +61,11 @@ class Compounding(Form):
     To calculate the factor, the projection is modelled as an exponential function of (1 + rate) ** period
     """
 
-    def __init__(
-            self,
-            rate: float):
+    def __init__(self, rate: float):
         self.type = Type.COMPOUNDING
         self.rate = rate
 
-    def terms(
-            self,
-            sequence: pd.RangeIndex) -> [float]:
+    def terms(self, sequence: pd.RangeIndex) -> [float]:
         """
         Returns the multiplicative factors of the projection's form at each value in the sequence.
         """
@@ -83,15 +75,11 @@ class Compounding(Form):
 class Dynamic(Form):
     series: pd.Series
 
-    def __init__(
-            self,
-            series: pd.Series):
+    def __init__(self, series: pd.Series):
         self.type = Type.DYNAMIC
         self.series = series
 
-    def terms(
-            self,
-            sequence: pd.RangeIndex) -> [float]:
+    def terms(self, sequence: pd.RangeIndex) -> [float]:
         """
         Returns the multiplicative factors of the projection's form at each value in the sequence.
         """

{rangekeeper-0.8.24 → rangekeeper-0.8.26}/rangekeeper/flux.py

@@ -324,21 +324,35 @@ class Flow:
             movements=frame["Discounted Flow"], units=self.units, name=name
         )
 
-    def xirr(self) -> float:
-        return pyxirr.xirr(
+    def xirr(
+        self, registry: pint.UnitRegistry = rk.measure.Index.registry
+    ) -> pint.Quantity:
+        """
+        Returns the XIRR (Extended Internal Rate of Return) of the Flow's movements.
+        Formats the result as a percentage in the specified registry's units.
+        """
+        result = pyxirr.xirr(
             dates=list(self.movements.index.array),
             amounts=self.movements.to_list(),
         )
+        return result * 100 * registry.percent
 
     def xnpv(
         self,
-        rate: float,
-    ) -> float:
-        return pyxirr.xnpv(
+        rate: Union[float, pint.Quantity],
+    ) -> pint.Quantity:
+        """
+        Returns the XNPV (Extended Net Present Value) of the Flow's movements at a specified rate.
+        Formats the result as a quantity in the Flow's units.
+        """
+        if isinstance(rate, pint.Quantity):
+            rate = rate.to(rk.measure.Index.registry.dimensionless).magnitude
+        result = pyxirr.xnpv(
             rate=rate,
             dates=list(self.movements.index.array),
             amounts=self.movements.to_list(),
         )
+        return result * self.units
 
     def diff(
         self,

{rangekeeper-0.8.24 → rangekeeper-0.8.26}/rangekeeper/measure.py

@@ -102,7 +102,7 @@ def register_currency(
     return Measure(
         name=currency.name,
         definition="Currency of {0}".format(currency.countries),
-        units=registry[currency.code].units,
+        units=registry.parse_units(currency.code),
     )