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

hcpchris · web-flow · commit bf1ce55d0fe1 · 2023-08-06T19:22:54.000-04:00
PR for v.1.3.0
diff --git a/CHANGES.rst b/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. (#32)
+* **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.3
 =========================================
 
diff --git a/README.rst b/README.rst
@@ -84,7 +84,7 @@ Before you install, please be aware of the following "hard" dependencies:
   * Python 3.10 or higher
   * Highcharts Gantt (JS) v.10.3 or higher (not technically a Python dependency, but 
     it won't work with earlier versions of Highcharts Stock)
-  * `Highcharts Stock for Python <https://stock-docs.highchartspython.com/en/latest/>`__ v.1.0 or higher
+  * `Highcharts Stock for Python <https://stock-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/>`__
diff --git a/docs/_dependencies.rst b/docs/_dependencies.rst
@@ -32,7 +32,7 @@
         Not technically a Python dependency, but obviously **Highcharts Gantt for Python**
         will not work properly if your rendering layer does not leverage Highcharts Gantt.
 
-    * `highcharts-stock <https://stock-docs.highchartspython.com>`_ v.1.0.0 or higher
+    * `highcharts-stock <https://stock-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/>`_
diff --git a/highcharts_gantt/__version__.py b/highcharts_gantt/__version__.py
@@ -1 +1 @@
-__version__ = '1.2.3'
+__version__ = '1.3.0'
diff --git a/highcharts_gantt/options/series/data/bar.py b/highcharts_gantt/options/series/data/bar.py
@@ -1,11 +1,11 @@
 from typing import Optional, List
 
-from validator_collection import checkers
+from validator_collection import checkers, validators
 
 from highcharts_core.options.series.data.bar import (BarData,
-                                                       WaterfallData,
-                                                       WindBarbData,
-                                                       XRangeData as XRangeDataBase)
+                                                     WaterfallData,
+                                                     WindBarbData,
+                                                     XRangeData as XRangeDataBase)
 
 from highcharts_gantt.options.series.data.connect import DataConnection
 from highcharts_gantt.decorators import validate_types
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,7 +57,7 @@ classifiers = [
 
 requires-python = ">= 3.10"
 dependencies = [
-    "highcharts-stock>=1.0.0-rc1",
+    "highcharts-stock>=1.3.0",
     "esprima>=4.0.1",
     "validator-collection>=1.5.0",
     "requests>=2.31.0"
diff --git a/requirements.dev.txt b/requirements.dev.txt
@@ -16,4 +16,4 @@ requests==2.31.0
 tox==4.0.0
 urllib3==1.26.9
 validator-collection==1.5.0
-highcharts-stock>=1.0.0-rc1
+highcharts-stock>=1.3.0
diff --git a/requirements.travis.txt b/requirements.travis.txt
@@ -16,4 +16,4 @@ requests==2.31.0
 tox==4.0.0
 urllib3==1.26.9
 validator-collection==1.5.0
-highcharts-stock>=1.0.0-rc1
+highcharts-stock>=1.3.0
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 esprima==4.0.1
 requests==2.31.0
 validator-collection==1.5.0
-highcharts-stock>=1.0.0-rc1
+highcharts-stock>=1.3.0
diff --git a/tests/input_files/headless_export/output/test-basic.png b/tests/input_files/headless_export/output/test-basic.png
diff --git a/tests/input_files/headless_export/output/test-with-series-types.png b/tests/input_files/headless_export/output/test-with-series-types.png
diff --git a/tests/input_files/series/area/01.js b/tests/input_files/series/area/01.js
@@ -97,8 +97,8 @@
           symbol: 'circle',
           width: 48
         },
-        x: 'some category',
-        y: 123
+        y: 123,
+        name: 'some category'
       },
       {
         dataLabels: {
diff --git a/tests/input_files/series/area/02.js b/tests/input_files/series/area/02.js
@@ -97,8 +97,8 @@
           symbol: 'circle',
           width: 48
         },
-        x: 'some category',
-        y: 123
+        y: 123,
+        name: 'some category'
       },
       {
         dataLabels: {
diff --git a/tests/input_files/series/area/03.js b/tests/input_files/series/area/03.js
@@ -97,8 +97,8 @@
           symbol: 'circle',
           width: 48
         },
-        x: 'some category',
-        y: 123
+        y: 123,
+        name: 'some category'
       },
       {
         dataLabels: {
diff --git a/tests/input_files/series/area/04.js b/tests/input_files/series/area/04.js
@@ -99,7 +99,7 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category'
+      name: 'some category'
     },
     {
       dataLabels: {
@@ -200,8 +200,6 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-
       accessibility: {
           description: 'Some description goes here',
           enabled: true
diff --git a/tests/input_files/series/area/05.js b/tests/input_files/series/area/05.js
@@ -99,7 +99,7 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category'
+      name: 'some category'
     },
     {
       dataLabels: {
@@ -200,7 +200,6 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
 
       accessibility: {
           description: 'Some description goes here',
diff --git a/tests/input_files/series/area/06.js b/tests/input_files/series/area/06.js
@@ -99,7 +99,7 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category'
+      name: 'some category'
     },
     {
       dataLabels: {
@@ -200,7 +200,6 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
 
       accessibility: {
           description: 'Some description goes here',
diff --git a/tests/input_files/series/bar/01.js b/tests/input_files/series/bar/01.js
@@ -108,8 +108,8 @@
           symbol: 'circle',
           width: 48
         },
-        x: 'some category',
-        y: 123
+        y: 123,
+        name: 'some category'
       }
   ],
   id: 'some-id-goes-here',
diff --git a/tests/input_files/series/bar/02.js b/tests/input_files/series/bar/02.js
@@ -97,8 +97,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     },
     {
       dataLabels: {
@@ -197,8 +197,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   id: 'some-id-goes-here',
diff --git a/tests/input_files/series/bar/03.js b/tests/input_files/series/bar/03.js
@@ -99,7 +99,7 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category'
+      name: 'some category'
     },
     {
       dataLabels: {
@@ -200,7 +200,7 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category'
+      name: 'some category'
     }
   ],
   id: 'some-id-goes-here',
diff --git a/tests/input_files/series/bar/04.js b/tests/input_files/series/bar/04.js
@@ -99,8 +99,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     },
     {
       z: 456,
@@ -201,8 +201,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   id: 'some-id-goes-here',
diff --git a/tests/input_files/series/bar/06.js b/tests/input_files/series/bar/06.js
@@ -100,8 +100,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     },
     {
       direction: 45,
@@ -203,8 +203,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   id: 'some-id-goes-here',
diff --git a/tests/input_files/series/boxplot/01.js b/tests/input_files/series/boxplot/01.js
@@ -107,8 +107,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   id: 'some-id-goes-here',
diff --git a/tests/input_files/series/boxplot/02.js b/tests/input_files/series/boxplot/02.js
@@ -99,7 +99,7 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category'
+      name: 'some category'
     }
   ],
   id: 'some-id-goes-here',
diff --git a/tests/input_files/series/bubble/01.js b/tests/input_files/series/bubble/01.js
@@ -99,8 +99,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   
diff --git a/tests/input_files/series/bullet/01.js b/tests/input_files/series/bullet/01.js
@@ -111,8 +111,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     },
     {
       target: 123,
@@ -225,8 +225,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   targetOptions: {
diff --git a/tests/input_files/series/data/gantt/02.js b/tests/input_files/series/data/gantt/02.js
@@ -2,10 +2,8 @@
   collapsed: false,
   completed: 0.5,
   dependency: null,
-  end: 1675141282.0,
   milestone: false,
   parent: 'some-id-goes-here',
-  start: 1675141282.0,
   y: 123,
 
   accessibility: {
diff --git a/tests/input_files/series/dumbbell/01.js b/tests/input_files/series/dumbbell/01.js
@@ -101,7 +101,6 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
       y: 123,
 
       accessibility: {
diff --git a/tests/input_files/series/heatmap/01.js b/tests/input_files/series/heatmap/01.js
@@ -100,8 +100,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
 
diff --git a/tests/input_files/series/heatmap/02.js b/tests/input_files/series/heatmap/02.js
@@ -100,8 +100,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
 
diff --git a/tests/input_files/series/scatter/01.js b/tests/input_files/series/scatter/01.js
@@ -97,8 +97,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   jitter: {
diff --git a/tests/input_files/series/scatter/02.js b/tests/input_files/series/scatter/02.js
@@ -97,8 +97,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   jitter: {
diff --git a/tests/input_files/series/spline/01.js b/tests/input_files/series/spline/01.js
@@ -97,8 +97,8 @@
         symbol: 'circle',
         width: 48
       },
-      x: 'some category',
-      y: 123
+      y: 123,
+      name: 'some category'
     }
   ],
   colorAxis: 1,
diff --git a/tests/input_files/series/spline/02.js b/tests/input_files/series/spline/02.js
diff --git a/tests/input_files/series/vector/01.js b/tests/input_files/series/vector/01.js
diff --git a/tests/input_files/series/vector/02.js b/tests/input_files/series/vector/02.js
diff --git a/tests/options/series/test_area.py b/tests/options/series/test_area.py
diff --git a/tests/options/series/test_bar.py b/tests/options/series/test_bar.py
diff --git a/tests/options/series/test_boxplot.py b/tests/options/series/test_boxplot.py
diff --git a/tests/options/series/test_bubble.py b/tests/options/series/test_bubble.py
diff --git a/tests/options/series/test_dumbbell.py b/tests/options/series/test_dumbbell.py
diff --git a/tests/options/series/test_heatmap.py b/tests/options/series/test_heatmap.py
diff --git a/tests/options/series/test_pictorial.py b/tests/options/series/test_pictorial.py
diff --git a/tests/options/series/test_scatter.py b/tests/options/series/test_scatter.py
diff --git a/tests/options/series/test_spline.py b/tests/options/series/test_spline.py
diff --git a/tests/options/series/test_treegraph.py b/tests/options/series/test_treegraph.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '1.2.3'`
	`1`	`+__version__ = '1.3.0'`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@`
`99`	`99`	`symbol: 'circle',`
`100`	`100`	`width: 48`
`101`	`101`	`},`
`102`		`- x: 'some category'`
	`102`	`+ name: 'some category'`
`103`	`103`	`}`
`104`	`104`	`],`
`105`	`105`	`id: 'some-id-goes-here',`