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

PR for v.1.7.2

Author: hcpchris

CHANGES.rst

@@ -1,4 +1,12 @@
 
+Release 1.7.2
+=========================================
+
+* **BUGFIX:** Fixed incorrect handling of empty string in ``YAxis.title.text`` (#171).
+* **ENHANCEMENT:** Bumped dependency on ``requests`` to ``v.2.32``.
+
+--------------------
+
 Release 1.7.1
 =========================================
 

highcharts_core/__version__.py

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

highcharts_core/constants.py

@@ -953,6 +953,7 @@ def __repr__(self):
 
 EMPTY_STRING_CONTEXTS = [
     'Annotation.draggable',
+    'YAxisTitle.text',
 ]
 
 

highcharts_core/options/axes/title.py

@@ -1,7 +1,7 @@
 from typing import Optional
 from decimal import Decimal
 
-from validator_collection import validators
+from validator_collection import validators, checkers
 
 from highcharts_core import errors, constants
 from highcharts_core.metaclasses import HighchartsMeta
@@ -372,3 +372,76 @@ def _to_untrimmed_dict(self, in_cls = None) -> dict:
         }
 
         return untrimmed
+
+
+class YAxisTitle(AxisTitle):
+    """The axis title, shown next to the axis line."""
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    @property
+    def _dot_path(self) -> Optional[str]:
+        """The dot-notation path to the options key for the current class.
+
+        :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
+        """
+        return "yAxis.title"
+
+    @property
+    def text(self) -> Optional[str | constants.EnforcedNullType]:
+        """The actual text of the title.
+
+        .. note::
+
+          A subset of HTML is supported, e.g. ``<b>``, ``<i>``, ``<span>`` (with in-line
+          styles), etc.
+
+        .. warning::
+
+          A :meth:`.text <highcharts_core.options.axes.title.YAxisTitle.text>` of 
+          :obj:`None <python:None>` will default to ``'Values'``. To clear the Y-Axis title 
+          on your chart, set its value to an empty string (``''``).
+
+        :rtype: :class:`str <python:str>` or :obj:`None <python:None>`
+        """
+        return self._text
+
+    @text.setter
+    def text(self, value):
+        if isinstance(value, constants.EnforcedNullType):
+            self._text = constants.EnforcedNull
+        elif value == '':
+            self._text = ""
+        else:
+            self._text = validators.string(value, allow_empty=True)
+
+    @classmethod
+    def _get_kwargs_from_dict(cls, as_dict):
+        kwargs = {
+            "align": as_dict.get("align", None),
+            "margin": as_dict.get("margin", None),
+            "offset": as_dict.get("offset", None),
+            "position_3d": as_dict.get("position3d", None),
+            "reserve_space": as_dict.get("reserveSpace", None),
+            "rotation": as_dict.get("rotation", None),
+            "skew_3d": as_dict.get("skew3d", None),
+            "style": as_dict.get("style", None),
+            "text": as_dict.get("text", None),
+            "text_align": as_dict.get("textAlign", None),
+            "use_html": as_dict.get("useHTML", None),
+            "x": as_dict.get("x", None),
+            "y": as_dict.get("y", None),
+        }
+
+        return kwargs
+
+    def _to_untrimmed_dict(self, in_cls=None) -> dict:
+        untrimmed = {
+        }
+
+        parent_as_dict = super()._to_untrimmed_dict(in_cls=in_cls)
+        for key in parent_as_dict:
+            untrimmed[key] = parent_as_dict[key]
+
+        return untrimmed

highcharts_core/options/axes/y_axis.py

@@ -12,6 +12,7 @@
 from highcharts_core.utility_functions import validate_color
 
 from highcharts_core.options.axes.x_axis import XAxis
+from highcharts_core.options.axes.title import AxisTitle, YAxisTitle
 
 
 class StackShadow(HighchartsMeta):
@@ -287,6 +288,25 @@ def stops(self, value):
 
             self._stops = processed_items
 
+    @property
+    def title(self) -> Optional[AxisTitle | YAxisTitle]:
+        """The axis title, displayed next to the axis line. Defaults to
+        :obj:`None <python:None>`, which applies the default title of ``'Values'``.
+        
+        .. tip::
+        
+          To clear the y-axis value title, set its ``text`` property to an empty string
+          (``''``).
+
+        :rtype: :class:`YAxisTitle` or :obj:`None <python:None>`
+        """
+        return self._title
+
+    @title.setter
+    @class_sensitive(YAxisTitle)
+    def title(self, value):
+        self._title = value
+
     @property
     def tooltip_value_format(self) -> Optional[str]:
         """Format string that will be used for ``point.y`` and available in (JavaScript)

pyproject.toml

@@ -56,7 +56,7 @@ requires-python = ">= 3.10"
 dependencies = [
     "esprima>=4.0.1",
     "validator-collection>=1.5.0",
-    "requests>=2.31.0"
+    "requests>=2.32.0"
 ]
 
 [tool.hatch.version]

requirements.dev.numpy.txt

@@ -9,7 +9,7 @@ sphinx-rtd-theme==1.2.0
 sphinx-toolbox==3.4.0
 sphinx-tabs==3.4.1
 tox==4.4.6
-requests==2.31.0
+requests==2.32.0
 validator-collection==1.5.0
 anthropic==0.3.11
 dill==0.3.7

requirements.dev.txt

@@ -9,7 +9,7 @@ sphinx-rtd-theme==1.2.0
 sphinx-toolbox==3.4.0
 sphinx-tabs==3.4.1
 tox==4.4.6
-requests==2.31.0
+requests==2.32.0
 validator-collection==1.5.0
 anthropic==0.3.11
 dill==0.3.7

requirements.txt

@@ -1,3 +1,3 @@
 esprima==4.0.1
-requests==2.31.0
+requests==2.32.0
 validator-collection==1.5.0