betterproto2-compiler 0.5.0__tar.gz → 0.6.0__tar.gz

betterproto2_compiler-0.6.0/.gitignore

@@ -0,0 +1,21 @@
+.coverage
+.DS_Store
+.env
+.vscode/settings.json
+.mypy_cache
+.pytest_cache
+.python-version
+build/
+tests/output_*
+**/__pycache__
+dist
+**/*.egg-info
+output
+.idea
+.DS_Store
+.tox
+.venv
+.asv
+venv
+.devcontainer
+.ruff_cache

betterproto2_compiler-0.6.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: betterproto2_compiler
+Version: 0.6.0
+Summary: Compiler for betterproto2
+Project-URL: Documentation, https://betterproto.github.io/python-betterproto2/
+Project-URL: Repository, https://github.com/betterproto/python-betterproto2
+Author-email: Adrien Vannson <adrien.vannson@protonmail.com>, "Daniel G. Taylor" <danielgtaylor@gmail.com>
+License-Expression: MIT
+Keywords: compiler,gRPC,protobuf
+Requires-Python: <4.0,>=3.10
+Requires-Dist: betterproto2[grpclib]<0.7,>=0.6.0
+Requires-Dist: jinja2>=3.0.3
+Requires-Dist: ruff~=0.9.3
+Requires-Dist: strenum<0.5,>=0.4.15; python_version == '3.10'
+Requires-Dist: typing-extensions<5,>=4.7.1

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/pyproject.toml

@@ -1,54 +1,63 @@
 [project]
 name = "betterproto2_compiler"
-version = "0.5.0"
+version = "0.6.0"
 description = "Compiler for betterproto2"
 authors = [
     { name = "Adrien Vannson", email = "adrien.vannson@protonmail.com" },
     { name = "Daniel G. Taylor", email = "danielgtaylor@gmail.com" },
 ]
-readme = "README.md"
-keywords = ["protobuf", "gRPC", "compiler"]
 license = "MIT"
+keywords = [
+    "protobuf",
+    "gRPC",
+    "compiler",
+]
 requires-python = ">=3.10,<4.0"
-dynamic = ["dependencies"]
+dependencies = [
+    # TODO use the version from the current repo?
+    "betterproto2[grpclib]>=0.6.0,<0.7",
+    "ruff~=0.9.3",
+    "jinja2>=3.0.3",
+    "typing-extensions>=4.7.1,<5",
+    "strenum>=0.4.15,<0.5 ; python_version == '3.10'",
+]
 
 [project.urls]
-Documentation = "https://betterproto.github.io/python-betterproto2-compiler/"
-Repository = "https://github.com/betterproto/python-betterproto2-compiler"
+Documentation = "https://betterproto.github.io/python-betterproto2/"
+Repository = "https://github.com/betterproto/python-betterproto2"
 
 [project.scripts]
 protoc-gen-python_betterproto2 = "betterproto2_compiler.plugin:main"
 
-[tool.poetry]
-packages = [
-    { include = "betterproto2_compiler", from = "src" }
+[dependency-groups]
+dev = [
+    "pre-commit>=2.17.0,<3",
+    "grpcio-tools>=1.54.2,<2",
+    "poethepoet>=0.32.2,<0.33",
+    "pyright>=1.1.391,<2",
+    "ipykernel>=6.29.5,<7",
 ]
-
-[tool.poetry.dependencies]
-python = "^3.10"
-betterproto2 = { version = "^0.5.0", extras = ["grpclib"] }
-# betterproto2 = { git="https://github.com/betterproto/python-betterproto2" }
-# betterproto2 = { path = "../python-betterproto2", extras = ["grpclib"] }
-# The Ruff version is pinned. To update it, also update it in .pre-commit-config.yaml
-ruff = "~0.9.3"
-jinja2 = ">=3.0.3"
-typing-extensions = "^4.7.1"
-strenum = [
-    {version = "^0.4.15", python = "=3.10"},
+test = [
+    "pytest>=8.3.4,<9",
+    "protobuf>=5.29.3,<6",
 ]
 
-[tool.poetry.group.dev.dependencies]
-pre-commit = "^2.17.0"
-grpcio-tools = "^1.54.2"
-mkdocs-material = {version = "^9.5.49"}
-mkdocstrings = {version = "^0.27.0", extras = ["python"]}
-poethepoet = "^0.32.2"
-pyright = "^1.1.391"
-ipykernel = "^6.29.5"
+[tool.uv]
+package = true
+default-groups = "all"
+
+# [tool.hatch.build.targets.sdist]
+# include = ["src/betterproto2_compiler"]
+
+# [tool.hatch.build.targets.wheel]
+# include = ["src/betterproto2_compiler"]
+
+# [tool.hatch.build.targets.wheel.sources]
+# "src/betterproto2_compiler" = "betterproto2_compiler"
 
-[tool.poetry.group.test.dependencies]
-pytest = "^8.3.4"
-protobuf = "^5.29.3"
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [tool.ruff]
 extend-exclude = ["tests/output_*", "src/betterproto2_compiler/lib"]
@@ -71,12 +80,9 @@ select = [
     "I",
 ]
 
-
 [tool.ruff.lint.isort]
 combine-as-imports = true
 
-# Dev workflow tasks
-
 [tool.poe.tasks.test]
 cmd = "pytest"
 help = "Run tests"
@@ -146,14 +152,6 @@ help = "Check that the source code is formatted"
 cmd = "ruff check src tests"
 help = "Check the code with the Ruff linter"
 
-[tool.poe.tasks.serve-docs]
-cmd = "mkdocs serve"
-help = "Serve the documentation locally"
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3"]
-build-backend = "poetry.core.masonry.api"
-
 # python -m grpc.tools.protoc \
 #     --python_betterproto2_out=src/lib2 \
 #     google/protobuf/any.proto \

betterproto2_compiler-0.6.0/pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+python_files = test_*.py
+python_classes =
+norecursedirs = **/output_*
+addopts = -p no:warnings

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/known_types/any.py

@@ -37,7 +37,7 @@ class Any(VanillaAny):
         except KeyError:
             raise TypeError(f"Can't unpack unregistered type: {self.type_url}")
 
-        return message_type().parse(self.value)
+        return message_type.parse(self.value)
 
     def to_dict(self, **kwargs) -> dict[str, typing.Any]:
         # TODO allow passing a message pool to `to_dict`

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/lib/google/protobuf/__init__.py

@@ -80,7 +80,7 @@ import dateutil.parser
 
 from ...message_pool import default_message_pool
 
-betterproto2.check_compiler_version("0.5.0")
+betterproto2.check_compiler_version("0.6.0")
 
 
 class FieldCardinality(betterproto2.Enum):

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/lib/google/protobuf/compiler/__init__.py

@@ -17,7 +17,7 @@ import betterproto2
 
 from ....message_pool import default_message_pool
 
-betterproto2.check_compiler_version("0.5.0")
+betterproto2.check_compiler_version("0.6.0")
 
 
 class CodeGeneratorResponseFeature(betterproto2.Enum):

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/plugin/compiler.py

@@ -33,17 +33,27 @@ def outputfile_compiler(output_file: OutputTemplate) -> str:
         loader=jinja2.FileSystemLoader(templates_folder),
         undefined=jinja2.StrictUndefined,
     )
-    # Load the body first so we have a compleate list of imports needed.
+
+    # List of the symbols that should appear in the `__all__` variable of the file
+    all: list[str] = []
+
+    def add_to_all(name: str) -> str:
+        all.append(name)
+        return name
+
+    env.filters["add_to_all"] = add_to_all
+
     body_template = env.get_template("template.py.j2")
     header_template = env.get_template("header.py.j2")
 
+    # Load the body first do know the symbols defined in the file
     code = body_template.render(output_file=output_file)
-    code = header_template.render(output_file=output_file, version=version) + "\n" + code
+    code = header_template.render(output_file=output_file, version=version, all=all) + "\n" + code
 
     try:
-        # Sort imports, delete unused ones
+        # Sort imports, delete unused ones, sort __all__
         code = subprocess.check_output(
-            ["ruff", "check", "--select", "I,F401,TCH005", "--fix", "--silent", "-"],
+            ["ruff", "check", "--select", "I,F401,TC005,RUF022", "--fix", "--silent", "-"],
             input=code,
             encoding="utf-8",
         )

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/plugin/main.py

@@ -15,8 +15,7 @@ def main() -> None:
     data = sys.stdin.buffer.read()
 
     # Parse request
-    request = CodeGeneratorRequest()
-    request.parse(data)
+    request = CodeGeneratorRequest.parse(data)
 
     dump_file = os.getenv("BETTERPROTO_DUMP")
     if dump_file:

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/plugin/models.py

@@ -353,8 +353,7 @@ class FieldCompiler(ProtoContentBase):
 
     @property
     def field_type(self) -> FieldType:
-        # TODO it should be possible to remove constructor
-        return FieldType(self.proto_obj.type)
+        return self.proto_obj.type
 
     @property
     def packed(self) -> bool:
@@ -411,12 +410,46 @@ class FieldCompiler(ProtoContentBase):
     def unwrapped_py_type(self) -> str:
         return self._py_type(wrap=False)
 
+    @property
+    def annotations(self) -> list[str]:
+        """List of the Pydantic annotation to add to the field."""
+        assert self.output_file.settings.pydantic_dataclasses
+
+        annotations = []
+
+        if self.proto_obj.type in (FieldType.TYPE_INT32, FieldType.TYPE_SFIXED32, FieldType.TYPE_SINT32):
+            annotations.append("pydantic.Field(ge=-2**31, le=2**31 - 1)")
+
+        elif self.proto_obj.type in (FieldType.TYPE_UINT32, FieldType.TYPE_FIXED32):
+            annotations.append("pydantic.Field(ge=0, le=2**32 - 1)")
+
+        elif self.proto_obj.type in (FieldType.TYPE_INT64, FieldType.TYPE_SFIXED64, FieldType.TYPE_SINT64):
+            annotations.append("pydantic.Field(ge=-2**63, le=2**63 - 1)")
+
+        elif self.proto_obj.type in (FieldType.TYPE_UINT64, FieldType.TYPE_FIXED64):
+            annotations.append("pydantic.Field(ge=0, le=2**64 - 1)")
+
+        elif self.proto_obj.type == FieldType.TYPE_FLOAT:
+            annotations.append("pydantic.AfterValidator(betterproto2.validators.validate_float32)")
+
+        elif self.proto_obj.type == FieldType.TYPE_STRING:
+            annotations.append("pydantic.AfterValidator(betterproto2.validators.validate_string)")
+
+        return annotations
+
     @property
     def annotation(self) -> str:
         py_type = self.py_type
 
         if self.use_builtins:
             py_type = f"builtins.{py_type}"
+
+        # Add the pydantic annotation if needed
+        if self.output_file.settings.pydantic_dataclasses:
+            annotations = self.annotations
+            if annotations:
+                py_type = f"typing.Annotated[{py_type}, {', '.join(annotations)}]"
+
         if self.repeated:
             return f"list[{py_type}]"
         if self.optional:

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/templates/header.py.j2

@@ -6,15 +6,8 @@
 # This file has been @generated
 
 __all__ = (
-    {% for _, enum in output_file.enums|dictsort(by="key") %}
-        "{{ enum.py_name }}",
-    {%- endfor -%}
-    {% for _, message in output_file.messages|dictsort(by="key") %}
-        "{{ message.py_name }}",
-    {%- endfor -%}
-    {% for _, service in output_file.services|dictsort(by="key") %}
-        "{{ service.py_name }}Stub",
-        "{{ service.py_name }}Base",
+    {%- for name in all -%}
+    "{{ name }}",
     {%- endfor -%}
 )
 
@@ -28,6 +21,7 @@ import typing
 from typing import TYPE_CHECKING
 
 {% if output_file.settings.pydantic_dataclasses %}
+import pydantic
 from pydantic.dataclasses import dataclass
 from pydantic import model_validator
 {%- else -%}

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/templates/service_stub.py.j2

@@ -1,4 +1,4 @@
-class {% block class_name %}{% endblock %}({% block inherit_from %}{% endblock %}):
+class {% filter add_to_all %}{% block class_name %}{% endblock %}{% endfilter %}({% block inherit_from %}{% endblock %}):
     {% block service_docstring scoped %}
     {% if service.comment %}
     """

{betterproto2_compiler-0.5.0 → betterproto2_compiler-0.6.0}/src/betterproto2_compiler/templates/template.py.j2

@@ -1,5 +1,5 @@
 {% for _, enum in output_file.enums|dictsort(by="key") %}
-class {{ enum.py_name }}(betterproto2.Enum):
+class {{ enum.py_name | add_to_all }}(betterproto2.Enum):
     {% if enum.comment %}
     """
     {{ enum.comment | indent(4) }}
@@ -31,7 +31,7 @@ class {{ enum.py_name }}(betterproto2.Enum):
 {% else %}
 @dataclass(eq=False, repr=False)
 {% endif %}
-class {{ message.py_name }}(betterproto2.Message):
+class {{ message.py_name | add_to_all }}(betterproto2.Message):
     {% if message.comment or message.oneofs %}
     """
     {{ message.comment | indent(4) }}
@@ -104,7 +104,7 @@ default_message_pool.register_message("{{ output_file.package }}", "{{ message.p
 
 {% if output_file.settings.server_generation == "async" %}
 {% for _, service in output_file.services|dictsort(by="key") %}
-class {{ service.py_name }}Base(ServiceBase):
+class {{ (service.py_name + "Base") | add_to_all }}(ServiceBase):
     {% if service.comment %}
     """
     {{ service.comment | indent(4) }}

betterproto2_compiler-0.6.0/tests/generate.py

@@ -0,0 +1,143 @@
+#!/usr/bin/env python
+import asyncio
+import os
+import shutil
+import sys
+from pathlib import Path
+
+from tests.util import (
+    get_directories,
+    inputs_path,
+    output_path_betterproto,
+    output_path_betterproto_pydantic,
+    output_path_reference,
+    protoc,
+)
+
+# Force pure-python implementation instead of C++, otherwise imports
+# break things because we can't properly reset the symbol database.
+os.environ["PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION"] = "python"
+
+
+def clear_directory(dir_path: Path):
+    for file_or_directory in dir_path.glob("*"):
+        if file_or_directory.is_dir():
+            shutil.rmtree(file_or_directory)
+        else:
+            file_or_directory.unlink()
+
+
+async def generate(verbose: bool):
+    test_case_names = set(get_directories(inputs_path)) - {"__pycache__"}
+
+    generation_tasks = []
+    for test_case_name in sorted(test_case_names):
+        test_case_input_path = inputs_path.joinpath(test_case_name).resolve()
+        generation_tasks.append(generate_test_case_output(test_case_input_path, test_case_name, verbose))
+
+    failed_test_cases = []
+    # Wait for all subprocs and match any failures to names to report
+    for test_case_name, result in zip(sorted(test_case_names), await asyncio.gather(*generation_tasks)):
+        if result != 0:
+            failed_test_cases.append(test_case_name)
+
+    if len(failed_test_cases) > 0:
+        sys.stderr.write("\n\033[31;1;4mFailed to generate the following test cases:\033[0m\n")
+        for failed_test_case in failed_test_cases:
+            sys.stderr.write(f"- {failed_test_case}\n")
+
+        sys.exit(1)
+
+
+async def generate_test_case_output(test_case_input_path: Path, test_case_name: str, verbose: bool) -> int:
+    """
+    Returns the max of the subprocess return values
+    """
+
+    test_case_output_path_reference = output_path_reference.joinpath(test_case_name)
+    test_case_output_path_betterproto = output_path_betterproto
+    test_case_output_path_betterproto_pyd = output_path_betterproto_pydantic
+
+    os.makedirs(test_case_output_path_reference, exist_ok=True)
+    os.makedirs(test_case_output_path_betterproto, exist_ok=True)
+    os.makedirs(test_case_output_path_betterproto_pyd, exist_ok=True)
+
+    clear_directory(test_case_output_path_reference)
+    clear_directory(test_case_output_path_betterproto)
+    clear_directory(test_case_output_path_betterproto_pyd)
+
+    (
+        (ref_out, ref_err, ref_code),
+        (plg_out, plg_err, plg_code),
+        (plg_out_pyd, plg_err_pyd, plg_code_pyd),
+    ) = await asyncio.gather(
+        protoc(test_case_input_path, test_case_output_path_reference, True),
+        protoc(test_case_input_path, test_case_output_path_betterproto, False),
+        protoc(test_case_input_path, test_case_output_path_betterproto_pyd, False, True),
+    )
+
+    if ref_code == 0:
+        print(f"\033[31;1;4mGenerated reference output for {test_case_name!r}\033[0m")
+    else:
+        print(f"\033[31;1;4mFailed to generate reference output for {test_case_name!r}\033[0m")
+        print(ref_err.decode())
+
+    if verbose:
+        if ref_out:
+            print("Reference stdout:")
+            sys.stdout.buffer.write(ref_out)
+            sys.stdout.buffer.flush()
+
+        if ref_err:
+            print("Reference stderr:")
+            sys.stderr.buffer.write(ref_err)
+            sys.stderr.buffer.flush()
+
+    if plg_code == 0:
+        print(f"\033[31;1;4mGenerated plugin output for {test_case_name!r}\033[0m")
+    else:
+        print(f"\033[31;1;4mFailed to generate plugin output for {test_case_name!r}\033[0m")
+        print(plg_err.decode())
+
+    if verbose:
+        if plg_out:
+            print("Plugin stdout:")
+            sys.stdout.buffer.write(plg_out)
+            sys.stdout.buffer.flush()
+
+        if plg_err:
+            print("Plugin stderr:")
+            sys.stderr.buffer.write(plg_err)
+            sys.stderr.buffer.flush()
+
+    if plg_code_pyd == 0:
+        print(f"\033[31;1;4mGenerated plugin (pydantic compatible) output for {test_case_name!r}\033[0m")
+    else:
+        print(f"\033[31;1;4mFailed to generate plugin (pydantic compatible) output for {test_case_name!r}\033[0m")
+        print(plg_err_pyd.decode())
+
+    if verbose:
+        if plg_out_pyd:
+            print("Plugin stdout:")
+            sys.stdout.buffer.write(plg_out_pyd)
+            sys.stdout.buffer.flush()
+
+        if plg_err_pyd:
+            print("Plugin stderr:")
+            sys.stderr.buffer.write(plg_err_pyd)
+            sys.stderr.buffer.flush()
+
+    return max(ref_code, plg_code, plg_code_pyd)
+
+
+def main():
+    if sys.argv[1:2] == ["-v"]:
+        verbose = True
+    else:
+        verbose = False
+
+    asyncio.run(generate(verbose))
+
+
+if __name__ == "__main__":
+    main()

betterproto2_compiler-0.6.0/tests/inputs/any/any.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package any;
+
+message Person {
+    string first_name = 1;
+    string last_name = 2;
+}

betterproto2_compiler-0.6.0/tests/inputs/bool/bool.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+package bool;
+
+message Test {
+    bool value = 1;
+}

betterproto2_compiler-0.6.0/tests/inputs/bytes/bytes.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+package bytes;
+
+message Test {
+    bytes data = 1;
+}

betterproto2_compiler-0.6.0/tests/inputs/casing/casing.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package casing;
+
+enum my_enum {
+  ZERO = 0;
+  ONE = 1;
+  TWO = 2;
+}
+
+message Test {
+  int32 camelCase = 1;
+  my_enum snake_case = 2;
+  snake_case_message snake_case_message = 3;
+  int32 UPPERCASE = 4;
+}
+
+message snake_case_message {
+
+}

betterproto2_compiler-0.6.0/tests/inputs/casing_inner_class/casing_inner_class.proto

@@ -0,0 +1,11 @@
+// https://github.com/danielgtaylor/python-betterproto/issues/344
+syntax = "proto3";
+
+package casing_inner_class;
+
+message Test {
+  message inner_class {
+    sint32 old_exp = 1;
+  }
+  inner_class inner = 2;
+}

betterproto2_compiler-0.6.0/tests/inputs/casing_message_field_uppercase/casing_message_field_uppercase.proto

@@ -0,0 +1,9 @@
+syntax = "proto3";
+
+package casing_message_field_uppercase;
+
+message Test {
+  int32 UPPERCASE = 1;
+  int32 UPPERCASE_V2 = 2;
+  int32 UPPER_CAMEL_CASE = 3;
+}

betterproto2_compiler-0.6.0/tests/inputs/deprecated/deprecated.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package deprecated;
+
+// Some documentation about the Test message.
+message Test {
+    Message message = 1 [deprecated=true];
+    int32 value = 2;
+}
+
+message Message {
+    option deprecated = true;
+    string value = 1;
+}
+
+message Empty {}
+
+service TestService {
+    rpc func(Empty) returns (Empty);
+    rpc deprecated_func(Empty) returns (Empty) { option deprecated = true; };
+}

betterproto2_compiler-0.6.0/tests/inputs/documentation/documentation.proto

@@ -0,0 +1,62 @@
+syntax = "proto3";
+package documentation;
+
+// Documentation of message 1
+// other line 1
+
+// Documentation of message 2
+// other line 2
+message Test { // Documentation of message 3
+    // Documentation of field 1
+    // other line 1
+
+    // Documentation of field 2
+    // other line 2
+    uint32 x = 1; // Documentation of field 3
+
+    // Documentation of oneof 1
+    // other line 1
+
+    // Documentation of oneof 2
+    // other line 2
+    oneof oneof_example { // Documentation of oneof 3
+        // Documentation of oneof field 1
+        // other line 1
+
+        // Documentation of oneof field 2
+        // other line 2
+        int32 a = 2; // Documentation of oneof field 3
+    }
+}
+
+// Documentation of enum 1
+// other line 1
+
+// Documentation of enum 2
+// other line 2
+enum Enum { // Documentation of enum 3
+    // Documentation of variant 1
+    // other line 1
+
+    // Documentation of variant 2
+    // other line 2
+    Enum_Variant = 0; // Documentation of variant 3
+}
+
+// Documentation of service 1
+// other line 1
+
+// Documentation of service 2
+// other line 2
+service Service { // Documentation of service 3
+    // Documentation of method 1
+    // other line 1
+
+    // Documentation of method 2
+    // other line 2
+    rpc get(Test) returns (Test); // Documentation of method 3
+}
+
+// A comment with backslashes \ and triple quotes """
+// Simple quotes are not escaped "
+message ComplexDocumentation {}

betterproto2_compiler-0.6.0/tests/inputs/double/double.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+package double;
+
+message Test {
+    double count = 1;
+}