Use betterproto for gRPC on Python instead of vanilla protoc

elonen · Oct 22, 2023 · d76b405 · d76b405
1 parent b1a700f
commit d76b405
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 16 deletions.
diff --git a/protobuf/libs/python/Makefile b/protobuf/libs/python/Makefile
@@ -1,13 +1,14 @@
 PACKAGE_NAME := clapshot_grpc
 PACKAGE_VERSION := 0.0.1
-PACKAGE_DIR := pkg_tmp
-DIST_DIR := dist
 VENV := _venv
-PROTO_DIR := ../../proto
 
+PROTO_DIR := ../../proto
 PROTO_FILES = $(wildcard $(PROTO_DIR)/*.proto)
 PROTO_BASENAMES = $(notdir $(PROTO_FILES))
 
+DIST_DIR := dist
+PACKAGE_DIR := $(DIST_DIR)/$(PACKAGE_NAME)
+
 VENV_PYTHON := $(abspath $(VENV)/bin/python)
 PROTO_FILES := $(wildcard $(PROTO_DIR)/*.proto)
 PROTO_GRPC_FILES := organizer.proto
@@ -26,22 +27,18 @@ $(VENV)/bin/activate:
 
 $(DIST_DIR):
 	mkdir -p $(DIST_DIR)
+	mkdir -p $(PACKAGE_DIR)
 
 generate:
-	_venv/bin/python -m grpc_tools.protoc --experimental_allow_proto3_optional --python_out=$(DIST_DIR) --proto_path=$(PROTO_DIR) $(PROTO_BASENAMES)
-	_venv/bin/python -m grpc_tools.protoc --experimental_allow_proto3_optional --python_out=$(DIST_DIR) --grpc_python_out=$(DIST_DIR) --proto_path=$(PROTO_DIR) $(PROTO_GRPC_FILES)
-	# KLUDGE: use `protoletariat` command to make the import relative (see https://github.com/protocolbuffers/protobuf/issues/1491)
-	_venv/bin/protol --create-package --in-place --python-out $(DIST_DIR) protoc --proto-path=$(PROTO_DIR) $(PROTO_BASENAMES)
+	$(VENV_PYTHON) -m grpc_tools.protoc --plugin=$(abspath $(VENV)/bin/protoc-gen-python_betterproto) \
+	  --python_betterproto_out=$(DIST_DIR)/$(PACKAGE_NAME) --experimental_allow_proto3_optional \
+	  --proto_path=$(PROTO_DIR) $(PROTO_BASENAMES)
 
 package: protobufs
-	mkdir -p $(PACKAGE_DIR)/$(PACKAGE_NAME)
-	# Create an __init__.py file for the package
-	touch $(PACKAGE_DIR)/$(PACKAGE_NAME)/__init__.py
-	cp $(DIST_DIR)/* $(PACKAGE_DIR)/$(PACKAGE_NAME)
-	echo "from setuptools import setup, find_packages" > $(PACKAGE_DIR)/setup.py
-	echo "setup(name='$(PACKAGE_NAME)', version='$(PACKAGE_VERSION)', packages=find_packages(), install_requires=['protobuf', 'grpcio-tools'])" >> $(PACKAGE_DIR)/setup.py
-	cd $(PACKAGE_DIR) && $(VENV_PYTHON) setup.py sdist
-	cp $(PACKAGE_DIR)/dist/*.tar.gz $(DIST_DIR)
+	echo "from setuptools import setup, find_packages" > $(DIST_DIR)/setup.py
+	echo "setup(name='$(PACKAGE_NAME)', version='$(PACKAGE_VERSION)', packages=find_packages(), install_requires=['betterproto>=2.0.0', 'grpclib'])" >> $(DIST_DIR)/setup.py
+	cd $(DIST_DIR) && $(VENV_PYTHON) setup.py sdist
+	cp $(DIST_DIR)/dist/*.tar.gz $(DIST_DIR)
 
 clean:
 	rm -rf $(DIST_DIR)

diff --git a/protobuf/libs/python/requirements.txt b/protobuf/libs/python/requirements.txt
@@ -1,4 +1,4 @@
 protobuf
 grpcio-tools
 setuptools
-protoletariat
+betterproto[compiler]==2.0.0b6