Skip to content

feat(py-client)!: Remove deprecated compression argument from Session.put #718

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
jan-auer merged 1 commit into from
Oct 22, 2026
Merged

feat(py-client)!: Remove deprecated compression argument from Session.put #718

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
13 changes: 0 additions & 13 deletions clients/python/src/objectstore_client/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,6 @@ def put(
contents: bytes | IO[bytes],
key: str | None = None,
compress: Compression | None = None,
compression: Compression | Literal["none"] | None = None,
precompressed: Compression | None = None,
content_type: str | None = None,
metadata: dict[str, str] | None = None,
Expand All @@ -431,8 +430,6 @@ def put(
You can use the utility function `objectstore_client.utils.guess_mime_type`
to attempt to guess a `content_type` based on magic bytes.

`compression` is deprecated in favor of `compress`.

.. rubric:: Resumable Uploads

This method uses Objectstore's Resumable Uploads API when the size of
Expand All @@ -455,16 +452,6 @@ def put(
Set ``Client(spool_dir=<path>)`` if you wish to customize the directory where
the temporary files are created in.
"""
if compression is not None:
warnings.warn(
"`compression` is deprecated, use `compress` instead",
DeprecationWarning,
stacklevel=2,
)
if compress is not None:
raise ValueError("Cannot pass both `compress` and `compression`")
compress = compression

if compress is not None and precompressed is not None:
raise ValueError("Cannot pass both `compress` and `precompressed`")
if compress and compress not in ("none", "zstd"):
Expand Down
16 changes: 0 additions & 16 deletions clients/python/tests/test_e2e.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,22 +491,6 @@ def test_precompressed_rejects_conflicting_arguments(server_url: str) -> None:
session.put(b"test data", precompressed="brotli") # type: ignore[arg-type]


def test_compression_argument_is_deprecated(server_url: str) -> None:
client = Client(server_url, token=TestSecretKey.get())
session = client.session(Usecase("test-usecase"), org=42, project=1337)

with pytest.deprecated_call():
object_key = session.put(b"test data", compression="none")

retrieved = session.get(object_key)
assert retrieved is not None
assert retrieved.metadata.compression is None
assert retrieved.payload.read() == b"test data"

with pytest.warns(DeprecationWarning), pytest.raises(ValueError):
session.put(b"test data", compress="none", compression="none")


def test_full_cycle_structured_key(server_url: str) -> None:
client = Client(
server_url,
Expand Down
Loading