Merge branch 'main' into advanced-pubsub

Author: DenisBiryukov91

Cargo.lock

@@ -26,6 +26,7 @@
 import tomllib
 
 import zenoh
+import zenoh.ext
 
 # -- Project information -----------------------------------------------------
 

docs/conf.py

@@ -74,3 +74,10 @@ module zenoh.handlers
 .. automodule:: zenoh.handlers
     :members:
     :undoc-members:
+
+module zenoh.ext
+================
+
+.. automodule:: zenoh.ext
+    :members:
+    :undoc-members:

docs/index.rst

@@ -49,8 +49,11 @@ impl ZBytes {
         }
     }
 
-    fn to_bytes(&self) -> Cow<[u8]> {
-        self.0.to_bytes()
+    fn to_bytes<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyBytes>> {
+        // Not using `ZBytes::to_bytes`
+        PyBytes::new_bound_with(py, self.0.len(), |bytes| {
+            self.0.reader().read_exact(bytes).into_pyres()
+        })
     }
 
     fn to_string(&self) -> PyResult<Cow<str>> {
@@ -68,9 +71,11 @@ impl ZBytes {
     }
 
     fn __bytes__<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyBytes>> {
-        PyBytes::new_bound_with(py, self.0.len(), |bytes| {
-            self.0.reader().read_exact(bytes).into_pyres()
-        })
+        self.to_bytes(py)
+    }
+
+    fn __str__(&self) -> PyResult<Cow<str>> {
+        self.to_string()
     }
 
     fn __eq__(&self, other: &Bound<PyAny>) -> PyResult<bool> {

src/bytes.rs

@@ -71,8 +71,32 @@ class Float64(float):
 class ZDeserializeError(Exception):
     pass
 
-def z_serialize(obj: Any) -> ZBytes: ...
-def z_deserialize(tp: type[_T], zbytes: ZBytes) -> _T: ...
+def z_serialize(obj: Any) -> ZBytes:
+    """Serialize an object of supported type according to the `Zenoh serialization format <https://github.com/eclipse-zenoh/roadmap/blob/main/rfcs/ALL/Serialization.md>`_.
+
+    Supported types are:
+
+    * UInt8, UInt16, Uint32, UInt64, UInt128, Int8, Int16, Int32, Int64, Int128, int (handled as int32), Float32, Float64, float (handled as Float64), bool;
+
+    * Str, Bytes, ByteArray;
+
+    * List, Dict, Set, FrozenSet and Tuple of supported types.
+    """
+    pass
+
+def z_deserialize(tp: type[_T], zbytes: ZBytes) -> _T:
+    """Deserialize into an object of supported type according to the `Zenoh serialization format <https://github.com/eclipse-zenoh/roadmap/blob/main/rfcs/ALL/Serialization.md>`_.
+
+    Supported types are:
+
+    * UInt8, UInt16, Uint32, UInt64, UInt128, Int8, Int16, Int32, Int64, Int128, int (handled as int32), Float32, Float64, float (handled as Float64), bool;
+
+    * Str, Bytes, ByteArray;
+
+    * List, Dict, Set, FrozenSet and Tuple of supported types.
+    """
+    pass
+
 @_unstable
 @final
 class AdvancedPublisher: