benchling-sdk 1.21.0__tar.gz → 1.21.1__tar.gz

{benchling_sdk-1.21.0 → benchling_sdk-1.21.1}/PKG-INFO

@@ -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 → benchling_sdk-1.21.1}/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-1.21.0 → benchling_sdk-1.21.1}/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-1.21.0 → benchling_sdk-1.21.1}/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 → benchling_sdk-1.21.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "benchling-sdk"
-version = "1.21.0"   # NOTE: This version number is ignored and does not correspond to releases (see README)
+version = "1.21.1"   # NOTE: This version number is ignored and does not correspond to releases (see README)
 description = "SDK for interacting with the Benchling Platform."
 authors = ["Benchling Support <support@benchling.com>"]
 packages = [{include = "benchling_sdk"}]
@@ -44,19 +44,16 @@ cryptography = ["cryptography"]
 python-jose = ["python-jose"]
 
 [tool.poetry.group.dev.dependencies]
-black = "^22.3.0"
-isort = "^5.10.1"
 pre-commit = "^2.6.0"
 ipython = "^7.16.1"
 mypy = "^1.13"
-flake8 = "^3.8.3"
+ruff = "^0.7.3"
 taskipy = "^1.6.0"
 Jinja2 = "^3.1.2"
 Markdown = "3.3.4" # Errors in Markdown 3.3.5 related to TypeError: entry_points() got an unexpected keyword argument 'group'
 toml = "^0.10.2"
 packaging = "^20.9"
 coverage = "^5.5"
-flake8-docstrings = "^1.6.0"
 ddt = "1.4.4"
 pytest = "^7.1.2"
 beautifulsoup4 = "4.10.0"
@@ -67,8 +64,6 @@ boto3 = "^1.24.67"
 boto3-stubs = {extras = ["ssm"], version = "1.24.67"}
 types-s3transfer = "0.6.0.post4"
 botocore-stubs = "1.28.4"
-# Used by flake8, version pinning is because v5 removes a deprecated call flake is currently using.
-importlib-metadata = "^4.13.0"
 sphinx-multiversion-pre-post-build = "^0.2.4"
 time-machine = "^2.15.0"  # change to >=2.15.0 once we drop Python 3.8 support
 python-jose = "^3.3.0"
@@ -81,29 +76,92 @@ unit = "pytest -s tests/unit/"
 integration = "pytest -vv --reruns 3 --reruns-delay 1 -s tests/integration/"
 # Separate than unit tests because they intentionally take awhile but still mock Benchling
 retry_strategy_tests = "pytest -vv --reruns 3 --reruns-delay 1 -s tests/retries/"
+format = "ruff check . --fix"
+lint = "ruff check . && mypy ."
 models = "task generate_models && task sort_models && task format_models"
 generate_models = "python3 -m regenerate_models"
 format_models = "black benchling_sdk/models"
-sort_models = "isort benchling_sdk/models"
+sort_models = "ruff check benchling_sdk/models --fix"
 regenerate_docs = "./scripts/regenerate_docs.sh"
 regenerate_doc_sources = "sphinx-apidoc --module-first -H benchling-sdk -e -f -o sphinx/source . tests* regenerate* > stdout.log 2> stderr.log"
 check_docs = "python3 -m regenerate_docs --check"
 
-[tool.black]
-line-length=110
+[tool.ruff]
+target-version = "py39"
+line-length = 110
+exclude = [
+    ".git",
+    ".mypy_cache",
+    ".venv",
+]
+
+[tool.ruff.lint]
+select = ["D", "E", "F", "I", "UP", "B", "PL", "RUF"]
+ignore = [
+    "D100",  # don't require docstring for modules
+    "D104",  # don't require docstring for public packages
+    "D105",  # don't require docstring for magic methods
+    "D203",  # don't require blank line before class docstring
+    "D211",  # no-blank-line-before-class
+    "D212",  # multi-line-summary-first-line
+    "D213",  # multi-line-summary-second-line
+    "D413",  # don't require blank line after docstring section
+
+    "E501",
+    "PLR0913",
+    "PLR2004",
+
+    # rules that we can unignore once we've made some code updates:
+    "B006",
+    "B007",
+    "B008",
+    "B009",
+    "B010",
+    "B018",
+    "B028",
+    "B904",
+    "E721",
+    "E731",
+    "PLR0911",
+    "PLW2901",
+    "RUF002",
+    "RUF005",
+    "RUF012",
+    "RUF019",
+    "RUF100",
+    "UP004",
+    "UP006",
+    "UP007",
+    "UP012",
+    "UP015",
+    "UP018",
+    "UP033",
+    "UP037",
+    "UP035",
+]
+
+[tool.ruff.lint.isort]
+combine-as-imports=true
+default-section="third-party"
+force-sort-within-sections=true
+known-first-party=["benchling_sdk"]
+known-third-party=["attr", "backoff", "benchling_api_client", "benchling_jira_api", "boto3", "bs4", "cryptography", "dataclasses_json", "httpx", "jinja2", "jose", "jwcrypto", "ordered_set", "pytest", "time_machine", "util", "yaml"]
+order-by-type=false
 
-[tool.isort]
-combine_as_imports=true
-default_section="THIRDPARTY"
-force_alphabetical_sort_within_sections=true
-force_sort_within_sections=true
-include_trailing_comma=true
-known_first_party=["benchling_sdk"]
-known_third_party=["attr", "backoff", "benchling_api_client", "benchling_jira_api", "boto3", "bs4", "cryptography", "dataclasses_json", "httpx", "jinja2", "jose", "jwcrypto", "ordered_set", "pytest", "time_machine", "util", "yaml"]
-line_length=110
-multi_line_output=3
-order_by_type=false
-skip = ["tests/packaged/run_smoke_test.py"]
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "D100", "D101", "D102", "D104", "D106", "D107",  # missing docstrings
+    "PLR2004",
+]
+"tests/packaged/run_smoke_test.py" = [
+    "D103",  # missing docstrings
+]
+# Ignore imperative mood for some class docstrings
+"benchling_sdk/benchling.py" = ["D401"]
+"benchling_sdk/services/v2/v2_stable_service.py" = ["D401"]
+"benchling_sdk/services/v2/stable/assay_run_service.py" = ["D401"]
+# Scripts that aren't published
+"regenerate_docs.py" = [ "D103", "D205", "D400", "D415" ]
 
 [build-system]
 requires = ["poetry>=1.2"]