Skip to content

Remove the setter for GlobusAPIError.message #1204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sirosen merged 1 commit into from
May 30, 2025
Merged

Remove the setter for GlobusAPIError.message #1204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions changelog.d/20250530_102408_sirosen_remove_deprecated_message_setter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Removed
~~~~~~~

- ``GlobusAPIError`` no longer provides a setter for ``message``. The
``message`` property is now read-only. (:pr:`NUMBER`)
8 changes: 0 additions & 8 deletions src/globus_sdk/exc/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,6 @@ def message(self) -> str | None:
return "; ".join(self.messages)
return None

@message.setter
def message(self, value: str) -> None:
warn_deprecated(
"Setting a message on GlobusAPIError objects is deprecated. "
"This overwrites any parsed messages. Append to 'messages' instead."
)
self.messages = [value]

@property
def http_reason(self) -> str:
"""
Expand Down
18 changes: 0 additions & 18 deletions tests/unit/errors/test_common_functionality.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,24 +65,6 @@ def test_raw_text_property_warns():
assert err.raw_text == body_text


def test_imperative_message_setting_warns():
err = construct_error(
body={"code": "FooCode", "message": "FooMessage"}, http_status=400
)
assert err.message == "FooMessage"

with pytest.warns(
RemovedInV4Warning,
match=(
r"Setting a message on GlobusAPIError objects is deprecated\. "
r"This overwrites any parsed messages\. Append to 'messages' instead\."
),
):
err.message = "BarMessage"

assert err.message == "BarMessage"


@pytest.mark.parametrize(
"body, response_headers, http_status, expect_code, expect_message",
(
Expand Down