Add Python pathlib support for file IO #6619
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds support for
pathlib.Path
/os.PathLike
type arguments to IO functions. E.g:is now supported in addition to
str
-type arguments.Type
Motivation and Context
Currently, only string-type filenames are supported in all IO functions. Python's
pathlib
is quite popular and should be supported. This commit adds support for all libraries which are compatible withos.PathLike
aspathlib
is.Checklist:
python util/check_style.py --apply
to apply Open3D code styleto my code.
updated accordingly.
results (e.g. screenshots or numbers) here.
Description
Using
std::filesystem::path
as type for filename arguments allows pybind to support bothpathlib.Path
andstring
through <pybind11/stl/filesystem.h> (which I backported to C++14 with minimal changes). Unfortunately this means we have to callfilename.string()
in the wrappers when calling the open3d C++ code.I've added support everywhere except for
o3d.data
classes and someo3d.t.io.*Sensor
class functions.The documentation shows will os.PathLike as type for filenames: