✨(backends) granular data backends without template pattern #488
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
SergioSim
force-pushed
the
granular-data-backends-without-template-pattern
branch
4 times, most recently
from
ca8f722
to
7da89f0
Compare
wilbrdt
reviewed
Oct 30, 2023
Leobouloc
reviewed
Oct 31, 2023
This was
linked to
issues
Oct 31, 2023
SergioSim
force-pushed
the
granular-data-backends-without-template-pattern
branch
2 times, most recently
from
7150453
to
4b073eb
Compare
wilbrdt
approved these changes
Nov 6, 2023
SergioSim
force-pushed
the
granular-data-backends-without-template-pattern
branch
2 times, most recently
from
c37bf4b
to
88d475a
Compare
We simplify the base data backend interface by moving out the write and list methods. Now, data backends that implement the list and write methods should inherit from Writable and Listable classes.
We want to automatically discover backends in the data/backends sub-directories for CLI and LRS usage. We also now handle import failures gracefully, thus backends with unmet dependencies are excluded.
SergioSim
force-pushed
the
granular-data-backends-without-template-pattern
branch
from
88d475a
to
1c66674
Compare
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.
Purpose
Currently, not all backends follow the base interface strictly.
This is problematic as we need to know in advance what methods a backend supports for the CLI usage.
Also, we want to automatically discover backends in the data/backends sub-directories for CLI and LRS usage and handle import failures gracefully, to exclude backends with unmet dependencies.
Proposal
BaseDataBackendinterface to allow backends to follow the base interface more strictly.The
write/listmethods are extracted in separate interfaces (Writable,Listable).Thus, by default, a backend only needs to support the
status/readandclosemethods, and its functionalitycan be extended by inheriting the
Writable/Listableinterfaces.Instead of using
BackendSettingsto discover backends we implement aget_backendsfunction to search for backends in thedata/backendssub-directories.