objectstore-client 0.2.0__tar.gz → 0.2.1__tar.gz

{objectstore_client-0.2.0 → objectstore_client-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: objectstore-client
-Version: 0.2.0
+Version: 0.2.1
 Summary: Client SDK for Objectstore, the Sentry object storage platform
 Author: Sentry
 Author-email: Sentry <oss@sentry.io>

{objectstore_client-0.2.0 → objectstore_client-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "objectstore-client"
-version = "0.2.0"
+version = "0.2.1"
 description = "Client SDK for Objectstore, the Sentry object storage platform"
 readme = "README.md"
 authors = [{ name = "Sentry", email = "oss@sentry.io" }]

{objectstore_client-0.2.0 → objectstore_client-0.2.1}/src/objectstore_client/client.py

@@ -354,14 +354,14 @@ class Session:
             headers[HEADER_EXPIRATION] = format_expiration(expiration_policy)
 
         if origin:
-            headers[HEADER_ORIGIN] = origin
+            headers[HEADER_ORIGIN] = utils.encode_header_value(origin)
 
         if filename is not None:
-            headers[HEADER_FILENAME] = filename
+            headers[HEADER_FILENAME] = utils.encode_header_value(filename)
 
         if metadata:
             for k, v in metadata.items():
-                headers[f"{HEADER_META_PREFIX}{k}"] = v
+                headers[f"{HEADER_META_PREFIX}{k}"] = utils.encode_header_value(v)
 
         if key == "":
             key = None
@@ -619,14 +619,14 @@ class Session:
             headers[HEADER_EXPIRATION] = format_expiration(expiration_policy)
 
         if origin:
-            headers[HEADER_ORIGIN] = origin
+            headers[HEADER_ORIGIN] = utils.encode_header_value(origin)
 
         if filename is not None:
-            headers[HEADER_FILENAME] = filename
+            headers[HEADER_FILENAME] = utils.encode_header_value(filename)
 
         if metadata:
             for k, v in metadata.items():
-                headers[f"{HEADER_META_PREFIX}{k}"] = v
+                headers[f"{HEADER_META_PREFIX}{k}"] = utils.encode_header_value(v)
 
         if key == "":
             key = None

{objectstore_client-0.2.0 → objectstore_client-0.2.1}/src/objectstore_client/metadata.py

@@ -7,6 +7,8 @@ from dataclasses import dataclass
 from datetime import datetime, timedelta
 from typing import Literal, TypeVar, cast
 
+from objectstore_client.utils import decode_header_value
+
 Compression = Literal["zstd"] | Literal["none"]
 
 HEADER_EXPIRATION = "x-sn-expiration"
@@ -14,6 +16,7 @@ HEADER_TIME_CREATED = "x-sn-time-created"
 HEADER_TIME_EXPIRES = "x-sn-time-expires"
 HEADER_ORIGIN = "x-sn-origin"
 HEADER_FILENAME = "x-sn-filename"
+HEADER_SIZE = "x-sn-size"
 HEADER_META_PREFIX = "x-snme-"
 
 
@@ -70,6 +73,17 @@ class Metadata:
     prompting browsers and download tools to save the file under this name.
     """
 
+    size: int | None
+    """
+    The size of the complete stored object in bytes.
+
+    This is always the size of the whole object, even when only a range of it was
+    requested. For a compressed object it is the compressed size, matching the bytes on
+    the wire.
+
+    This field is computed by the server, it cannot be set by clients.
+    """
+
     custom: dict[str, str]
 
     @classmethod
@@ -81,6 +95,7 @@ class Metadata:
         time_expires = None
         origin = None
         filename = None
+        size = None
         custom_metadata = {}
 
         for k, v in headers.items():
@@ -95,11 +110,13 @@ class Metadata:
             elif k == HEADER_TIME_EXPIRES:
                 time_expires = datetime.fromisoformat(v)
             elif k == HEADER_ORIGIN:
-                origin = v
+                origin = decode_header_value(v)
             elif k == HEADER_FILENAME:
-                filename = v
+                filename = decode_header_value(v)
+            elif k == HEADER_SIZE:
+                size = int(v)
             elif k.startswith(HEADER_META_PREFIX):
-                custom_metadata[k[len(HEADER_META_PREFIX) :]] = v
+                custom_metadata[k[len(HEADER_META_PREFIX) :]] = decode_header_value(v)
 
         return Metadata(
             content_type=content_type,
@@ -109,6 +126,7 @@ class Metadata:
             time_expires=time_expires,
             origin=origin,
             filename=filename,
+            size=size,
             custom=custom_metadata,
         )
 

{objectstore_client-0.2.0 → objectstore_client-0.2.1}/src/objectstore_client/utils.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import io
 from typing import IO, Any
-from urllib.parse import quote
+from urllib.parse import quote, unquote
 
 import filetype  # type: ignore[import-untyped]
 from zstandard import ZstdCompressionReader
@@ -22,6 +22,16 @@ from zstandard import ZstdCompressionReader
 _PATH_SAFE = "/:@!$&'()*+,;="
 _QUERY_SAFE = _PATH_SAFE + "?"
 
+# Characters left unescaped in a metadata header value: every visible ASCII
+# character except "%". Non-ASCII, the C0 controls, and DEL are escaped because a
+# header value cannot carry them; "%" is escaped so that a literal percent sign in
+# a value can never be confused with an escape sequence when decoding.
+#
+# This is byte-for-byte identical to the Rust `HEADER_ESCAPE` set (see
+# `objectstore-types/src/headers.rs`), so both clients and the server agree on the
+# wire form. Values that are already plain ASCII are left untouched.
+_HEADER_VALUE_SAFE = "".join(chr(b) for b in range(0x20, 0x7F) if b != ord("%"))
+
 
 def encode_path(path: str) -> str:
     """Percent-encodes a request path as it will appear on the wire.
@@ -42,6 +52,27 @@ def encode_query(query: str) -> str:
     return quote(query, safe=_QUERY_SAFE)
 
 
+def encode_header_value(value: str) -> str:
+    """Percent-encodes a free-form metadata string for an HTTP header value.
+
+    HTTP header values carry only visible ASCII, so anything outside that range has
+    to be escaped to survive the transport (see :data:`_HEADER_VALUE_SAFE`). This is
+    the inverse of :func:`decode_header_value`; only the transport representation is
+    escaped, never the logical string held in :class:`Metadata`.
+    """
+    return quote(value, safe=_HEADER_VALUE_SAFE)
+
+
+def decode_header_value(value: str) -> str:
+    """Decodes a percent-encoded HTTP header value into its logical string.
+
+    Inverse of :func:`encode_header_value`. Values without escape sequences are
+    returned unchanged, so headers written before the encoding existed still read
+    back as-is.
+    """
+    return unquote(value, errors="strict")
+
+
 def parse_accept_encoding(header: str) -> list[str]:
     """Parse an Accept-Encoding header value for use in objectstore GET requests.