splunk-soar-sdk 2.0.1__tar.gz → 2.1.0__tar.gz

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.0.1
+Version: 2.1.0
 Summary: The official framework for developing and testing Splunk SOAR Apps
 Project-URL: Homepage, https://github.com/phantomcyber/splunk-soar-sdk
 Project-URL: Documentation, https://github.com/phantomcyber/splunk-soar-sdk

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "2.0.1"
+version = "2.1.0"
 description = "The official framework for developing and testing Splunk SOAR Apps"
 readme = "README.md"
 requires-python = ">=3.9, <3.14"

splunk_soar_sdk-2.1.0/release_notes.txt

@@ -0,0 +1,21 @@
+# [2.1.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.1...2.1.0) (2025-09-26)
+
+
+### Features
+
+* add a parameter to enable the action concurrency lock ([6ec9a5f](https://github.com/phantomcyber/splunk-soar-sdk/commit/6ec9a5fc69dbfaa528105f9d983e83c5544d06ba))
+
+
+
+
+
+# [2.1.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.1...2.1.0) (2025-09-26)
+
+
+### Features
+
+* add a parameter to enable the action concurrency lock ([6ec9a5f](https://github.com/phantomcyber/splunk-soar-sdk/commit/6ec9a5fc69dbfaa528105f9d983e83c5544d06ba))
+
+
+
+

splunk_soar_sdk-2.1.0/release_version.txt

@@ -0,0 +1 @@
+2.1.0

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.0}/src/soar_sdk/app.py

@@ -241,6 +241,7 @@ class App:
         view_template: Optional[str] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
+        enable_concurrency_lock: bool = False,
     ) -> Action:
         """Dynamically register an action function defined in another module.
 
@@ -301,6 +302,7 @@ class App:
             versions: Version constraint string for when this action is available.
                 Defaults to "EQ(*)" (all versions).
             summary_type: Pydantic model class for structuring action summary output.
+            enable_concurrency_lock: Whether to enable a concurrency lock for this action. Defaults to False.
 
         Returns:
             The registered Action instance with all metadata and handlers configured.
@@ -356,6 +358,7 @@ class App:
             view_handler=view_handler,
             versions=versions,
             summary_type=summary_type,
+            enable_concurrency_lock=enable_concurrency_lock,
         )(action)
 
     def _resolve_function_import(self, action_path: str) -> Callable:
@@ -421,6 +424,7 @@ class App:
         view_handler: Optional[Callable] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
+        enable_concurrency_lock: bool = False,
     ) -> ActionDecorator:
         """Decorator for registering an action function.
 
@@ -439,6 +443,7 @@ class App:
             view_handler=view_handler,
             versions=versions,
             summary_type=summary_type,
+            enable_concurrency_lock=enable_concurrency_lock,
         )
 
     def test_connectivity(self) -> ConnectivityTestDecorator:

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.0}/src/soar_sdk/decorators/action.py

@@ -42,6 +42,7 @@ class ActionDecorator:
         view_handler: Optional[Callable] = None,
         versions: str = "EQ(*)",
         summary_type: Optional[type[ActionOutput]] = None,
+        enable_concurrency_lock: bool = False,
     ) -> None:
         self.app = app
         self.name = name
@@ -55,6 +56,7 @@ class ActionDecorator:
         self.view_handler = view_handler
         self.versions = versions
         self.summary_type = summary_type
+        self.enable_concurrency_lock = enable_concurrency_lock
 
     def __call__(self, function: Callable) -> Action:
         """Decorator for the action handling function.
@@ -152,6 +154,7 @@ class ActionDecorator:
             versions=self.versions,
             view_handler=self.view_handler,
             summary_type=self.summary_type,
+            enable_concurrency_lock=self.enable_concurrency_lock,
         )
 
         self.app.actions_manager.set_action(action_identifier, inner)

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.0}/src/soar_sdk/meta/actions.py

@@ -22,6 +22,7 @@ class ActionMeta(BaseModel):
     output: Type[ActionOutput] = Field(default=ActionOutput)  # noqa: UP006
     view_handler: Optional[Callable] = None
     summary_type: Optional[Type[ActionOutput]] = Field(default=None, exclude=True)  # noqa: UP006
+    enable_concurrency_lock: bool = False
 
     def dict(self, *args: Any, **kwargs: Any) -> dict[str, Any]:  # noqa: ANN401
         """Serializes the action metadata to a dictionary."""
@@ -52,4 +53,8 @@ class ActionMeta(BaseModel):
         # Remove view_handler from the output since in render
         data.pop("view_handler", None)
 
+        if self.enable_concurrency_lock:
+            data["lock"] = {"enabled": True}
+        data.pop("enable_concurrency_lock", None)
+
         return data

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.0}/tests/meta/test_actions.py

@@ -70,3 +70,24 @@ def test_action_meta_dict_without_view_handler():
 
     assert "render" not in result
     assert "view_handler" not in result
+
+
+def test_action_meta_dict_with_concurrency_lock():
+    """Test ActionMeta.dict() with enable_concurrency_lock set to True."""
+
+    meta = ActionMeta(
+        action="test_action",
+        identifier="test_identifier",
+        description="Test description",
+        verbose="Test verbose",
+        type="generic",
+        read_only=True,
+        versions="EQ(*)",
+        enable_concurrency_lock=True,
+    )
+
+    result = meta.dict()
+
+    assert "lock" in result
+    assert result["lock"]["enabled"] is True
+    assert "enable_concurrency_lock" not in result

{splunk_soar_sdk-2.0.1 → splunk_soar_sdk-2.1.0}/uv.lock

@@ -1291,7 +1291,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "2.0.1"
+version = "2.1.0"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4", marker = "(python_full_version < '3.10' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'linux')" },

splunk_soar_sdk-2.0.1/release_notes.txt

@@ -1,21 +0,0 @@
-## [2.0.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.0...2.0.1) (2025-09-25)
-
-
-### Bug Fixes
-
-* handle lists and optionals of nested types properly ([98a84b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/98a84b52fa79aaf08b4ce7493abef76df94cfb37))
-
-
-
-
-
-## [2.0.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.0...2.0.1) (2025-09-25)
-
-
-### Bug Fixes
-
-* handle lists and optionals of nested types properly ([98a84b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/98a84b52fa79aaf08b4ce7493abef76df94cfb37))
-
-
-
-

splunk_soar_sdk-2.0.1/release_version.txt

@@ -1 +0,0 @@
-2.0.1