owlplanner 2025.5.3__py3-none-any.whl → 2025.5.12__py3-none-any.whl

owlplanner/__init__.py

@@ -1,6 +1,8 @@
-from owlplanner.plan import Plan
-from owlplanner.plan import clone
-from owlplanner.config import readConfig
-from owlplanner.rates import getRatesDistributions
-from owlplanner.rates import showRatesDistributions
-from owlplanner.version import __version__
+from owlplanner.plan import Plan                                              # noqa: F401
+from owlplanner.plan import clone                                             # noqa: F401
+from owlplanner.config import readConfig                                      # noqa: F401
+from owlplanner.rates import getRatesDistributions                            # noqa: F401
+from owlplanner.version import __version__                                    # noqa: F401
+
+# Make the package importable as 'owlplanner'
+__all__ = ['Plan', 'clone', 'readConfig', 'getRatesDistributions', '__version__']

owlplanner/abcapi.py

@@ -43,14 +43,16 @@ class Row(object):
         """
         Add an element at index ``ind`` of value ``val`` to the row.
         """
-        assert 0 <= ind and ind < self.nvars, f"Index {ind} out of range."
+        if not (0 <= ind < self.nvars):
+            raise ValueError(f"Index {ind} out of range.")
         self.ind.append(ind)
         self.val.append(val)
 
-    def addElemDic(self, rowDic={}):
+    def addElemDic(self, rowDic=None):
         """
         Add elements at indices provided by a dictionary.
         """
+        rowDic = {} if rowDic is None else rowDic
         for key in rowDic:
             self.addElem(key, rowDic[key])
         return self
@@ -73,11 +75,12 @@ class ConstraintMatrix(object):
         self.ub = []
         self.key = []
 
-    def newRow(self, rowDic={}):
+    def newRow(self, rowDic=None):
         """
         Create a new row and populate its elements using the dictionary provided.
         Return the row created.
         """
+        rowDic = {} if rowDic is None else rowDic
         row = Row(self.nvars)
         row.addElemDic(rowDic)
         return row
@@ -157,7 +160,8 @@ class Bounds(object):
             self.setBinary(ii)
 
     def setBinary(self, ii):
-        assert 0 <= ii and ii < self.nvars, f"Index {ii} out of range."
+        if not (0 <= ii < self.nvars):
+            raise ValueError(f"Index {ii} out of range.")
         self.ind.append(ii)
         self.lb.append(0)
         self.ub.append(1)
@@ -165,8 +169,10 @@ class Bounds(object):
         self.integrality.append(ii)
 
     def setRange(self, ii, lb, ub):
-        assert 0 <= ii and ii < self.nvars, f"Index {ii} out of range."
-        assert lb <= ub, f"Lower bound {lb} > upper bound {ub}."
+        if not (0 <= ii < self.nvars):
+            raise ValueError(f"Index {ii} out of range.")
+        if lb > ub:
+            raise ValueError(f"Lower bound {lb} > upper bound {ub}.")
         self.ind.append(ii)
         self.lb.append(lb)
         self.ub.append(ub)
@@ -219,7 +225,8 @@ class Objective(object):
         self.val = []
 
     def setElem(self, ind, val):
-        assert 0 <= ind and ind < self.nvars, f"Index {ind} out of range."
+        if not (0 <= ind < self.nvars):
+            raise ValueError(f"Index {ind} out of range.")
         self.ind.append(ind)
         self.val.append(val)
 

owlplanner/config.py

@@ -16,7 +16,7 @@ from datetime import date
 import os
 
 from owlplanner import plan
-from owlplanner import logging
+from owlplanner import mylogging as log
 from owlplanner.rates import FROM, TO
 
 
@@ -122,13 +122,13 @@ def saveConfig(myplan, file, mylog):
             with open(filename, "w") as casefile:
                 toml.dump(diconf, casefile, encoder=toml.TomlNumpyEncoder())
         except Exception as e:
-            raise RuntimeError(f"Failed to save case file {filename}: {e}")
+            raise RuntimeError(f"Failed to save case file {filename}: {e}") from e
     elif isinstance(file, StringIO):
         try:
             string = toml.dumps(diconf, encoder=toml.TomlNumpyEncoder())
             file.write(string)
         except Exception as e:
-            raise RuntimeError(f"Failed to save case to StringIO: {e}")
+            raise RuntimeError(f"Failed to save case to StringIO: {e}") from e
     elif file is None:
         pass
     else:
@@ -143,7 +143,7 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     A new plan is created and returned.
     Argument file can be a filename, a file, or a stringIO.
     """
-    mylog = logging.Logger(verbose, logstreams)
+    mylog = log.Logger(verbose, logstreams)
 
     accountTypes = ["taxable", "tax-deferred", "tax-free"]
 
@@ -160,19 +160,19 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
             with open(filename, "r") as f:
                 diconf = toml.load(f)
         except Exception as e:
-            raise FileNotFoundError(f"File {filename} not found: {e}")
+            raise FileNotFoundError(f"File {filename} not found: {e}") from e
     elif isinstance(file, BytesIO):
         try:
             string = file.getvalue().decode("utf-8")
             diconf = toml.loads(string)
         except Exception as e:
-            raise RuntimeError(f"Cannot read from BytesIO: {e}")
+            raise RuntimeError(f"Cannot read from BytesIO: {e}") from e
     elif isinstance(file, StringIO):
         try:
             string = file.getvalue()
             diconf = toml.loads(string)
         except Exception as e:
-            raise RuntimeError(f"Cannot read from StringIO: {e}")
+            raise RuntimeError(f"Cannot read from StringIO: {e}") from e
     else:
         raise ValueError(f"Type {type(file)} not a valid type")