feat(bindings/python): add exists (#5637)

* try add exists

* try add test

* ruff + fix path

* check file

* fix test

Author: asukaminato0721

bindings/python/python/opendal/__init__.pyi

@@ -45,6 +45,7 @@ class Operator(_Base):
     def stat(self, path: PathBuf) -> Metadata: ...
     def create_dir(self, path: PathBuf) -> None: ...
     def delete(self, path: PathBuf) -> None: ...
+    def exists(self, path: PathBuf) -> bool: ...
     def list(self, path: PathBuf) -> Iterable[Entry]: ...
     def scan(self, path: PathBuf) -> Iterable[Entry]: ...
     def capability(self) -> Capability: ...
@@ -72,6 +73,7 @@ class AsyncOperator(_Base):
     async def stat(self, path: PathBuf) -> Metadata: ...
     async def create_dir(self, path: PathBuf) -> None: ...
     async def delete(self, path: PathBuf) -> None: ...
+    async def exists(self, path: PathBuf) -> bool: ...
     async def list(self, path: PathBuf) -> AsyncIterable[Entry]: ...
     async def scan(self, path: PathBuf) -> AsyncIterable[Entry]: ...
     async def presign_stat(

bindings/python/src/operator.rs

@@ -198,6 +198,16 @@ impl Operator {
         self.core.delete(&path).map_err(format_pyerr)
     }
 
+    /// Check given path is exists.
+    ///
+    /// # Notes
+    ///
+    /// - Check not existing path won't return errors.
+    pub fn exists(&self, path: PathBuf) -> PyResult<bool> {
+        let path = path.to_string_lossy().to_string();
+        self.core.exists(&path).map_err(format_pyerr)
+    }
+
     /// List current dir path.
     pub fn list(&self, path: PathBuf) -> PyResult<BlockingLister> {
         let path = path.to_string_lossy().to_string();
@@ -460,6 +470,20 @@ impl AsyncOperator {
         )
     }
 
+    /// Check given path is exists.
+    ///
+    /// # Notes
+    ///
+    /// - Check not existing path won't return errors.
+    pub fn exists<'p>(&'p self, py: Python<'p>, path: PathBuf) -> PyResult<Bound<'p, PyAny>> {
+        let this = self.core.clone();
+        let path = path.to_string_lossy().to_string();
+        future_into_py(
+            py,
+            async move { this.exists(&path).await.map_err(format_pyerr) },
+        )
+    }
+
     /// List current dir path.
     pub fn list<'p>(&'p self, py: Python<'p>, path: PathBuf) -> PyResult<Bound<'p, PyAny>> {
         let this = self.core.clone();

bindings/python/tests/test_async_exists.py

@@ -0,0 +1,31 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+#
+#   http://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 os
+from uuid import uuid4
+
+import pytest
+
+
+@pytest.mark.asyncio
+@pytest.mark.need_capability("read", "write", "delete", "list", "create_dir")
+async def test_async_remove_all(service_name, operator, async_operator):
+    content = os.urandom(1024)
+    target = f"random_{str(uuid4())}"
+    await async_operator.write(target, content)
+    assert await async_operator.exists(target)
+    assert not await async_operator.exists(target + "1")

bindings/python/tests/test_sync_exists.py

@@ -0,0 +1,32 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+#
+#   http://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 os
+from uuid import uuid4
+
+import pytest
+
+
+@pytest.mark.need_capability(
+    "read", "write", "delete", "list", "blocking", "create_dir"
+)
+def test_sync_exists(service_name, operator, async_operator):
+    content = os.urandom(1024)
+    target = f"random_{str(uuid4())}"
+    operator.write(target, content)
+    assert operator.exists(target)
+    assert not operator.exists(target + "1")