splunk-soar-sdk 2.3.7__py3-none-any.whl → 3.1.0__py3-none-any.whl

soar_sdk/code_renderers/action_renderer.py

@@ -1,14 +1,15 @@
-from typing import ClassVar, Optional
+from typing import ClassVar
 from collections.abc import Iterator
 import typing
 import ast
-from pydantic.fields import Undefined
+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.meta.actions import ActionMeta
 from soar_sdk.params import Params
+from soar_sdk.field_utils import parse_json_schema_extra
 
 
 class ActionRenderer(AstRenderer[ActionMeta]):
@@ -201,7 +202,7 @@ class ActionRenderer(AstRenderer[ActionMeta]):
         yield ast.fix_missing_locations(node)
 
     def render_outputs_ast(
-        self, model: Optional[type[ActionOutput]] = None
+        self, model: type[ActionOutput] | None = None
     ) -> Iterator[ast.ClassDef]:
         """Generates the AST for the action outputs.
 
@@ -221,16 +222,24 @@ class ActionRenderer(AstRenderer[ActionMeta]):
 
         field_defs: list[ast.stmt] = []
 
-        for field_name_str, field in model.__fields__.items():
+        for field_name_str, field in model.model_fields.items():
             annotation = field.annotation
+            if annotation is None:
+                continue
+
             annotation_str = "{name}"
             while typing.get_origin(annotation) is list:
                 annotation_str = f"list[{annotation_str}]"
                 annotation = typing.get_args(annotation)[0]
+
+            # Ensure annotation is a valid type after unwrapping
+            if not isinstance(annotation, type):
+                continue
+
             annotation_str = annotation_str.format(name=annotation.__name__)
 
             field_name = normalize_field_name(field_name_str)
-            if field.alias != field_name.normalized:
+            if field.alias is not None and field.alias != field_name.normalized:
                 field_name.original = field.alias
                 field_name.modified = True
 
@@ -240,9 +249,10 @@ class ActionRenderer(AstRenderer[ActionMeta]):
                 simple=1,
             )
 
-            if issubclass(annotation, ActionOutput):
+            if isinstance(annotation, type) and issubclass(annotation, ActionOutput):
                 # If the field is a Pydantic model, recursively print its fields
-                for model_ast in self.render_outputs_ast(field.type_):
+                # In Pydantic v2, use annotation directly (no field.type_)
+                for model_ast in self.render_outputs_ast(annotation):
                     model_tree[model_ast.name] = model_ast
 
                 if field_name.modified:
@@ -258,7 +268,9 @@ class ActionRenderer(AstRenderer[ActionMeta]):
                     )
             else:
                 keywords = []
-                if (extras := {**field.field_info.extra}) or field_name.modified:
+                extras = {**parse_json_schema_extra(field.json_schema_extra)}
+
+                if extras or field_name.modified:
                     extras["example_values"] = extras.pop("examples", None)
                     if extras["example_values"] == [True, False]:
                         extras["example_values"] = None
@@ -315,7 +327,10 @@ class ActionRenderer(AstRenderer[ActionMeta]):
             keywords=[],
         )
 
-        for field_name, field_def in self.action_meta.parameters.__fields__.items():
+        for field_name, field_def in self.action_meta.parameters.model_fields.items():
+            if field_def.annotation is None:
+                continue
+
             field_type = ast.Name(id=field_def.annotation.__name__, ctx=ast.Load())
 
             param = ast.Call(
@@ -324,29 +339,31 @@ class ActionRenderer(AstRenderer[ActionMeta]):
                 keywords=[],
             )
 
-            if field_def.field_info.description:
+            json_schema_extra = parse_json_schema_extra(field_def.json_schema_extra)
+
+            if field_def.description:
                 param.keywords.append(
                     ast.keyword(
                         arg="description",
-                        value=ast.Constant(value=field_def.field_info.description),
+                        value=ast.Constant(value=field_def.description),
                     )
                 )
-            if not field_def.field_info.extra.get("required", True):
+            if not json_schema_extra.get("required", True):
                 param.keywords.append(
                     ast.keyword(arg="required", value=ast.Constant(value=False))
                 )
-            if field_def.field_info.extra.get("primary", False):
+            if json_schema_extra.get("primary", False):
                 param.keywords.append(
                     ast.keyword(arg="primary", value=ast.Constant(value=True))
                 )
-            if (default := field_def.field_info.default) and default != Undefined:
+            if field_def.default not in (PydanticUndefined, None):
                 param.keywords.append(
                     ast.keyword(
                         arg="default",
-                        value=ast.Constant(value=field_def.field_info.default),
+                        value=ast.Constant(value=field_def.default),
                     )
                 )
-            if value_list := field_def.field_info.extra.get("value_list"):
+            if value_list := json_schema_extra.get("value_list"):
                 param.keywords.append(
                     ast.keyword(
                         arg="value_list",
@@ -356,7 +373,7 @@ class ActionRenderer(AstRenderer[ActionMeta]):
                         ),
                     )
                 )
-            if cef_types := field_def.field_info.extra.get("cef_types"):
+            if cef_types := json_schema_extra.get("cef_types"):
                 param.keywords.append(
                     ast.keyword(
                         arg="cef_types",
@@ -366,7 +383,7 @@ class ActionRenderer(AstRenderer[ActionMeta]):
                         ),
                     )
                 )
-            if field_def.field_info.extra.get("allow_list", False):
+            if json_schema_extra.get("allow_list", False):
                 param.keywords.append(
                     ast.keyword(arg="allow_list", value=ast.Constant(value=True))
                 )

soar_sdk/code_renderers/app_renderer.py

@@ -1,6 +1,5 @@
 import dataclasses
 import ast
-from typing import Union
 from collections.abc import Iterator
 
 
@@ -50,7 +49,7 @@ class AppRenderer:
         self.context = context
 
     @staticmethod
-    def create_default_imports() -> Iterator[Union[ast.Import, ast.ImportFrom]]:
+    def create_default_imports() -> Iterator[ast.Import | ast.ImportFrom]:
         """Create default imports for the App module.
 
         Returns:

soar_sdk/code_renderers/asset_renderer.py

@@ -1,5 +1,4 @@
 import dataclasses
-from typing import Optional, Union
 import ast
 from collections.abc import Iterator
 
@@ -12,12 +11,12 @@ class AssetContext:
     """Context for rendering individual configuration keys of an Asset class."""
 
     name: str
-    description: Optional[str]
+    description: str | None
     required: bool
-    default: Union[str, int, float, bool, None]
+    default: str | int | float | bool | None
     data_type: str
-    value_list: Optional[list[str]]
-    alias: Optional[str] = None
+    value_list: list[str] | None
+    alias: str | None = None
 
     @property
     def is_str(self) -> bool:

soar_sdk/code_renderers/renderer.py

@@ -1,5 +1,5 @@
 import abc
-from typing import TypeVar, Generic, Optional
+from typing import TypeVar, Generic
 import jinja2 as j2
 import ast
 from collections.abc import Iterator
@@ -12,7 +12,7 @@ class Renderer(Generic[ContextT], abc.ABC):
     """Abstract base class for rendering code using Jinja2 templates."""
 
     def __init__(
-        self, context: ContextT, jinja_env: Optional[j2.Environment] = None
+        self, context: ContextT, jinja_env: j2.Environment | None = None
     ) -> None:
         self.context = context
         self.jinja_env = jinja_env or j2.Environment(

soar_sdk/code_renderers/templates/pyproject.toml.jinja

@@ -52,7 +52,7 @@ required-environments = [
 [tool.ruff]
 output-format = "full"  # <full|concise>
 fix = true
-target-version = "py39"
+target-version = "py313"
 
 [tool.ruff.lint]
 select = [

soar_sdk/compat.py

@@ -2,7 +2,7 @@ from enum import Enum
 import functools
 from packaging.version import Version
 
-MIN_PHANTOM_VERSION = "6.4.0"
+MIN_PHANTOM_VERSION = "7.0.0"
 
 UPDATE_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%fZ"
 
@@ -27,8 +27,8 @@ def remove_when_soar_newer_than(
 class PythonVersion(str, Enum):
     """Enum to represent supported Python versions."""
 
-    PY_3_9 = "3.9"
     PY_3_13 = "3.13"
+    PY_3_14 = "3.14"
 
     def __str__(self) -> str:
         """Returns the string representation of the Python version."""
@@ -41,10 +41,10 @@ class PythonVersion(str, Enum):
         Raises ValueError if the version is not supported.
         """
         # "3" is a special case for connectors that don't properly define their Python version
-        if version_str in ("3", "3.9"):
-            return cls.PY_3_9
-        if version_str == "3.13":
+        if version_str in ("3", "3.13"):
             return cls.PY_3_13
+        if version_str == "3.14":
+            return cls.PY_3_14
 
         raise ValueError(f"Unsupported Python version: {version_str}")
 
@@ -67,7 +67,7 @@ class PythonVersion(str, Enum):
     @classmethod
     def all(cls) -> list["PythonVersion"]:
         """Returns a list of all supported Python versions."""
-        return [cls.PY_3_9, cls.PY_3_13]
+        return [cls.PY_3_13, cls.PY_3_14]
 
     @classmethod
     def all_csv(cls) -> str:

soar_sdk/decorators/action.py

@@ -1,7 +1,8 @@
 import inspect
 from functools import wraps
 from collections.abc import Iterator
-from typing import Callable, Optional, Any, Union, get_args, get_origin
+from typing import Any, get_args, get_origin
+from collections.abc import Callable
 from collections.abc import AsyncGenerator
 
 from soar_sdk.abstract import SOARClient
@@ -25,24 +26,22 @@ class ActionDecorator:
     def __init__(
         self,
         app: "App",
-        name: Optional[str] = None,
-        identifier: Optional[str] = None,
-        description: Optional[str] = None,
+        name: str | None = None,
+        identifier: str | None = None,
+        description: str | None = None,
         verbose: str = "",
         action_type: str = "generic",
         read_only: bool = True,
-        params_class: Optional[type[Params]] = None,
-        output_class: Union[
-            None,
-            type[ActionOutput],
-            Iterator[type[ActionOutput]],
-            AsyncGenerator[type[ActionOutput]],
-            list[type[ActionOutput]],
-        ] = None,
-        render_as: Optional[str] = None,
-        view_handler: Optional[Callable] = None,
+        params_class: type[Params] | None = None,
+        output_class: None
+        | type[ActionOutput]
+        | Iterator[type[ActionOutput]]
+        | AsyncGenerator[type[ActionOutput]]
+        | list[type[ActionOutput]] = None,
+        render_as: str | None = None,
+        view_handler: Callable | None = None,
         versions: str = "EQ(*)",
-        summary_type: Optional[type[ActionOutput]] = None,
+        summary_type: type[ActionOutput] | None = None,
         enable_concurrency_lock: bool = False,
     ) -> None:
         self.app = app

soar_sdk/decorators/make_request.py

@@ -12,7 +12,8 @@ from soar_sdk.logging import getLogger
 from functools import wraps
 import traceback
 
-from typing import TYPE_CHECKING, Callable, Any, Optional
+from typing import TYPE_CHECKING, Any
+from collections.abc import Callable
 
 if TYPE_CHECKING:
     from soar_sdk.app import App
@@ -24,7 +25,7 @@ class MakeRequestDecorator:
     def __init__(
         self,
         app: "App",
-        output_class: Optional[type[ActionOutput]] = None,
+        output_class: type[ActionOutput] | None = None,
     ) -> None:
         self.app = app
         self.output_class = output_class
@@ -97,7 +98,7 @@ class MakeRequestDecorator:
             **kwargs: Any,  # noqa: ANN401
         ) -> bool:
             try:
-                action_params = validated_params_class.parse_obj(params)
+                action_params = validated_params_class.model_validate(params)
             except Exception as e:
                 logger.info(f"Parameter validation error: {e!s}")
                 return self.app._adapt_action_result(

soar_sdk/decorators/on_poll.py

@@ -1,6 +1,7 @@
 import inspect
 from functools import wraps
-from typing import Callable, Any
+from typing import Any
+from collections.abc import Callable
 from collections.abc import Iterator
 
 from soar_sdk.abstract import SOARClient
@@ -80,7 +81,7 @@ class OnPollDecorator:
             try:
                 # Validate poll params
                 try:
-                    action_params = validated_params_class.parse_obj(params)
+                    action_params = validated_params_class.model_validate(params)
                 except Exception as e:
                     logger.info(f"Parameter validation error: {e!s}")
                     return self.app._adapt_action_result(
@@ -177,8 +178,8 @@ class OnPollDecorator:
 
         # Custom ActionMeta class for on_poll (has no output)
         class OnPollActionMeta(ActionMeta):
-            def dict(self, *args: object, **kwargs: object) -> dict[str, Any]:
-                data = super().dict(*args, **kwargs)
+            def model_dump(self, *args: object, **kwargs: object) -> dict[str, Any]:
+                data = super().model_dump(*args, **kwargs)
                 # Poll actions have no output
                 data["output"] = []
                 return data

soar_sdk/decorators/test_connectivity.py

@@ -1,6 +1,6 @@
 import inspect
 from functools import wraps
-from typing import Callable, Optional
+from collections.abc import Callable
 
 from soar_sdk.abstract import SOARClient
 from soar_sdk.action_results import ActionResult
@@ -48,7 +48,7 @@ class ConnectivityTestDecorator:
         @action_protocol
         @wraps(function)
         def inner(
-            _param: Optional[dict] = None,
+            _param: dict | None = None,
             soar: SOARClient = self.app.soar_client,
         ) -> bool:
             kwargs = self.app._build_magic_args(function, soar=soar)

soar_sdk/decorators/view_handler.py

@@ -1,6 +1,7 @@
 import inspect
 from functools import wraps
-from typing import Callable, Optional, Any
+from typing import Any
+from collections.abc import Callable
 
 from soar_sdk.action_results import ActionResult
 from soar_sdk.views.component_registry import COMPONENT_REGISTRY
@@ -10,9 +11,7 @@ from soar_sdk.views.view_parser import ViewFunctionParser
 from soar_sdk.views.template_renderer import (
     get_template_renderer,
     get_templates_dir,
-    BASE_TEMPLATE_PATH,
 )
-from soar_sdk.compat import remove_when_soar_newer_than
 
 from typing import TYPE_CHECKING
 
@@ -23,15 +22,15 @@ if TYPE_CHECKING:
 class ViewHandlerDecorator:
     """Class-based decorator for view handler functionality."""
 
-    def __init__(self, app: "App", *, template: Optional[str] = None) -> None:
+    def __init__(self, app: "App", *, template: str | None = None) -> None:
         self.app = app
         self.template = template
 
     @staticmethod
     def _validate_view_function_signature(
         function: Callable,
-        template: Optional[str] = None,
-        component_type: Optional[str] = None,
+        template: str | None = None,
+        component_type: str | None = None,
     ) -> None:
         """Validate that the function signature is compatible with view handlers."""
         signature = inspect.signature(function)
@@ -92,14 +91,9 @@ class ViewHandlerDecorator:
             **kwargs: Any,  # noqa: ANN401
         ) -> str:
             def handle_html_output(html: str) -> str:
-                remove_when_soar_newer_than(
-                    "6.4.1", "SOAR now fully supports prerendering views"
-                )
-                if context.get("accepts_prerender"):
-                    context["prerender"] = True
-                    return html
-                context["html_content"] = html
-                return BASE_TEMPLATE_PATH
+                # SOAR 7.0+ fully supports prerendering
+                context["prerender"] = True
+                return html
 
             def render_with_error_handling(
                 render_func: Callable[[], str], error_type: str, target_name: str
@@ -121,12 +115,12 @@ class ViewHandlerDecorator:
                 parser: ViewFunctionParser = ViewFunctionParser(function)
 
                 # Parse context to ViewContext (coming from app_interface)
-                parsed_context = ViewContext.parse_obj(context)
+                parsed_context = ViewContext.model_validate(context)
 
                 # Parse all_app_runs to AllAppRuns (coming from app_interface)
                 parsed_all_app_runs: AllAppRuns = []
                 for app_run_data, action_results in all_app_runs:
-                    result_summary = ResultSummary.parse_obj(app_run_data)
+                    result_summary = ResultSummary.model_validate(app_run_data)
                     parsed_all_app_runs.append((result_summary, action_results))
 
                 result = parser.execute(
@@ -158,7 +152,7 @@ class ViewHandlerDecorator:
 
             # Reusable component
             if isinstance(result, BaseModel):
-                result_dict = result.dict()
+                result_dict = result.model_dump()
                 template_name = f"components/{component_type}.html"
                 err_msg = "Component Rendering Failed"
                 err_context = f"component '{component_type}'"

soar_sdk/decorators/webhook.py

@@ -1,6 +1,5 @@
 import inspect
 from functools import wraps
-from typing import Optional
 from pathlib import Path
 
 from soar_sdk.cli.path_utils import relative_to_cwd
@@ -19,7 +18,7 @@ class WebhookDecorator:
     """Class-based decorator for webhook functionality."""
 
     def __init__(
-        self, app: "App", url_pattern: str, allowed_methods: Optional[list[str]] = None
+        self, app: "App", url_pattern: str, allowed_methods: list[str] | None = None
     ) -> None:
         self.app = app
         self.url_pattern = url_pattern

soar_sdk/exceptions.py

@@ -1,10 +1,7 @@
-from typing import Optional
-
-
 class ActionFailure(Exception):
     """Exception raised when an action fails to execute successfully."""
 
-    def __init__(self, message: str, action_name: Optional[str] = None) -> None:
+    def __init__(self, message: str, action_name: str | None = None) -> None:
         self.message = message
         self.action_name = action_name
         super().__init__(self.message)

soar_sdk/field_utils.py

@@ -0,0 +1,8 @@
+from typing import Any
+
+
+def parse_json_schema_extra(json_schema_extra: Any) -> dict[str, Any]:  # noqa: ANN401
+    """Extract json_schema_extra as a dict, handling both dict and callable forms."""
+    if callable(json_schema_extra):
+        return {}
+    return json_schema_extra or {}

soar_sdk/input_spec.py

@@ -1,6 +1,6 @@
 from uuid import uuid4
-from pydantic import BaseModel, Field, validator
-from typing import Literal, Optional, Any
+from pydantic import BaseModel, Field, field_validator, ConfigDict
+from typing import Literal, Any
 import random
 
 
@@ -20,20 +20,18 @@ class AppConfig(BaseModel):
 
     app_version: str
     directory: str
-    ingest: Optional[IngestConfig] = None
+    ingest: IngestConfig | None = None
     main_module: str
     # TODO: The platform should deprecate this unused field
     appname: Literal["-"] = "-"
 
     # NOTE: Inputs will intermix the keys of the asset config with the keys here
-    class Config:
-        """Configuration for the AppConfig model."""
-
-        extra = "allow"
+    model_config = ConfigDict(extra="allow")
 
     def get_asset_config(self) -> dict[str, Any]:
         """Get the asset configuration from the app config."""
-        return {k: v for k, v in self.__dict__.items() if k not in self.__fields__}
+        # In Pydantic v2 extra fields are stored in __pydantic_extra__
+        return dict(self.__pydantic_extra__) if self.__pydantic_extra__ else {}
 
 
 class EnvironmentVariable(BaseModel):
@@ -65,10 +63,7 @@ class ActionParameter(BaseModel):
     # context: Optional[ParameterContext] = None # noqa: ERA001
 
     # Additional keys are action-specific and not predictable here.
-    class Config:
-        """Configuration for the ActionParameter model."""
-
-        extra = "allow"
+    model_config = ConfigDict(extra="allow")
 
 
 class SoarAuth(BaseModel):
@@ -78,7 +73,8 @@ class SoarAuth(BaseModel):
     username: str
     password: str
 
-    @validator("phantom_url")
+    @field_validator("phantom_url")
+    @classmethod
     def validate_phantom_url(cls, value: str) -> str:
         """Ensure the URL starts with http:// or https://."""
         return (
@@ -137,9 +133,9 @@ class InputSpecification(BaseModel):
     }
     """
 
-    action: Optional[str] = None
+    action: str | None = None
     action_run_id: int = Field(default_factory=id_factory)
-    app_config: Optional[Any] = None
+    app_config: Any | None = None
     asset_id: str = Field(default_factory=lambda: str(id_factory()))
     config: AppConfig
     connector_run_id: int = Field(default_factory=id_factory)
@@ -148,6 +144,6 @@ class InputSpecification(BaseModel):
     dec_key: str = Field(default_factory=lambda: str(id_factory()))
     environment_variables: dict[str, EnvironmentVariable] = Field(default_factory=dict)
     identifier: str
-    parameters: list[ActionParameter] = Field(default_factory=lambda: [{}])
+    parameters: list[ActionParameter] = Field(default_factory=list)
     user_session_token: str = ""
-    soar_auth: Optional[SoarAuth] = None
+    soar_auth: SoarAuth | None = None

soar_sdk/logging.py

@@ -4,7 +4,7 @@ from soar_sdk.colors import ANSIColor
 from soar_sdk.shims.phantom.install_info import is_soar_available, get_product_version
 from soar_sdk.shims.phantom.ph_ipc import ph_ipc
 from packaging.version import Version
-from typing import Any, Optional
+from typing import Any
 from soar_sdk.compat import remove_when_soar_newer_than
 
 PROGRESS_LEVEL = 25
@@ -38,7 +38,7 @@ class SOARHandler(logging.Handler):
         self,
     ) -> None:
         super().__init__()
-        self.__handle: Optional[int] = None
+        self.__handle: int | None = None
 
     def emit(self, record: logging.LogRecord) -> None:
         is_new_soar = Version(get_product_version()) >= Version("7.0.0")
@@ -79,7 +79,7 @@ class SOARHandler(logging.Handler):
         except Exception:
             self.handleError(record)
 
-    def set_handle(self, handle: Optional[int]) -> None:
+    def set_handle(self, handle: int | None) -> None:
         """Set the action handle for the SOAR client."""
         self.__handle = handle
 

soar_sdk/meta/actions.py

@@ -1,9 +1,8 @@
-from typing import Any, Type, Optional, Callable  # noqa: UP035
+from typing import Any, Type, Callable  # noqa: UP035
 
 from pydantic import BaseModel, Field
 
 from soar_sdk.cli.manifests.serializers import ParamsSerializer, OutputsSerializer
-from soar_sdk.compat import remove_when_soar_newer_than
 from soar_sdk.params import Params
 from soar_sdk.action_results import ActionOutput
 
@@ -20,14 +19,14 @@ class ActionMeta(BaseModel):
     verbose: str = ""
     parameters: Type[Params] = Field(default=Params)  # noqa: UP006
     output: Type[ActionOutput] = Field(default=ActionOutput)  # noqa: UP006
-    render_as: Optional[str] = None
-    view_handler: Optional[Callable] = None
-    summary_type: Optional[Type[ActionOutput]] = Field(default=None, exclude=True)  # noqa: UP006
+    render_as: str | None = None
+    view_handler: Callable | None = None
+    summary_type: Type[ActionOutput] | None = Field(default=None, exclude=True)  # noqa: UP006
     enable_concurrency_lock: bool = False
 
-    def dict(self, *args: Any, **kwargs: Any) -> dict[str, Any]:  # noqa: ANN401
+    def model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]:  # noqa: ANN401
         """Serializes the action metadata to a dictionary."""
-        data = super().dict(*args, **kwargs)
+        data = super().model_dump(*args, **kwargs)
         data["parameters"] = ParamsSerializer.serialize_fields_info(self.parameters)
         data["output"] = OutputsSerializer.serialize_datapaths(
             self.parameters, self.output, summary_class=self.summary_type
@@ -40,21 +39,6 @@ class ActionMeta(BaseModel):
                 "type": self.render_as,
             }
 
-        if self.view_handler:
-            remove_when_soar_newer_than("6.4.1")
-            # Get the module path and function name for the view
-            module = self.view_handler.__module__
-            # Convert module path from dot notation to the expected format
-            # e.g., "example_app.src.app" -> "src.app"
-            module_parts = module.split(".")
-            if len(module_parts) > 1:
-                # Remove the package name (first part) to get relative module path
-                relative_module = ".".join(module_parts[1:])
-            else:
-                relative_module = module
-
-            data["render"]["view"] = f"{relative_module}.{self.view_handler.__name__}"
-
         # Remove view_handler from the output since in render
         data.pop("view_handler", None)
         data.pop("render_as", None)