Improve packstream Structure class

 * Implement `repr` to match Python implementation
 * Copy tests for `Structure` from the driver project

Author: robsdedude

bin/target_driver.sh

@@ -12,6 +12,7 @@ git checkout "$version"
 git pull origin "$version"
 cd ..
 cp driver/tests/unit/common/codec/packstream/v1/test_packstream.py tests/codec/packstream/v1/from_driver/test_packstream.py
+cp driver/tests/unit/common/codec/packstream/test_structure.py tests/unit/common/codec/packstream/from_driver/test_structure.py
 cp -r driver/tests/unit/common/vector/* tests/vector/from_driver
 
 towncrier create -c "Target driver version ${version}<ISSUES_LIST>.

changelog.d/63.clean.md

@@ -0,0 +1,4 @@
+Improve packstream `Structure` class<ISSUES_LIST>.
+
+ * Implement `repr` to match Python implementation.
+ * Copy tests for `Structure` from the driver project.

src/codec/packstream.rs

@@ -18,7 +18,7 @@ mod v1;
 use pyo3::basic::CompareOp;
 use pyo3::exceptions::PyValueError;
 use pyo3::prelude::*;
-use pyo3::types::{PyBytes, PyTuple};
+use pyo3::types::PyBytes;
 use pyo3::{IntoPyObjectExt, PyTraverseError, PyVisit};
 
 use crate::register_package;
@@ -64,9 +64,20 @@ impl Structure {
         PyBytes::new(py, &[self.tag])
     }
 
-    #[getter(fields)]
-    fn read_fields<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyTuple>> {
-        PyTuple::new(py, &self.fields)
+    fn __repr__(slf: &Bound<'_, Self>) -> PyResult<String> {
+        let args = {
+            let slf = slf.borrow();
+            let py = slf.py();
+            let mut args = format!(r"b'{}'", slf.tag as char);
+            slf.fields.iter().try_for_each(|field| {
+                let repr = field.bind(py).repr()?;
+                args.push_str(", ");
+                args.push_str(&repr.to_cow()?);
+                Ok::<_, PyErr>(())
+            })?;
+            args
+        };
+        Ok(format!("Structure({args})"))
     }
 
     fn eq(&self, other: &Self, py: Python<'_>) -> PyResult<bool> {

tests/codec/packstream/from_driver/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

tests/codec/packstream/from_driver/test_structure.py

@@ -0,0 +1,82 @@
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import pytest
+
+from neo4j._codec.packstream import Structure
+
+
+@pytest.mark.parametrize(
+    "args",
+    (
+        (b"T", 1, 2, 3, "abc", 1.2, None, False),
+        (b"F",),
+    ),
+)
+def test_structure_accessors(args):
+    tag = args[0]
+    fields = list(args[1:])
+    s1 = Structure(*args)
+    assert s1.tag == tag
+    assert s1.fields == fields
+
+
+@pytest.mark.parametrize(
+    ("other", "expected"),
+    (
+        (Structure(b"T", 1, 2, 3, "abc", 1.2, [{"a": "b"}, None]), True),
+        (Structure(b"T", 1, 2, 3, "abc", 1.2, [{"a": "b"}, 0]), False),
+        (Structure(b"T", 1, 2, 3, "abc", 1.2, [{"a": "B"}, None]), False),
+        (Structure(b"T", 1, 2, 3, "abc", 1.2, [{"A": "b"}, None]), False),
+        (Structure(b"T", 1, 2, 3, "abc", 1.3, [{"a": "b"}, None]), False),
+        (
+            Structure(b"T", 1, 2, 3, "aBc", float("Nan"), [{"a": "b"}, None]),
+            False,
+        ),
+        (Structure(b"T", 2, 2, 3, "abc", 1.2, [{"a": "b"}, None]), False),
+        (Structure(b"T", 2, 3, "abc", 1.2, [{"a": "b"}, None]), False),
+        (Structure(b"T", [1, 2, 3, "abc", 1.2, [{"a": "b"}, None]]), False),
+        (object(), NotImplemented),
+    ),
+)
+def test_structure_equality(other, expected):
+    s1 = Structure(b"T", 1, 2, 3, "abc", 1.2, [{"a": "b"}, None])
+    assert s1.__eq__(other) is expected  # noqa: PLC2801
+    if expected is NotImplemented:
+        assert s1.__ne__(other) is NotImplemented  # noqa: PLC2801
+    else:
+        assert s1.__ne__(other) is not expected  # noqa: PLC2801
+
+
+@pytest.mark.parametrize(
+    ("args", "expected"),
+    (
+        ((b"F", 1, 2), "Structure(b'F', 1, 2)"),
+        ((b"f", [1, 2]), "Structure(b'f', [1, 2])"),
+        (
+            (b"T", 1.3, None, {"a": "b"}),
+            "Structure(b'T', 1.3, None, {'a': 'b'})",
+        ),
+    ),
+)
+def test_structure_repr(args, expected):
+    s1 = Structure(*args)
+    assert repr(s1) == expected
+    assert str(s1) == expected
+
+    # Ensure that the repr is consistent with the constructor
+    assert eval(repr(s1)) == s1
+    assert eval(str(s1)) == s1