Fixed wrongly raised ValueError when passing border_type=utils.borders.default_grid to Styler - Closes #94

Author: DeepSpace2

CHANGELOG.md

@@ -1,14 +1,17 @@
+#### 3.0.6
+* Fixes [GitHub issue #94](https://github.com/DeepSpace2/StyleFrame/issues/94) - Passing `border_type=utils.borders.default_grid` to `Styler`
+
 #### 3.0.5
-* Fixes github issue #81 - read excel as template headers height
+* Fixes [GitHub issue #81](https://github.com/DeepSpace2/StyleFrame/issues/81) - read excel as template headers height
 
 #### 3.0.4
-* Fixed style "shifts" when using `read_style=True` and `header=None` with `StyleFrame.read_excel`. Fixes github issue #80 
+* Fixed style "shifts" when using `read_style=True` and `header=None` with `StyleFrame.read_excel`. Fixes [GitHub issue #80](https://github.com/DeepSpace2/StyleFrame/issues/80) 
 
 #### 3.0.3
-No longer relying on openpyxl's colors definition. Related to github issue #73
+No longer relying on openpyxl's colors definition. Related to [GitHub issue #73](https://github.com/DeepSpace2/StyleFrame/issues/73)
 
 #### 3.0.2
-Hotfix release - setting maximum versions for dependencies. Related to github issue #73
+Hotfix release - setting maximum versions for dependencies. Related to [GitHub issue #73](https://github.com/DeepSpace2/StyleFrame/issues/73)
 
 #### 3.0.1
 * **Removed Python 2.7 support**
@@ -23,8 +26,8 @@ Hotfix release - setting maximum versions for dependencies. Related to github is
 
 * Added `default_grid` to `utils.borders` to allow usage of the default spreadsheet grid
 * Added `read_excel_as_template` method
-* Fixed a bug that prevented saving if `read_excel` was used with `use_openpxl_style=True`, see github issue #67
-* Allowing usage of pathlib.Path in `to_excel`, see github issue #69 
+* Fixed a bug that prevented saving if `read_excel` was used with `use_openpxl_style=True`, see [GitHub issue #67](https://github.com/DeepSpace2/StyleFrame/issues/67)
+* Allowing usage of pathlib.Path in `to_excel`, see [GitHub issue #69](https://github.com/DeepSpace2/StyleFrame/issues/69) 
 * Added ability to execute the tests from the commandline: `styleframe --test`
 
 #### 2.0.5
@@ -71,7 +74,7 @@ Hotfix release - setting maximum versions for dependencies. Related to github is
 
 #### 1.5.1
 * Fixed a bug where `read_excel` will fail when using `read_style=True` in cases
-  where specific themes are used (See github issue #37).
+  where specific themes are used (See [GitHub issue #37](https://github.com/DeepSpace2/StyleFrame/issues/37)).
 
 #### 1.5
 * Added `complement_style` and `complement_height` arguments to `StyleFrame.apply_style_by_indexes`
@@ -93,7 +96,7 @@ Hotfix release - setting maximum versions for dependencies. Related to github is
 
 #### 1.3.1
 * Improved error message if invalid style arguments are used in JSON through the commandline interface
-* Fixed an error importing utils in case there is already a utils module in Python's path (see github issue #31)
+* Fixed an error importing utils in case there is already a utils module in Python's path (see [GitHub issue #31](https://github.com/DeepSpace2/StyleFrame/issues/31))
 
 #### 1.3
 * Added `utils.fill_pattern_types`

styleframe/styler.py

@@ -61,31 +61,32 @@ def get_color_from_string(color_str, default_color=None):
                 color_str = utils.colors.get(color_str, default_color)
             return color_str
 
+        if border_type == utils.borders.default_grid:
+            if bg_color is not None or fill_pattern_type != utils.fill_pattern_types.solid:
+                raise ValueError('`bg_color`or `fill_pattern_type` conflict with border_type={}'.format(utils.borders.default_grid))
+            self.border_type = None
+            self.fill_pattern_type = None
+        else:
+            self.border_type = border_type
+            self.fill_pattern_type = fill_pattern_type
+
         self.bold = bold
         self.font = font
         self.font_size = font_size
         self.number_format = number_format
         self.protection = protection
         self.underline = underline
-        self.border_type = border_type
         self.horizontal_alignment = horizontal_alignment
         self.vertical_alignment = vertical_alignment
         self.bg_color = get_color_from_string(bg_color, default_color=utils.colors.white)
         self.font_color = get_color_from_string(font_color, default_color=utils.colors.black)
         self.shrink_to_fit = shrink_to_fit
         self.wrap_text = wrap_text
-        self.fill_pattern_type = fill_pattern_type
         self.indent = indent
         self.comment_author = comment_author
         self.comment_text = comment_text
         self.text_rotation = text_rotation
 
-        if self.border_type == utils.borders.default_grid:
-            if self.bg_color is not None:
-                raise ValueError('bg_color and border_type={} can not be used together'.format(utils.borders.default_grid))
-            self.border_type = None
-            self.fill_pattern_type = None
-
     def __eq__(self, other):
         if not isinstance(other, self.__class__):
             return False

styleframe/tests/styler_tests.py

@@ -35,6 +35,12 @@ def test_from_openpyxl_style(self):
 
         self.assertEqual(styler_obj, Styler.from_openpyxl_style(styler_obj.to_openpyxl_style(), []))
 
-    def test_default_grid_and_bg_color(self):
+    def test_default_grid_invalid_args(self):
         with self.assertRaises(ValueError):
             Styler(border_type=utils.borders.default_grid, bg_color=utils.colors.yellow)
+        with self.assertRaises(ValueError):
+            Styler(border_type=utils.borders.default_grid, fill_pattern_type=utils.fill_pattern_types.light_grid)
+        with self.assertRaises(ValueError):
+            Styler(border_type=utils.borders.default_grid, bg_color=utils.colors.yellow,
+                   fill_pattern_type=utils.fill_pattern_types.light_grid)
+

styleframe/version.py

@@ -17,7 +17,7 @@ def get_all_versions():
     return _versions_
 
 
-_version_ = '3.0.5'
+_version_ = '3.0.6'
 _python_version_ = get_python_version()
 _pandas_version_ = get_pandas_version()
 _openpyxl_version_ = get_openpyxl_version()