Renaming Database3 to Database, but preserving the API

armi/bookkeeping/db/__init__.py

@@ -64,13 +64,15 @@
 from armi import runLog
 
 # re-export package components for easier import
+from armi.bookkeeping.db.database import Database
 from armi.bookkeeping.db.database3 import Database3
 from armi.bookkeeping.db.databaseInterface import DatabaseInterface
 from armi.bookkeeping.db.compareDB3 import compareDatabases
 from armi.bookkeeping.db.factory import databaseFactory
 
 
 __all__ = [
+    "Database",
     "Database3",
     "DatabaseInterface",
     "compareDatabases",
@@ -98,7 +100,7 @@ def loadOperator(
         The time node to load the reactor from.
     statePointName: str
         State point name at the end, E.G. `EOC` or `EOL`.
-        Full name would be C0N2EOC, see database3.getH5GroupName
+        Full name would be C0N2EOC, see database.getH5GroupName
     allowMissing : bool
         Whether to emit a warning, rather than crash if reading a database
         with undefined parameters. Default False.
@@ -138,7 +140,7 @@ def loadOperator(
             "of the database."
         )
 
-    db = Database3(pathToDb, "r")
+    db = Database(pathToDb, "r")
     with db:
         # init Case here as it keeps track of execution time and assigns a reactor
         # attribute. This attribute includes the time it takes to initialize the reactor
@@ -181,7 +183,7 @@ def _getH5File(db):
     All this being said, we are probably violating this already with genAuxiliaryData,
     but we have to start somewhere.
     """
-    if isinstance(db, Database3):
+    if isinstance(db, Database):
         return db.h5db
     else:
         raise TypeError("Unsupported Database type ({})!".format(type(db)))

armi/bookkeeping/db/compareDB3.py

@@ -53,8 +53,8 @@
 import numpy as np
 
 from armi import runLog
-from armi.bookkeeping.db import database3
-from armi.bookkeeping.db.database3 import Database3
+from armi.bookkeeping.db import database
+from armi.bookkeeping.db.database import Database
 from armi.bookkeeping.db.factory import databaseFactory
 from armi.bookkeeping.db.permissions import Permissions
 from armi.reactor.composites import ArmiObject
@@ -179,7 +179,7 @@ def compareDatabases(
     with OutputWriter(outputName) as out:
         ref = databaseFactory(refFileName, Permissions.READ_ONLY_FME)
         src = databaseFactory(srcFileName, Permissions.READ_ONLY_FME)
-        if not isinstance(ref, Database3) or not isinstance(src, Database3):
+        if not isinstance(ref, Database) or not isinstance(src, Database):
             raise TypeError(
                 "This database comparer only knows how to deal with database version "
                 "3; received {} and {}".format(type(ref), type(src))
@@ -363,8 +363,8 @@ def _diffSpecialData(
         return
 
     try:
-        src = database3.unpackSpecialData(srcData[()], srcData.attrs, paramName)
-        ref = database3.unpackSpecialData(refData[()], refData.attrs, paramName)
+        src = database.unpackSpecialData(srcData[()], srcData.attrs, paramName)
+        ref = database.unpackSpecialData(refData[()], refData.attrs, paramName)
     except Exception:
         runLog.error(
             f"Unable to unpack special data for paramName {paramName}. "
@@ -380,9 +380,8 @@ def _diffSpecialData(
                 diffResults.addDiff(compName, paramName, np.inf, np.inf, np.inf)
                 return
 
-            # make sure not to try to compare empty arrays. Numpy is mediocre at
-            # these; they are super degenerate and cannot participate in concatenation.
-            # Why?
+            # Make sure not to try to compare empty arrays. Numpy is mediocre at these;
+            # they are super degenerate and cannot participate in concatenation.
             if 0 not in dSrc.shape:
                 # Use the mean of the two to calc relative error. This is more robust to
                 # changes that cause one of the values to be zero, while the other is