neo4j-viz 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

neo4j_viz/gql_create.py

@@ -249,13 +249,8 @@ def from_gql_create(
     node_pattern = re.compile(r"^\(([^)]*)\)$")
     rel_pattern = re.compile(r"^\(([^)]*)\)-\s*\[\s*:(\w+)\s*(\{[^}]*\})?\s*\]->\(([^)]*)\)$")
 
-    node_top_level_keys = set(Node.model_fields.keys())
-    node_top_level_keys.remove("id")
-
-    rel_top_level_keys = set(Relationship.model_fields.keys())
-    rel_top_level_keys.remove("id")
-    rel_top_level_keys.remove("source")
-    rel_top_level_keys.remove("target")
+    node_top_level_keys = Node.all_validation_aliases(exempted_fields=["id"])
+    rel_top_level_keys = Relationship.all_validation_aliases(exempted_fields=["id", "source", "target"])
 
     nodes = []
     relationships = []

neo4j_viz/neo4j.py

@@ -47,10 +47,15 @@ def from_neo4j(
     else:
         raise ValueError(f"Invalid input type `{type(result)}`. Expected `neo4j.Graph` or `neo4j.Result`")
 
-    nodes = [_map_node(node, size_property, caption_property=node_caption) for node in graph.nodes]
+    all_node_field_aliases = Node.all_validation_aliases()
+    all_rel_field_aliases = Relationship.all_validation_aliases()
+
+    nodes = [
+        _map_node(node, all_node_field_aliases, size_property, caption_property=node_caption) for node in graph.nodes
+    ]
     relationships = []
     for rel in graph.relationships:
-        mapped_rel = _map_relationship(rel, caption_property=relationship_caption)
+        mapped_rel = _map_relationship(rel, all_rel_field_aliases, caption_property=relationship_caption)
         if mapped_rel:
             relationships.append(mapped_rel)
 
@@ -62,7 +67,12 @@ def from_neo4j(
     return VG
 
 
-def _map_node(node: neo4j.graph.Node, size_property: Optional[str], caption_property: Optional[str]) -> Node:
+def _map_node(
+    node: neo4j.graph.Node,
+    all_node_field_aliases: set[str],
+    size_property: Optional[str],
+    caption_property: Optional[str],
+) -> Node:
     top_level_fields = {"id": node.element_id}
 
     if size_property:
@@ -78,7 +88,7 @@ def _map_node(node: neo4j.graph.Node, size_property: Optional[str], caption_prop
 
     properties = {}
     for prop, value in node.items():
-        if prop not in Node.model_fields.keys():
+        if prop not in all_node_field_aliases:
             properties[prop] = value
             continue
 
@@ -95,7 +105,9 @@ def _map_node(node: neo4j.graph.Node, size_property: Optional[str], caption_prop
     return Node(**top_level_fields, properties=properties)
 
 
-def _map_relationship(rel: neo4j.graph.Relationship, caption_property: Optional[str]) -> Optional[Relationship]:
+def _map_relationship(
+    rel: neo4j.graph.Relationship, all_rel_field_aliases: set[str], caption_property: Optional[str]
+) -> Optional[Relationship]:
     if rel.start_node is None or rel.end_node is None:
         return None
 
@@ -109,7 +121,7 @@ def _map_relationship(rel: neo4j.graph.Relationship, caption_property: Optional[
 
     properties = {}
     for prop, value in rel.items():
-        if prop not in Relationship.model_fields.keys():
+        if prop not in all_rel_field_aliases:
             properties[prop] = value
             continue
 

neo4j_viz/node.py

@@ -2,7 +2,8 @@ from __future__ import annotations
 
 from typing import Any, Optional, Union
 
-from pydantic import AliasChoices, BaseModel, Field, field_serializer, field_validator
+from pydantic import AliasChoices, AliasGenerator, BaseModel, Field, field_serializer, field_validator
+from pydantic.alias_generators import to_camel
 from pydantic_extra_types.color import Color, ColorType
 
 from .node_size import RealNumber
@@ -11,29 +12,46 @@ from .options import CaptionAlignment
 NodeIdType = Union[str, int]
 
 
-class Node(BaseModel, extra="allow"):
+def create_aliases(field_name: str) -> AliasChoices:
+    valid_names = [field_name]
+
+    if field_name == "id":
+        valid_names.extend(["nodeid", "node_id"])
+
+    choices = [[choice, choice.upper(), to_camel(choice)] for choice in valid_names]
+
+    return AliasChoices(*[alias for aliases in choices for alias in aliases])
+
+
+class Node(
+    BaseModel,
+    extra="forbid",
+    alias_generator=AliasGenerator(
+        validation_alias=create_aliases,
+        serialization_alias=lambda field_name: to_camel(field_name),
+    ),
+):
     """
     A node in a graph to visualize.
 
+    Each field is case-insensitive for input, and camelCase is also accepted.
+    For example, "CAPTION_ALIGN", "captionAlign" are also valid inputs keys for the `caption_align` field.
+    Upon construction however, the field names are converted to snake_case.
+
     For more info on each field, see the NVL library docs: https://neo4j.com/docs/nvl/current/base-library/#_nodes
     """
 
     #: Unique identifier for the node
-    id: NodeIdType = Field(
-        validation_alias=AliasChoices("id", "nodeId", "node_id"), description="Unique identifier for the node"
-    )
+    id: NodeIdType = Field(description="Unique identifier for the node")
     #: The caption of the node
     caption: Optional[str] = Field(None, description="The caption of the node")
     #: The alignment of the caption text
-    caption_align: Optional[CaptionAlignment] = Field(
-        None, serialization_alias="captionAlign", description="The alignment of the caption text"
-    )
+    caption_align: Optional[CaptionAlignment] = Field(None, description="The alignment of the caption text")
     #: The size of the caption text. The font size to node radius ratio
     caption_size: Optional[int] = Field(
         None,
         ge=1,
         le=3,
-        serialization_alias="captionSize",
         description="The size of the caption text. The font size to node radius ratio",
     )
     #: The size of the node as radius in pixel
@@ -70,3 +88,12 @@ class Node(BaseModel, extra="allow"):
 
     def to_dict(self) -> dict[str, Any]:
         return self.model_dump(exclude_none=True, by_alias=True)
+
+    @staticmethod
+    def all_validation_aliases(exempted_fields: Optional[list[str]] = None) -> set[str]:
+        if exempted_fields is None:
+            exempted_fields = []
+
+        by_field = [v.validation_alias.choices for k, v in Node.model_fields.items() if k not in exempted_fields]  # type: ignore
+
+        return {str(alias) for aliases in by_field for alias in aliases}

neo4j_viz/nvl.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import json
 import uuid
 from importlib.resources import files
+from typing import Union
 
 from IPython.display import HTML
 
@@ -40,10 +41,28 @@ class NVL:
         with screenshot_path.open("r", encoding="utf-8") as file:
             self.screenshot_svg = file.read()
 
-    def unsupported_field_type_error(self, e: TypeError, entity: str) -> Exception:
-        if "not JSON serializable" in str(e):
-            return ValueError(f"A field of a {entity} object is not supported: {str(e)}")
-        return e
+    @staticmethod
+    def _serialize_entity(entity: Union[Node, Relationship]) -> str:
+        try:
+            entity_dict = entity.to_dict()
+            return json.dumps(entity_dict)
+        except TypeError:
+            props_as_strings = {}
+            for k, v in entity_dict["properties"].items():
+                try:
+                    json.dumps(v)
+                except TypeError:
+                    props_as_strings[k] = str(v)
+            entity_dict["properties"].update(props_as_strings)
+
+            try:
+                return json.dumps(entity_dict)
+            except TypeError as e:
+                # This should never happen anymore, but just in case
+                if "not JSON serializable" in str(e):
+                    raise ValueError(f"A field of a {type(entity).__name__} object is not supported: {str(e)}")
+                else:
+                    raise e
 
     def render(
         self,
@@ -54,14 +73,8 @@ class NVL:
         height: str,
         show_hover_tooltip: bool,
     ) -> HTML:
-        try:
-            nodes_json = json.dumps([node.to_dict() for node in nodes])
-        except TypeError as e:
-            raise self.unsupported_field_type_error(e, "node")
-        try:
-            rels_json = json.dumps([rel.to_dict() for rel in relationships])
-        except TypeError as e:
-            raise self.unsupported_field_type_error(e, "relationship")
+        nodes_json = f"[{','.join([self._serialize_entity(node) for node in nodes])}]"
+        rels_json = f"[{','.join([self._serialize_entity(rel) for rel in relationships])}]"
 
         render_options_json = json.dumps(render_options.to_dict())
         container_id = str(uuid.uuid4())
@@ -112,7 +125,7 @@ class NVL:
         <script>
             getTheme = () => {{
                 const backgroundColorString = window.getComputedStyle(document.body, null).getPropertyValue('background-color')
-                const colorsArray = backgroundColorString.match(/\d+/g);
+                const colorsArray = backgroundColorString.match(/\\d+/g);
                 const brightness = Number(colorsArray[0]) * 0.2126 + Number(colorsArray[1]) * 0.7152 + Number(colorsArray[2]) * 0.0722
                 return brightness < 128 ? "dark" : "light"
             }}

neo4j_viz/pandas.py

@@ -23,6 +23,9 @@ def _from_dfs(
     else:
         node_dfs_iter = node_dfs
 
+    all_node_field_aliases = Node.all_validation_aliases()
+    all_rel_field_aliases = Relationship.all_validation_aliases()
+
     has_size = True
     nodes = []
     for node_df in node_dfs_iter:
@@ -31,7 +34,7 @@ def _from_dfs(
             top_level = {}
             properties = {}
             for key, value in row.to_dict().items():
-                if key in Node.model_fields.keys():
+                if key in all_node_field_aliases:
                     top_level[key] = value
                 else:
                     if rename_properties and key in rename_properties:
@@ -51,7 +54,7 @@ def _from_dfs(
             top_level = {}
             properties = {}
             for key, value in row.to_dict().items():
-                if key in Relationship.model_fields.keys():
+                if key in all_rel_field_aliases:
                     top_level[key] = value
                 else:
                     if rename_properties and key in rename_properties:

neo4j_viz/relationship.py

@@ -3,16 +3,41 @@ from __future__ import annotations
 from typing import Any, Optional, Union
 from uuid import uuid4
 
-from pydantic import AliasChoices, BaseModel, Field, field_serializer, field_validator
+from pydantic import AliasChoices, AliasGenerator, BaseModel, Field, field_serializer, field_validator
+from pydantic.alias_generators import to_camel
 from pydantic_extra_types.color import Color, ColorType
 
 from .options import CaptionAlignment
 
 
-class Relationship(BaseModel, extra="allow"):
+def create_aliases(field_name: str) -> AliasChoices:
+    valid_names = [field_name]
+
+    if field_name == "source":
+        valid_names.extend(["sourcenodeid", "source_node_id", "from"])
+    if field_name == "target":
+        valid_names.extend(["targetnodeid", "target_node_id", "to"])
+
+    choices = [[choice, choice.upper(), to_camel(choice)] for choice in valid_names]
+
+    return AliasChoices(*[alias for aliases in choices for alias in aliases])
+
+
+class Relationship(
+    BaseModel,
+    extra="forbid",
+    alias_generator=AliasGenerator(
+        validation_alias=create_aliases,
+        serialization_alias=lambda field_name: to_camel(field_name),
+    ),
+):
     """
     A relationship in a graph to visualize.
 
+    Each field is case-insensitive for input, and camelCase is also accepted.
+    For example, "CAPTION_ALIGN", "captionAlign" are also valid inputs keys for the `caption_align` field.
+    Upon construction however, the field names are converted to snake_case.
+
     For more info on each field, see the NVL library docs: https://neo4j.com/docs/nvl/current/base-library/#_relationships
     """
 
@@ -23,25 +48,19 @@ class Relationship(BaseModel, extra="allow"):
     #: Node ID where the relationship points from
     source: Union[str, int] = Field(
         serialization_alias="from",
-        validation_alias=AliasChoices("source", "sourceNodeId", "source_node_id", "from"),
         description="Node ID where the relationship points from",
     )
     #: Node ID where the relationship points to
     target: Union[str, int] = Field(
         serialization_alias="to",
-        validation_alias=AliasChoices("target", "targetNodeId", "target_node_id", "to"),
         description="Node ID where the relationship points to",
     )
     #: The caption of the relationship
     caption: Optional[str] = Field(None, description="The caption of the relationship")
     #: The alignment of the caption text
-    caption_align: Optional[CaptionAlignment] = Field(
-        None, serialization_alias="captionAlign", description="The alignment of the caption text"
-    )
+    caption_align: Optional[CaptionAlignment] = Field(None, description="The alignment of the caption text")
     #: The size of the caption text
-    caption_size: Optional[Union[int, float]] = Field(
-        None, gt=0.0, serialization_alias="captionSize", description="The size of the caption text"
-    )
+    caption_size: Optional[Union[int, float]] = Field(None, gt=0.0, description="The size of the caption text")
     #: The color of the relationship. Allowed input is for example "#FF0000", "red" or (255, 0, 0)
     color: Optional[ColorType] = Field(None, description="The color of the relationship")
     #: Additional properties of the relationship that do not directly impact the visualization
@@ -76,3 +95,16 @@ class Relationship(BaseModel, extra="allow"):
 
     def to_dict(self) -> dict[str, Any]:
         return self.model_dump(exclude_none=True, by_alias=True)
+
+    @staticmethod
+    def all_validation_aliases(exempted_fields: Optional[list[str]] = None) -> set[str]:
+        if exempted_fields is None:
+            exempted_fields = []
+
+        by_field = [
+            v.validation_alias.choices  # type: ignore
+            for k, v in Relationship.model_fields.items()
+            if k not in exempted_fields
+        ]
+
+        return {str(alias) for aliases in by_field for alias in aliases}

{neo4j_viz-0.3.0.dist-info → neo4j_viz-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: neo4j-viz
-Version: 0.3.0
+Version: 0.3.1
 Summary: A simple graph visualization tool
 Author-email: Neo4j <team-gds@neo4j.org>
 Project-URL: Homepage, https://neo4j.com/

{neo4j_viz-0.3.0.dist-info → neo4j_viz-0.3.1.dist-info}/RECORD

@@ -1,22 +1,22 @@
 neo4j_viz/__init__.py,sha256=ATDPdaupFWIWaOWtJtfCGVRVuuwXKNe1hNdENofgRLk,270
 neo4j_viz/colors.py,sha256=IvOCTmCu7WTMna_wNLZ3GrThTwFyIoKtNkmZYDLdYac,6694
 neo4j_viz/gds.py,sha256=v6b3XdSoWSoOu-U2MWQM-5QXLiPT3_9gGOv7haxuozE,4135
-neo4j_viz/gql_create.py,sha256=Eqo_fFxtsrsoKV0gjXIpHZdeBqjX2q-vwe_xBCJU7OI,13354
-neo4j_viz/neo4j.py,sha256=0urKoYwtCyyKXMu_tWPspehyjOFF5ETyiWuYVNA1Wfc,4589
-neo4j_viz/node.py,sha256=NgB8preP2v1PWW177iU4YeojvfWafz8yIyY7MQrP6iE,2850
+neo4j_viz/gql_create.py,sha256=YH9mZUx-b86h714wCIbikGoxZD7IEuOmhKDdrp5fhXk,13264
+neo4j_viz/neo4j.py,sha256=UTrLZRlDgkw2w8Ov4P1oP8w-25Kf0sMCkLFDq3qD-Q8,4855
+neo4j_viz/node.py,sha256=MiLoghsn2NLs_iV65NuW7u3iaxP8MTKoNy6La9TdreY,3886
 neo4j_viz/node_size.py,sha256=c_sMtQSD8eJ_6Y0Kr6ku0LOs9VoEDxfYCUUzUWZ-1Xo,1197
-neo4j_viz/nvl.py,sha256=32NTuNCaf78bHEVD1nWQD5jUHS2ZUBemxKktuIpiCK0,4774
+neo4j_viz/nvl.py,sha256=ZN3tyWar9ugR88r5N6txW3ThfNEWOt5A1KzrrRnLKwk,5262
 neo4j_viz/options.py,sha256=QBeHLqHOJFtSCjzHvv-2A9TzTbnIaC6_onQq9fUlT_4,3079
-neo4j_viz/pandas.py,sha256=4ArBUV6DKOhwbplD8edJd5DsIilDNKyCpPjqrus0bPk,3269
+neo4j_viz/pandas.py,sha256=bju4Pcoe-d_MFG6XOpVPPkD_p3cF-gWuXqfA9oxyvSU,3382
 neo4j_viz/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-neo4j_viz/relationship.py,sha256=DmmBUHup_jtqnenQKACCfz4Mz7CjbCnDmOZfsSj6qiQ,3042
+neo4j_viz/relationship.py,sha256=sRgGjNzlqt6wPmiB3WXBTxR_W_5Z40VofpHUZvkRS1I,4143
 neo4j_viz/visualization_graph.py,sha256=ogYhxAyPzqOcSogYSesGAV6iRQDLIA-YhBImEShuCPM,13175
 neo4j_viz/resources/icons/screenshot.svg,sha256=Ns9Yi2Iq4lIaiFvzc0pXBmjxt4fcmBO-I4cI8Xiu1HE,311
 neo4j_viz/resources/icons/zoom-in.svg,sha256=PsO5yFkA1JnGM2QV_qxHKG13qmoR-RrlWARpaXNp5qU,415
 neo4j_viz/resources/icons/zoom-out.svg,sha256=OQRADAoe2bxbCeFufg6W22nR41q5NlI8QspT9l5pXUw,400
 neo4j_viz/resources/nvl_entrypoint/base.js,sha256=QfFjqd7Uo2F-plgFlPfLzUcjqzTzqUh533VaBemJhLI,1816247
 neo4j_viz/resources/nvl_entrypoint/styles.css,sha256=JjeTSB9OJT2KMfb8yFUUMLMG7Rzrf3o60hSCD547zTk,1123
-neo4j_viz-0.3.0.dist-info/METADATA,sha256=wCM57O61k4kllIiYOqopDJiQPBzyftooJwhwz9h8oSw,7074
-neo4j_viz-0.3.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-neo4j_viz-0.3.0.dist-info/top_level.txt,sha256=jPUM3z8MOtxqDanc2VzqkxG4HJn8aaq4S7rnCFNk_Vs,10
-neo4j_viz-0.3.0.dist-info/RECORD,,
+neo4j_viz-0.3.1.dist-info/METADATA,sha256=p8n2aK9ELDWZX75mUyDCh1pLR22TdWrQarXTXmXYcAU,7074
+neo4j_viz-0.3.1.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+neo4j_viz-0.3.1.dist-info/top_level.txt,sha256=jPUM3z8MOtxqDanc2VzqkxG4HJn8aaq4S7rnCFNk_Vs,10
+neo4j_viz-0.3.1.dist-info/RECORD,,

{neo4j_viz-0.3.0.dist-info → neo4j_viz-0.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any