You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "bkietz (via GitHub)" <gi...@apache.org> on 2024/03/04 17:00:36 UTC
[PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
bkietz opened a new pull request, #40356:
URL: https://github.com/apache/arrow/pull/40356
<!--
Thanks for opening a pull request!
If this is your first pull request you can find detailed information on how
to contribute here:
* [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
* [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
In the case of PARQUET issues on JIRA the title also supports:
PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
-->
### Rationale for this change
Moving LocalFileSystem into to registry is a good first usage and will help us hammer out which aspects of built in file systems should remain public.
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
### What changes are included in this PR?
A factory for LocalFileSystem is added to the registry. `FileSystem::MakeUri` is added to enable roundtripping filesystems through URIs. Some unnecessary bindings to the LocalFileSystem concrete class are removed. file:// URIs now support a use_mmap query parameter
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
### Are these changes tested?
Yes, all existing tests for file:// URIs continue to pass
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
### Are there any user-facing changes?
For consistency, local:// URIs will now be considered equivalent to corresponding file:// URIs
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please uncomment the line below and explain which changes are breaking.
-->
<!-- **This PR includes breaking changes to public APIs.** -->
<!--
Please uncomment the line below (and provide explanation) if the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld). We use this to highlight fixes to issues that may affect users without their knowledge. For this reason, fixing bugs that cause errors don't count, since those are usually obvious.
-->
<!-- **This PR contains a "Critical Fix".** -->
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "bkietz (via GitHub)" <gi...@apache.org>.
bkietz commented on PR #40356:
URL: https://github.com/apache/arrow/pull/40356#issuecomment-2073399617
The only failures are a known flake https://github.com/apache/arrow/issues/40675
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #40356:
URL: https://github.com/apache/arrow/pull/40356#issuecomment-2075503703
After merging your PR, Conbench analyzed the 7 benchmarking runs that have been run so far on merge-commit fd75cbdb38836b66dbae81094cf06821e5d25cb1.
There were no benchmark performance regressions. 🎉
The [full Conbench report](https://github.com/apache/arrow/runs/24215695607) has more details. It also includes information about 45 possible false positives for unstable benchmarks that are known to sometimes produce them.
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #40356:
URL: https://github.com/apache/arrow/pull/40356#discussion_r1584266480
##########
python/pyarrow/_fs.pyx:
##########
@@ -1097,30 +1101,18 @@ cdef class LocalFileSystem(FileSystem):
def __init__(self, *, use_mmap=False):
cdef:
- CLocalFileSystemOptions opts
- shared_ptr[CLocalFileSystem] fs
-
- opts = CLocalFileSystemOptions.Defaults()
- opts.use_mmap = use_mmap
+ shared_ptr[CFileSystem] fs
+ c_string c_uri
- fs = make_shared[CLocalFileSystem](opts)
+ # from_uri needs a non-empty path, so just use a placeholder of /_
+ c_uri = tobytes(f"file:///_?use_mmap={int(use_mmap)}")
+ with nogil:
+ fs = GetResultValue(CFileSystemFromUri(c_uri))
self.init(<shared_ptr[CFileSystem]> fs)
- cdef init(self, const shared_ptr[CFileSystem]& c_fs):
- FileSystem.init(self, c_fs)
- self.localfs = <CLocalFileSystem*> c_fs.get()
-
- @staticmethod
- @binding(True) # Required for cython < 3
- def _reconstruct(kwargs):
- # __reduce__ doesn't allow passing named arguments directly to the
- # reconstructor, hence this wrapper.
- return LocalFileSystem(**kwargs)
-
def __reduce__(self):
- cdef CLocalFileSystemOptions opts = self.localfs.options()
- return LocalFileSystem._reconstruct, (dict(
- use_mmap=opts.use_mmap),)
+ uri = frombytes(GetResultValue(self.fs.MakeUri(b"/_")))
+ return FileSystem._from_uri, (uri,)
Review Comment:
Refactoring this has broken the cython-2 build (as the removed comments indicated, that code was required for cython < 3)
See https://github.com/ursacomputing/crossbow/actions/runs/8887296743/job/24402368974
(TBH, I would personally also fine with just dropping that build and requiring cython > 3 for building)
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #40356:
URL: https://github.com/apache/arrow/pull/40356#discussion_r1584273269
##########
python/pyarrow/_fs.pyx:
##########
@@ -1097,30 +1101,18 @@ cdef class LocalFileSystem(FileSystem):
def __init__(self, *, use_mmap=False):
cdef:
- CLocalFileSystemOptions opts
- shared_ptr[CLocalFileSystem] fs
-
- opts = CLocalFileSystemOptions.Defaults()
- opts.use_mmap = use_mmap
+ shared_ptr[CFileSystem] fs
+ c_string c_uri
- fs = make_shared[CLocalFileSystem](opts)
+ # from_uri needs a non-empty path, so just use a placeholder of /_
+ c_uri = tobytes(f"file:///_?use_mmap={int(use_mmap)}")
+ with nogil:
+ fs = GetResultValue(CFileSystemFromUri(c_uri))
self.init(<shared_ptr[CFileSystem]> fs)
- cdef init(self, const shared_ptr[CFileSystem]& c_fs):
- FileSystem.init(self, c_fs)
- self.localfs = <CLocalFileSystem*> c_fs.get()
-
- @staticmethod
- @binding(True) # Required for cython < 3
- def _reconstruct(kwargs):
- # __reduce__ doesn't allow passing named arguments directly to the
- # reconstructor, hence this wrapper.
- return LocalFileSystem(**kwargs)
-
def __reduce__(self):
- cdef CLocalFileSystemOptions opts = self.localfs.options()
- return LocalFileSystem._reconstruct, (dict(
- use_mmap=opts.use_mmap),)
+ uri = frombytes(GetResultValue(self.fs.MakeUri(b"/_")))
+ return FileSystem._from_uri, (uri,)
Review Comment:
Opened https://github.com/apache/arrow/pull/41459 for a quick fix for now
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "bkietz (via GitHub)" <gi...@apache.org>.
bkietz commented on code in PR #40356:
URL: https://github.com/apache/arrow/pull/40356#discussion_r1568083144
##########
cpp/src/arrow/filesystem/localfs.cc:
##########
@@ -686,4 +704,19 @@ Result<std::shared_ptr<io::OutputStream>> LocalFileSystem::OpenAppendStream(
return OpenOutputStreamGeneric(path, truncate, append);
}
+static Result<std::shared_ptr<fs::FileSystem>> LocalFileSystemFactory(
+ const arrow::util::Uri& uri, const io::IOContext& io_context, std::string* out_path) {
+ std::string path;
+ ARROW_ASSIGN_OR_RAISE(auto options, LocalFileSystemOptions::FromUri(uri, &path));
+ if (out_path != nullptr) {
+ *out_path = std::move(path);
+ }
+ return std::make_shared<LocalFileSystem>(options, io_context);
+}
+
+FileSystemRegistrar kLocalFileSystemModule[]{
+ {"file", LocalFileSystemFactory},
+ {"local", LocalFileSystemFactory},
Review Comment:
It seemed more inconsistent to refuse the scheme since the `type_name()` of other filesystems is also a usable scheme. I can remove it
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "bkietz (via GitHub)" <gi...@apache.org>.
bkietz commented on code in PR #40356:
URL: https://github.com/apache/arrow/pull/40356#discussion_r1585134614
##########
python/pyarrow/_fs.pyx:
##########
@@ -1097,30 +1101,18 @@ cdef class LocalFileSystem(FileSystem):
def __init__(self, *, use_mmap=False):
cdef:
- CLocalFileSystemOptions opts
- shared_ptr[CLocalFileSystem] fs
-
- opts = CLocalFileSystemOptions.Defaults()
- opts.use_mmap = use_mmap
+ shared_ptr[CFileSystem] fs
+ c_string c_uri
- fs = make_shared[CLocalFileSystem](opts)
+ # from_uri needs a non-empty path, so just use a placeholder of /_
+ c_uri = tobytes(f"file:///_?use_mmap={int(use_mmap)}")
+ with nogil:
+ fs = GetResultValue(CFileSystemFromUri(c_uri))
self.init(<shared_ptr[CFileSystem]> fs)
- cdef init(self, const shared_ptr[CFileSystem]& c_fs):
- FileSystem.init(self, c_fs)
- self.localfs = <CLocalFileSystem*> c_fs.get()
-
- @staticmethod
- @binding(True) # Required for cython < 3
- def _reconstruct(kwargs):
- # __reduce__ doesn't allow passing named arguments directly to the
- # reconstructor, hence this wrapper.
- return LocalFileSystem(**kwargs)
-
def __reduce__(self):
- cdef CLocalFileSystemOptions opts = self.localfs.options()
- return LocalFileSystem._reconstruct, (dict(
- use_mmap=opts.use_mmap),)
+ uri = frombytes(GetResultValue(self.fs.MakeUri(b"/_")))
+ return FileSystem._from_uri, (uri,)
Review Comment:
Whoops, sorry
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #40356:
URL: https://github.com/apache/arrow/pull/40356#issuecomment-1977053377
<!--
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.
-->
Thanks for opening a pull request!
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
In the case of PARQUET issues on JIRA the title also supports:
PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
See also:
* [Other pull requests](https://github.com/apache/arrow/pulls/)
* [Contribution Guidelines - Contributing Overview](https://arrow.apache.org/docs/developers/overview.html)
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "felipecrv (via GitHub)" <gi...@apache.org>.
felipecrv commented on code in PR #40356:
URL: https://github.com/apache/arrow/pull/40356#discussion_r1535952395
##########
cpp/src/arrow/filesystem/localfs.cc:
##########
@@ -686,4 +704,19 @@ Result<std::shared_ptr<io::OutputStream>> LocalFileSystem::OpenAppendStream(
return OpenOutputStreamGeneric(path, truncate, append);
}
+static Result<std::shared_ptr<fs::FileSystem>> LocalFileSystemFactory(
+ const arrow::util::Uri& uri, const io::IOContext& io_context, std::string* out_path) {
+ std::string path;
+ ARROW_ASSIGN_OR_RAISE(auto options, LocalFileSystemOptions::FromUri(uri, &path));
+ if (out_path != nullptr) {
+ *out_path = std::move(path);
+ }
+ return std::make_shared<LocalFileSystem>(options, io_context);
+}
+
+FileSystemRegistrar kLocalFileSystemModule[]{
+ {"file", LocalFileSystemFactory},
+ {"local", LocalFileSystemFactory},
Review Comment:
Is this really necessary? The `local` scheme?
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "paleolimbot (via GitHub)" <gi...@apache.org>.
paleolimbot commented on code in PR #40356:
URL: https://github.com/apache/arrow/pull/40356#discussion_r1535996380
##########
r/R/filesystem.R:
##########
@@ -390,7 +390,7 @@ are_urls <- function(x) if (!is.character(x)) FALSE else grepl("://", x)
#' @export
LocalFileSystem <- R6Class("LocalFileSystem", inherit = FileSystem)
LocalFileSystem$create <- function() {
- fs___LocalFileSystem__create()
+ FileSystem$from_uri("file:///_")$fs
Review Comment:
Is `_` the sentinel for something? (It might be worth explaining why it's there since for the next time one of us has to debug it).
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #40356:
URL: https://github.com/apache/arrow/pull/40356#issuecomment-2007798742
<!--
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.
-->
Thanks for opening a pull request!
If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
In the case of PARQUET issues on JIRA the title also supports:
PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
See also:
* [Other pull requests](https://github.com/apache/arrow/pulls/)
* [Contribution Guidelines - Contributing Overview](https://arrow.apache.org/docs/developers/overview.html)
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche commented on code in PR #40356:
URL: https://github.com/apache/arrow/pull/40356#discussion_r1530859485
##########
cpp/src/arrow/filesystem/filesystem.h:
##########
@@ -197,6 +197,8 @@ class ARROW_EXPORT FileSystem
/// \return The path inside the filesystem that is indicated by the URI.
virtual Result<std::string> PathFromUri(const std::string& uri_string) const;
+ virtual Result<std::string> MakeUri(std::string path) const;
Review Comment:
Add a doc comment here?
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] GH-40342: [C++] move LocalFileSystem to the registry [arrow]
Posted by "bkietz (via GitHub)" <gi...@apache.org>.
bkietz merged PR #40356:
URL: https://github.com/apache/arrow/pull/40356
--
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.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org