Clarify async credential requirement and update examples#537
Merged
kyleknap merged 8 commits intofsspec:mainfrom Mar 9, 2026
Merged
Clarify async credential requirement and update examples#537kyleknap merged 8 commits intofsspec:mainfrom
kyleknap merged 8 commits intofsspec:mainfrom
Conversation
Collaborator
anjaliratnam-msft
left a comment
anjaliratnam-msft
left a comment
There was a problem hiding this comment.
This looks good to me!
nateprewitt
force-pushed
the
handle_sync_creds
branch
from
dea0a00 to
49717a9
Compare
kyleknap
reviewed
Mar 6, 2026
Collaborator
kyleknap
left a comment
kyleknap
left a comment
There was a problem hiding this comment.
Looks good! Just had a couple of small comments. I think it is worth calling out the fix for close() in the changelog too.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
adlfsuses the async Azure SDK under the hood, which requires async credentials. A common source of issues is users passing synchronous credentials (e.g.azure.identity.DefaultAzureCredential) instead of their async counterparts (azure.identity.aio.DefaultAzureCredential). This was partly due to inaccurate documentation in the project which should now be fixed.For almost all users, the preferred option is to use
anon=False(soon to be default) when instantiating your file system. This allows the SDK to auto-detect the right credentials. If you must supply credentials directly, make sure you're using the async version.This PR:
FutureWarningwhen synchronous credentials are detectedCredentialTypealias for accurate type checkinganon=Falseover passing credential objects directly, and corrects references to point toazure.identity.aio