Cleanup the scope normalization interfaces for v4 #1289
Merged
Conversation
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
This moves the function to the parser class, but also slightly simplifies its behavior. It now refrains from any "re-parsing" of data, and simply joins together strings provided by the user. Users who want to do more normalization have access to `ScopeParser.merge_scopes`, which does more rigorous handling than what was present in `scopes_to_str`.
This function was supported as a public interface but only had one known usage site, in `GlobusApp`. It has been removed and replaced with an internal method, `GlobusApp._iter_scopes`. Unit tests are updated to test the new replacement helper. Because the helper has a tighter contract in terms of what it supports and in what context, it is greatly simplified in the process as well. The older helper structure shows evidence of past iterations in terms of handling nested iterables.
Rather than a helper specific to Globus Auth components doing this as a post-processing step, handling for `""` as the output is now baked into `ScopeParser.serialize`. By default, it will raise an error if it finds that the serialized data is `""`. For example, `ScopeParser.serialize([])` errors. A new flag, `reject_empty=False`, can be passed to explicitly disable the check, if users have a desire to handle an unknown iterable and check if it's empty *after* serialization.
sirosen
requested review from
MaxTueckeGlobus,
aaschaer,
ada-globus,
derek-globus,
kurtmckee and
m1yag1
as code owners
ada-globus
approved these changes
Jul 29, 2025
Contributor
ada-globus
left a comment
ada-globus
left a comment
There was a problem hiding this comment.
Agree w/ these decisions. Replacing scopes_to_str and stringify_requested_scopes with serialize is a nice win for clarity.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
sc-41886
These changes seek to get some better control over the scope interfaces in SDK v4.
Primarily, the outstanding 'odd things' are scope normalizing functions which were added for internal use-cases but declared as public, user-facing functions.
scopes_to_stris here deemed reasonable to expose, but makes a great deal of sense to attach to theScopeParserobject.It is now provided as
ScopeParser.serializeand features a new flag,reject_empty(defaults toTrue) which replaces some internal functionality smoothly.Attachment as a public method to a public object also helps to clarify for internal and external developers that the function is intentionally public (vs name leakage).
scopes_to_scope_listgets the opposite treatment.This is only used inside of
GlobusAppfor some normalization, and it supports a variety of types at runtime which we have declared unsupported in our typing-time contracts.It is replaced with an internal
GlobusApp._iter_scopeshelper, which we can change at will to suit the needs of the SDK itself.The relevant tests for these functions have been ported, as appropriate, to their new implementations.
Because direct usage of these functions is relatively niche, I have opted not to include them in the upgrading guide.
They are called out unceremoniously in the changelog as
Breaking Changes.📚 Documentation preview 📚: https://globus-sdk-python--1289.org.readthedocs.build/en/1289/