pangea-sdk 6.3.0__tar.gz → 6.5.0__tar.gz

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/PKG-INFO

@@ -1,24 +1,25 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pangea-sdk
-Version: 6.3.0
+Version: 6.5.0
 Summary: Pangea API SDK
-License: MIT
 Keywords: Pangea,SDK,Audit
 Author: Glenn Gallien
-Author-email: glenn.gallien@pangea.cloud
-Requires-Python: >=3.9.2,<4.0.0
+Author-email: Glenn Gallien <glenn.gallien@pangea.cloud>
+License-Expression: MIT
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: aiohttp (>=3.12.14,<4.0.0)
-Requires-Dist: cryptography (>=45.0.5,<46.0.0)
-Requires-Dist: deprecated (>=1.2.18,<2.0.0)
-Requires-Dist: google-crc32c (>=1.7.1,<2.0.0)
-Requires-Dist: pydantic (>=2.11.7,<3.0.0)
-Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
-Requires-Dist: requests (>=2.32.4,<3.0.0)
-Requires-Dist: requests-toolbelt (>=1.0.0,<2.0.0)
-Requires-Dist: typing-extensions (>=4.14.1,<5.0.0)
-Requires-Dist: yarl (>=1.20.1,<2.0.0)
+Requires-Dist: aiohttp>=3.12.15,<4.0.0
+Requires-Dist: cryptography>=45.0.6,<46.0.0
+Requires-Dist: deprecated>=1.2.18,<2.0.0
+Requires-Dist: google-crc32c>=1.7.1,<2.0.0
+Requires-Dist: pydantic>=2.11.7,<3.0.0
+Requires-Dist: python-dateutil>=2.9.0.post0,<3.0.0
+Requires-Dist: requests>=2.32.4,<3.0.0
+Requires-Dist: requests-toolbelt>=1.0.0,<2.0.0
+Requires-Dist: typing-extensions>=4.14.1,<5.0.0
+Requires-Dist: yarl>=1.20.1,<2.0.0
+Requires-Python: >=3.9.2, <4.0.0
+Project-URL: repository, https://github.com/pangeacyber/pangea-python
 Description-Content-Type: text/markdown
 
 <a href="https://pangea.cloud?utm_source=github&utm_medium=python-sdk" target="_blank" rel="noopener noreferrer">
@@ -116,8 +117,7 @@ The SDK supports the following configuration options via `PangeaConfig`:
   Use `base_url_template` for more control over the URL, such as setting
   service-specific paths. Defaults to `aws.us.pangea.cloud`.
 - `request_retries` — Number of retries on the initial request.
-- `request_backoff` — Backoff strategy passed to 'requests'.
-- `request_timeout` — Timeout used on initial request attempts.
+- `request_backoff` — A backoff factor to apply between request attempts.
 - `poll_result_timeout` — Timeout used to poll results after 202 (in secs).
 - `queued_retry_enabled` — Enable queued request retry support.
 - `custom_user_agent` — Custom user agent to be used in the request headers.
@@ -243,4 +243,3 @@ It accepts multiple file formats:
   [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
   [Pangea Console]: https://console.pangea.cloud/
   [Secure Audit Log]: https://pangea.cloud/docs/audit
-

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/README.md

@@ -93,8 +93,7 @@ The SDK supports the following configuration options via `PangeaConfig`:
   Use `base_url_template` for more control over the URL, such as setting
   service-specific paths. Defaults to `aws.us.pangea.cloud`.
 - `request_retries` — Number of retries on the initial request.
-- `request_backoff` — Backoff strategy passed to 'requests'.
-- `request_timeout` — Timeout used on initial request attempts.
+- `request_backoff` — A backoff factor to apply between request attempts.
 - `poll_result_timeout` — Timeout used to poll results after 202 (in secs).
 - `queued_retry_enabled` — Enable queued request retry support.
 - `custom_user_agent` — Custom user agent to be used in the request headers.

pangea_sdk-6.5.0/pangea/__init__.py

@@ -0,0 +1,7 @@
+__version__ = "6.5.0"
+
+from pangea.config import PangeaConfig
+from pangea.file_uploader import FileUploader
+from pangea.response import PangeaResponse, PangeaResponseResult, TransferMethod
+
+__all__ = ("FileUploader", "PangeaConfig", "PangeaResponse", "PangeaResponseResult", "TransferMethod")

pangea_sdk-6.5.0/pangea/_constants.py

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+MAX_RETRY_DELAY = 8.0
+RETRYABLE_HTTP_CODES = frozenset({500, 502, 503, 504})

pangea_sdk-6.5.0/pangea/_typing.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from typing import TypeVar
+
+T = TypeVar("T")

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/__init__.py

@@ -1,2 +1,3 @@
-# ruff: noqa: F401
 from .file_uploader import FileUploaderAsync
+
+__all__ = ("FileUploaderAsync",)

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/file_uploader.py

@@ -6,9 +6,10 @@ from __future__ import annotations
 import io
 import logging
 
+from pangea import PangeaConfig, TransferMethod
 from pangea.asyncio.request import PangeaRequestAsync
-from pangea.request import PangeaConfig
-from pangea.response import TransferMethod
+
+__all__ = ("FileUploaderAsync",)
 
 
 class FileUploaderAsync:

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/request.py

@@ -10,6 +10,7 @@ import asyncio
 import json
 import time
 from collections.abc import Iterable, Mapping
+from random import random
 from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast
 
 import aiohttp
@@ -19,10 +20,13 @@ from pydantic_core import to_jsonable_python
 from typing_extensions import Any, TypeAlias, TypeVar, override
 
 import pangea.exceptions as pe
+from pangea._constants import MAX_RETRY_DELAY, RETRYABLE_HTTP_CODES
 from pangea.request import MultipartResponse, PangeaRequestBase
 from pangea.response import AttachedFile, PangeaResponse, PangeaResponseResult, ResponseStatus, TransferMethod
 from pangea.utils import default_encoder
 
+__all__ = ("PangeaRequestAsync",)
+
 _FileName: TypeAlias = Union[str, None]
 _FileContent: TypeAlias = Union[str, bytes]
 _FileContentType: TypeAlias = str
@@ -462,13 +466,46 @@ class PangeaRequestAsync(PangeaRequestBase):
 
     @override
     def _init_session(self) -> aiohttp.ClientSession:
-        # retry_config = Retry(
-        #     total=self.config.request_retries,
-        #     backoff_factor=self.config.request_backoff,
-        #     status_forcelist=[500, 502, 503, 504],
-        # )
-        # adapter = HTTPAdapter(max_retries=retry_config)
-        # TODO: Add retry config
-
-        session = aiohttp.ClientSession()
-        return session
+        return aiohttp.ClientSession(middlewares=[self._retry_middleware])
+
+    def _calculate_retry_timeout(self, remaining_retries: int) -> float:
+        max_retries = self.config.request_retries
+        nb_retries = min(max_retries - remaining_retries, 1000)
+        sleep_seconds = min(self.config.request_backoff * pow(2.0, nb_retries), MAX_RETRY_DELAY)
+        jitter = 1 - 0.25 * random()
+        timeout = sleep_seconds * jitter
+        return max(timeout, 0)
+
+    async def _retry_middleware(
+        self, request: aiohttp.ClientRequest, handler: aiohttp.ClientHandlerType
+    ) -> aiohttp.ClientResponse:
+        max_retries = self.config.request_retries
+        request_ids = set[str]()
+        retries_taken = 0
+        for retries_taken in range(max_retries + 1):
+            remaining_retries = max_retries - retries_taken
+
+            if len(request_ids) > 0:
+                request.headers["X-Pangea-Retried-Request-Ids"] = ",".join(request_ids)
+
+            response = await handler(request)
+
+            request_id = response.headers.get("x-request-id")
+            if request_id:
+                request_ids.add(request_id)
+
+            if not response.ok and remaining_retries > 0 and self._should_retry(response):
+                await self._sleep_for_retry(retries_taken=retries_taken, max_retries=max_retries)
+                continue
+
+            break
+
+        return response
+
+    def _should_retry(self, response: aiohttp.ClientResponse) -> bool:
+        return response.status in RETRYABLE_HTTP_CODES
+
+    async def _sleep_for_retry(self, *, retries_taken: int, max_retries: int) -> None:
+        remaining_retries = max_retries - retries_taken
+        timeout = self._calculate_retry_timeout(remaining_retries)
+        await asyncio.sleep(timeout)

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/services/__init__.py

@@ -1,5 +1,3 @@
-# ruff: noqa: F401
-
 from .ai_guard import AIGuardAsync
 from .audit import AuditAsync
 from .authn import AuthNAsync
@@ -12,3 +10,22 @@ from .redact import RedactAsync
 from .sanitize import SanitizeAsync
 from .share import ShareAsync
 from .vault import VaultAsync
+
+__all__ = (
+    "AIGuardAsync",
+    "AuditAsync",
+    "AuthNAsync",
+    "AuthZAsync",
+    "DomainIntelAsync",
+    "EmbargoAsync",
+    "FileIntelAsync",
+    "FileScanAsync",
+    "IpIntelAsync",
+    "PromptGuardAsync",
+    "RedactAsync",
+    "SanitizeAsync",
+    "ShareAsync",
+    "UrlIntelAsync",
+    "UserIntelAsync",
+    "VaultAsync",
+)

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/services/ai_guard.py

@@ -15,11 +15,9 @@ class AIGuardAsync(ServiceBaseAsync):
     Provides methods to interact with Pangea's AI Guard service.
 
     Examples:
-        from pangea import PangeaConfig
         from pangea.asyncio.services import AIGuardAsync
 
-        config = PangeaConfig(domain="aws.us.pangea.cloud")
-        ai_guard = AIGuardAsync(token="pangea_token", config=config)
+        ai_guard = AIGuardAsync(token="pangea_token")
     """
 
     service_name = "ai-guard"
@@ -39,11 +37,9 @@ class AIGuardAsync(ServiceBaseAsync):
             config_id: Configuration ID.
 
         Examples:
-            from pangea import PangeaConfig
             from pangea.asyncio.services import AIGuardAsync
 
-            config = PangeaConfig(domain="aws.us.pangea.cloud")
-            ai_guard = AIGuardAsync(token="pangea_token", config=config)
+            ai_guard = AIGuardAsync(token="pangea_token")
         """
 
         super().__init__(token, config, logger_name, config_id)
@@ -53,29 +49,31 @@ class AIGuardAsync(ServiceBaseAsync):
         self,
         text: str,
         *,
-        recipe: str | None = None,
         debug: bool | None = None,
-        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
+        overrides: Overrides | None = None,
+        recipe: str | None = None,
     ) -> PangeaResponse[TextGuardResult]:
         """
-        Text Guard for scanning LLM inputs and outputs
+        Guard LLM input and output text
 
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
+        Detect, remove, or block malicious content and intent in LLM inputs and
+        outputs to prevent model manipulation and data leakage.
 
         OperationId: ai_guard_post_v1_text_guard
 
         Args:
             text: Text to be scanned by AI Guard for PII, sensitive data,
                 malicious content, and other data types defined by the
-                configuration. Supports processing up to 10KB of text.
-            recipe: Recipe key of a configuration of data types and settings
-                defined in the Pangea User Console. It specifies the rules that
-                are to be applied to the text, such as defang malicious URLs.
+                configuration. Supports processing up to 20 KiB of text.
             debug: Setting this value to true will provide a detailed analysis
                 of the text data
             log_field: Additional fields to include in activity log
+            overrides: Overrides flags. Note: This parameter has no effect when
+                the request is made by AIDR
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                are to be applied to the text, such as defang malicious URLs.
 
         Examples:
             response = await ai_guard.guard_text("text")
@@ -92,24 +90,26 @@ class AIGuardAsync(ServiceBaseAsync):
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult]:
         """
-        Text Guard for scanning LLM inputs and outputs
+        Guard LLM input and output text
 
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
+        Detect, remove, or block malicious content and intent in LLM inputs and
+        outputs to prevent model manipulation and data leakage.
 
         OperationId: ai_guard_post_v1_text_guard
 
         Args:
             messages: Structured messages data to be scanned by AI Guard for
                 PII, sensitive data, malicious content, and other data types
-                defined by the configuration. Supports processing up to 10KB of
-                JSON text
-            recipe: Recipe key of a configuration of data types and settings
-                defined in the Pangea User Console. It specifies the rules that
-                are to be applied to the text, such as defang malicious URLs.
+                defined by the configuration. Supports processing up to 20 KiB
+                of JSON text using Pangea message format.
             debug: Setting this value to true will provide a detailed analysis
                 of the text data
             log_field: Additional fields to include in activity log
+            overrides: Overrides flags. Note: This parameter has no effect when
+                the request is made by AIDR
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                are to be applied to the text, such as defang malicious URLs.
 
         Examples:
             response = await ai_guard.guard_text(messages=[Message(role="user", content="hello world")])
@@ -126,10 +126,10 @@ class AIGuardAsync(ServiceBaseAsync):
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult]:
         """
-        Text Guard for scanning LLM inputs and outputs
+        Guard LLM input and output text
 
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
+        Detect, remove, or block malicious content and intent in LLM inputs and
+        outputs to prevent model manipulation and data leakage.
 
         OperationId: ai_guard_post_v1_text_guard
 
@@ -141,12 +141,14 @@ class AIGuardAsync(ServiceBaseAsync):
                 PII, sensitive data, malicious content, and other data types
                 defined by the configuration. Supports processing up to 10KB of
                 JSON text
-            recipe: Recipe key of a configuration of data types and settings
-                defined in the Pangea User Console. It specifies the rules that
-                are to be applied to the text, such as defang malicious URLs.
             debug: Setting this value to true will provide a detailed analysis
                 of the text data
             log_field: Additional fields to include in activity log
+            overrides: Overrides flags. Note: This parameter has no effect when
+                the request is made by AIDR
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                are to be applied to the text, such as defang malicious URLs.
 
         Examples:
             response = await ai_guard.guard_text("text")

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/services/authn.py

@@ -10,9 +10,9 @@ from collections.abc import Mapping
 from typing import Dict, List, Literal, Optional, Union
 
 import pangea.services.authn.models as m
+from pangea import PangeaResponse, PangeaResponseResult
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
-from pangea.response import PangeaResponse, PangeaResponseResult
 
 __all__ = ["AuthNAsync"]
 
@@ -66,11 +66,18 @@ class AuthNAsync(ServiceBaseAsync):
              authn = AuthNAsync(token="pangea_token", config=config)
         """
         super().__init__(token, config, logger_name=logger_name)
-        self.user = AuthNAsync.UserAsync(token, config, logger_name=logger_name)
-        self.flow = AuthNAsync.FlowAsync(token, config, logger_name=logger_name)
+        self.agreements = AuthNAsync.AgreementsAsync(token, config, logger_name=logger_name)
         self.client = AuthNAsync.ClientAsync(token, config, logger_name=logger_name)
+        self.flow = AuthNAsync.FlowAsync(token, config, logger_name=logger_name)
         self.session = AuthNAsync.SessionAsync(token, config, logger_name=logger_name)
-        self.agreements = AuthNAsync.AgreementsAsync(token, config, logger_name=logger_name)
+        self.user = AuthNAsync.UserAsync(token, config, logger_name=logger_name)
+
+    async def close(self) -> None:
+        await self.agreements.close()
+        await self.client.close()
+        await self.flow.close()
+        await self.session.close()
+        await self.user.close()
 
     class SessionAsync(ServiceBaseAsync):
         service_name = _SERVICE_NAME
@@ -179,10 +186,15 @@ class AuthNAsync(ServiceBaseAsync):
             logger_name: str = "pangea",
         ) -> None:
             super().__init__(token, config, logger_name=logger_name)
-            self.session = AuthNAsync.ClientAsync.SessionAsync(token, config, logger_name=logger_name)
             self.password = AuthNAsync.ClientAsync.PasswordAsync(token, config, logger_name=logger_name)
+            self.session = AuthNAsync.ClientAsync.SessionAsync(token, config, logger_name=logger_name)
             self.token_endpoints = AuthNAsync.ClientAsync.TokenAsync(token, config, logger_name=logger_name)
 
+        async def close(self) -> None:
+            await self.password.close()
+            await self.session.close()
+            await self.token_endpoints.close()
+
         async def userinfo(self, code: str) -> PangeaResponse[m.ClientUserinfoResult]:
             """
             Get User (client token)
@@ -470,9 +482,14 @@ class AuthNAsync(ServiceBaseAsync):
             logger_name: str = "pangea",
         ) -> None:
             super().__init__(token, config, logger_name=logger_name)
-            self.profile = AuthNAsync.UserAsync.ProfileAsync(token, config, logger_name=logger_name)
             self.authenticators = AuthNAsync.UserAsync.AuthenticatorsAsync(token, config, logger_name=logger_name)
             self.invites = AuthNAsync.UserAsync.InvitesAsync(token, config, logger_name=logger_name)
+            self.profile = AuthNAsync.UserAsync.ProfileAsync(token, config, logger_name=logger_name)
+
+        async def close(self) -> None:
+            await self.authenticators.close()
+            await self.invites.close()
+            await self.profile.close()
 
         async def create(
             self,
@@ -932,7 +949,7 @@ class AuthNAsync(ServiceBaseAsync):
                 return await self.request.post(
                     "v2/user/group/assign",
                     data={"id": user_id, "group_ids": group_ids},
-                    result_class=m.PangeaResponseResult,
+                    result_class=PangeaResponseResult,
                 )
 
             async def remove(self, user_id: str, group_id: str) -> PangeaResponse[PangeaResponseResult]:
@@ -946,7 +963,7 @@ class AuthNAsync(ServiceBaseAsync):
                 return await self.request.post(
                     "v2/user/group/remove",
                     data={"id": user_id, "group_id": group_id},
-                    result_class=m.PangeaResponseResult,
+                    result_class=PangeaResponseResult,
                 )
 
             async def list(self, user_id: str) -> PangeaResponse[m.GroupList]:

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/services/base.py

@@ -6,14 +6,20 @@
 
 from __future__ import annotations
 
+from types import TracebackType
 from typing import Dict, Optional, Type, Union
 
 from typing_extensions import override
 
+from pangea import PangeaResponse, PangeaResponseResult
+from pangea._typing import T
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.exceptions import AcceptedRequestException
-from pangea.response import AttachedFile, PangeaResponse, PangeaResponseResult
-from pangea.services.base import PangeaRequest, ServiceBase
+from pangea.request import PangeaRequest
+from pangea.response import AttachedFile
+from pangea.services.base import ServiceBase
+
+__all__ = ("ServiceBaseAsync",)
 
 
 class ServiceBaseAsync(ServiceBase):
@@ -85,8 +91,17 @@ class ServiceBaseAsync(ServiceBase):
         return await self.request.download_file(url=url, filename=filename)
 
     async def close(self):
+        """Close the underlying aiohttp client."""
+
         await self.request.session.close()
-        # Loop over all attributes to check if they are derived from ServiceBaseAsync and close them
-        for _, value in self.__dict__.items():
-            if issubclass(type(value), ServiceBaseAsync):
-                await value.close()
+
+    async def __aenter__(self: T) -> T:
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> None:
+        await self.close()

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/services/file_scan.py

@@ -11,9 +11,9 @@ import logging
 from typing import Dict, List, Optional, Tuple
 
 import pangea.services.file_scan as m
+from pangea import PangeaConfig
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.asyncio.services.base import ServiceBaseAsync
-from pangea.request import PangeaConfig
 from pangea.response import PangeaResponse, TransferMethod
 from pangea.utils import FileUploadParams, get_file_upload_params
 

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/asyncio/services/prompt_guard.py

@@ -12,6 +12,9 @@ if TYPE_CHECKING:
     from pangea.response import PangeaResponse
 
 
+__all__ = ("Message", "PromptGuardAsync")
+
+
 class PromptGuardAsync(ServiceBaseAsync):
     """Prompt Guard service client.
 

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/config.py

@@ -6,6 +6,8 @@ from typing import Any, Optional
 
 from pydantic import BaseModel, model_validator
 
+__all__ = ("PangeaConfig",)
+
 
 class PangeaConfig(BaseModel):
     """Holds run time configuration information used by SDK components."""
@@ -34,12 +36,12 @@ class PangeaConfig(BaseModel):
 
     request_backoff: float = 0.5
     """
-    Backoff strategy passed to 'requests'
+    A backoff factor to apply between request attempts.
     """
 
     request_timeout: int = 5
     """
-    Timeout used on initial request attempts
+    Unused.
     """
 
     poll_result_timeout: int = 30

{pangea_sdk-6.3.0 → pangea_sdk-6.5.0}/pangea/file_uploader.py

@@ -8,9 +8,12 @@ import io
 import logging
 from typing import Dict, Optional
 
-from pangea.request import PangeaConfig, PangeaRequest
+from pangea.config import PangeaConfig
+from pangea.request import PangeaRequest
 from pangea.response import TransferMethod
 
+__all__ = ("FileUploader",)
+
 
 class FileUploader:
     def __init__(self):