Scope Parsing

Scope parsing is handled by the ScopeParser type.

Additionally, Scope objects define a parse() method which wraps parser usage.

ScopeParser provides classmethods as its primary interface, so there is no need to instantiate the parser in order to use it.

ScopeParser Reference

class globus_sdk.scopes.ScopeParser

Bases: object

The ScopeParser handles the conversion of strings to scopes.

Most interfaces are classmethods, meaning users should prefer usage like ScopeParser.parse("foo")

classmethod merge_scopes(scopes_a, scopes_b)

Given two lists of Scopes, merge them into one list of Scopes by parsing them as one combined scope string.

Parameters:

• scopes_a (list[Scope]) – list of Scopes to be merged with scopes_b

• scopes_b (list[Scope]) – list of Scopes to be merged with scopes_a

Return type:

list[Scope]

classmethod parse(scope_string)

Parse an arbitrary scope string to a list of scopes.

Zero or more than one scope may be returned, as in the case of an empty string or space-delimited scopes.

Warning

Parsing passes through an intermediary representation which treats scopes as a graph. This ensures that the behavior of parses matches the treatment of scope strings in Globus Auth authorization flows. However, this also means that the parsing does not allow for strings which represent consent trees with structures in which the same scope appears in multiple parts of the tree.

Parameters:

scope_string (str) – The string to parse

Return type:

list[Scope]

class globus_sdk.scopes.ScopeParseError

The error raised if scope parsing fails.

class globus_sdk.scopes.ScopeCycleError

The error raised if scope parsing discovers a cycle.

Utility Functions

globus_sdk.scopes also provides helper functions which are used to manipulate scope objects.

globus_sdk.scopes.scopes_to_str(scopes)

Normalize a scope collection to a space-separated scope string.

Parameters:

scopes (ScopeCollectionType) – A scope string or object, or an iterable of scope strings or objects.

Returns:

A space-separated scope string.

Return type:

str

Example usage:

>>> scopes_to_str(Scope("foo"))
'foo'
>>> scopes_to_str(Scope("foo"), "bar", Scope("qux"))
'foo bar qux'

globus_sdk.scopes.scopes_to_scope_list(scopes)

Normalize a scope collection to a list of Scope objects.

Parameters:

scopes (ScopeCollectionType) – A scope string or object, or an iterable of scope strings or objects.

Returns:

A list of Scope objects.

Return type:

list[Scope]

Example usage:

>>> scopes_to_scope_list(Scope("foo"))
[Scope('foo')]
>>> scopes_to_scope_list(Scope("foo"), "bar baz", Scope("qux"))
[Scope('foo'), Scope('bar'), Scope('baz'), Scope('qux')]