pyfastexcel 0.1.0__tar.gz → 0.1.2__tar.gz

{pyfastexcel-0.1.0 → pyfastexcel-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyfastexcel
-Version: 0.1.0
+Version: 0.1.2
 Summary: High performace excel file generation library.
 Home-page: https://github.com/Zncl2222/pyfastexcel
 Author: Zncl2222

{pyfastexcel-0.1.0 → pyfastexcel-0.1.2}/pyfastexcel/__init__.py

@@ -2,6 +2,7 @@ from openpyxl_style_writer import CustomStyle, DefaultStyle
 
 from pyfastexcel.workbook import Workbook
 from pyfastexcel.writer import StreamWriter
+from pyfastexcel.utils import set_debug_level
 
 __all__ = [
     'Workbook',
@@ -10,4 +11,5 @@ __all__ = [
     # convinent usage.
     'CustomStyle',
     'DefaultStyle',
+    'set_debug_level',
 ]

{pyfastexcel-0.1.0 → pyfastexcel-0.1.2}/pyfastexcel/_typing.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Literal, TypedDict, Optional, List, Union
+from typing import Literal, Protocol, TypedDict, Optional, List, Union
 
 
 class CommentTextDict(TypedDict, total=False):
@@ -21,5 +21,9 @@ class SelectionDict(TypedDict, total=False):
     pane: str
 
 
+class Writable(Protocol):
+    def write(self, content: str) -> None: ...
+
+
 CommentTextStructure = Union[str, List[str], CommentTextDict, List[CommentTextDict]]
 SetPanesSelection = List[SelectionDict]

{pyfastexcel-0.1.0 → pyfastexcel-0.1.2}/pyfastexcel/driver.py

@@ -2,20 +2,31 @@ from __future__ import annotations
 
 import base64
 import ctypes
+import logging
 import sys
 from datetime import datetime, timezone
 from io import BytesIO
 from pathlib import Path
+from typing import overload
 
 import msgspec
 from openpyxl import load_workbook
 from openpyxl_style_writer import CustomStyle
 
+from .logformatter import formatter
 from .style import StyleManager
 from .worksheet import WorkSheet
+from ._typing import Writable
 
 BASE_DIR = Path(__file__).resolve().parent
 
+logger = logging.getLogger(__name__)
+style_formatter = logging.StreamHandler()
+style_formatter.setFormatter(formatter)
+
+logger.addHandler(style_formatter)
+logger.propagate = False
+
 
 class ExcelDriver:
     """
@@ -85,14 +96,37 @@ class ExcelDriver:
 
     @property
     def sheet_list(self):
-        return self._sheet_list
+        return list(self._sheet_list)
+
+    @overload
+    def save(self, file: Writable) -> None:
+        """
+        Saves the workbook to a writable object.
+
+        Args:
+            file (Writable): Writable object that has .write() function.
+        """
+        ...
 
-    def save(self, path: str = './pyfastexcel.xlsx') -> None:
+    @overload
+    def save(self, path: str) -> None:
+        """
+        Saves the workbook to a file.
+
+        Args:
+            path (str): A path to save the file.
+        """
+        ...
+
+    def save(self, file_or_path: Writable | str) -> None:
         if not hasattr(self, 'decoded_bytes'):
             self.read_lib_and_create_excel()
 
-        with open(path, 'wb') as file:
-            file.write(self.decoded_bytes)
+        if isinstance(file_or_path, str):
+            with open(file_or_path, 'wb') as file:
+                file.write(self.decoded_bytes)
+        else:
+            file_or_path.write(self.decoded_bytes)
 
     def __getitem__(self, key: str) -> WorkSheet:
         return self.workbook[key]
@@ -120,11 +154,11 @@ class ExcelDriver:
         use_openpyxl = False
         for sheet in self._sheet_list:
             self._dict_wb[sheet] = self.workbook[sheet]._transfer_to_dict()
-            if self.workbook[sheet].engine == 'openpyxl':
+            if self.workbook[sheet]._engine == 'openpyxl':
                 use_openpyxl = True
-            if len(self.workbook[sheet].grouped_columns) != 0:
+            if len(self.workbook[sheet]._grouped_columns_list) != 0:
                 set_group_columns = True
-            if len(self.workbook[sheet].grouped_rows) != 0:
+            if len(self.workbook[sheet]._grouped_rows_list) != 0:
                 set_row_columns = True
 
         # Set writer (if some of the function that excelize StremWriter is not support, and
@@ -155,6 +189,7 @@ class ExcelDriver:
         # Due to Streaming API of Excelize can't group column currently
         # So implement this function by openpyxl
         if (set_group_columns or set_row_columns) and use_openpyxl is True:
+            logger.info('Using openpyxl to group columns and rows...')
             self.decoded_bytes = self._set_group_columns_and_group_rows()
 
         return self.decoded_bytes
@@ -162,7 +197,7 @@ class ExcelDriver:
     def _set_group_columns_and_group_rows(self):
         wb = load_workbook(BytesIO(self.decoded_bytes))
         for sheet in self._sheet_list:
-            grouped_columns = self.workbook[sheet].grouped_columns
+            grouped_columns = self.workbook[sheet]._grouped_columns_list
             ws = wb[sheet]
             for col in grouped_columns:
                 ws.column_dimensions.group(
@@ -171,7 +206,7 @@ class ExcelDriver:
                     outline_level=col['outline_level'],
                     hidden=col['hidden'],
                 )
-            grouped_rows = self.workbook[sheet].grouped_rows
+            grouped_rows = self.workbook[sheet]._grouped_rows_list
             for row in grouped_rows:
                 ws.row_dimensions.group(
                     row['start_row'],

pyfastexcel-0.1.2/pyfastexcel/logformatter.py

@@ -0,0 +1,38 @@
+import logging
+import warnings
+
+NORMAL_FORMAT = '\033[%(log_color)s%(asctime)s - %(name)s - %(levelname)s - %(message)s\033[0m'
+LOG_COLORS = {
+    'DEBUG': '\033[90m',  # Grey
+    'INFO': '\033[92m',  # Green
+    'WARNING': '\033[93m',  # Yellow
+    'ERROR': '\033[91m',  # Red
+    'CRITICAL': '\033[91m',  # Red
+}
+LOG_CACHE = {}
+
+
+def custom_warning_format(message, *args):
+    start_color = '\033[93m'
+    reset_color = '\033[0m'
+    return f'{start_color}DeprecationWarning: {message}{reset_color}\n'
+
+
+def log_warning(logger: logging.Logger, message: str):
+    if not LOG_CACHE.get(message):
+        logger.warning(message)
+        LOG_CACHE[message] = True
+
+
+class ColoredFormatter(logging.Formatter):
+    def __init__(self, fmt):
+        super().__init__(fmt)
+
+    def format(self, record):
+        record.log_color = LOG_COLORS[record.levelname]
+        return super().format(record)
+
+
+warnings.formatwarning = custom_warning_format
+warnings.simplefilter('always', DeprecationWarning)
+formatter = ColoredFormatter(NORMAL_FORMAT)

{pyfastexcel-0.1.0 → pyfastexcel-0.1.2}/pyfastexcel/style.py

@@ -5,20 +5,16 @@ from pathlib import Path
 from typing import Any
 
 from openpyxl_style_writer import CustomStyle
+from .logformatter import formatter, log_warning
 
 BASE_DIR = Path(__file__).resolve().parent
 
 logger = logging.getLogger(__name__)
-logger.setLevel(logging.DEBUG)
+style_formatter = logging.StreamHandler()
+style_formatter.setFormatter(formatter)
 
-ch = logging.StreamHandler()
-ch.setLevel(logging.DEBUG)
-
-formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-ch.setFormatter(formatter)
-
-if not logger.hasHandlers():
-    logger.addHandler(ch)
+logger.addHandler(style_formatter)
+logger.propagate = False
 
 # TODO: Implement a CustomStyle without the dependency of openpyxl_style_writer
 
@@ -75,6 +71,11 @@ class StyleManager:
 
     @classmethod
     def set_custom_style(cls, name: str, custom_style: CustomStyle):
+        if cls.REGISTERED_STYLES.get(name):
+            log_warning(
+                logger,
+                f'{name} has already existed. Overiding the style settings.',
+            )
         cls.REGISTERED_STYLES[name] = custom_style
         cls._STYLE_NAME_MAP[custom_style] = name
 
@@ -104,7 +105,10 @@ class StyleManager:
 
     def _update_style_map(self, style_name: str, custom_style: CustomStyle) -> None:
         if self._style_map.get(style_name):
-            logger.warning(f'{style_name} has already existed. Overiding the style settings.')
+            log_warning(
+                logger,
+                f'{style_name} has already existed. Overiding the style settings.',
+            )
         self._style_map[style_name] = self._get_default_style()
         self._style_map[style_name]['Font'] = self._get_font_style(custom_style)
         self._style_map[style_name]['Fill'] = self._get_fill_style(custom_style)

{pyfastexcel-0.1.0 → pyfastexcel-0.1.2}/pyfastexcel/utils.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 import re
 import string
 import warnings
@@ -49,6 +50,10 @@ class Selection:
         }
 
 
+def set_debug_level(level: int):
+    logging.basicConfig(level=level)
+
+
 def deprecated_warning(msg: str):
     warnings.warn(
         msg,

{pyfastexcel-0.1.0 → pyfastexcel-0.1.2}/pyfastexcel/workbook.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Literal, Optional
+from typing import Literal, Optional, overload
 
 from pyfastexcel.driver import ExcelDriver, WorkSheet
 from pyfastexcel.utils import deprecated_warning
@@ -16,6 +16,8 @@ class Workbook(ExcelDriver):
     Methods:
         remove_sheet(sheet: str) -> None:
             Removes a sheet from the Excel data.
+        rename_sheet(self, old_sheet_name: str, new_sheet_name: str) -> None:
+            Rename a sheet.
         create_sheet(sheet_name: str) -> None:
             Creates a new sheet.
         switch_sheet(sheet_name: str) -> None:
@@ -45,6 +47,24 @@ class Workbook(ExcelDriver):
         self._sheet_list = tuple(self.workbook.keys())
         self.sheet = self._sheet_list[0]
 
+    def rename_sheet(self, old_sheet_name: str, new_sheet_name: str) -> None:
+        """
+        Renames a sheet in the Excel data.
+
+        Args:
+            old_sheet_name (str): The name of the sheet to rename.
+            new_sheet_name (str): The new name for the sheet.
+        """
+        if self.workbook.get(old_sheet_name) is None:
+            raise IndexError(f'Sheet {old_sheet_name} does not exist.')
+        if self.workbook.get(new_sheet_name) is not None:
+            raise ValueError(f'Sheet {new_sheet_name} already exists.')
+        self.workbook[new_sheet_name] = self.workbook.pop(old_sheet_name)
+        self._sheet_list = tuple(
+            [new_sheet_name if x == old_sheet_name else x for x in self._sheet_list]
+        )
+        self.sheet = new_sheet_name
+
     def create_sheet(
         self,
         sheet_name: str,
@@ -121,15 +141,45 @@ class Workbook(ExcelDriver):
         self._check_if_sheet_exists(sheet)
         self.workbook[sheet].set_cell_height(row, value)
 
-    def set_merge_cell(self, sheet: str, top_left_cell: str, bottom_right_cell: str) -> None:
+    @overload
+    def set_merge_cell(
+        self,
+        sheet: str,
+        top_lef_cell: Optional[str],
+        bottom_right_cell: Optional[str],
+    ) -> None: ...
+
+    @overload
+    def set_merge_cell(
+        self,
+        sheet: str,
+        cell_range: Optional[str],
+    ) -> None: ...
+
+    def set_merge_cell(self, sheet, *args) -> None:
         deprecated_warning(
-            "This function is going to deprecated in v1.0.0. Please use 'wb.merge_cell' instead",
+            "wb.set_merge_cell is going to deprecated in v1.0.0. Please use 'wb.merge_cell' instead",
         )
-        self.merge_cell(sheet, top_left_cell, bottom_right_cell)
+        self.merge_cell(sheet, *args)
+
+    @overload
+    def merge_cell(
+        self,
+        sheet: str,
+        top_lef_cell: Optional[str],
+        bottom_right_cell: Optional[str],
+    ) -> None: ...
+
+    @overload
+    def merge_cell(
+        self,
+        sheet: str,
+        cell_range: Optional[str],
+    ) -> None: ...
 
-    def merge_cell(self, sheet: str, top_left_cell: str, bottom_right_cell: str) -> None:
+    def merge_cell(self, sheet: str, *args) -> None:
         self._check_if_sheet_exists(sheet)
-        self.workbook[sheet].set_merge_cell(top_left_cell, bottom_right_cell)
+        self.workbook[sheet].set_merge_cell(*args)
 
     def auto_filter(self, sheet: str, target_range: str) -> None:
         self._check_if_sheet_exists(sheet)