feat: add multi-storage-client backend for file open #1455
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
pzelasko
requested changes
Mar 4, 2025
| @@ -815,6 +815,82 @@ def handles_special_case(self, identifier: Pathlike) -> bool: | |||
| def is_applicable(self, identifier: Pathlike) -> bool: | |||
| return is_valid_url(identifier) | |||
|
|
|||
|
|
|||
| @lru_cache(1) | |||
There was a problem hiding this comment.
We can remove the lru cache decorator since these environ lookups should be cheap - it looks like that would simplify the tests.
| 2. override the profile/bucket name by env LHOTSE_MSC_PROFILE if provided: msc://profile/path/to/my/object2, | ||
| if bucket name is not provided, then we expect the msc profile name to match with bucket name | ||
| """ | ||
|
|
There was a problem hiding this comment.
Please add an import guard here:
if not is_module_available("multistorageclient"):
raise RuntimeError("Please run 'pip install multistorageclient' in order to use MSCIOBackend.")(imported from lhotse.utils)
|
|
||
| class MSCIOBackend(IOBackend): | ||
| """ | ||
| Uses multi-storage client to download data from object store |
There was a problem hiding this comment.
Can you add a link to MSC here? It'd be good to add 1-2 sentences about how MSC is different and what are it's unique features.
|
|
||
| @lru_cache(1) | ||
| def get_lhotse_msc_override_protocols() -> Any: | ||
| return os.getenv("LHOTSE_MSC_OVERRIDE_PROTOCOLS", None) |
There was a problem hiding this comment.
Please document these environment variables in Lhotse's top-level README.md where it lists all env vars used to modify lhotse behavior.
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 adds support for the Multi-Storage Client (MSC) backend to handle object storage access in Lhotse. The changes include:
Features
MSCIOBackendfor handling MSC protocol URLsLHOTSE_MSC_OVERRIDE_PROTOCOLSenv for supported protocols, e.g.s3://->msc://LHOTSE_MSC_PROFILEenv for profile/bucket name overrides, e.g.msc://my-bucket->msc://my-profileImplementation Details
Configuration
MSC behavior can be configured through environment variables:
LHOTSE_MSC_OVERRIDE_PROTOCOLS: Comma-separated list of protocols to override (e.g., "s3,gs")LHOTSE_MSC_PROFILE: Profile name to use for bucket overrideDependencies
multistorageclientpackage to be installed