pyxecm 3.4.4__tar.gz → 3.4.6__tar.gz

{pyxecm-3.4.4 → pyxecm-3.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyxecm
-Version: 3.4.4
+Version: 3.4.6
 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.4.4 → pyxecm-3.4.6}/pyproject.toml

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

{pyxecm-3.4.4 → pyxecm-3.4.6}/src/pyxecm/otcs.py

@@ -8528,6 +8528,9 @@ class OTCS:
                     str(volume_type),
                 )
 
+        if not mime_type:
+            mime_type = "application/octet-stream"  # Default to binary stream if mime type cannot be determined
+
         upload_post_files = [("file", (f"{file_name}", file_content, mime_type))]
 
         request_url = self.config()["nodesUrlv2"]
@@ -8819,6 +8822,9 @@ class OTCS:
                     parent_id,
                 )
 
+        if not mime_type:
+            mime_type = "application/octet-stream"  # Default to binary stream if mime type cannot be determined
+
         upload_post_files = [("file", (f"{file_name}", file_content, mime_type))]
 
         request_url = self.config()["nodesUrlv2"]
@@ -9187,6 +9193,9 @@ class OTCS:
                     node_id,
                 )
 
+        if not mime_type:
+            mime_type = "application/octet-stream"  # Default to binary stream if mime type cannot be determined
+
         upload_post_files = [("file", (f"{file_name}", file_content, mime_type))]
 
         request_url = self.config()["nodesUrlv2"] + "/" + str(node_id) + "/versions"
@@ -13538,16 +13547,22 @@ class OTCS:
     # end method definition
 
     @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="get_workspace_type_name")
-    def get_workspace_type_name(self, type_id: int) -> str | None:
+    def get_workspace_type_name(self, type_id: int, renew: bool = False) -> str | None:
         """Get the name of a workspace type based on the provided workspace type ID.
 
         The name is taken from a OTCS object variable self._workspace_type_lookup if recorded there.
-        If not yet derived it is determined via the REST API and then stored
-        in self._workspace_type_lookup (as a lookup cache).
+        If not yet derived - or if renew is requested - it is determined via the REST API and
+        then stored in self._workspace_type_lookup (as a lookup cache).
 
         Args:
             type_id (int):
                 The workspace type ID.
+            renew (bool, optional):
+                Whether to bypass the cache and force a fresh lookup via the REST API,
+                updating the cache entry. Useful for callers that cannot tolerate a
+                workspace type having been renamed/reconfigured since it was last cached
+                (self._workspace_type_lookup has no expiry and is shared across calls
+                for the lifetime of this OTCS instance).
 
         Returns:
             str | None:
@@ -13561,7 +13576,7 @@ class OTCS:
         """
 
         workspace_type = self._workspace_type_lookup.get(type_id)
-        if workspace_type:
+        if workspace_type and not renew:
             return workspace_type.get("name")
 
         workspace_type = self.get_workspace_type(type_id=type_id)
@@ -14654,6 +14669,71 @@ class OTCS:
 
     # end method definition
 
+    @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="get_workspace_by_child_node")
+    def get_workspace_by_child_node(
+        self,
+        node_id: int,
+        timeout: float = REQUEST_TIMEOUT,
+        show_error: bool = False,
+    ) -> dict | None:
+        """Get the business workspace a given node is located in.
+
+        The node can be a direct or indirect child of the workspace.
+        If the given node is a business workspace itself, then this
+        workspace is returned.
+
+        The REST API endpoint of this method is /v1/nodes/{id}/businessworkspace
+
+        Args:
+            node_id (int):
+                The ID of the node to determine the enclosing workspace for.
+            timeout (float, optional):
+                Specific timeout for the request in seconds. The default is the standard
+                timeout value REQUEST_TIMEOUT used by the OTCS module.
+            show_error (bool, optional):
+                Treat it as an error if no enclosing workspace is found.
+                Default is False (just a warning is logged).
+
+        Returns:
+            dict | None:
+                Workspace information or None if the node is not inside a workspace.
+
+        Example:
+        {
+            'id': 346184,
+            'isLinked': False,
+            'type': 848,
+            'workspace_type_id': 5
+        }
+
+        """
+
+        request_url = self.config()["nodesUrl"] + "/" + str(node_id) + "/businessworkspace"
+
+        request_header = self.request_form_header()
+
+        self.logger.debug(
+            "Get business workspace for node with ID -> %d; calling -> %s",
+            node_id,
+            request_url,
+        )
+
+        return self.do_request(
+            url=request_url,
+            method="GET",
+            headers=request_header,
+            timeout=timeout,
+            warning_message="Cannot get business workspace for node with ID -> {}. The node may not be inside a workspace.".format(
+                node_id,
+            ),
+            failure_message="Failed to get business workspace for node with ID -> {}".format(
+                node_id,
+            ),
+            show_error=show_error,
+        )
+
+    # end method definition
+
     @tracer.start_as_current_span(attributes=OTEL_TRACING_ATTRIBUTES, name="lookup_workspace")
     def lookup_workspaces(
         self,
@@ -23986,6 +24066,12 @@ class OTCS:
         for workspace_type in workspace_types:
             wksp_type_id = self.get_result_value(response=workspace_type, key="wksp_type_id")
             wksp_type_name = self.get_result_value(response=workspace_type, key="wksp_type_name")
+            # Refresh the shared lookup cache with the current name (see the equivalent
+            # refresh in traverse_workspaces_parallel's init_traversal_queue for why this
+            # must overwrite rather than only fill in missing entries): this keeps
+            # get_workspace_type_name() calls made later in this traversal (e.g. from
+            # traverse_workspace()) from resolving a stale, previously-cached name.
+            self._workspace_type_lookup[wksp_type_id] = {"location": None, "name": wksp_type_name}
             if not self._check_filter(
                 workspace_type_name=wksp_type_name,
                 workspace_type_id=wksp_type_id,
@@ -24335,8 +24421,14 @@ class OTCS:
             for workspace_type in workspace_types:
                 wksp_type_id = self.get_result_value(response=workspace_type, key="wksp_type_id")
                 wksp_type_name = self.get_result_value(response=workspace_type, key="wksp_type_name")
-                if wksp_type_id not in self._workspace_type_lookup:
-                    self._workspace_type_lookup[wksp_type_id] = {"location": None, "name": wksp_type_name}
+                # Refresh (not just fill-if-missing): this is a fresh, current listing of
+                # workspace types, fetched on every traversal run. self._workspace_type_lookup
+                # is a long-lived cache on this OTCS instance (spans many traversal runs over the
+                # life of the process), so if we only filled in missing entries, a renamed
+                # workspace type would keep resolving to its stale old name here - and via
+                # get_workspace_type_name() - forever. Overwriting is free since we already have
+                # the current name from this iteration; no extra API call is needed.
+                self._workspace_type_lookup[wksp_type_id] = {"location": None, "name": wksp_type_name}
                 if not self._check_filter(
                     workspace_type_name=wksp_type_name,
                     workspace_type_id=wksp_type_id,