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

PR for v.1.2.3

Author: hcpchris

CHANGES.rst

@@ -1,3 +1,11 @@
+Release 1.2.3
+=========================================
+
+* **BUGFIX:** Fixed error when loading certain Highcharts (JS) scripts in Jupyter context.
+* **ENHANCEMENT:** Increased the default timeout for ``Chart.download_chart()`` and related.
+
+------------------
+
 Release 1.2.2
 =========================================
 

highcharts_core/__version__.py

@@ -1 +1 @@
-__version__ = '1.2.2'
+__version__ = '1.2.3'

highcharts_core/chart.py

@@ -411,7 +411,7 @@ def download_chart(self,
                        filename = None,
                        auth_user = None,
                        auth_password = None,
-                       timeout = 0.5,
+                       timeout = 3,
                        server_instance = None,
                        **kwargs):
         """Export a downloaded form of the chart using a Highcharts :term:`Export Server`.
@@ -432,7 +432,7 @@ def download_chart(self,
 
         :param timeout: The number of seconds to wait before issuing a timeout error.
           The timeout check is passed if bytes have been received on the socket in less
-          than the ``timeout`` value. Defaults to ``0.5``.
+          than the ``timeout`` value. Defaults to ``3``.
         :type timeout: numeric or :obj:`None <python:None>`
 
         :param server_instance: Provide an already-configured :class:`ExportServer`

highcharts_core/constants.py

@@ -22,7 +22,7 @@
     try:
         MODULE_REQUIREMENTS = json.load(module_requirements)
     except AttributeError:
-        MODULE_REQUIRE = json.loads(module_requirements.read())
+        MODULE_REQUIREMENTS = json.loads(module_requirements.read())
 
 
 class EnforcedNullType:

highcharts_core/headless_export.py

@@ -621,7 +621,7 @@ def request_chart(self,
                       filename = None,
                       auth_user = None,
                       auth_password = None,
-                      timeout = 0.5,
+                      timeout = 3,
                       **kwargs):
         """Execute a request against the export server based on the configuration in the
         instance.
@@ -642,7 +642,7 @@ def request_chart(self,
 
         :param timeout: The number of seconds to wait before issuing a timeout error.
           The timeout check is passed if bytes have been received on the socket in less
-          than the ``timeout`` value. Defaults to ``0.5``.
+          than the ``timeout`` value. Defaults to ``3``.
         :type timeout: numeric or :obj:`None <python:None>`
 
         .. note::
@@ -782,7 +782,7 @@ def get_chart(cls,
                   filename = None,
                   auth_user = None,
                   auth_password = None,
-                  timeout = 0.5,
+                  timeout = 3,
                   **kwargs):
         """Produce an exported chart image.
 
@@ -802,7 +802,7 @@ def get_chart(cls,
 
         :param timeout: The number of seconds to wait before issuing a timeout error.
           The timeout check is passed if bytes have been received on the socket in less
-          than the ``timeout`` value. Defaults to ``0.5``.
+          than the ``timeout`` value. Defaults to ``3``.
         :type timeout: numeric or :obj:`None <python:None>`
 
         .. note::

highcharts_core/metaclasses.py

@@ -63,9 +63,10 @@ def _process_required_modules(self, scripts = None, include_extension = False) -
         """
         if not scripts:
             scripts = []
+            
+        properties = [x[1:] for x in self.__dict__
+                      if x.startswith('_') and hasattr(self, x[1:])]
 
-        properties = [x for x in self.__class__.__dict__ 
-                      if self.__class__.__dict__[x].__class__.__name__ == 'property']
         for property_name in properties:
             property_value = getattr(self, property_name, None)
             if property_value is None:

tests/test_chart.py

@@ -66,3 +66,81 @@ def test_from_js_literal(input_files, input_filename, expected_filename, as_file
                                         expected_filename,
                                         as_file,
                                         error)
+
+
+
+@pytest.mark.parametrize('json_str, expected_modules, error', [
+    ("""{
+    "chart": {
+        "type": "column"
+    },
+    "colors": null,
+    "credits": false,
+    "exporting": {
+        "scale": 1
+    },
+    "series": [{
+        "baseSeries": 1,
+        "color": "#434343",
+        "name": "Pareto",
+        "tooltip": {
+            "valueDecimals": 2,
+            "valueSuffix": "%"
+        },
+        "type": "pareto",
+        "yAxis": 1,
+        "zIndex": 10
+    }, {
+        "color": "#7cb5ec",
+        "data": [1, 23, 45, 54, 84, 13, 8, 7, 23, 1, 34, 6, 8, 99, 85, 23, 3, 3, 3, 3, 3, 2, 2, 2, 2, 1, 1, 1, 1],
+        "name": "random-name",
+        "type": "column",
+        "zIndex": 2
+    }],
+    "title": {
+        "text": "Random Name Pareto"
+    },
+    "tooltip": {
+        "shared": true
+    },
+    "xAxis": {
+        "categories": ["Something", "Something", "Something", "Something", "Something", "Something", "Hypovolemia", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something", "Something"],
+        "crosshair": true,
+        "labels": {
+            "rotation": 90
+        }
+    },
+    "yAxis": [{
+        "title": {
+            "text": "count"
+        }
+    }, {
+        "labels": {
+            "format": "{value}%"
+        },
+        "max": 100,
+        "maxPadding": 0,
+        "min": 0,
+        "minPadding": 0,
+        "opposite": true,
+        "title": {
+            "text": "accum percent"
+        }
+    }]
+}""", ['highcharts', 'modules/exporting', 'modules/pareto'], None),
+])
+def test_get_required_modules(json_str, expected_modules, error):
+    from highcharts_core.options import HighchartsOptions
+    options = HighchartsOptions.from_json(json_str)
+    chart = cls.from_options(options)
+    if not error:
+        result = chart.get_required_modules()
+        if expected_modules:
+            assert len(result) == len(expected_modules)
+            for item in expected_modules:
+                assert item in result
+        else:
+            assert result is None or len(result) == 0
+    else:
+        with pytest.raises(error):
+            result = chart.get_required_modules()