sibi-dst 2025.1.12__py3-none-any.whl → 2025.8.1__py3-none-any.whl

sibi_dst/utils/filepath_generator.py

@@ -1,187 +1,349 @@
-import datetime
+import datetime as dt
 import re
+from pathlib import PurePosixPath
+from typing import Iterable, List, Optional
 
 import fsspec
+from fsspec.utils import infer_storage_options
 
 from .log_utils import Logger
 
 
 class FilePathGenerator:
     """
-    Dynamically generates file paths by scanning directories starting from the base path
-    and determining the innermost directory structure.
-
-    Now supports generating appropriate paths for both pandas and Dask.
+    Scans date-partitioned directories base/YYYY/MM/DD and returns paths for pandas or Dask.
+    Works with any fsspec filesystem.
     """
 
-    def __init__(self, base_path='', fs=None, logger=None, **kwargs):
-        """
-        Initialize the FilePathGenerator.
-
-        Parameters:
-            base_path (str): Base directory path where data files are stored.
-            fs (fsspec.AbstractFileSystem, optional): Filesystem object to use for file operations.
-            logger (Logger, optional): Logger instance for logging information.
-            **kwargs: Additional keyword arguments.
-                - debug (bool): If True, enables debug logging.
-                - storage_options (dict): Options for the filesystem (e.g., credentials, tokens).
-                - exclude_patterns (list): List of regex patterns to exclude from file paths.
-                - file_extension (str): File extension to look for (default: 'parquet').
-        """
-        self.base_path = base_path.rstrip('/')
-        self.fs = fs  # Filesystem object
+    def __init__(
+        self,
+        base_path: str = "",
+        *,
+        fs=None,
+        logger: Optional[Logger] = None,
+        debug: bool = False,
+        storage_options: Optional[dict] = None,
+        exclude_patterns: Optional[Iterable[str]] = None,
+        file_extension: str = "parquet",
+    ):
         self.logger = logger or Logger.default_logger(logger_name=self.__class__.__name__)
-        self.debug = kwargs.get('debug', False)
-        self.storage_options = kwargs.get('storage_options', {})
-        self.exclude_patterns = kwargs.get('exclude_patterns', [])
-        self.file_extension = kwargs.get('file_extension', 'parquet').lstrip('.')
+        self.debug = debug
+        self.storage_options = storage_options or {}
+        self.file_extension = file_extension.lstrip(".")
+        self._compiled_exclusions = [re.compile(p) for p in (exclude_patterns or [])]
+
+        # Normalize base path & derive protocol + root path
+        opts = infer_storage_options(base_path or ".")
+        proto = opts.get("protocol") or "file"
+        root = opts.get("path") or ""  # protocol-stripped
+
+        # If no fs given, make one from base_path
+        if fs is None:
+            self.fs, resolved_root = fsspec.core.url_to_fs(base_path or ".", **self.storage_options)
+            # Prefer resolved_root (already stripped and normalized by fsspec)
+            root = resolved_root or root
+        else:
+            self.fs = fs
 
-        # If fs is not provided, initialize it based on base_path and storage_options
-        if self.fs is None:
-            self.fs, _ = fsspec.core.url_to_fs(self.base_path, **self.storage_options)
+        self._protocol = proto if isinstance(proto, str) else (proto[0] if proto else "file")
+        self._root = self._ensure_no_trailing_slash(self._to_posix(root))
 
-    def generate_file_paths(self, start_date, end_date, engine='dask'):
-        """
-        Generate paths dynamically for files within the date range by scanning directories.
-        Returns a list of file paths compatible with the specified engine.
+        if self.debug:
+            self.logger.debug(
+                f"FilePathGenerator init: protocol={self._protocol!r}, root={self._root!r}, fs={type(self.fs).__name__}"
+            )
 
-        Parameters:
-            start_date (str or datetime): Start date in 'YYYY-MM-DD' format or datetime object.
-            end_date (str or datetime): End date in 'YYYY-MM-DD' format or datetime object.
-            engine (str): 'pandas' or 'dask' to specify which library the paths are intended for.
+    # ------------------------- public API -------------------------
 
-        Returns:
-            list: List of file paths.
+    def generate_file_paths(self, start_date, end_date, engine: str = "dask") -> List[str]:
         """
-        start_date = self._convert_to_datetime(start_date)
-        end_date = self._convert_to_datetime(end_date)
-
-        paths = []
-        curr_date = start_date
-
-        while curr_date <= end_date:
-            year, month, day = curr_date.year, curr_date.month, curr_date.day
-            day_paths = self._collect_paths(year, month, day, engine)
-            if day_paths:
-                paths.extend(day_paths)
-            curr_date += datetime.timedelta(days=1)
+        Return a list of file (engine='dask') or dataset directory (engine='pandas') paths
+        for all dates in [start_date, end_date].
+        """
+        sd = self._to_date(start_date)
+        ed = self._to_date(end_date)
+        if sd > ed:
+            sd, ed = ed, sd  # be forgiving on reversed dates
+
+        paths: List[str] = []
+        current = sd
+        while current <= ed:
+            y, m, d = current.year, current.month, current.day
+            paths.extend(self._collect_paths_for_day(y, m, d, engine))
+            current += dt.timedelta(days=1)
 
+        if self.debug:
+            self.logger.debug(f"Generated {len(paths)} path(s) for {sd}..{ed} (engine={engine})")
         return paths
 
-    def _collect_paths(self, year, month, day, engine):
-        """
-        Collect appropriate paths for a given date, depending on the engine.
+    # ------------------------- internals -------------------------
 
-        Parameters:
-            year (int): Year component of the date.
-            month (int): Month component of the date.
-            day (int): Day component of the date.
-            engine (str): 'pandas' or 'dask'.
+    def _collect_paths_for_day(self, year: int, month: int, day: int, engine: str) -> List[str]:
+        # IMPORTANT: use protocol-stripped paths with fs methods
+        day_dir = self._join(self._root, f"{year:04d}", f"{month:02d}", f"{day:02d}")
 
-        Returns:
-            list: List of file or directory paths.
-        """
-        base_dir = f"{self.base_path}/{year}/{str(month).zfill(2)}/{str(day).zfill(2)}"
-
-        if not self.fs.exists(base_dir):
+        if not self.fs.exists(day_dir):
             if self.debug:
-                self.logger.debug(f"Directory does not exist: {base_dir}")
+                self.logger.debug(f"Directory does not exist: {day_dir}")
             return []
 
-        if engine == 'dask':
-            # Collect individual file paths
-            file_pattern = f"{base_dir}/**/*.{self.file_extension}"
-            all_paths = self.fs.glob(file_pattern)
-
-            if not all_paths and self.debug:
-                self.logger.debug(f"No files found with pattern: {file_pattern}")
-
-            # Exclude unwanted files and directories
-            filtered_paths = self._exclude_unwanted_paths(all_paths)
-
-            # Filter out directories
-            file_paths = [path for path in filtered_paths if not self.fs.isdir(path)]
-
-        elif engine == 'pandas':
-            # Collect dataset directories
-            # Assume that the base_dir is a Parquet dataset
-            if self.fs.isdir(base_dir):
-                file_paths = [base_dir]
-            else:
-                file_paths = []
-
+        if engine == "dask":
+            # Try recursive glob first
+            pattern = self._join(day_dir, "**", f"*.{self.file_extension}")
+            all_paths = self.fs.glob(pattern) or []
+
+            # Some filesystems don’t support recursive glob well; fallback to find()
+            if not all_paths:
+                try:
+                    found = self.fs.find(day_dir)  # recursive listing
+                except Exception:
+                    found = []
+                all_paths = [p for p in found if p.endswith(f".{self.file_extension}")]
+
+            # Filter out dirs & excluded patterns
+            file_paths = [
+                p for p in all_paths
+                if not self._is_dir(p) and not self._is_excluded(p)
+            ]
+
+        elif engine == "pandas":
+            # For pandas, return the dataset directory for the day (if not excluded)
+            file_paths = [day_dir] if self._is_dir(day_dir) and not self._is_excluded(day_dir) else []
         else:
-            raise ValueError("Engine must be 'pandas' or 'dask'.")
+            raise ValueError("engine must be 'pandas' or 'dask'.")
 
-        protocol = self.fs.protocol if isinstance(self.fs.protocol, str) else self.fs.protocol[0]
+        # Reattach protocol ONLY for returned paths
+        return [self._with_protocol(p) for p in file_paths]
 
-        # Ensure the protocol is included in the paths
-        file_paths = [
-            f"{protocol}://{path}" if not path.startswith(f"{protocol}://") else path
-            for path in file_paths
-        ]
+    def _is_dir(self, path: str) -> bool:
+        try:
+            return bool(self.fs.isdir(path))
+        except Exception:
+            # Robust fallback via info()
+            try:
+                return (self.fs.info(path).get("type") == "directory")
+            except Exception:
+                return False
 
-        if self.debug:
-            self.logger.debug(f"Collected {len(file_paths)} paths from {base_dir} for engine '{engine}'")
-
-        return file_paths
-
-    def _exclude_unwanted_paths(self, paths):
-        """
-        Exclude paths that match any of the exclusion patterns.
-        """
-        # Combine default patterns with user-provided patterns
-        exclude_patterns = self.exclude_patterns
+    def _is_excluded(self, path: str) -> bool:
+        return any(pat.search(path) for pat in self._compiled_exclusions)
 
-        # Compile regex patterns for efficiency
-        compiled_patterns = [re.compile(pattern) for pattern in exclude_patterns]
-
-        # Filter out paths matching any of the exclude patterns
-        filtered_paths = [
-            path for path in paths
-            if not any(pattern.match(path) for pattern in compiled_patterns)
-        ]
-
-        return filtered_paths
+    # ------------------------- helpers -------------------------
 
     @staticmethod
-    def _convert_to_datetime(date):
-        """Convert a date string or datetime object into a datetime object."""
-        if isinstance(date, str):
-            return datetime.datetime.strptime(date, '%Y-%m-%d')
-        return date
-
-
-"""
-Usage:
-# Initialize the generator
-generator = FilePathGenerator(
-    base_path='/Users/lvalverdeb/TeamDev/sibi-dst/IbisDataWH/logistics_storage/products/tracking',
-    debug=True
-)
+    def _to_date(x) -> dt.date:
+        if isinstance(x, dt.datetime):
+            return x.date()
+        if isinstance(x, dt.date):
+            return x
+        return dt.datetime.strptime(str(x), "%Y-%m-%d").date()
 
-# Generate dataset paths for Dask
-dataset_paths = generator.generate_file_paths('2024-01-01', '2024-01-05', engine='dask')
-
-# Read data with Dask
-import dask.dataframe as dd
-
-df = dd.read_parquet(dataset_paths)
-
-# Now you can use df as a Dask DataFrame
-print(df.head())
-
-# Generate file paths for pandas
-file_paths = generator.generate_file_paths('2024-01-01', '2024-01-05', engine='pandas')
-
-# Read data with pandas
-import pandas as pd
+    @staticmethod
+    def _to_posix(path: str) -> str:
+        return PurePosixPath(path).as_posix()
 
-dataframes = []
-for fp in file_paths:
-    df = pd.read_parquet(fp)
-    dataframes.append(df)
+    @staticmethod
+    def _ensure_no_trailing_slash(path: str) -> str:
+        return path[:-1] if path.endswith("/") else path
 
-df_pandas = pd.concat(dataframes, ignore_index=True)
-print(df_pandas.head())
-"""
+    @staticmethod
+    def _join(*parts: str) -> str:
+        p = PurePosixPath(parts[0])
+        for part in parts[1:]:
+            p = p / part
+        return p.as_posix()
+
+    def _with_protocol(self, path: str) -> str:
+        # If path already has a scheme, leave it
+        if "://" in path:
+            return path
+        # For local file, return absolute-like path without scheme or keep 'file://'? Keep scheme for consistency.
+        return f"{self._protocol}://{path}"
+
+# import datetime
+# import re
+#
+# import fsspec
+#
+# from .log_utils import Logger
+#
+#
+# class FilePathGenerator:
+#     """
+#     Dynamically generates file paths by scanning directories starting from the base path
+#     and determining the innermost directory structure.
+#
+#     Now supports generating appropriate paths for both pandas and Dask.
+#     """
+#
+#     def __init__(self, base_path='', fs=None, logger=None, **kwargs):
+#         """
+#         Initialize the FilePathGenerator.
+#
+#         Parameters:
+#             base_path (str): Base directory path where data files are stored.
+#             fs (fsspec.AbstractFileSystem, optional): Filesystem object to use for file operations.
+#             logger (Logger, optional): Logger instance for logging information.
+#             **kwargs: Additional keyword arguments.
+#                 - debug (bool): If True, enables debug logging.
+#                 - storage_options (dict): Options for the filesystem (e.g., credentials, tokens).
+#                 - exclude_patterns (list): List of regex patterns to exclude from file paths.
+#                 - file_extension (str): File extension to look for (default: 'parquet').
+#         """
+#         self.base_path = base_path.rstrip('/')
+#         self.fs = fs  # Filesystem object
+#         self.logger = logger or Logger.default_logger(logger_name=self.__class__.__name__)
+#         self.debug = kwargs.get('debug', False)
+#         self.storage_options = kwargs.get('storage_options', {})
+#         self.exclude_patterns = kwargs.get('exclude_patterns', [])
+#         self.file_extension = kwargs.get('file_extension', 'parquet').lstrip('.')
+#
+#         # If fs is not provided, initialize it based on base_path and storage_options
+#         if self.fs is None:
+#             self.fs, _ = fsspec.core.url_to_fs(self.base_path, **self.storage_options)
+#
+#     def generate_file_paths(self, start_date, end_date, engine='dask'):
+#         """
+#         Generate paths dynamically for files within the date range by scanning directories.
+#         Returns a list of file paths compatible with the specified engine.
+#
+#         Parameters:
+#             start_date (str or datetime): Start date in 'YYYY-MM-DD' format or datetime object.
+#             end_date (str or datetime): End date in 'YYYY-MM-DD' format or datetime object.
+#             engine (str): 'pandas' or 'dask' to specify which library the paths are intended for.
+#
+#         Returns:
+#             list: List of file paths.
+#         """
+#         start_date = self._convert_to_datetime(start_date)
+#         end_date = self._convert_to_datetime(end_date)
+#
+#         paths = []
+#         curr_date = start_date
+#
+#         while curr_date <= end_date:
+#             year, month, day = curr_date.year, curr_date.month, curr_date.day
+#             day_paths = self._collect_paths(year, month, day, engine)
+#             if day_paths:
+#                 paths.extend(day_paths)
+#             curr_date += datetime.timedelta(days=1)
+#
+#         return paths
+#
+#     def _collect_paths(self, year, month, day, engine):
+#         """
+#         Collect appropriate paths for a given date, depending on the engine.
+#
+#         Parameters:
+#             year (int): Year component of the date.
+#             month (int): Month component of the date.
+#             day (int): Day component of the date.
+#             engine (str): 'pandas' or 'dask'.
+#
+#         Returns:
+#             list: List of file or directory paths.
+#         """
+#         base_dir = f"{self.base_path}/{year}/{str(month).zfill(2)}/{str(day).zfill(2)}"
+#
+#         if not self.fs.exists(base_dir):
+#             if self.debug:
+#                 self.logger.debug(f"Directory does not exist: {base_dir}")
+#             return []
+#
+#         if engine == 'dask':
+#             # Collect individual file paths
+#             file_pattern = f"{base_dir}/**/*.{self.file_extension}"
+#             all_paths = self.fs.glob(file_pattern)
+#
+#             if not all_paths and self.debug:
+#                 self.logger.debug(f"No files found with pattern: {file_pattern}")
+#
+#             # Exclude unwanted files and directories
+#             filtered_paths = self._exclude_unwanted_paths(all_paths)
+#
+#             # Filter out directories
+#             file_paths = [path for path in filtered_paths if not self.fs.isdir(path)]
+#
+#         elif engine == 'pandas':
+#             # Collect dataset directories
+#             # Assume that the base_dir is a Parquet dataset
+#             if self.fs.isdir(base_dir):
+#                 file_paths = [base_dir]
+#             else:
+#                 file_paths = []
+#
+#         else:
+#             raise ValueError("Engine must be 'pandas' or 'dask'.")
+#
+#         protocol = self.fs.protocol if isinstance(self.fs.protocol, str) else self.fs.protocol[0]
+#
+#         # Ensure the protocol is included in the paths
+#         file_paths = [
+#             f"{protocol}://{path}" if not path.startswith(f"{protocol}://") else path
+#             for path in file_paths
+#         ]
+#
+#         if self.debug:
+#             self.logger.debug(f"Collected {len(file_paths)} paths from {base_dir} for engine '{engine}'")
+#
+#         return file_paths
+#
+#     def _exclude_unwanted_paths(self, paths):
+#         """
+#         Exclude paths that match any of the exclusion patterns.
+#         """
+#         # Combine default patterns with user-provided patterns
+#         exclude_patterns = self.exclude_patterns
+#
+#         # Compile regex patterns for efficiency
+#         compiled_patterns = [re.compile(pattern) for pattern in exclude_patterns]
+#
+#         # Filter out paths matching any of the exclude patterns
+#         filtered_paths = [
+#             path for path in paths
+#             if not any(pattern.match(path) for pattern in compiled_patterns)
+#         ]
+#
+#         return filtered_paths
+#
+#     @staticmethod
+#     def _convert_to_datetime(date):
+#         """Convert a date string or datetime object into a datetime object."""
+#         if isinstance(date, str):
+#             return datetime.datetime.strptime(date, '%Y-%m-%d')
+#         return date
+#
+#
+# """
+# Usage:
+# # Initialize the generator
+# generator = FilePathGenerator(
+#     base_path='/Users/lvalverdeb/TeamDev/sibi-dst/IbisDataWH/logistics_storage/products/tracking',
+#     debug=True
+# )
+#
+# # Generate dataset paths for Dask
+# dataset_paths = generator.generate_file_paths('2024-01-01', '2024-01-05', engine='dask')
+#
+# # Read data with Dask
+# import dask.dataframe as dd
+#
+# df = dd.read_parquet(dataset_paths)
+#
+# # Now you can use df as a Dask DataFrame
+# print(df.head())
+#
+# # Generate file paths for pandas
+# file_paths = generator.generate_file_paths('2024-01-01', '2024-01-05', engine='pandas')
+#
+# # Read data with pandas
+# import pandas as pd
+#
+# dataframes = []
+# for fp in file_paths:
+#     df = pd.read_parquet(fp)
+#     dataframes.append(df)
+#
+# df_pandas = pd.concat(dataframes, ignore_index=True)
+# print(df_pandas.head())
+# """