highcharts-for-python · hcpchris · Aug 6, 2023 · Aug 2, 2023 · Aug 3, 2023 · Aug 3, 2023
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. (#77)
+* **ENHANCEMENT:** Added ``__repr__()`` method for Highcharts Core for Python classes (#76).
+* **ENHANCEMENT:** Added ``__str__()`` method with special handling for difficult-to-read classes (#76).
+* **ENHANCEMENT:** Added ``Chart.get_script_tags()`` to retrieve Javascript ``<script>`` tags (#78).
+* **ENHANCEMENT:** Added ``utility_functions.to_snake_case()`` function.
+* **BUGFIX:** Fixed incorrect serialization of datetime and Pandas ``Timestamp`` objects in ``.to_dict()`` and ``.to_json()`` (#74).
+* **BUGFIX:** Fixed incorrect serialization of ``EnforcedNull`` in ``.to_dict()`` and ``.to_json()`` (#75).
+
+------------------
+
 Release 1.2.6
 =========================================
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -713,6 +713,7 @@ familiarize yourself with these internals.
       :func:`mro__to_untrimmed_dict() <highcharts_core.utility_functions.mro__to_untrimmed_dict>`
       :func:`validate_color() <highcharts_core.utility_functions.validate_color>`
       :func:`to_camelCase() <highcharts_core.utility_functions.to_camelCase>`
+      :func:`to_snake_case() <highcharts_core.utility_functions.to_snake_case>`
       :func:`parse_csv() <highcharts_core.utility_functions.parse_csv>`
 
 .. target-notes::

diff --git a/docs/api/chart.rst b/docs/api/chart.rst
@@ -18,6 +18,7 @@ class: :class:`Chart <highcharts_core.chart.Chart>`
 .. autoclass:: Chart
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/internals.rst b/docs/api/internals.rst
@@ -165,6 +165,11 @@ function:: :func:`to_camelCase() <highcharts_core.utility_functions.to_camelCase
 
 .. autofunction:: to_camelCase
 
+function:: :func:`to_snake_case() <highcharts_core.utility_functions.to_snake_case>`
+=====================================================================================================
+
+.. autofunction:: to_snake_case
+
 function:: :func:`parse_csv() <highcharts_core.utility_functions.parse_csv>`
 =====================================================================================================
 

diff --git a/docs/api/options/index.rst b/docs/api/options/index.rst
@@ -46,6 +46,7 @@ class: :class:`HighchartsOptions <highcharts_core.options.HighchartsOptions>`
 .. autoclass:: HighchartsOptions
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
 -----------------------
 
@@ -56,6 +57,7 @@ class: :class:`Options <highcharts_core.options.Options>`
 .. autoclass:: Options
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
 -----------------------
 

diff --git a/docs/api/options/series/arcdiagram.rst b/docs/api/options/series/arcdiagram.rst
@@ -17,7 +17,8 @@ class: :class:`ArcDiagramSeries <highcharts_core.options.series.arcdiagram.ArcDi
 
 .. autoclass:: ArcDiagramSeries
   :members:
-  :inherited-members:
+    :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/area.rst b/docs/api/options/series/area.rst
@@ -18,6 +18,7 @@ class: :class:`AreaSeries <highcharts_core.options.series.area.AreaSeries>`
 .. autoclass:: AreaSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -36,6 +37,7 @@ class: :class:`AreaRangeSeries <highcharts_core.options.series.area.AreaRangeSer
 .. autoclass:: AreaRangeSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -54,6 +56,7 @@ class: :class:`AreaSplineSeries <highcharts_core.options.series.area.AreaSplineS
 .. autoclass:: AreaSplineSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -72,6 +75,7 @@ class: :class:`AreaSplineRangeSeries <highcharts_core.options.series.area.AreaSp
 .. autoclass:: AreaSplineRangeSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -90,6 +94,7 @@ class: :class:`LineSeries <highcharts_core.options.series.area.LineSeries>`
 .. autoclass:: LineSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -108,6 +113,7 @@ class: :class:`StreamGraphSeries <highcharts_core.options.series.area.StreamGrap
 .. autoclass:: StreamGraphSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/bar.rst b/docs/api/options/series/bar.rst
@@ -18,6 +18,7 @@ class: :class:`BarSeries <highcharts_core.options.series.bar.BarSeries>`
 .. autoclass:: BarSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -36,6 +37,7 @@ class: :class:`ColumnSeries <highcharts_core.options.series.bar.ColumnSeries>`
 .. autoclass:: ColumnSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -54,6 +56,7 @@ class: :class:`ColumnPyramidSeries <highcharts_core.options.series.bar.ColumnPyr
 .. autoclass:: ColumnPyramidSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -72,6 +75,7 @@ class: :class:`ColumnRangeSeries <highcharts_core.options.series.bar.ColumnRange
 .. autoclass:: ColumnRangeSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -90,6 +94,7 @@ class: :class:`CylinderSeries <highcharts_core.options.series.bar.CylinderSeries
 .. autoclass:: CylinderSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -108,6 +113,7 @@ class: :class:`VariwideSeries <highcharts_core.options.series.bar.VariwideSeries
 .. autoclass:: VariwideSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -126,6 +132,7 @@ class: :class:`WaterfallSeries <highcharts_core.options.series.bar.WaterfallSeri
 .. autoclass:: WaterfallSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -144,6 +151,7 @@ class: :class:`WindBarbSeries <highcharts_core.options.series.bar.WindBarbSeries
 .. autoclass:: WindBarbSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -180,6 +188,8 @@ class: :class:`BaseBarSeries <highcharts_core.options.series.bar.BaseBarSeries>`
 .. autoclass:: BaseBarSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/base.rst b/docs/api/options/series/base.rst
@@ -18,6 +18,7 @@ class: :class:`SeriesBase <highcharts_core.options.series.base.SeriesBase>`
 .. autoclass:: SeriesBase
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/bellcurve.rst b/docs/api/options/series/bellcurve.rst
@@ -18,6 +18,7 @@ class: :class:`BellCurveSeries <highcharts_core.options.series.bellcurve.BellCur
 .. autoclass:: BellCurveSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/boxplot.rst b/docs/api/options/series/boxplot.rst
@@ -18,6 +18,7 @@ class: :class:`BoxPlotSeries <highcharts_core.options.series.boxplot.BoxPlotSeri
 .. autoclass:: BoxPlotSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -36,6 +37,7 @@ class: :class:`ErrorBarSeries <highcharts_core.options.series.boxplot.ErrorBarSe
 .. autoclass:: ErrorBarSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/bubble.rst b/docs/api/options/series/bubble.rst
@@ -18,6 +18,7 @@ class: :class:`BubbleSeries <highcharts_core.options.series.bubble.BubbleSeries>
 .. autoclass:: BubbleSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/bullet.rst b/docs/api/options/series/bullet.rst
@@ -18,6 +18,7 @@ class: :class:`BulletSeries <highcharts_core.options.series.bullet.BulletSeries>
 .. autoclass:: BulletSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/dependencywheel.rst b/docs/api/options/series/dependencywheel.rst
@@ -18,6 +18,7 @@ class: :class:`DependencyWheelSeries <highcharts_core.options.series.dependencyw
 .. autoclass:: DependencyWheelSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/dumbbell.rst b/docs/api/options/series/dumbbell.rst
@@ -18,6 +18,7 @@ class: :class:`DumbbellSeries <highcharts_core.options.series.dumbbell.DumbbellS
 .. autoclass:: DumbbellSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -36,6 +37,7 @@ class: :class:`LollipopSeries <highcharts_core.options.series.dumbbell.LollipopS
 .. autoclass:: LollipopSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/funnel.rst b/docs/api/options/series/funnel.rst
@@ -18,6 +18,7 @@ class: :class:`FunnelSeries <highcharts_core.options.series.funnel.FunnelSeries>
 .. autoclass:: FunnelSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -36,6 +37,7 @@ class: :class:`Funnel3DSeries <highcharts_core.options.series.funnel.Funnel3DSer
 .. autoclass:: Funnel3DSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/gauge.rst b/docs/api/options/series/gauge.rst
@@ -18,6 +18,7 @@ class: :class:`GaugeSeries <highcharts_core.options.series.gauge.GaugeSeries>`
 .. autoclass:: GaugeSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -36,6 +37,7 @@ class: :class:`SolidGaugeSeries <highcharts_core.options.series.gauge.SolidGauge
 .. autoclass:: SolidGaugeSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/heatmap.rst b/docs/api/options/series/heatmap.rst
@@ -18,6 +18,7 @@ class: :class:`HeatmapSeries <highcharts_core.options.series.heatmap.HeatmapSeri
 .. autoclass:: HeatmapSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -36,6 +37,7 @@ class: :class:`TilemapSeries <highcharts_core.options.series.heatmap.TilemapSeri
 .. autoclass:: TilemapSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/histogram.rst b/docs/api/options/series/histogram.rst
@@ -18,6 +18,7 @@ class: :class:`HistogramSeries <highcharts_core.options.series.histogram.Histogr
 .. autoclass:: HistogramSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/item.rst b/docs/api/options/series/item.rst
@@ -18,6 +18,7 @@ class: :class:`ItemSeries <highcharts_core.options.series.item.ItemSeries>`
 .. autoclass:: ItemSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/networkgraph.rst b/docs/api/options/series/networkgraph.rst
@@ -18,6 +18,7 @@ class: :class:`NetworkGraphSeries <highcharts_core.options.series.networkgraph.N
 .. autoclass:: NetworkGraphSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/organization.rst b/docs/api/options/series/organization.rst
@@ -18,6 +18,7 @@ class: :class:`OrganizationSeries <highcharts_core.options.series.organization.O
 .. autoclass:: OrganizationSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/packedbubble.rst b/docs/api/options/series/packedbubble.rst
@@ -18,6 +18,7 @@ class: :class:`PackedBubbleSeries <highcharts_core.options.series.packedbubble.P
 .. autoclass:: PackedBubbleSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/pareto.rst b/docs/api/options/series/pareto.rst
@@ -18,6 +18,7 @@ class: :class:`ParetoSeries <highcharts_core.options.series.pareto.ParetoSeries>
 .. autoclass:: ParetoSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/pictorial.rst b/docs/api/options/series/pictorial.rst
@@ -18,6 +18,7 @@ class: :class:`PictorialSeries <highcharts_core.options.series.pictorial.Pictori
 .. autoclass:: PictorialSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -38,6 +39,7 @@ class: :class:`PictorialPaths <highcharts_core.options.series.pictorial.Pictoria
 .. autoclass:: PictorialPaths
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/pie.rst b/docs/api/options/series/pie.rst
@@ -18,6 +18,7 @@ class: :class:`PieSeries <highcharts_core.options.series.pie.PieSeries>`
 .. autoclass:: PieSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 
@@ -37,6 +38,7 @@ class: :class:`VariablePieSeries <highcharts_core.options.series.pie.VariablePie
 .. autoclass:: VariablePieSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance
 

diff --git a/docs/api/options/series/polygon.rst b/docs/api/options/series/polygon.rst
@@ -18,6 +18,7 @@ class: :class:`PolygonSeries <highcharts_core.options.series.polygon.PolygonSeri
 .. autoclass:: PolygonSeries
   :members:
   :inherited-members:
+  :special-members: __str__, __repr__
 
   .. collapse:: Class Inheritance