betterproto2-compiler 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

betterproto2_compiler/compile/importing.py

@@ -5,8 +5,9 @@ from typing import (
     TYPE_CHECKING,
 )
 
+from betterproto2.lib.google import protobuf as google_protobuf
+
 from ..casing import safe_snake_case
-from ..lib.google import protobuf as google_protobuf
 from .naming import pythonize_class_name
 
 if TYPE_CHECKING:

betterproto2_compiler/lib/google/protobuf/__init__.py

@@ -1 +0,0 @@
-from betterproto2_compiler.lib.std.google.protobuf import *

betterproto2_compiler/lib/google/protobuf/compiler/__init__.py

@@ -1 +1,229 @@
-from betterproto2_compiler.lib.std.google.protobuf.compiler import *
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# sources: plugin.proto
+# plugin: python-betterproto2
+# This file has been @generated
+
+__all__ = (
+    "CodeGeneratorResponseFeature",
+    "CodeGeneratorRequest",
+    "CodeGeneratorResponse",
+    "CodeGeneratorResponseFile",
+    "Version",
+)
+
+
+from dataclasses import dataclass
+from typing import (
+    TYPE_CHECKING,
+    List,
+    Optional,
+)
+
+import betterproto2
+
+if TYPE_CHECKING:
+    pass
+
+betterproto2.check_compiler_version("0.1.0")
+
+
+class CodeGeneratorResponseFeature(betterproto2.Enum):
+    """
+    Sync with code_generator.h.
+    """
+
+    FEATURE_NONE = 0
+
+    FEATURE_PROTO3_OPTIONAL = 1
+
+    FEATURE_SUPPORTS_EDITIONS = 2
+
+
+@dataclass(eq=False, repr=False)
+class CodeGeneratorRequest(betterproto2.Message):
+    """
+    An encoded CodeGeneratorRequest is written to the plugin's stdin.
+
+    """
+
+    file_to_generate: "List[str]" = betterproto2.field(1, betterproto2.TYPE_STRING, repeated=True)
+    """
+    The .proto files that were explicitly listed on the command-line.  The
+    code generator should generate code only for these files.  Each file's
+    descriptor will be included in proto_file, below.
+    """
+    parameter: "str" = betterproto2.field(2, betterproto2.TYPE_STRING)
+    """
+    The generator parameter passed on the command-line.
+    """
+    proto_file: "List[betterproto2_lib_google_protobuf.FileDescriptorProto]" = betterproto2.field(
+        15, betterproto2.TYPE_MESSAGE, repeated=True
+    )
+    """
+    FileDescriptorProtos for all files in files_to_generate and everything
+    they import.  The files will appear in topological order, so each file
+    appears before any file that imports it.
+
+    Note: the files listed in files_to_generate will include runtime-retention
+    options only, but all other files will include source-retention options.
+    The source_file_descriptors field below is available in case you need
+    source-retention options for files_to_generate.
+
+    protoc guarantees that all proto_files will be written after
+    the fields above, even though this is not technically guaranteed by the
+    protobuf wire format.  This theoretically could allow a plugin to stream
+    in the FileDescriptorProtos and handle them one by one rather than read
+    the entire set into memory at once.  However, as of this writing, this
+    is not similarly optimized on protoc's end -- it will store all fields in
+    memory at once before sending them to the plugin.
+
+    Type names of fields and extensions in the FileDescriptorProto are always
+    fully qualified.
+    """
+    source_file_descriptors: "List[betterproto2_lib_google_protobuf.FileDescriptorProto]" = betterproto2.field(
+        17, betterproto2.TYPE_MESSAGE, repeated=True
+    )
+    """
+    File descriptors with all options, including source-retention options.
+    These descriptors are only provided for the files listed in
+    files_to_generate.
+    """
+    compiler_version: "Optional[Version]" = betterproto2.field(3, betterproto2.TYPE_MESSAGE, optional=True)
+    """
+    The version number of protocol compiler.
+    """
+
+
+@dataclass(eq=False, repr=False)
+class CodeGeneratorResponse(betterproto2.Message):
+    """
+    The plugin writes an encoded CodeGeneratorResponse to stdout.
+
+    """
+
+    error: "str" = betterproto2.field(1, betterproto2.TYPE_STRING)
+    """
+    Error message.  If non-empty, code generation failed.  The plugin process
+    should exit with status code zero even if it reports an error in this way.
+
+    This should be used to indicate errors in .proto files which prevent the
+    code generator from generating correct code.  Errors which indicate a
+    problem in protoc itself -- such as the input CodeGeneratorRequest being
+    unparseable -- should be reported by writing a message to stderr and
+    exiting with a non-zero status code.
+    """
+    supported_features: "int" = betterproto2.field(2, betterproto2.TYPE_UINT64)
+    """
+    A bitmask of supported features that the code generator supports.
+    This is a bitwise "or" of values from the Feature enum.
+    """
+    minimum_edition: "int" = betterproto2.field(3, betterproto2.TYPE_INT32)
+    """
+    The minimum edition this plugin supports.  This will be treated as an
+    Edition enum, but we want to allow unknown values.  It should be specified
+    according the edition enum value, *not* the edition number.  Only takes
+    effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.
+    """
+    maximum_edition: "int" = betterproto2.field(4, betterproto2.TYPE_INT32)
+    """
+    The maximum edition this plugin supports.  This will be treated as an
+    Edition enum, but we want to allow unknown values.  It should be specified
+    according the edition enum value, *not* the edition number.  Only takes
+    effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.
+    """
+    file: "List[CodeGeneratorResponseFile]" = betterproto2.field(15, betterproto2.TYPE_MESSAGE, repeated=True)
+
+
+@dataclass(eq=False, repr=False)
+class CodeGeneratorResponseFile(betterproto2.Message):
+    """
+    Represents a single generated file.
+
+    """
+
+    name: "str" = betterproto2.field(1, betterproto2.TYPE_STRING)
+    """
+    The file name, relative to the output directory.  The name must not
+    contain "." or ".." components and must be relative, not be absolute (so,
+    the file cannot lie outside the output directory).  "/" must be used as
+    the path separator, not "\".
+
+    If the name is omitted, the content will be appended to the previous
+    file.  This allows the generator to break large files into small chunks,
+    and allows the generated text to be streamed back to protoc so that large
+    files need not reside completely in memory at one time.  Note that as of
+    this writing protoc does not optimize for this -- it will read the entire
+    CodeGeneratorResponse before writing files to disk.
+    """
+    insertion_point: "str" = betterproto2.field(2, betterproto2.TYPE_STRING)
+    """
+    If non-empty, indicates that the named file should already exist, and the
+    content here is to be inserted into that file at a defined insertion
+    point.  This feature allows a code generator to extend the output
+    produced by another code generator.  The original generator may provide
+    insertion points by placing special annotations in the file that look
+    like:
+      @@protoc_insertion_point(NAME)
+    The annotation can have arbitrary text before and after it on the line,
+    which allows it to be placed in a comment.  NAME should be replaced with
+    an identifier naming the point -- this is what other generators will use
+    as the insertion_point.  Code inserted at this point will be placed
+    immediately above the line containing the insertion point (thus multiple
+    insertions to the same point will come out in the order they were added).
+    The double-@ is intended to make it unlikely that the generated code
+    could contain things that look like insertion points by accident.
+
+    For example, the C++ code generator places the following line in the
+    .pb.h files that it generates:
+      // @@protoc_insertion_point(namespace_scope)
+    This line appears within the scope of the file's package namespace, but
+    outside of any particular class.  Another plugin can then specify the
+    insertion_point "namespace_scope" to generate additional classes or
+    other declarations that should be placed in this scope.
+
+    Note that if the line containing the insertion point begins with
+    whitespace, the same whitespace will be added to every line of the
+    inserted text.  This is useful for languages like Python, where
+    indentation matters.  In these languages, the insertion point comment
+    should be indented the same amount as any inserted code will need to be
+    in order to work correctly in that context.
+
+    The code generator that generates the initial file and the one which
+    inserts into it must both run as part of a single invocation of protoc.
+    Code generators are executed in the order in which they appear on the
+    command line.
+
+    If |insertion_point| is present, |name| must also be present.
+    """
+    content: "str" = betterproto2.field(15, betterproto2.TYPE_STRING)
+    """
+    The file contents.
+    """
+    generated_code_info: "Optional[betterproto2_lib_google_protobuf.GeneratedCodeInfo]" = betterproto2.field(
+        16, betterproto2.TYPE_MESSAGE, optional=True
+    )
+    """
+    Information describing the file content being inserted. If an insertion
+    point is used, this information will be appropriately offset and inserted
+    into the code generation metadata for the generated files.
+    """
+
+
+@dataclass(eq=False, repr=False)
+class Version(betterproto2.Message):
+    """
+    The version number of protocol compiler.
+
+    """
+
+    major: "int" = betterproto2.field(1, betterproto2.TYPE_INT32)
+    minor: "int" = betterproto2.field(2, betterproto2.TYPE_INT32)
+    patch: "int" = betterproto2.field(3, betterproto2.TYPE_INT32)
+    suffix: "str" = betterproto2.field(4, betterproto2.TYPE_STRING)
+    """
+    A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
+    be empty for mainline stable releases.
+    """
+
+
+import betterproto2.lib.google.protobuf as betterproto2_lib_google_protobuf

betterproto2_compiler/plugin/models.py

@@ -41,13 +41,7 @@ from typing import (
 )
 
 import betterproto2
-
-from betterproto2_compiler.compile.naming import (
-    pythonize_class_name,
-    pythonize_field_name,
-    pythonize_method_name,
-)
-from betterproto2_compiler.lib.google.protobuf import (
+from betterproto2.lib.google.protobuf import (
     DescriptorProto,
     EnumDescriptorProto,
     FieldDescriptorProto,
@@ -56,6 +50,13 @@ from betterproto2_compiler.lib.google.protobuf import (
     FieldDescriptorProtoType as FieldType,
     FileDescriptorProto,
     MethodDescriptorProto,
+    OneofDescriptorProto,
+)
+
+from betterproto2_compiler.compile.naming import (
+    pythonize_class_name,
+    pythonize_field_name,
+    pythonize_method_name,
 )
 from betterproto2_compiler.lib.google.protobuf.compiler import CodeGeneratorRequest
 
@@ -117,28 +118,6 @@ PROTO_PACKED_TYPES = (
 )
 
 
-# TODO patch again to make field optional
-# def monkey_patch_oneof_index():
-#     """
-#     The compiler message types are written for proto2, but we read them as proto3.
-#     For this to work in the case of the oneof_index fields, which depend on being able
-#     to tell whether they were set, we have to treat them as oneof fields. This method
-#     monkey patches the generated classes after the fact to force this behaviour.
-#     """
-#     object.__setattr__(
-#         FieldDescriptorProto.__dataclass_fields__["oneof_index"].metadata[
-#             "betterproto"
-#         ],
-#         "group",
-#         "oneof_index",
-#     )
-#     object.__setattr__(
-#         Field.__dataclass_fields__["oneof_index"].metadata["betterproto"],
-#         "group",
-#         "oneof_index",
-#     )
-
-
 def get_comment(
     proto_file: "FileDescriptorProto",
     path: list[int],
@@ -287,6 +266,7 @@ class MessageCompiler(ProtoContentBase):
     proto_obj: DescriptorProto = PLACEHOLDER
     path: list[int] = PLACEHOLDER
     fields: list[Union["FieldCompiler", "MessageCompiler"]] = field(default_factory=list)
+    oneofs: list["OneofCompiler"] = field(default_factory=list)
     builtins_types: set[str] = field(default_factory=set)
 
     def __post_init__(self) -> None:
@@ -566,6 +546,26 @@ class MapEntryCompiler(FieldCompiler):
         return False  # maps cannot be repeated
 
 
+@dataclass
+class OneofCompiler(ProtoContentBase):
+    source_file: FileDescriptorProto
+    typing_compiler: TypingCompiler
+    path: list[int] = PLACEHOLDER
+
+    parent: MessageCompiler = PLACEHOLDER
+    proto_obj: OneofDescriptorProto = PLACEHOLDER
+
+    def __post_init__(self) -> None:
+        # Add oneof to message
+        if isinstance(self.parent, MessageCompiler):  # TODO why?
+            self.parent.oneofs.append(self)
+        super().__post_init__()
+
+    @property
+    def name(self) -> str:
+        return self.proto_obj.name
+
+
 @dataclass
 class EnumDefinitionCompiler(MessageCompiler):
     """Representation of a proto Enum definition."""

betterproto2_compiler/plugin/parser.py

@@ -2,13 +2,13 @@ import pathlib
 import sys
 from collections.abc import Generator
 
-from betterproto2_compiler.lib.google.protobuf import (
+from betterproto2.lib.google.protobuf import (
     DescriptorProto,
     EnumDescriptorProto,
-    FieldDescriptorProto,
     FileDescriptorProto,
     ServiceDescriptorProto,
 )
+
 from betterproto2_compiler.lib.google.protobuf.compiler import (
     CodeGeneratorRequest,
     CodeGeneratorResponse,
@@ -22,6 +22,7 @@ from .models import (
     FieldCompiler,
     MapEntryCompiler,
     MessageCompiler,
+    OneofCompiler,
     OneOfFieldCompiler,
     OutputTemplate,
     PluginRequestCompiler,
@@ -173,22 +174,6 @@ def generate_code(request: CodeGeneratorRequest) -> CodeGeneratorResponse:
     return response
 
 
-def _make_one_of_field_compiler(
-    output_package: OutputTemplate,
-    source_file: "FileDescriptorProto",
-    parent: MessageCompiler,
-    proto_obj: "FieldDescriptorProto",
-    path: list[int],
-) -> FieldCompiler:
-    return OneOfFieldCompiler(
-        source_file=source_file,
-        parent=parent,
-        proto_obj=proto_obj,
-        path=path,
-        typing_compiler=output_package.typing_compiler,
-    )
-
-
 def read_protobuf_type(
     item: DescriptorProto,
     path: list[int],
@@ -217,7 +202,13 @@ def read_protobuf_type(
                     typing_compiler=output_package.typing_compiler,
                 )
             elif is_oneof(field):
-                _make_one_of_field_compiler(output_package, source_file, message_data, field, path + [2, index])
+                OneOfFieldCompiler(
+                    source_file=source_file,
+                    parent=message_data,
+                    proto_obj=field,
+                    path=path + [2, index],
+                    typing_compiler=output_package.typing_compiler,
+                )
             else:
                 FieldCompiler(
                     source_file=source_file,
@@ -226,6 +217,16 @@ def read_protobuf_type(
                     path=path + [2, index],
                     typing_compiler=output_package.typing_compiler,
                 )
+
+        for index, oneof in enumerate(item.oneof_decl):
+            OneofCompiler(
+                source_file=source_file,
+                typing_compiler=output_package.typing_compiler,
+                path=path + [8, index],
+                parent=message_data,
+                proto_obj=oneof,
+            )
+
     elif isinstance(item, EnumDescriptorProto):
         # Enum
         EnumDefinitionCompiler(

betterproto2_compiler/templates/template.py.j2

@@ -32,9 +32,16 @@ class {{ enum.py_name }}(betterproto2.Enum):
 @dataclass(eq=False, repr=False)
 {% endif %}
 class {{ message.py_name }}(betterproto2.Message):
-    {% if message.comment %}
+    {% if message.comment or message.oneofs %}
     """
     {{ message.comment | indent(4) }}
+
+    {% if message.oneofs %}
+    Oneofs:
+        {% for oneof in message.oneofs %}
+        - {{ oneof.name }}: {{ oneof.comment | indent(12) }}
+        {% endfor %}
+    {% endif %}
     """
     {% endif %}
 

{betterproto2_compiler-0.1.0.dist-info → betterproto2_compiler-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: betterproto2_compiler
-Version: 0.1.0
+Version: 0.1.1
 Summary: Compiler for betterproto2
 Home-page: https://github.com/betterproto/python-betterproto2-compiler
 License: MIT
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: betterproto2 (==0.0.2)
+Requires-Dist: betterproto2 (>=0.1.1,<0.2.0)
 Requires-Dist: grpclib (>=0.4.1,<0.5.0)
 Requires-Dist: jinja2 (>=3.0.3)
 Requires-Dist: ruff (>=0.7.4,<0.8.0)

betterproto2_compiler-0.1.1.dist-info/RECORD

@@ -0,0 +1,26 @@
+betterproto2_compiler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+betterproto2_compiler/casing.py,sha256=bMdI4W0hfYh6kV-DQIqFEjSfGYEqUtPciAzP64z5HLQ,3587
+betterproto2_compiler/compile/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+betterproto2_compiler/compile/importing.py,sha256=JgvVFlWiA8zeb8L_pcAbxH61tDGNNNx18kVXRrfmIlo,7400
+betterproto2_compiler/compile/naming.py,sha256=zf0VOmNojzyv33upOGelGxjZTEDE8JULEEED5_3inHg,562
+betterproto2_compiler/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+betterproto2_compiler/lib/google/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+betterproto2_compiler/lib/google/protobuf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+betterproto2_compiler/lib/google/protobuf/compiler/__init__.py,sha256=CX9UOXUUZD8GpeS7CWb1JTJoPIKi2e6lH7BCw6RJ8uI,9285
+betterproto2_compiler/plugin/__init__.py,sha256=L3pW0b4CvkM5x53x_sYt1kYiSFPO0_vaeH6EQPq9FAM,43
+betterproto2_compiler/plugin/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
+betterproto2_compiler/plugin/compiler.py,sha256=jICLI4-5rAOkWQI1v5j7JqIvoao-ZM9szMuq0OBRteA,2138
+betterproto2_compiler/plugin/main.py,sha256=Q9PmcJqXuYYFe51l7AqHVzJrHqi2LWCUu80CZSQOOwk,1469
+betterproto2_compiler/plugin/models.py,sha256=RfHRt8Iw_v9q-Rpi58VNHkcDfED5TwHWur2O4wr1Z8Q,24482
+betterproto2_compiler/plugin/module_validation.py,sha256=RdPFwdmkbD6NKADaHC5eaPix_pz-yGxHvYJj8Ev48fA,4822
+betterproto2_compiler/plugin/parser.py,sha256=AZihuRp7XCTKG04YNJcthR9fmarllfkPSfLS0l9exLI,9668
+betterproto2_compiler/plugin/plugin.bat,sha256=lfLT1WguAXqyerLLsRL6BfHA0RqUE6QG79v-1BYVSpI,48
+betterproto2_compiler/plugin/typing_compiler.py,sha256=IK6m4ggHXK7HL98Ed_WjvQ_yeWfIpf_fIBZ9SA8UcyM,4873
+betterproto2_compiler/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+betterproto2_compiler/templates/header.py.j2,sha256=nxqsengMcM_IRqQYNVntPQ0gUFUPCy_1P1mcoLvbDos,1464
+betterproto2_compiler/templates/template.py.j2,sha256=R_9a5IvX2wU6yKzcdjj-uMb09askExrShu4UX2ayQO8,8911
+betterproto2_compiler-0.1.1.dist-info/LICENSE.md,sha256=Pgl2pReU-2yw2miGeQ55UFlyzqAZ_EpYVyZ2nWjwRv4,1121
+betterproto2_compiler-0.1.1.dist-info/METADATA,sha256=G9d9cnAsNG8x00x3wWxDDcWZdXOaZyaitkblivnE8lw,1170
+betterproto2_compiler-0.1.1.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+betterproto2_compiler-0.1.1.dist-info/entry_points.txt,sha256=re3Qg8lLljbVobeeKH2f1FVQZ114wfZkGv3zCZTD8Ok,84
+betterproto2_compiler-0.1.1.dist-info/RECORD,,

{betterproto2_compiler-0.1.0.dist-info → betterproto2_compiler-0.1.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: poetry-core 2.0.0
 Root-Is-Purelib: true
 Tag: py3-none-any