glpi-python-client 0.4.3__py3-none-any.whl → 0.5.0__py3-none-any.whl

glpi_python_client/__init__.py

@@ -20,6 +20,7 @@ from __future__ import annotations
 from glpi_python_client._async.clients import AsyncGlpiClient
 from glpi_python_client._errors import (
     GlpiAuthError,
+    GlpiContentError,
     GlpiError,
     GlpiNotFoundError,
     GlpiProtocolError,
@@ -109,7 +110,7 @@ from glpi_python_client.rsql import (
     date_window,
 )
 
-__version__ = "0.4.3"
+__version__ = "0.5.0"
 
 __all__ = [
     "AsyncGlpiClient",
@@ -145,6 +146,7 @@ __all__ = [
     "GetUser",
     "GlpiAuthError",
     "GlpiClient",
+    "GlpiContentError",
     "GlpiEnum",
     "GlpiError",
     "GlpiGlobalValidation",

glpi_python_client/_async/clients/commons/_payloads.py

@@ -14,6 +14,7 @@ from glpi_python_client.models._base import (
     SERVER_TIMEZONE_CONTEXT_KEY,
     GlpiModel,
 )
+from glpi_python_client.models.api_schema._content import restoring_content_faults
 
 ModelT = TypeVar("ModelT", bound=GlpiModel)
 
@@ -54,12 +55,13 @@ def model_to_payload(
         if server_timezone is not None
         else None
     )
-    body = model.model_dump(
-        mode="json",
-        exclude_none=True,
-        exclude={"extra_payload"},
-        context=context,
-    )
+    with restoring_content_faults():
+        body = model.model_dump(
+            mode="json",
+            exclude_none=True,
+            exclude={"extra_payload"},
+            context=context,
+        )
     if model.extra_payload:
         body.update(model.extra_payload)
     return body

glpi_python_client/_errors.py

@@ -1,10 +1,10 @@
 """Public exception hierarchy raised by :mod:`glpi_python_client`.
 
 Every exception the client raises for a bad argument, an unexpected HTTP
-status, an unusable response body, or a network-level fault deliberately
-derives from :class:`GlpiError`, so callers can catch the library's failure
-surface with a single ``except`` clause and never need to import the
-underlying HTTP library.
+status, an unusable response body, a network-level fault, or content it
+cannot convert deliberately derives from :class:`GlpiError`, so callers can
+catch the library's failure surface with a single ``except`` clause and
+never need to import the underlying HTTP library.
 
 Two deliberate exceptions to that rule remain:
 
@@ -17,6 +17,8 @@ Two deliberate exceptions to that rule remain:
 :class:`GlpiStatusError`, :class:`GlpiValidationError` and
 :class:`GlpiProtocolError` also inherit :class:`ValueError` so code written
 against earlier releases — which raised bare ``ValueError`` — keeps working.
+:class:`GlpiContentError` and :class:`GlpiTransportError` do not, for the
+reason given on each: nothing was passed in wrongly.
 """
 
 from __future__ import annotations
@@ -137,6 +139,35 @@ class GlpiProtocolError(GlpiError, ValueError):
     """
 
 
+class GlpiContentError(GlpiError):
+    """A rich-text content value could not be converted.
+
+    Raised when :class:`~glpi_python_client.content.GlpiContentConverter`
+    cannot translate a value between GLPI's HTML transport format and the
+    package's canonical Markdown — in either direction. The underlying
+    fault is always attached as ``__cause__``.
+
+    This exists so that no failure of the content layer escapes the
+    package's taxonomy. The conversion runs third-party parsers
+    (``markdownify`` inbound, ``markdown`` outbound), and a parser fault
+    used to reach the caller as a bare builtin — most visibly a
+    ``RecursionError``, which ``except GlpiError`` does not catch and which
+    a caller reading a ticket has no reason to expect from
+    ``get_ticket``. Deeply nested HTML is caught and answered with the
+    body's text instead of raising at all (see
+    :meth:`glpi_python_client.content.conversion.GlpiContentConverter.from_transport`);
+    this is the backstop for everything else.
+
+    Unlike :class:`GlpiStatusError`, :class:`GlpiValidationError` and
+    :class:`GlpiProtocolError` this does **not** inherit ``ValueError``.
+    Those three do so for back-compatibility with releases that raised
+    bare ``ValueError`` at the same sites; there was never a
+    ``ValueError`` here to be compatible with, and a parser exhausting the
+    interpreter's stack is not a value the caller got wrong. The reasoning
+    matches :class:`GlpiTransportError`.
+    """
+
+
 def status_error_class(status_code: int) -> type[GlpiStatusError]:
     """Return the most specific status-error class for one status code.
 
@@ -164,6 +195,7 @@ def status_error_class(status_code: int) -> type[GlpiStatusError]:
 
 __all__ = [
     "GlpiAuthError",
+    "GlpiContentError",
     "GlpiError",
     "GlpiNotFoundError",
     "GlpiProtocolError",

glpi_python_client/_sync/clients/commons/_payloads.py

@@ -14,6 +14,7 @@ from glpi_python_client.models._base import (
     SERVER_TIMEZONE_CONTEXT_KEY,
     GlpiModel,
 )
+from glpi_python_client.models.api_schema._content import restoring_content_faults
 
 ModelT = TypeVar("ModelT", bound=GlpiModel)
 
@@ -54,12 +55,13 @@ def model_to_payload(
         if server_timezone is not None
         else None
     )
-    body = model.model_dump(
-        mode="json",
-        exclude_none=True,
-        exclude={"extra_payload"},
-        context=context,
-    )
+    with restoring_content_faults():
+        body = model.model_dump(
+            mode="json",
+            exclude_none=True,
+            exclude={"extra_payload"},
+            context=context,
+        )
     if model.extra_payload:
         body.update(model.extra_payload)
     return body