Merge pull request #958 from bouthilx/feature/db_repr

Add repr to dbs to help debug with orion db test

src/orion/core/io/database/__init__.py

@@ -59,6 +59,9 @@ def __init__(
         self._conn = None
         self.initiate_connection()
 
+    def __repr__(self) -> str:
+        return f"{type(self).__qualname__}(host={self.host})"
+
     @property
     @abstractmethod
     def is_connected(self):

src/orion/core/io/database/ephemeraldb.py

@@ -35,6 +35,9 @@ class EphemeralDB(Database):
 
     """
 
+    def __repr__(self) -> str:
+        return f"{type(self).__qualname__}()"
+
     @property
     def is_connected(self):
         """Return true, always."""

src/orion/core/io/database/mongodb.py

@@ -121,6 +121,14 @@ def __init__(
             authSource=name,
         )
 
+    def __repr__(self) -> str:
+        name = type(self).__qualname__
+        args = ", ".join(
+            f"{name}={getattr(self, name)}"
+            for name in ["host", "name", "port", "username", "password", "options"]
+        )
+        return f"{name}({args})"
+
     def __getstate__(self):
         state = {}
         for key in ["host", "name", "port", "username", "password", "options"]:

src/orion/core/io/database/pickleddb.py

@@ -109,6 +109,9 @@ def __init__(self, host="", timeout=60, *args, **kwargs):
         if os.path.dirname(host):
             os.makedirs(os.path.dirname(host), exist_ok=True)
 
+    def __repr__(self) -> str:
+        return f"{type(self).__qualname__}(host={self.host}, timeout={self.timeout})"
+
     @property
     def is_connected(self):
         """Return true, always."""

tests/unittests/core/database/test_ephemeraldb.py

@@ -54,6 +54,10 @@ def collection(document, db_type):
 # TESTS SET
 
 
+def test_repr(orion_db: EphemeralDB):
+    assert str(orion_db) == f"EphemeralDB()"
+
+
 @pytest.mark.usefixtures("clean_db")
 class TestIndex(object):
     """Test index for :meth:`orion.core.io.database.ephemeraldb.EphemeralCollection`."""

tests/unittests/core/database/test_mongodb.py

@@ -332,3 +332,10 @@ def test_non_converted_errors(self, orion_db, test_collection):
 
         with pytest.raises(pymongo.errors.OperationFailure):
             orion_db.read_and_write("test_collection", query, config_to_add)
+
+
+def test_repr(orion_db: MongoDB):
+    assert str(orion_db) == (
+        f"MongoDB(host=localhost, name=orion_test, port=27017, username=user, "
+        f"password=pass, options={orion_db.options})"
+    )

tests/unittests/core/database/test_pickleddb.py

@@ -186,3 +186,9 @@ def _get_fs(path):
     monkeypatch.setattr("orion.core.io.database.pickleddb._get_fs", _get_fs)
 
     assert isinstance(_create_lock("/whatever/the/path/is"), file_lock_class)
+
+
+def test_repr(orion_db: PickledDB):
+    assert (
+        str(orion_db) == f"PickledDB(host={orion_db.host}, timeout={orion_db.timeout})"
+    )