apache-airflow-providers-http 5.3.4__py3-none-any.whl → 5.4.0rc1__py3-none-any.whl

airflow/providers/http/__init__.py

@@ -29,7 +29,7 @@ from airflow import __version__ as airflow_version
 
 __all__ = ["__version__"]
 
-__version__ = "5.3.4"
+__version__ = "5.4.0"
 
 if packaging.version.parse(packaging.version.parse(airflow_version).base_version) < packaging.version.parse(
     "2.10.0"

airflow/providers/http/triggers/http.py

@@ -18,20 +18,30 @@ from __future__ import annotations
 
 import asyncio
 import base64
+import importlib
+import inspect
 import pickle
+import sys
 from collections.abc import AsyncIterator
 from importlib import import_module
 from typing import TYPE_CHECKING, Any
 
 import aiohttp
 import requests
+from asgiref.sync import sync_to_async
 from requests.cookies import RequestsCookieJar
 from requests.structures import CaseInsensitiveDict
 
 from airflow.exceptions import AirflowException
 from airflow.providers.http.hooks.http import HttpAsyncHook
+from airflow.providers.http.version_compat import AIRFLOW_V_3_0_PLUS
 from airflow.triggers.base import BaseTrigger, TriggerEvent
 
+if AIRFLOW_V_3_0_PLUS:
+    from airflow.triggers.base import BaseEventTrigger
+else:
+    from airflow.triggers.base import BaseTrigger as BaseEventTrigger  # type: ignore
+
 if TYPE_CHECKING:
     from aiohttp.client_reqrep import ClientResponse
 
@@ -105,21 +115,9 @@ class HttpTrigger(BaseTrigger):
 
     async def run(self) -> AsyncIterator[TriggerEvent]:
         """Make a series of asynchronous http calls via a http hook."""
-        hook = HttpAsyncHook(
-            method=self.method,
-            http_conn_id=self.http_conn_id,
-            auth_type=self.auth_type,
-        )
+        hook = self._get_async_hook()
         try:
-            async with aiohttp.ClientSession() as session:
-                client_response = await hook.run(
-                    session=session,
-                    endpoint=self.endpoint,
-                    data=self.data,
-                    headers=self.headers,
-                    extra_options=self.extra_options,
-                )
-                response = await self._convert_response(client_response)
+            response = await self._get_response(hook)
             yield TriggerEvent(
                 {
                     "status": "success",
@@ -129,6 +127,25 @@ class HttpTrigger(BaseTrigger):
         except Exception as e:
             yield TriggerEvent({"status": "error", "message": str(e)})
 
+    def _get_async_hook(self) -> HttpAsyncHook:
+        return HttpAsyncHook(
+            method=self.method,
+            http_conn_id=self.http_conn_id,
+            auth_type=self.auth_type,
+        )
+
+    async def _get_response(self, hook):
+        async with aiohttp.ClientSession() as session:
+            client_response = await hook.run(
+                session=session,
+                endpoint=self.endpoint,
+                data=self.data,
+                headers=self.headers,
+                extra_options=self.extra_options,
+            )
+            response = await self._convert_response(client_response)
+            return response
+
     @staticmethod
     async def _convert_response(client_response: ClientResponse) -> requests.Response:
         """Convert aiohttp.client_reqrep.ClientResponse to requests.Response."""
@@ -219,3 +236,84 @@ class HttpSensorTrigger(BaseTrigger):
             method=self.method,
             http_conn_id=self.http_conn_id,
         )
+
+
+class HttpEventTrigger(HttpTrigger, BaseEventTrigger):
+    """
+    HttpEventTrigger for event-based DAG scheduling when the API response satisfies the response check.
+
+    :param response_check_path: Path to the function that evaluates whether the API response
+        passes the conditions set by the user to fire the trigger. The method must be asynchronous.
+    :param http_conn_id: http connection id that has the base
+        API url i.e https://www.google.com/ and optional authentication credentials. Default
+        headers can also be specified in the Extra field in json format.
+    :param auth_type: The auth type for the service
+    :param method: The API method to be called
+    :param endpoint: Endpoint to be called, i.e. ``resource/v1/query?``.
+    :param headers: Additional headers to be passed through as a dict.
+    :param data: Payload to be uploaded or request parameters.
+    :param extra_options: Additional kwargs to pass when creating a request.
+    """
+
+    def __init__(
+        self,
+        response_check_path: str,
+        http_conn_id: str = "http_default",
+        auth_type: Any = None,
+        method: str = "GET",
+        endpoint: str | None = None,
+        headers: dict[str, str] | None = None,
+        data: dict[str, Any] | str | None = None,
+        extra_options: dict[str, Any] | None = None,
+    ):
+        super().__init__(http_conn_id, auth_type, method, endpoint, headers, data, extra_options)
+        self.response_check_path = response_check_path
+
+    def serialize(self) -> tuple[str, dict[str, Any]]:
+        """Serialize HttpEventTrigger arguments and classpath."""
+        return (
+            self.__class__.__module__ + "." + self.__class__.__qualname__,
+            {
+                "http_conn_id": self.http_conn_id,
+                "method": self.method,
+                "auth_type": self.auth_type,
+                "endpoint": self.endpoint,
+                "headers": self.headers,
+                "data": self.data,
+                "extra_options": self.extra_options,
+                "response_check_path": self.response_check_path,
+            },
+        )
+
+    async def run(self) -> AsyncIterator[TriggerEvent]:
+        """Make a series of asynchronous http calls via a http hook until the response passes the response check."""
+        hook = super()._get_async_hook()
+        try:
+            while True:
+                response = await super()._get_response(hook)
+                if await self._run_response_check(response):
+                    break
+            yield TriggerEvent(
+                {
+                    "status": "success",
+                    "response": base64.standard_b64encode(pickle.dumps(response)).decode("ascii"),
+                }
+            )
+        except Exception as e:
+            self.log.error("status: error, message: %s", str(e))
+
+    async def _import_from_response_check_path(self):
+        """Import the response check callable from the path provided by the user."""
+        module_path, func_name = self.response_check_path.rsplit(".", 1)
+        if module_path in sys.modules:
+            module = await sync_to_async(importlib.reload)(sys.modules[module_path])
+        module = await sync_to_async(importlib.import_module)(module_path)
+        return getattr(module, func_name)
+
+    async def _run_response_check(self, response) -> bool:
+        """Run the response_check callable provided by the user."""
+        response_check = await self._import_from_response_check_path()
+        if not inspect.iscoroutinefunction(response_check):
+            raise AirflowException("The response_check callable is not asynchronous.")
+        check = await response_check(response)
+        return check

airflow/providers/http/version_compat.py

@@ -33,6 +33,7 @@ def get_base_airflow_version_tuple() -> tuple[int, int, int]:
 
 
 AIRFLOW_V_3_0_PLUS = get_base_airflow_version_tuple() >= (3, 0, 0)
+
 AIRFLOW_V_3_1_PLUS: bool = get_base_airflow_version_tuple() >= (3, 1, 0)
 
 if AIRFLOW_V_3_1_PLUS:

{apache_airflow_providers_http-5.3.4.dist-info → apache_airflow_providers_http-5.4.0rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apache-airflow-providers-http
-Version: 5.3.4
+Version: 5.4.0rc1
 Summary: Provider package apache-airflow-providers-http for Apache Airflow
 Keywords: airflow-provider,http,airflow,integration
 Author-email: Apache Software Foundation <dev@airflow.apache.org>
@@ -20,14 +20,14 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: System :: Monitoring
-Requires-Dist: apache-airflow>=2.10.0
+Requires-Dist: apache-airflow>=2.10.0rc1
 Requires-Dist: requests>=2.32.0,<3
 Requires-Dist: requests-toolbelt>=1.0.0
 Requires-Dist: aiohttp>=3.12.14
 Requires-Dist: asgiref>=2.3.0
 Project-URL: Bug Tracker, https://github.com/apache/airflow/issues
-Project-URL: Changelog, https://airflow.apache.org/docs/apache-airflow-providers-http/5.3.4/changelog.html
-Project-URL: Documentation, https://airflow.apache.org/docs/apache-airflow-providers-http/5.3.4
+Project-URL: Changelog, https://airflow.staged.apache.org/docs/apache-airflow-providers-http/5.4.0/changelog.html
+Project-URL: Documentation, https://airflow.staged.apache.org/docs/apache-airflow-providers-http/5.4.0
 Project-URL: Mastodon, https://fosstodon.org/@airflow
 Project-URL: Slack Chat, https://s.apache.org/airflow-slack
 Project-URL: Source Code, https://github.com/apache/airflow
@@ -58,7 +58,7 @@ Project-URL: YouTube, https://www.youtube.com/channel/UCSXwxpWZQ7XZ1WL3wqevChA/
 
 Package ``apache-airflow-providers-http``
 
-Release: ``5.3.4``
+Release: ``5.4.0``
 
 
 `Hypertext Transfer Protocol (HTTP) <https://www.w3.org/Protocols/>`__
@@ -71,7 +71,7 @@ This is a provider package for ``http`` provider. All classes for this provider
 are in ``airflow.providers.http`` python package.
 
 You can find package information and changelog for the provider
-in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-http/5.3.4/>`_.
+in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-http/5.4.0/>`_.
 
 Installation
 ------------
@@ -96,5 +96,5 @@ PIP package            Version required
 =====================  ==================
 
 The changelog for the provider package can be found in the
-`changelog <https://airflow.apache.org/docs/apache-airflow-providers-http/5.3.4/changelog.html>`_.
+`changelog <https://airflow.apache.org/docs/apache-airflow-providers-http/5.4.0/changelog.html>`_.
 

{apache_airflow_providers_http-5.3.4.dist-info → apache_airflow_providers_http-5.4.0rc1.dist-info}/RECORD

@@ -1,8 +1,8 @@
 airflow/providers/http/LICENSE,sha256=gXPVwptPlW1TJ4HSuG5OMPg-a3h43OGMkZRR1rpwfJA,10850
-airflow/providers/http/__init__.py,sha256=RmrtyqR3ka6J3c4gx9P5sv3P4biGxAWT5wulO7Yiqz4,1493
+airflow/providers/http/__init__.py,sha256=TkZJvkSq4g9quBruQL2QpSuh8OpLxS2hgjzIW2oScwU,1493
 airflow/providers/http/exceptions.py,sha256=WnIEj0cnAS746uRF1661tCEBc_Uuo0bMEIMrQyEb9nc,1084
 airflow/providers/http/get_provider_info.py,sha256=eJrWksE0KVCB32BavHb64imCUZZIoWyJYnsBj8UsS9Y,2657
-airflow/providers/http/version_compat.py,sha256=MGhWZkvkF4S7MI6wOQmQrUCKHJ2vqDe1WjSkQNyAtRU,2082
+airflow/providers/http/version_compat.py,sha256=v-uQ9ARthMV1C075gyNfc1w7xDtcxQzLH0zpuoB9rB0,2083
 airflow/providers/http/hooks/__init__.py,sha256=mlJxuZLkd5x-iq2SBwD3mvRQpt3YR7wjz_nceyF1IaI,787
 airflow/providers/http/hooks/http.py,sha256=MoEyhIJtXB9sNy-Avrrm2oVc4VugAlBSq18CAvylJgo,22587
 airflow/providers/http/operators/__init__.py,sha256=mlJxuZLkd5x-iq2SBwD3mvRQpt3YR7wjz_nceyF1IaI,787
@@ -10,8 +10,8 @@ airflow/providers/http/operators/http.py,sha256=KzviUKRlf0-Omam9bjQuguWhvHmQTtlZ
 airflow/providers/http/sensors/__init__.py,sha256=mlJxuZLkd5x-iq2SBwD3mvRQpt3YR7wjz_nceyF1IaI,787
 airflow/providers/http/sensors/http.py,sha256=4lIgV7-3AUy64tAv9N5lKiDtWYaqaVHG_cXkz_Gijq8,8502
 airflow/providers/http/triggers/__init__.py,sha256=mlJxuZLkd5x-iq2SBwD3mvRQpt3YR7wjz_nceyF1IaI,787
-airflow/providers/http/triggers/http.py,sha256=DG4_20edkRT44grqB5Gyx8pD0ueYsTURpsBMRwO1SNQ,8501
-apache_airflow_providers_http-5.3.4.dist-info/entry_points.txt,sha256=65Rk4MYlxxtwo7y7-uNv4KS7MfoBnILhMjRQmNbRo1Q,100
-apache_airflow_providers_http-5.3.4.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-apache_airflow_providers_http-5.3.4.dist-info/METADATA,sha256=24sxYo0EMGgNm3B5NMm8W1zrlMtoqLQHcxH6TX0XKvQ,4088
-apache_airflow_providers_http-5.3.4.dist-info/RECORD,,
+airflow/providers/http/triggers/http.py,sha256=67Ri86fOubQJtto_cF2aOo9U7xA46Qjg60LqfdFgn6M,12709
+apache_airflow_providers_http-5.4.0rc1.dist-info/entry_points.txt,sha256=65Rk4MYlxxtwo7y7-uNv4KS7MfoBnILhMjRQmNbRo1Q,100
+apache_airflow_providers_http-5.4.0rc1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+apache_airflow_providers_http-5.4.0rc1.dist-info/METADATA,sha256=2RsnhxmkagmnYvCiZFgS1bA3jm4nE1KxyXgdGjno88g,4108
+apache_airflow_providers_http-5.4.0rc1.dist-info/RECORD,,