Skip to content

Commit 78bd7e6

Browse files
committed
Update credentials.py
Update the comment block of "_with_regional_access_boundary" to inform future maintainers of the necessity to maintain a backwards compatible contract of this method.
1 parent 17a1c3d commit 78bd7e6

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

packages/google-auth/google/auth/credentials.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,10 @@ def _with_regional_access_boundary(self, seed):
365365
"""Returns a copy of these credentials with the the regional_access_boundary
366366
set to the provided seed. This is intended for internal use only as invalid
367367
seeds would produce unexpected results until automatic recovery is supported.
368+
Currently this is used by the gcloud CLI and therefore changes to the
369+
contract MUST be backwards compatible (e.g. the method signature must be
370+
unchanged and a copy of the credenials with the RAB set must be returned).
371+
368372
369373
Returns:
370374
google.auth.credentials.Credentials: A new credentials instance.

0 commit comments

Comments
 (0)