feat: add check for free storage space when enabling cache

PR Closed: #1081

tensorbay/client/dataset.py

@@ -24,6 +24,7 @@
 
 import logging
 import os
+import shutil
 import tempfile
 from typing import TYPE_CHECKING, Any, Dict, Generator, Iterable, Iterator, Optional, Tuple, Union
 
@@ -32,6 +33,7 @@
 from tensorbay.client.diff import DataDiff, DatasetDiff, SegmentDiff
 from tensorbay.client.lazy import PagingList
 from tensorbay.client.log import (
+    CACHE_SPACE_WARNING,
     UPLOAD_SEGMENT_RESUME_TEMPLATE_CLI,
     UPLOAD_SEGMENT_RESUME_TEMPLATE_SDK,
 )
@@ -229,15 +231,20 @@ def enable_cache(self, cache_path: str = "") -> None:
             )
         else:
             self._cache_path = os.path.join(tempfile.gettempdir(), "tensorbay", self.dataset_id)
-
+        total_size = self.get_total_size()
         print(
-            "To use cache, "
-            "please make sure there is free storage space larger than the dataset size.\n"
+            "To cache the entire dataset, "
+            f"please make sure there is free storage space larger than {total_size} bytes.\n"
             "Note that cache will not work for datasets under draft status.\n\n"
             f'The cache will be stored under "{self._cache_path}".\n'
             "You can remove all the files after using."
         )
 
+        os.makedirs(self._cache_path, exist_ok=True)
+        _, _, free = shutil.disk_usage(self._cache_path)
+        if free < total_size:
+            logger.warning(CACHE_SPACE_WARNING, free, total_size)
+
     def update_notes(
         self,
         *,

tensorbay/client/log.py

@@ -71,6 +71,15 @@
 *****************************************************************************
 """
 
+CACHE_SPACE_WARNING = """
+*****************************************************************************
+
+ %d bytes left on device, less than the dataset size %d bytes.
+ Please be aware that there is not enough space to cache the entire dataset.
+
+*****************************************************************************
+"""
+
 
 class RequestLogging:
     """This class used to lazy load request to logging.