Option to choose whether to compile sync or / and async clients

Author: AdrienVannson

src/betterproto2_compiler/plugin/parser.py

@@ -14,7 +14,7 @@
     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,
     )
 
 

src/betterproto2_compiler/settings.py

@@ -1,6 +1,62 @@
 from dataclasses import dataclass
+from enum 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

src/betterproto2_compiler/templates/service_stub_async.py.j2

@@ -1,7 +1,7 @@
 {% extends "service_stub.py.j2" %}
 
 {# Class definition #}
-{% block class_name %}{{ service.py_name }}Stub{% endblock %}
+{% 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 #}

src/betterproto2_compiler/templates/service_stub_sync.py.j2

@@ -1,7 +1,7 @@
 {% extends "service_stub.py.j2" %}
 
 {# Class definition #}
-{% block class_name %}{{ service.py_name }}SyncStub{% endblock %}
+{% 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 #}

src/betterproto2_compiler/templates/template.py.j2

@@ -87,8 +87,15 @@ default_message_pool.register_message("{{ output_file.package }}", "{{ message.p
 {% endfor %}
 
 {% for _, service in output_file.services|dictsort(by="key") %}
-{% include "service_stub_async.py.j2" %}
+
+{% if output_file.settings.client_generation.is_sync_generated %}
 {% include "service_stub_sync.py.j2" %}
+{% endif %}
+
+{% if output_file.settings.client_generation.is_async_generated %}
+{% include "service_stub_async.py.j2" %}
+{% endif %}
+
 {% endfor %}
 
 {% for i in output_file.imports_end %}

tests/util.py

@@ -63,6 +63,7 @@ async def protoc(
             f"--plugin=protoc-gen-custom={plugin_path.as_posix()}",
             "--experimental_allow_proto3_optional",
             "--custom_opt=pydantic_dataclasses",
+            "--custom_opt=client_generation=async_sync",
             f"--proto_path={path.as_posix()}",
             f"--custom_out={output_dir.as_posix()}",
             *[p.as_posix() for p in path.glob("*.proto")],
@@ -76,6 +77,10 @@ async def protoc(
             f"--{python_out_option}={output_dir.as_posix()}",
             *[p.as_posix() for p in path.glob("*.proto")],
         ]
+
+        if not reference:
+            command.insert(3, "--python_betterproto2_opt=client_generation=async_sync")
+
     proc = await asyncio.create_subprocess_exec(
         *command,
         stdout=asyncio.subprocess.PIPE,