Merge branch 'develop' into v.1.4-rc-branch

hcpchris · web-flow · commit 99a90d61073d · 2023-10-09T16:56:34.000-04:00
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -22,6 +22,28 @@ Release 1.4.0
 * **BUGFIX:** Fixed instability issues in Jupyter Notebooks, both when operating as a Notebook (outside of 
   Jupyter Lab) and when saved to a static HTML file (#66).
 
+--------------------
+
+Release 1.3.7
+=========================================
+
+* **BUGFIX:** Fixed bug in ``HighchartsMeta.copy()`` (#98).
+* **BUGFIX:** Fixed bug in data point serialization to primitive array.
+
+---------------------
+
+Release 1.3.6
+=========================================
+
+* **BUGFIX:** Adding missing ``menu...Style`` properties to `Navigation` class (#95).
+
+---------------------
+
+Release 1.3.5
+=========================================
+
+* **BUGFIX:** Fixed validation of style properties in the ``Legend`` class (#93).
+
 ---------------------
 
 
diff --git a/highcharts_core/js_literal_functions.py b/highcharts_core/js_literal_functions.py
@@ -81,7 +81,6 @@ def serialize_to_js_literal(item,
                     continue
                 else:
                     raise error
-
         if requires_js_objects:
             return [serialize_to_js_literal(x,
                                             encoding = encoding,
diff --git a/highcharts_core/metaclasses.py b/highcharts_core/metaclasses.py
@@ -718,8 +718,14 @@ def _copy_dict_key(cls,
 
         :returns: The value that should be placed in ``other`` for ``key``.
         """
+        if not isinstance(original, (dict, UserDict)):
+            return original
+
         original_value = original[key]
-        other_value = other.get(key, None)
+        if other is None:
+            other_value = None
+        else:
+            other_value = other.get(key, None)
 
         if isinstance(original_value, (dict, UserDict)):
             new_value = {}
diff --git a/highcharts_core/options/legend/__init__.py b/highcharts_core/options/legend/__init__.py
@@ -319,18 +319,24 @@ def floating(self, value):
             self._floating = bool(value)
 
     @property
-    def item_checkbox_style(self) -> Optional[str]:
+    def item_checkbox_style(self) -> Optional[str | dict]:
         """Default styling for the checkbox next to a legend item when
         :meth:`Legend.show_checkbox` is ``True``. Defaults to:
         ``'{"width": "13px", "height": "13px", "position":"absolute"}'``.
 
-        :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
+        :rtype: :class:`str <python:str>` or :class:`dict <python:dict>` or 
+          :obj:`None <python:None>`
         """
         return self._item_checkbox_style
 
     @item_checkbox_style.setter
     def item_checkbox_style(self, value):
-        self._item_checkbox_style = validators.string(value, allow_empty = True)
+        try:
+            self._item_checkbox_style = validators.dict(value, allow_empty = True)
+        except (ValueError, TypeError):
+            self._item_checkbox_style = validators.string(value, 
+                                                          allow_empty = True,
+                                                          coerce_value = True)
 
     @property
     def item_distance(self) -> Optional[int | float | Decimal]:
@@ -348,7 +354,7 @@ def item_distance(self, value):
                                                  minimum = 0)
 
     @property
-    def item_hidden_style(self) -> Optional[str]:
+    def item_hidden_style(self) -> Optional[str | dict]:
         """Default styling for the legend item when the corresponding series or data
         point is hidden. Defaults to:
         ``'{"color": "#cccccc"}'``.
@@ -367,10 +373,15 @@ def item_hidden_style(self) -> Optional[str]:
 
     @item_hidden_style.setter
     def item_hidden_style(self, value):
-        self._item_hidden_style = validators.string(value, allow_empty = True)
+        try:
+            self._item_hidden_style = validators.dict(value, allow_empty = True)
+        except (ValueError, TypeError):
+            self._item_hidden_style = validators.string(value, 
+                                                        allow_empty = True,
+                                                        coerce_value = True)
 
     @property
-    def item_hover_style(self) -> Optional[str]:
+    def item_hover_style(self) -> Optional[str | dict]:
         """Default styling for the legend item when the corresponding series or data
         point is in a hover state. Defaults to:
         ``'{"color": "#000000"}'``.
@@ -383,13 +394,19 @@ def item_hover_style(self) -> Optional[str]:
 
           Properties are inherited from :meth:`Legend.style` unless overridden here.
 
-        :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
+        :rtype: :class:`str <python:str>` or :class:`dict <python:dict>` or 
+          :obj:`None <python:None>`
         """
         return self._item_hover_style
 
     @item_hover_style.setter
     def item_hover_style(self, value):
-        self._item_hover_style = validators.string(value, allow_empty = True)
+        try:
+            self._item_hover_style = validators.dict(value, allow_empty = True)
+        except (ValueError, TypeError):
+            self._item_hover_style = validators.string(value, 
+                                                       allow_empty = True,
+                                                       coerce_value = True)
 
     @property
     def item_margin_bottom(self) -> Optional[int | float | Decimal]:
@@ -422,9 +439,9 @@ def item_margin_top(self, value):
                                                       minimum = 0)
 
     @property
-    def item_style(self) -> Optional[str]:
+    def item_style(self) -> Optional[str | dict]:
         """Default styling for each legend item. Defaults to:
-        ``'{"color": "#333333", "cursor": "pointer", "fontSize": "12px", "fontWeight": "bold", "textOverflow": "ellipsis"}'``.
+        ``{"color": "#333333", "cursor": "pointer", "fontSize": "12px", "fontWeight": "bold", "textOverflow": "ellipsis"}``.
 
         .. warning::
 
@@ -442,7 +459,12 @@ def item_style(self) -> Optional[str]:
 
     @item_style.setter
     def item_style(self, value):
-        self._item_style = validators.string(value, allow_empty = True)
+        try:
+            self._item_style = validators.dict(value, allow_empty = True)
+        except (ValueError, TypeError):
+            self._item_style = validators.string(value, 
+                                                 allow_empty = True,
+                                                 coerce_value = True)
 
     @property
     def item_width(self) -> Optional[int | float | Decimal]:
diff --git a/highcharts_core/options/navigation/__init__.py b/highcharts_core/options/navigation/__init__.py
@@ -23,13 +23,19 @@ def __init__(self, **kwargs):
         self._button_options = None
         self._events = None
         self._icons_url = None
+        self._menu_item_hover_style = None
+        self._menu_item_style = None
+        self._menu_style = None
 
         self.annotation_options = kwargs.get('annotation_options', None)
         self.bindings = kwargs.get('bindings', None)
         self.bindings_class_name = kwargs.get('bindings_class_name', None)
         self.button_options = kwargs.get('button_options', None)
         self.events = kwargs.get('events', None)
         self.icons_url = kwargs.get('icons_url', None)
+        self.menu_item_hover_style = kwargs.get('menu_item_hover_style', None)
+        self.menu_item_style = kwargs.get('menu_item_style', None)
+        self.menu_style = kwargs.get('menu_style', None)
 
         super().__init__(**kwargs)
 
@@ -118,6 +124,74 @@ def icons_url(self) -> Optional[str]:
     def icons_url(self, value):
         self._icons_url = validators.string(value, allow_empty = True)
 
+    @property
+    def menu_item_hover_style(self) -> Optional[str | dict]:
+        """CSS styles for the individual items within the popup menu when the user's mouse hovers over them.
+
+        .. note::
+
+          Font size defaults to 11px on desktop and 14px on touch devices.
+
+        Defaults to:
+        ``{"background": "#f2f2f2" }``.
+
+        :rtype: :class:`str <python:str>` or :class:`dict <python:dict>` or :obj:`None <python:None>`
+        """
+        return self._menu_item_hover_style
+
+    @menu_item_hover_style.setter
+    def menu_item_hover_style(self, value):
+        try:
+            self._menu_item_hover_style = validators.dict(value, allow_empty = True)
+        except (ValueError, TypeError):
+            self._menu_item_hover_style = validators.string(value,
+                                                            allow_empty = True,
+                                                            coerce_value = True)
+
+    @property
+    def menu_item_style(self) -> Optional[str | dict]:
+        """CSS styles for the individual items within the popup menu.
+
+        .. note::
+
+          Font size defaults to 11px on desktop and 14px on touch devices.
+
+        Defaults to:
+        ``{"padding": "0.5em", "color": "#333333", "background": "none", "borderRadius": "3px", "fontSize": "0.8em", "transition": "background 250ms, color 250ms"}``.
+
+        :rtype: :class:`str <python:str>` or :class:`dict <python:dict>` or :obj:`None <python:None>`
+        """
+        return self._menu_item_style
+
+    @menu_item_style.setter
+    def menu_item_style(self, value):
+        try:
+            self._menu_item_style = validators.dict(value, allow_empty = True)
+        except (ValueError, TypeError):
+            self._menu_item_style = validators.string(value,
+                                                      allow_empty = True,
+                                                      coerce_value = True)
+
+    @property
+    def menu_style(self) -> Optional[str | dict]:
+        """CSS styles for the popup menu appearing when the popup button is clicked.
+
+        Defaults to:
+        ``{"background": "#ffffff", "borderRadius": "3px", "padding": "0.5em"}``.
+
+        :rtype: :class:`str <python:str>` or :class:`dict <python:dict>` or :obj:`None <python:None>`
+        """
+        return self._menu_style
+
+    @menu_style.setter
+    def menu_style(self, value):
+        try:
+            self._menu_style = validators.dict(value, allow_empty = True)
+        except (ValueError, TypeError):
+            self._menu_style = validators.string(value,
+                                                 allow_empty = True,
+                                                 coerce_value = True)
+
     @classmethod
     def _get_kwargs_from_dict(cls, as_dict):
         kwargs = {
@@ -127,6 +201,9 @@ def _get_kwargs_from_dict(cls, as_dict):
             'button_options': as_dict.get('buttonOptions', None),
             'events': as_dict.get('events', None),
             'icons_url': as_dict.get('iconsURL', None),
+            'menu_item_hover_style': as_dict.get('menuItemHoverStyle', None),
+            'menu_item_style': as_dict.get('menuItemStyle', None),
+            'menu_style': as_dict.get('menuStyle', None),
         }
 
         return kwargs
@@ -138,7 +215,10 @@ def _to_untrimmed_dict(self, in_cls = None) -> dict:
             'bindingsClassName': self.bindings_class_name,
             'buttonOptions': self.button_options,
             'events': self.events,
-            'iconsURL': self.icons_url
+            'iconsURL': self.icons_url,
+            'menuItemHoverStyle': self.menu_item_hover_style,
+            'menuItemStyle': self.menu_item_style,
+            'menuStyle': self.menu_style,
         }
 
         return untrimmed
@@ -194,6 +274,9 @@ def _get_kwargs_from_dict(cls, as_dict):
             'button_options': as_dict.get('buttonOptions', None),
             'events': as_dict.get('events', None),
             'icons_url': as_dict.get('iconsURL', None),
+            'menu_item_hover_style': as_dict.get('menuItemHoverStyle', None),
+            'menu_item_style': as_dict.get('menuItemStyle', None),
+            'menu_style': as_dict.get('menuStyle', None),
 
             'breadcrumbs': as_dict.get('breadcrumbs', None),
         }
diff --git a/tests/input_files/navigation/navigation/01.js b/tests/input_files/navigation/navigation/01.js
@@ -36,5 +36,23 @@
     selectButton: function (event) {return true;},
     showPopup: function(event) {return true;}
   },
-  iconsURL: 'https://www.somewhere.com/'
+  iconsURL: 'https://www.somewhere.com/',
+  menuItemHoverStyle: {
+    'color': '#5f5e5e',
+    'fontFamily': 'Roboto',
+    'fontSize': '12px',
+    'fontWeight': '400'
+  },
+  menuItemStyle: {
+    'color': '#5f5e5e',
+    'fontFamily': 'Roboto',
+    'fontSize': '12px',
+    'fontWeight': '400'
+  },
+  menuStyle: {
+    'color': '#5f5e5e',
+    'fontFamily': 'Roboto',
+    'fontSize': '12px',
+    'fontWeight': '400'
+  }
 }
diff --git a/tests/options/legend/test_legend.py b/tests/options/legend/test_legend.py
@@ -59,6 +59,13 @@
       'x': 0,
       'y': 0
     }, None),
+    ({
+        'item_style': {
+            'color': '#5f5e5e',
+            'fontFamily': 'Roboto',
+            'fontSize': '12px'
+        }
+    }, None),
 ]
 
 
diff --git a/tests/options/navigation/test_navigation.py b/tests/options/navigation/test_navigation.py
@@ -93,7 +93,10 @@
         'selectButton': """function (event) {return true;}""",
         'showPopup': """function(event) {return true;}"""
       },
-      'icons_url': 'https://www.somewhere.com/'
+      'icons_url': 'https://www.somewhere.com/',
+      'menu_item_style': {"fontWeight": "bold", "fontSize": "12px"},
+      'menu_item_hover_style': {"fontWeight": "bold", "fontSize": "12px"},
+      'menu_style': {"border-width": "1px"}
     }, None),
 ]
 
diff --git a/tests/options/series/data/test_base.py b/tests/options/series/data/test_base.py
@@ -1,6 +1,7 @@
 """Tests for ``highcharts.no_data``."""
 
 import pytest
+from typing import List
 
 from json.decoder import JSONDecodeError
 
@@ -17,13 +18,38 @@ class NonAbstractDataBase(DataBase):
     def from_array(cls, value):
         pass
 
+    def _get_props_from_array(self) -> List[str]:
+        """Returns a list of the property names that can be set using the
+        :meth:`.from_array() <highcharts_core.options.series.data.base.DataBase.from_array>`
+        method.
+        
+        :rtype: :class:`list <python:list>` of :class:`str <python:str>`
+        """
+        return ['fromArrayProp1', 'fromArrayProp2']
+
+
+
 cls = NonAbstractDataBase
 
 
 class RequiringJSObject(NonAbstractDataBase):
     def _to_untrimmed_dict(self):
         return {'someKey': 123}
 
+class NotRequiringJSObject(NonAbstractDataBase):
+    def _to_untrimmed_dict(self):
+        return {
+            'fromArrayProp1': 456,
+            'fromArrayProp2': 789
+        }
+
+
+class RequiringJSObject2(NonAbstractDataBase):
+    def _to_untrimmed_dict(self):
+        return {'someKey': 123,
+                'fromArrayProp1': 456,
+                'fromArrayProp2': 789}
+
 
 STANDARD_PARAMS = [
     ({}, None),
@@ -102,8 +128,10 @@ def test_from_js_literal(input_files, filename, as_file, error):
 
 @pytest.mark.parametrize('cls, expected', [
     (NonAbstractDataBase, False),
+    (NotRequiringJSObject, False),
     (RequiringJSObject, True),
-    
+    (RequiringJSObject2, True)
+
 ])
 def test_requires_js_object(cls, expected):
     obj = cls()
diff --git a/tests/test_metaclasses.py b/tests/test_metaclasses.py
