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

PR for v.1.3.0

Author: hcpchris

CHANGES.rst

@@ -1,3 +1,16 @@
+Release 1.3.0
+=========================================
+
+* **ENHANCEMENT:** Modified the way that data points are serialized to JavaScript literal objects. Now, they are serialized to a JavaScript array if their configured properties are those that Highcharts (JS) supports in JavaScript array notation. Otherwise, the code falls back to serialize the data point as a JavaScript object literal. This change is intended to improve performance and reduce the size of the serialized data. (#27)
+* **ENHANCEMENT:** Added ``__repr__()`` method for Highcharts Core for Python classes.
+* **ENHANCEMENT:** Added ``__str__()`` method with special handling for difficult-to-read classes.
+* **ENHANCEMENT:** Added ``Chart.get_script_tags()`` to retrieve Javascript ``<script>`` tags.
+* **ENHANCEMENT:** Added ``utility_functions.to_snake_case()`` function.
+* **BUGFIX:** Fixed incorrect serialization of datetime and Pandas ``Timestamp`` objects in ``.to_dict()`` and ``.to_json()``.
+* **BUGFIX:** Fixed incorrect serialization of ``EnforcedNull`` in ``.to_dict()`` and ``.to_json()``.
+
+-------------------
+
 Release 1.2.1
 =========================================
 

README.rst

@@ -80,7 +80,7 @@ Before you install, please be aware of the following "hard" dependencies:
   * Python 3.10 or higher
   * Highcharts Stock (JS) v.10.2 or higher (not technically a Python dependency, but 
     it won't work with earlier versions of Highcharts Stock)
-  * `Highcharts Core for Python <https://core-docs.highchartspython.com/en/latest/>`__ v.1.0 or higher
+  * `Highcharts Core for Python <https://core-docs.highchartspython.com/en/latest/>`__ v.1.3 or higher
   * `esprima-python <https://github.com/Kronuz/esprima-python>`__ v.4.0 or higher
   * `requests <https://requests.readthedocs.io/en/latest/>`__ v.2.31 or higher
   * `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`__

docs/_dependencies.rst

@@ -32,7 +32,7 @@
         Not technically a Python dependency, but obviously **Highcharts Stock for Python**
         will not work properly if your rendering layer does not leverage Highcharts Stock.
 
-    * `highcharts-core <https://core-docs.highchartspython.com>`_ v.1.0.0 or higher
+    * `highcharts-core <https://core-docs.highchartspython.com>`_ v.1.3.0 or higher
     * `esprima-python <https://github.com/Kronuz/esprima-python>`_ v.4.0 or higher
     * `requests <https://requests.readthedocs.io/en/latest/>`_ v.2.31 or higher
     * `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`_

highcharts_stock/__version__.py

@@ -1 +1 @@
-__version__ = '1.2.1'
+__version__ = '1.3.0'

highcharts_stock/options/series/data/hlc.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, List, Dict
 from decimal import Decimal
 
 from validator_collection import validators, checkers
@@ -237,10 +237,71 @@ def from_array(cls, value):
                                                   f'be a DataBase Data Point or be '
                                                   f'coercable to one. Could not coerce: '
                                                   f'{item}')
+            if checkers.is_string(as_obj.x) and not as_obj.name:
+                as_obj.name = as_obj.x
+                as_obj.x = None
+
             collection.append(as_obj)
 
         return collection
 
+    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 ['x', 'high', 'low', 'close', 'name']
+
+    def to_array(self, force_object = False) -> List | Dict:
+        """Generate the array representation of the data point (the inversion 
+        of 
+        :meth:`.from_array() <highcharts_core.options.series.data.base.DataBase.from_array>`).
+        
+        .. warning::
+        
+          If the data point *cannot* be serialized to a JavaScript array,
+          this method will instead return the untrimmed :class:`dict <python:dict>`
+          representation of the data point as a fallback.
+
+        :param force_object: if ``True``, forces the return of the instance's
+          untrimmed :class:`dict <python:dict>` representation. Defaults to ``False``.
+        :type force_object: :class:`bool <python:bool>`
+
+        :returns: The array representation of the data point.
+        :rtype: :class:`list <python:list>` of values or :class:`dict <python:dict>`
+        """
+        if self.requires_js_object or force_object:
+            return self._to_untrimmed_dict()
+        
+        if self.x is not None:
+            x = self.x
+        elif self.name is not None:
+            x = self.name
+        else:
+            x = constants.EnforcedNull
+            
+        if self.high is not None:
+            high = self.high
+        else:
+            high = constants.EnforcedNull
+
+        if self.low is not None:
+            low = self.low
+        else:
+            low = constants.EnforcedNull
+            
+        if self.close is not None:
+            close = self.close
+        else:
+            close = constants.EnforcedNull
+            
+        if self.x is None and self.name is None:
+            return [high, low, close]
+
+        return [x, high, low, close]
+
 
 class OHLCData(HLCData):
     """Data point that can be visualized in a
@@ -371,6 +432,72 @@ def from_array(cls, value):
                                                   f'be a DataBase Data Point or be '
                                                   f'coercable to one. Could not coerce: '
                                                   f'{item}')
+            if checkers.is_string(as_obj.x) and not as_obj.name:
+                as_obj.name = as_obj.x
+                as_obj.x = None
+
             collection.append(as_obj)
 
         return collection
+
+    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 ['x', 'open', 'high', 'low', 'close', 'name']
+
+    def to_array(self, force_object = False) -> List | Dict:
+        """Generate the array representation of the data point (the inversion 
+        of 
+        :meth:`.from_array() <highcharts_core.options.series.data.base.DataBase.from_array>`).
+        
+        .. warning::
+        
+          If the data point *cannot* be serialized to a JavaScript array,
+          this method will instead return the untrimmed :class:`dict <python:dict>`
+          representation of the data point as a fallback.
+
+        :param force_object: if ``True``, forces the return of the instance's
+          untrimmed :class:`dict <python:dict>` representation. Defaults to ``False``.
+        :type force_object: :class:`bool <python:bool>`
+
+        :returns: The array representation of the data point.
+        :rtype: :class:`list <python:list>` of values or :class:`dict <python:dict>`
+        """
+        if self.requires_js_object or force_object:
+            return self._to_untrimmed_dict()
+        
+        if self.x is not None:
+            x = self.x
+        elif self.name is not None:
+            x = self.name
+        else:
+            x = constants.EnforcedNull
+            
+        if self.open is not None:
+            open_ = self.open
+        else:
+            open_ = constants.EnforcedNull
+            
+        if self.high is not None:
+            high = self.high
+        else:
+            high = constants.EnforcedNull
+
+        if self.low is not None:
+            low = self.low
+        else:
+            low = constants.EnforcedNull
+            
+        if self.close is not None:
+            close = self.close
+        else:
+            close = constants.EnforcedNull
+            
+        if self.x is None and self.name is None:
+            return [open, high, low, close]
+
+        return [x, open, high, low, close]

pyproject.toml

@@ -59,7 +59,7 @@ classifiers = [
 
 requires-python = ">= 3.10"
 dependencies = [
-    "highcharts-core>=1.0.0-rc1",
+    "highcharts-core>=1.3.0",
     "esprima>=4.0.1",
     "validator-collection>=1.5.0",
     "requests>=2.31.0"

requirements.dev.txt

@@ -12,4 +12,4 @@ tox==4.4.6
 requests==2.31.0
 urllib3==1.26.9
 validator-collection==1.5.0
-highcharts-core>=1.0.0-rc1
+highcharts-core>=1.3.0

requirements.travis.txt

@@ -14,4 +14,4 @@ tox==4.4.6
 requests==2.31.0
 urllib3==1.26.9
 validator-collection==1.5.0
-highcharts-core>=1.0.0-rc1
+highcharts-core>=1.3.0

requirements.txt

@@ -1,4 +1,4 @@
 esprima==4.0.1
 requests==2.31.0
 validator-collection==1.5.0
-highcharts-core>=1.0.0-rc1
+highcharts-core>=1.3.0