Make VFS accept path-like objects to refer to files. #1818
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Related to #1816. |
nguyenv
approved these changes
Aug 22, 2023
tiledb/vfs.py
Outdated
| from types import TracebackType | ||
| from typing import List, Optional, Type, Union | ||
|
|
||
| import tiledb.cc as lt | ||
|
|
||
| from .ctx import Config, Ctx, default_ctx | ||
|
|
||
| AnyPath = Union[str, bytes, os.PathLike] |
There was a problem hiding this comment.
More of a note to self: We'll want to expand support pathlib.Path / path-like objects for other functions like tiledb.open, etc. eventually. OK to keep this typing definition in here for now but should probably be moved to a new _types.py in the future.
There was a problem hiding this comment.
In order to make this not look like it is intended to be used by any external users, I renamed this to _AnyPath, with no other changes.
When working on a change in tiledbsoma [1], we ran into somewhat mysterious error messages where things had worked before. This was because, unlike `open` (and other libraries which accept path-likes), `tiledb.VFS` only accepts `str` (and undocumented `bytes`) paths. Accepting path-like objects (like `pathlib.Path`s) lets us play better with other libraries and user code. [1]: single-cell-data/TileDB-SOMA#1629
thetorpedodog
force-pushed
the
vfs-pathlib-path
branch
from
2b9fb61 to
c0fd103
Compare
|
I don’t have the power to merge changes, so one of you will have to do it once the tests go through. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When working on a change in tiledbsoma 1, we ran into somewhat mysterious error messages where things had worked before. This was because, unlike
open(and other libraries which accept path-likes),tiledb.VFSonly acceptsstr(and undocumentedbytes) paths. Accepting path-like objects (likepathlib.Paths) lets us play better with other libraries and user code.