BlobTree API refactor including newfile() / newdir(), and renaming. #45
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
Refactor newfile() / newdir() into primarily in-place APIs. A temporary directory can still be created with newdir(). Before this refactor the API looked slightly nicer, but we would never be able to reach the efficiency of the native file APIs. In particular, we might end up moving data across devices as a last step in constructing a directory tree — this seemed bad! Various changes to BlobTree API to make it more Dict-like and less reliant on overloading filesystem-like functions. * Further document the BlobTree API * Allow path strings as keys in more places in BlobTree * Deprecations of some filesystem-like functions
* The big rename * Add deprecations for Blob, BlobTree
Not including documentation on writing to a file tree yet; that will come in a future change.
Also some docstring refinement
* Additional tests for FileTree - the whole API should be covered now. * Remove internal TempFilesystemRoot; replace with a simple flag on FileSystemRoot. * Remove internal AbstractFileSystemRoot; this seems unnecessary now.
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.
This PR updates and refines the
BlobTreeAPI and renamesBlobTree->FileTreeandBlob->Fileas mentioned to fix #41. In the rename, the previous nameBlobTreeis still allowed for now, though both the binding and use in Data.toml are deprecated.It also significantly updates and refines the mutation API — the
newfile()andnewdir()functions so that they're primarily in-place APIs. The older out-of-placenewfile()andnewdir()have been deprecated. (Before this refactor the API looked slightly nicer, but was inherently less efficient than the native file APIs.)In addition, add a few missing pieces of query functionality
/-separated path strings in anyFileTreeaccessors for convenience. (Previously these would raise an error.)delete!(tree, path). Requires the tree's root object to implementdelete!(root, path)rm(tree).TODO
newfile()andnewdir().