From d26d434b5e22d47103376b2b380c0c714f35e0a4 Mon Sep 17 00:00:00 2001 From: JulienBacquart <16917004+JulienBacquart@users.noreply.github.com> Date: Fri, 19 Jul 2024 16:25:41 +0200 Subject: [PATCH 1/7] fix typo in contributing.rst function_name -> functionName --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 867dc41c..e3d1e6b0 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -98,7 +98,7 @@ Naming Conventions noun that describes what information is contained in the variable. If a ``bool``, preface with ``is_`` or ``has_`` or similar question-word that can be answered with a yes-or-no. -* ``function_name`` and not ``function_name`` or ``functionName``. Should be an +* ``function_name`` and not ``functionName`` or ``FunctionName``. Should be an imperative that describes what the function does (e.g. ``get_next_page``). * ``CONSTANT_NAME`` and not ``constant_name`` or ``ConstantName``. * ``ClassName`` and not ``class_name`` or ``Class_Name``. From d2dd9ca469c47aa2bdafb2c3d2d2efa3aa0a26db Mon Sep 17 00:00:00 2001 From: JulienBacquart <16917004+JulienBacquart@users.noreply.github.com> Date: Wed, 24 Jul 2024 16:41:40 +0200 Subject: [PATCH 2/7] Fix typos in glossary.rst JavaScriot -> JavaScript --- docs/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/glossary.rst b/docs/glossary.rst index 3e4d2503..4dfce604 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -241,7 +241,7 @@ Glossary JavaScript Object Literal Notation *is* JavaScript source code. JSON is not. JSON is a way of encoding data into a text form that JavaScript is able to parse and - deserialize. Because Highcharts JS relies heavily on JavaScriot object literal + deserialize. Because Highcharts JS relies heavily on JavaScript object literal notation to support the definition of :term:`event handlers ` and :term:`callback functions `, **Highcharts for Python** is designed to serialize and deserialize Python representations to/from their JavaScript object @@ -254,7 +254,7 @@ Glossary :widths: 50 50 :header-rows: 1 - * - JavaScriot Object Literal Notation + * - JavaScript Object Literal Notation - JSON * - | .. code-block:: JavaScript From 1577cef55ade30e3764fb6a9d862263bf4a830f4 Mon Sep 17 00:00:00 2001 From: JulienBacquart <16917004+JulienBacquart@users.noreply.github.com> Date: Wed, 24 Jul 2024 16:44:08 +0200 Subject: [PATCH 3/7] Fix typos in metaclasses.py JavaScriot -> JavaScript --- highcharts_core/metaclasses.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/highcharts_core/metaclasses.py b/highcharts_core/metaclasses.py index 529ed695..7e44a9f8 100644 --- a/highcharts_core/metaclasses.py +++ b/highcharts_core/metaclasses.py @@ -704,7 +704,7 @@ def from_js_literal(cls, return cls.from_js_literal(prefixed_str, _break_loop_on_failure = True) elif not checkers.is_type(body, 'VariableDeclaration'): - raise errors.HighchartsVariableDeclarationError('To parse a JavaScriot ' + raise errors.HighchartsVariableDeclarationError('To parse a JavaScript ' 'object literal, it is ' 'expected to be either a ' 'variable declaration or a' @@ -1338,7 +1338,7 @@ def from_js_literal(cls, return cls.from_js_literal(prefixed_str, _break_loop_on_failure = True) elif not checkers.is_type(body, 'VariableDeclaration'): - raise errors.HighchartsVariableDeclarationError('To parse a JavaScriot ' + raise errors.HighchartsVariableDeclarationError('To parse a JavaScript ' 'object literal, it is ' 'expected to be either a ' 'variable declaration or a' From 620c468f76a307ae655a05e55668f75a209248bb Mon Sep 17 00:00:00 2001 From: Chris Modzelewski Date: Tue, 20 Aug 2024 13:07:49 -0400 Subject: [PATCH 4/7] Fixed value validation in DataLabel.overflow. Fixes #198. --- highcharts_core/utility_classes/data_labels.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/highcharts_core/utility_classes/data_labels.py b/highcharts_core/utility_classes/data_labels.py index e5d09331..b56bb787 100644 --- a/highcharts_core/utility_classes/data_labels.py +++ b/highcharts_core/utility_classes/data_labels.py @@ -561,8 +561,8 @@ def overflow(self, value): self._overflow = None else: value = value.lower() - if value not in ['justify', 'none']: - raise errors.HighchartsValueError(f'overflow accepts "justify" or "none".' + if value not in ['justify', 'allow', 'none']: + raise errors.HighchartsValueError(f'overflow accepts "justify", "allow", or "none".' f' Was: {value}') self._overflow = value From e8eedf21e47be11b7a4b715d93a14bcecabab27c Mon Sep 17 00:00:00 2001 From: Chris Modzelewski Date: Tue, 20 Aug 2024 13:08:20 -0400 Subject: [PATCH 5/7] Fixed for-export MapData serialization to HighchartsMeta.trim_dict() --- highcharts_core/metaclasses.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/highcharts_core/metaclasses.py b/highcharts_core/metaclasses.py index 529ed695..27d888b8 100644 --- a/highcharts_core/metaclasses.py +++ b/highcharts_core/metaclasses.py @@ -323,6 +323,18 @@ def trim_dict(untrimmed: dict, trimmed_value = str(value) if trimmed_value and trimmed_value != 'None': as_dict[key] = trimmed_value + # MapData -> dict --> object + elif checkers.is_type(value, 'MapData') and to_json and for_export: + untrimmed_value = value._to_untrimmed_dict() + updated_context = value.__class__.__name__ + topology = untrimmed_value.get('topology', None) + if topology: + trimmed_value = topology.to_dict() + else: + trimmed_value = None + + if trimmed_value: + as_dict[key] = trimmed_value # HighchartsMeta -> dict --> object elif value and hasattr(value, '_to_untrimmed_dict'): untrimmed_value = value._to_untrimmed_dict() From c34bef1d529e39ee74dbf49c081da506dbfefc7e Mon Sep 17 00:00:00 2001 From: Chris Modzelewski Date: Tue, 20 Aug 2024 13:09:17 -0400 Subject: [PATCH 6/7] Bumped version number. --- CHANGES.rst | 9 +++++++++ highcharts_core/__version__.py | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 0935d4a1..c960944e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,4 +1,13 @@ +Release 1.9.3 +========================================= + +* **BUGFIX:** Fixed incorrect export serialization of Highcharts Maps for Python map topologies. +* **BUGFIX:** Added support for value ``'allow'`` to ``DataLabel.overflow`` property. Fixes #198. + +---- + + Release 1.9.2 ========================================= diff --git a/highcharts_core/__version__.py b/highcharts_core/__version__.py index 4175d399..be0b6107 100644 --- a/highcharts_core/__version__.py +++ b/highcharts_core/__version__.py @@ -1 +1 @@ -__version__ = '1.9.2' +__version__ = '1.9.3' From 3d7fc78c602756f099b3f3bdf41b39223ca87bec Mon Sep 17 00:00:00 2001 From: Chris Modzelewski Date: Tue, 20 Aug 2024 13:19:22 -0400 Subject: [PATCH 7/7] Added entry to changelog. --- CHANGES.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES.rst b/CHANGES.rst index c960944e..8370f30f 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,6 +4,7 @@ Release 1.9.3 * **BUGFIX:** Fixed incorrect export serialization of Highcharts Maps for Python map topologies. * **BUGFIX:** Added support for value ``'allow'`` to ``DataLabel.overflow`` property. Fixes #198. +* **DOCS:** Fixed some typos in documentation (courtesy of @JulienBacquart). ----