benchling-sdk 1.21.0__py3-none-any.whl → 1.21.1__py3-none-any.whl

benchling_sdk/apps/helpers/webhook_helpers.py

@@ -1,6 +1,6 @@
 import base64
 from datetime import datetime, timedelta, timezone
-from typing import Any, cast, List, Mapping, Optional, Protocol, Union
+from typing import cast, List, Optional, Protocol, Union
 
 from benchling_api_client.v2.benchling_client import BenchlingApiClient
 import httpx
@@ -12,6 +12,21 @@ from benchling_sdk.helpers.package_helpers import _required_packages_context, Ex
 from benchling_sdk.services.v2.stable.api_service import build_json_response
 
 
+class HeadersMapping(Protocol):
+    """
+    A general type for objects that represent request headers.
+    
+    This can be a dict, or any `Mapping[str, str]`, or an instance of a class like
+    Flask's Headers class which is dict-like to a limited degree.
+    """
+
+    def __contains__(self, key: str) -> bool:
+        pass
+
+    def __getitem__(self, key: str) -> str:
+        pass
+
+
 class WebhookVerificationError(Exception):
     """
     Webhook Verification Error.
@@ -146,7 +161,7 @@ def jwks_by_app_definition(
 
 
 def verify_app_installation(
-    app_id: str, data: str, headers: Mapping[str, Any], jwk_function: Optional[LegacyGetJwksFunction] = None
+    app_id: str, data: str, headers: HeadersMapping, jwk_function: Optional[LegacyGetJwksFunction] = None
 ) -> None:
     """
     Verify a webhook for an app installation (Deprecated).
@@ -165,7 +180,7 @@ def verify_app_installation(
 def verify(
     app_definition_id: str,
     data: str,
-    headers: Mapping[str, Any],
+    headers: HeadersMapping,
     jwk_function: Optional[GetJwksFunction] = None,
 ) -> None:
     """
@@ -174,6 +189,9 @@ def verify(
     Verifies that a webhook was a valid webhook from Benchling.
     Raises WebhookVerificationError if the webhook could not be verified.
     Resolves JWKs from Benchling with default settings. Pass jwk_function for customization.
+
+    The headers parameter can be a dict, or a dict-like object such as the Headers type
+    from Flask.
     """
     default_jwk_function: GetJwksFunction = jwks_by_app_definition
     _jwk_function: GetJwksFunction = default_jwk_function if jwk_function is None else jwk_function
@@ -201,7 +219,7 @@ def _has_valid_signature(to_verify: str, jwks: jwk.JWKSet, encoded_signatures: L
 def _verify(
     app_installation_or_definition_id: str,
     data: str,
-    headers: Mapping[str, Any],
+    headers: HeadersMapping,
     jwk_function: Union[GetJwksFunction, LegacyGetJwksFunction],
 ) -> None:
     _verify_headers_present(headers)
@@ -215,7 +233,7 @@ def _verify(
         raise WebhookVerificationError("No matching signature found")
 
 
-def _der_signatures_from_versioned_signatures(versioned_signatures: str) -> List[str]:
+def _der_signatures_from_versioned_signatures(versioned_signatures: List[str]) -> List[str]:
     """
     Parse and return a list of ders signatures from a single string.
 
@@ -231,7 +249,7 @@ def _der_signatures_from_versioned_signatures(versioned_signatures: str) -> List
     return der_signatures
 
 
-def _verify_headers_present(headers: Mapping[str, Any]) -> None:
+def _verify_headers_present(headers: HeadersMapping) -> None:
     """
     Verify Headers Present.
 

benchling_sdk/apps/status/framework.py

@@ -5,7 +5,7 @@ from contextlib import AbstractContextManager
 from types import TracebackType
 from typing import cast, Iterable, List, Optional, Protocol, Type, TYPE_CHECKING, Union
 
-from benchling_api_client.v2.stable.types import Unset, UNSET
+from benchling_api_client.v2.stable.types import UNSET, Unset
 
 from benchling_sdk.apps.status.errors import (
     AppUserFacingError,

benchling_sdk/helpers/serialization_helpers.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 from typing import Any, Dict, Iterable, Optional, Type, TypeVar, Union
 
-from benchling_api_client.v2.types import Unset, UNSET
+from benchling_api_client.v2.types import UNSET, Unset
 from dataclasses_json import DataClassJsonMixin
 
 from benchling_sdk.models import CustomFields, Field, Fields, SchemaFieldsQueryParam

{benchling_sdk-1.21.0.dist-info → benchling_sdk-1.21.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: benchling-sdk
-Version: 1.21.0
+Version: 1.21.1
 Summary: SDK for interacting with the Benchling Platform.
 License: Apache-2.0
 Author: Benchling Support

{benchling_sdk-1.21.0.dist-info → benchling_sdk-1.21.1.dist-info}/RECORD

@@ -16,10 +16,10 @@ benchling_sdk/apps/config/types.py,sha256=XKfSGv-75CU-j1XwfXBGq8zbtnkF-PQnuY6Z2U
 benchling_sdk/apps/framework.py,sha256=G15mv20FH7FLHJrnXMPcuFdUsP3Va-grvb5A4eq0Qlk,3175
 benchling_sdk/apps/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/helpers/manifest_helpers.py,sha256=yidiKA5mwWdAFR1ZSUu40QoG0Us-bc6V8tYHYqheEtM,945
-benchling_sdk/apps/helpers/webhook_helpers.py,sha256=TG1T76A6zI8EceoVE6E5hYG_hdZCmjRtsF6r0rG6fwo,10065
+benchling_sdk/apps/helpers/webhook_helpers.py,sha256=CLotJQYm6QfXjnzzkO193m_qHbS-TBEniCkICnLH2_w,10535
 benchling_sdk/apps/status/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 benchling_sdk/apps/status/errors.py,sha256=BezqnaHkCG1QBscD4301NjSYBHu7BzdYEUKF90psuz0,2377
-benchling_sdk/apps/status/framework.py,sha256=go0pyU5qgMCvsrTDXWk3V9FZwbaRHgfhEWtjIZ-JLEE,27418
+benchling_sdk/apps/status/framework.py,sha256=xbZ5jJxI62Wf0EehUhPDysv-Utag4sZoisGzqiMm-CM,27418
 benchling_sdk/apps/status/helpers.py,sha256=MSa2soRIK7TiA9TWAEg-EoqZ7ZYyjTmtJ28JIe6LUds,1316
 benchling_sdk/apps/status/types.py,sha256=vE7-_7ns3mvPRJoVv-GQxc3389dIIH4mcG0VDNWpVhQ,746
 benchling_sdk/apps/types.py,sha256=TBTfAB3IOoZjZqzTOK25kN3b6RTU9Z7tOMdBbq6u8lA,110
@@ -41,7 +41,7 @@ benchling_sdk/helpers/package_helpers.py,sha256=JLDDdlOwz6_BgP5j157u0qX-Mtb7ZkzX
 benchling_sdk/helpers/pagination_helpers.py,sha256=Dewy1OxAO0ZdJOGuEPyJGkjU8Hu8iFNWob-z0riMNOs,7745
 benchling_sdk/helpers/response_helpers.py,sha256=vtmb9lEEKy3dRFre3Q0R4XaLBEaS_rruxtwPvpepPUw,613
 benchling_sdk/helpers/retry_helpers.py,sha256=Sd7F8HMGPs31svYW-1z-SujbWUBn3qlZUk52hZ5G7xw,2814
-benchling_sdk/helpers/serialization_helpers.py,sha256=IUS0uGU_EiZvb8O-bTViUaROmxKcvdX3JeR9iKsWAG8,3662
+benchling_sdk/helpers/serialization_helpers.py,sha256=jpW7ydipBB1q4Ek1t9tWkTOul_E1QwtlzwTnBZp7LB4,3662
 benchling_sdk/helpers/task_helpers.py,sha256=4AgAR7JSlP3jb4egGTesxixzgsTbod6uJvdS0VIOppI,7349
 benchling_sdk/helpers/transaction_manager.py,sha256=HcSDsgGK7Rb93bgv6fpb4HvQUT-tqP0lXgVa_bWCDh4,3663
 benchling_sdk/models/__init__.py,sha256=4m3QBFbghDfeU3hAf3h-DELjhcH1MUtvc0kJyGRG-q0,372428
@@ -120,7 +120,7 @@ benchling_sdk/services/v2/v2_alpha_service.py,sha256=rl4niKxjU-Rvdx5W6cjyXd4rUMo
 benchling_sdk/services/v2/v2_beta_service.py,sha256=SEv2AsZG0phf_B4ORqjRO-3VBkYehu1hlUhRFHrpX3c,6093
 benchling_sdk/services/v2/v2_stable_service.py,sha256=21TzqEFHygMUFv0z0z8_MtXpSHLgwYC7YbIIsHrljaw,28232
 benchling_sdk/services/v2_service.py,sha256=cGX-Ps0hu7Oh1M7a0tu2zDN8-QG63dNDoK7w4eYo_OQ,3093
-benchling_sdk-1.21.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-benchling_sdk-1.21.0.dist-info/METADATA,sha256=kZHp9f3LPEHGoTEM2OddcOE_eQPyZfIQ5mvSnltbkCM,2058
-benchling_sdk-1.21.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-benchling_sdk-1.21.0.dist-info/RECORD,,
+benchling_sdk-1.21.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+benchling_sdk-1.21.1.dist-info/METADATA,sha256=JGAaM4hofzaehnL0qmWd3_dZA3dHjKjS79reu0pZKRI,2058
+benchling_sdk-1.21.1.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+benchling_sdk-1.21.1.dist-info/RECORD,,