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

soar_sdk/app_cli_runner.py

@@ -3,7 +3,7 @@ import inspect
 import json
 from pathlib import Path
 import typing
-from typing import Optional, Any
+from typing import Any
 import os
 from pydantic import ValidationError
 from urllib.parse import urlparse, parse_qs
@@ -31,7 +31,7 @@ class AppCliRunner:
     def __init__(self, app: "App") -> None:
         self.app = app
 
-    def parse_args(self, argv: Optional[list[str]] = None) -> argparse.Namespace:
+    def parse_args(self, argv: list[str] | None = None) -> argparse.Namespace:
         """Parse command line arguments for the app CLI runner."""
         root_parser = argparse.ArgumentParser()
         root_parser.add_argument(
@@ -162,13 +162,13 @@ class AppCliRunner:
                 )
 
             try:
-                param = chosen_action.params_class.parse_obj(params_json)
+                param = chosen_action.params_class.model_validate(params_json)
             except Exception as e:
                 root_parser.error(
                     f"Unable to parse parameter JSON file {params_file}:\n{e}"
                 )
 
-            parameter_list.append(ActionParameter(**param.dict()))
+            parameter_list.append(ActionParameter(**param.model_dump()))
 
         input_data = InputSpecification(
             action=args.identifier,
@@ -191,7 +191,7 @@ class AppCliRunner:
                 )
 
         input_data.config = AppConfig(
-            **input_data.config.dict(),
+            **input_data.config.model_dump(),
             **asset_json,  # Merge asset JSON into config
         )
 
@@ -207,7 +207,7 @@ class AppCliRunner:
             except ValidationError as e:
                 root_parser.error(f"Provided soar auth arguments are invalid: {e}.")
 
-        args.raw_input_data = input_data.json()
+        args.raw_input_data = input_data.model_dump_json()
 
     def _parse_webhook_args(
         self,
@@ -250,14 +250,14 @@ class AppCliRunner:
             path_parts=path_parts,
             query=query,
             body=args.data,
-            asset=self.app.asset_cls.parse_obj(asset_json),
+            asset=self.app.asset_cls.model_validate(asset_json),
             soar_base_url=soar_base_url,
             soar_auth_token=soar_auth_token,
             asset_id=args.asset_id,
         )
         print(f"Parsed webhook request: {args.webhook_request}")
 
-    def run(self, argv: Optional[list[str]] = None) -> None:
+    def run(self, argv: list[str] | None = None) -> None:
         """Run the app CLI."""
         args = self.parse_args(argv=argv)
 

soar_sdk/app_client.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Any, TYPE_CHECKING, Union, Optional
+from typing import Any, TYPE_CHECKING
 from collections.abc import Mapping
 
 import httpx
@@ -41,9 +41,9 @@ class AppClient(SOARClient[SummaryType]):
         self._artifacts_api = Artifact(soar_client=self)
         self._containers_api = Container(soar_client=self)
         self._vault_api = Vault(soar_client=self)
-        self.basic_auth: Optional[BasicAuth] = None
+        self.basic_auth: BasicAuth | None = None
 
-        self._summary: Optional[SummaryType] = None
+        self._summary: SummaryType | None = None
         self._message: str = ""
         self.__container_id: int = 0
         self.__asset_id: str = ""
@@ -132,13 +132,13 @@ class AppClient(SOARClient[SummaryType]):
         self,
         endpoint: str,
         *,
-        params: Optional[Union[dict[str, Any], httpx.QueryParams]] = None,
-        headers: Optional[dict[str, str]] = None,
-        cookies: Optional[dict[str, str]] = None,
-        auth: Optional[Union[httpx.Auth, tuple[str, str]]] = None,
-        timeout: Optional[httpx.Timeout] = None,
+        params: dict[str, Any] | httpx.QueryParams | None = None,
+        headers: dict[str, str] | None = None,
+        cookies: dict[str, str] | None = None,
+        auth: httpx.Auth | tuple[str, str] | None = None,
+        timeout: httpx.Timeout | None = None,
         follow_redirects: bool = False,
-        extensions: Optional[Mapping[str, Any]] = None,
+        extensions: Mapping[str, Any] | None = None,
     ) -> httpx.Response:
         """Perform a DELETE request to the specific endpoint using the SOAR client."""
         headers = headers or {}
@@ -167,7 +167,7 @@ class AppClient(SOARClient[SummaryType]):
         """Set the message for the action result."""
         self._message = message
 
-    def get_summary(self) -> Optional[SummaryType]:
+    def get_summary(self) -> SummaryType | None:
         """Get the summary for the action result."""
         return self._summary
 

soar_sdk/asset.py

@@ -1,14 +1,16 @@
-from typing import Any, Optional, Union
+from typing import Any
 from zoneinfo import ZoneInfo
-from pydantic import BaseModel, root_validator
-from pydantic.fields import Field, Undefined
+from pydantic import BaseModel, model_validator, ConfigDict, Field
+from pydantic_core import PydanticUndefined
 
-from typing_extensions import NotRequired, TypedDict
+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
 
 remove_when_soar_newer_than(
     "7.0.0", "NotRequired from typing_extensions is in typing in Python 3.11+"
@@ -16,12 +18,12 @@ remove_when_soar_newer_than(
 
 
 def AssetField(
-    description: Optional[str] = None,
+    description: str | None = None,
     required: bool = True,
-    default: Optional[Any] = None,  # noqa: ANN401
-    value_list: Optional[list] = None,
+    default: Any | None = None,  # noqa: ANN401
+    value_list: list | None = None,
     sensitive: bool = False,
-    alias: Optional[str] = None,
+    alias: str | None = None,
 ) -> Any:  # noqa: ANN401
     """Representation of an asset configuration field.
 
@@ -42,13 +44,22 @@ def AssetField(
     Returns:
         The FieldInfo object as pydantic.Field.
     """
+    json_schema_extra: dict[str, Any] = {}
+    if required is not None:
+        json_schema_extra["required"] = required
+    if value_list is not None:
+        json_schema_extra["value_list"] = value_list
+    if sensitive is not None:
+        json_schema_extra["sensitive"] = sensitive
+
+    # Use ... for required fields
+    field_default: Any = ... if default is None and required else default
+
     return Field(
-        default=default,
+        default=field_default,
         description=description,
-        required=required,
-        value_list=value_list,
-        sensitive=sensitive,
         alias=alias,
+        json_schema_extra=json_schema_extra if json_schema_extra else None,
     )
 
 
@@ -71,7 +82,7 @@ class AssetFieldSpecification(TypedDict):
     data_type: str
     description: NotRequired[str]
     required: NotRequired[bool]
-    default: NotRequired[Union[str, int, float, bool]]
+    default: NotRequired[str | int | float | bool]
     value_list: NotRequired[list[str]]
     order: NotRequired[int]
 
@@ -106,16 +117,12 @@ class BaseAsset(BaseModel):
         the SOAR platform to avoid conflicts with internal fields.
     """
 
-    class Config:
-        """Pydantic configuration for BaseAsset.
-
-        Note that we are using the `arbitrary_types_allowed` setting, which is generally not recommended.
-        However, we are checking all of the field types via `soar_sdk.datatypes.as_datatype`, so we have confidence in their validity.
-        """
-
-        arbitrary_types_allowed = True
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+    )
 
-    @root_validator(pre=True)
+    @model_validator(mode="before")
+    @classmethod
     def validate_no_reserved_fields(cls, values: dict[str, Any]) -> dict[str, Any]:
         """Prevents subclasses from defining fields starting with "_reserved_".
 
@@ -148,7 +155,7 @@ class BaseAsset(BaseModel):
             # This accounts for some bad behavior by the platform; it injects a few app-related
             # metadata fields directly into asset configuration dictionaries, which can lead to
             # undefined behavior if an asset tries to use the same field names.
-            if field_name in AppConfig.__fields__:
+            if field_name in AppConfig.model_fields:
                 raise ValueError(
                     f"Field name '{field_name}' is reserved by the platform and cannot be used in an asset"
                 )
@@ -206,8 +213,10 @@ class BaseAsset(BaseModel):
         """
         params: dict[str, AssetFieldSpecification] = {}
 
-        for field_order, (field_name, field) in enumerate(cls.__fields__.items()):
+        for field_order, (field_name, field) in enumerate(cls.model_fields.items()):
             field_type = field.annotation
+            if field_type is None:
+                continue
 
             try:
                 type_name = as_datatype(field_type)
@@ -216,32 +225,34 @@ class BaseAsset(BaseModel):
                     f"Failed to serialize asset field {field_name}: {e}"
                 ) from None
 
-            if field.field_info.extra.get("sensitive", False):
+            json_schema_extra = parse_json_schema_extra(field.json_schema_extra)
+
+            if json_schema_extra.get("sensitive", False):
                 if field_type is not str:
                     raise TypeError(
                         f"Sensitive parameter {field_name} must be type str, not {field_type.__name__}"
                     )
                 type_name = "password"
 
-            if not (description := field.field_info.description):
+            if not (description := field.description):
                 description = cls._default_field_description(field_name)
 
             params_field = AssetFieldSpecification(
                 data_type=type_name,
-                required=field.field_info.extra.get("required", True),
+                required=bool(json_schema_extra.get("required", True)),
                 description=description,
                 order=field_order,
             )
 
-            if (default := field.field_info.default) and default != Undefined:
+            if (default := field.default) not in (PydanticUndefined, None):
                 if isinstance(default, ZoneInfo):
                     params_field["default"] = default.key
                 else:
                     params_field["default"] = default
-            if value_list := field.field_info.extra.get("value_list"):
+            if value_list := json_schema_extra.get("value_list"):
                 params_field["value_list"] = value_list
 
-            params[field.alias] = params_field
+            params[field.alias or field_name] = params_field
 
         return params
 
@@ -255,8 +266,9 @@ class BaseAsset(BaseModel):
         """
         return {
             field_name
-            for field_name, field in cls.__fields__.items()
-            if field.field_info.extra.get("sensitive", False)
+            for field_name, field in cls.model_fields.items()
+            if isinstance(field.json_schema_extra, dict)
+            and field.json_schema_extra.get("sensitive", False)
         }
 
     @classmethod
@@ -268,6 +280,6 @@ class BaseAsset(BaseModel):
         """
         return {
             field_name
-            for field_name, field in cls.__fields__.items()
+            for field_name, field in cls.model_fields.items()
             if field.annotation is ZoneInfo
         }

soar_sdk/async_utils.py

@@ -17,7 +17,7 @@ def is_async_generator(obj: Any) -> bool:  # noqa: ANN401
     return inspect.isasyncgen(obj)
 
 
-async def async_generator_to_list(agen: AsyncGenerator[T, None]) -> list[T]:
+async def async_generator_to_list(agen: AsyncGenerator[T]) -> list[T]:
     """Consume an async generator and return its items in a list."""
     result: list[T] = []
     # Python 3.9 coverage limitation with async for loops
@@ -31,7 +31,7 @@ def run_async_if_needed(result: Coroutine[Any, Any, T]) -> T: ...
 
 
 @overload
-def run_async_if_needed(result: AsyncGenerator[T, None]) -> list[T]: ...
+def run_async_if_needed(result: AsyncGenerator[T]) -> list[T]: ...
 
 
 @overload

soar_sdk/cli/init/cli.py

@@ -1,4 +1,4 @@
-from typing import Annotated, Optional, cast
+from typing import Annotated, cast
 import datetime
 import json
 import os
@@ -65,7 +65,7 @@ def init_callback(
     type: str = "generic",  # noqa: A002
     vendor: str = "Splunk Inc.",
     publisher: str = "Splunk Inc.",
-    product: Optional[str] = None,
+    product: str | None = None,
     fips_compliant: bool = False,
     overwrite: bool = False,
 ) -> None:
@@ -107,11 +107,11 @@ def init_sdk_app(
     publisher: str,
     logo: Path,
     logo_dark: Path,
-    product: Optional[str] = None,
+    product: str | None = None,
     fips_compliant: bool = False,
     overwrite: bool = False,
-    app_content: Optional[list[ast.stmt]] = None,
-    asset_class: Optional[ast.ClassDef] = None,
+    app_content: list[ast.stmt] | None = None,
+    asset_class: ast.ClassDef | None = None,
 ) -> None:
     """Initialize a new SOAR app in the specified directory."""
     app_dir.mkdir(exist_ok=True)
@@ -149,9 +149,7 @@ def init_sdk_app(
         name=name,
         version=version,
         description=description,
-        copyright=copyright.format(
-            year=datetime.datetime.now(datetime.timezone.utc).year
-        ),
+        copyright=copyright.format(year=datetime.datetime.now(datetime.UTC).year),
         python_versions=python_versions,
         authors=authors,
         dependencies=dependencies,
@@ -242,7 +240,7 @@ def convert_connector_to_sdk(
         ),
     ],
     output_dir: Annotated[
-        Optional[Path],
+        Path | None,
         typer.Argument(
             file_okay=False,
             dir_okay=True,

soar_sdk/cli/manifests/deserializers.py

@@ -1,7 +1,7 @@
 import dataclasses
 import json
 from pathlib import Path
-from typing import Any, NamedTuple, Optional, TypeVar, Union, cast
+from typing import Any, NamedTuple, TypeVar, cast
 import pydantic
 
 from soar_sdk.action_results import ActionOutput, OutputFieldSpecification, OutputField
@@ -94,10 +94,10 @@ class OutputFieldModel:
 
     data_path: str
     data_type: str
-    contains: Optional[list[str]] = None
-    example_values: Optional[list[Union[str, float, bool]]] = None
-    column_name: Optional[str] = None
-    column_order: Optional[int] = None
+    contains: list[str] | None = None
+    example_values: list[str | float | bool] | None = None
+    column_name: str | None = None
+    column_order: int | None = None
 
 
 class DeserializedActionMeta(NamedTuple):
@@ -129,7 +129,7 @@ class ActionDeserializer:
         )
         action["output"] = cls.parse_output(action["action"], action.get("output", []))
         return DeserializedActionMeta(
-            action_meta=ActionMeta.parse_obj(action),
+            action_meta=ActionMeta.model_validate(action),
             has_custom_view=action.get("render", {}).get("type") == "custom",
         )
 
@@ -212,7 +212,7 @@ class ActionDeserializer:
     @staticmethod
     def _build_output_structure(
         datapath_specs: dict[str, OutputFieldModel],
-    ) -> dict[str, Union[list, dict, OutputFieldModel]]:
+    ) -> dict[str, list | dict | OutputFieldModel]:
         """Parse a datapath string into a dictionary.
 
         Args:
@@ -223,10 +223,10 @@ class ActionDeserializer:
         """
 
         def set_nested_value(
-            field_struct: dict[str, Union[list, dict, OutputFieldModel]],
+            field_struct: dict[str, list | dict | OutputFieldModel],
             path_parts: list[str],
             field_spec: OutputFieldModel,
-        ) -> Union[list, dict, OutputFieldModel]:
+        ) -> list | dict | OutputFieldModel:
             """Recursively set a field spec in the nested output field structure."""
             # Base case: we're at a leaf node and can return the field spec directly
             if not path_parts:
@@ -240,7 +240,7 @@ class ActionDeserializer:
 
             # Recursive case: this portion of the datapath is an object key
             next_field_struct = cast(
-                dict[str, Union[list, dict, OutputFieldModel]],
+                dict[str, list | dict | OutputFieldModel],
                 field_struct.get(current_key, {}),
             )
             field_struct[current_key] = set_nested_value(
@@ -248,7 +248,7 @@ class ActionDeserializer:
             )
             return field_struct
 
-        MergeT = TypeVar("MergeT", bound=Union[list, dict, OutputFieldModel])
+        MergeT = TypeVar("MergeT", bound=list | dict | OutputFieldModel)
 
         def merge(base: MergeT, new_structure: MergeT) -> MergeT:
             """Merge two nested structures, handling arrays and objects."""
@@ -280,12 +280,12 @@ class ActionDeserializer:
             # Should never happen in reality, hence the pragma, but we handle it gracefully
             return new_structure  # pragma: no cover
 
-        result: dict[str, Union[list, dict, OutputFieldModel]] = {}
+        result: dict[str, list | dict | OutputFieldModel] = {}
 
         for datapath, field_spec in datapath_specs.items():
             path_parts = datapath.split(".")
             nested_structure = cast(
-                dict[str, Union[list, dict, OutputFieldModel]],
+                dict[str, list | dict | OutputFieldModel],
                 set_nested_value({}, path_parts, field_spec),
             )
             merged = merge(result, nested_structure)
@@ -298,7 +298,7 @@ class ActionDeserializer:
     def _build_output_class(
         cls,
         action_name: str,
-        output_structure: dict[str, Union[dict, list, OutputFieldModel]],
+        output_structure: dict[str, dict | list | OutputFieldModel],
     ) -> type[ActionOutput]:
         """Build dynamic pydantic models for an action output, from the output data paths.
 
@@ -323,7 +323,7 @@ class ActionDeserializer:
 
     @classmethod
     def _build_output_field(
-        cls, field_name: str, output_structure: Union[list, dict, OutputFieldModel]
+        cls, field_name: str, output_structure: list | dict | OutputFieldModel
     ) -> tuple[str, FieldSpec]:
         """Build dynamic specs for an action output field, from an output data path.
 

soar_sdk/cli/manifests/processors.py

@@ -1,13 +1,13 @@
 import importlib
 import json
 import toml
-from datetime import datetime, timezone
+from datetime import datetime, UTC
 from pathlib import Path
 from pprint import pprint
 
 from soar_sdk.app import App
 from soar_sdk.cli.path_utils import context_directory
-from soar_sdk.compat import remove_when_soar_newer_than, UPDATE_TIME_FORMAT
+from soar_sdk.compat import UPDATE_TIME_FORMAT
 from soar_sdk.meta.adapters import TOMLDataAdapter
 from soar_sdk.meta.app import AppMeta
 from soar_sdk.meta.dependencies import UvLock
@@ -30,9 +30,7 @@ class ManifestProcessor:
         app = self.import_app_instance(app_meta)
         app_meta.configuration = app.asset_cls.to_json_schema()
         app_meta.actions = app.actions_manager.get_actions_meta_list()
-        app_meta.utctime_updated = datetime.now(timezone.utc).strftime(
-            UPDATE_TIME_FORMAT
-        )
+        app_meta.utctime_updated = datetime.now(UTC).strftime(UPDATE_TIME_FORMAT)
         for field, value in app.app_meta_info.items():
             setattr(app_meta, field, value)
 
@@ -43,16 +41,12 @@ class ManifestProcessor:
                 dep for dep in dependencies if dep.name != "splunk-soar-sdk"
             ]
 
-        app_meta.pip39_dependencies, app_meta.pip313_dependencies = (
+        app_meta.pip313_dependencies, app_meta.pip314_dependencies = (
             uv_lock.resolve_dependencies(dependencies)
         )
 
         if app.webhook_meta is not None:
-            remove_when_soar_newer_than("6.4.0")
             app_meta.webhook = app.webhook_meta
-            app_meta.webhook.handler = (
-                f"{app_meta.main_module.replace(':', '.')}.handle_webhook"
-            )
 
         return app_meta
 

soar_sdk/cli/manifests/serializers.py

@@ -1,4 +1,4 @@
-from typing import Any, Optional
+from typing import Any
 from collections.abc import Iterator
 from logging import getLogger
 import itertools
@@ -6,6 +6,7 @@ import itertools
 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
 
 logger = getLogger(__name__)
 
@@ -16,7 +17,7 @@ class ParamsSerializer:
     @staticmethod
     def get_sorted_fields_keys(params_class: type[Params]) -> list[str]:
         """Lists the fields of a Params class in order of declaration."""
-        return list(params_class.__fields__.keys())
+        return list(params_class.model_fields.keys())
 
     @classmethod
     def serialize_fields_info(cls, params_class: type[Params]) -> dict[str, Any]:
@@ -30,21 +31,28 @@ class OutputsSerializer:
     @staticmethod
     def serialize_parameter_datapaths(
         params_class: type[Params],
-        column_order_counter: Optional[itertools.count] = None,
+        column_order_counter: itertools.count | None = None,
     ) -> Iterator[OutputFieldSpecification]:
         """Serializes the parameter data paths of a Params class to JSON schema."""
         if column_order_counter is None:
             column_order_counter = itertools.count()
 
-        for field_name, field in params_class.__fields__.items():
+        for field_name, field in params_class.model_fields.items():
+            annotation = field.annotation
+            if annotation is None:
+                continue
+
             spec = OutputFieldSpecification(
                 data_path=f"action_result.parameter.{field_name}",
-                data_type=as_datatype(field.annotation),
+                data_type=as_datatype(annotation),
             )
-            if cef_types := field.field_info.extra.get("cef_types"):
+
+            json_schema_extra = parse_json_schema_extra(field.json_schema_extra)
+
+            if cef_types := json_schema_extra.get("cef_types"):
                 spec["contains"] = cef_types
 
-            column_name = field.field_info.extra.get("column_name")
+            column_name = json_schema_extra.get("column_name")
 
             if column_name is not None:
                 spec["column_name"] = column_name
@@ -56,7 +64,7 @@ class OutputsSerializer:
         cls,
         params_class: type[Params],
         outputs_class: type[ActionOutput],
-        summary_class: Optional[type[ActionOutput]] = None,
+        summary_class: type[ActionOutput] | None = None,
     ) -> list[OutputFieldSpecification]:
         """Serializes the data paths of an action to JSON schema."""
         status = OutputFieldSpecification(

soar_sdk/cli/package/cli.py

@@ -9,7 +9,7 @@ import json
 from pathlib import Path
 import asyncio
 import time
-from typing import Optional, Annotated
+from typing import Annotated
 from tqdm import tqdm
 from rich.console import Console
 from rich.panel import Panel
@@ -67,11 +67,11 @@ def build(
         ),
     ],
     output_file: Annotated[
-        Optional[Path],
+        Path | None,
         typer.Option("--output-file", "-o", show_default="derived from pyproject.toml"),
     ] = None,
     with_sdk_wheel_from: Annotated[
-        Optional[Path],
+        Path | None,
         typer.Option(
             "--with-sdk-wheel-from",
             "-w",
@@ -115,7 +115,7 @@ def build(
 
         console.print(f"Generated manifest for app:[green] {app_name}[/]")
 
-        def filter_source_files(t: tarfile.TarInfo) -> Optional[tarfile.TarInfo]:
+        def filter_source_files(t: tarfile.TarInfo) -> tarfile.TarInfo | None:
             if t.isdir() and "__pycache__" not in t.name:
                 return t
             if t.isfile() and t.name.endswith(".py"):
@@ -125,7 +125,7 @@ def build(
         with tarfile.open(output_file, "w:gz") as app_tarball:
             # Collect all wheels from both Python versions
             all_wheels = set(
-                app_meta.pip39_dependencies.wheel + app_meta.pip313_dependencies.wheel
+                app_meta.pip313_dependencies.wheel + app_meta.pip314_dependencies.wheel
             )
 
             # Run the async collection function within an event loop
@@ -188,8 +188,8 @@ def build(
                     input_file=wheel_archive_path,
                     input_file_aarch64=wheel_archive_path,
                 )
-                app_meta.pip39_dependencies.wheel.append(wheel_entry)
                 app_meta.pip313_dependencies.wheel.append(wheel_entry)
+                app_meta.pip314_dependencies.wheel.append(wheel_entry)
 
             console.print("Writing manifest")
             manifest_json = json.dumps(app_meta.to_json_manifest(), indent=4).encode()

soar_sdk/cli/package/utils.py

@@ -6,7 +6,7 @@ from collections.abc import AsyncGenerator
 @asynccontextmanager
 async def phantom_get_login_session(
     base_url: str, username: str, password: str
-) -> AsyncGenerator[httpx.AsyncClient, None]:
+) -> AsyncGenerator[httpx.AsyncClient]:
     """Contextmanager that creates an authenticated client with CSRF token handling."""
     # Set longer timeouts for large file uploads
     timeout = httpx.Timeout(30.0, read=60.0)