pyfastexcel 0.1.1__tar.gz → 0.1.2__tar.gz

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

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

{pyfastexcel-0.1.1 → 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.1 → 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.1 → 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:
     """
@@ -87,12 +98,35 @@ class ExcelDriver:
     def sheet_list(self):
         return list(self._sheet_list)
 
-    def save(self, path: str = './pyfastexcel.xlsx') -> None:
+    @overload
+    def save(self, file: Writable) -> None:
+        """
+        Saves the workbook to a writable object.
+
+        Args:
+            file (Writable): Writable object that has .write() function.
+        """
+        ...
+
+    @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]
@@ -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

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

@@ -11,11 +11,10 @@ BASE_DIR = Path(__file__).resolve().parent
 
 logger = logging.getLogger(__name__)
 style_formatter = logging.StreamHandler()
-style_formatter.setLevel(logging.DEBUG)
 style_formatter.setFormatter(formatter)
 
-if not logger.hasHandlers():
-    logger.addHandler(style_formatter)
+logger.addHandler(style_formatter)
+logger.propagate = False
 
 # TODO: Implement a CustomStyle without the dependency of openpyxl_style_writer
 

{pyfastexcel-0.1.1 → 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.1 → pyfastexcel-0.1.2}/pyfastexcel/workbook.py

@@ -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:

{pyfastexcel-0.1.1 → pyfastexcel-0.1.2}/pyfastexcel/worksheet.py

@@ -562,6 +562,27 @@ class WorkSheet(WorkSheetBase):
         active_pane: Literal['bottomLeft', 'bottomRight', 'topLeft', 'topRight', ''] = '',
         selection: Optional[SetPanesSelection | list[Selection]] = None,
     ) -> None:
+        """
+        Sets the panes for the worksheet with options for freezing, splitting, and selection.
+
+        Args:
+            freeze (bool): Whether to freeze the panes.
+            split (bool): Whether to split the panes.
+            x_split (int): The column position to split or freeze.
+            y_split (int): The row position to split or freeze.
+            top_left_cell (str): The top-left cell in the split or frozen panes.
+            active_pane (Literal['bottomLeft', 'bottomRight', 'topLeft', 'topRight', '']):
+            The active pane.
+            selection (Optional[SetPanesSelection | list[Selection]]): The selection
+            details for the panes.
+
+        Raises:
+            ValueError: If x_split or y_split is negative, or if active_pane is
+                invalid.
+
+        Returns:
+            None
+        """
         if x_split < 0 or y_split < 0:
             raise ValueError('Split position should be positive.')
         if top_left_cell != '':
@@ -709,6 +730,22 @@ class WorkSheet(WorkSheetBase):
         hidden: bool = False,
         engine: Literal['pyfastexcel', 'openpyxl'] = 'pyfastexcel',
     ):
+        """
+        Groups columns between start_col and end_col with specified outline
+        level and visibility.
+
+        Args:
+            start_col (str): The starting column to group.
+            end_col (Optional[str]): The ending column to group. If None, only
+            start_col will be grouped.
+            outline_level (int): The outline level of the group.
+            hidden (bool): Whether the grouped columns should be hidden.
+            engine (Literal['pyfastexcel', 'openpyxl']): The engine to use for
+            grouping.
+
+        Returns:
+            None
+        """
         self._grouped_columns_list.append(
             {
                 'start_col': start_col,
@@ -727,6 +764,22 @@ class WorkSheet(WorkSheetBase):
         hidden: bool = False,
         engine: Literal['pyfastexcel', 'openpyxl'] = 'pyfastexcel',
     ):
+        """
+        Groups rows between start_row and end_row with specified outline level
+        and visibility.
+
+        Args:
+            start_row (int): The starting row to group.
+            end_row (Optional[int]): The ending row to group. If None,
+            only start_row will be grouped.
+            outline_level (int): The outline level of the group.
+            hidden (bool): Whether the grouped rows should be hidden.
+            engine (Literal['pyfastexcel', 'openpyxl']): The engine to use for
+            grouping.
+
+        Returns:
+            None
+        """
         self._grouped_rows_list.append(
             {
                 'start_row': start_row,

{pyfastexcel-0.1.1 → pyfastexcel-0.1.2}/pyfastexcel/writer.py

@@ -26,13 +26,6 @@ class StreamWriter(Workbook):
     """
 
     def __init__(self, data: Optional[list[dict[str, str]]] = None):
-        """
-        Initializes the NormalWriter.
-
-        Args:
-            data (list[dict[str, str]]): The data to be written to the
-            Excel file.
-        """
         super().__init__()
         self._row_list = []
         self.data = data
@@ -116,6 +109,39 @@ class StreamWriter(Workbook):
         value = validate_and_format_value(value, set_default_style=False)
         self._row_list.append((value, style))
 
+    def row_append_list(
+        self,
+        value: list[Any],
+        style: str | CustomStyle = 'DEFAULT_STYLE',
+        create_row: bool = False,
+        **kwargs,
+    ) -> None:
+        """
+        Appends a value to the row list.
+
+        Args:
+            value (list[Any]): The value to be appended.
+            style (str | CustomStyle): The style of the value, can be either
+                a style name or a CustomStyle object.
+            create_row (bool): Whether to create row.
+            **kwargs: Additional keyword arguments to modify the style.
+        """
+        self.style_key = f'{style}{kwargs}'
+
+        if isinstance(style, CustomStyle):
+            style = self._handle_custom_style(style, kwargs)
+        elif isinstance(style, str):
+            style = self._handle_string_style(style, kwargs)
+
+        if create_row:
+            value = tuple(
+                (validate_and_format_value(x, set_default_style=False), style) for x in value
+            )
+            self.workbook[self.sheet].data.append(value)
+        else:
+            value = validate_and_format_value(value, set_default_style=False)
+            self._row_list.append((value, style))
+
     def create_row(self):
         """
         Creates a row in the Excel data, and clean the current _row_list.

{pyfastexcel-0.1.1 → pyfastexcel-0.1.2}/pyfastexcel.egg-info/PKG-INFO

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

{pyfastexcel-0.1.1 → pyfastexcel-0.1.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pyfastexcel
-version = 0.1.1
+version = 0.1.2
 description = High performace excel file generation library.
 long_description = file: README.md
 long_description_content_type = text/markdown