DefStream-RabbitMQ 0.1.24__110-py3-none-any.whl

DefStream/Broker/Implements/RabbitMQ/Stream.py

@@ -0,0 +1,181 @@
+# -*- coding: utf-8 -*-
+
+from DefStream.Broker import (
+	Sendable,
+	Readable,
+)
+from .Serializer import (
+	Encoder,
+	Decoder,
+)
+from .Event import Event
+
+from pika import (
+	BlockingConnection,
+	BasicProperties,
+)
+
+from time import time
+from logging import getLogger
+from uuid import uuid4
+
+from typing import (
+	Dict,
+	Generator,
+	Optional,
+)
+
+__all__ = (
+	'Stream',
+)
+
+
+class Stream(
+	Sendable,
+	Readable,
+):
+	"""Stream of Event Broker for RabbitMQ"""
+	logger = getLogger('Broker.RabbitMQ.Stream')
+
+	def __init__(
+		self,
+		connection: BlockingConnection,
+		encode: Encoder,
+		decode: Decoder,
+		name: str,
+	):
+		self.connection = connection
+		self.encode = encode
+		self.decode = decode
+		try:
+			self.channel = self.connection.channel()
+		except Exception as error:
+			self.logger.error('Stream channel creation failed: queue=%s error_type=%s', name, type(error).__name__)
+			raise
+		self.queue = name
+		self.event = None
+		return
+
+	def __del__(self):
+		channel = getattr(self, 'channel', None)
+		try:
+			if channel and channel.is_open:
+				channel.close()
+				self.logger.debug('Stream channel cleanup completed: queue=%s', self.queue)
+		except Exception as error:
+			self.logger.error('Stream channel cleanup failed: error_type=%s', type(error).__name__)
+			raise
+		return
+	
+	def __str__(self): return self.queue
+
+	def send(
+		self,
+		body,
+		event: Optional[str] = None,
+		headers: Dict = {},
+		timestamp: Optional[int] = None,
+		id: Optional[str] = None,
+	):
+		if not timestamp: timestamp = int(time())
+		if not id: id = uuid4().hex
+		properties = BasicProperties(
+			type=event if event else '',
+			headers=headers,
+			content_type=self.encode.format,
+			content_encoding=self.encode.charset,
+			timestamp=timestamp,
+			message_id=id,
+		)
+		self.logger.debug('Publishing Stream message: queue=%s message_id=%s publisher_confirm=False', self.queue, id)
+		try:
+			self.channel.basic_publish(
+				exchange='',
+				routing_key=self.queue,
+				properties=properties,
+				body=self.encode(body)
+			)
+		except Exception as error:
+			self.logger.error('Stream publication failed: queue=%s message_id=%s error_type=%s', self.queue, id, type(error).__name__)
+			raise
+		self.logger.debug('Stream publish API call completed: queue=%s message_id=%s', self.queue, id)
+		return id
+
+	def read(self, offset: int = 0, timeout: Optional[int] = None) -> Generator[Event, None, None]:
+		channel = self.channel
+		self.logger.debug('Starting Stream read: queue=%s offset=%s timeout_ms=%s qos=1', self.queue, offset, timeout)
+		try:
+			channel.basic_qos(0, 1, False)
+		except Exception as error:
+			self.logger.error('Failed to apply Stream QoS: queue=%s error_type=%s', self.queue, type(error).__name__)
+			raise
+
+		deadline = time() + (timeout / 1000) if timeout else None
+
+		failure_observed = False
+		try:
+			for method, properties, body in channel.consume(
+				queue=self.queue,
+				auto_ack=False,
+				inactivity_timeout=1,
+				arguments={'x-stream-offset': offset},
+			):
+				if method is None:
+					if deadline and time() >= deadline:
+						break
+					continue
+				# pika delivers properties and body together with every non-empty method frame.
+				assert properties is not None and body is not None
+
+				try:
+					decoded = self.decode(body, properties.content_type, properties.content_encoding)
+				except Exception as error:
+					failure_observed = True
+					self.logger.error('Stream decoding failed: queue=%s delivery_tag=%s error_type=%s', self.queue, method.delivery_tag, type(error).__name__)
+					raise
+				self.logger.debug('Stream message received and decoded: queue=%s consumer_tag=%s delivery_tag=%s message_id=%s', self.queue, method.consumer_tag, method.delivery_tag, properties.message_id)
+				event = Event(
+					channel,
+					self.queue,
+					method.consumer_tag,
+					method.delivery_tag,
+					properties,
+					decoded,
+				)
+
+				try:
+					failure_observed = True
+					yield event
+					failure_observed = False
+					self.logger.debug('Stream ack requested: queue=%s delivery_tag=%s', self.queue, method.delivery_tag)
+					try:
+						channel.basic_ack(delivery_tag=method.delivery_tag)
+					except Exception as error:
+						failure_observed = True
+						self.logger.error('Stream ack failed: queue=%s delivery_tag=%s error_type=%s', self.queue, method.delivery_tag, type(error).__name__)
+						raise
+					self.logger.debug('Stream ack API call completed: queue=%s delivery_tag=%s', self.queue, method.delivery_tag)
+				except Exception:
+					failure_observed = True
+					self.logger.warning('Attempting requeue after Stream processing exception: queue=%s delivery_tag=%s', self.queue, method.delivery_tag)
+					self.logger.debug('Stream nack requested: queue=%s delivery_tag=%s requeue=True', self.queue, method.delivery_tag)
+					try:
+						channel.basic_nack(delivery_tag=method.delivery_tag, requeue=True)
+					except Exception as error:
+						self.logger.error('Stream nack failed: queue=%s delivery_tag=%s error_type=%s', self.queue, method.delivery_tag, type(error).__name__)
+						raise
+					self.logger.debug('Stream nack API call completed: queue=%s delivery_tag=%s', self.queue, method.delivery_tag)
+					raise
+		except Exception as error:
+			if not failure_observed:
+				self.logger.error('Stream consumption loop failed: queue=%s error_type=%s', self.queue, type(error).__name__)
+			raise
+		finally:
+			self.logger.debug('Ending Stream read loop; requesting Consumer cancellation: queue=%s', self.queue)
+			try:
+				channel.cancel()
+			except Exception as error:
+				self.logger.error('Stream Consumer cancellation failed: queue=%s error_type=%s', self.queue, type(error).__name__)
+				raise
+			self.logger.debug('Stream Consumer cancelled: queue=%s', self.queue)
+		return

DefStream/Broker/Implements/RabbitMQ/Subscription.py

@@ -0,0 +1,90 @@
+from collections.abc import Mapping
+from dataclasses import dataclass
+from datetime import timedelta
+from typing import (
+	Any,
+	Optional,
+	Union,
+)
+from DefStream.Broker import validate_priority
+
+__all__ = (
+	'Subscription',
+)
+
+
+@dataclass(frozen=True)
+class Subscription:
+	queue: str
+	offset: Optional[int] = None
+	qos: Optional[int] = None
+	error: Optional[str] = None
+	max_priority: Optional[int] = None
+	priority: Optional[int] = None
+	timeout: Optional[Union[int, timedelta]] = None
+
+	def __post_init__(self) -> None:
+		if self.timeout is not None:
+			if isinstance(self.timeout, timedelta):
+				if self.timeout <= timedelta(0) or self.timeout.microseconds % 1000:
+					raise ValueError('Subscription timeout must be positive with whole-millisecond precision')
+				object.__setattr__(
+					self,
+					'timeout',
+					self.timeout // timedelta(milliseconds=1),
+				)
+			elif isinstance(self.timeout, bool) or not isinstance(self.timeout, int):
+				raise TypeError('Subscription timeout must be integer milliseconds, a timedelta or None')
+			elif self.timeout <= 0:
+				raise ValueError('Subscription timeout must be positive')
+		if self.priority is not None and self.max_priority is None:
+			object.__setattr__(
+				self,
+				'max_priority',
+				255,
+			)
+		validate_priority(
+			self.max_priority,
+			255,
+			minimum=1,
+			name='max_priority',
+		)
+		self.validate_priority(self.priority)
+		if not isinstance(self.queue, str) or not self.queue:
+			raise ValueError('Subscription queue must be a non-empty string')
+		if self.error is not None:
+			if not isinstance(
+				self.error,
+				str,
+			) or not self.error:
+				raise ValueError('Subscription error must be a non-empty string or None')
+		if self.offset is not None and (isinstance(self.offset, bool) or not isinstance(self.offset, int)):
+			raise ValueError('Subscription offset must be an integer')
+		if self.qos is not None:
+			if isinstance(
+				self.qos,
+				bool,
+			) or not isinstance(
+				self.qos,
+				int,
+			) or not 0 <= self.qos <= 65535:
+				raise ValueError('Subscription qos must be an integer between 0 and 65535')
+		return
+
+	def validate_priority(
+		self,
+		priority: Optional[int],
+	) -> None:
+		validate_priority(
+			priority,
+			255 if self.max_priority is None else self.max_priority,
+		)
+		return
+
+	@classmethod
+	def parse(cls, parameters: Any) -> 'Subscription':
+		if isinstance(parameters, cls):
+			return parameters
+		if isinstance(parameters, Mapping):
+			return cls(**dict(parameters))
+		raise TypeError('RabbitMQ subscriptions require a Subscription or mapping')

DefStream/Broker/Implements/RabbitMQ/__init__.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+from .Configuration import Configuration
+from .Connection import (
+	Connection,
+	ExchangeType,
+	Parameters,
+	All,
+	Any,
+)
+from .Exchange import Exchange
+from .Queue import Queue
+from .Stream import Stream
+from .Consumer import Consumer
+from .Subscription import Subscription
+from .Event import (
+	Event,
+	EventHandler,
+	Requeue,
+	Reject,
+)
+from .Serializer import (
+	Encoder,
+	Decoder,
+)
+
+__all__ = (
+	'Configuration',
+	'Connection',
+	'ExchangeType',
+	'Parameters',
+	'All',
+	'Any',
+	'Exchange',
+	'Queue',
+	'Stream',
+	'Consumer',
+	'Subscription',
+	'Requeue',
+	'Reject',
+	'Event',
+	'EventHandler',
+	'Encoder',
+	'Decoder',
+)

defstream_rabbitmq-0.1.24.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: DefStream-RabbitMQ
+Version: 0.1.24
+Summary: Synchronous message processing with pluggable broker adapters
+Home-page: https://github.com/yong5eon/DefStream
+Author: Heo Yongseon
+Project-URL: Source, https://github.com/yong5eon/DefStream
+Project-URL: Issues, https://github.com/yong5eon/DefStream/issues
+Project-URL: Releases, https://github.com/yong5eon/DefStream/releases
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: DefStream==0.1.24
+Requires-Dist: pika>=1.3.2
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# DefStream
+
+Synchronous event/message processing with pluggable broker adapters
+
+DefStream processes broker messages with ordinary Python task methods and can run them in thread or process pools. It requires Python 3.9 or later.
+
+## Installation
+
+Install the client extra for the broker you use. A broker server must be available separately.
+
+```shell
+python -m pip install "DefStream[RabbitMQ]"
+```
+
+For Redis Streams, install `DefStream[Redis]`. To install both adapters and clients, use `DefStream[RabbitMQ,Redis]`. The plain `DefStream` installation includes neither broker implementation nor client. Each extra installs a separate, same-version adapter distribution, preserving existing import paths.
+
+Before migrating an older integrated installation or historical standalone adapters, uninstall DefStream, DefStream-RabbitMQ and DefStream-Redis, then reinstall with the desired extras. Omitting an extra later does not remove an already installed adapter.
+
+## Quick start
+
+The following worker listens to a local RabbitMQ server at `127.0.0.1:5672`. The example credentials are for local development only.
+
+```python
+from signal import SIGINT, signal
+
+from DefStream.Broker.Implements.RabbitMQ import Configuration, Connection, Reject, Subscription
+from DefStream.Worker import Run, ThreadPool, Worker, WorkerSetup, declare
+
+
+class Add(
+  Run,
+  parameters=Subscription(queue='example.add', error='example.add.error'),
+  on_error=Reject(),
+):
+  def run(self, a: int, b: int):
+    print(a + b)
+    return a + b
+
+
+class Prepare(WorkerSetup):
+  def __call__(self, worker: Worker) -> None:
+    for task in worker.tasks:
+      declare(task=task, broker=worker.broker)
+
+
+if __name__ == '__main__':
+  worker = Worker(
+    Connection(Configuration(host='127.0.0.1', port=5672, username='guest', password='guest')),
+    ThreadPool(4),
+    setups=Prepare(),
+  )
+  worker.add(Add)
+  signal(SIGINT, lambda *_: worker.stop())
+  worker.run()
+```
+
+Run the script after starting RabbitMQ. The worker declares its task queue and waits for messages. Store production credentials outside source code.
+
+## License
+
+See the `LICENSE` file included with the source distribution for the license terms.

defstream_rabbitmq-0.1.24.dist-info/RECORD

@@ -0,0 +1,15 @@
+DefStream/Broker/Implements/RabbitMQ/Configuration.py,sha256=sHysXc1nlJHbSjWD3BZxlXjKBAbz2AKDtr7ACVVVj0c,1094
+DefStream/Broker/Implements/RabbitMQ/Connection.py,sha256=XzPDDHXENClRzKh7rKRPHm2zYpsYhoxo9BcIF-jasdI,14317
+DefStream/Broker/Implements/RabbitMQ/Consumer.py,sha256=pISQZqK5KB_5dvuiL0NVzG-Je7o6nd746Mu5lZcalXQ,11265
+DefStream/Broker/Implements/RabbitMQ/Event.py,sha256=r4r7XT_-2N6XSPz8hBiGNS5di6OYe37q3INYxJAYQCk,3362
+DefStream/Broker/Implements/RabbitMQ/Exchange.py,sha256=EblUpf1SKUfmESREWNargJwGpoSwA5v0Th5MHcwW4Xg,8444
+DefStream/Broker/Implements/RabbitMQ/Queue.py,sha256=XXypscxJNVrNuMAOgSI93lQkiW6EV5GWEcfYeiLH11w,9446
+DefStream/Broker/Implements/RabbitMQ/Serializer.py,sha256=PbL_V89GHPjqh1zvOM-apExhD7Bgau2jinpVCsVUg00,1718
+DefStream/Broker/Implements/RabbitMQ/Stream.py,sha256=vhfnIhpCe1gduT09VIfp6ZhpQtHyqz6bjWhlWAjNy9E,5698
+DefStream/Broker/Implements/RabbitMQ/Subscription.py,sha256=DyjbZ0ZiYBuJDJxVTL_tzsvJluwvsCrcowYMRPcPnzA,2553
+DefStream/Broker/Implements/RabbitMQ/__init__.py,sha256=-0Cj2PyjAVhPSP4w1geyLzwRioAYOuFaGMrp1Le5z4I,647
+defstream_rabbitmq-0.1.24.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+defstream_rabbitmq-0.1.24.dist-info/METADATA,sha256=V9mxCrN0Ej1VQOxZWYGjt6XZCwuR5fWzRtTho3x_omw,3255
+defstream_rabbitmq-0.1.24.dist-info/WHEEL,sha256=p9NQTHLf2esq-Cr7VaqNOmqf-kvOy68UMCeyjVxLzY8,102
+defstream_rabbitmq-0.1.24.dist-info/top_level.txt,sha256=zsnisIu5wHL4b7VM8e9AggG9KTSdUU4morFqpb8YWFs,10
+defstream_rabbitmq-0.1.24.dist-info/RECORD,,

defstream_rabbitmq-0.1.24.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+Build: 110
+