generating macros

rules-proto-grpc · Jan 18, 2024 · d0a84ba · d0a84ba
1 parent b6745a8
commit d0a84ba
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 7 deletions.
diff --git a/.bazelci/presubmit.yml b/.bazelci/presubmit.yml
@@ -379,6 +379,7 @@ tasks:
      - make test_workspace_import_prefix
      - make test_workspace_nested_output_directory
      - make test_workspace_objc_capitalisation
+     - make test_workspace_prefix_path
      - make test_workspace_python3_grpc
      - make test_workspace_python_dashes
      - make test_workspace_python_deps
@@ -433,6 +434,10 @@ tasks:
      - cd test_workspaces/objc_capitalisation
      - bazel --batch test %BAZEL_EXTRA_FLAGS% --enable_runfiles --verbose_failures --test_output=errors --disk_cache=../bazel-disk-cache //... || exit 1
      - cd ../..
+     - echo prefix_path
+     - cd test_workspaces/prefix_path
+     - bazel --batch test %BAZEL_EXTRA_FLAGS% --enable_runfiles --verbose_failures --test_output=errors --disk_cache=../bazel-disk-cache //... || exit 1
+     - cd ../..
      - echo python3_grpc
      - cd test_workspaces/python3_grpc
      - bazel --batch test %BAZEL_EXTRA_FLAGS% --enable_runfiles --verbose_failures --test_output=errors --disk_cache=../bazel-disk-cache //... || exit 1
@@ -479,6 +484,7 @@ tasks:
      - make test_workspace_import_prefix
      - make test_workspace_nested_output_directory
      - make test_workspace_objc_capitalisation
+     - make test_workspace_prefix_path
      - make test_workspace_python3_grpc
      - make test_workspace_python_dashes
      - make test_workspace_python_deps

diff --git a/modules/python/python_grpc_library.bzl b/modules/python/python_grpc_library.bzl
@@ -18,7 +18,7 @@ def python_grpc_library(name, **kwargs):
         }  # Forward args
     )
 
-    # for other code to import generated code with prefix_path if that exists
+    # for other code to import generated code with prefix_path if it's given
     output_mode = kwargs.get("output_mode", "PREFIXED")
     if output_mode == "PREFIXED":
         imports = [name_pb]

diff --git a/modules/python/python_proto_library.bzl b/modules/python/python_proto_library.bzl
@@ -18,13 +18,14 @@ def python_proto_library(name, **kwargs):
         }  # Forward args
     )
 
-    # Create python library
+	# for other code to import generated code with prefix_path if it's given
     output_mode = kwargs.get("output_mode", "PREFIXED")
     if output_mode == "PREFIXED":
         imports = [name_pb]
     else:
         imports = ["."]
 
+    # Create python library
     py_library(
         name = name,
         srcs = [name_pb],

diff --git a/test_workspaces/Makefile.mk b/test_workspaces/Makefile.mk
@@ -48,6 +48,11 @@ test_workspace_objc_capitalisation:
 	cd test_workspaces/objc_capitalisation; \
 	bazel --batch test ${BAZEL_EXTRA_FLAGS} --verbose_failures --disk_cache=../bazel-disk-cache --test_output=errors //...
 
+.PHONY: test_workspace_prefix_path
+test_workspace_prefix_path:
+	cd test_workspaces/prefix_path; \
+	bazel --batch test ${BAZEL_EXTRA_FLAGS} --verbose_failures --disk_cache=../bazel-disk-cache --test_output=errors //...
+
 .PHONY: test_workspace_python3_grpc
 test_workspace_python3_grpc:
 	cd test_workspaces/python3_grpc; \
@@ -84,4 +89,4 @@ test_workspace_special_characters:
 	bazel --batch test ${BAZEL_EXTRA_FLAGS} --verbose_failures --disk_cache=../bazel-disk-cache --test_output=errors //...
 
 .PHONY: all_test_workspaces
-all_test_workspaces: test_workspace_absolute_strip_import_prefix test_workspace_combined_strip_and_add_prefix test_workspace_common_cpp_library test_workspace_exclusions test_workspace_generated_proto test_workspace_go_fixer test_workspace_go_importpath test_workspace_import_prefix test_workspace_nested_output_directory test_workspace_objc_capitalisation test_workspace_python3_grpc test_workspace_python_dashes test_workspace_python_deps test_workspace_python_dots test_workspace_relative_strip_import_prefix test_workspace_shared_proto test_workspace_special_characters
+all_test_workspaces: test_workspace_absolute_strip_import_prefix test_workspace_combined_strip_and_add_prefix test_workspace_common_cpp_library test_workspace_exclusions test_workspace_generated_proto test_workspace_go_fixer test_workspace_go_importpath test_workspace_import_prefix test_workspace_nested_output_directory test_workspace_objc_capitalisation test_workspace_prefix_path test_workspace_python3_grpc test_workspace_python_dashes test_workspace_python_deps test_workspace_python_dots test_workspace_relative_strip_import_prefix test_workspace_shared_proto test_workspace_special_characters
diff --git a/test_workspaces/prefix_path/example.com/BUILD.bazel b/test_workspaces/prefix_path/example.com/BUILD.bazel
@@ -13,9 +13,9 @@ proto_library(
 
 python_grpc_library(
     name = "py_lib",
-    protos = [":proto_lib"],
-    prefix_path = "demo",
     output_mode = "NO_PREFIX_FLAT",
+    prefix_path = "demo",
+    protos = [":proto_lib"],
     python_version = "PY3",
 )
 

diff --git a/tools/rulegen/python.go b/tools/rulegen/python.go
@@ -13,13 +13,20 @@ def {{ .Rule.Name }}(name, **kwargs):
         {{ .Common.CompileArgsForwardingSnippet }}
     )
 
+	# for other code to import generated code with prefix_path if it's given
+    output_mode = kwargs.get("output_mode", "PREFIXED")
+    if output_mode == "PREFIXED":
+        imports = [name_pb]
+    else:
+        imports = ["."]
+
     # Create {{ .Lang.Name }} library
     py_library(
         name = name,
         srcs = [name_pb],
         deps = PROTO_DEPS + kwargs.get("deps", []),
         data = kwargs.get("data", []),  # See https://github.com/rules-proto-grpc/rules_proto_grpc/issues/257 for use case
-        imports = [name_pb],
+        imports = imports,
         {{ .Common.LibraryArgsForwardingSnippet }}
     )
 
@@ -40,13 +47,25 @@ def {{ .Rule.Name }}(name, **kwargs):
         {{ .Common.CompileArgsForwardingSnippet }}
     )
 
+    # for other code to import generated code with prefix_path if it's given
+    output_mode = kwargs.get("output_mode", "PREFIXED")
+    if output_mode == "PREFIXED":
+        imports = [name_pb]
+    else:
+        imports = ["."]
+
+    # for pb2_grpc.py to import pb2.py
+    prefix_path = kwargs.get("prefix_path", None)
+    if prefix_path:
+        imports.append(imports[0] + "/" + prefix_path)
+
     # Create {{ .Lang.Name }} library
     py_library(
         name = name,
         srcs = [name_pb],
         deps = GRPC_DEPS + kwargs.get("deps", []),
         data = kwargs.get("data", []),  # See https://github.com/rules-proto-grpc/rules_proto_grpc/issues/257 for use case
-        imports = [name_pb],
+        imports = imports,
         {{ .Common.LibraryArgsForwardingSnippet }}
     )