eea.plotly 2.0__tar.gz → 2.2__tar.gz

{eea_plotly-2.0/eea.plotly.egg-info → eea_plotly-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eea.plotly
-Version: 2.0
+Version: 2.2
 Summary: volto-plotlycharts backend support
 Home-page: https://github.com/eea/eea.plotly
 Author: European Environment Agency: IDM2 A-Team
@@ -145,6 +145,18 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+2.2 - (2025-11-20)
+---------------------------
+* Change: better handle of backward compatibility, ref #293767
+  [razvanMiu]
+
+2.1 - (2025-11-18)
+---------------------------
+* Change: Replace Python linting to ruff
+  [mihaidobrescu1111 = refs #286821]
+* Change: Add plone6 tests
+  [mihaidobrescu1111 = refs #293593]
+
 2.0 - (2025-08-27)
 ---------------------------
 * Change: fix csv file data decoding

{eea_plotly-2.0 → eea_plotly-2.2}/docs/HISTORY.txt

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+2.2 - (2025-11-20)
+---------------------------
+* Change: better handle of backward compatibility, ref #293767
+  [razvanMiu]
+
+2.1 - (2025-11-18)
+---------------------------
+* Change: Replace Python linting to ruff
+  [mihaidobrescu1111 = refs #286821]
+* Change: Add plone6 tests
+  [mihaidobrescu1111 = refs #293593]
+
 2.0 - (2025-08-27)
 ---------------------------
 * Change: fix csv file data decoding

eea_plotly-2.2/eea/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+"""Init"""
+
+__import__("pkg_resources").declare_namespace(__name__)

eea_plotly-2.2/eea/plotly/__init__.py

@@ -0,0 +1,9 @@
+"""Main product initializer"""
+
+from zope.i18nmessageid.message import MessageFactory
+
+EEAMessageFactory = MessageFactory("eea")
+
+
+def initialize(context):
+    """Initializer called when used as a Zope 2 product."""

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/behaviors.py

@@ -1,4 +1,4 @@
-""" behavior module """
+"""behavior module"""
 
 import json
 
@@ -17,7 +17,7 @@ VIZ_SCHEMA = json.dumps({"type": "object", "properties": {}})
 
 @provider(IFormFieldProvider)
 class IPlotlyVisualization(model.Schema):
-    """ A plotly visualization behavior provider """
+    """A plotly visualization behavior provider"""
 
     visualization = JSONField(
         title="Visualization", required=False, default={}, schema=VIZ_SCHEMA

eea_plotly-2.2/eea/plotly/browser/__init__.py

@@ -0,0 +1 @@
+"""Browser"""

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/browser/controlpanel.py

@@ -1,4 +1,5 @@
 """Control panel module"""
+
 from plone.app.registry.browser.controlpanel import ControlPanelFormWrapper
 from plone.app.registry.browser.controlpanel import RegistryEditForm
 
@@ -7,6 +8,7 @@ from eea.plotly.controlpanel import IPlotlySettings
 
 class PlotlyRegistryEditForm(RegistryEditForm):
     """Plotly Registry Edit Form"""
+
     schema = IPlotlySettings
     id = "plotly"
     label = "Plotly Settings"
@@ -14,4 +16,5 @@ class PlotlyRegistryEditForm(RegistryEditForm):
 
 class PlotlyControlPanelFormWrapper(ControlPanelFormWrapper):
     """Plotly Control Panel Form Wrapper"""
+
     form = PlotlyRegistryEditForm

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/browser/preview.py

@@ -15,12 +15,13 @@ from .preview_adapter.adapter import get_preview_adapter
 
 
 def deepUpdate(original, update):
-    """ Recursively update a dictionary with another dictionary."""
+    """Recursively update a dictionary with another dictionary."""
     for key, value in update.items():
-        if isinstance(
-                value, dict) and key in original and isinstance(
-                original[key],
-                dict):
+        if (
+            isinstance(value, dict)
+            and key in original
+            and isinstance(original[key], dict)
+        ):
             deepUpdate(original[key], value)
         elif key in original:
             original[key] = value
@@ -44,17 +45,12 @@ class PlotlyPreview(BrowserView):
 
         if not self.visualization:
             self.request.response.setStatus(404)
-            return {
-                "message": "Visualization is not defined",
-                "type": "NotFound"
-            }
+            return {"message": "Visualization is not defined", "type": "NotFound"}
 
         if self.name:
             theme = None
             themes = api.portal.get_registry_record(
-                "themes",
-                interface=IPlotlySettings,
-                default=[]
+                "themes", interface=IPlotlySettings, default=[]
             )
             for t in themes:
                 if t.get("id") == self.name:
@@ -63,11 +59,10 @@ class PlotlyPreview(BrowserView):
             if theme and "layout" in self.visualization:
                 data = theme.get("data", {})
                 layout = theme.get("layout", {})
-                for trIndex, tr in enumerate(
-                        self.visualization.get("data", [])):
+                for trIndex, tr in enumerate(self.visualization.get("data", [])):
                     trType = tr.get("type", "")
                     if trType in data:
-                        newTrIndex = min(trIndex, len(data[trType])-1)
+                        newTrIndex = min(trIndex, len(data[trType]) - 1)
                         newTr = data[trType][newTrIndex]
                         deepUpdate(tr, newTr)
                 deepUpdate(self.visualization["layout"], layout)
@@ -76,21 +71,17 @@ class PlotlyPreview(BrowserView):
         get_preview_adapter(self, self.name)
 
         fig = pio.from_json(
-            json.dumps(self.visualization, cls=JSONEncoder),
-            skip_invalid=True)
+            json.dumps(self.visualization, cls=JSONEncoder), skip_invalid=True
+        )
 
         if "template" not in self.visualization["layout"]:
             fig.update_layout(template=None)
 
-        image = fig.to_image(
-            format="svg", width=self.width, height=self.height)
+        image = fig.to_image(format="svg", width=self.width, height=self.height)
 
         sh = self.request.response.setHeader
 
-        sh(
-            "Content-Type",
-            "image/svg+xml"
-        )
+        sh("Content-Type", "image/svg+xml")
         sh("Content-Disposition", "inline; filename=%s.svg" % "x")
 
         return image

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/browser/preview_adapter/adapter.py

@@ -1,14 +1,12 @@
-""" Preview adapter for Plotly browser. """
+"""Preview adapter for Plotly browser."""
 
 adapters = {
-    "soer_miniature": (
-        "eea.plotly.browser.preview_adapter.soer_miniature.serialize"
-    ),
+    "soer_miniature": ("eea.plotly.browser.preview_adapter.soer_miniature.serialize"),
 }
 
 
 def get_preview_adapter(context, name):
-    """ Get the preview adapter for a given name.
+    """Get the preview adapter for a given name.
 
     Args:
         name (str): The name of the preview adapter.

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/browser/preview_adapter/soer_miniature.py

@@ -1,4 +1,5 @@
-""" SOER miniature theme for Plotly visualizations. """
+"""SOER miniature theme for Plotly visualizations."""
+
 import math
 
 SOER_TRACES_COUNT = 5
@@ -36,7 +37,7 @@ def exact_step(vmin, vmax, target_ticks=5):
 
 
 def toFloat(v):
-    """ Convert value to float """
+    """Convert value to float"""
     try:
         return float(v)
     except ValueError:
@@ -44,17 +45,17 @@ def toFloat(v):
 
 
 def getMin(arr):
-    """ Get minimum value from array """
+    """Get minimum value from array"""
     return min(toFloat(v) for v in arr if v is not None)
 
 
 def getMax(arr):
-    """ Get maximum value from array """
+    """Get maximum value from array"""
     return max(toFloat(v) for v in arr if v is not None)
 
 
 def serialize(context):
-    """ Serialize the context for SOER miniature theme"""
+    """Serialize the context for SOER miniature theme"""
     if context.visualization is None:
         return False
 
@@ -62,8 +63,8 @@ def serialize(context):
     layout = context.visualization["layout"]
 
     top = (
-        layout.get("margin", {}).get("t") or
-        layout.get("template", {}).get("margin", {}).get("t")
+        layout.get("margin", {}).get("t")
+        or layout.get("template", {}).get("margin", {}).get("t")
     ) or 0
     nticks = max(int((context.height - top) / 100), 2)
 
@@ -89,7 +90,7 @@ def serialize(context):
         layout["template"]["layout"]["annotationdefaults"] = {
             "showarrow": False,
             "xref": "paper",
-            "yref": "paper"
+            "yref": "paper",
         }
         return False
 
@@ -150,7 +151,7 @@ def serialize(context):
 
         if y4_len >= y_len:
             data[4]["x"] = new_x
-            data[4]["y"] = data[4]["y"][y4_len - y_len:y4_len + 1]
+            data[4]["y"] = data[4]["y"][y4_len - y_len : y4_len + 1]
         elif data[4].get("x") is None or data[4].get("y") is None:
             data[4] = {
                 "type": "scatter",
@@ -159,24 +160,21 @@ def serialize(context):
                 "visible": True,
                 "marker": {
                     "color": "rgba(0, 0, 0, 1)",
-                    "line": {
-                        "color": "rgba(0, 0, 0, 1)"
-                    }
-                }
+                    "line": {"color": "rgba(0, 0, 0, 1)"},
+                },
             }
             data[4]["y"][len(data[4]["y"]) - 1] = new_y[-1]
 
         layout["xaxis"]["tickmode"] = "array"
         layout["xaxis"]["tickvals"] = [min_year, max_year, 2030]
-        layout["xaxis"]["range"] = [
-            min_year - 2, 2032]
+        layout["xaxis"]["range"] = [min_year - 2, 2032]
         layout["xaxis"]["autorange"] = True
 
     y_values = (
-        (data[0].get("y") or []) +
-        (data[1].get("y") or []) +
-        (data[4].get("y") or []) +
-        ((trace_6.get("y") or []) if trace_6 else [])
+        (data[0].get("y") or [])
+        + (data[1].get("y") or [])
+        + (data[4].get("y") or [])
+        + ((trace_6.get("y") or []) if trace_6 else [])
     )
 
     if y_values:
@@ -193,14 +191,11 @@ def serialize(context):
         layout["yaxis"]["tick0"] = min_y - step
         layout["yaxis"]["dtick"] = step
 
-        layout["yaxis"]["range"] = [
-            min_y - step, max_y + 2 * step]
+        layout["yaxis"]["range"] = [min_y - step, max_y + 2 * step]
         layout["yaxis"]["autorange"] = False
 
     if "text" in data[0]:
-        data[0]["text"] = [
-            (t if t is None else " " + str(t))
-            for t in data[0]["text"]]
+        data[0]["text"] = [(t if t is None else " " + str(t)) for t in data[0]["text"]]
 
     data[1]["x"] = None
     data[1]["y"] = None

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/controlpanel.py

@@ -1,4 +1,5 @@
 """Plotly Controlpanel API"""
+
 import json
 from zope.interface import Interface
 from zope.component import adapter
@@ -7,58 +8,45 @@ from plone.restapi.controlpanels import RegistryConfigletPanel
 from eea.plotly.interfaces import IPlotlyLayer
 from eea.plotly import EEAMessageFactory as _
 
-TEMPLATES_SCHEMA = json.dumps({
-    "type": "array",
-    "items": {
-        "type": "object",
-        "properties": {}
-    }
-})
+TEMPLATES_SCHEMA = json.dumps(
+    {"type": "array", "items": {"type": "object", "properties": {}}}
+)
 
-THEMES_SCHEMA = json.dumps({
-    "type": "array",
-    "items": {
-        "type": "object",
-        "properties": {}
-    }
-})
+THEMES_SCHEMA = json.dumps(
+    {"type": "array", "items": {"type": "object", "properties": {}}}
+)
 
 
 class IPlotlySettings(Interface):
     """Client settings for EEA Plotly."""
+
     themes = JSONField(
-        title=_(u"Themes"),
-        description=_(
-            u"The JSON representation of plotly themes."
-        ),
+        title=_("Themes"),
+        description=_("The JSON representation of plotly themes."),
         schema=THEMES_SCHEMA,
         default=[],
         widget="plotly_themes",
-        required=False
+        required=False,
     )
 
     templates = JSONField(
-        title=_(u"Templates"),
-        description=_(
-            u"The JSON representation of plotly templates."
-        ),
+        title=_("Templates"),
+        description=_("The JSON representation of plotly templates."),
         schema=TEMPLATES_SCHEMA,
         default=[],
         widget="plotly_templates",
-        required=False
+        required=False,
     )
 
 
 @adapter(Interface, IPlotlyLayer)
 class PlotlyControlpanel(RegistryConfigletPanel):
     """Plotly Control Panel"""
+
     schema = IPlotlySettings
     schema_prefix = None
     configlet_id = "plotly"
     configlet_category_id = "Products"
     title = "Plotly Settings"
     group = "Products"
-    data = {
-        "themes": [],
-        "templates": []
-    }
+    data = {"themes": [], "templates": []}

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/deserializer/blocks.py

@@ -1,4 +1,4 @@
-""" block-related utils """
+"""block-related utils"""
 
 from plone.restapi.behaviors import IBlocks
 from plone.restapi.interfaces import IBlockFieldDeserializationTransformer
@@ -22,11 +22,11 @@ class EmbedVisualizationDeserializationTransformer:
         self.request = request
 
     def __call__(self, value):
-        delProperty(value, 'visualization')
-        delProperty(value, 'properties')
-        delProperty(value, 'image_scales')
-        if 'vis_url' in value:
-            value['vis_url'] = path2uid(
-                context=self.context, link=getLink(value['vis_url'])
+        delProperty(value, "visualization")
+        delProperty(value, "properties")
+        delProperty(value, "image_scales")
+        if "vis_url" in value:
+            value["vis_url"] = path2uid(
+                context=self.context, link=getLink(value["vis_url"])
             )
         return value

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/deserializer/dxcontent.py

@@ -1,4 +1,5 @@
-""" Deserialize Plotly visualization from JSON """
+"""Deserialize Plotly visualization from JSON"""
+
 from io import StringIO
 import json
 import plotly.io as pio
@@ -18,7 +19,7 @@ from eea.plotly.io_json import JSONEncoder
 @implementer(IDeserializeFromJson)
 @adapter(IPlotlyVisualization, Interface)
 class DeserializeVisualizationFromJson(DeserializeFromJson):
-    """ Deserialize Plotly visualization from JSON """
+    """Deserialize Plotly visualization from JSON"""
 
     def jsonToBinary(self, data):
         """Convert JSON data to binary"""
@@ -50,34 +51,29 @@ class DeserializeVisualizationFromJson(DeserializeFromJson):
 
         CsvWriter(output).writerows(rows)
 
-        return output.getvalue().encode('utf-8')
+        return output.getvalue().encode("utf-8")
 
     def __call__(
-            self, validate_all=False, data=None, create=False,
-            mask_validation_errors=True):
-
-        super().__call__(
-            validate_all, data, create, mask_validation_errors
-        )
+        self, validate_all=False, data=None, create=False, mask_validation_errors=True
+    ):
+        super().__call__(validate_all, data, create, mask_validation_errors)
 
         ok = False
         for interface, names in self.modified.items():
-            if (interface == IPlotlyVisualization and
-                    "IPlotlyVisualization.visualization" in names):
+            if (
+                interface == IPlotlyVisualization
+                and "IPlotlyVisualization.visualization" in names
+            ):
                 ok = True
                 break
 
         if not ok:
             return self.context
 
-        data = self.jsonToBinary(self.context.visualization.get(
-            "dataSources", {})
-        )
+        data = self.jsonToBinary(self.context.visualization.get("dataSources", {}))
 
         self.context.file = NamedBlobFile(
-            data=data if data else b"",
-            filename="data.csv",
-            contentType="text/csv"
+            data=data if data else b"", filename="data.csv", contentType="text/csv"
         )
 
         if "dataSources" in self.context.visualization:
@@ -89,28 +85,27 @@ class DeserializeVisualizationFromJson(DeserializeFromJson):
             Attributes(
                 IPlotlyVisualization,
                 "IPlotlyVisualization.visualization",
-                "IPlotlyVisualization.file"
+                "IPlotlyVisualization.file",
             )
         )
         notify(ObjectModifiedEvent(self.context, *modified))
 
         # Handle preview image
         fig = pio.from_json(
-            json.dumps({
-                "data": self.context.visualization.get("data", []),
-                "layout": self.context.visualization.get("layout", {}),
-                "frames": self.context.visualization.get("frames", [])
-            },
-                cls=JSONEncoder
+            json.dumps(
+                {
+                    "data": self.context.visualization.get("data", []),
+                    "layout": self.context.visualization.get("layout", {}),
+                    "frames": self.context.visualization.get("frames", []),
+                },
+                cls=JSONEncoder,
             ),
-            skip_invalid=True
+            skip_invalid=True,
         )
 
         image = fig.to_image(format="svg", width=1200, height=900)
         self.context.preview_image = NamedBlobImage(
-            data=image,
-            filename="preview.svg",
-            contentType="image/svg+xml"
+            data=image, filename="preview.svg", contentType="image/svg+xml"
         )
 
         return self.context

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/deserializer/dxfields.py

@@ -1,4 +1,4 @@
-""" dxfields deserializers """
+"""dxfields deserializers"""
 
 from zope.component import adapter
 from zope.interface import implementer
@@ -19,10 +19,8 @@ class VisualizationFieldDeserializer(DefaultFieldDeserializer):
     def __call__(self, value):
         value = sanitizeVisualization(value)
 
-        if 'provider_url' in value:
+        if "provider_url" in value:
             url = value["provider_url"]
-            value["provider_url"] = path2uid(
-                context=self.context, link=getLink(url)
-            )
+            value["provider_url"] = path2uid(context=self.context, link=getLink(url))
 
         return value

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/interfaces.py

@@ -1,19 +1,20 @@
 """Module where all interfaces, events and exceptions live."""
+
 from zope.interface import Interface
 from zope.publisher.interfaces.browser import IDefaultBrowserLayer
 
 
 class IPlotlyLayer(IDefaultBrowserLayer):
-    """ Marker interface that defines a browser layer. """
+    """Marker interface that defines a browser layer."""
 
 
 class IPlotlyVisualizationField(Interface):
-    """ Marker interface for plotly visualization JSON field """
+    """Marker interface for plotly visualization JSON field"""
 
 
 class IPlotlyFileField(Interface):
-    """ Marker interface for plotly file field """
+    """Marker interface for plotly file field"""
 
 
 class IPlotlyVisualization(Interface):
-    """ Marker interface for plotly visualization """
+    """Marker interface for plotly visualization"""

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/io_csv.py

@@ -1,6 +1,8 @@
 """CSV reader/writer that handles NULL values."""
+
 import csv
-NULL = 'NULL'
+
+NULL = "NULL"
 
 
 class CsvWriter:
@@ -15,10 +17,7 @@ class CsvWriter:
 
     def writerow(self, row):
         """Write a single row to the CSV file."""
-        self.csv_writer.writerow(
-            [item if item is not None else NULL
-             for item in row]
-        )
+        self.csv_writer.writerow([item if item is not None else NULL for item in row])
 
     def writerows(self, rows):
         """Write multiple rows to the CSV file."""
@@ -31,10 +30,10 @@ class CsvReader:
 
     def __init__(self, *args, **kwrds):
         try:
-            inputEntity = args[0] or kwrds.get('csvfile')
+            inputEntity = args[0] or kwrds.get("csvfile")
             sample = inputEntity.read(1024)
             inputEntity.seek(0)
-            dialect = csv.Sniffer().sniff(sample, delimiters=',;\t|')
+            dialect = csv.Sniffer().sniff(sample, delimiters=",;\t|")
         except (csv.Error, TypeError):
             # No dialect found, use default
             dialect = csv.excel

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/io_json.py

@@ -1,4 +1,5 @@
 """JSON encoder that handles Decimal values."""
+
 import decimal
 import json
 

eea_plotly-2.2/eea/plotly/locales/__init__.py

@@ -0,0 +1 @@
+"""i18n"""

eea_plotly-2.2/eea/plotly/restapi/__init__.py

@@ -0,0 +1 @@
+"""Restapi"""

{eea_plotly-2.0 → eea_plotly-2.2}/eea/plotly/restapi/controlpanel/get.py

@@ -1,4 +1,5 @@
 """RestAPI enpoint @plotly GET"""
+
 from plone import api
 from plone.restapi.services import Service
 from zope.interface import implementer
@@ -15,27 +16,18 @@ class PlotlySettingsGet(Service):
     def reply(self):
         """Reply"""
         if not IPlotlyLayer.providedBy(self.request):
-            return {
-                "themes": [],
-                "templates": []
-            }
+            return {"themes": [], "templates": []}
 
         themes = api.portal.get_registry_record(
-            "themes",
-            interface=IPlotlySettings,
-            default=[]
+            "themes", interface=IPlotlySettings, default=[]
         )
 
         templates = api.portal.get_registry_record(
-            "templates",
-            interface=IPlotlySettings,
-            default=[]
+            "templates", interface=IPlotlySettings, default=[]
         )
 
         for template in templates:
-            layout = template.get(
-                "visualization", {}).get(
-                "layout", None)
+            layout = template.get("visualization", {}).get("layout", None)
             if layout:
                 themeId = layout.get("template", {}).get("id", None)
                 if not themeId and themes:
@@ -45,7 +37,4 @@ class PlotlySettingsGet(Service):
                         if theme.get("id") == themeId:
                             layout["template"] = theme
 
-        return {
-            "themes": themes,
-            "templates": templates
-        }
+        return {"themes": themes, "templates": templates}