Compile well-known types

Author: AdrienVannson

.github/workflows/ci.yml

@@ -62,4 +62,4 @@ jobs:
 
       - name: Generate code from proto files
         shell: bash
-        run: poetry run python -m tests.generate -v
+        run: poetry run poe generate

docs/development.md

@@ -2,20 +2,17 @@
 
 ## Recompiling the lib proto files
 
-After some updates in the compiler, it might be useful to recompile the standard Google proto files. As the proto files
-are distributed with `protoc`, their path might depend on your installation.
+After some updates in the compiler, it might be useful to recompile the standard Google proto files used by the
+compiler. As the proto files are distributed with `protoc`, their path might depend on your installation.
 
 ```bash
 mkdir lib
 protoc \
-    --python_betterproto2_opt=INCLUDE_GOOGLE \
     --python_betterproto2_out=lib \
     -I /usr/include/ \
     /usr/include/google/protobuf/*.proto
 ```
 
-The generated files should be distributed in the `betterproto2` package.
-
 !!! warning
     These proto files are written with the `proto2` syntax, which is not supported by betterproto. For the compiler to
     work, you need to manually patch the generated file to mark the field `oneof_index` in `Field` and

pyproject.toml

@@ -68,9 +68,42 @@ cmd = "pytest"
 help = "Run tests"
 
 [tool.poe.tasks.generate]
-script = "tests.generate:main"
+sequence = ["_generate_tests", "_generate_tests_lib"]
 help = "Generate test cases"
 
+[tool.poe.tasks._generate_tests]
+script = "tests.generate:main"
+
+[tool.poe.tasks._generate_tests_lib]
+shell = """
+python -m grpc.tools.protoc \
+    --python_betterproto2_out=tests/output_betterproto \
+    google/protobuf/any.proto \
+    google/protobuf/api.proto \
+    google/protobuf/duration.proto \
+    google/protobuf/empty.proto \
+    google/protobuf/field_mask.proto \
+    google/protobuf/source_context.proto \
+    google/protobuf/struct.proto \
+    google/protobuf/timestamp.proto \
+    google/protobuf/type.proto \
+    google/protobuf/wrappers.proto
+
+python -m grpc.tools.protoc \
+    --python_betterproto2_out=tests/output_betterproto_pydantic \
+    --python_betterproto2_opt=pydantic_dataclasses \
+    google/protobuf/any.proto \
+    google/protobuf/api.proto \
+    google/protobuf/duration.proto \
+    google/protobuf/empty.proto \
+    google/protobuf/field_mask.proto \
+    google/protobuf/source_context.proto \
+    google/protobuf/struct.proto \
+    google/protobuf/timestamp.proto \
+    google/protobuf/type.proto \
+    google/protobuf/wrappers.proto
+"""
+
 [tool.poe.tasks.typecheck]
 cmd  = "pyright src"
 help = "Typecheck the code with Pyright"
@@ -103,25 +136,6 @@ help = "Check the code with the Ruff linter"
 cmd = "mkdocs serve"
 help = "Serve the documentation locally"
 
-[tool.poe.tasks.generate_lib]
-shell = """
-mkdir -p tests/output_lib
-python -m grpc.tools.protoc \
-    --python_betterproto2_opt=INCLUDE_GOOGLE \
-    --python_betterproto2_out=tests/output_lib \
-    google/protobuf/any.proto \
-    google/protobuf/api.proto \
-    google/protobuf/duration.proto \
-    google/protobuf/empty.proto \
-    google/protobuf/field_mask.proto \
-    google/protobuf/source_context.proto \
-    google/protobuf/struct.proto \
-    google/protobuf/timestamp.proto \
-    google/protobuf/type.proto \
-    google/protobuf/wrappers.proto
-"""
-help = "Compile the well-known proto types"
-
 [build-system]
 requires = ["poetry-core>=1.0.0,<2"]
 build-backend = "poetry.core.masonry.api"

src/betterproto2_compiler/plugin/models.py

@@ -189,7 +189,6 @@ class OutputTemplate:
     messages: dict[str, "MessageCompiler"] = field(default_factory=dict)
     enums: dict[str, "EnumDefinitionCompiler"] = field(default_factory=dict)
     services: dict[str, "ServiceCompiler"] = field(default_factory=dict)
-    output: bool = True
 
     settings: Settings
 

src/betterproto2_compiler/plugin/parser.py

@@ -107,11 +107,6 @@ def generate_code(request: CodeGeneratorRequest) -> CodeGeneratorResponse:
         # Add this input file to the output corresponding to this package
         request_data.output_packages[output_package_name].input_files.append(proto_file)
 
-        if proto_file.package == "google.protobuf" and "INCLUDE_GOOGLE" not in plugin_options:
-            # If not INCLUDE_GOOGLE,
-            # skip outputting Google's well-known types
-            request_data.output_packages[output_package_name].output = False
-
     # Read Messages and Enums
     # We need to read Messages before Services in so that we can
     # get the references to input/output messages for each service
@@ -147,9 +142,6 @@ def generate_code(request: CodeGeneratorRequest) -> CodeGeneratorResponse:
     # Generate output files
     output_paths: set[pathlib.Path] = set()
     for output_package_name, output_package in request_data.output_packages.items():
-        if not output_package.output:
-            continue
-
         # Add files to the response object
         output_path = pathlib.Path(*output_package_name.split("."), "__init__.py")
         output_paths.add(output_path)