Merge pull request #173 from highcharts-for-python/develop

PR for v.1.7.3

Author: hcpchris

CHANGES.rst

@@ -1,4 +1,15 @@
 
+Release 1.7.3
+=========================================
+
+* **BUGFIX:** Fixed handling of boolean values in ``GenericTypeOptions.animation`` property.
+* **BUGFIX:** Fixed incorrect serialization of format strings that begin with ``{`` and end with ``}``.
+  In particular, now added an "escape hatch" if the ``{...}`` string is prefixed with ``$`` to ensure
+  proper serialization.
+* **BUGFIX:** Adjusted export support for Highcharts Node Export Server v.3.1.1.
+
+--------------------
+
 Release 1.7.2
 =========================================
 

highcharts_core/__version__.py

@@ -1 +1 @@
-__version__ = '1.7.2'
+__version__ = '1.7.3'

highcharts_core/constants.py

@@ -944,10 +944,6 @@ def __repr__(self):
 ]
 
 EXPORT_SERVER_UNSUPPORTED_SERIES_TYPES = [
-    'pictorial',
-    'flowmap',
-    'geoheatmap',
-    'treegraph',
 ]
 
 

highcharts_core/headless_export.py

@@ -39,10 +39,12 @@ def __init__(self, **kwargs):
         self._url = None
         self._port = None
         self._path = None
+
         self._options = None
         self._format_ = None
         self._scale = None
         self._width = None
+        self._height = None
         self._callback = None
         self._constructor = None
         self._use_base64 = None
@@ -61,12 +63,14 @@ def __init__(self, **kwargs):
                                                  ''))
         self.path = kwargs.get('path', os.getenv('HIGHCHARTS_EXPORT_SERVER_PATH',
                                                  ''))
+
         self.options = kwargs.get('options', None)
         self.format_ = kwargs.get('format_', kwargs.get('type', 'png'))
         self.scale = kwargs.get('scale', 1)
         self.width = kwargs.get('width', None)
+        self.height = kwargs.get('height', None)
         self.callback = kwargs.get('callback', None)
-        self.constructor = kwargs.get('constructor', 'Chart')
+        self.constructor = kwargs.get('constructor', 'chart')
         self.use_base64 = kwargs.get('use_base64', False)
         self.no_download = kwargs.get('no_download', False)
         self.async_rendering = kwargs.get('async_rendering', False)
@@ -404,6 +408,28 @@ def width(self, value):
 
         self._width = value
 
+    @property
+    def height(self) -> Optional[int | float]:
+        """The height that the exported chart should have. Defaults to
+        :obj:`None <python:None>`.
+
+        .. warning::
+
+          If explicitly set, this setting will override
+          :meth:`scale <ExportServer.scale>`.
+
+        :rtype: numeric or :obj:`None <python:None>`
+        """
+        return self._height
+
+    @height.setter
+    def height(self, value):
+        value = validators.numeric(value, allow_empty=True, minimum=0)
+        if not value:
+            value = None
+
+        self._height = value
+
     @property
     def callback(self) -> Optional[CallbackFunction]:
         """A JavaScript function to execute in the (JavaScript) Highcharts constructor.
@@ -429,7 +455,13 @@ def constructor(self) -> Optional[str]:
         Accepts:
 
           * ``'Chart'``
+          * ``'chart'``
           * ``'Stock'``
+          * ``'stockChart'``
+          * ``'Map'``
+          * ``'mapChart'``
+          * ``'Gantt'``
+          * ``'ganttChart'``
 
         :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
         """
@@ -441,11 +473,19 @@ def constructor(self, value):
         if not value:
             self._constructor = None
         else:
-            if value not in ['Chart', 'Stock']:
+            if value not in ['Chart', 'Stock', 'Map', 'Gantt', 'chart', 'stockChart', 'mapChart', 'ganttChart',]:
                 raise errors.HighchartsUnsupportedConstructorError(f'constructor expects '
-                                                                   f'either "Chart" or '
-                                                                   f'"Stock", but '
+                                                                   f'"Chart", "Stock", "Map", "Gantt", "chart", '
+                                                                   f'"stockChart",  "mapChart", or "ganttChart", but '
                                                                    f'received: "{value}"')
+            if value == 'Chart':
+                value = 'chart'
+            elif value == 'Stock':
+                value = 'stockChart'
+            elif value == 'Map':
+                value = 'mapChart'
+            elif value == 'Gantt':
+                value = 'ganttChart'
 
             self._constructor = value
 
@@ -669,7 +709,6 @@ def request_chart(self,
         self.no_download = kwargs.get('no_download', self.no_download)
         self.async_rendering = kwargs.get('async_rendering', self.async_rendering)
         self.global_options = kwargs.get('global_options', self.global_options)
-        self.data_options = kwargs.get('data_options', self.data_options)
         self.custom_code = kwargs.get('custom_code', self.custom_code)
 
         missing_details = []
@@ -701,16 +740,15 @@ def request_chart(self,
             'constr': self.constructor,
             'b64': self.use_base64,
             'noDownload': self.no_download,
-            'asyncRendering': self.async_rendering
         }
         if self.width:
             payload['width'] = self.width
+        if self.height:
+            payload['height'] = self.height
         if self.callback:
             payload['callback'] = 'HIGHCHARTS FOR PYTHON: REPLACE WITH CALLBACK'
         if self.global_options:
             payload['globalOptions'] = 'HIGHCHARTS FOR PYTHON: REPLACE WITH GLOBAL'
-        if self.data_options:
-            payload['dataOptions'] = 'HIGHCHARTS FOR PYTHON: REPLACE WITH DATA'
         if self.custom_code:
             payload['customCode'] = 'HIGHCHARTS FOR PYTHON: REPLACE WITH CUSTOM'
 

highcharts_core/js_literal_functions.py

@@ -373,6 +373,12 @@ def get_js_literal(item, careful_validation = False) -> str:
     elif isinstance(item, str):
         if (item.startswith('[') or item.startswith('Date')) and item != 'Date':
             as_str += f"""{item}"""
+        elif item.startswith('${'):
+            if "'" in item:
+                item = item.replace("'", "\\'")
+                as_str += f'"{item[1:]}"'
+            else:
+                as_str += f"'{item[1:]}'"
         elif item.startswith('{') and item.endswith('}'):
             if is_js_object(item, careful_validation = careful_validation):
                 as_str += f"""{item}"""

highcharts_core/metaclasses.py

@@ -220,6 +220,9 @@ def trim_iterable(untrimmed,
         if isinstance(untrimmed, 
                       (str, bytes, dict, UserDict)) or not hasattr(untrimmed, 
                                                                    '__iter__'):
+            if to_json and isinstance(untrimmed, str) and untrimmed.startswith('${'):
+                return untrimmed[1:]
+            
             return untrimmed
 
         trimmed = []

highcharts_core/options/annotations/label_options.py

@@ -295,6 +295,12 @@ def format(self) -> Optional[str]:
 
           * :meth:`PlotOptions.series.data_labels`
 
+        .. warning::
+
+          If your format string begins with ``{`` and ends with ``}``, Highcharts
+          for Python may interpret it as a JavaScript or JSON object. To prevent this, please
+          add a ``$`` before the opening curly brace, like so: ``${value:.1f}``.
+
         :returns: The format string to apply to the labels.
         :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
         """

highcharts_core/options/axes/labels.py

@@ -231,6 +231,12 @@ def format(self) -> Optional[str]:
 
         To add custom numeric or datetime formatting, use ``'{value}'`` with formatting,
         for example ``'{value:.1f}'`` or ``'{value:%Y-%m-%d}'``.
+        
+        .. warning::
+        
+          If your format string begins with ``{`` and ends with ``}``, Highcharts
+          for Python may interpret it as a JavaScript or JSON object. To prevent this, please
+          add a ``$`` before the opening curly brace, like so: ``${value:.1f}``.
 
         :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
         """

highcharts_core/options/plot_options/generic.py

@@ -167,7 +167,7 @@ def allow_point_select(self, value):
             self._allow_point_select = bool(value)
 
     @property
-    def animation(self) -> Optional[AnimationOptions]:
+    def animation(self) -> Optional[AnimationOptions | bool]:
         """Enable or disable the initial animation when a series is displayed.
 
         The animation can also be set as a configuration object. Please note that this
@@ -190,9 +190,13 @@ def animation(self) -> Optional[AnimationOptions]:
         return self._animation
 
     @animation.setter
-    @class_sensitive(AnimationOptions)
     def animation(self, value):
-        self._animation = value
+        if value is None:
+            self._animation = None
+        elif value is False or value is True:
+            self._animation = value
+        else:
+            self._animation = validate_types(value, types = AnimationOptions, allow_none = False)
 
     @property
     def class_name(self) -> Optional[str]:

highcharts_core/options/series/labels.py

@@ -207,6 +207,12 @@ def format(self) -> Optional[str]:
         ``options.xxx``, ``color``, and other members from the ``series`` object.
         Use this option also to set a static text for the label.
 
+        .. warning::
+
+          If your format string begins with ``{`` and ends with ``}``, Highcharts
+          for Python may interpret it as a JavaScript or JSON object. To prevent this, please
+          add a ``$`` before the opening curly brace, like so: ``${value:.1f}``.
+
         :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
         """
         return self._format