Merge branch 'develop' into enhancement/17-add-support-for-highcharts-core-js-v11

Author: hcpchris

CHANGES.rst

@@ -34,6 +34,22 @@ Release 1.1.0
 
 -------------------------------
 
+Release 1.0.2
+=========================================
+
+* **DOCUMENTATION:** Added documentation of hard dependencies to the README (issue #37).
+
+-----------------------
+
+Release 1.0.1
+=========================================
+
+* **BUGFIX**: Fixed a bug encountered when parsing CSV data (issue #32).
+* **ENHANCEMENT**: Added a catch for when trying to set ``Chart.options`` to a ``SharedOptions`` instance (issue #34).
+* Fixed a broken link in the documentation.
+
+---------------
+
 Release 1.0.0
 =========================================
 

README.rst

@@ -63,6 +63,18 @@ To install **Highcharts Core for Python**, just execute:
 
  $ pip install highcharts-core
 
+Before you install, please be aware of the following "hard" dependencies:
+
+  * Python 3.10 or higher
+  * Highcharts Core (JS) v.10.2 or higher (not technically a Python dependency, but 
+    it won't work with earlier versions of Highcharts)
+  * `esprima-python <https://github.com/Kronuz/esprima-python>`__ v.4.0 or higher
+  * `requests <https://requests.readthedocs.io/en/latest/>`__ v.2.28 or higher
+  * `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`__
+    v.1.5 or higher
+
+You can find more information about soft and development dependencies in the
+`complete documentation <https://core-docs.highchartspython.com/en/latest/#dependencies>`__.
 
 -------------
 

highcharts_core/__version__.py

@@ -1 +1 @@
-__version__ = '1.1.0'
+__version__ = '1.1.0'

highcharts_core/chart.py

@@ -185,8 +185,18 @@ def options(self) -> Optional[HighchartsOptions]:
         return self._options
 
     @options.setter
-    @class_sensitive(HighchartsOptions)
     def options(self, value):
+        if not value:
+            self._options = None
+        elif isinstance(value, SharedOptions):
+            raise errors.HighchartsValueError('Chart.options expects a HighchartsOptions instance '
+                                              'or a valid descendent. However, the value you supplied '
+                                              'is a SharedOptions instance, which wil a descendent is not '
+                                              'valid for this parameter.')
+        else:
+            value = validate_types(value,
+                                   types = HighchartsOptions)
+
         self._options = value
 
     @property

highcharts_core/options/series/base.py

@@ -441,12 +441,6 @@ def load_from_csv(self,
         except AttributeError:
             pass
 
-        if checkers.is_file_on_filesystem(as_string_or_file):
-            with open(as_string_or_file, 'r') as file_:
-                as_str = file_.read()
-        else:
-            as_str = as_string_or_file
-
         property_column_map = validators.dict(property_column_map, allow_empty = False)
         cleaned_column_map = {}
         for key in property_column_map:
@@ -465,17 +459,32 @@ def load_from_csv(self,
                                                                f'instead.')
             cleaned_column_map[key] = map_value
 
-        columns, csv_records = utility_functions.parse_csv(
-            as_str,
-            has_header_row = has_header_row,
-            delimiter = delimiter,
-            null_text = null_text,
-            wrapper_character = wrapper_character,
-            line_terminator = line_terminator,
-            wrap_all_strings = False,
-            double_wrapper_character_when_nested = False,
-            escape_character = "\\"
-        )
+        if not checkers.is_on_filesystem(as_string_or_file):
+            as_str = as_string_or_file
+            columns, csv_records = utility_functions.parse_csv(
+                as_str,
+                has_header_row = has_header_row,
+                delimiter = delimiter,
+                null_text = null_text,
+                wrapper_character = wrapper_character,
+                line_terminator = line_terminator,
+                wrap_all_strings = False,
+                double_wrapper_character_when_nested = False,
+                escape_character = "\\"
+            )
+        else:
+            with open(as_string_or_file, 'r', newline = '') as file_:
+                columns, csv_records = utility_functions.parse_csv(
+                    file_,
+                    has_header_row = has_header_row,
+                    delimiter = delimiter,
+                    null_text = null_text,
+                    wrapper_character = wrapper_character,
+                    line_terminator = line_terminator,
+                    wrap_all_strings = False,
+                    double_wrapper_character_when_nested = False,
+                    escape_character = "\\"
+                )
 
         for key in cleaned_column_map:
             map_value = cleaned_column_map[key]
@@ -496,7 +505,14 @@ def load_from_csv(self,
             data_point_dict = {}
             for key in cleaned_column_map:
                 map_value = cleaned_column_map[key]
-                data_point_dict[key] = record.get(map_value, None)
+                value = record.get(map_value, None)
+                if value and isinstance(value, str) and ',' in value:
+                    test_value = value.replace(delimiter, '')
+                    if checkers.is_numeric(test_value):
+                        value = test_value
+
+                data_point_dict[key] = value
+                
             data_point_dicts.append(data_point_dict)
 
         self.data = data_point_dicts
@@ -651,14 +667,14 @@ def from_csv(cls,
         instance = cls(**series_kwargs)
         instance.load_from_csv(as_string_or_file,
                                property_column_map,
-                               has_header_row = True,
-                               delimiter = ',',
-                               null_text = 'None',
-                               wrapper_character = "'",
-                               line_terminator = '\r\n',
-                               wrap_all_strings = False,
-                               double_wrapper_character_when_nested = False,
-                               escape_character = "\\")
+                               has_header_row = has_header_row,
+                               delimiter = delimiter,
+                               null_text = null_text,
+                               wrapper_character = wrapper_character,
+                               line_terminator = line_terminator,
+                               wrap_all_strings = wrap_all_strings,
+                               double_wrapper_character_when_nested = double_wrapper_character_when_nested,
+                               escape_character = escape_character)
 
         return instance
 

highcharts_core/utility_functions.py

@@ -279,12 +279,14 @@ def parse_csv(csv_data,
     :rtype: :class:`tuple <python:tuple>` of a :class:`list <python:list>` of column names
       and :class:`list <python:list>` of :class:`dict <python:dict>`
     """
-    csv_data = validators.string(csv_data, allow_empty = True)
     if not csv_data:
         return [], []
 
+    if isinstance(csv_data, str):
+        csv_data = csv_data.split(line_terminator)
+
     if not wrapper_character:
-        wrapper_character = '\''
+        wrapper_character = "'"
 
     if wrap_all_strings:
         quoting = csv.QUOTE_NONNUMERIC

tests/options/series/test_area.py

@@ -5,6 +5,8 @@
 import datetime
 from json.decoder import JSONDecodeError
 
+from validator_collection import checkers
+
 from highcharts_core.options.series.area import AreaSeries as cls
 from highcharts_core.options.series.area import AreaRangeSeries as cls2
 from highcharts_core.options.series.area import AreaSplineSeries as cls3
@@ -2764,6 +2766,64 @@ def test_LineSeries_from_pandas(input_files, filename, property_map, error):
         with pytest.raises(error):
             result = cls5.from_pandas(df, property_map = property_map)
 
+
+@pytest.mark.parametrize('kwargs, error', [
+    ({
+        'as_string_or_file': "'Date','HeadCount'\r\n'01/01/2023','2'\r\n'01/02/2023','4'\r\n'01/03/2023','8'",
+        'property_column_map': {'x': 'Date', 'y': 'HeadCount', 'id': 'Date'}
+     }, None),
+    ({
+        'as_string_or_file': "Date,HeadCount\r\n01/01/2023,2\r\n01/02/2023,4\r\n01/03/2023,8",
+        'property_column_map': {'x': 'Date', 'y': 'HeadCount', 'id': 'Date'}
+     }, None),
+
+])
+def test_bugfix32_LineSeries_from_csv(kwargs, error):
+    if not error:
+        result = cls5.from_csv(**kwargs)
+        assert result is not None
+        assert isinstance(result, cls5) is True
+        assert result.data is not None
+        assert isinstance(result.data, list) is True
+        for item in result.data:
+            assert item.x is not None
+            assert item.y is not None
+
+
+@pytest.mark.parametrize('filename, property_map, kwargs, error', [
+    ('test-data-files/nst-est2019-01.csv', {}, {}, ValueError),
+    ('test-data-files/nst-est2019-01.csv',
+     {
+         'name': 'Geographic Area',
+         'x': 'Geographic Area',
+         'y': '2010'
+     },
+     {
+         'wrapper_character': '"'
+     },
+     None),
+
+])
+def test_LineSeries_from_csv(input_files, filename, property_map, kwargs, error):
+    input_file = check_input_file(input_files, filename)
+    
+    if not error:
+        result = cls5.from_csv(input_file,
+                               property_column_map = property_map,
+                               **kwargs)
+        assert result is not None
+        assert isinstance(result, cls5)
+        assert result.data is not None
+        for item in result.data:
+            for key in property_map:
+                assert getattr(item, key, None) is not None
+    else:
+        with pytest.raises(error):
+            result = cls5.from_csv(input_file, 
+                                   property_column_map = property_map,
+                                   **kwargs)
+
+
 #### NEXT CLASS
 
 @pytest.mark.parametrize('kwargs, error', STANDARD_PARAMS)

tests/test_chart.py

@@ -5,6 +5,7 @@
 from json.decoder import JSONDecodeError
 
 from highcharts_core.chart import Chart as cls
+from highcharts_core.global_options.shared_options import SharedOptions
 from highcharts_core import errors
 from tests.fixtures import input_files, check_input_file, to_camelCase, to_js_dict, \
     Class__init__, Class__to_untrimmed_dict, Class_from_dict, Class_to_dict, \
@@ -20,6 +21,19 @@ def test__init__(kwargs, error):
     Class__init__(cls, kwargs, error)
 
 
+@pytest.mark.parametrize('kwargs, error', [
+    ({}, errors.HighchartsValueError),
+])
+def test_bugfix34_SharedOptions_error(kwargs, error):
+    shared_options = SharedOptions()
+    instance = cls(**kwargs)
+    if not error:
+        instance.options = shared_options
+    else:
+        with pytest.raises(error):
+            instance.options = shared_options
+
+
 @pytest.mark.parametrize('kwargs, error', STANDARD_PARAMS)
 def test__to_untrimmed_dict(kwargs, error):
     Class__to_untrimmed_dict(cls, kwargs, error)

tests/test_utility_functions.py

@@ -5,3 +5,21 @@
 from abc import ABC, abstractmethod
 
 from highcharts_core import utility_functions
+
+
+@pytest.mark.parametrize('kwargs, expected_column_names, expected_records, error', [
+    ({
+        'csv_data': "Date,Header\r\n01/01/2023,2\r\n01/02/2023,4\r\n01/03/2023,8"
+     }, ['Date', 'HeadCount'], 3, None),
+])
+def test_parse_csv(kwargs, expected_column_names, expected_records, error):
+    if not error:
+        columns, records_as_dicts = utility_functions.parse_csv(**kwargs)
+        assert columns is not None
+        assert len(columns) == len(expected_column_names)
+        
+        assert records_as_dicts is not None
+        assert len(records_as_dicts) == expected_records
+    else:
+        with pytest.raises(error):
+            result = utility_functions.parse_csv(**kwargs)