jorisvandenbossche commented on a change in pull request #7349:
URL: https://github.com/apache/arrow/pull/7349#discussion_r437373988
##########
File path: python/pyarrow/_fs.pyx
##########
@@ -685,3 +756,234 @@ cdef class _MockFileSystem(FileSystem):
cdef init(self, const shared_ptr[CFileSystem]& wrapped):
FileSystem.init(self, wrapped)
self.mockfs = <CMockFileSystem*> wrapped.get()
+
+
+cdef class PyFileSystem(FileSystem):
+ """
+ A FileSystem with behavior implemented in Python.
+
+ A PyFileSystem is backed by a FileSystemHandler instance.
+ """
+
+ def __init__(self, handler):
+ cdef:
+ CPyFileSystemVtable vtable
+ shared_ptr[CPyFileSystem] wrapped
+
+ if not isinstance(handler, FileSystemHandler):
+ raise TypeError("Expected a FileSystemHandler instance, got {0}"
+ .format(type(handler)))
+
+ vtable.get_type_name = _cb_get_type_name
+ vtable.equals = _cb_equals
+ vtable.get_file_info = _cb_get_file_info
+ vtable.get_file_info_vector = _cb_get_file_info_vector
+ vtable.get_file_info_selector = _cb_get_file_info_selector
+ vtable.create_dir = _cb_create_dir
+ vtable.delete_dir = _cb_delete_dir
+ vtable.delete_dir_contents = _cb_delete_dir_contents
+ vtable.delete_file = _cb_delete_file
+ vtable.move = _cb_move
+ vtable.copy_file = _cb_copy_file
+ vtable.open_input_stream = _cb_open_input_stream
+ vtable.open_input_file = _cb_open_input_file
+ vtable.open_output_stream = _cb_open_output_stream
+ vtable.open_append_stream = _cb_open_append_stream
+
+ wrapped = CPyFileSystem.Make(handler, move(vtable))
+ self.init(<shared_ptr[CFileSystem]> wrapped)
+
+ cdef init(self, const shared_ptr[CFileSystem]& wrapped):
+ FileSystem.init(self, wrapped)
+ self.pyfs = <CPyFileSystem*> wrapped.get()
+
+ @property
+ def handler(self):
+ """
+ The filesystem's underlying handler.
+
+ Returns
+ -------
+ handler : FileSystemHandler
+ """
+ return <object> self.pyfs.handler()
+
+ def __reduce__(self):
+ return PyFileSystem, (self.handler,)
+
+
+class FileSystemHandler(ABC):
+ """
+ An abstract class exposing methods to implement PyFileSystem's behavior.
+ """
+
+ @abstractmethod
+ def get_type_name(self):
+ """
+ Implement PyFileSystem.type_name.
+ """
+
+ @abstractmethod
+ def get_file_info(self, paths):
+ """
+ Implement PyFileSystem.get_file_info(paths).
+ """
+
+ @abstractmethod
+ def get_file_info_selector(self, selector):
+ """
+ Implement PyFileSystem.get_file_info(selector).
+ """
+
+ @abstractmethod
+ def create_dir(self, path, recursive):
+ """
+ Implement PyFileSystem.create_dir(...).
+ """
+
+ @abstractmethod
+ def delete_dir(self, path):
+ """
+ Implement PyFileSystem.delete_dir(...).
+ """
+
+ @abstractmethod
+ def delete_dir_contents(self, path):
+ """
+ Implement PyFileSystem.delete_dir_contents(...).
+ """
+
+ @abstractmethod
+ def delete_file(self, path):
+ """
+ Implement PyFileSystem.delete_file(...).
+ """
+
+ @abstractmethod
+ def move(self, src, dest):
+ """
+ Implement PyFileSystem.move(...).
Review comment:
I suppose methods like this are expected to just raise the appropriate
FileNotFoundError in case `src` does not exist?
##########
File path: cpp/src/arrow/python/filesystem.h
##########
@@ -0,0 +1,115 @@
+// 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.
+
+#pragma once
+
+#include <memory>
+#include <string>
+#include <vector>
+
+#include "arrow/filesystem/filesystem.h"
+#include "arrow/python/common.h"
+#include "arrow/python/visibility.h"
+#include "arrow/util/macros.h"
+
+namespace arrow {
+namespace py {
+namespace fs {
+
+class ARROW_PYTHON_EXPORT PyFileSystemVtable {
+ public:
+ std::function<void(PyObject*, std::string* out)> get_type_name;
+ std::function<bool(PyObject*, const arrow::fs::FileSystem& other)> equals;
+
+ std::function<void(PyObject*, const std::string& path, arrow::fs::FileInfo*
out)>
+ get_file_info;
+ std::function<void(PyObject*, const std::vector<std::string>& paths,
+ std::vector<arrow::fs::FileInfo>* out)>
+ get_file_info_vector;
+ std::function<void(PyObject*, const arrow::fs::FileSelector&,
+ std::vector<arrow::fs::FileInfo>* out)>
+ get_file_info_selector;
+
+ std::function<void(PyObject*, const std::string& path, bool)> create_dir;
+ std::function<void(PyObject*, const std::string& path)> delete_dir;
+ std::function<void(PyObject*, const std::string& path)> delete_dir_contents;
+ std::function<void(PyObject*, const std::string& path)> delete_file;
+ std::function<void(PyObject*, const std::string& src, const std::string&
dest)> move;
+ std::function<void(PyObject*, const std::string& src, const std::string&
dest)>
+ copy_file;
+
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::InputStream>* out)>
+ open_input_stream;
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::RandomAccessFile>* out)>
+ open_input_file;
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::OutputStream>* out)>
+ open_output_stream;
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::OutputStream>* out)>
+ open_append_stream;
+};
+
+class ARROW_PYTHON_EXPORT PyFileSystem : public arrow::fs::FileSystem {
Review comment:
Does this need some doc comments? (I don't know how "public" this is, in
the end it is only to be used in the python bindings I think, and there the
PyFileSystem class has docstrings for python users, so that might be sufficient)
##########
File path: cpp/src/arrow/python/filesystem.h
##########
@@ -0,0 +1,115 @@
+// 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.
+
+#pragma once
+
+#include <memory>
+#include <string>
+#include <vector>
+
+#include "arrow/filesystem/filesystem.h"
+#include "arrow/python/common.h"
+#include "arrow/python/visibility.h"
+#include "arrow/util/macros.h"
+
+namespace arrow {
+namespace py {
+namespace fs {
+
+class ARROW_PYTHON_EXPORT PyFileSystemVtable {
+ public:
+ std::function<void(PyObject*, std::string* out)> get_type_name;
+ std::function<bool(PyObject*, const arrow::fs::FileSystem& other)> equals;
+
+ std::function<void(PyObject*, const std::string& path, arrow::fs::FileInfo*
out)>
+ get_file_info;
+ std::function<void(PyObject*, const std::vector<std::string>& paths,
+ std::vector<arrow::fs::FileInfo>* out)>
+ get_file_info_vector;
+ std::function<void(PyObject*, const arrow::fs::FileSelector&,
+ std::vector<arrow::fs::FileInfo>* out)>
+ get_file_info_selector;
+
+ std::function<void(PyObject*, const std::string& path, bool)> create_dir;
+ std::function<void(PyObject*, const std::string& path)> delete_dir;
+ std::function<void(PyObject*, const std::string& path)> delete_dir_contents;
+ std::function<void(PyObject*, const std::string& path)> delete_file;
+ std::function<void(PyObject*, const std::string& src, const std::string&
dest)> move;
+ std::function<void(PyObject*, const std::string& src, const std::string&
dest)>
+ copy_file;
+
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::InputStream>* out)>
+ open_input_stream;
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::RandomAccessFile>* out)>
+ open_input_file;
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::OutputStream>* out)>
+ open_output_stream;
+ std::function<void(PyObject*, const std::string& path,
+ std::shared_ptr<io::OutputStream>* out)>
+ open_append_stream;
+};
+
+class ARROW_PYTHON_EXPORT PyFileSystem : public arrow::fs::FileSystem {
Review comment:
Maybe just one-liner indicating this is only used to implement
pyarrow.fs.PyFileSystem could be added then, but not that important
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
