Refactor out _tofile/_fromfile from DirectoryStore
#503
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
To make it easier to sub out different ways of reading and writing data, create to methods to handle reading and writing directly. This way users don't need to reimplement all of the same logic that `__getitem__` and `__setitem__` are doing and can focus on simply reading and writing. Can be useful for trying memmaping for example.
7 tasks
jrbourbeau
reviewed
Nov 8, 2019
Co-Authored-By: James Bourbeau <jrbourbeau@users.noreply.github.com>
mzjp2
approved these changes
Nov 9, 2019
|
The idea would be subclasses could override |
jrbourbeau
reviewed
Nov 9, 2019
There was a problem hiding this comment.
Thanks @jakirkham, this looks great and should definitely help with extending the DirectoryStore! I've left one small documentation comment below. Also, could you please add a changelog entry? Otherwise LGTM
|
Thanks for the feedback. Have added two docstrings based on what you mentioned. Please let me know if there is anything else. 🙂 |
|
Planning on merging EOD tomorrow if no comments. |
|
Thanks James! 😄 |
7 tasks
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
To make it easier for users to implement their own methods for reading and writing from disk ( like memory-mapping #377 ), refactor out
_tofileand_fromfilemethods that are called to handle the reading and writing of the value. Should avoid duplicating a lot of other logic when trying to extendDirectoryStores for these cases.TODO:
tox -e docs)