betterproto2-compiler 0.3.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

betterproto2_compiler/lib/google/protobuf/__init__.py

@@ -98,7 +98,7 @@ import betterproto2
 
 from ...message_pool import default_message_pool
 
-betterproto2.check_compiler_version("0.3.0")
+betterproto2.check_compiler_version("0.4.0")
 
 
 class Edition(betterproto2.Enum):

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

@@ -22,7 +22,7 @@ import betterproto2
 
 from ....message_pool import default_message_pool
 
-betterproto2.check_compiler_version("0.3.0")
+betterproto2.check_compiler_version("0.4.0")
 
 
 class CodeGeneratorResponseFeature(betterproto2.Enum):

betterproto2_compiler/plugin/models.py

@@ -129,7 +129,12 @@ def get_comment(
             # We don't add this space to the generated file.
             lines = [line[1:] if line and line[0] == " " else line for line in lines]
 
-            return "\n".join(lines)
+            comment = "\n".join(lines)
+
+            # Escape backslashes and triple quotes
+            comment = comment.replace("\\", "\\\\").replace('"""', '\\"\\"\\"')
+
+            return comment
 
     return ""
 

betterproto2_compiler/plugin/parser.py

@@ -14,7 +14,7 @@ from betterproto2_compiler.lib.google.protobuf.compiler import (
     CodeGeneratorResponseFeature,
     CodeGeneratorResponseFile,
 )
-from betterproto2_compiler.settings import Settings
+from betterproto2_compiler.settings import ClientGeneration, Settings
 
 from .compiler import outputfile_compiler
 from .models import (
@@ -60,8 +60,24 @@ def traverse(
 
 
 def get_settings(plugin_options: list[str]) -> Settings:
+    # Synchronous clients are suitable for most users
+    client_generation = ClientGeneration.SYNC
+
+    for opt in plugin_options:
+        if opt.startswith("client_generation="):
+            name = opt.split("=")[1]
+
+            # print(ClientGeneration.__members__, file=sys.stderr)
+            # print([member.value for member in ClientGeneration])
+
+            try:
+                client_generation = ClientGeneration(name)
+            except ValueError:
+                raise ValueError(f"Invalid client_generation option: {name}")
+
     return Settings(
         pydantic_dataclasses="pydantic_dataclasses" in plugin_options,
+        client_generation=client_generation,
     )
 
 

betterproto2_compiler/settings.py

@@ -1,6 +1,67 @@
+import sys
 from dataclasses import dataclass
 
+if sys.version_info >= (3, 11):
+    from enum import StrEnum
+else:
+    from strenum import StrEnum
+
+
+class ClientGeneration(StrEnum):
+    NONE = "none"
+    """Clients are not generated."""
+
+    SYNC = "sync"
+    """Only synchronous clients are generated."""
+
+    ASYNC = "async"
+    """Only asynchronous clients are generated."""
+
+    SYNC_ASYNC = "sync_async"
+    """Both synchronous and asynchronous clients are generated.
+
+    The asynchronous client is generated with the Async suffix."""
+
+    ASYNC_SYNC = "async_sync"
+    """Both synchronous and asynchronous clients are generated.
+
+    The synchronous client is generated with the Sync suffix."""
+
+    SYNC_ASYNC_NO_DEFAULT = "sync_async_no_default"
+    """Both synchronous and asynchronous clients are generated.
+
+    The synchronous client is generated with the Sync suffix, and the asynchronous client is generated with the Async
+    suffix."""
+
+    @property
+    def is_sync_generated(self) -> bool:
+        return self in {
+            ClientGeneration.SYNC,
+            ClientGeneration.SYNC_ASYNC,
+            ClientGeneration.ASYNC_SYNC,
+            ClientGeneration.SYNC_ASYNC_NO_DEFAULT,
+        }
+
+    @property
+    def is_async_generated(self) -> bool:
+        return self in {
+            ClientGeneration.ASYNC,
+            ClientGeneration.SYNC_ASYNC,
+            ClientGeneration.ASYNC_SYNC,
+            ClientGeneration.SYNC_ASYNC_NO_DEFAULT,
+        }
+
+    @property
+    def is_sync_prefixed(self) -> bool:
+        return self in {ClientGeneration.ASYNC_SYNC, ClientGeneration.SYNC_ASYNC_NO_DEFAULT}
+
+    @property
+    def is_async_prefixed(self) -> bool:
+        return self in {ClientGeneration.SYNC_ASYNC, ClientGeneration.SYNC_ASYNC_NO_DEFAULT}
+
 
 @dataclass
 class Settings:
     pydantic_dataclasses: bool
+
+    client_generation: ClientGeneration

betterproto2_compiler/templates/header.py.j2

@@ -21,7 +21,7 @@ __all__ = (
 import builtins
 import datetime
 import warnings
-from collections.abc import AsyncIterable, AsyncIterator, Iterable
+from collections.abc import AsyncIterable, AsyncIterator, Iterable, Iterator
 import typing
 from typing import TYPE_CHECKING
 
@@ -33,10 +33,9 @@ from dataclasses import dataclass
 {% endif %}
 
 import betterproto2
-{% if output_file.services %}
 from betterproto2.grpc.grpclib_server import ServiceBase
+import grpc
 import grpclib
-{% endif %}
 
 {# Import the message pool of the generated code. #}
 {% if output_file.package %}

betterproto2_compiler/templates/service_stub.py.j2

@@ -0,0 +1,32 @@
+class {% block class_name %}{% endblock %}({% block inherit_from %}{% endblock %}):
+    {% block service_docstring scoped %}
+    {% if service.comment %}
+    """
+    {{ service.comment | indent(4) }}
+    """
+    {% elif not service.methods %}
+    pass
+    {% endif %}
+    {% endblock %}
+
+    {% block class_content %}{% endblock %}
+
+    {% for method in service.methods %}
+    {% block method_definition scoped required %}{% endblock %}
+        {% block method_docstring scoped %}
+        {% if method.comment %}
+        """
+        {{ method.comment | indent(8) }}
+        """
+        {% endif %}
+        {% endblock %}
+
+        {% block deprecation_warning scoped %}
+        {% if method.deprecated %}
+        warnings.warn("{{ service.py_name }}.{{ method.py_name }} is deprecated", DeprecationWarning)
+        {% endif %}
+        {% endblock %}
+
+        {% block method_body scoped required %}{% endblock %}
+
+    {% endfor %}

betterproto2_compiler/templates/service_stub_async.py.j2

@@ -0,0 +1,86 @@
+{% extends "service_stub.py.j2" %}
+
+{# Class definition #}
+{% block class_name %}{{ service.py_name }}{% if output_file.settings.client_generation.is_async_prefixed %}Async{% endif %}Stub{% endblock %}
+{% block inherit_from %}betterproto2.ServiceStub{% endblock %}
+
+{# Methods definition #}
+{% block method_definition %}
+    async def {{ method.py_name }}(self
+        {%- if not method.client_streaming -%}
+            , message:
+                {%- if method.is_input_msg_empty -%}
+                    "{{ method.py_input_message_type }} | None" = None
+                {%- else -%}
+                    "{{ method.py_input_message_type }}"
+                {%- endif -%}
+        {%- else -%}
+            {# Client streaming: need a request iterator instead #}
+            , messages: "AsyncIterable[{{ method.py_input_message_type }}] | Iterable[{{ method.py_input_message_type }}]"
+        {%- endif -%}
+            ,
+            *
+            , timeout: "float | None" = None
+            , deadline: "Deadline | None" = None
+            , metadata: "MetadataLike | None" = None
+            ) -> "{% if method.server_streaming %}AsyncIterator[{{ method.py_output_message_type }}]{% else %}{{ method.py_output_message_type }}{% endif %}":
+{% endblock %}
+
+{% block method_body %}
+    {% if method.server_streaming %}
+      {% if method.client_streaming %}
+        async for response in self._stream_stream(
+            "{{ method.route }}",
+            messages,
+            {{ method.py_input_message_type }},
+            {{ method.py_output_message_type }},
+            timeout=timeout,
+            deadline=deadline,
+            metadata=metadata,
+        ):
+            yield response
+      {% else %}
+        {% if method.is_input_msg_empty %}
+        if message is None:
+            message = {{ method.py_input_message_type }}()
+
+        {% endif %}
+        async for response in self._unary_stream(
+            "{{ method.route }}",
+            message,
+            {{ method.py_output_message_type }},
+            timeout=timeout,
+            deadline=deadline,
+            metadata=metadata,
+        ):
+            yield response
+
+      {% endif %}
+    {% else %}
+      {% if method.client_streaming %}
+        return await self._stream_unary(
+            "{{ method.route }}",
+            messages,
+            {{ method.py_input_message_type }},
+            {{ method.py_output_message_type }},
+            timeout=timeout,
+            deadline=deadline,
+            metadata=metadata,
+        )
+      {% else %}
+        {% if method.is_input_msg_empty %}
+        if message is None:
+            message = {{ method.py_input_message_type }}()
+
+        {% endif %}
+        return await self._unary_unary(
+            "{{ method.route }}",
+            message,
+            {{ method.py_output_message_type }},
+            timeout=timeout,
+            deadline=deadline,
+            metadata=metadata,
+        )
+      {% endif %}
+    {% endif %}
+{% endblock %}

betterproto2_compiler/templates/service_stub_sync.py.j2

@@ -0,0 +1,72 @@
+{% extends "service_stub.py.j2" %}
+
+{# Class definition #}
+{% block class_name %}{{ service.py_name }}{% if output_file.settings.client_generation.is_sync_prefixed %}Sync{% endif %}Stub{% endblock %}
+
+{% block class_content %}
+    {# TODO move to parent class #}
+    def __init__(self, channel: grpc.Channel):
+        self._channel = channel
+{% endblock %}
+
+{# Methods definition #}
+{% block method_definition %}
+    def {{ method.py_name }}(self
+        {%- if not method.client_streaming -%}
+            , message:
+                {%- if method.is_input_msg_empty -%}
+                    "{{ method.py_input_message_type }} | None" = None
+                {%- else -%}
+                    "{{ method.py_input_message_type }}"
+                {%- endif -%}
+        {%- else -%}
+            {# Client streaming: need a request iterator instead #}
+            , messages: "Iterable[{{ method.py_input_message_type }}]"
+        {%- endif -%}
+            ) -> "{% if method.server_streaming %}Iterator[{{ method.py_output_message_type }}]{% else %}{{ method.py_output_message_type }}{% endif %}":
+{% endblock %}
+
+{% block method_body %}
+    {% if method.server_streaming %}
+      {% if method.client_streaming %}
+        for response in self._channel.stream_stream(
+            "{{ method.route }}",
+            {{ method.py_input_message_type }}.SerializeToString,
+            {{ method.py_output_message_type }}.FromString,
+        )(iter(messages)):
+            yield response
+      {% else %}
+        {% if method.is_input_msg_empty %}
+        if message is None:
+            message = {{ method.py_input_message_type }}()
+
+        {% endif %}
+        for response in self._channel.unary_stream(
+            "{{ method.route }}",
+            {{ method.py_input_message_type }}.SerializeToString,
+            {{ method.py_output_message_type }}.FromString,
+        )(message):
+            yield response
+
+      {% endif %}
+    {% else %}
+      {% if method.client_streaming %}
+        return self._channel.stream_unary(
+            "{{ method.route }}",
+            {{ method.py_input_message_type }}.SerializeToString,
+            {{ method.py_output_message_type }}.FromString,
+        )(iter(messages))
+      {% else %}
+        {% if method.is_input_msg_empty %}
+        if message is None:
+            message = {{ method.py_input_message_type }}()
+
+        {% endif %}
+        return self._channel.unary_unary(
+            "{{ method.route }}",
+            {{ method.py_input_message_type }}.SerializeToString,
+            {{ method.py_output_message_type }}.FromString,
+        )(message)
+      {% endif %}
+    {% endif %}
+{% endblock %}

betterproto2_compiler/templates/template.py.j2

@@ -85,103 +85,17 @@ default_message_pool.register_message("{{ output_file.package }}", "{{ message.p
 
 
 {% endfor %}
-{% for _, service in output_file.services|dictsort(by="key") %}
-class {{ service.py_name }}Stub(betterproto2.ServiceStub):
-    {% if service.comment %}
-    """
-    {{ service.comment | indent(4) }}
-    """
-    {% elif not service.methods %}
-    pass
-    {% endif %}
-
-    {% for method in service.methods %}
-    async def {{ method.py_name }}(self
-        {%- if not method.client_streaming -%}
-            , message:
-                {%- if method.is_input_msg_empty -%}
-                    "{{ method.py_input_message_type }} | None" = None
-                {%- else -%}
-                    "{{ method.py_input_message_type }}"
-                {%- endif -%}
-        {%- else -%}
-            {# Client streaming: need a request iterator instead #}
-            , messages: "AsyncIterable[{{ method.py_input_message_type }}] | Iterable[{{ method.py_input_message_type }}]"
-        {%- endif -%}
-            ,
-            *
-            , timeout: "float | None" = None
-            , deadline: "Deadline | None" = None
-            , metadata: "MetadataLike | None" = None
-            ) -> "{% if method.server_streaming %}AsyncIterator[{{ method.py_output_message_type }}]{% else %}{{ method.py_output_message_type }}{% endif %}":
-        {% if method.comment %}
-        """
-        {{ method.comment | indent(8) }}
-        """
-        {% endif %}
 
-        {% if method.deprecated %}
-        warnings.warn("{{ service.py_name }}.{{ method.py_name }} is deprecated", DeprecationWarning)
-        {% endif %}
-
-        {% if method.server_streaming %}
-            {% if method.client_streaming %}
-        async for response in self._stream_stream(
-            "{{ method.route }}",
-            messages,
-            {{ method.py_input_message_type }},
-            {{ method.py_output_message_type }},
-            timeout=timeout,
-            deadline=deadline,
-            metadata=metadata,
-        ):
-            yield response
-            {% else %}{# i.e. not client streaming #}
-        {% if method.is_input_msg_empty %}
-        if message is None:
-            message = {{ method.py_input_message_type }}()
-
-        {% endif %}
-        async for response in self._unary_stream(
-            "{{ method.route }}",
-            message,
-            {{ method.py_output_message_type }},
-            timeout=timeout,
-            deadline=deadline,
-            metadata=metadata,
-        ):
-            yield response
+{% for _, service in output_file.services|dictsort(by="key") %}
 
-            {% endif %}{# if client streaming #}
-        {% else %}{# i.e. not server streaming #}
-            {% if method.client_streaming %}
-        return await self._stream_unary(
-            "{{ method.route }}",
-            messages,
-            {{ method.py_input_message_type }},
-            {{ method.py_output_message_type }},
-            timeout=timeout,
-            deadline=deadline,
-            metadata=metadata,
-        )
-            {% else %}{# i.e. not client streaming #}
-        {% if method.is_input_msg_empty %}
-        if message is None:
-            message = {{ method.py_input_message_type }}()
+{% if output_file.settings.client_generation.is_sync_generated %}
+{% include "service_stub_sync.py.j2" %}
+{% endif %}
 
-        {% endif %}
-        return await self._unary_unary(
-            "{{ method.route }}",
-            message,
-            {{ method.py_output_message_type }},
-            timeout=timeout,
-            deadline=deadline,
-            metadata=metadata,
-        )
-            {% endif %}{# client streaming #}
-        {% endif %}
+{% if output_file.settings.client_generation.is_async_generated %}
+{% include "service_stub_async.py.j2" %}
+{% endif %}
 
-    {% endfor %}
 {% endfor %}
 
 {% for i in output_file.imports_end %}

{betterproto2_compiler-0.3.1.dist-info → betterproto2_compiler-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: betterproto2_compiler
-Version: 0.3.1
+Version: 0.4.0
 Summary: Compiler for betterproto2
 License: MIT
 Keywords: protobuf,gRPC,compiler
@@ -13,10 +13,10 @@ 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.3.1,<0.4.0)
-Requires-Dist: grpclib (>=0.4.1,<0.5.0)
+Requires-Dist: betterproto2[grpclib] (>=0.4.0,<0.5.0)
 Requires-Dist: jinja2 (>=3.0.3)
 Requires-Dist: ruff (>=0.9.3,<0.10.0)
+Requires-Dist: strenum (>=0.4.15,<0.5.0) ; python_version == "3.10"
 Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
 Project-URL: Documentation, https://betterproto.github.io/python-betterproto2-compiler/
 Project-URL: Repository, https://github.com/betterproto/python-betterproto2-compiler

{betterproto2_compiler-0.3.1.dist-info → betterproto2_compiler-0.4.0.dist-info}/RECORD

@@ -9,23 +9,26 @@ betterproto2_compiler/known_types/duration.py,sha256=jy9GPnQTT9qhi12pQDG_ptdFAdm
 betterproto2_compiler/known_types/timestamp.py,sha256=dUfJmdrVg1NW-zkquAc8kxMH6nqdxQ2x_MKeP4N5ksY,2153
 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=gjVdLGtwPhNVept742QqpSdf042sKltfZubb-4YYwoc,107931
-betterproto2_compiler/lib/google/protobuf/compiler/__init__.py,sha256=LfQnk85-q2R_mc1CmvqkobqHASqDCnG9xOFd0S-O3p4,8906
+betterproto2_compiler/lib/google/protobuf/__init__.py,sha256=g41P4o4VkHjz8ko5ndwZ-1tUaNTMCT29c6Snd9XSoDI,107931
+betterproto2_compiler/lib/google/protobuf/compiler/__init__.py,sha256=bxBif4bFkIAqRQ02lrx1n5Qjwkj_rgrFRogdLUeg-6Q,8906
 betterproto2_compiler/lib/message_pool.py,sha256=4-cRhhiM6bmfpUJZ8qxc8LEyqHBHpLCcotjbyZxl7JM,71
 betterproto2_compiler/plugin/__init__.py,sha256=L3pW0b4CvkM5x53x_sYt1kYiSFPO0_vaeH6EQPq9FAM,43
 betterproto2_compiler/plugin/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
 betterproto2_compiler/plugin/compiler.py,sha256=3sPbCtdzjAGftVvoGe5dvxE8uTzJ78hABA-_f-1rEUo,2471
 betterproto2_compiler/plugin/main.py,sha256=gI2fSWc9U-fn6MOlkLg7iResr2YsXbdOge6SzNWxBAo,1302
-betterproto2_compiler/plugin/models.py,sha256=gF3pEBsrzleVRTr1vSYg17k5Ezbe3OSitV0oDsycVWA,20922
+betterproto2_compiler/plugin/models.py,sha256=MIzmnekCuZrzixGthAw9B6p3hXAtk6YYjDLUVIsIs4o,21085
 betterproto2_compiler/plugin/module_validation.py,sha256=JnP8dSN83eJJVDP_UPJsHzq7E7Md3lah0PnKXDbFW5Q,4808
-betterproto2_compiler/plugin/parser.py,sha256=MIA5-pAIJsng59wk3KYEKBARNCsQEQeetnVZk_MhL0I,9349
+betterproto2_compiler/plugin/parser.py,sha256=1u-EeDHH0lRMFIbeHvqpmWiqUVip16cW8eQIhKmevyI,9952
 betterproto2_compiler/plugin/plugin.bat,sha256=lfLT1WguAXqyerLLsRL6BfHA0RqUE6QG79v-1BYVSpI,48
 betterproto2_compiler/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-betterproto2_compiler/settings.py,sha256=FQwco5j9ViBXtDYoFqog7SlXhX2YcbgEnFP77znYiwc,94
-betterproto2_compiler/templates/header.py.j2,sha256=HrISX0IKmUsVpIlGIT6XlD9e3LgWWPN7jYRpws5_-CY,1609
-betterproto2_compiler/templates/template.py.j2,sha256=Wlif_PRN49Hmeh0e8RyYFvrNTcusugysP_sAgBaDA4A,8420
-betterproto2_compiler-0.3.1.dist-info/LICENSE.md,sha256=Pgl2pReU-2yw2miGeQ55UFlyzqAZ_EpYVyZ2nWjwRv4,1121
-betterproto2_compiler-0.3.1.dist-info/METADATA,sha256=QpKRNrkBszUpS7E08NgQpmEPqyY75urCm30w53ovCdU,1188
-betterproto2_compiler-0.3.1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-betterproto2_compiler-0.3.1.dist-info/entry_points.txt,sha256=re3Qg8lLljbVobeeKH2f1FVQZ114wfZkGv3zCZTD8Ok,84
-betterproto2_compiler-0.3.1.dist-info/RECORD,,
+betterproto2_compiler/settings.py,sha256=gbMgOQpUoKqxpW1HELnTUR6sntho5IuqWoktRrFNm1M,1871
+betterproto2_compiler/templates/header.py.j2,sha256=u7pIz9DJsFl4CxIGIosd8qPfhOOv1v6XA7nuo__SKPM,1589
+betterproto2_compiler/templates/service_stub.py.j2,sha256=r0AefgNbDCh-iDgFNV7aNx8fNe5kQY-8TNew-T_tUXc,929
+betterproto2_compiler/templates/service_stub_async.py.j2,sha256=JNOAa8FPhzYS5D0zi0DPESVEwAjkdFsVQZ008Qi4JmE,2968
+betterproto2_compiler/templates/service_stub_sync.py.j2,sha256=V7HJIQJEgivX8VEBt7Ju6cXG5FeeCY9QyYMy1kicElM,2642
+betterproto2_compiler/templates/template.py.j2,sha256=-1fpTlu_DCIeios3CHZUzY3b28zcN2QKdkhGtSrFMbg,5344
+betterproto2_compiler-0.4.0.dist-info/LICENSE.md,sha256=Pgl2pReU-2yw2miGeQ55UFlyzqAZ_EpYVyZ2nWjwRv4,1121
+betterproto2_compiler-0.4.0.dist-info/METADATA,sha256=R4sJQ_oMrnS5wcdSq4LVoHhIud-paWgaoq3XAdiES20,1225
+betterproto2_compiler-0.4.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+betterproto2_compiler-0.4.0.dist-info/entry_points.txt,sha256=re3Qg8lLljbVobeeKH2f1FVQZ114wfZkGv3zCZTD8Ok,84
+betterproto2_compiler-0.4.0.dist-info/RECORD,,

{betterproto2_compiler-0.3.1.dist-info → betterproto2_compiler-0.4.0.dist-info}/WHEEL

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