tcex 4.0.11.dev0__tar.gz → 4.0.11.dev2__tar.gz

{tcex-4.0.11.dev0/tcex.egg-info → tcex-4.0.11.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tcex
-Version: 4.0.11.dev0
+Version: 4.0.11.dev2
 Summary: ThreatConnect Exchange App Framework
 Author-email: ThreatConnect <support@threatconnect.com>
 License-Expression: Apache-2.0

{tcex-4.0.11.dev0 → tcex-4.0.11.dev2}/pyproject.toml

@@ -108,7 +108,7 @@ commit = false
 # Additional arguments to pass to the git commit command
 commit_args = "--no-verify"
 # The current version of the project
-current_version = "4.0.11-dev0"
+current_version = "4.0.11-dev2"
 # The commit message template used when committing version bumps
 message = "Version updated from {current_version} to {new_version}"
 # Regular expression for parsing version strings

{tcex-4.0.11.dev0 → tcex-4.0.11.dev2}/tcex/__metadata__.py

@@ -1,4 +1,4 @@
 """TcEx Framework Module"""
 
 __license__ = 'Apache-2.0'
-__version__ = '4.0.11-dev0'
+__version__ = '4.0.11-dev2'

{tcex-4.0.11.dev0 → tcex-4.0.11.dev2}/tcex/api/tc/v2/batch/batch.py

@@ -10,7 +10,6 @@ import threading
 import time
 from collections import deque
 from collections.abc import Callable
-from functools import cached_property
 from typing import Any
 
 # third-party
@@ -922,140 +921,7 @@ class Batch(BatchWriter, BatchSubmit):
 
         return {}
 
-    @cached_property
-    def attribute_config(self) -> dict:
-        """Return a dict of attribute types keyed by 'name', fetched across all pages."""
-        attributes: dict[str, dict] = {}
-
-        # Start with the initial endpoint
-        url = '/v3/attributeTypes'
-        while True:
-            # Fetch page (first call uses relative path; subsequent calls use absolute next_ URL)
-            resp = self.session_tc.get(url, params={'resultLimit': 10_000})
-            payload = resp.json()
-
-            # Collect items from this page
-            for attribute_type in payload.get('data', []):
-                name = attribute_type.get('name')
-                if name is None:
-                    # Skip entries without a name key (defensive)
-                    continue
-                attributes[name] = attribute_type
-
-            # Get the next page URL; stop if none
-            next_ = payload.get('next')
-            if not next_:
-                break
-
-            # next_ is the full URL for the next page
-            url = next_
-
-        return attributes
-
-    def _auto_truncate_attribute(
-        self, attribute_type: str, attribute_value: str, ellipsis: str = '...'
-    ) -> str:
-        """Truncate attribute value if it exceeds the maximum length for its type.
-
-        Args:
-            attribute_type: The name of the attribute type.
-            attribute_value: The attribute value to potentially truncate.
-            ellipsis: The string to append when truncating. Defaults to '...'.
-
-        Returns:
-            The original value if within limits, or the truncated value with ellipsis.
-        """
-        attribute_config = self.attribute_config.get(attribute_type)
-        if not attribute_config:
-            return attribute_value
-
-        max_length = attribute_config.get('maxSize')
-        if not max_length:
-            return attribute_value
-
-        # Only strings can be truncated
-        if not isinstance(attribute_value, str):
-            return attribute_value
-
-        # If within limit, keep as-is
-        if len(attribute_value) <= max_length:
-            return attribute_value
-
-        # If max is tiny, avoid negative slicing; fall back to hard cut
-        if max_length <= len(ellipsis):
-            return attribute_value[:max_length]
-
-        # Truncate and append the msg
-        return attribute_value[: max_length - len(ellipsis)] + ellipsis
-
-    def _clean_attributes(self, content: dict) -> dict:
-        """Clean, truncate, and deduplicate attributes for groups and indicators.
-
-        Args:
-            content: The content dictionary containing groups and/or indicators with attributes.
-
-        Returns:
-            The content dictionary with cleaned, truncated, and deduplicated attributes.
-        """
-        truncated_types: set[str] = set()
-
-        for key in ['groups', 'indicators']:
-            for item in content.get(key, []):
-                original_attrs = item.get('attributes') or []
-                cleaned_attrs = []
-                seen = set()  # track normalized tuples of the entire attribute
-
-                for attr in original_attrs:
-                    type_ = attr.get('type')
-                    value = attr.get('value')
-
-                    # Skip if type missing or value explicitly empty/None
-                    if not type_ or value is None or value == '':
-                        continue
-
-                    # Truncate/normalize value
-                    truncated = self._auto_truncate_attribute(type_, value)
-
-                    # Log warning once per attribute type when truncation occurs
-                    if truncated != value and type_ not in truncated_types:
-                        truncated_types.add(type_)
-                        self.log.warning(
-                            f'feature=batch, event=attribute-truncated, '
-                            f'key={key}, attribute-type={type_}'
-                        )
-
-                    # De-duplication is based on all fields, but with the truncated value
-                    # Combine with the `seen` set to skip duplicates
-                    normalized_items = tuple(
-                        (k, truncated if k == 'value' else attr.get(k)) for k in sorted(attr.keys())
-                    )
-
-                    if normalized_items in seen:
-                        continue
-                    seen.add(normalized_items)
-
-                    new_attr = dict(attr)
-                    new_attr['value'] = truncated
-                    cleaned_attrs.append(new_attr)
-
-                item['attributes'] = cleaned_attrs
-
-        return content
-
-    def clean_content(self, content: dict) -> dict:
-        """Clean content before upload.
-
-        Args:
-            content: The content dictionary to clean.
-
-        Returns:
-            The cleaned content dictionary.
-        """
-        return self._clean_attributes(content)
-
-    def submit_files(
-        self, file_data: dict, halt_on_error: bool = True, clean_content: bool = False
-    ) -> list[dict] | None:
+    def submit_files(self, file_data: dict, halt_on_error: bool = True) -> list[dict] | None:
         """Submit Files for Documents and Reports to ThreatConnect API.
 
         Critical Errors: There is insufficient document storage allocated to this account.
@@ -1097,9 +963,6 @@ class Batch(BatchWriter, BatchSubmit):
                 except Exception as e:
                     self.log.warning(f'feature=batch, event=file-download-exception, err="""{e}"""')
 
-            if clean_content is True:
-                content = self.clean_content(content)
-
             if content is None:
                 upload_status.append({'uploaded': False, 'xid': xid})
                 self.log.warning(f'feature=batch-submit-files, xid={xid}, event=content-null')

{tcex-4.0.11.dev0 → tcex-4.0.11.dev2}/tcex/api/tc/v2/batch/batch_submit.py

@@ -15,6 +15,7 @@ from requests import Session
 from tcex.exit.error_code import handle_error
 from tcex.input.input import Input
 from tcex.logger.trace_logger import TraceLogger
+from tcex.pleb.cached_property import cached_property
 
 # get tcex logger
 _logger: TraceLogger = logging.getLogger(__name__.split('.', maxsplit=1)[0])  # type: ignore
@@ -73,6 +74,96 @@ class BatchSubmit:
         self._poll_interval_times = []
         self._poll_timeout = 3600
 
+    def _auto_truncate_attribute(
+        self, attribute_type: str, attribute_value: str, ellipsis: str = '...'
+    ) -> str:
+        """Truncate attribute value if it exceeds the maximum length for its type.
+
+        Args:
+            attribute_type: The name of the attribute type.
+            attribute_value: The attribute value to potentially truncate.
+            ellipsis: The string to append when truncating. Defaults to '...'.
+
+        Returns:
+            The original value if within limits, or the truncated value with ellipsis.
+        """
+        attribute_config = self.attribute_config.get(attribute_type)
+        if not attribute_config:
+            return attribute_value
+
+        max_length = attribute_config.get('maxSize')
+        if not max_length:
+            return attribute_value
+
+        # Only strings can be truncated
+        if not isinstance(attribute_value, str):
+            return attribute_value
+
+        # If within limit, keep as-is
+        if len(attribute_value) <= max_length:
+            return attribute_value
+
+        # If max is tiny, avoid negative slicing; fall back to hard cut
+        if max_length <= len(ellipsis):
+            return attribute_value[:max_length]
+
+        # Truncate and append the msg
+        return attribute_value[: max_length - len(ellipsis)] + ellipsis
+
+    def _clean_attributes(self, content: dict) -> dict:
+        """Clean, truncate, and deduplicate attributes for groups and indicators.
+
+        Args:
+            content: The content dictionary containing groups and/or indicators with attributes.
+
+        Returns:
+            The content dictionary with cleaned, truncated, and deduplicated attributes.
+        """
+        truncated_types: set[str] = set()
+
+        for key in ['groups', 'indicators']:
+            for item in content.get(key, []):
+                original_attrs = item.get('attributes') or []
+                cleaned_attrs = []
+                seen = set()  # track normalized tuples of the entire attribute
+
+                for attr in original_attrs:
+                    type_ = attr.get('type')
+                    value = attr.get('value')
+
+                    # Skip if type missing or value explicitly empty/None
+                    if not type_ or value is None or value == '':
+                        continue
+
+                    # Truncate/normalize value
+                    truncated = self._auto_truncate_attribute(type_, value)
+
+                    # Log warning once per attribute type when truncation occurs
+                    if truncated != value and type_ not in truncated_types:
+                        truncated_types.add(type_)
+                        self.log.warning(
+                            f'feature=batch, event=attribute-truncated, '
+                            f'key={key}, attribute-type={type_}'
+                        )
+
+                    # De-duplication is based on all fields, but with the truncated value
+                    # Combine with the `seen` set to skip duplicates
+                    normalized_items = tuple(
+                        (k, truncated if k == 'value' else attr.get(k)) for k in sorted(attr.keys())
+                    )
+
+                    if normalized_items in seen:
+                        continue
+                    seen.add(normalized_items)
+
+                    new_attr = dict(attr)
+                    new_attr['value'] = truncated
+                    cleaned_attrs.append(new_attr)
+
+                item['attributes'] = cleaned_attrs
+
+        return content
+
     @property
     def _critical_failures(self) -> list[str]:  # pragma: no cover
         """Return Batch critical failure messages."""
@@ -91,6 +182,36 @@ class BatchSubmit:
         """Set batch action."""
         self._action = action
 
+    @cached_property
+    def attribute_config(self) -> dict:
+        """Return a dict of attribute types keyed by 'name', fetched across all pages."""
+        attributes: dict[str, dict] = {}
+
+        # Start with the initial endpoint
+        url = '/v3/attributeTypes'
+        while True:
+            # Fetch page (first call uses relative path; subsequent calls use absolute next_ URL)
+            resp = self.session_tc.get(url, params={'resultLimit': 10_000})
+            payload = resp.json()
+
+            # Collect items from this page
+            for attribute_type in payload.get('data', []):
+                name = attribute_type.get('name')
+                if name is None:
+                    # Skip entries without a name key (defensive)
+                    continue
+                attributes[name] = attribute_type
+
+            # Get the next page URL; stop if none
+            next_ = payload.get('next')
+            if not next_:
+                break
+
+            # next_ is the full URL for the next page
+            url = next_
+
+        return attributes
+
     @property
     def attribute_write_type(self) -> str:
         """Return batch attribute write type."""
@@ -101,6 +222,18 @@ class BatchSubmit:
         """Set batch attribute write type."""
         self._attribute_write_type = write_type
 
+    def clean_content(self, content: dict | str) -> dict:
+        """Clean content before upload.
+
+        Args:
+            content: The content dictionary to clean.
+
+        Returns:
+            The cleaned content dictionary.
+        """
+        content_dict = json.loads(content) if isinstance(content, str) else content
+        return self._clean_attributes(content_dict)
+
     def create_job(self, halt_on_error: bool = True) -> int | None:
         """Submit Batch request to ThreatConnect API.
 
@@ -341,7 +474,7 @@ class BatchSubmit:
             if data.get('data', {}).get('batchStatus', {}).get('status') == 'Completed':
                 # store last 5 poll times to use in calculating average poll time
                 modifier = poll_time_total * 0.7
-                self._poll_interval_times = self._poll_interval_times[-4:] + [modifier]  # noqa: RUF005
+                self._poll_interval_times = [*self._poll_interval_times[-4:], modifier]
 
                 weights: list[float | int] = [1]
                 poll_interval_time_weighted_sum = 0
@@ -447,7 +580,11 @@ class BatchSubmit:
         return {}
 
     def submit_data(
-        self, batch_id: int, content: dict | str, halt_on_error: bool = True
+        self,
+        batch_id: int,
+        content: dict | str,
+        halt_on_error: bool = True,
+        clean_content: bool = False,
     ) -> dict | None:
         """Submit Batch request to ThreatConnect API.
 
@@ -456,6 +593,7 @@ class BatchSubmit:
             content: The dict of groups and indicator data.
             halt_on_error (bool = True): If True the process
                 should halt if any errors are encountered.
+            clean_content: If True the content will be cleaned before upload.
 
         Returns:
             dict: The response data
@@ -467,6 +605,9 @@ class BatchSubmit:
         # TC Core requires the header to be application/octet-stream
         headers = {'Content-Type': 'application/octet-stream'}
         try:
+            if clean_content is True:
+                content = self.clean_content(content)
+
             if isinstance(content, dict):
                 content = json.dumps(content)
 

{tcex-4.0.11.dev0 → tcex-4.0.11.dev2}/tcex/api/tc/v3/object_abc.py

@@ -54,6 +54,7 @@ class ObjectABC(ABC):  # noqa: B024
         self._model: V3ModelABC
         self._nested_field_name: str | None = None
         self._nested_filter: str | None = None
+        self._timeout = None
         self.type_: str
 
     @property
@@ -141,7 +142,7 @@ class ObjectABC(ABC):  # noqa: B024
         try:
             self.log_request(method, url, body, params)
             self.request = self._session.request(
-                method, url, data=body, headers=headers, params=params
+                method, url, data=body, headers=headers, params=params, timeout=self.timeout
             )
         except (ConnectionError, ProxyError, RetryError):  # pragma: no cover
             handle_error(
@@ -393,6 +394,16 @@ class ObjectABC(ABC):  # noqa: B024
             status = False
         return status
 
+    @property
+    def timeout(self) -> int | None:
+        """Return the current timeout value for all requests."""
+        return self._timeout
+
+    @timeout.setter
+    def timeout(self, timeout: int | None):
+        """Set the current timeout value for all requests."""
+        self._timeout = timeout
+
     def update(self, mode: str | None = None, params: dict | None = None) -> Response:
         """Create or Update the Case Management object.
 

{tcex-4.0.11.dev0 → tcex-4.0.11.dev2}/tcex/api/tc/v3/object_collection_abc.py

@@ -47,6 +47,7 @@ class ObjectCollectionABC(ABC):  # noqa: B024
         self.log = _logger
         self.request: Response
         self.tql = Tql()
+        self._timeout = None
         self._model = None
         self.type_ = None  # defined in child class
         self.util = Util()
@@ -121,7 +122,7 @@ class ObjectCollectionABC(ABC):  # noqa: B024
         try:
             self.log_request(method, url, body, params)
             self.request = self._session.request(
-                method, url, data=body, headers=headers, params=params
+                method, url, data=body, headers=headers, params=params, timeout=self.timeout
             )
         except (ConnectionError, ProxyError, RetryError):  # pragma: no cover
             handle_error(
@@ -275,13 +276,13 @@ class ObjectCollectionABC(ABC):  # noqa: B024
         return status
 
     @property
-    def timeout(self) -> int:
-        """Return the timeout of the case management object collection."""
+    def timeout(self) -> int | None:
+        """Return the current timeout value for all requests."""
         return self._timeout
 
     @timeout.setter
-    def timeout(self, timeout: int):
-        """Set the timeout of the case management object collection."""
+    def timeout(self, timeout: int | None):
+        """Set the current timeout value for all requests."""
         self._timeout = timeout
 
     @cached_property

{tcex-4.0.11.dev0 → tcex-4.0.11.dev2/tcex.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tcex
-Version: 4.0.11.dev0
+Version: 4.0.11.dev2
 Summary: ThreatConnect Exchange App Framework
 Author-email: ThreatConnect <support@threatconnect.com>
 License-Expression: Apache-2.0