fix: raise DeepLException for malformed style profile responses

StyleProfile.from_json raised a raw KeyError for a missing style_profile_id
or name and a raw TypeError for a non-object body, and returned None for a
missing or malformed creation_time or updated_time. All of these now raise
DeepLException; creation_time and updated_time are typed as datetime.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: hive-bot

CHANGELOG.md

@@ -70,7 +70,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `create_style_profile()` and `update_style_profile()` accept IDs or
   `GlossaryInfo`, `MultilingualGlossaryInfo`, `StyleRuleInfo` and
   `TranslationMemoryInfo` objects, and both functions accept
-  `extra_body_parameters`.
+  `extra_body_parameters`. A style profile response that is not a JSON object,
+  or lacks a valid `style_profile_id`, `name`, `creation_time` or
+  `updated_time`, raises `DeepLException`.
 - Added the `TagHandlingMode` (`HTML`, `XML`) and `TagHandlingVersion` (`V1`,
   `V2`) enums. The `tag_handling` and `tag_handling_version` options of
   `translate_text()` accept them as well as strings.

deepl/api_data.py

@@ -1466,10 +1466,8 @@ class StyleProfile:
     :param translation_memory_ids: IDs of the linked translation memories.
     :param glossary_priority_order_enabled: Whether the order of glossary_ids
         decides which glossary wins when glossaries overlap.
-    :param creation_time: Timestamp when the style profile was created, or
-        None if the response has none or it cannot be parsed.
-    :param updated_time: Timestamp of the last update, or None if the
-        response has none or it cannot be parsed.
+    :param creation_time: Timestamp when the style profile was created.
+    :param updated_time: Timestamp of the last update.
     """
 
     def __init__(
@@ -1482,8 +1480,8 @@ def __init__(
         style_rule_ids: List[str],
         translation_memory_ids: List[str],
         glossary_priority_order_enabled: bool,
-        creation_time: Optional[datetime.datetime],
-        updated_time: Optional[datetime.datetime],
+        creation_time: datetime.datetime,
+        updated_time: datetime.datetime,
     ):
         self._style_profile_id = style_profile_id
         self._name = name
@@ -1501,7 +1499,31 @@ def __str__(self) -> str:
 
     @staticmethod
     def from_json(json) -> "StyleProfile":
-        """Create StyleProfile from the given API JSON object."""
+        """Create StyleProfile from the given API JSON object.
+
+        :raises DeepLException: If the response is not a JSON object, or a
+            required field is missing or malformed.
+        """
+        # Imported here: deepl.exceptions imports this module.
+        from deepl.exceptions import DeepLException
+
+        if not isinstance(json, dict):
+            raise DeepLException("Style profile response is not a JSON object")
+        for field in ("style_profile_id", "name"):
+            if not isinstance(json.get(field), str):
+                raise DeepLException(
+                    f"Style profile response is missing {field}"
+                )
+
+        def required_timestamp(field: str) -> datetime.datetime:
+            timestamp = parse_optional_timestamp(json.get(field))
+            if timestamp is None:
+                raise DeepLException(
+                    f"Style profile response has a missing or malformed "
+                    f"{field}"
+                )
+            return timestamp
+
         return StyleProfile(
             json["style_profile_id"],
             json["name"],
@@ -1511,8 +1533,8 @@ def from_json(json) -> "StyleProfile":
             _string_list(json.get("style_rule_ids")),
             _string_list(json.get("translation_memory_ids")),
             json.get("glossary_priority_order_enabled") is True,
-            parse_optional_timestamp(json.get("creation_time")),
-            parse_optional_timestamp(json.get("updated_time")),
+            required_timestamp("creation_time"),
+            required_timestamp("updated_time"),
         )
 
     @property
@@ -1548,11 +1570,11 @@ def glossary_priority_order_enabled(self) -> bool:
         return self._glossary_priority_order_enabled
 
     @property
-    def creation_time(self) -> Optional[datetime.datetime]:
+    def creation_time(self) -> datetime.datetime:
         return self._creation_time
 
     @property
-    def updated_time(self) -> Optional[datetime.datetime]:
+    def updated_time(self) -> datetime.datetime:
         return self._updated_time
 
 

deepl/deepl_client.py

@@ -1302,16 +1302,17 @@ def list_style_profiles(
         status, content, json = self._api_call(endpoint, method="GET")
         self._raise_for_status(status, content, json)
 
-        style_profiles = (
-            json.get("style_profiles") or []
-            if (json and isinstance(json, dict))
-            else []
-        )
-        return [
-            StyleProfile.from_json(style_profile)
-            for style_profile in style_profiles
-            if isinstance(style_profile, dict)
-        ]
+        if not isinstance(json, dict):
+            raise DeepLException(
+                "Style profile list response is not a JSON object"
+            )
+        style_profiles = json.get("style_profiles") or []
+        if not isinstance(style_profiles, list):
+            raise DeepLException(
+                "Style profile list response has a malformed style_profiles"
+            )
+        # from_json raises DeepLException for a malformed entry.
+        return [StyleProfile.from_json(p) for p in style_profiles]
 
     def create_style_profile(
         self,

tests/offline/test_style_profiles.py

@@ -216,11 +216,9 @@ def test_parses_a_profile_without_optional_fields():
     assert not hasattr(profile, "spoken_terms_ids")
 
 
-@pytest.mark.parametrize("creation_time", ["not a timestamp", 123])
-def test_tolerates_malformed_values(mocked, creation_time):
+def test_tolerates_malformed_optional_values(mocked):
     malformed = dict(
         STYLE_PROFILE_JSON,
-        creation_time=creation_time,
         glossary_ids=["g1", 7, None, "g2"],
         translation_memory_ids=None,
     )
@@ -229,12 +227,10 @@ def test_tolerates_malformed_values(mocked, creation_time):
 
     profile = make_deepl_client().get_style_profile(PROFILE_ID)
 
-    assert profile.creation_time is None
     assert profile.glossary_ids == ["g1", "g2"]
     assert profile.translation_memory_ids == []
     assert profile.glossary_priority_order_enabled is False
     assert profile.name == "Legal, German"
-    assert profile.updated_time == utc(2026, 8, 6, 9, 12, 44, 108000)
 
 
 def test_maps_404_to_not_found(mocked):
@@ -322,3 +318,64 @@ def test_update_merges_extra_body_parameters_last(mocked):
         glossary_ids=[GLOSSARY],
         extra_body_parameters={"glossary_ids": ["x"], "extra": True},
     )
+
+
+def _without(field):
+    return {k: v for k, v in STYLE_PROFILE_JSON.items() if k != field}
+
+
+@pytest.mark.parametrize(
+    "body",
+    [
+        _without("style_profile_id"),
+        _without("name"),
+        _without("creation_time"),
+        _without("updated_time"),
+        dict(STYLE_PROFILE_JSON, creation_time="not a timestamp"),
+        dict(STYLE_PROFILE_JSON, updated_time=123),
+        dict(STYLE_PROFILE_JSON, name=None),
+    ],
+)
+def test_raises_for_a_missing_or_malformed_required_field(mocked, body):
+    mocked.get(url(f"v3/style_profiles/{PROFILE_ID}"), json=body)
+
+    with pytest.raises(deepl.DeepLException):
+        make_deepl_client().get_style_profile(PROFILE_ID)
+
+
+@pytest.mark.parametrize(
+    "entry", [_without("style_profile_id"), "not an object", None]
+)
+def test_list_raises_for_a_malformed_entry(mocked, entry):
+    mocked.get(
+        url("v3/style_profiles"),
+        json={"style_profiles": [STYLE_PROFILE_JSON, entry]},
+    )
+
+    with pytest.raises(deepl.DeepLException):
+        make_deepl_client().list_style_profiles()
+
+
+@pytest.mark.parametrize(
+    "method, path, call",
+    [
+        ("GET", "v3/style_profiles", lambda c: c.list_style_profiles()),
+        ("POST", "v3/style_profiles", lambda c: c.create_style_profile("n")),
+        (
+            "GET",
+            f"v3/style_profiles/{PROFILE_ID}",
+            lambda c: c.get_style_profile(PROFILE_ID),
+        ),
+        (
+            "PATCH",
+            f"v3/style_profiles/{PROFILE_ID}",
+            lambda c: c.update_style_profile(PROFILE_ID, name="n"),
+        ),
+    ],
+)
+@pytest.mark.parametrize("body", ["not json", "[]", "null"])
+def test_raises_for_a_non_object_body(mocked, method, path, call, body):
+    mocked.add(method, url(path), body=body)
+
+    with pytest.raises(deepl.DeepLException):
+        call(make_deepl_client())

tests/offline/test_translate_document.py

@@ -207,7 +207,12 @@ def test_sends_all_options_as_form_fields(mocked):
     [
         "sp-1",
         deepl.StyleProfile.from_json(
-            {"style_profile_id": "sp-1", "name": "profile"}
+            {
+                "style_profile_id": "sp-1",
+                "name": "profile",
+                "creation_time": "2026-10-26T16:27:10Z",
+                "updated_time": "2026-10-26T16:27:10Z",
+            }
         ),
     ],
 )

tests/offline/test_translate_text.py

@@ -76,7 +76,12 @@ def style_rule_info(language="en"):
 
 def style_profile():
     return deepl.StyleProfile.from_json(
-        {"style_profile_id": "sp-1", "name": "profile"}
+        {
+            "style_profile_id": "sp-1",
+            "name": "profile",
+            "creation_time": "2026-10-26T16:27:10Z",
+            "updated_time": "2026-10-26T16:27:10Z",
+        }
     )