sfq 0.0.15__py3-none-any.whl → 0.0.17__py3-none-any.whl

sfq/__init__.py

@@ -7,17 +7,13 @@ import time
 import warnings
 from collections import OrderedDict
 from concurrent.futures import ThreadPoolExecutor, as_completed
-from typing import Any, Dict, Literal, Optional, List, Tuple
+from typing import Any, Dict, Iterable, Literal, Optional, List, Tuple
 from urllib.parse import quote, urlparse
 
 TRACE = 5
 logging.addLevelName(TRACE, "TRACE")
 
 
-class ExperimentalWarning(Warning):
-    pass
-
-
 def trace(self: logging.Logger, message: str, *args: Any, **kwargs: Any) -> None:
     """Custom TRACE level logging function with redaction."""
 
@@ -88,9 +84,9 @@ class SFAuth:
         access_token: Optional[str] = None,
         token_expiration_time: Optional[float] = None,
         token_lifetime: int = 15 * 60,
-        user_agent: str = "sfq/0.0.15",
+        user_agent: str = "sfq/0.0.17",
         sforce_client: str = "_auto",
-        proxy: str = "auto",
+        proxy: str = "_auto",
     ) -> None:
         """
         Initializes the SFAuth with necessary parameters.
@@ -104,9 +100,9 @@ class SFAuth:
         :param access_token: The access token for the current session (default is None).
         :param token_expiration_time: The expiration time of the access token (default is None).
         :param token_lifetime: The lifetime of the access token in seconds (default is 15 minutes).
-        :param user_agent: Custom User-Agent string (default is "sfq/0.0.15").
+        :param user_agent: Custom User-Agent string (default is "sfq/0.0.17").
         :param sforce_client: Custom Application Identifier (default is user_agent).
-        :param proxy: The proxy configuration, "auto" to use environment (default is "auto").
+        :param proxy: The proxy configuration, "_auto" to use environment (default is "_auto").
         """
         self.instance_url = self._format_instance_url(instance_url)
         self.client_id = client_id
@@ -118,7 +114,7 @@ class SFAuth:
         self.token_expiration_time = token_expiration_time
         self.token_lifetime = token_lifetime
         self.user_agent = user_agent
-        self.sforce_client = sforce_client
+        self.sforce_client = str(sforce_client).replace(",", "")
         self._auto_configure_proxy(proxy)
         self._high_api_usage_threshold = 80
 
@@ -138,6 +134,13 @@ class SFAuth:
             )
 
     def _format_instance_url(self, instance_url) -> str:
+        """
+        HTTPS is mandatory with Spring '21 release,
+        This method ensures that the instance URL is formatted correctly.
+
+        :param instance_url: The Salesforce instance URL.
+        :return: The formatted instance URL.
+        """
         if instance_url.startswith("https://"):
             return instance_url
         if instance_url.startswith("http://"):
@@ -148,8 +151,8 @@ class SFAuth:
         """
         Automatically configure the proxy based on the environment or provided value.
         """
-        if proxy == "auto":
-            self.proxy = os.environ.get("https_proxy")
+        if proxy == "_auto":
+            self.proxy = os.environ.get("https_proxy")  # HTTPs is mandatory
             if self.proxy:
                 logger.debug("Auto-configured proxy: %s", self.proxy)
         else:
@@ -210,7 +213,6 @@ class SFAuth:
         endpoint: str,
         headers: Dict[str, str],
         body: Optional[str] = None,
-        timeout: Optional[int] = None,
     ) -> Tuple[Optional[int], Optional[str]]:
         """
         Unified request method with built-in logging and error handling.
@@ -256,7 +258,7 @@ class SFAuth:
         :param payload: Payload for the token request.
         :return: Parsed JSON response or None on failure.
         """
-        headers = self._get_common_headers()
+        headers = self._get_common_headers(recursive_call=True)
         headers["Content-Type"] = "application/x-www-form-urlencoded"
         del headers["Authorization"]
 
@@ -343,16 +345,15 @@ class SFAuth:
         logger.error("Failed to obtain access token.")
         return None
 
-    def _get_common_headers(self) -> Dict[str, str]:
+    def _get_common_headers(self, recursive_call: bool = False) -> Dict[str, str]:
         """
         Generate common headers for API requests.
 
         :return: A dictionary of common headers.
         """
-        if not self.access_token and self.token_expiration_time is None:
-            self.token_expiration_time = int(time.time())
+        if not recursive_call:
             self._refresh_token_if_needed()
-        
+
         return {
             "Authorization": f"Bearer {self.access_token}",
             "User-Agent": self.user_agent,
@@ -361,8 +362,6 @@ class SFAuth:
             "Content-Type": "application/json",
         }
 
-    
-
     def _is_token_expired(self) -> bool:
         """
         Check if the access token has expired.
@@ -648,7 +647,7 @@ class SFAuth:
         return None
 
     def cquery(
-        self, query_dict: dict[str, str], max_workers: int = 10
+        self, query_dict: dict[str, str], batch_size: int = 25, max_workers: int = None
     ) -> Optional[Dict[str, Any]]:
         """
         Execute multiple SOQL queries using the Composite Batch API with threading to reduce network overhead.
@@ -657,7 +656,8 @@ class SFAuth:
         Each query (subrequest) is counted as a unique API request against Salesforce governance limits.
 
         :param query_dict: A dictionary of SOQL queries with keys as logical names and values as SOQL queries.
-        :param max_workers: The maximum number of threads to spawn for concurrent execution (default is 10).
+        :param batch_size: The number of queries to include in each batch (default is 25).
+        :param max_workers: The maximum number of threads to spawn for concurrent execution (default is None).
         :return: Dict mapping the original keys to their corresponding batch response or None on failure.
         """
         if not query_dict:
@@ -757,3 +757,122 @@ class SFAuth:
 
         logger.trace("Composite query results: %s", results_dict)
         return results_dict
+
+    def cdelete(
+        self, ids: Iterable[str], batch_size: int = 200, max_workers: int = None
+    ) -> Optional[Dict[str, Any]]:
+        """
+        Execute the Collections Delete API to delete multiple records using multithreading.
+
+        :param ids: A list of record IDs to delete.
+        :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 (default is None).
+        :return: Combined JSON response from all batches or None on complete failure.
+        """
+        ids = list(ids)
+        chunks = [ids[i : i + batch_size] for i in range(0, len(ids), batch_size)]
+
+        def delete_chunk(chunk: List[str]) -> Optional[Dict[str, Any]]:
+            endpoint = f"/services/data/{self.api_version}/composite/sobjects?ids={','.join(chunk)}&allOrNone=false"
+            headers = self._get_common_headers()
+
+            status_code, resp_data = self._send_request(
+                method="DELETE",
+                endpoint=endpoint,
+                headers=headers,
+            )
+
+            if status_code == 200:
+                logger.debug("Collections delete API response without errors.")
+                return json.loads(resp_data)
+            else:
+                logger.error("Collections delete API request failed: %s", status_code)
+                logger.debug("Response body: %s", resp_data)
+                return None
+
+        results = []
+        with ThreadPoolExecutor(max_workers=max_workers) as executor:
+            futures = [executor.submit(delete_chunk, chunk) for chunk in chunks]
+            for future in as_completed(futures):
+                result = future.result()
+                if result:
+                    results.append(result)
+
+        combined_response = [
+            item
+            for result in results
+            for item in (result if isinstance(result, list) else [result])
+            if isinstance(result, (dict, list))
+        ]
+        return combined_response or None
+
+    def _cupdate(self, update_dict: Dict[str, Any], batch_size: int = 25, max_workers: int = None) -> Optional[Dict[str, Any]]:
+        """
+        Execute the Composite Update API to update multiple records.
+
+        :param update_dict: A dictionary of keys of records to be updated, and a dictionary of field-value pairs to be updated, with a special key '_' overriding the sObject type which is otherwise inferred from the key. Example:
+            {'001aj00000C8kJhAAJ': {'Subject': 'Easily updated via SFQ'}, '00aaj000006wtdcAAA': {'_': 'CaseComment', 'IsPublished': False}, '001aj0000002yJRCAY': {'_': 'IdeaComment', 'CommentBody': 'Hello World!'}} 
+        :param batch_size: The number of records to update in each batch (default is 25).
+        :return: JSON response from the update request or None on failure.
+        """
+        allOrNone = False
+        endpoint = f"/services/data/{self.api_version}/composite"
+
+        compositeRequest_payload = []
+        sobject_prefixes = {}
+
+        for key, record in update_dict.items():
+            sobject = record.copy().pop("_", None)
+            if not sobject and not sobject_prefixes:
+                sobject_prefixes = self.get_sobject_prefixes()
+            
+            sobject = str(sobject) or str(sobject_prefixes.get(str(key[:3]), None))
+            
+            compositeRequest_payload.append(
+                {
+                    'method': 'PATCH',
+                    'url': f"/services/data/{self.api_version}/sobjects/{sobject}/{key}",
+                    'referenceId': key,
+                    'body': record,
+                }
+            )
+
+        chunks = [compositeRequest_payload[i:i+batch_size] for i in range(0, len(compositeRequest_payload), batch_size)]
+
+        def update_chunk(chunk: List[Dict[str, Any]]) -> Optional[Dict[str, Any]]:
+            payload = {
+                "allOrNone": bool(allOrNone),
+                "compositeRequest": chunk
+            }
+
+            status_code, resp_data = self._send_request(
+                method="POST",
+                endpoint=endpoint,
+                headers=self._get_common_headers(),
+                body=json.dumps(payload),
+            )
+
+            if status_code == 200:
+                logger.debug("Composite update API response without errors.")
+                return json.loads(resp_data)
+            else:
+                logger.error("Composite update API request failed: %s", status_code)
+                logger.debug("Response body: %s", resp_data)
+                return None
+
+        results = []
+        with ThreadPoolExecutor(max_workers=max_workers) as executor:
+            futures = [executor.submit(update_chunk, chunk) for chunk in chunks]
+            for future in as_completed(futures):
+                result = future.result()
+                if result:
+                    results.append(result)
+
+        combined_response = [
+            item
+            for result in results
+            for item in (result if isinstance(result, list) else [result])
+            if isinstance(result, (dict, list))
+        ]
+        
+        return combined_response or None

{sfq-0.0.15.dist-info → sfq-0.0.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfq
-Version: 0.0.15
+Version: 0.0.17
 Summary: Python wrapper for the Salesforce's Query API.
 Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
 Keywords: salesforce,salesforce query
@@ -56,18 +56,6 @@ print(sf.query("SELECT Id FROM Account LIMIT 5"))
 print(sf.tooling_query("SELECT Id, FullName, Metadata FROM SandboxSettings LIMIT 5"))
 ```
 
-### sObject Key Prefixes
-
-```python
-# Key prefix via IDs
-print(sf.get_sobject_prefixes())
->>> {'0Pp': 'AIApplication', '6S9': 'AIApplicationConfig', '9qd': 'AIInsightAction', '9bq': 'AIInsightFeedback', '0T2': 'AIInsightReason', '9qc': 'AIInsightValue', ...}
-
-# Key prefix via names
-print(sf.get_sobject_prefixes(key_type="name"))
->>> {'AIApplication': '0Pp', 'AIApplicationConfig': '6S9', 'AIInsightAction': '9qd', 'AIInsightFeedback': '9bq', 'AIInsightReason': '0T2', 'AIInsightValue': '9qc', ...}
-```
-
 ### Composite Batch Queries
 
 ```python
@@ -90,6 +78,13 @@ for subrequest_identifer, subrequest_response in batched_response.items():
 >>> "Frozen Users" returned 4082 records
 ```
 
+### Collection Deletions
+
+```python
+response = sf.cdelete(['07La0000000bYgj', '07La0000000bYgk', '07La0000000bYgl'])
+>>> [{'id': '07La0000000bYgj', 'success': True, 'errors': []}, {'id': '07La0000000bYgk', 'success': True, 'errors': []}, {'id': '07La0000000bYgl', 'success': True, 'errors': []}]
+```
+
 ### Static Resources
 
 ```python
@@ -103,6 +98,18 @@ print(f'Updated resource: {page}')
 sf.update_static_resource_id('081aj000009jUMXAA2', '<h1>It works!</h1>')
 ```
 
+### sObject Key Prefixes
+
+```python
+# Key prefix via IDs
+print(sf.get_sobject_prefixes())
+>>> {'0Pp': 'AIApplication', '6S9': 'AIApplicationConfig', '9qd': 'AIInsightAction', '9bq': 'AIInsightFeedback', '0T2': 'AIInsightReason', '9qc': 'AIInsightValue', ...}
+
+# Key prefix via names
+print(sf.get_sobject_prefixes(key_type="name"))
+>>> {'AIApplication': '0Pp', 'AIApplicationConfig': '6S9', 'AIInsightAction': '9qd', 'AIInsightFeedback': '9bq', 'AIInsightReason': '0T2', 'AIInsightValue': '9qc', ...}
+```
+
 ## How to Obtain Salesforce Tokens
 
 To use the `sfq` library, you'll need a **client ID** and **refresh token**. The easiest way to obtain these is by using the Salesforce CLI:

sfq-0.0.17.dist-info/RECORD

@@ -0,0 +1,6 @@
+sfq/__init__.py,sha256=qtXrbjzTQL1nU2RaMbxWUDRFt4CAUKAkwwp-_9lqavE,35361
+sfq/_cometd.py,sha256=XimQEubmJwUmbWe85TxH_cuhGvWVuiHHrVr41tguuiI,10508
+sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sfq-0.0.17.dist-info/METADATA,sha256=XgKcuglHsZ1dN1rqNSgaWb-A-wf8-bStAMt2Gmj4GlE,6899
+sfq-0.0.17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sfq-0.0.17.dist-info/RECORD,,

sfq-0.0.15.dist-info/RECORD

@@ -1,6 +0,0 @@
-sfq/__init__.py,sha256=b70qbaov94JC7qWHuJA6X0i6O-H145YS-_vlyPzWig4,29895
-sfq/_cometd.py,sha256=XimQEubmJwUmbWe85TxH_cuhGvWVuiHHrVr41tguuiI,10508
-sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sfq-0.0.15.dist-info/METADATA,sha256=ipG9mLqnwZwGp6gUGSbggP_LNl80YcGPpM1_fYlS7Vo,6598
-sfq-0.0.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sfq-0.0.15.dist-info/RECORD,,