Merge pull request #855 from neo4j-contrib/rc/5.4.3

Rc/5.4.3

Author: mariusconjeaud

.sonarcloud.properties

@@ -1,3 +1,3 @@
 sonar.sources = neomodel/
 sonar.tests = test/
-sonar.python.version = 3.7, 3.8, 3.9, 3.10, 3.11
+sonar.python.version = 3.9, 3.10, 3.11, 3.12, 3.13

Changelog

@@ -1,3 +1,9 @@
+Version 5.4.3 2025-02
+* Add Size() scalar function
+* Fix potential duplicate variable name in multiple traversals
+* Minor fixes
+* Note : With Neo4j now using CalVer, we can soon shift to true SemVer
+
 Version 5.4.2 2024-12
 * Add support for Neo4j Rust driver extension : pip install neomodel[rust-driver-ext]
 * Add initial_context parameter to subqueries

doc/source/configuration.rst

@@ -32,7 +32,7 @@ Adjust driver configuration - these options are only available for this connecti
     config.MAX_TRANSACTION_RETRY_TIME = 30.0  # default
     config.RESOLVER = None  # default
     config.TRUST = neo4j.TRUST_SYSTEM_CA_SIGNED_CERTIFICATES  # default
-    config.USER_AGENT = neomodel/v5.4.2  # default
+    config.USER_AGENT = neomodel/v5.4.3  # default
 
 Setting the database name, if different from the default one::
 

doc/source/getting_started.rst

@@ -235,7 +235,7 @@ Working with relationships::
     len(germany.inhabitant) # 1
 
     # Find people called 'Jim' in germany
-    germany.inhabitant.search(name='Jim')
+    germany.inhabitant.filter(name='Jim')
 
     # Find all the people called in germany except 'Jim'
     germany.inhabitant.exclude(name='Jim')

doc/source/spatial_properties.rst

@@ -157,9 +157,11 @@ Working with `PointProperty`
 ----------------------------
 To define a ``PointProperty`` Node property, simply specify it along with its ``crs``: ::
 
+    from neomodel.contrib import spatial_properties as neomodel_spatial 
+
     class SomeEntity(neomodel.StructuredNode):
         entity_id = neomodel.UniqueIdProperty()
-        location = neomodel.PointProperty(crs='wgs-84')
+        location = neomodel_spatial.PointProperty(crs='wgs-84')
 
 Given this definition of ``SomeEntity``, an object can be created by: ::
 

neomodel/_version.py

@@ -1 +1 @@
-__version__ = "5.4.2"
+__version__ = "5.4.3"

neomodel/async_/match.py

@@ -444,7 +444,8 @@ def __init__(
         self._ast = QueryAST()
         self._query_params: dict = {}
         self._place_holder_registry: dict = {}
-        self._ident_count: int = 0
+        self._relation_identifier_count: int = 0
+        self._node_identifier_count: int = 0
         self._subquery_namespace: TOptional[str] = subquery_namespace
 
     async def build_ast(self) -> "AsyncQueryBuilder":
@@ -494,9 +495,13 @@ async def build_source(
             return await self.build_node(source)
         raise ValueError("Unknown source type " + repr(source))
 
-    def create_ident(self) -> str:
-        self._ident_count += 1
-        return f"r{self._ident_count}"
+    def create_relation_identifier(self) -> str:
+        self._relation_identifier_count += 1
+        return f"r{self._relation_identifier_count}"
+
+    def create_node_identifier(self, prefix: str) -> str:
+        self._node_identifier_count += 1
+        return f"{prefix}{self._node_identifier_count}"
 
     def build_order_by(self, ident: str, source: "AsyncNodeSet") -> None:
         if "?" in source.order_by_elements:
@@ -535,7 +540,7 @@ async def build_traversal(self, traversal: "AsyncTraversal") -> str:
         rhs_label = ":" + traversal.target_class.__label__
 
         # build source
-        rel_ident = self.create_ident()
+        rel_ident = self.create_relation_identifier()
         lhs_ident = await self.build_source(traversal.source)
         traversal_ident = f"{traversal.name}_{rel_ident}"
         rhs_ident = traversal_ident + rhs_label
@@ -600,7 +605,7 @@ def build_traversal_from_path(
                 lhs_ident = stmt
 
             already_present = part in subgraph
-            rel_ident = self.create_ident()
+            rel_ident = self.create_relation_identifier()
             rhs_label = relationship.definition["node_class"].__label__
             if relation.get("relation_filtering"):
                 rhs_name = rel_ident
@@ -610,6 +615,7 @@ def build_traversal_from_path(
                     rhs_name = relation["alias"]
                 else:
                     rhs_name = f"{rhs_label.lower()}_{rel_iterator}"
+                    rhs_name = self.create_node_identifier(rhs_name)
             rhs_ident = f"{rhs_name}:{rhs_label}"
             if relation["include_in_return"] and not already_present:
                 self._additional_return(rhs_name)
@@ -1235,12 +1241,9 @@ def render(self, qbuilder: AsyncQueryBuilder) -> str:
 class ScalarFunction(BaseFunction):
     """Base scalar function class."""
 
-    pass
-
-
-@dataclass
-class Last(ScalarFunction):
-    """last() function."""
+    @property
+    def function_name(self) -> str:
+        raise NotImplementedError
 
     def render(self, qbuilder: AsyncQueryBuilder) -> str:
         if isinstance(self.input_name, str):
@@ -1250,7 +1253,25 @@ def render(self, qbuilder: AsyncQueryBuilder) -> str:
             self._internal_name = self.input_name.get_internal_name()
         else:
             content = self.resolve_internal_name(qbuilder)
-        return f"last({content})"
+        return f"{self.function_name}({content})"
+
+
+@dataclass
+class Last(ScalarFunction):
+    """last() function."""
+
+    @property
+    def function_name(self) -> str:
+        return "last"
+
+
+@dataclass
+class Size(ScalarFunction):
+    """size() function."""
+
+    @property
+    def function_name(self) -> str:
+        return "size"
 
 
 @dataclass

neomodel/async_/relationship.py

@@ -44,9 +44,8 @@ def __new__(
         return inst
 
 
-StructuredRelBase: type = RelationshipMeta(
-    "RelationshipBase", (AsyncPropertyManager,), {}
-)
+class StructuredRelBase(AsyncPropertyManager, metaclass=RelationshipMeta):
+    pass
 
 
 class AsyncStructuredRel(StructuredRelBase):

neomodel/async_/relationship_manager.py

@@ -433,7 +433,7 @@ def __init__(
         cls_name: str,
         direction: int,
         manager: type[AsyncRelationshipManager] = AsyncRelationshipManager,
-        model: Optional[AsyncStructuredRel] = None,
+        model: Optional[type[AsyncStructuredRel]] = None,
     ) -> None:
         self._validate_class(cls_name, model)
 
@@ -486,7 +486,7 @@ def __init__(
                 adb._NODE_CLASS_REGISTRY[label_set] = model
 
     def _validate_class(
-        self, cls_name: str, model: Optional[AsyncStructuredRel] = None
+        self, cls_name: str, model: Optional[type[AsyncStructuredRel]] = None
     ) -> None:
         if not isinstance(cls_name, (str, object)):
             raise ValueError("Expected class name or class got " + repr(cls_name))
@@ -552,7 +552,7 @@ def __init__(
         cls_name: str,
         relation_type: str,
         cardinality: type[AsyncRelationshipManager] = AsyncZeroOrMore,
-        model: Optional[AsyncStructuredRel] = None,
+        model: Optional[type[AsyncStructuredRel]] = None,
     ) -> None:
         super().__init__(
             relation_type, cls_name, OUTGOING, manager=cardinality, model=model
@@ -565,7 +565,7 @@ def __init__(
         cls_name: str,
         relation_type: str,
         cardinality: type[AsyncRelationshipManager] = AsyncZeroOrMore,
-        model: Optional[AsyncStructuredRel] = None,
+        model: Optional[type[AsyncStructuredRel]] = None,
     ) -> None:
         super().__init__(
             relation_type, cls_name, INCOMING, manager=cardinality, model=model
@@ -578,7 +578,7 @@ def __init__(
         cls_name: str,
         relation_type: str,
         cardinality: type[AsyncRelationshipManager] = AsyncZeroOrMore,
-        model: Optional[AsyncStructuredRel] = None,
+        model: Optional[type[AsyncStructuredRel]] = None,
     ) -> None:
         super().__init__(
             relation_type, cls_name, EITHER, manager=cardinality, model=model

neomodel/sync_/match.py

@@ -442,7 +442,8 @@ def __init__(
         self._ast = QueryAST()
         self._query_params: dict = {}
         self._place_holder_registry: dict = {}
-        self._ident_count: int = 0
+        self._relation_identifier_count: int = 0
+        self._node_identifier_count: int = 0
         self._subquery_namespace: TOptional[str] = subquery_namespace
 
     def build_ast(self) -> "QueryBuilder":
@@ -492,9 +493,13 @@ def build_source(
             return self.build_node(source)
         raise ValueError("Unknown source type " + repr(source))
 
-    def create_ident(self) -> str:
-        self._ident_count += 1
-        return f"r{self._ident_count}"
+    def create_relation_identifier(self) -> str:
+        self._relation_identifier_count += 1
+        return f"r{self._relation_identifier_count}"
+
+    def create_node_identifier(self, prefix: str) -> str:
+        self._node_identifier_count += 1
+        return f"{prefix}{self._node_identifier_count}"
 
     def build_order_by(self, ident: str, source: "NodeSet") -> None:
         if "?" in source.order_by_elements:
@@ -533,7 +538,7 @@ def build_traversal(self, traversal: "Traversal") -> str:
         rhs_label = ":" + traversal.target_class.__label__
 
         # build source
-        rel_ident = self.create_ident()
+        rel_ident = self.create_relation_identifier()
         lhs_ident = self.build_source(traversal.source)
         traversal_ident = f"{traversal.name}_{rel_ident}"
         rhs_ident = traversal_ident + rhs_label
@@ -598,7 +603,7 @@ def build_traversal_from_path(
                 lhs_ident = stmt
 
             already_present = part in subgraph
-            rel_ident = self.create_ident()
+            rel_ident = self.create_relation_identifier()
             rhs_label = relationship.definition["node_class"].__label__
             if relation.get("relation_filtering"):
                 rhs_name = rel_ident
@@ -608,6 +613,7 @@ def build_traversal_from_path(
                     rhs_name = relation["alias"]
                 else:
                     rhs_name = f"{rhs_label.lower()}_{rel_iterator}"
+                    rhs_name = self.create_node_identifier(rhs_name)
             rhs_ident = f"{rhs_name}:{rhs_label}"
             if relation["include_in_return"] and not already_present:
                 self._additional_return(rhs_name)
@@ -1231,12 +1237,9 @@ def render(self, qbuilder: QueryBuilder) -> str:
 class ScalarFunction(BaseFunction):
     """Base scalar function class."""
 
-    pass
-
-
-@dataclass
-class Last(ScalarFunction):
-    """last() function."""
+    @property
+    def function_name(self) -> str:
+        raise NotImplementedError
 
     def render(self, qbuilder: QueryBuilder) -> str:
         if isinstance(self.input_name, str):
@@ -1246,7 +1249,25 @@ def render(self, qbuilder: QueryBuilder) -> str:
             self._internal_name = self.input_name.get_internal_name()
         else:
             content = self.resolve_internal_name(qbuilder)
-        return f"last({content})"
+        return f"{self.function_name}({content})"
+
+
+@dataclass
+class Last(ScalarFunction):
+    """last() function."""
+
+    @property
+    def function_name(self) -> str:
+        return "last"
+
+
+@dataclass
+class Size(ScalarFunction):
+    """size() function."""
+
+    @property
+    def function_name(self) -> str:
+        return "size"
 
 
 @dataclass