splunk-soar-sdk 3.3.2__py3-none-any.whl → 3.5.0__py3-none-any.whl

soar_sdk/abstract.py

@@ -1,14 +1,15 @@
 from abc import abstractmethod
+from collections.abc import AsyncIterable, Iterable, Mapping
 from typing import Any, Generic, TypeVar
-from collections.abc import Mapping, Iterable, AsyncIterable
 
-from soar_sdk.apis.vault import Vault
-from soar_sdk.apis.artifact import Artifact
-from soar_sdk.apis.container import Container
-from soar_sdk.action_results import ActionOutput
 import httpx
-from pydantic.dataclasses import dataclass
 from pydantic import field_validator
+from pydantic.dataclasses import dataclass
+
+from soar_sdk.action_results import ActionOutput
+from soar_sdk.apis.artifact import Artifact
+from soar_sdk.apis.container import Container
+from soar_sdk.apis.vault import Vault
 
 JSONType = dict[str, Any] | list[Any] | str | int | float | bool | None
 SummaryType = TypeVar("SummaryType", bound=ActionOutput)

soar_sdk/action_results.py

@@ -1,15 +1,15 @@
-from typing import Union, get_origin, get_args, Any
-from collections.abc import Iterator
-from typing_extensions import TypedDict
-from typing import NotRequired
-from pydantic import BaseModel, Field, ConfigDict
 import itertools
 import types
+from collections.abc import Iterator
+from typing import Any, NotRequired, Union, get_args, get_origin
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import TypedDict
 
 from soar_sdk.compat import remove_when_soar_newer_than
-from soar_sdk.shims.phantom.action_result import ActionResult as PhantomActionResult
-from soar_sdk.meta.datatypes import as_datatype
 from soar_sdk.field_utils import parse_json_schema_extra
+from soar_sdk.meta.datatypes import as_datatype
+from soar_sdk.shims.phantom.action_result import ActionResult as PhantomActionResult
 
 remove_when_soar_newer_than(
     "7.0.0", "NotRequired from typing_extensions is in typing in Python 3.11+"

soar_sdk/actions_manager.py

@@ -1,17 +1,17 @@
-from typing import Any
 import os
 from pathlib import Path
+from typing import Any
+
+from pydantic import ValidationError
 
 from soar_sdk.compat import remove_when_soar_newer_than
 from soar_sdk.input_spec import InputSpecification
-from soar_sdk.shims.phantom.base_connector import BaseConnector
-
+from soar_sdk.logging import getLogger
 from soar_sdk.meta.actions import ActionMeta
-from soar_sdk.types import Action
-from pydantic import ValidationError
 from soar_sdk.shims.phantom.action_result import ActionResult as PhantomActionResult
+from soar_sdk.shims.phantom.base_connector import BaseConnector
 from soar_sdk.shims.phantom.install_info import is_onprem_broker_install
-from soar_sdk.logging import getLogger
+from soar_sdk.types import Action
 
 logger = getLogger()
 

soar_sdk/apis/artifact.py

@@ -1,11 +1,11 @@
 import json
 from typing import TYPE_CHECKING
 
-from soar_sdk.exceptions import ActionFailure, SoarAPIError
-from soar_sdk.shims.phantom.json_keys import json_keys as ph_jsons
-from soar_sdk.shims.phantom.consts import consts as ph_consts
 from soar_sdk.apis.utils import is_client_authenticated
+from soar_sdk.exceptions import ActionFailure, SoarAPIError
 from soar_sdk.logging import getLogger
+from soar_sdk.shims.phantom.consts import consts as ph_consts
+from soar_sdk.shims.phantom.json_keys import json_keys as ph_jsons
 
 if TYPE_CHECKING:
     from soar_sdk.abstract import SOARClient

soar_sdk/apis/container.py

@@ -1,10 +1,10 @@
 import json
 from typing import TYPE_CHECKING
 
-from soar_sdk.shims.phantom.json_keys import json_keys as ph_jsons
+from soar_sdk.apis.utils import is_client_authenticated
 from soar_sdk.exceptions import ActionFailure, SoarAPIError
 from soar_sdk.logging import getLogger
-from soar_sdk.apis.utils import is_client_authenticated
+from soar_sdk.shims.phantom.json_keys import json_keys as ph_jsons
 
 if TYPE_CHECKING:
     from soar_sdk.abstract import SOARClient

soar_sdk/apis/utils.py

@@ -1,6 +1,7 @@
-import httpx
-from typing import Any
 from collections.abc import Generator
+from typing import Any
+
+import httpx
 
 
 def is_client_authenticated(client: httpx.Client) -> bool:

soar_sdk/apis/vault.py

@@ -1,4 +1,5 @@
 from typing import TYPE_CHECKING
+
 from soar_sdk.models.vault_attachment import VaultAttachment
 from soar_sdk.shims.phantom.vault import PhantomVault, VaultBase
 

soar_sdk/app.py

@@ -1,48 +1,45 @@
 import importlib.util
 import inspect
 import json
-from pathlib import Path
 import sys
+import uuid
+from collections.abc import Callable, Iterator
+from pathlib import Path
 from typing import Any
-from collections.abc import Callable
-from collections.abc import Iterator
 from zoneinfo import ZoneInfo
 
+from soar_sdk.abstract import SOARClient, SOARClientAuth
+from soar_sdk.action_results import ActionOutput, ActionResult
+from soar_sdk.actions_manager import ActionsManager
+from soar_sdk.app_cli_runner import AppCliRunner
+from soar_sdk.app_client import AppClient
 from soar_sdk.asset import BaseAsset
-from soar_sdk.input_spec import InputSpecification
+from soar_sdk.asset_state import AssetState
 from soar_sdk.compat import (
     MIN_PHANTOM_VERSION,
     PythonVersion,
 )
+from soar_sdk.decorators import (
+    ActionDecorator,
+    ConnectivityTestDecorator,
+    MakeRequestDecorator,
+    OnESPollDecorator,
+    OnPollDecorator,
+    ViewHandlerDecorator,
+    WebhookDecorator,
+)
+from soar_sdk.exceptions import ActionRegistrationError
+from soar_sdk.input_spec import InputSpecification
+from soar_sdk.logging import getLogger
+from soar_sdk.meta.webhooks import WebhookMeta
+from soar_sdk.params import Params
 from soar_sdk.shims.phantom_common.app_interface.app_interface import SoarRestClient
 from soar_sdk.shims.phantom_common.encryption.encryption_manager_factory import (
     platform_encryption_backend,
 )
-from soar_sdk.abstract import SOARClient, SOARClientAuth
-from soar_sdk.action_results import ActionResult
-from soar_sdk.actions_manager import ActionsManager
-from soar_sdk.app_cli_runner import AppCliRunner
-from soar_sdk.meta.webhooks import WebhookMeta
-from soar_sdk.params import Params
-from soar_sdk.app_client import AppClient
-from soar_sdk.action_results import ActionOutput
-from soar_sdk.logging import getLogger
 from soar_sdk.types import Action
-from soar_sdk.webhooks.routing import Router
 from soar_sdk.webhooks.models import WebhookRequest, WebhookResponse
-from soar_sdk.exceptions import ActionRegistrationError
-from soar_sdk.asset_state import AssetState
-
-import uuid
-from soar_sdk.decorators import (
-    ConnectivityTestDecorator,
-    ActionDecorator,
-    ViewHandlerDecorator,
-    OnPollDecorator,
-    OnESPollDecorator,
-    WebhookDecorator,
-    MakeRequestDecorator,
-)
+from soar_sdk.webhooks.routing import Router
 
 
 def is_valid_uuid(value: str) -> bool:

soar_sdk/app_cli_runner.py

@@ -1,22 +1,23 @@
 import argparse
 import inspect
 import json
-from pathlib import Path
+import os
 import typing
+from pathlib import Path
 from typing import Any
-import os
+from urllib.parse import parse_qs, urlparse
+
 from pydantic import ValidationError
-from urllib.parse import urlparse, parse_qs
 
+from soar_sdk.abstract import SOARClientAuth
 from soar_sdk.input_spec import ActionParameter, AppConfig, InputSpecification, SoarAuth
+from soar_sdk.logging import PhantomLogger
+from soar_sdk.shims.phantom_common.app_interface.app_interface import SoarRestClient
 from soar_sdk.shims.phantom_common.encryption.encryption_manager_factory import (
     platform_encryption_backend,
 )
 from soar_sdk.types import Action
 from soar_sdk.webhooks.models import WebhookRequest
-from soar_sdk.logging import PhantomLogger
-from soar_sdk.shims.phantom_common.app_interface.app_interface import SoarRestClient
-from soar_sdk.abstract import SOARClientAuth
 
 if typing.TYPE_CHECKING:
     from .app import App

soar_sdk/app_client.py

@@ -1,15 +1,14 @@
-from dataclasses import dataclass
-from typing import Any, TYPE_CHECKING
 from collections.abc import Mapping
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Any
 
 import httpx
 
+from soar_sdk.abstract import SOARClient, SOARClientAuth, SummaryType
 from soar_sdk.apis.artifact import Artifact
 from soar_sdk.apis.container import Container
 from soar_sdk.apis.vault import Vault
 
-from soar_sdk.abstract import SOARClient, SOARClientAuth, SummaryType
-
 if TYPE_CHECKING:
     pass
 

soar_sdk/asset.py

@@ -1,18 +1,16 @@
-from typing import Any
+from typing import Any, NotRequired
 from zoneinfo import ZoneInfo
-from pydantic import BaseModel, model_validator, ConfigDict, Field
-from pydantic_core import PydanticUndefined
 
+from pydantic import BaseModel, ConfigDict, Field, model_validator
+from pydantic_core import PydanticUndefined
 from typing_extensions import TypedDict
-from typing import NotRequired
-
 
-from soar_sdk.compat import remove_when_soar_newer_than
-from soar_sdk.meta.datatypes import as_datatype
-from soar_sdk.input_spec import AppConfig
-from soar_sdk.field_utils import parse_json_schema_extra
 from soar_sdk.asset_state import AssetState
+from soar_sdk.compat import remove_when_soar_newer_than
 from soar_sdk.exceptions import AppContextRequired
+from soar_sdk.field_utils import parse_json_schema_extra
+from soar_sdk.input_spec import AppConfig
+from soar_sdk.meta.datatypes import as_datatype
 
 remove_when_soar_newer_than(
     "7.0.0", "NotRequired from typing_extensions is in typing in Python 3.11+"

soar_sdk/asset_state.py

@@ -1,10 +1,9 @@
 import json
-from collections.abc import MutableMapping, Iterator
+from collections.abc import Iterator, MutableMapping
 
 from soar_sdk.shims.phantom.base_connector import BaseConnector
 from soar_sdk.shims.phantom.encryption_helper import encryption_helper
 
-
 AssetStateKeyType = str
 AssetStateValueType = str | bool | int | float | None
 AssetStateType = dict[AssetStateKeyType, AssetStateValueType]

soar_sdk/async_utils.py

@@ -1,8 +1,7 @@
 import asyncio
 import inspect
-from typing import Any, TypeVar, overload
 from collections.abc import AsyncGenerator, Coroutine
-
+from typing import Any, TypeVar, overload
 
 T = TypeVar("T")
 

soar_sdk/cli/cli.py

@@ -1,11 +1,11 @@
 import typer
 
 from soar_sdk import __version__
-from soar_sdk.paths import SDK_ROOT
+from soar_sdk.cli.init.cli import convert, init
 from soar_sdk.cli.manifests.cli import manifests
 from soar_sdk.cli.package.cli import package
-from soar_sdk.cli.init.cli import init, convert
 from soar_sdk.cli.test.cli import test
+from soar_sdk.paths import SDK_ROOT
 
 CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
 HELP = """A command-line tool for helping with SOAR Apps development"""

soar_sdk/cli/init/cli.py

@@ -1,19 +1,19 @@
-from typing import Annotated, cast
+import ast
 import datetime
 import json
 import os
-from pathlib import Path
 import re
 import shutil
 import subprocess
 import uuid
-import ast
+from pathlib import Path
+from typing import Annotated, cast
 
 import typer
-from rich.console import Console
-from rich.panel import Panel
 from rich import print as rprint
+from rich.console import Console
 from rich.markup import escape as rescape
+from rich.panel import Panel
 
 from soar_sdk.cli.manifests.deserializers import AppMetaDeserializer
 from soar_sdk.cli.utils import normalize_field_name

soar_sdk/cli/manifests/deserializers.py

@@ -2,15 +2,16 @@ import dataclasses
 import json
 from pathlib import Path
 from typing import Any, NamedTuple, TypeVar, cast
+
 import pydantic
 
-from soar_sdk.action_results import ActionOutput, OutputFieldSpecification, OutputField
-from soar_sdk.cli.utils import normalize_field_name, NormalizationResult
+from soar_sdk.action_results import ActionOutput, OutputField, OutputFieldSpecification
+from soar_sdk.cli.utils import NormalizationResult, normalize_field_name
 from soar_sdk.compat import remove_when_soar_newer_than
 from soar_sdk.meta.actions import ActionMeta
 from soar_sdk.meta.app import AppMeta
-from soar_sdk.params import Params, Param
 from soar_sdk.meta.datatypes import to_python_type
+from soar_sdk.params import Param, Params
 
 
 class DeserializedAppMeta(NamedTuple):

soar_sdk/cli/manifests/processors.py

@@ -1,10 +1,10 @@
 import importlib
 import json
-import toml
-from datetime import datetime, UTC
+from datetime import UTC, datetime
 from pathlib import Path
 from pprint import pprint
 
+import toml
 from packaging.specifiers import SpecifierSet
 
 from soar_sdk.app import App

soar_sdk/cli/manifests/serializers.py

@@ -1,12 +1,12 @@
-from typing import Any
+import itertools
 from collections.abc import Iterator
 from logging import getLogger
-import itertools
+from typing import Any
 
-from soar_sdk.meta.datatypes import as_datatype
-from soar_sdk.params import Params
 from soar_sdk.action_results import ActionOutput, OutputFieldSpecification
 from soar_sdk.field_utils import parse_json_schema_extra
+from soar_sdk.meta.datatypes import as_datatype
+from soar_sdk.params import Params
 
 logger = getLogger(__name__)
 

soar_sdk/cli/package/cli.py

@@ -1,27 +1,27 @@
+import asyncio
 import contextlib
-from datetime import timedelta
-import humanize
-import typer
-
+import json
+import os
 import tarfile
+import time
+from datetime import timedelta
 from io import BytesIO
-import json
+from itertools import chain
 from pathlib import Path
-import asyncio
-import time
 from typing import Annotated
-from tqdm import tqdm
+
+import httpx
+import humanize
+import typer
 from rich.console import Console
 from rich.panel import Panel
+from tqdm import tqdm
 
 from soar_sdk.cli.manifests.processors import ManifestProcessor
-from soar_sdk.meta.dependencies import DependencyWheel
-from soar_sdk.cli.path_utils import context_directory
 from soar_sdk.cli.package.utils import phantom_get_login_session, phantom_install_app
-from soar_sdk.paths import SDK_TEMPLATES, APP_TEMPLATES
-from itertools import chain
-import os
-import httpx
+from soar_sdk.cli.path_utils import context_directory
+from soar_sdk.meta.dependencies import DependencyWheel
+from soar_sdk.paths import APP_TEMPLATES, SDK_TEMPLATES
 
 package = typer.Typer()
 console = Console()  # For printing lots of pretty colors and stuff

soar_sdk/cli/package/utils.py

@@ -1,6 +1,7 @@
-import httpx
-from contextlib import asynccontextmanager
 from collections.abc import AsyncGenerator
+from contextlib import asynccontextmanager
+
+import httpx
 
 
 @asynccontextmanager

soar_sdk/cli/path_utils.py

@@ -1,8 +1,8 @@
 import os
 import sys
+from collections.abc import Iterator
 from contextlib import contextmanager
 from pathlib import Path
-from collections.abc import Iterator
 
 
 @contextmanager

soar_sdk/code_renderers/action_renderer.py

@@ -1,15 +1,16 @@
-from typing import ClassVar
-from collections.abc import Iterator
-import typing
 import ast
+import typing
+from collections.abc import Iterator
+from typing import ClassVar
+
 from pydantic_core import PydanticUndefined
 
 from soar_sdk.action_results import ActionOutput
 from soar_sdk.cli.utils import normalize_field_name
 from soar_sdk.code_renderers.renderer import AstRenderer
+from soar_sdk.field_utils import parse_json_schema_extra
 from soar_sdk.meta.actions import ActionMeta
 from soar_sdk.params import Params
-from soar_sdk.field_utils import parse_json_schema_extra
 
 
 class ActionRenderer(AstRenderer[ActionMeta]):

soar_sdk/code_renderers/app_renderer.py

@@ -1,5 +1,5 @@
-import dataclasses
 import ast
+import dataclasses
 from collections.abc import Iterator
 
 

soar_sdk/code_renderers/asset_renderer.py

@@ -1,5 +1,5 @@
-import dataclasses
 import ast
+import dataclasses
 from collections.abc import Iterator
 
 from soar_sdk.code_renderers.renderer import AstRenderer

soar_sdk/code_renderers/renderer.py

@@ -1,9 +1,9 @@
 import abc
-from typing import TypeVar, Generic
-import jinja2 as j2
 import ast
 from collections.abc import Iterator
+from typing import Generic, TypeVar
 
+import jinja2 as j2
 
 ContextT = TypeVar("ContextT")
 

soar_sdk/compat.py

@@ -1,5 +1,6 @@
-from enum import Enum
 import functools
+from enum import Enum
+
 from packaging.version import Version
 
 MIN_PHANTOM_VERSION = "7.0.0"

soar_sdk/decorators/__init__.py

@@ -1,12 +1,12 @@
 """This module provides class-based decorators for SOAR app development."""
 
 from .action import ActionDecorator
+from .make_request import MakeRequestDecorator
+from .on_es_poll import OnESPollDecorator
+from .on_poll import OnPollDecorator
 from .test_connectivity import ConnectivityTestDecorator
 from .view_handler import ViewHandlerDecorator
-from .on_poll import OnPollDecorator
-from .on_es_poll import OnESPollDecorator
 from .webhook import WebhookDecorator
-from .make_request import MakeRequestDecorator
 
 __all__ = [
     "ActionDecorator",

soar_sdk/decorators/action.py

@@ -1,20 +1,16 @@
 import inspect
+import traceback
+from collections.abc import AsyncGenerator, Callable, Iterator
 from functools import wraps
-from collections.abc import Iterator
-from typing import Any, get_args, get_origin
-from collections.abc import Callable
-from collections.abc import AsyncGenerator
+from typing import TYPE_CHECKING, Any, get_args, get_origin
 
 from soar_sdk.abstract import SOARClient
-from soar_sdk.action_results import ActionResult, ActionOutput
-from soar_sdk.params import Params
+from soar_sdk.action_results import ActionOutput, ActionResult
+from soar_sdk.async_utils import run_async_if_needed
+from soar_sdk.exceptions import ActionFailure
 from soar_sdk.meta.actions import ActionMeta
+from soar_sdk.params import Params
 from soar_sdk.types import Action, action_protocol
-from soar_sdk.exceptions import ActionFailure
-from soar_sdk.async_utils import run_async_if_needed
-import traceback
-
-from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from soar_sdk.app import App

soar_sdk/decorators/make_request.py

@@ -1,19 +1,17 @@
 import inspect
+import traceback
+from collections.abc import Callable
+from functools import wraps
+from typing import TYPE_CHECKING, Any
 
 from soar_sdk.abstract import SOARClient
-from soar_sdk.action_results import ActionResult
-from soar_sdk.params import MakeRequestParams
-from soar_sdk.meta.actions import ActionMeta
-from soar_sdk.action_results import ActionOutput, MakeRequestOutput
-from soar_sdk.types import Action, action_protocol
-from soar_sdk.exceptions import ActionFailure
+from soar_sdk.action_results import ActionOutput, ActionResult, MakeRequestOutput
 from soar_sdk.async_utils import run_async_if_needed
+from soar_sdk.exceptions import ActionFailure
 from soar_sdk.logging import getLogger
-from functools import wraps
-import traceback
-
-from typing import TYPE_CHECKING, Any
-from collections.abc import Callable
+from soar_sdk.meta.actions import ActionMeta
+from soar_sdk.params import MakeRequestParams
+from soar_sdk.types import Action, action_protocol
 
 if TYPE_CHECKING:
     from soar_sdk.app import App

soar_sdk/decorators/on_es_poll.py

@@ -1,22 +1,19 @@
 import inspect
+from collections.abc import Callable, Iterator
 from functools import wraps
-from typing import Any
-from collections.abc import Callable
-from collections.abc import Iterator
+from typing import TYPE_CHECKING, Any
 
 from soar_sdk.abstract import SOARClient
 from soar_sdk.action_results import ActionResult
-from soar_sdk.params import OnESPollParams
-from soar_sdk.meta.actions import ActionMeta
-from soar_sdk.types import Action, action_protocol
-from soar_sdk.exceptions import ActionFailure
 from soar_sdk.async_utils import run_async_if_needed
+from soar_sdk.exceptions import ActionFailure
 from soar_sdk.logging import getLogger
-from soar_sdk.models.finding import Finding
+from soar_sdk.meta.actions import ActionMeta
 from soar_sdk.models.attachment_input import AttachmentInput
 from soar_sdk.models.container import Container
-
-from typing import TYPE_CHECKING
+from soar_sdk.models.finding import Finding
+from soar_sdk.params import OnESPollParams
+from soar_sdk.types import Action, action_protocol
 
 if TYPE_CHECKING:
     from soar_sdk.app import App

soar_sdk/decorators/on_poll.py

@@ -1,20 +1,16 @@
 import inspect
+from collections.abc import Callable, Iterator
 from functools import wraps
-from typing import Any
-from collections.abc import Callable
-from collections.abc import Iterator
+from typing import TYPE_CHECKING, Any
 
 from soar_sdk.abstract import SOARClient
 from soar_sdk.action_results import ActionResult
-from soar_sdk.params import OnPollParams
-from soar_sdk.meta.actions import ActionMeta
-from soar_sdk.types import Action, action_protocol
-from soar_sdk.exceptions import ActionFailure
 from soar_sdk.async_utils import run_async_if_needed
+from soar_sdk.exceptions import ActionFailure
 from soar_sdk.logging import getLogger
-
-
-from typing import TYPE_CHECKING
+from soar_sdk.meta.actions import ActionMeta
+from soar_sdk.params import OnPollParams
+from soar_sdk.types import Action, action_protocol
 
 if TYPE_CHECKING:
     from soar_sdk.app import App
@@ -75,8 +71,8 @@ class OnPollDecorator:
             **kwargs: Any,  # noqa: ANN401
         ) -> bool:
             # Lazy imports to avoid circular dependencies
-            from soar_sdk.models.container import Container
             from soar_sdk.models.artifact import Artifact
+            from soar_sdk.models.container import Container
 
             try:
                 # Validate poll params