Star Quix Streams

 Install Quix Streams

 Edit on GitHub

Sources

quixstreams.sources.base

BaseSource

class BaseSource(ABC)

[VIEW SOURCE]

This is the base class for all sources.

Sources are executed in a sub-process of the main application.

To create your own source you need to implement: * run * stop * default_topic

BaseSource is the most basic interface, and the framework expects every sources to implement it. Use Source to benefit from a base implementation.

You can connect a source to a StreamingDataframe using the Application.

Example snippet:

from quixstreams import Application
from quixstreams.sources import Source

class MySource(Source):
    def run(self):
        for _ in range(1000):
            self.produce(
                key="foo",
                value=b"foo"
            )

def main():
    app = Application()
    source = MySource(name="my_source")

    sdf = app.dataframe(source=source)
    sdf.print(metadata=True)

    app.run(sdf)

if __name__ == "__main__":
    main()

BaseSource.configure

def configure(topic: Topic, producer: RowProducer) -> None

[VIEW SOURCE]

This method is triggered when the source is registered to the Application.

It configures the source's Kafka producer and the topic it will produce to.

BaseSource.start

@abstractmethod
def start() -> None

[VIEW SOURCE]

This method is triggered in the subprocess when the source is started.

The subprocess will run as long as the start method executes. Use it to fetch data and produce it to Kafka.

BaseSource.stop

@abstractmethod
def stop() -> None

[VIEW SOURCE]

This method is triggered when the application is shutting down.

The source must ensure that the run method is completed soon.

Example Snippet:

class MySource(BaseSource):
    def start(self):
        self._running = True
        while self._running:
            self._producer.produce(
                topic=self._producer_topic,
                value="foo",
            )
            time.sleep(1)

    def stop(self):
        self._running = False

BaseSource.default_topic

@abstractmethod
def default_topic() -> Topic

[VIEW SOURCE]

This method is triggered when the topic is not provided to the source.

The source must return a default topic configuration.

Source

class Source(BaseSource)

[VIEW SOURCE]

BaseSource class implementation providing

Implementation for the abstract method: * default_topic * start * stop

Helper methods * serialize * produce * flush

Helper property * running

Subclass it and implement the run method to fetch data and produce it to Kafka.

Source.__init__

def __init__(name: str, shutdown_timeout: float = 10) -> None

[VIEW SOURCE]

Arguments:

• name: The source unique name. Used to generate the topic configurtion
• shutdown_timeout: Time in second the application waits for the source to gracefully shutdown

Source.running

@property
def running() -> bool

[VIEW SOURCE]

Property indicating if the source is running.

The stop method will set it to False. Use it to stop the source gracefully.

Example snippet:

class MySource(Source):
    def run(self):
        while self.running:
            self.produce(
                value="foo",
            )
            time.sleep(1)

Source.cleanup

def cleanup(failed: bool) -> None

[VIEW SOURCE]

This method is triggered once the run method completes.

Use it to clean up the resources and shut down the source gracefully.

It flush the producer when _run completes successfully.

Source.stop

def stop() -> None

[VIEW SOURCE]

This method is triggered when the application is shutting down.

It sets the running property to False.

Source.start

def start()

[VIEW SOURCE]

This method is triggered in the subprocess when the source is started.

It marks the source as running, execute it's run method and ensure cleanup happens.

Source.run

@abstractmethod
def run()

[VIEW SOURCE]

This method is triggered in the subprocess when the source is started.

The subprocess will run as long as the run method executes. Use it to fetch data and produce it to Kafka.

Source.serialize

def serialize(key: Optional[object] = None,
              value: Optional[object] = None,
              headers: Optional[Headers] = None,
              timestamp_ms: Optional[int] = None) -> KafkaMessage

[VIEW SOURCE]

Serialize data to bytes using the producer topic serializers and return a quixstreams.models.messages.KafkaMessage.

Returns:

quixstreams.models.messages.KafkaMessage

Source.produce

def produce(value: Optional[Union[str, bytes]] = None,
            key: Optional[Union[str, bytes]] = None,
            headers: Optional[Headers] = None,
            partition: Optional[int] = None,
            timestamp: Optional[int] = None,
            poll_timeout: float = 5.0,
            buffer_error_max_tries: int = 3) -> None

[VIEW SOURCE]

Produce a message to the configured source topic in Kafka.

Source.flush

def flush(timeout: Optional[float] = None) -> None

[VIEW SOURCE]

This method flush the producer.

It ensures all messages are successfully delivered to Kafka.

Arguments:

• timeout (float): time to attempt flushing (seconds). None use producer default or -1 is infinite. Default: None

Raises:

• CheckpointProducerTimeout: if any message fails to produce before the timeout

Source.default_topic

def default_topic() -> Topic

[VIEW SOURCE]

Return a default topic matching the source name.

The default topic will not be used if the topic has already been provided to the source.

Returns:

quixstreams.models.topics.Topic

quixstreams.sources.csv

CSVSource

class CSVSource(Source)

[VIEW SOURCE]

CSVSource.__init__

def __init__(path: str,
             dialect: str = "excel",
             name: Optional[str] = None,
             shutdown_timeout: float = 10,
             key_deserializer: Callable[[Any], str] = str,
             value_deserializer: Callable[[Any], str] = json.loads) -> None

[VIEW SOURCE]

A base CSV source that reads data from a single CSV file.

Best used with quixstreams.sinks.csv.CSVSink.

Required columns: key, value Optional columns: timestamp

Arguments:

• path: path to the CSV file
• dialect: a CSV dialect to use. It affects quoting and delimiters. See the "csv" module docs for more info. Default - "excel".
• key_deseralizer: a callable to convert strings to key. Default - str
• value_deserializer: a callable to convert strings to value. Default - json.loads

quixstreams.sources.kafka.kafka

KafkaReplicatorSource

class KafkaReplicatorSource(Source)

[VIEW SOURCE]

Source implementation that replicates a topic from a Kafka broker to your application broker.

Running multiple instances of this source is supported.

Example Snippet:

from quixstreams import Application
from quixstreams.sources.kafka import KafkaReplicatorSource

app = Application(
    consumer_group="group",
)

source = KafkaReplicatorSource(
    name="source-second-kafka",
    app_config=app.config,
    topic="second-kafka-topic",
    broker_address="localhost:9092",
)

sdf = app.dataframe(source=source)
sdf = sdf.print()
app.run(sdf)

KafkaReplicatorSource.__init__

def __init__(name: str,
             app_config: "ApplicationConfig",
             topic: str,
             broker_address: Union[str, ConnectionConfig],
             auto_offset_reset: AutoOffsetReset = "latest",
             consumer_extra_config: Optional[dict] = None,
             consumer_poll_timeout: Optional[float] = None,
             shutdown_timeout: float = 10,
             on_consumer_error: Optional[
                 ConsumerErrorCallback] = default_on_consumer_error,
             value_deserializer: DeserializerType = "json",
             key_deserializer: DeserializerType = "bytes") -> None

[VIEW SOURCE]

Arguments:

• name: The source unique name. It is used to generate the default topic name and consumer group name on the source broker. Running multiple instances of KafkaReplicatorSource with the same name connected to the same broker will make them share the same consumer group.
• app_config: The configuration of the application. Used by the source to connect to the application kafka broker.
• topic: The topic to replicate.
• broker_address: The connection settings for the source Kafka.
• auto_offset_reset: Consumer auto.offset.reset setting. Default - Use the Application auto_offset_reset setting.
• consumer_extra_config: A dictionary with additional options that will be passed to confluent_kafka.Consumer as is. Default - None
• consumer_poll_timeout: timeout for RowConsumer.poll() Default - Use the Application consumer_poll_timeout setting.
• shutdown_timeout: Time in second the application waits for the source to gracefully shutdown.
• on_consumer_error: Triggered when the source Consumer fails to poll Kafka.
• value_deserializer: The default topic value deserializer, used by StreamingDataframe connected to the source. Default - json
• key_deserializer: The default topic key deserializer, used by StreamingDataframe connected to the source. Default - json

quixstreams.sources.kafka.quix

QuixEnvironmentSource

class QuixEnvironmentSource(KafkaReplicatorSource)

[VIEW SOURCE]

Source implementation that replicates a topic from a Quix Cloud environment to your application broker. It can copy messages for development and testing without risking producing them back or affecting the consumer groups.

Running multiple instances of this source is supported.

Example Snippet:

from quixstreams import Application
from quixstreams.sources.kafka import QuixEnvironmentSource

app = Application(
    consumer_group="group",
)

source = QuixEnvironmentSource(
    name="source-quix",
    app_config=app.config,
    quix_workspace_id="WORKSPACE_ID",
    quix_sdk_token="WORKSPACE_SDK_TOKEN",
    topic="quix-source-topic",
)

sdf = app.dataframe(source=source)
sdf = sdf.print()
app.run(sdf)

QuixEnvironmentSource.__init__

def __init__(name: str,
             app_config: "ApplicationConfig",
             topic: str,
             quix_sdk_token: str,
             quix_workspace_id: str,
             quix_portal_api: Optional[str] = None,
             auto_offset_reset: Optional[AutoOffsetReset] = None,
             consumer_extra_config: Optional[dict] = None,
             consumer_poll_timeout: Optional[float] = None,
             shutdown_timeout: float = 10,
             on_consumer_error: Optional[
                 ConsumerErrorCallback] = default_on_consumer_error,
             value_deserializer: DeserializerType = "json",
             key_deserializer: DeserializerType = "bytes") -> None

[VIEW SOURCE]

Arguments:

• quix_workspace_id: The Quix workspace ID of the source environment.
• quix_sdk_token: Quix cloud sdk token used to connect to the source environment.
• quix_portal_api: The Quix portal API URL of the source environment. Default - Quix__Portal__Api environment variable or Quix cloud production URL

For other parameters See quixstreams.sources.kafka.KafkaReplicatorSource