pangea-sdk 6.2.0b1__py3-none-any.whl → 6.2.0b2__py3-none-any.whl

pangea/services/audit/signing.py

@@ -81,7 +81,7 @@ class Signer:
                 with open(self.private_key_file, "rb") as file:
                     file_bytes = file.read()
             except FileNotFoundError:
-                raise Exception(f"Error: Failed opening private key file {self.private_key_file}")
+                raise Exception(f"Error: Failed opening private key file {self.private_key_file}") from None
 
             privkey = self._decode_private_key(file_bytes)
             for cls, signer in signers.items():

pangea/services/audit/util.py

@@ -1,5 +1,11 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Modernize.
+# ruff: noqa: UP006, UP035
+
+from __future__ import annotations
+
 import base64
 import json
 import logging
@@ -155,9 +161,9 @@ def verify_membership_proof(node_hash: Hash, root_hash: Hash, proof: MembershipP
 def normalize_log(data: dict) -> dict:
     ans = {}
     for key in data:
-        if type(data[key]) == datetime:
+        if isinstance(data[key], datetime):
             ans[key] = format_datetime(data[key])
-        elif type(data[key]) == dict:
+        elif isinstance(data[key], dict):
             ans[key] = normalize_log(data[key])  # type: ignore[assignment]
         else:
             ans[key] = data[key]
@@ -223,9 +229,7 @@ def get_arweave_published_roots(tree_name: str, tree_sizes: Collection[int]) ->
             }
         }
     }
-    """.replace(
-        "{tree_sizes}", ", ".join(f'"{tree_size}"' for tree_size in tree_sizes)
-    ).replace(
+    """.replace("{tree_sizes}", ", ".join(f'"{tree_size}"' for tree_size in tree_sizes)).replace(
         "{tree_name}", tree_name
     )
 
@@ -273,8 +277,4 @@ def verify_consistency_proof(new_root: Hash, prev_root: Hash, proof: Consistency
         return False
 
     logger.debug("Verifying the proofs for the new root")
-    for item in proof:
-        if not verify_membership_proof(item.node_hash, new_root, item.proof):
-            return False
-
-    return True
+    return all(verify_membership_proof(item.node_hash, new_root, item.proof) for item in proof)

pangea/services/authn/authn.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Modernize.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 from typing import Dict, List, Literal, Optional, Union
@@ -128,7 +132,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of sessions in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/session/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/session/list-post).
 
             Examples:
                 response = authn.session.list()
@@ -192,7 +196,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with credentials for a login session in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/client/userinfo).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/client/userinfo-post).
 
             Examples:
                 response = authn.client.userinfo(
@@ -217,7 +221,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with jwt verification keys in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/jwt#/v2/client/jwks).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/jwt#/v2/client/jwks-post).
 
             Examples:
                 response = authn.client.jwks()
@@ -290,7 +294,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of sessions in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/list-post).
 
                 Examples:
                     response = authn.client.session.list(
@@ -349,7 +353,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with credentials for a login session in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/refresh).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/session#/v2/client/session/refresh-post).
 
                 Examples:
                     response = authn.client.session.refresh(
@@ -447,7 +451,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a token and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/client/token/check).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/client/token/check-post).
 
                 Examples:
                     response = authn.client.token_endpoints.check(
@@ -496,7 +500,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/create).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/create-post).
 
             Examples:
                 response = authn.user.create(
@@ -561,7 +565,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a pending user invitation in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite-post).
 
             Examples:
                 response = authn.user.invite(
@@ -606,7 +610,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a user and its information in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/update-post).
 
             Examples:
                 response = authn.user.update(
@@ -649,7 +653,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of users in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/list-post).
 
             Examples:
                 response = authn.user.list()
@@ -703,7 +707,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of pending user invitations in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/invite#/v2/user/invite/list-post).
                 Examples:
                     response = authn.user.invites.list()
                 """
@@ -807,7 +811,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a list of authenticators in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/authenticators/list).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/authenticators/list-post).
 
                 Examples:
                     response = authn.user.authenticators.list(
@@ -850,7 +854,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/get).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/get-post).
 
                 Examples:
                     response = authn.user.profile.get(
@@ -886,7 +890,7 @@ class AuthN(ServiceBase):
                 Returns:
                     A PangeaResponse with a user and its information in the response.result field.
                         Available response fields can be found in our
-                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/update).
+                        [API Documentation](https://pangea.cloud/docs/api/authn/user#/v2/user/profile/update-post).
 
                 Examples:
                     response = authn.user.profile.update(
@@ -980,7 +984,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with credentials for a login session in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/complete).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/complete-post).
 
             Examples:
                 response = authn.flow.complete(
@@ -991,7 +995,10 @@ class AuthN(ServiceBase):
             return self.request.post("v2/flow/complete", m.FlowCompleteResult, data=input.model_dump(exclude_none=True))
 
         def restart(
-            self, flow_id: str, choice: m.FlowChoice, data: m.FlowRestartData = {}
+            self,
+            flow_id: str,
+            choice: m.FlowChoice,
+            data: m.FlowRestartData = {},  # noqa: B006
         ) -> PangeaResponse[m.FlowRestartResult]:
             """
             Restart a sign-up/sign-in flow
@@ -1009,7 +1016,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/restart).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/restart-post).
 
             Examples:
                 response = authn.flow.restart(
@@ -1046,7 +1053,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/start).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/start-post).
 
             Examples:
                 response = authn.flow.start(
@@ -1062,7 +1069,10 @@ class AuthN(ServiceBase):
             return self.request.post("v2/flow/start", m.FlowStartResult, data=input.model_dump(exclude_none=True))
 
         def update(
-            self, flow_id: str, choice: m.FlowChoice, data: m.FlowUpdateData = {}
+            self,
+            flow_id: str,
+            choice: m.FlowChoice,
+            data: m.FlowUpdateData = {},  # noqa: B006
         ) -> PangeaResponse[m.FlowUpdateResult]:
             """
             Update a sign-up/sign-in flow
@@ -1080,7 +1090,7 @@ class AuthN(ServiceBase):
                 A PangeaResponse with information about next steps needed
                     to complete a flow in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/flow#/v2/flow/update-post).
 
             Examples:
                 response = authn.flow.update(
@@ -1125,7 +1135,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a EULA object in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/create).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/create-post).
 
             Examples:
                 response = authn.agreements.create(
@@ -1192,7 +1202,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with a list of EULA objects in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/list).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/list-post).
 
             Examples:
                 response = authn.agreements.list()
@@ -1231,7 +1241,7 @@ class AuthN(ServiceBase):
             Returns:
                 A PangeaResponse with the updated EULA object in the response.result field.
                     Available response fields can be found in our
-                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/update).
+                    [API Documentation](https://pangea.cloud/docs/api/authn/agreements#/v2/agreements/update-post).
 
             Examples:
                 response = authn.agreements.update(

pangea/services/authn/models.py

@@ -1,6 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
 
+# TODO: Modernize.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum

pangea/services/authz.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum
@@ -243,7 +247,7 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with empty result.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/create).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/create-post).
 
         Examples:
             response = authz.tuple_create(
@@ -287,7 +291,7 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with a list of tuples and the last token.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/list).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/list-post).
 
         Examples:
             authz.tuple_list(TupleListFilter(subject_type="user", subject_id="user_1"))
@@ -311,7 +315,7 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with empty result.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/delete).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/delete-post).
 
         Examples:
             response = authz.tuple_delete(
@@ -353,7 +357,7 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with the result of the check.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/check).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/check-post).
 
         Examples:
             response = authz.check(
@@ -387,7 +391,7 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with a list of resource IDs.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-resources).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-resources-post).
 
         Examples:
             authz.list_resources(
@@ -422,7 +426,7 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with a list of subjects.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-subjects).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-subjects-post).
 
         Examples:
             response = authz.list_subjects(

pangea/services/base.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Modernize.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import copy
@@ -17,7 +21,7 @@ from pangea.response import AttachedFile, PangeaResponse, PangeaResponseResult
 TResult = TypeVar("TResult", bound=PangeaResponseResult, default=PangeaResponseResult)
 
 
-class ServiceBase(object):
+class ServiceBase:
     service_name: str = "base"
 
     def __init__(

pangea/services/embargo.py

@@ -1,5 +1,11 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
+from __future__ import annotations
+
 from typing import Any, Dict, List
 
 from pangea.response import APIRequestModel, APIResponseModel, PangeaResponse, PangeaResponseResult

pangea/services/file_scan.py

@@ -1,5 +1,11 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
+from __future__ import annotations
+
 import io
 import logging
 from typing import Dict, List, Optional, Tuple
@@ -52,7 +58,7 @@ class FileScan(ServiceBase):
     """FileScan service client.
 
     Provides methods to interact with Pangea FileScan Service:
-        https://pangea.cloud/docs/api/embargo
+        https://pangea.cloud/docs/api/file-scan
 
     The following information is needed:
         PANGEA_TOKEN - service token which can be found on the Pangea User
@@ -133,7 +139,7 @@ class FileScan(ServiceBase):
         files: Optional[List[Tuple]] = None
         if file or file_path:
             if file_path:
-                file = open(file_path, "rb")
+                file = open(file_path, "rb")  # noqa: SIM115
             if transfer_method == TransferMethod.POST_URL:
                 params = get_file_upload_params(file)  # type: ignore[arg-type]
                 crc = params.crc_hex

pangea/services/intel.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum

pangea/services/management.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Sequence
-from typing import List, Literal, Optional, Union, overload
+from typing import Literal, Optional, Union, overload
 
 from pydantic import Field
 
@@ -57,7 +57,7 @@ class ListProjectsFilter(APIRequestModel):
 
 
 class ListProjectsResult(PangeaResponseResult):
-    results: List[Project]
+    results: list[Project]
     """A list of projects"""
 
     count: int
@@ -82,11 +82,11 @@ class AccessClientInfo(PangeaResponseResult):
     """A list of space separated scope"""
     token_endpoint_auth_method: AccessClientTokenAuth
     """The authentication method for the token endpoint."""
-    redirect_uris: List[str]
+    redirect_uris: list[str]
     """A list of allowed redirect URIs for the client."""
-    grant_types: List[str]
+    grant_types: list[str]
     """A list of OAuth grant types that the client can use."""
-    response_types: List[Optional[str]]
+    response_types: list[Optional[str]]
     """A list of OAuth response types that the client can use."""
     client_token_expires_in: Optional[int] = None
     """A positive time duration in seconds or null"""
@@ -124,7 +124,7 @@ class AccessRole(PangeaResponseResult):
 
 
 class AccessClientListResult(PangeaResponseResult):
-    clients: List[AccessClientInfo]
+    clients: list[AccessClientInfo]
     count: int
     last: Optional[str] = None
 
@@ -163,13 +163,13 @@ class AccessClientSecretInfoWithMetadata(PangeaResponseResult):
 
 
 class AccessClientSecretInfoListResult(PangeaResponseResult):
-    client_secrets: List[AccessClientSecretInfoWithMetadata] = Field(alias="client-secrets")
+    client_secrets: list[AccessClientSecretInfoWithMetadata] = Field(alias="client-secrets")
     count: int
     last: Optional[str] = None
 
 
 class AccessRolesListResult(PangeaResponseResult):
-    roles: List[AccessRole]
+    roles: list[AccessRole]
     count: int
     last: Optional[str] = None