Allow passing directory path in FolderData constructor
#3359
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
This will initialize the node and copy over the tree pointed to by the `tree` keyword argument into the node's repository.
ltalirz
suggested changes
Sep 27, 2019
aiida/orm/nodes/data/folder.py
Outdated
|
|
||
| Alternatively, in order to simply wrap a directory, the `path` keyword can be used in the constructor: | ||
|
|
||
| folder = FolderData(tree='/absolute/path/to/directory') |
There was a problem hiding this comment.
Would it make sense to add an explicit documentation of the tree argument as well?
:param tree: Absolute path to a folder to wrap.
:type tree: str
| @@ -19,3 +19,22 @@ | |||
|
|
|||
| class FolderData(Data): | |||
| """`Data` sub class to represent a folder on a file system.""" | |||
|
|
|||
| def __init__(self, **kwargs): | |||
| """Construct a new `FolderData` to which any files and folders can be added. | |||
There was a problem hiding this comment.
Suggested change
| """Construct a new `FolderData` to which any files and folders can be added. | |
| """Construct a new `FolderData` to which files and folders can be added. |
aiida/orm/nodes/data/folder.py
Outdated
| folder.put_object_from_filepath('/absolute/path/to/file.txt') | ||
| folder.put_object_from_filelike(filelike_object) | ||
|
|
||
| Alternatively, in order to simply wrap a directory, the `path` keyword can be used in the constructor: |
There was a problem hiding this comment.
I would put this first, and then mention the other methods.
Suggested change
| Alternatively, in order to simply wrap a directory, the `path` keyword can be used in the constructor: | |
| Use the `tree` keyword in order to simply wrap a directory: |
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.
Fixes #3357
This will initialize the node and copy over the tree pointed to by the
treekeyword argument into the node's repository.