Loosen the lowest required Protobuf version to 4.25.0 (#10)

* Initial commit

Signed-off-by: teodordelibasic-db <[email protected]>

* Exclude generated gRPC service files from linter

Signed-off-by: teodordelibasic-db <[email protected]>

---------

Signed-off-by: teodordelibasic-db <[email protected]>

Author: teodordelibasic-db

Makefile

@@ -57,7 +57,7 @@ fmt:
 	$(VENV) -m isort zerobus examples tests
 
 lint:
-	$(VENV) -m pycodestyle zerobus
+	$(VENV) -m pycodestyle --exclude='*_pb2*.py' zerobus
 	$(VENV) -m autoflake --check-diff --quiet --recursive --exclude '*_pb2*.py' zerobus
 
 test:

NEXT_CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### New Features and Improvements
 
+- Loosened protobuf dependency constraint to support versions >= 4.25.0 and < 7.0
 - Added `HeadersProvider` abstraction for flexible authentication strategies
 - Implemented `OAuthHeadersProvider` for OAuth 2.0 Client Credentials flow (default authentication method used by `create_stream()`)
 

README.md

@@ -49,7 +49,7 @@ The Databricks Zerobus Ingest SDK for Python provides a high-performance client
 
 ### Dependencies
 
-- `protobuf` >= 6.31.0, < 7.0
+- `protobuf` >= 4.25.0, < 7.0
 - `grpcio` >= 1.60.0, < 2.0
 - `requests` >= 2.28.1, < 3
 

pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
 dependencies = [
     "requests>=2.28.1,<3",
     "grpcio>=1.60.0,<2.0",
-    "protobuf>=6.31.0,<7.0",
+    "protobuf>=4.25.0,<7.0",
 ]
 
 [project.optional-dependencies]

zerobus/sdk/shared/zerobus_service_pb2.py

@@ -0,0 +1,96 @@
+from typing import ClassVar as _ClassVar
+from typing import Mapping as _Mapping
+from typing import Optional as _Optional
+from typing import Union as _Union
+
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import duration_pb2 as _duration_pb2
+from google.protobuf import message as _message
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class RecordType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    RECORD_TYPE_UNSPECIFIED: _ClassVar[RecordType]
+    PROTO: _ClassVar[RecordType]
+    JSON: _ClassVar[RecordType]
+
+RECORD_TYPE_UNSPECIFIED: RecordType
+PROTO: RecordType
+JSON: RecordType
+
+class CreateIngestStreamRequest(_message.Message):
+    __slots__ = ("table_name", "descriptor_proto", "record_type")
+    TABLE_NAME_FIELD_NUMBER: _ClassVar[int]
+    DESCRIPTOR_PROTO_FIELD_NUMBER: _ClassVar[int]
+    RECORD_TYPE_FIELD_NUMBER: _ClassVar[int]
+    table_name: str
+    descriptor_proto: bytes
+    record_type: RecordType
+    def __init__(
+        self,
+        table_name: _Optional[str] = ...,
+        descriptor_proto: _Optional[bytes] = ...,
+        record_type: _Optional[_Union[RecordType, str]] = ...,
+    ) -> None: ...
+
+class CreateIngestStreamResponse(_message.Message):
+    __slots__ = ("stream_id",)
+    STREAM_ID_FIELD_NUMBER: _ClassVar[int]
+    stream_id: str
+    def __init__(self, stream_id: _Optional[str] = ...) -> None: ...
+
+class IngestRecordRequest(_message.Message):
+    __slots__ = ("offset_id", "proto_encoded_record", "json_record")
+    OFFSET_ID_FIELD_NUMBER: _ClassVar[int]
+    PROTO_ENCODED_RECORD_FIELD_NUMBER: _ClassVar[int]
+    JSON_RECORD_FIELD_NUMBER: _ClassVar[int]
+    offset_id: int
+    proto_encoded_record: bytes
+    json_record: str
+    def __init__(
+        self,
+        offset_id: _Optional[int] = ...,
+        proto_encoded_record: _Optional[bytes] = ...,
+        json_record: _Optional[str] = ...,
+    ) -> None: ...
+
+class EphemeralStreamRequest(_message.Message):
+    __slots__ = ("create_stream", "ingest_record")
+    CREATE_STREAM_FIELD_NUMBER: _ClassVar[int]
+    INGEST_RECORD_FIELD_NUMBER: _ClassVar[int]
+    create_stream: CreateIngestStreamRequest
+    ingest_record: IngestRecordRequest
+    def __init__(
+        self,
+        create_stream: _Optional[_Union[CreateIngestStreamRequest, _Mapping]] = ...,
+        ingest_record: _Optional[_Union[IngestRecordRequest, _Mapping]] = ...,
+    ) -> None: ...
+
+class IngestRecordResponse(_message.Message):
+    __slots__ = ("durability_ack_up_to_offset",)
+    DURABILITY_ACK_UP_TO_OFFSET_FIELD_NUMBER: _ClassVar[int]
+    durability_ack_up_to_offset: int
+    def __init__(self, durability_ack_up_to_offset: _Optional[int] = ...) -> None: ...
+
+class CloseStreamSignal(_message.Message):
+    __slots__ = ("duration",)
+    DURATION_FIELD_NUMBER: _ClassVar[int]
+    duration: _duration_pb2.Duration
+    def __init__(self, duration: _Optional[_Union[_duration_pb2.Duration, _Mapping]] = ...) -> None: ...
+
+class EphemeralStreamResponse(_message.Message):
+    __slots__ = ("create_stream_response", "ingest_record_response", "close_stream_signal")
+    CREATE_STREAM_RESPONSE_FIELD_NUMBER: _ClassVar[int]
+    INGEST_RECORD_RESPONSE_FIELD_NUMBER: _ClassVar[int]
+    CLOSE_STREAM_SIGNAL_FIELD_NUMBER: _ClassVar[int]
+    create_stream_response: CreateIngestStreamResponse
+    ingest_record_response: IngestRecordResponse
+    close_stream_signal: CloseStreamSignal
+    def __init__(
+        self,
+        create_stream_response: _Optional[_Union[CreateIngestStreamResponse, _Mapping]] = ...,
+        ingest_record_response: _Optional[_Union[IngestRecordResponse, _Mapping]] = ...,
+        close_stream_signal: _Optional[_Union[CloseStreamSignal, _Mapping]] = ...,
+    ) -> None: ...

zerobus/sdk/shared/zerobus_service_pb2.pyi

@@ -1,31 +1,9 @@
 # Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
 """Client and server classes corresponding to protobuf-defined services."""
-import warnings
-
 import grpc
 
 from . import zerobus_service_pb2 as zerobus__service__pb2
 
-GRPC_GENERATED_VERSION = "1.71.2"
-GRPC_VERSION = grpc.__version__
-_version_not_supported = False
-
-try:
-    from grpc._utilities import first_version_is_lower
-
-    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
-except ImportError:
-    _version_not_supported = True
-
-if _version_not_supported:
-    raise RuntimeError(
-        f"The grpc package installed is at version {GRPC_VERSION},"
-        + f" but the generated code in zerobus_service_pb2_grpc.py depends on"
-        + f" grpcio>={GRPC_GENERATED_VERSION}."
-        + f" Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}"
-        + f" or downgrade your generated code using grpcio-tools<={GRPC_VERSION}."
-    )
-
 
 class ZerobusStub(object):
     """Version information for the Zerobus service.
@@ -58,7 +36,6 @@ def __init__(self, channel):
             "/databricks.zerobus.Zerobus/EphemeralStream",
             request_serializer=zerobus__service__pb2.EphemeralStreamRequest.SerializeToString,
             response_deserializer=zerobus__service__pb2.EphemeralStreamResponse.FromString,
-            _registered_method=True,
         )
 
 
@@ -107,7 +84,6 @@ def add_ZerobusServicer_to_server(servicer, server):
     }
     generic_handler = grpc.method_handlers_generic_handler("databricks.zerobus.Zerobus", rpc_method_handlers)
     server.add_generic_rpc_handlers((generic_handler,))
-    server.add_registered_method_handlers("databricks.zerobus.Zerobus", rpc_method_handlers)
 
 
 # This class is part of an EXPERIMENTAL API.
@@ -159,5 +135,4 @@ def EphemeralStream(
             wait_for_ready,
             timeout,
             metadata,
-            _registered_method=True,
         )