Protobuf version upgrades (#307)

2024-12-21 16:37:41 +01:00 · 2022-11-23 07:20:23 +13:00 · 2022-11-23 07:20:23 +13:00 · c2ed072c88
commit c2ed072c88
parent 67f3b4efd1
6 changed files with 589 additions and 6867 deletions
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@ -52,4 +52,4 @@ jobs:
          pull: true
          cache-to: type=inline
          cache-from: ghcr.io/esphome/aioesphomeapi-proto-builder:latest
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          platforms: linux/amd64,linux/arm64
--- a/24
+++ b/24
@ -1,14 +1,20 @@
 FROM python:3.10

-RUN \
-    apt-get update \
-    && apt-get install -y --no-install-recommends \
-        protobuf-compiler=3.12.4-1 \
-        libprotobuf-dev=3.12.4-1 \
-    && rm -rf \
-        /tmp/* \
-        /var/{cache,log}/* \
-        /var/lib/apt/lists/*
+ENV PROTOC_VERSION 3.19.6
+
+ARG TARGETARCH
+
+RUN if [ "$TARGETARCH" = "amd64" ]; then \
+        arch="x86_64"; \
+    elif [ "$TARGETARCH" = "arm64" ]; then \
+        arch="aarch_64"; \
+    else \
+        exit 1; \
+    fi \
+    && curl -o /tmp/protoc.zip -L \
+        https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-linux-${arch}.zip \
+    && unzip /tmp/protoc.zip -d /usr -x readme.txt \
+    && rm /tmp/protoc.zip

 WORKDIR /aioesphomeapi

--- a/aioesphomeapi/api_options_pb2.py
+++ b/aioesphomeapi/api_options_pb2.py
@ -2,9 +2,10 @@
 # -*- coding: utf-8 -*-
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: api_options.proto
-
+"""Generated protocol buffer code."""
 from google.protobuf.internal import enum_type_wrapper
 from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
 from google.protobuf import message as _message
 from google.protobuf import reflection as _reflection
 from google.protobuf import symbol_database as _symbol_database
@ -16,144 +17,30 @@ _sym_db = _symbol_database.Default()
 from google.protobuf import descriptor_pb2 as google_dot_protobuf_dot_descriptor__pb2


-DESCRIPTOR = _descriptor.FileDescriptor(
-  name='api_options.proto',
-  package='',
-  syntax='proto2',
-  serialized_options=None,
-  create_key=_descriptor._internal_create_key,
-  serialized_pb=b'\n\x11\x61pi_options.proto\x1a google/protobuf/descriptor.proto\"\x06\n\x04void*F\n\rAPISourceType\x12\x0f\n\x0bSOURCE_BOTH\x10\x00\x12\x11\n\rSOURCE_SERVER\x10\x01\x12\x11\n\rSOURCE_CLIENT\x10\x02:E\n\x16needs_setup_connection\x12\x1e.google.protobuf.MethodOptions\x18\x8e\x08 \x01(\x08:\x04true:C\n\x14needs_authentication\x12\x1e.google.protobuf.MethodOptions\x18\x8f\x08 \x01(\x08:\x04true:/\n\x02id\x12\x1f.google.protobuf.MessageOptions\x18\x8c\x08 \x01(\r:\x01\x30:M\n\x06source\x12\x1f.google.protobuf.MessageOptions\x18\x8d\x08 \x01(\x0e\x32\x0e.APISourceType:\x0bSOURCE_BOTH:/\n\x05ifdef\x12\x1f.google.protobuf.MessageOptions\x18\x8e\x08 \x01(\t:3\n\x03log\x12\x1f.google.protobuf.MessageOptions\x18\x8f\x08 \x01(\x08:\x04true:9\n\x08no_delay\x12\x1f.google.protobuf.MessageOptions\x18\x90\x08 \x01(\x08:\x05\x66\x61lse'
-  ,
-  dependencies=[google_dot_protobuf_dot_descriptor__pb2.DESCRIPTOR,])
-
-_APISOURCETYPE = _descriptor.EnumDescriptor(
-  name='APISourceType',
-  full_name='APISourceType',
-  filename=None,
-  file=DESCRIPTOR,
-  create_key=_descriptor._internal_create_key,
-  values=[
-    _descriptor.EnumValueDescriptor(
-      name='SOURCE_BOTH', index=0, number=0,
-      serialized_options=None,
-      type=None,
-      create_key=_descriptor._internal_create_key),
-    _descriptor.EnumValueDescriptor(
-      name='SOURCE_SERVER', index=1, number=1,
-      serialized_options=None,
-      type=None,
-      create_key=_descriptor._internal_create_key),
-    _descriptor.EnumValueDescriptor(
-      name='SOURCE_CLIENT', index=2, number=2,
-      serialized_options=None,
-      type=None,
-      create_key=_descriptor._internal_create_key),
-  ],
-  containing_type=None,
-  serialized_options=None,
-  serialized_start=63,
-  serialized_end=133,
-)
-_sym_db.RegisterEnumDescriptor(_APISOURCETYPE)
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x11\x61pi_options.proto\x1a google/protobuf/descriptor.proto\"\x06\n\x04void*F\n\rAPISourceType\x12\x0f\n\x0bSOURCE_BOTH\x10\x00\x12\x11\n\rSOURCE_SERVER\x10\x01\x12\x11\n\rSOURCE_CLIENT\x10\x02:E\n\x16needs_setup_connection\x12\x1e.google.protobuf.MethodOptions\x18\x8e\x08 \x01(\x08:\x04true:C\n\x14needs_authentication\x12\x1e.google.protobuf.MethodOptions\x18\x8f\x08 \x01(\x08:\x04true:/\n\x02id\x12\x1f.google.protobuf.MessageOptions\x18\x8c\x08 \x01(\r:\x01\x30:M\n\x06source\x12\x1f.google.protobuf.MessageOptions\x18\x8d\x08 \x01(\x0e\x32\x0e.APISourceType:\x0bSOURCE_BOTH:/\n\x05ifdef\x12\x1f.google.protobuf.MessageOptions\x18\x8e\x08 \x01(\t:3\n\x03log\x12\x1f.google.protobuf.MessageOptions\x18\x8f\x08 \x01(\x08:\x04true:9\n\x08no_delay\x12\x1f.google.protobuf.MessageOptions\x18\x90\x08 \x01(\x08:\x05\x66\x61lse')

+_APISOURCETYPE = DESCRIPTOR.enum_types_by_name['APISourceType']
 APISourceType = enum_type_wrapper.EnumTypeWrapper(_APISOURCETYPE)
 SOURCE_BOTH = 0
 SOURCE_SERVER = 1
 SOURCE_CLIENT = 2

 NEEDS_SETUP_CONNECTION_FIELD_NUMBER = 1038
-needs_setup_connection = _descriptor.FieldDescriptor(
-  name='needs_setup_connection', full_name='needs_setup_connection', index=0,
-  number=1038, type=8, cpp_type=7, label=1,
-  has_default_value=True, default_value=True,
-  message_type=None, enum_type=None, containing_type=None,
-  is_extension=True, extension_scope=None,
-  serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key)
+needs_setup_connection = DESCRIPTOR.extensions_by_name['needs_setup_connection']
 NEEDS_AUTHENTICATION_FIELD_NUMBER = 1039
-needs_authentication = _descriptor.FieldDescriptor(
-  name='needs_authentication', full_name='needs_authentication', index=1,
-  number=1039, type=8, cpp_type=7, label=1,
-  has_default_value=True, default_value=True,
-  message_type=None, enum_type=None, containing_type=None,
-  is_extension=True, extension_scope=None,
-  serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key)
+needs_authentication = DESCRIPTOR.extensions_by_name['needs_authentication']
 ID_FIELD_NUMBER = 1036
-id = _descriptor.FieldDescriptor(
-  name='id', full_name='id', index=2,
-  number=1036, type=13, cpp_type=3, label=1,
-  has_default_value=True, default_value=0,
-  message_type=None, enum_type=None, containing_type=None,
-  is_extension=True, extension_scope=None,
-  serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key)
+id = DESCRIPTOR.extensions_by_name['id']
 SOURCE_FIELD_NUMBER = 1037
-source = _descriptor.FieldDescriptor(
-  name='source', full_name='source', index=3,
-  number=1037, type=14, cpp_type=8, label=1,
-  has_default_value=True, default_value=0,
-  message_type=None, enum_type=None, containing_type=None,
-  is_extension=True, extension_scope=None,
-  serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key)
+source = DESCRIPTOR.extensions_by_name['source']
 IFDEF_FIELD_NUMBER = 1038
-ifdef = _descriptor.FieldDescriptor(
-  name='ifdef', full_name='ifdef', index=4,
-  number=1038, type=9, cpp_type=9, label=1,
-  has_default_value=False, default_value=b"".decode('utf-8'),
-  message_type=None, enum_type=None, containing_type=None,
-  is_extension=True, extension_scope=None,
-  serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key)
+ifdef = DESCRIPTOR.extensions_by_name['ifdef']
 LOG_FIELD_NUMBER = 1039
-log = _descriptor.FieldDescriptor(
-  name='log', full_name='log', index=5,
-  number=1039, type=8, cpp_type=7, label=1,
-  has_default_value=True, default_value=True,
-  message_type=None, enum_type=None, containing_type=None,
-  is_extension=True, extension_scope=None,
-  serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key)
+log = DESCRIPTOR.extensions_by_name['log']
 NO_DELAY_FIELD_NUMBER = 1040
-no_delay = _descriptor.FieldDescriptor(
-  name='no_delay', full_name='no_delay', index=6,
-  number=1040, type=8, cpp_type=7, label=1,
-  has_default_value=True, default_value=False,
-  message_type=None, enum_type=None, containing_type=None,
-  is_extension=True, extension_scope=None,
-  serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key)
-
-
-_VOID = _descriptor.Descriptor(
-  name='void',
-  full_name='void',
-  filename=None,
-  file=DESCRIPTOR,
-  containing_type=None,
-  create_key=_descriptor._internal_create_key,
-  fields=[
-  ],
-  extensions=[
-  ],
-  nested_types=[],
-  enum_types=[
-  ],
-  serialized_options=None,
-  is_extendable=False,
-  syntax='proto2',
-  extension_ranges=[],
-  oneofs=[
-  ],
-  serialized_start=55,
-  serialized_end=61,
-)
-
-DESCRIPTOR.message_types_by_name['void'] = _VOID
-DESCRIPTOR.enum_types_by_name['APISourceType'] = _APISOURCETYPE
-DESCRIPTOR.extensions_by_name['needs_setup_connection'] = needs_setup_connection
-DESCRIPTOR.extensions_by_name['needs_authentication'] = needs_authentication
-DESCRIPTOR.extensions_by_name['id'] = id
-DESCRIPTOR.extensions_by_name['source'] = source
-DESCRIPTOR.extensions_by_name['ifdef'] = ifdef
-DESCRIPTOR.extensions_by_name['log'] = log
-DESCRIPTOR.extensions_by_name['no_delay'] = no_delay
-_sym_db.RegisterFileDescriptor(DESCRIPTOR)
+no_delay = DESCRIPTOR.extensions_by_name['no_delay']

+_VOID = DESCRIPTOR.message_types_by_name['void']
 void = _reflection.GeneratedProtocolMessageType('void', (_message.Message,), {
  'DESCRIPTOR' : _VOID,
  '__module__' : 'api_options_pb2'
@ -161,13 +48,18 @@ void = _reflection.GeneratedProtocolMessageType('void', (_message.Message,), {
  })
 _sym_db.RegisterMessage(void)

-google_dot_protobuf_dot_descriptor__pb2.MethodOptions.RegisterExtension(needs_setup_connection)
-google_dot_protobuf_dot_descriptor__pb2.MethodOptions.RegisterExtension(needs_authentication)
-google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(id)
-source.enum_type = _APISOURCETYPE
-google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(source)
-google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(ifdef)
-google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(log)
-google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(no_delay)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  google_dot_protobuf_dot_descriptor__pb2.MethodOptions.RegisterExtension(needs_setup_connection)
+  google_dot_protobuf_dot_descriptor__pb2.MethodOptions.RegisterExtension(needs_authentication)
+  google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(id)
+  google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(source)
+  google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(ifdef)
+  google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(log)
+  google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(no_delay)

+  DESCRIPTOR._options = None
+  _APISOURCETYPE._serialized_start=63
+  _APISOURCETYPE._serialized_end=133
+  _VOID._serialized_start=55
+  _VOID._serialized_end=61
 # @@protoc_insertion_point(module_scope)
--- a/aioesphomeapi/api_pb2.py
+++ b/aioesphomeapi/api_pb2.py
--- a/requirements.txt
+++ b/requirements.txt
@ -1,4 +1,4 @@
-protobuf>=3.12.2,<4.0
+protobuf>=3.19.0
 zeroconf>=0.36.0,<1.0
 noiseprotocol>=0.3.1,<1.0
 async-timeout>=4.0
--- a/script/gen-protoc
+++ b/script/gen-protoc
@ -8,7 +8,7 @@ root_dir = Path(__file__).absolute().parent.parent
 os.chdir(root_dir)

 check_call([
-    "protoc", "--python_out=aioesphomeapi", "-I", "aioesphomeapi", 
+    "protoc", "--python_out=aioesphomeapi", "-I", "aioesphomeapi",
    "aioesphomeapi/api.proto", "aioesphomeapi/api_options.proto"
 ])