Draft version of refactoring handler

qlib/utils/objm.py

@@ -0,0 +1,130 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+import os
+import pickle
+import tempfile
+from pathlib import Path
+
+from qlib.config import C
+
+
+class ObjManager:
+    def save_obj(self, obj: object, name: str):
+        """
+        save obj as name
+
+        Parameters
+        ----------
+        obj : object
+            object to be saved
+        name : str
+            name of the object
+        """
+        raise NotImplementedError(f"Please implement `save_obj`")
+
+    def save_objs(self, obj_name_l):
+        """
+        save objects 
+
+        Parameters
+        ----------
+        obj_name_l : list of <obj, name>
+        """
+        raise NotImplementedError(f"Please implement the `save_objs` method")
+
+    def load_obj(self, name: str) -> object:
+        """
+        load object by name
+
+        Parameters
+        ----------
+        name : str
+            the name of the object
+
+        Returns
+        -------
+        object:
+            loaded object
+        """
+        raise NotImplementedError(f"Please implement the `load_obj` method")
+
+    def exists(self, name: str) -> bool:
+        """
+        if the object named `name` exists
+
+        Parameters
+        ----------
+        name : str
+            name of the objecT
+
+        Returns
+        -------
+        bool:
+            If the object exists
+        """
+        raise NotImplementedError(f"Please implement the `exists` method")
+
+    def list(self) -> list:
+        """
+        list the objects
+
+        Returns
+        -------
+        list:
+            the list of returned objects
+        """
+        raise NotImplementedError(f"Please implement the `list` method")
+
+    def remove(self, fname=None):
+        """remove.
+
+        Parameters
+        ----------
+        fname :
+            if file name is provided. specific file is removed
+            otherwise, The all the objects will be removed.
+        """
+        raise NotImplementedError(f"Please implement the `remove` method")
+
+
+class FileManager(ObjManager):
+    '''
+    Use file system to manage objects
+    '''
+    def __init__(self, path=None):
+        if path is None:
+            self.path = Path(self.create_path())
+        else:
+            self.path = Path(path).resolve()
+
+    def create_path(self) -> str:
+        try:
+            return tempfile.mkdtemp(prefix=str(C['file_manager_path']) + os.sep)
+        except AttributeError:
+            raise NotImplementedError(f"If path is not given, the `create_path` function should be implemented")
+
+    def save_obj(self, obj, name):
+        with (self.path / name).open('wb') as f:
+            pickle.dump(obj, f)
+
+    def save_objs(self, obj_name_l):
+        for obj, name in obj_name_l:
+            self.save_obj(obj, name)
+
+    def load_obj(self, name):
+        with (self.path / name).open('rb') as f:
+            return pickle.load(f)
+
+    def exists(self, name):
+        return (self.path / name).exists()
+
+    def list(self):
+        return list(self.path.iterdir())
+
+    def remove(self, fname=None):
+        if fname is None:
+            for fp in self.path.glob('*'):
+                fp.unlink()
+            self.path.rmdir()
+        else:
+            (self.path / fname).unlink()