splunk-soar-sdk 3.3.2__tar.gz → 3.4.0__tar.gz

{splunk_soar_sdk-3.3.2 → splunk_soar_sdk-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 3.3.2
+Version: 3.4.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-3.3.2 → splunk_soar_sdk-3.4.0}/pyproject.toml

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

splunk_soar_sdk-3.4.0/release_notes.txt

@@ -0,0 +1,21 @@
+# [3.4.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.3.2...3.4.0) (2025-12-04)
+
+
+### Features
+
+* type property for poll now vs scheduled ([33a14b3](https://github.com/phantomcyber/splunk-soar-sdk/commit/33a14b3ae50f9b6583205a06aac0d927e1a1abc0))
+
+
+
+
+
+# [3.4.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.3.2...3.4.0) (2025-12-04)
+
+
+### Features
+
+* type property for poll now vs scheduled ([33a14b3](https://github.com/phantomcyber/splunk-soar-sdk/commit/33a14b3ae50f9b6583205a06aac0d927e1a1abc0))
+
+
+
+

splunk_soar_sdk-3.4.0/release_version.txt

@@ -0,0 +1 @@
+3.4.0

{splunk_soar_sdk-3.3.2 → splunk_soar_sdk-3.4.0}/src/soar_sdk/params.py

@@ -14,6 +14,8 @@ remove_when_soar_newer_than(
     "7.0.0", "NotRequired from typing_extensions is in typing in Python 3.11+"
 )
 
+MAX_COUNT_VALUE = 4294967295
+
 
 def Param(
     description: str | None = None,
@@ -192,6 +194,12 @@ class OnPollParams(Params):
         allow_list=True,
     )
 
+    def is_manual_poll(self) -> bool:
+        """Check if this is a manual poll execution (poll now) vs scheduled polling."""
+        if not self.container_count:
+            return False
+        return int(self.container_count) != MAX_COUNT_VALUE
+
 
 class OnESPollParams(Params):
     """Canonical parameters for the special 'on es poll' action."""

{splunk_soar_sdk-3.3.2 → splunk_soar_sdk-3.4.0}/tests/example_app/src/app.py

@@ -156,6 +156,11 @@ def http_action(params: MakeRequestParamsCustom, asset: Asset) -> MakeRequestOut
 def on_poll(
     params: OnPollParams, soar: SOARClient, asset: Asset
 ) -> Iterator[Container | Artifact]:
+    if params.is_manual_poll():
+        logger.info("Manual poll (poll now) detected")
+    else:
+        logger.info("Scheduled poll detected")
+
     # Create container first for artifacts
     yield Container(
         name="Network Alerts",

{splunk_soar_sdk-3.3.2 → splunk_soar_sdk-3.4.0}/tests/test_on_poll.py

@@ -322,3 +322,71 @@ def test_on_poll_actionmeta_dict_output_empty(app_with_action: App):
     meta_dict = action.meta.model_dump()
     assert "output" in meta_dict
     assert meta_dict["output"] == []
+
+
+def test_on_poll_is_manual_poll_with_limited_container_count():
+    """Test that is_manual_poll returns True when container_count is limited."""
+    params = OnPollParams(
+        start_time=0,
+        end_time=1,
+        container_count=100,
+    )
+    assert params.is_manual_poll() is True
+
+
+def test_on_poll_is_manual_poll_with_max_container_count():
+    """Test that is_manual_poll returns False when container_count is MAX_COUNT_VALUE."""
+    MAX_COUNT_VALUE = 4294967295
+    params = OnPollParams(
+        start_time=0,
+        end_time=1,
+        container_count=MAX_COUNT_VALUE,
+    )
+    assert params.is_manual_poll() is False
+
+
+def test_on_poll_is_manual_poll_without_container_count():
+    """Test that is_manual_poll returns False when no container_count is provided."""
+    params = OnPollParams(
+        start_time=0,
+        end_time=1,
+    )
+    assert params.is_manual_poll() is False
+
+
+def test_on_poll_is_manual_poll_with_zero_container_count():
+    """Test that is_manual_poll returns False when container_count is zero."""
+    params = OnPollParams(
+        start_time=0,
+        end_time=1,
+        container_count=0,
+    )
+    assert params.is_manual_poll() is False
+
+
+def test_on_poll_is_manual_poll_in_function(
+    app_with_action: App, mocker: pytest_mock.MockerFixture
+):
+    """Test that is_manual_poll can be used within an on_poll function."""
+    poll_type_captured = []
+
+    @app_with_action.on_poll()
+    def on_poll_function(params: OnPollParams):
+        poll_type_captured.append(params.is_manual_poll())
+        yield Container(name="test")
+
+    mocker.patch.object(
+        app_with_action.actions_manager,
+        "save_container",
+        return_value=(True, "Created", 1),
+    )
+
+    params_manual = OnPollParams(container_count=100)
+    on_poll_function(params_manual)
+    assert poll_type_captured[-1] is True
+
+    params_scheduled = OnPollParams(
+        start_time=0, end_time=1, container_count=4294967295
+    )
+    on_poll_function(params_scheduled)
+    assert poll_type_captured[-1] is False

{splunk_soar_sdk-3.3.2 → splunk_soar_sdk-3.4.0}/uv.lock

@@ -1164,7 +1164,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "3.3.2"
+version = "3.4.0"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4", marker = "(platform_machine == 'arm64' and sys_platform == 'darwin') or (platform_machine == 'x86_64' and sys_platform == 'darwin') or (platform_machine == 'aarch64' and sys_platform == 'linux') or (platform_machine == 'x86_64' and sys_platform == 'linux')" },

splunk_soar_sdk-3.3.2/release_notes.txt

@@ -1,21 +0,0 @@
-## [3.3.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.3.1...3.3.2) (2025-12-03)
-
-
-### Bug Fixes
-
-* allow any Python 3.14.x version, not just 3.14.0 ([3bfc69e](https://github.com/phantomcyber/splunk-soar-sdk/commit/3bfc69e9c9609953b675237fad245a95cbcbd0bd))
-
-
-
-
-
-## [3.3.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/3.3.1...3.3.2) (2025-12-03)
-
-
-### Bug Fixes
-
-* allow any Python 3.14.x version, not just 3.14.0 ([3bfc69e](https://github.com/phantomcyber/splunk-soar-sdk/commit/3bfc69e9c9609953b675237fad245a95cbcbd0bd))
-
-
-
-

splunk_soar_sdk-3.3.2/release_version.txt

@@ -1 +0,0 @@
-3.3.2