splunk-soar-sdk 2.0.0__py3-none-any.whl → 2.1.0__py3-none-any.whl

soar_sdk/action_results.py

@@ -182,20 +182,29 @@ class ActionOutput(BaseModel):
             field_type = field.annotation
             datapath = parent_datapath + f".{field_name}"
 
-            # Handle list types, even nested ones
-            while get_origin(field_type) is list:
-                field_type = get_args(field_type)[0]
-                datapath += ".*"
-
-            if get_origin(field_type) is Union or get_origin(field_type) is Optional:
+            # Handle lists and optional types, even nested ones
+            origin = get_origin(field_type)
+            while origin in [list, Union, Optional]:
                 type_args = [
-                    arg for arg in get_args(field_type) if arg is not type(None)
+                    arg
+                    for arg in get_args(field_type)
+                    if arg is not type(None) and arg is not None
                 ]
-                if len(type_args) > 1:
-                    raise TypeError(
-                        f"Output field {field_name} is invalid: the only valid Union type is Optional, or Union[X, None]."
-                    )
+
+                if origin is list:
+                    if len(type_args) != 1:
+                        raise TypeError(
+                            f"Output field {field_name} is invalid: List types must have exactly one non-null type argument."
+                        )
+                    datapath += ".*"
+                else:
+                    if len(type_args) != 1:
+                        raise TypeError(
+                            f"Output field {field_name} is invalid: the only valid Union type is Optional, or Union[X, None]."
+                        )
+
                 field_type = type_args[0]
+                origin = get_origin(field_type)
 
             if issubclass(field_type, ActionOutput):
                 # If the field is another ActionOutput, recursively call _to_json_schema

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:

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)

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.0.dist-info → splunk_soar_sdk-2.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.0.0
+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.0.dist-info → splunk_soar_sdk-2.1.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
 soar_sdk/abstract.py,sha256=jGXs2Fv5TRpnh5Duz3mWjY8_DAOpY4RSSzvw_z4XN4I,7950
-soar_sdk/action_results.py,sha256=VJaBzXY0CW1Ncvo0E1ospxYi1buGER6JhL2BoQ4Dbwo,9770
+soar_sdk/action_results.py,sha256=7uEl1KidC2gkNOuBzOq2_3EiAGfRQYrDYD3CR-G6DKg,10116
 soar_sdk/actions_manager.py,sha256=wJCyfzkI_6OKZ-Kmll4vRJpGvYdL93Uw-JyEEGnKcw0,5779
-soar_sdk/app.py,sha256=mFzfGTtsCdlrp5Q0amj53s07oXC5Zhy7ym7U0zFPjQs,32580
+soar_sdk/app.py,sha256=yCD4HqJKFhfehyXixHqO-kEwzycII-_ephRpxEINIE0,32906
 soar_sdk/app_cli_runner.py,sha256=fJoozhyAt7QUMuc02nE5RL_InpsjQBpr6U4rF9sey3E,11627
 soar_sdk/app_client.py,sha256=0r3jIvMM8szCEHXOgRu07VaovKH96pZut5rn2GfYcsc,6275
 soar_sdk/asset.py,sha256=deS8_B5hr7W2fED8_6wUpVriRgiQ5r8TkGVHiasIaro,10666
@@ -49,14 +49,14 @@ soar_sdk/code_renderers/renderer.py,sha256=oDlmU-MzDqpc4Yq6zupoT4XN-vRjgL4UV5lOG
 soar_sdk/code_renderers/toml_renderer.py,sha256=-zP8UzlYMCVVA5ex9slaNLeFTu4xLjkv88YLmRNLrTM,1505
 soar_sdk/code_renderers/templates/pyproject.toml.jinja,sha256=Ti6A5kWMb902Lbd1kmw8qPgVDPNNzlV6rd0pcVEbVUo,3917
 soar_sdk/decorators/__init__.py,sha256=ttvapTczeQpReZVYgjTw4qnEqKd7b8pR7lNaCpO0npQ,513
-soar_sdk/decorators/action.py,sha256=7S43XFl0WBa9BYOpyFhlSmxT-08DvV1VQ4P5nEMw8ms,6128
+soar_sdk/decorators/action.py,sha256=WgkOtlfUpRGkFv1Be1ycRm3s_1UYabCJqoI5MMFWsi8,6304
 soar_sdk/decorators/make_request.py,sha256=W_ltGvryTvdKomiJ8gL7rE_KVc1VVodhFYstGxB8d4Q,5527
 soar_sdk/decorators/on_poll.py,sha256=xdT0QSa_dnh37XdJNGW-DAZsb9oQO5tjxPbIQmWpaZs,8232
 soar_sdk/decorators/test_connectivity.py,sha256=8uXMD4NW5bokpsAfBctUrfOR4K_geYLEZUY0Y6uI6aU,3568
 soar_sdk/decorators/view_handler.py,sha256=jhBzbJcokWOeUWR4_orDRWTXiiVwE9RZdRSvNUYF3S0,7362
 soar_sdk/decorators/webhook.py,sha256=Pde0MjxC2kckpxoKb3m4WVfLWtiFAAzAwZe5AF5VIbE,2400
 soar_sdk/meta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-soar_sdk/meta/actions.py,sha256=-Py_AbQ9BOr3P-J9OrKTTdKAQvNZ5g6xvgYLCjJktlg,2215
+soar_sdk/meta/actions.py,sha256=L64T9DaWGiqjS2EpB72kO-63gPuVyCJ-lYlaKAvT2uM,2394
 soar_sdk/meta/adapters.py,sha256=KjSYIUtkCz2eesA_vhsNCjfi5C-Uz71tbSuDIjhuB8U,1112
 soar_sdk/meta/app.py,sha256=rwgoFfIFnLutLB9PF1kR7X1neKs175VA0Xx4KpJ6c7I,1765
 soar_sdk/meta/datatypes.py,sha256=piR-oBVAATiRciXSdVE7XaqjUZTgSaOvTEqcOcNvCS0,795
@@ -96,8 +96,8 @@ soar_sdk/views/components/pie_chart.py,sha256=LVTeHVJN6nf2vjUs9y7PDBhS0U1fKW750l
 soar_sdk/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/webhooks/models.py,sha256=-rjuFA9cRX5zTLp7cHSHVTkt5eVJD6BdESGbj_qkyHI,4540
 soar_sdk/webhooks/routing.py,sha256=BKbURSrBPdOTS5UFL-mHzFEr-Fj04mJMx9KeiPrZ2VQ,6872
-splunk_soar_sdk-2.0.0.dist-info/METADATA,sha256=GiFXmEsBHTw7YBcnk8OV5U48usWYNpd-djWhMy_eeiI,7361
-splunk_soar_sdk-2.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-2.0.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-2.0.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-2.0.0.dist-info/RECORD,,
+splunk_soar_sdk-2.1.0.dist-info/METADATA,sha256=lk4jyDyQKtbWUH3aTODNW4eSQho4UKsQ4sNmiMB7MH8,7361
+splunk_soar_sdk-2.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-2.1.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-2.1.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-2.1.0.dist-info/RECORD,,