pyxecm 3.9.2__tar.gz → 3.9.3__tar.gz

{pyxecm-3.9.2 → pyxecm-3.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyxecm
-Version: 3.9.2
+Version: 3.9.3
 Summary: A Python library to interact with Opentext Content Management Rest API
 Project-URL: Homepage, https://github.com/opentext/pyxecm
 Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>

{pyxecm-3.9.2 → pyxecm-3.9.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyxecm"
-version = "3.9.2"
+version = "3.9.3"
 description = 'A Python library to interact with Opentext Content Management Rest API'
 keywords = [
   'opentext',

{pyxecm-3.9.2 → pyxecm-3.9.3}/src/pyxecm/errors.py

@@ -30,10 +30,13 @@ __credits__ = ["Kai-Philip Gatzweiler"]
 __maintainer__ = "Dr. Marc Diefenbruch"
 __email__ = "mdiefenb@opentext.com"
 
+import contextlib
 import json
 import logging
+import os
 import threading
 import urllib.parse
+import warnings
 from collections import deque
 from collections.abc import Generator, Iterator
 from contextlib import contextmanager, suppress
@@ -719,6 +722,40 @@ def record_error(
 # end function definition
 
 
+# The warning should point to the code that called pyxecm - not to the pyxecm
+# method that passes the parameter on (e.g. OTCS.create_item() -> OTCS.do_request())
+# or to the wrapper of the @tracer.start_as_current_span decorator (in contextlib).
+# The contextlib entry has no ".py" extension: CPython does not compare the last
+# character of the file name, so a prefix that is the complete file name never matches.
+_PYXECM_PACKAGE_DIRS = (
+    *(
+        os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), package) + os.sep
+        for package in ("pyxecm", "pyxecm_customizer")
+    ),
+    os.path.splitext(contextlib.__file__)[0],
+)
+
+
+def warn_parse_error_response_deprecated() -> None:
+    """Warn that the parse_error_response parameter is deprecated.
+
+    The error details are available via capture_errors() for all pyxecm calls,
+    so the parameter will be removed in a future version.
+    """
+
+    warnings.warn(
+        message=(
+            "The parameter parse_error_response is deprecated and will be removed in a future version. "
+            "Use capture_errors() to get the error details instead, e.g. errors.root_cause.server_message."
+        ),
+        category=DeprecationWarning,
+        skip_file_prefixes=_PYXECM_PACKAGE_DIRS,
+    )
+
+
+# end function definition
+
+
 def request_error_severity(show_error: bool, show_warning: bool = True) -> ErrorSeverity:
     """Return the severity of a failed REST call that matches its log level.