Rangekeeper 0.8.25__py3-none-any.whl → 0.8.27__py3-none-any.whl

rangekeeper/__init__.py

@@ -1,10 +1,10 @@
 from . import api as api
+from . import measure as measure
 from . import distribution as distribution
 from . import duration as duration
 from . import extrapolation as extrapolation
 from . import flux as flux
 from . import graph as graph
-from . import measure as measure
 from . import policy as policy
 from . import projection as projection
 from . import segmentation as segmentation

rangekeeper/flux.py

@@ -1,9 +1,7 @@
 from __future__ import annotations
 
 import datetime
-import itertools
 import json
-import locale
 import os
 from typing import Dict, Union, Optional, Tuple, List
 
@@ -324,21 +322,42 @@ class Flow:
             movements=frame["Discounted Flow"], units=self.units, name=name
         )
 
-    def xirr(self) -> float:
-        return pyxirr.xirr(
+    def xirr(
+        self,
+        registry: pint.UnitRegistry = None,
+    ) -> 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.
+        """
+        # Lazy import to avoid circular dependency
+        if registry is None:
+            from rangekeeper.measure import Index
+
+            registry = Index.registry
+
+        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.25.dist-info → rangekeeper-0.8.27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.25
+Version: 0.8.27
 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.25.dist-info → rangekeeper-0.8.27.dist-info}/RECORD

@@ -1,9 +1,9 @@
-rangekeeper/__init__.py,sha256=3ed6dqjrwb0_Z1le9oItyOFHFrAtP0XJIVhZG07iqZ0,1731
+rangekeeper/__init__.py,sha256=8q0KF90SLgIfptpFGuI66FOCqe3K9UgIzTHFL1pwP4Y,1731
 rangekeeper/api.py,sha256=3nuG7C2IQjpumcn79MvYDTa7ADWPAos7VfVM-3pL4n4,4798
 rangekeeper/distribution.py,sha256=2C3jhi1rLJUs0seBztdQb196hNhc00sKJEGMkFiDpYs,8961
 rangekeeper/duration.py,sha256=9GU6dcZTL_OAOgEHLGkCVxjG16_Po1IMEU29K5g4iRM,20433
 rangekeeper/extrapolation.py,sha256=Zfsz2KwkImxEMMCNZaF8RpiQxlIgemS1dQkSnjliYU4,2814
-rangekeeper/flux.py,sha256=X1m4bkGQqRG5DswYWh46nwcbgIfKqj2sk6xLhaFYzYE,31227
+rangekeeper/flux.py,sha256=25-jSnBrO9QGDXpuNahaVFUiJrHAWaiTda1uplUXFck,32043
 rangekeeper/format.py,sha256=DOfF4-LCXqWyCtE1OomwE80sJLe6LjL4gqEOAP454LQ,10796
 rangekeeper/graph.py,sha256=6oWRv-qzGsM5Z19UyJ1v3hwtWaQp_F4qQKxizvkQ_gg,28043
 rangekeeper/measure.py,sha256=eCdoTAocq1loNZBnOp3nPiPV7yIi0QTwpVHvjba1hkY,4125
@@ -20,7 +20,7 @@ rangekeeper/dynamics/trend.py,sha256=-WqrRvmmTj2mE24Pz-Dl5lXEpLXnDUMngafU__em_ac
 rangekeeper/dynamics/volatility.py,sha256=MGDLzrI1uP_C6HL-pigJwWikHg1KNbfB_0m0Akh-L2A,5162
 rangekeeper/formula/__init__.py,sha256=4OXzdJAYDBxQeOMzLR5MZvIjxxIfFOTE9aNu9zFryAE,36
 rangekeeper/formula/financial.py,sha256=oNFdhygbtdEUFjpxYFuuDnpC_P8nOO538b21FzaMtTU,14045
-rangekeeper-0.8.25.dist-info/METADATA,sha256=_bLPq7sZOAVAi0aKKviTEp-lpee04lB30okteq9VsOs,2212
-rangekeeper-0.8.25.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rangekeeper-0.8.25.dist-info/top_level.txt,sha256=7ov6d70lppmzKc088MAmRWnCtCRGA2cd43G28QBSv-c,12
-rangekeeper-0.8.25.dist-info/RECORD,,
+rangekeeper-0.8.27.dist-info/METADATA,sha256=2RSAoHJkWMaR5bEw9Y03S_pZHx149hKs6bvcXFkoK8s,2212
+rangekeeper-0.8.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rangekeeper-0.8.27.dist-info/top_level.txt,sha256=7ov6d70lppmzKc088MAmRWnCtCRGA2cd43G28QBSv-c,12
+rangekeeper-0.8.27.dist-info/RECORD,,