sfq 0.0.33__py3-none-any.whl → 0.0.34__py3-none-any.whl

sfq/__init__.py

@@ -25,6 +25,7 @@ from .http_client import HTTPClient
 from .query import QueryClient
 from .soap import SOAPClient
 from .utils import get_logger
+from .debug_cleanup import DebugCleanup
 
 # Define public API for documentation tools
 __all__ = [
@@ -42,7 +43,7 @@ __all__ = [
     "__version__",
 ]
 
-__version__ = "0.0.33"
+__version__ = "0.0.34"
 """
 ### `__version__`
 
@@ -66,7 +67,7 @@ class SFAuth:
         access_token: Optional[str] = None,
         token_expiration_time: Optional[float] = None,
         token_lifetime: int = 15 * 60,
-        user_agent: str = "sfq/0.0.33",
+        user_agent: str = "sfq/0.0.34",
         sforce_client: str = "_auto",
         proxy: str = "_auto",
     ) -> None:
@@ -127,8 +128,11 @@ class SFAuth:
             api_version=api_version,
         )
 
+        # Initialize the DebugCleanup
+        self._debug_cleanup = DebugCleanup(sf_auth=self)
+
         # Store version information
-        self.__version__ = "0.0.33"
+        self.__version__ = "0.0.34"
         """
         ### `__version__`
         
@@ -530,25 +534,20 @@ class SFAuth:
             sobject, insert_list, batch_size, max_workers, api_type
         )
 
-    def _debug_cleanup_apex_logs(self):
-        """
-        This function performs cleanup operations for Apex debug logs.
-        """
-        apex_logs = self.query("SELECT Id FROM ApexLog ORDER BY LogLength DESC")
-        if apex_logs and apex_logs.get("records"):
-            log_ids = [log["Id"] for log in apex_logs["records"]]
-            if log_ids:
-                delete_response = self.cdelete(log_ids)
-                logger.debug("Deleted Apex logs: %s", delete_response)
-        else:
-            logger.debug("No Apex logs found to delete.")
-
-    def debug_cleanup(self, apex_logs: bool = True) -> None:
+    def debug_cleanup(
+        self,
+        apex_logs: bool = True,
+        expired_apex_flags: bool = True,
+        all_apex_flags: bool = False,
+    ) -> None:
         """
         Perform cleanup operations for Apex debug logs.
         """
-        if apex_logs:
-            self._debug_cleanup_apex_logs()
+        self._debug_cleanup.debug_cleanup(
+            apex_logs=apex_logs,
+            expired_apex_flags=expired_apex_flags,
+            all_apex_flags=all_apex_flags,
+        )
 
     def open_frontdoor(self) -> None:
         """

sfq/crud.py

@@ -37,23 +37,17 @@ class CRUDClient:
         self.soap_client = soap_client
         self.api_version = api_version
 
-    def create(
+    def _soap_batch_operation(
         self,
         sobject: str,
-        insert_list: List[Dict[str, Any]],
+        data_list,
+        method: str,
         batch_size: int = 200,
         max_workers: int = None,
         api_type: Literal["enterprise", "tooling"] = "enterprise",
     ) -> Optional[Dict[str, Any]]:
         """
-        Execute the Insert API to insert multiple records via SOAP calls.
-
-        :param sobject: The name of the sObject to insert into.
-        :param insert_list: A list of dictionaries, each representing a record to insert.
-        :param batch_size: The number of records to insert in each batch (default is 200).
-        :param max_workers: The maximum number of threads to spawn for concurrent execution.
-        :param api_type: API type to use ('enterprise' or 'tooling').
-        :return: JSON response from the insert request or None on failure.
+        Internal helper for batch SOAP operations (create/delete).
         """
         endpoint = "/services/Soap/"
         if api_type == "enterprise":
@@ -67,21 +61,20 @@ class CRUDClient:
             )
             return None
 
-        # Handle API versioning in the endpoint
         endpoint = endpoint.replace("/v", "/")
 
-        if isinstance(insert_list, dict):
-            insert_list = [insert_list]
+        if isinstance(data_list, dict) and method == "create":
+            data_list = [data_list]
+        if isinstance(data_list, str) and method == "delete":
+            data_list = [data_list]
 
         chunks = [
-            insert_list[i : i + batch_size]
-            for i in range(0, len(insert_list), batch_size)
+            data_list[i : i + batch_size]
+            for i in range(0, len(data_list), batch_size)
         ]
 
-        def insert_chunk(chunk: List[Dict[str, Any]]) -> Optional[Dict[str, Any]]:
-            """Insert a chunk of records using SOAP API."""
+        def process_chunk(chunk):
             try:
-                # Get the access token for the SOAP header
                 access_token = self.http_client.auth_manager.access_token
                 if not access_token:
                     logger.error("No access token available for SOAP request")
@@ -89,7 +82,7 @@ class CRUDClient:
 
                 header = self.soap_client.generate_soap_header(access_token)
                 body = self.soap_client.generate_soap_body(
-                    sobject=sobject, method="create", data=chunk
+                    sobject=sobject, method=method, data=chunk
                 )
                 envelope = self.soap_client.generate_soap_envelope(
                     header=header, body=body, api_type=api_type
@@ -99,8 +92,8 @@ class CRUDClient:
                 soap_headers["Content-Type"] = "text/xml; charset=UTF-8"
                 soap_headers["SOAPAction"] = '""'
 
-                logger.trace("SOAP request envelope: %s", envelope)
-                logger.trace("SOAP request headers: %s", soap_headers)
+                logger.trace(f"SOAP {method} request envelope: %s", envelope)
+                logger.trace(f"SOAP {method} request headers: %s", soap_headers)
 
                 status_code, resp_data = self.http_client.send_request(
                     method="POST",
@@ -109,25 +102,27 @@ class CRUDClient:
                     body=envelope,
                 )
 
+                logger.trace(f"SOAP {method} response status: {status_code}")
+                logger.trace(f"SOAP {method} raw response: {resp_data}")
+
                 if status_code == 200:
-                    logger.debug("Insert API request successful.")
-                    logger.trace("Insert API response: %s", resp_data)
+                    logger.debug(f"{method.capitalize()} API request successful.")
+                    logger.trace(f"{method.capitalize()} API response: %s", resp_data)
                     result = self.soap_client.extract_soap_result_fields(resp_data)
                     if result:
                         return result
                     logger.error("Failed to extract fields from SOAP response.")
                 else:
-                    logger.error("Insert API request failed: %s", status_code)
+                    logger.error(f"{method.capitalize()} API request failed: %s", status_code)
                     logger.debug("Response body: %s", resp_data)
                     return None
-
             except Exception as e:
-                logger.exception("Exception during insert chunk: %s", e)
+                logger.exception(f"Exception during {method} chunk: %s", e)
                 return None
 
         results = []
         with ThreadPoolExecutor(max_workers=max_workers) as executor:
-            futures = [executor.submit(insert_chunk, chunk) for chunk in chunks]
+            futures = [executor.submit(process_chunk, chunk) for chunk in chunks]
             for future in as_completed(futures):
                 result = future.result()
                 if result:
@@ -142,6 +137,79 @@ class CRUDClient:
 
         return combined_response or None
 
+    def create(
+        self,
+        sobject: str,
+        insert_list: List[Dict[str, Any]],
+        batch_size: int = 200,
+        max_workers: int = None,
+        api_type: Literal["enterprise", "tooling"] = "enterprise",
+    ) -> Optional[Dict[str, Any]]:
+        """
+        Execute the Insert API to insert multiple records via SOAP calls.
+        """
+        return self._soap_batch_operation(
+            sobject=sobject,
+            data_list=insert_list,
+            method="create",
+            batch_size=batch_size,
+            max_workers=max_workers,
+            api_type=api_type,
+        )
+    
+    def update(
+        self,
+        sobject: str,
+        update_list: List[Dict[str, Any]],
+        batch_size: int = 200,
+        max_workers: int = None,
+        api_type: Literal["enterprise", "tooling"] = "enterprise",
+    ) -> Optional[Dict[str, Any]]:
+        """
+        Execute the Update API to update multiple records via SOAP calls.
+        :param sobject: The name of the sObject to update.
+        :param update_list: A list of dictionaries, each representing a record to update (must include Id).
+        :param batch_size: The number of records to update in each batch (default is 200).
+        :param max_workers: The maximum number of threads to spawn for concurrent execution.
+        :param api_type: API type to use ('enterprise' or 'tooling').
+        :return: JSON response from the update request or None on failure.
+        """
+        return self._soap_batch_operation(
+            sobject=sobject,
+            data_list=update_list,
+            method="update",
+            batch_size=batch_size,
+            max_workers=max_workers,
+            api_type=api_type,
+        )
+    
+    def delete(
+        self,
+        sobject: str,
+        id_list: List[str],
+        batch_size: int = 200,
+        max_workers: int = None,
+        api_type: Literal["enterprise", "tooling"] = "enterprise",
+    ) -> Optional[Dict[str, Any]]:
+        """
+        Execute the Delete API to remove multiple records via SOAP calls.
+        :param sobject: The name of the sObject to delete from.
+        :param id_list: A list of record IDs to delete (strings, not dicts).
+        :param batch_size: The number of records to delete in each batch (default is 200).
+        :param max_workers: The maximum number of threads to spawn for concurrent execution.
+        :param api_type: API type to use ('enterprise' or 'tooling').
+        :return: JSON response from the delete request or None on failure.
+        """
+        # Pass list of IDs directly for SOAP delete
+        return self._soap_batch_operation(
+            sobject=sobject,
+            data_list=id_list,
+            method="delete",
+            batch_size=batch_size,
+            max_workers=max_workers,
+            api_type=api_type,
+        )
+
     def cupdate(
         self, update_dict: Dict[str, Any], batch_size: int = 25, max_workers: int = None
     ) -> Optional[Dict[str, Any]]:

sfq/debug_cleanup.py

@@ -0,0 +1,71 @@
+"""
+Debug cleanup module for Salesforce-related debug artifacts.
+"""
+
+from datetime import datetime, timezone
+import logging
+from typing import Dict, Any, Optional
+
+logger = logging.getLogger("sfq")
+
+
+class DebugCleanup:
+    """
+    Class handling debug artifact cleanup operations in Salesforce.
+    """
+
+    def __init__(self, sf_auth):
+        """
+        Initialize the DebugCleanup with an SFAuth instance.
+
+        :param sf_auth: An authenticated SFAuth instance
+        """
+        self._sf_auth = sf_auth
+
+    def _debug_cleanup_apex_logs(self) -> None:
+        """
+        This function performs cleanup operations for Apex debug logs.
+        """
+        apex_logs = self._sf_auth.query("SELECT Id FROM ApexLog ORDER BY LogLength DESC")
+        if apex_logs and apex_logs.get("records"):
+            log_ids = [log["Id"] for log in apex_logs["records"]]
+            if log_ids:
+                delete_response = self._sf_auth.cdelete(log_ids)
+                logger.debug("Deleted Apex logs: %s", delete_response)
+        else:
+            logger.debug("No Apex logs found to delete.")
+
+    def _debug_cleanup_trace_flags(self, expired_only: bool) -> None:
+        """
+        This function performs cleanup operations for Trace Flags.
+        """
+        if expired_only:
+            now_iso_format = datetime.now(timezone.utc).strftime('%Y-%m-%dT%H:%M:%SZ')
+            query = f"SELECT Id, ExpirationDate FROM TraceFlag WHERE ExpirationDate < {now_iso_format}"
+        else:
+            query = "SELECT Id, ExpirationDate FROM TraceFlag"
+
+        traceflags = self._sf_auth.tooling_query(query)
+        if traceflags['totalSize'] == 0:
+            logger.debug("No expired Trace Flag configurations to delete.")
+            return
+
+        trace_flag_ids = [tf["Id"] for tf in traceflags["records"]]
+        logger.debug("Deleting Trace Flags: %s", trace_flag_ids)
+        results = self._sf_auth._crud_client.delete("TraceFlag", trace_flag_ids, api_type="tooling")
+        # results = self._sf_auth.delete("TraceFlag", trace_flag_ids)
+        logger.debug("Deleted Trace Flags: %s", results)
+
+    def debug_cleanup(self, apex_logs: bool = True, expired_apex_flags: bool = True, all_apex_flags: bool = False) -> None:
+        """
+        Perform cleanup operations for Apex debug logs.
+
+        :param apex_logs: Whether to clean up Apex logs (default: True)
+        """
+        if apex_logs:
+            self._debug_cleanup_apex_logs()
+
+        if all_apex_flags:
+            self._debug_cleanup_trace_flags(expired_only=False)
+        elif expired_apex_flags:
+            self._debug_cleanup_trace_flags(expired_only=True)

sfq/http_client.py

@@ -28,7 +28,7 @@ class HTTPClient:
     def __init__(
         self,
         auth_manager: AuthManager,
-        user_agent: str = "sfq/0.0.33",
+        user_agent: str = "sfq/0.0.34",
         sforce_client: str = "_auto",
         high_api_usage_threshold: int = 80,
     ) -> None:

sfq/soap.py

@@ -100,13 +100,18 @@ class SOAPClient:
         else:
             records = data
 
-        sobjects = "".join(
-            f'<sObjects xsi:type="{sobject}">'
-            + "".join(f"<{k}>{v}</{k}>" for k, v in record.items())
-            + "</sObjects>"
-            for record in records
-        )
-        return f"<soapenv:Body><{method}>{sobjects}</{method}></soapenv:Body>"
+        if method == "delete":
+            # For delete, records is a list of IDs (strings)
+            id_tags = "".join(f"<ID>{id}</ID>" for id in records)
+            return f"<soapenv:Body><delete>{id_tags}</delete></soapenv:Body>"
+        else:
+            sobjects = "".join(
+                f'<sObjects xsi:type="{sobject}">'
+                + "".join(f"<{k}>{v}</{k}>" for k, v in record.items())
+                + "</sObjects>"
+                for record in records
+            )
+            return f"<soapenv:Body><{method}>{sobjects}</{method}></soapenv:Body>"
 
     def extract_soap_result_fields(
         self, xml_string: str

{sfq-0.0.33.dist-info → sfq-0.0.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfq
-Version: 0.0.33
+Version: 0.0.34
 Summary: Python wrapper for the Salesforce's Query API.
 Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
 Keywords: salesforce,salesforce query

sfq-0.0.34.dist-info/RECORD

@@ -0,0 +1,14 @@
+sfq/__init__.py,sha256=OcSYzIjdE1cCm8wiGcK_HFIDFvrle_IHKo54EIeSpns,19929
+sfq/_cometd.py,sha256=QqdSGsms9uFm7vgmxgau7m2UuLHztK1yjN-BNjeo8xM,10381
+sfq/auth.py,sha256=bD7kEI5UpUAh0xpE2GzB7EatfLE0q-rqG7tOpqn_cQY,13985
+sfq/crud.py,sha256=fj4wPMt0DcrMKbMWQ9AUMsUNUWicsY93LP_3Q7lhmDU,20300
+sfq/debug_cleanup.py,sha256=e2_Hpigy3F7XsATOUXo8DZNmuEIL9SDD0tBlZIZeQLc,2638
+sfq/exceptions.py,sha256=HZctvGj1SGguca0oG6fqSmf3KDbq4v68FfQfqB-crpo,906
+sfq/http_client.py,sha256=02x9mT0v2EYgUQVLakvzjp0IZUrIqp1zuRw2H2k8Zo0,11636
+sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sfq/query.py,sha256=AoagL8PMKUcpbPPTcHJPKhmUdDDPa0La4JLC0TUN_Yc,14586
+sfq/soap.py,sha256=FM4msP9ErrgLFaNOQy_kYVde8QFkT4yQu9TfMiZG0VA,7006
+sfq/utils.py,sha256=gx_pCZmOykYz19wwx6O2BTGj7bQfzhX_SuLHnYGCWuc,6234
+sfq-0.0.34.dist-info/METADATA,sha256=LlV877Eud-Cg2CAQLJHVfmvg6-kWHlHASDYt5zAJg5s,6899
+sfq-0.0.34.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sfq-0.0.34.dist-info/RECORD,,

sfq-0.0.33.dist-info/RECORD

@@ -1,13 +0,0 @@
-sfq/__init__.py,sha256=kTT0wRF7zWpG-2KYwvPwDlruzx0SB9fqIxGXq4P51oE,20134
-sfq/_cometd.py,sha256=QqdSGsms9uFm7vgmxgau7m2UuLHztK1yjN-BNjeo8xM,10381
-sfq/auth.py,sha256=bD7kEI5UpUAh0xpE2GzB7EatfLE0q-rqG7tOpqn_cQY,13985
-sfq/crud.py,sha256=oYx74HJN18fnsVVfEUIGb-H9YN0EAgH3HmjktN4GjuM,17829
-sfq/exceptions.py,sha256=HZctvGj1SGguca0oG6fqSmf3KDbq4v68FfQfqB-crpo,906
-sfq/http_client.py,sha256=JuPZ4YYR5y0Hhcn1HffMMcQcJPS_rht-1RewrTWn7bg,11636
-sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sfq/query.py,sha256=AoagL8PMKUcpbPPTcHJPKhmUdDDPa0La4JLC0TUN_Yc,14586
-sfq/soap.py,sha256=jQkC6D4z5iHFkDFOQhaR9Saj4sy3Qxn_zp0VPD-BmlQ,6728
-sfq/utils.py,sha256=gx_pCZmOykYz19wwx6O2BTGj7bQfzhX_SuLHnYGCWuc,6234
-sfq-0.0.33.dist-info/METADATA,sha256=qOEjgwIpgmx4J-ca_1knpMPVZU_zoBTqcO7ic_nWwIw,6899
-sfq-0.0.33.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sfq-0.0.33.dist-info/RECORD,,