From 57dbb113114603a743bec2fc407307336a9f2385 Mon Sep 17 00:00:00 2001 From: AlessandroLollo Date: Mon, 1 Nov 2021 15:22:27 +0100 Subject: [PATCH] Fix/kafka tasks docs (#5094) * Added Kafka tasks to docs * Added changes file * Fixed Kafka task __init__ * Added missing docstrings Co-authored-by: Alessandro Lollo --- changes/pr5094.yaml | 5 +++++ docs/outline.toml | 8 ++++++++ src/prefect/tasks/kafka/__init__.py | 10 ++++++++++ src/prefect/tasks/kafka/kafka.py | 2 ++ 4 files changed, 25 insertions(+) create mode 100644 changes/pr5094.yaml diff --git a/changes/pr5094.yaml b/changes/pr5094.yaml new file mode 100644 index 000000000000..4780b5bd202a --- /dev/null +++ b/changes/pr5094.yaml @@ -0,0 +1,5 @@ +enhancement: + - "Added Kafka Tasks entry to website docs - (https://github.com/PrefectHQ/prefect/pull/5094)" + +contributor: + - "[Alessandro Lollo](https://github.com/AlessandroLollo)" diff --git a/docs/outline.toml b/docs/outline.toml index 45b8ed4e2858..16b15fd55a2e 100644 --- a/docs/outline.toml +++ b/docs/outline.toml @@ -475,6 +475,14 @@ title = "Jupyter Tasks" module = "prefect.tasks.jupyter" classes = ["ExecuteNotebook"] +[pages.tasks.kafka] +title = "Kafka Tasks" +module = "prefect.tasks.kafka" +classes = [ + "KafkaBatchConsume", + "KafkaBatchProduce" +] + [pages.tasks.monday] title = "Monday Tasks" module = "prefect.tasks.monday" diff --git a/src/prefect/tasks/kafka/__init__.py b/src/prefect/tasks/kafka/__init__.py index e69de29bb2d1..250d7700941e 100644 --- a/src/prefect/tasks/kafka/__init__.py +++ b/src/prefect/tasks/kafka/__init__.py @@ -0,0 +1,10 @@ +""" +This module contains a collection of tasks to produce and consume Kafka events +""" + +try: + from prefect.tasks.kafka.kafka import KafkaBatchConsume, KafkaBatchProduce +except ImportError as err: + raise ImportError( + 'Using `prefect.tasks.kafka` requires Prefect to be installed with the "kafka" extra.' + ) from err diff --git a/src/prefect/tasks/kafka/kafka.py b/src/prefect/tasks/kafka/kafka.py index 7ece0b150fa9..9bf87d1a305d 100644 --- a/src/prefect/tasks/kafka/kafka.py +++ b/src/prefect/tasks/kafka/kafka.py @@ -82,6 +82,8 @@ def run( closing the consumer - kafka_configs (dict, optional): a dict of kafka client configuration properties used to construct the consumer. + - **kwargs (Any, optional): additional keyword arguments to pass to the standard Task + init method Returns: - List of consumed messages """