Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Changed
-------

- The method ``GroupsClient.set_subscription_admin_verified_id`` has been renamed to
``GroupsClient.set_subscription_admin_verified``. The earlier function name is still
available but emits a deprecation warning. (:pr:`NUMBER`)
25 changes: 24 additions & 1 deletion src/globus_sdk/services/groups/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import typing as t
import uuid

from globus_sdk import client, response, utils
from globus_sdk import client, exc, response, utils
from globus_sdk.scopes import GroupsScopes, Scope

from .data import BatchMembershipActions, GroupPolicies
Expand Down Expand Up @@ -401,6 +401,29 @@ def set_subscription_admin_verified_id(
subscription_id: uuid.UUID | str | None,
*,
query_params: dict[str, t.Any] | None = None,
) -> response.GlobusHTTPResponse:
"""
Deprecated alias for :meth:`set_subscription_admin_verified`.

:param group_id: the ID of the group
:param subscription_id: the ID of the subscription to which the group belongs,
or ``None`` to disassociate the group from a subscription
:param query_params: additional passthrough query parameters
"""
exc.warn_deprecated(
"`GroupsClient.set_subscription_admin_verified_id()` has been renamed to "
"`GroupsClient.set_subscription_admin_verified()`."
)
return self.set_subscription_admin_verified(
group_id, subscription_id, query_params=query_params
)

def set_subscription_admin_verified(
self,
group_id: uuid.UUID | str,
subscription_id: uuid.UUID | str | None,
*,
query_params: dict[str, t.Any] | None = None,
) -> response.GlobusHTTPResponse:
"""
Verify a group as belonging to a subscription or disassociate a verified group
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import json
import re

import pytest

from globus_sdk import RemovedInV4Warning
from globus_sdk._testing import get_last_request, load_response


def test_set_subscription_admin_verified(groups_client):
meta = load_response(groups_client.set_subscription_admin_verified).metadata

res = groups_client.set_subscription_admin_verified(
group_id=meta["group_id"],
subscription_id=meta["subscription_id"],
)
assert res.http_status == 200
assert res.data["group_id"] == meta["group_id"]
assert res.data["subscription_admin_verified_id"] == meta["subscription_id"]

req = get_last_request()
req = json.loads(req.body)
assert req == {"subscription_admin_verified_id": meta["subscription_id"]}


def test_set_subscription_admin_verified_id(groups_client):
"""Test that the deprecated alias warns but is functionally equivalent."""
meta = load_response(groups_client.set_subscription_admin_verified).metadata

with pytest.warns(
RemovedInV4Warning,
match=re.escape(
"`GroupsClient.set_subscription_admin_verified_id()` has been renamed to "
"`GroupsClient.set_subscription_admin_verified()`."
),
):
res = groups_client.set_subscription_admin_verified_id(
group_id=meta["group_id"],
subscription_id=meta["subscription_id"],
)
assert res.http_status == 200
assert res.data["group_id"] == meta["group_id"]
assert res.data["subscription_admin_verified_id"] == meta["subscription_id"]

req = get_last_request()
req = json.loads(req.body)
assert req == {"subscription_admin_verified_id": meta["subscription_id"]}

This file was deleted.

Loading