fix(bindings/python): Fix the semantic of size argument for python …

…`File::read`
apache · Mar 14, 2024 · 05ba060 · 05ba060
1 parent 7533627
commit 05ba060
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/bindings/python/src/file.rs b/bindings/python/src/file.rs
@@ -57,7 +57,7 @@ impl File {
 
 #[pymethods]
 impl File {
-    /// Read and return size bytes, or if size is not given, until EOF.
+    /// Read and return at most size bytes, or if size is not given, until EOF.
     #[pyo3(signature = (size=None,))]
     pub fn read<'p>(&'p mut self, py: Python<'p>, size: Option<usize>) -> PyResult<&'p PyAny> {
         let reader = match &mut self.0 {
@@ -76,8 +76,7 @@ impl File {
 
         let buffer = match size {
             Some(size) => {
-                let bs = reader
-                    .read_exact(size)
+                let bs = reader.read(size)
                     .map_err(|err| PyIOError::new_err(err.to_string()))?;
                 bs.to_vec()
             }
@@ -218,7 +217,7 @@ impl AsyncFile {
 
 #[pymethods]
 impl AsyncFile {
-    /// Read and return size bytes, or if size is not given, until EOF.
+    /// Read and return at most size bytes, or if size is not given, until EOF.
     pub fn read<'p>(&'p self, py: Python<'p>, size: Option<usize>) -> PyResult<&'p PyAny> {
         let state = self.0.clone();
 
@@ -241,7 +240,7 @@ impl AsyncFile {
             let buffer = match size {
                 Some(size) => {
                     let buffer = reader
-                        .read_exact(size)
+                        .read(size)
                         .await
                         .map_err(|err| PyIOError::new_err(err.to_string()))?;
                     buffer.to_vec()

diff --git a/bindings/python/tests/test_read.py b/bindings/python/tests/test_read.py
@@ -49,6 +49,11 @@ def test_sync_reader(service_name, operator, async_operator):
         assert read_content is not None
         assert read_content == content
 
+    with operator.open(filename, "rb") as reader:
+        read_content = reader.read(size + 1)
+        assert read_content is not None
+        assert read_content == content
+
     operator.delete(filename)
 
 
@@ -80,6 +85,11 @@ async def test_async_reader(service_name, operator, async_operator):
         assert read_content is not None
         assert read_content == content
 
+    async with await async_operator.open(filename, "rb") as reader:
+        read_content = await reader.read(size + 1)
+        assert read_content is not None
+        assert read_content == content
+
     await async_operator.delete(filename)