Feature Added: JSON Export

Author: CodingSamrat

filexdb/database.py

@@ -2,7 +2,8 @@
 
 from .collection import Collection
 from .fileio import BinaryFileIO, JsonFileIO
-from .document import JsonArray
+from .document import JsonArray, Document
+
 
 class FileXdb:
 
@@ -18,7 +19,7 @@ def __init__(self, db_name: str, data_dir=None, mode="binary"):
         :param db_name: Name of Database without file extension.
         :param data_dir: Where the Database will be stored.
         """
-        self._database = {}
+        self._database = Document({})
         self._db_name = db_name
         self._data_dir = data_dir
 
@@ -54,4 +55,3 @@ def show_collections(self) -> JsonArray:
 
         return _result
 
-

filexdb/document.py

@@ -1,6 +1,7 @@
 from typing import Mapping, List
 import uuid
 import json
+from .fileio import Export
 
 
 def _get_id():
@@ -44,7 +45,7 @@ def prettify(self) -> str:
 
 
 class JsonArray(list):
-    def __init__(self, _value:list) -> None:
+    def __init__(self, _value: list) -> None:
         self.value = _value
         super().__init__(self.value)
 
@@ -75,6 +76,16 @@ def count_item(self) -> int:
 
 
 
+    def export(self, _file_name, _file_dir=None, _mode="json"):
+        """
+
+        :param _file_name:
+        :param _file_dir:
+        :param _mode:
+        :return:
+        """
+
+        e = Export(self.value, _file_name, _file_dir, _mode)
 
 
 

filexdb/fileio.py

@@ -6,8 +6,10 @@
 
 __all__ = ("FileIO", "JsonFileIO", "BinaryFileIO")
 
+from typing import Tuple
 
-def create_db(db_name: str, data_dir: str = None):
+
+def create_file(db_name: str, data_dir: str = None):
     """
     Create a file if it doesn't exist yet.
 
@@ -30,8 +32,32 @@ def create_db(db_name: str, data_dir: str = None):
 
     # Create the file by opening it in "a" mode which creates the file if it
     # does not exist yet but does not modify its contents
-    with open(_db_path, 'ab'):
-        pass
+    if not os.path.exists(_db_path):
+        with open(_db_path, 'a'):
+            pass
+
+
+def pre_process(ext: str, db_name: str, data_dir=None) -> tuple[str, str]:
+    """
+
+    :param ext:
+    :param db_name:
+    :param data_dir:
+    :return:
+    """
+
+    # Adding ``FileXdb`` specific file extension to the Database-file.
+    _file_name = f"{db_name}.{ext}"
+
+    # Setting default Database-file path.
+    _file_full_path = _file_name
+
+    # Checking if Data Directory is on root or not.
+    if data_dir is not None:
+        # Creating Database-file full path by joining data_dir & db_name.
+        _file_full_path = os.path.join(data_dir, _file_name)
+
+    return _file_name, _file_full_path
 
 
 class FileIO(ABC):
@@ -69,8 +95,20 @@ def write(self, data: dict):
 
         raise NotImplementedError('To be overridden!')
 
+    @abstractmethod
+    def get_export_path(self) -> str:
+        """
+        Return Database path
+
+        :return: TDatabase path.
+        """
+
+        raise NotImplementedError('To be overridden!')
+
+
 
 class BinaryFileIO(FileIO):
+
     def __init__(self, db_name: str, data_dir=None):
         """
         Create a new instance.
@@ -85,22 +123,11 @@ def __init__(self, db_name: str, data_dir=None):
 
         super().__init__()
 
-        self._data_dir = data_dir
-
-        # Adding ``FileXdb`` specific file extension to the Database-file.
-        self._db_name = f"{db_name}.fxdb"
-
-        # Setting default Database-file path.
-        self._db_file_path = self._db_name
-
-        # Checking if Data Directory is on root or not.
-        if self._data_dir is not None:
-
-            # Creating Database-file full path by joining data_dir & db_name.
-            self._db_file_path = os.path.join(self._data_dir, self._db_name)
+        self._db_name, self._db_file_path = pre_process("fxdb", db_name, data_dir)
 
         # Create the Database/File if it doesn't exist
-        create_db(self._db_name, self._data_dir)
+        create_file(self._db_name, data_dir)
+
 
     def read(self) -> dict:
         """
@@ -165,27 +192,19 @@ def write(self, data: dict) -> None:
             # Remove data that is behind the new cursor if the file has gotten shorter.
             file.truncate()
 
+    def get_export_path(self) -> str:
+        return self._db_file_path
+
 
 class JsonFileIO(FileIO):
-    def __init__(self, db_name:str, data_dir=None):
+    def __init__(self, db_name: str, data_dir=None):
 
         super().__init__()
 
-        self._data_dir = data_dir
-
-        # Adding ``JSON`` file extension to the Database-file.
-        self._db_name = f"{db_name}.json"
-
-        # Setting default Database-file path.
-        self._db_file_path = self._db_name
-
-        # Checking if Data Directory is on root or not.
-        if self._data_dir is not None:
-            # Creating Database-file full path by joining data_dir & db_name.
-            self._db_file_path = os.path.join(self._data_dir, self._db_name)
+        self._db_name, self._db_file_path = pre_process("json", db_name, data_dir)
 
         # Create the Database/File if it doesn't exist
-        create_db(self._db_name, self._data_dir)
+        create_file(self._db_name, data_dir)
 
     def read(self) -> dict:
         """
@@ -249,3 +268,49 @@ def write(self, data: dict):
 
             # Remove data that is behind the new cursor if the file has gotten shorter.
             file.truncate()
+
+    def get_export_path(self) -> str:
+        return self._db_file_path
+
+
+class Export:
+    def __init__(self, _data, _file_name=None, _file_dir=None, _mode="json") -> None:
+        """
+        Exports data into different readable file.
+
+        :param _file_name: Where to export.
+        :param _file_dir: Parent dir.
+        :param _data: Data to export.
+        :param _mode: Export to which mode.
+        """
+
+        # Caching arguments
+        self.data = _data
+        self.file_name = _file_name
+        self.file_dir = _file_dir
+        self.mode = _mode
+
+        self._db_name, self._db_file_path = pre_process(self.mode, self.file_name, self.file_dir)
+
+        # Create the Database/File if it doesn't exist
+        create_file(self._db_name, self.file_dir)
+
+        # check mode
+        if self.mode == "json":
+            self.to_json(self.data, self._db_file_path)
+        else:
+            raise TypeError(f"`{self.mode}` is not a appropriate mode to export")
+
+
+
+    def to_json(self, _data, _file_path) -> None:
+        """
+        Exports data into JSON file.
+
+        :param _data: Data to export.
+        :param _file_path: Where to export.
+        :return: None
+        """
+        with open(_file_path, "w") as f:
+            json.dump(_data, fp=f, indent=4)
+