add json connector

onecode/base/enums.py

@@ -122,9 +122,12 @@ class FileFilter(tuple):
     * `PYTHON`:octicons-arrow-both-24: `("Python", ".py")`
     * `IMAGE` :octicons-arrow-both-24: `("Image", ".jpg .png .jpeg")`
     * `ZIP` :octicons-arrow-both-24: `("ZIP", ".zip .gz .tar.gz .7z")`
+    * `JSON` :octicons-arrow-both-24: `("JSON", ".json")`
+
 
     """
     CSV       = ("CSV", ".csv")                        # noqa: E-221
     PYTHON    = ("Python", ".py")                      # noqa: E-221
     IMAGE     = ("Image", ".jpg .png .jpeg")           # noqa: E-221
     ZIP       = ("ZIP", ".zip .gz .tar.gz .7z")        # noqa: E-221
+    JSON      = ("JSON", ".json")                      # noqa: E-221

onecode/elements/input/json_reader.py

@@ -0,0 +1,154 @@
+# SPDX-FileCopyrightText: 2023-2024 DeepLime <[email protected]>
+# SPDX-License-Identifier: MIT
+
+import os
+from typing import Any, Dict, List, Optional, Union
+
+import pandas as pd
+
+from ...base.decorator import check_type
+from ...base.project import Project
+from ..input_element import InputElement
+
+
+class JSONReader(InputElement):
+    @check_type
+    def __init__(
+        self,
+        key: str,
+        value: Optional[Union[str, List[str]]],
+        label: Optional[str] = None,
+        count: Optional[Union[int, str]] = None,
+        optional: Union[bool, str] = False,
+        hide_when_disabled: bool = False,
+        tags: Optional[List[str]] = None,
+        sep: Optional[str] = None,
+        **kwargs: Any
+    ):
+        """
+        A JSON-file reader returning a Pandas DataFrame.
+
+        Args:
+            key: ID of the element. It must be unique as it is the key used to story data in
+                Project(), otherwise it will lead to conflicts at runtime in execution mode.
+                The key will be transformed into snake case and slugified to avoid
+                any special character or whitespace. Note that an ID cannot start with `_`. Try to
+                choose a key that is meaningful for your context (see examples projects).
+            value: Path to the JSON file. JSON file must exists.
+            label: Label to display on top of the table.
+            count: Placeholder, ignore until we activate this feature.
+            optional: Specify whether the `value` may be None.
+            hide_when_disabled: Placeholder, ignore until we activate this feature.
+            tags: Optional meta-data information about the expected file. This information is only
+                used by the `Mode.EXTRACT_ALL` when dumping attributes to JSON.
+            **kwargs: Extra user meta-data to attach to the element. Argument names cannot overwrite
+                existing attributes or methods name such as `_validate`, `_value`, etc.
+
+        Raises:
+            ValueError: if the `key` is empty or starts with `_`.
+            AttributeError: if one the `kwargs` conflicts with an existing attribute or method.
+
+        !!! example
+            ```py
+            import pandas as pd
+            from onecode import json_reader, Mode, Project
+
+            Project().mode = Mode.EXECUTE
+            widget = json_reader(
+                key="JSONReader",
+                value="/path/to/file.json",
+                label="My JSON Reader",
+                tags=['JSON'],
+            )
+
+            pd.testing.assert_frame_equal(widget, pd.read_json("/path/to/file.json"))
+            ```
+
+        """
+        super().__init__(
+            key,
+            value,
+            label,
+            count,
+            optional,
+            hide_when_disabled,
+            tags=tags,
+            json_options={
+                "read_options": {},
+                "convert_options": {},
+            },
+            **kwargs
+        )
+
+    @staticmethod
+    def metadata(value: str) -> Dict:
+        """
+        Returns the metadata associated to the given JSON(s).
+
+        Returns:
+            A dictionnary metadata for each JSON path provided:
+            ```py
+            {
+                "columns": df.columns.to_list(),
+                "stats": df.describe().to_dict()
+            }
+            ```
+
+        """
+        df = pd.read_json(value)
+
+        meta = {
+            "columns": df.columns.to_list(),
+            "stats": df.describe().to_dict()
+        }
+
+        return meta
+
+    @property
+    def _value_type(self) -> type:
+        """
+        Get the JSONReader value type: Pandas DataFrame `pd.DataFrame`.
+
+        """
+        return pd.DataFrame
+
+    @property
+    def value(self) -> Optional[pd.DataFrame]:
+        """
+        Returns:
+            The Pandas DataFrame loaded from the provided file path, otherwise None if the
+                file does not exists.
+
+        """
+        if self._value is not None:
+            if type(self._value) is str:
+                filepath = Project().get_input_path(self._value)
+                return pd.read_json(
+                    filepath,
+                ) if os.path.exists(filepath) or filepath.startswith('https://') else None
+
+            elif type(self._value) is list and all(
+                type(v) is str for v in self._value
+            ):
+                return [
+                    pd.read_json(
+                        Project().get_input_path(val),
+                    ) if os.path.exists(
+                        Project().get_input_path(val)
+                    ) or filepath.startswith('https://') else None for val in self._value
+                ]
+
+        return None
+
+    @check_type
+    def _validate(
+        self,
+        value: pd.DataFrame
+    ) -> None:
+        """
+        Raises:
+            ValueError: if the DataFrame is empty.
+
+        """
+        if value.empty:
+            raise ValueError(f"[{self.key}] Empty dataframe")

tests/data/flow_1/data/input_test.json

@@ -0,0 +1,5 @@
+[
+  { "x": 1.2, "y": 3.5, "z": 6.3 },
+  { "x": 4.3, "y": 5.6, "z": 8.1 },
+  { "x": 3.1, "y": 6.6, "z": 5.3 }
+]