pyxecm 3.9.0__tar.gz → 3.9.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyxecm
-Version: 3.9.0
+Version: 3.9.2
 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.0 → pyxecm-3.9.2}/pyproject.toml

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

pyxecm-3.9.2/src/pyxecm/__init__.py

@@ -0,0 +1,65 @@
+"""pyxecm - A python library to interact with OpenText REST APIs."""
+
+__author__ = "Dr. Marc Diefenbruch"
+__copyright__ = "Copyright (C) 2024-2025, OpenText"
+__credits__ = ["Kai-Philip Gatzweiler"]
+__maintainer__ = "Dr. Marc Diefenbruch"
+__email__ = "mdiefenb@opentext.com"
+
+from .avts import AVTS
+from .coreshare import CoreShare
+from .errors import (
+    AVTSError,
+    CoreShareError,
+    ErrorCategory,
+    ErrorCollector,
+    ErrorSeverity,
+    OTACError,
+    OTAWPError,
+    OTCAError,
+    OTCSError,
+    OTDSError,
+    OTKDError,
+    OTMMError,
+    OTPDError,
+    PyxecmError,
+    capture_errors,
+)
+from .otac import OTAC
+from .otawp import OTAWP
+from .otca import OTCA
+from .otcs import OTCS
+from .otds import OTDS
+from .otiv import OTIV
+from .otkd import OTKD
+from .otmm import OTMM
+from .otpd import OTPD
+
+__all__ = [
+    "AVTS",
+    "OTAC",
+    "OTAWP",
+    "OTCA",
+    "OTCS",
+    "OTDS",
+    "OTIV",
+    "OTKD",
+    "OTMM",
+    "OTPD",
+    "AVTSError",
+    "CoreShare",
+    "CoreShareError",
+    "ErrorCategory",
+    "ErrorCollector",
+    "ErrorSeverity",
+    "OTACError",
+    "OTAWPError",
+    "OTCAError",
+    "OTCSError",
+    "OTDSError",
+    "OTKDError",
+    "OTMMError",
+    "OTPDError",
+    "PyxecmError",
+    "capture_errors",
+]

{pyxecm-3.9.0 → pyxecm-3.9.2}/src/pyxecm/avts.py

@@ -17,6 +17,14 @@ from importlib.metadata import version
 
 import requests
 
+from pyxecm.errors import (
+    AVTSError,
+    ErrorCategory,
+    ReportingLoggerAttribute,
+    record_request_error,
+    request_error_severity,
+)
+
 APP_NAME = "pyxecm"
 APP_VERSION = version("pyxecm")
 MODULE_NAME = APP_NAME + ".avts"
@@ -45,7 +53,7 @@ class AVTS:
 
     # Only class variables or class-wide constants should be defined here:
 
-    logger: logging.Logger = default_logger
+    logger = ReportingLoggerAttribute(default_logger, error_class=AVTSError)
 
     def __init__(
         self,
@@ -257,6 +265,14 @@ class AVTS:
                             response.text,
                         )
 
+                    record_request_error(
+                        error_class=AVTSError,
+                        message=failure_message,
+                        method=method,
+                        url=url,
+                        response=response,
+                        severity=request_error_severity(show_error=show_error),
+                    )
                     return None
             except requests.exceptions.Timeout:
                 if retries <= max_retries:
@@ -271,6 +287,13 @@ class AVTS:
                         "%s; timeout error.",
                         failure_message,
                     )
+                    record_request_error(
+                        error_class=AVTSError,
+                        message="{}; the request timed out".format(failure_message or "Request failed"),
+                        method=method,
+                        url=url,
+                        category=ErrorCategory.TIMEOUT,
+                    )
                     if retry_forever:
                         # If it fails after REQUEST_MAX_RETRIES retries we let it wait forever
                         self.logger.warning("Turn timeouts off and wait forever...")
@@ -290,6 +313,13 @@ class AVTS:
                         "%s; connection error.",
                         failure_message,
                     )
+                    record_request_error(
+                        error_class=AVTSError,
+                        message="{}; connection error".format(failure_message or "Request failed"),
+                        method=method,
+                        url=url,
+                        category=ErrorCategory.CONNECTION,
+                    )
                     if retry_forever:
                         # If it fails after REQUEST_MAX_RETRIES retries we let it wait forever
                         self.logger.warning("Turn timeouts off and wait forever...")
@@ -922,7 +952,7 @@ class AVTS:
         )
 
         if response is None:
-            self.logger.error("Failed to create repository -> '%s'", name)
+            self.logger.error("Failed to create repository -> '%s'", name, report=True)
             return None
 
         self.repo_admin_consent(response["id"])
@@ -1304,7 +1334,7 @@ class AVTS:
         )
 
         if response is None:
-            self.logger.error("Failed to create repository -> '%s'!", name)
+            self.logger.error("Failed to create repository -> '%s'!", name, report=True)
             return None
 
         self.repo_admin_consent(response["id"])

{pyxecm-3.9.0 → pyxecm-3.9.2}/src/pyxecm/coreshare.py

@@ -31,6 +31,14 @@ from urllib.parse import parse_qs, urlparse
 
 import requests
 
+from pyxecm.errors import (
+    CoreShareError,
+    ErrorCategory,
+    ReportingLoggerAttribute,
+    record_request_error,
+    request_error_severity,
+)
+
 APP_NAME = "pyxecm"
 APP_VERSION = version("pyxecm")
 MODULE_NAME = APP_NAME + ".coreshare"
@@ -66,7 +74,7 @@ class CoreShare:
 
     # Only class variables or class-wide constants should be defined here:
 
-    logger: logging.Logger = default_logger
+    logger = ReportingLoggerAttribute(default_logger, error_class=CoreShareError)
 
     def __init__(
         self,
@@ -369,6 +377,8 @@ class CoreShare:
         if headers is None:
             self.logger.error(
                 "Missing request header. Cannot send request to Core Share!",
+                report=True,
+                category=ErrorCategory.AUTHENTICATION,
             )
             return None
 
@@ -452,6 +462,14 @@ class CoreShare:
                             HTTPStatus(response.status_code).phrase,
                             response.text,
                         )
+                    record_request_error(
+                        error_class=CoreShareError,
+                        message=failure_message if show_error else (warning_message or failure_message),
+                        method=method,
+                        url=url,
+                        response=response,
+                        severity=request_error_severity(show_error=show_error, show_warning=show_warning),
+                    )
                     return None
             except requests.exceptions.Timeout:
                 if retries <= max_retries:
@@ -466,6 +484,13 @@ class CoreShare:
                         "%s; timeout error!",
                         failure_message,
                     )
+                    record_request_error(
+                        error_class=CoreShareError,
+                        message="{}; the request timed out".format(failure_message or "Request failed"),
+                        method=method,
+                        url=url,
+                        category=ErrorCategory.TIMEOUT,
+                    )
                     if retry_forever:
                         # If it fails after REQUEST_MAX_RETRIES retries we let it wait forever
                         self.logger.warning("Turn timeouts off and wait forever...")
@@ -485,6 +510,13 @@ class CoreShare:
                         "%s; connection error!",
                         failure_message,
                     )
+                    record_request_error(
+                        error_class=CoreShareError,
+                        message="{}; connection error".format(failure_message or "Request failed"),
+                        method=method,
+                        url=url,
+                        category=ErrorCategory.CONNECTION,
+                    )
                     if retry_forever:
                         # If it fails after REQUEST_MAX_RETRIES retries we let it wait forever
                         self.logger.warning("Turn timeouts off and wait forever...")
@@ -750,6 +782,7 @@ class CoreShare:
                 "Unable to connect to -> %s : %s",
                 request_url,
                 exception,
+                report=True,
             )
             return None
 
@@ -779,6 +812,7 @@ class CoreShare:
             self.logger.error(
                 "Failed to request a Core Share Tenant Admin Access Token; error -> %s",
                 response.text,
+                report=True,
             )
             return None
 
@@ -848,6 +882,7 @@ class CoreShare:
                 "Unable to connect to -> %s : %s",
                 request_url,
                 exception,
+                report=True,
             )
             return None
 
@@ -866,6 +901,7 @@ class CoreShare:
             self.logger.error(
                 "Failed to request a Core Share Tenant Service User Access Token; error -> %s",
                 response.text,
+                report=True,
             )
             return None
 
@@ -2205,7 +2241,9 @@ class CoreShare:
 
         # Check if the photo file exists
         if not os.path.isfile(photo_path):
-            self.logger.error("Photo file -> '%s' not found for Core Share user with ID -> %s!", photo_path, user_id)
+            self.logger.error(
+                "Photo file -> '%s' not found for Core Share user with ID -> %s!", photo_path, user_id, report=True
+            )
             return None
 
         try:
@@ -2215,7 +2253,10 @@ class CoreShare:
         except OSError:
             # Handle any errors that occurred while reading the photo file
             self.logger.error(
-                "Error reading photo file -> '%s' for Core Share user with ID -> '%s'!", photo_path, user_id
+                "Error reading photo file -> '%s' for Core Share user with ID -> '%s'!",
+                photo_path,
+                user_id,
+                report=True,
             )
             return None