Version 4.0.0 (#100)

- Removed Python 3.4 support
- Removed Python 3.5 support
- Added Python 3.9 support
- Allowing StyleFrame.ExcelWriter to accept any argument (except for engine) that pandas.ExcelWriter accepts
- Allowing customizing formats of date, time and datetime objects when creating Styler instances
- Fixed rows mis-alignment issue when calling to_excel with header=False (Closes #88)
- read_excel does not accept sheetname argument anymore (was deprecated since version 1.6). Use sheet_name instead.
- Version bumped to 4.0.0

Author: DeepSpace2

.github/workflows/test.yml

@@ -12,13 +12,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8]
+        python-version: [3.6, 3.7, 3.8, 3.9]
         experimental: [false]
         include:
-          - python-version: 3.4
-            experimental: true
-          - python-version: 3.9-dev
-            experimental: true
           - python-version: 3.10-dev
             experimental: true
 

.travis.yml

@@ -1,3 +1,12 @@
+#### 4.0
+* **Removed Python 3.4 support**
+* **Removed Python 3.5 support**
+* **Added Python 3.9 support**
+* Allowing `StyleFrame.ExcelWriter` to accept any argument (except for `engine`) that `pandas.ExcelWriter` accepts
+* Allowing customizing formats of `date`, `time` and `datetime` objects when creating `Styler` instances
+* Fixed rows mis-alignment issue when calling `to_excel` with `header=False` ([GitHub issue #88](https://github.com/DeepSpace2/StyleFrame/issues/88))
+* `read_excel` does not accept `sheetname` argument anymore (was deprecated since version 1.6). Use `sheet_name` instead.
+
 #### 3.0.6
 * Fixes [GitHub issue #94](https://github.com/DeepSpace2/StyleFrame/issues/94) - Passing `border_type=utils.borders.default_grid` to `Styler`
 

CHANGELOG.md

@@ -0,0 +1,2 @@
+fixes:
+  - "/home/runner/work/StyleFrame/::"

codecov.yml

@@ -64,11 +64,10 @@ def find_version(*file_paths):
 
         # Specify the Python versions you support here. In particular, ensure
         # that you indicate whether you support Python 2, Python 3 or both.
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8'
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9'
     ],
 
     # What does your project relate to?
@@ -83,5 +82,5 @@ def find_version(*file_paths):
     # your project is installed. For an analysis of "install_requires" vs pip's
     # requirements files see:
     # https://packaging.python.org/en/latest/requirements.html
-    install_requires=['openpyxl>=2.5,<3.0.6', 'colour>=0.1.5,<0.2', 'jsonschema', 'xlrd>=1.0.0,<1.3.0', 'pandas<1.2.0']
+    install_requires=['openpyxl>=2.5,<4', 'colour>=0.1.5,<0.2', 'jsonschema', 'xlrd>=1.0.0,<1.3.0', 'pandas<2']
 )

setup.py

@@ -13,7 +13,7 @@
 styler_kwargs = set(inspect.signature(Styler).parameters.keys())
 
 
-class CommandLineInterface(object):
+class CommandLineInterface:
     def __init__(self, input_path=None, output_path=None, input_json=None):
         self.input_path = input_path
         self.input_json = input_json

styleframe/command_line/commandline.py

@@ -1,35 +1,42 @@
+import argparse
 import unittest
 import os
 
+from contextlib import suppress
+from unittest.mock import patch
+
 from styleframe import CommandLineInterface, Styler, utils
+from styleframe.command_line.commandline import get_cli_args
 from styleframe.command_line.tests import TEST_JSON_FILE, TEST_JSON_STRING_FILE
 from styleframe.tests import TEST_FILENAME
 
 
 class CommandlineInterfaceTest(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
-        cls.cli = CommandLineInterface(TEST_JSON_FILE, TEST_FILENAME)
         cls.sheet_1_col_a_style = Styler(bg_color=utils.colors.blue, font_color=utils.colors.yellow).to_openpyxl_style()
         cls.sheet_1_col_a_cell_2_style = Styler(bold=True, font=utils.fonts.arial, font_size=30,
                                                 font_color=utils.colors.green,
                                                 border_type=utils.borders.double).to_openpyxl_style()
         cls.sheet_1_col_b_cell_4_style = Styler(bold=True, font=utils.fonts.arial, font_size=16).to_openpyxl_style()
 
     def tearDown(self):
-        try:
+        with suppress(OSError):
             os.remove(TEST_FILENAME)
-        except OSError as ex:
-            print(ex)
 
     # noinspection PyUnresolvedReferences
     def test_parse_as_json(self):
-        self.cli.parse_as_json()
-        loc_col_a = self.cli.Sheet1_sf.columns.get_loc('col_a')
-        loc_col_b = self.cli.Sheet1_sf.columns.get_loc('col_b')
-        self.assertEqual(self.cli.Sheet1_sf.iloc[0, loc_col_a].style.to_openpyxl_style(), self.sheet_1_col_a_style)
-        self.assertEqual(self.cli.Sheet1_sf.iloc[1, loc_col_a].style.to_openpyxl_style(), self.sheet_1_col_a_cell_2_style)
-        self.assertEqual(self.cli.Sheet1_sf.iloc[1, loc_col_b].style.to_openpyxl_style(), self.sheet_1_col_b_cell_4_style)
+        cli = CommandLineInterface(TEST_JSON_FILE, TEST_FILENAME)
+        cli.parse_as_json()
+        loc_col_a = cli.Sheet1_sf.columns.get_loc('col_a')
+        loc_col_b = cli.Sheet1_sf.columns.get_loc('col_b')
+        self.assertEqual(cli.Sheet1_sf.iloc[0, loc_col_a].style.to_openpyxl_style(), self.sheet_1_col_a_style)
+        self.assertEqual(cli.Sheet1_sf.iloc[1, loc_col_a].style.to_openpyxl_style(), self.sheet_1_col_a_cell_2_style)
+        self.assertEqual(cli.Sheet1_sf.iloc[1, loc_col_b].style.to_openpyxl_style(), self.sheet_1_col_b_cell_4_style)
+
+    def test_load_from_json_invalid_args(self):
+        with self.assertRaises((TypeError, ValueError)):
+            CommandLineInterface()._load_from_json()
 
     # noinspection PyUnresolvedReferences
     def test_init_with_json_string(self):
@@ -42,3 +49,11 @@ def test_init_with_json_string(self):
         self.assertEqual(cli.Sheet1_sf.iloc[0, loc_col_a].style.to_openpyxl_style(), self.sheet_1_col_a_style)
         self.assertEqual(cli.Sheet1_sf.iloc[1, loc_col_a].style.to_openpyxl_style(), self.sheet_1_col_a_cell_2_style)
         self.assertEqual(cli.Sheet1_sf.iloc[1, loc_col_b].style.to_openpyxl_style(), self.sheet_1_col_b_cell_4_style)
+
+    @patch('sys.stderr.write')
+    @patch('argparse.ArgumentParser.parse_args',
+           return_value=argparse.Namespace(version=False, show_schema=False, test=False,
+                                           json_path=None, json=None))
+    def test_get_cli_args_invalid_args(self, args_mock, stderr_mock):
+        with self.assertRaises(SystemExit):
+            get_cli_args()

styleframe/command_line/tests/commandline_tests.py

@@ -11,7 +11,7 @@
     pd_timestamp = pd.tslib.Timestamp
 
 
-class Container(object):
+class Container:
     """
     A container class used to store value and style pairs.
     Value can be any datatype, and style is a Styler object
@@ -84,16 +84,6 @@ def __rsub__(self, other):
             return Container(other.value - self.value)
         return Container(other - self.value)
 
-    def __div__(self, other):
-        if isinstance(other, self.__class__):
-            return Container(self.value / other.value)
-        return Container(self.value / other)
-
-    def __rdiv__(self, other):
-        if isinstance(other, self.__class__):
-            return Container(other.value / self.value)
-        return Container(other / self.value)
-
     def __truediv__(self, other):
         if isinstance(other, self.__class__):
             return Container(self.value / other.value)
@@ -146,6 +136,3 @@ def __bool__(self):
 
     def __len__(self):
         return len(self.value)
-
-    # for Python 2
-    __nonzero__ = __bool__

styleframe/container.py

@@ -25,7 +25,7 @@
     pd_timestamp = pd.tslib.Timestamp
 
 
-class StyleFrame(object):
+class StyleFrame:
     """
     A wrapper class that wraps a :class:`pandas.DataFrame` object and represent a stylized dataframe.
     Stores container objects that have values and styles that will be applied to excel
@@ -142,7 +142,6 @@ def _get_column_as_letter(self, sheet, column_to_convert, startcol=0):
         return column_as_letter
 
     @classmethod
-    @deprecated_kwargs(('sheetname',))
     def read_excel(cls, path, sheet_name=0, read_style=False, use_openpyxl_styles=False,
                    read_comments=False, **kwargs):
         """
@@ -154,6 +153,8 @@ def read_excel(cls, path, sheet_name=0, read_style=False, use_openpyxl_styles=Fa
         :param sheetname:
               .. deprecated:: 1.6
                  Use ``sheet_name`` instead.
+              .. versionchanged:: 4.0
+                 Removed
         :param sheet_name: The sheet name to read. If an integer is provided then it be used as a zero-based
                 sheet index. Default is 0.
         :type sheet_name: str or int
@@ -229,7 +230,6 @@ def _read_style():
 
                 sf._columns_width[col_name] = sheet.column_dimensions[sf._get_column_as_letter(sheet, col_name)].width
 
-        sheet_name = kwargs.pop('sheetname', sheet_name)
         header_arg = kwargs.get('header', 0)
         if read_style and isinstance(header_arg, Iterable):
             raise ValueError('Not supporting multiple index columns with read style.')
@@ -308,8 +308,14 @@ def read_excel_as_template(cls, path, df, use_df_boundaries=False, **kwargs):
 
     # noinspection PyPep8Naming
     @classmethod
-    def ExcelWriter(cls, path):
-        return pd.ExcelWriter(path, engine='openpyxl')
+    def ExcelWriter(cls, path, **kwargs):
+        """
+        A shortcut for :class:`pandas.ExcelWriter`, and accepts any argument it accepts except for ``engine``
+        """
+
+        if 'engine' in kwargs:
+            raise ValueError('`engine` argument for StyleFrame.ExcelWriter can not be set')
+        return pd.ExcelWriter(path, engine='openpyxl', **kwargs)
 
     @property
     def row_indexes(self):
@@ -439,6 +445,12 @@ def get_range_of_cells(row_index=None, columns=None):
                 index_name_cell.style = self._index_header_style.to_openpyxl_style()
             for row_index, index in enumerate(self.data_df.index):
                 try:
+                    date_time_types_to_formats = {pd_timestamp: index.style.date_time_format,
+                                                  dt.datetime: index.style.date_time_format,
+                                                  dt.date: index.style.date_format,
+                                                  dt.time: index.style.time_format}
+                    index.style.number_format = date_time_types_to_formats.get(type(index.value),
+                                                                               index.style.number_format)
                     style_to_apply = index.style.to_openpyxl_style()
                 except AttributeError:
                     style_to_apply = index.style
@@ -460,6 +472,13 @@ def get_range_of_cells(row_index=None, columns=None):
         # openpyxl's rows and cols start from 1,1 while the dataframe is 0,0
         for col_index, column in enumerate(self.data_df.columns):
             try:
+                date_time_types_to_formats = {pd_timestamp: column.style.date_time_format,
+                                              dt.datetime: column.style.date_time_format,
+                                              dt.date: column.style.date_format,
+                                              dt.time: column.style.time_format}
+
+                column.style.number_format = date_time_types_to_formats.get(type(column.value),
+                                                                            column.style.number_format)
                 style_to_apply = column.style.to_openpyxl_style()
             except AttributeError:
                 style_to_apply = Styler.from_openpyxl_style(column.style, [],
@@ -472,7 +491,7 @@ def get_range_of_cells(row_index=None, columns=None):
                 if hasattr(column.style, 'comment') and column.style.comment is not None:
                     column_header_cell.comment = column.style.comment
             for row_index, index in enumerate(self.data_df.index):
-                current_cell = sheet.cell(row=row_index + startrow + 2, column=col_index + startcol + 1)
+                current_cell = sheet.cell(row=row_index + startrow + (2 if header else 1), column=col_index + startcol + 1)
                 data_df_style = self.data_df.at[index, column].style
                 try:
                     if '=HYPERLINK' in str(current_cell.value):
@@ -483,6 +502,13 @@ def get_range_of_cells(row_index=None, columns=None):
                             data_df_style.wrap_text = False
                             data_df_style.shrink_to_fit = False
                     try:
+                        date_time_types_to_formats = {pd_timestamp: data_df_style.date_time_format,
+                                                      dt.datetime: data_df_style.date_time_format,
+                                                      dt.date: data_df_style.date_format,
+                                                      dt.time: data_df_style.time_format}
+
+                        data_df_style.number_format = date_time_types_to_formats.get(type(self.data_df.at[index,column].value),
+                                                                                     data_df_style.number_format)
                         style_to_apply = data_df_style.to_openpyxl_style()
                     except AttributeError:
                         style_to_apply = Styler.from_openpyxl_style(data_df_style, [],
@@ -596,12 +622,6 @@ def apply_style_by_indexes(self, indexes_to_style, styler_obj, cols_to_style=Non
         elif isinstance(indexes_to_style, Container):
             indexes_to_style = pd.Index([indexes_to_style])
 
-        default_number_formats = {pd_timestamp: utils.number_formats.default_date_time_format,
-                                  dt.date: utils.number_formats.default_date_format,
-                                  dt.time: utils.number_formats.default_time_format}
-
-        orig_number_format = styler_obj.number_format
-
         if cols_to_style is not None and not isinstance(cols_to_style, (list, tuple, set)):
             cols_to_style = [cols_to_style]
         elif cols_to_style is None:
@@ -613,18 +633,9 @@ def apply_style_by_indexes(self, indexes_to_style, styler_obj, cols_to_style=Non
             style_to_apply = Styler.combine(self._default_style, styler_obj)
 
         for index in indexes_to_style:
-            if orig_number_format == utils.number_formats.general:
-                style_to_apply.number_format = default_number_formats.get(type(index.value),
-                                                                          utils.number_formats.general)
             index.style = style_to_apply
-
             for col in cols_to_style:
-                cell = self.iloc[self.index.get_loc(index), self.columns.get_loc(col)]
-                if orig_number_format == utils.number_formats.general:
-                    style_to_apply.number_format = default_number_formats.get(type(cell.value),
-                                                                              utils.number_formats.general)
-
-                cell.style = style_to_apply
+                self.iloc[self.index.get_loc(index), self.columns.get_loc(col)].style = style_to_apply
 
         if height:
             # Add offset 2 since rows do not include the headers and they starts from 1 (not 0).

styleframe/style_frame.py

@@ -6,7 +6,7 @@
 from pprint import pformat
 
 
-class Styler(object):
+class Styler:
     """
     Used to represent a style
 
@@ -43,6 +43,18 @@ class Styler(object):
     :param str comment_author:
     :param str comment_text:
     :param int text_rotation: Integer in the range 0 - 180
+
+    .. versionadded:: 4.0
+
+    :param date_format:
+    :type date_format: str: one of :class:`.utils.number_formats` or any other format Excel supports
+    :param time_format:
+    :type time_format: str: one of :class:`.utils.number_formats` or any other format Excel supports
+    :param date_time_format:
+    :type date_time_format: str: one of :class:`.utils.number_formats` or any other format Excel supports
+
+    .. note:: For any of ``date_format``, ``time_format`` and ``date_time_format`` to take effect, the value being
+              styled must be an actual ``date``/``time``/``datetime`` object.
     """
 
     cache = {}
@@ -52,7 +64,8 @@ def __init__(self, bg_color=None, bold=False, font=utils.fonts.arial, font_size=
                  border_type=utils.borders.thin, horizontal_alignment=utils.horizontal_alignments.center,
                  vertical_alignment=utils.vertical_alignments.center, wrap_text=True, shrink_to_fit=True,
                  fill_pattern_type=utils.fill_pattern_types.solid, indent=0.0, comment_author=None, comment_text=None,
-                 text_rotation=0):
+                 text_rotation=0, date_format=utils.number_formats.date,
+                 time_format=utils.number_formats.time_24_hours, date_time_format=utils.number_formats.date_time):
 
         def get_color_from_string(color_str, default_color=None):
             if color_str and color_str.startswith('#'):
@@ -86,11 +99,12 @@ def get_color_from_string(color_str, default_color=None):
         self.comment_author = comment_author
         self.comment_text = comment_text
         self.text_rotation = text_rotation
+        self.date_format = date_format
+        self.time_format = time_format
+        self.date_time_format = date_time_format
 
     def __eq__(self, other):
-        if not isinstance(other, self.__class__):
-            return False
-        return self.__dict__ == other.__dict__
+        return isinstance(other, self.__class__) and self.__dict__ == other.__dict__
 
     def __hash__(self):
         return hash(tuple((k, v) for k, v in sorted(self.__dict__.items())))
@@ -232,7 +246,7 @@ def combine(cls, *styles):
     create_style = to_openpyxl_style
 
 
-class ColorScaleConditionalFormatRule(object):
+class ColorScaleConditionalFormatRule:
     """Creates a color scale conditional format rule. Wraps openpyxl's ColorScaleRule.
     Mostly should not be used directly, but through StyleFrame.add_color_scale_conditional_formatting
     """