betterproto2-compiler 0.2.1__tar.gz → 0.2.3__tar.gz

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: betterproto2_compiler
-Version: 0.2.1
+Version: 0.2.3
 Summary: Compiler for betterproto2
 License: MIT
 Keywords: protobuf,gRPC,compiler

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "betterproto2_compiler"
-version = "0.2.1"
+version = "0.2.3"
 description = "Compiler for betterproto2"
 authors = ["Adrien Vannson <adrien.vannson@protonmail.com>", "Daniel G. Taylor <danielgtaylor@gmail.com>"]
 readme = "README.md"

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/src/betterproto2_compiler/casing.py

@@ -21,43 +21,25 @@ def safe_snake_case(value: str) -> str:
     return value
 
 
-def snake_case(value: str, strict: bool = True) -> str:
+def snake_case(name: str) -> str:
     """
     Join words with an underscore into lowercase and remove symbols.
+    """
 
-    Parameters
-    -----------
-    value: :class:`str`
-        The value to convert.
-    strict: :class:`bool`
-        Whether or not to force single underscores.
+    # If there are already underscores in the name, don't break it
+    if "_" in name or not any([c.isupper() for c in name]):
+        return name
 
-    Returns
-    --------
-    :class:`str`
-        The value in snake_case.
-    """
+    # Add an underscore before capital letters
+    name = re.sub(r"(?<=[a-z0-9])([A-Z])", r"_\1", name)
 
-    def substitute_word(symbols: str, word: str, is_start: bool) -> str:
-        if not word:
-            return ""
-        if strict:
-            delimiter_count = 0 if is_start else 1  # Single underscore if strict.
-        elif is_start:
-            delimiter_count = len(symbols)
-        elif word.isupper() or word.islower():
-            delimiter_count = max(1, len(symbols))  # Preserve all delimiters if not strict.
-        else:
-            delimiter_count = len(symbols) + 1  # Extra underscore for leading capital.
+    # Add an underscore before capital letters following an acronym
+    name = re.sub(r"(?<=[A-Z])([A-Z])(?=[a-z])", r"_\1", name)
 
-        return ("_" * delimiter_count) + word.lower()
+    # Add an underscore before digits
+    name = re.sub(r"(?<=[a-zA-Z])([0-9])", r"_\1", name)
 
-    snake = re.sub(
-        f"(^)?({SYMBOLS})({WORD_UPPER}|{WORD})",
-        lambda groups: substitute_word(groups[2], groups[3], groups[1] is not None),
-        value,
-    )
-    return snake
+    return name.lower()
 
 
 def pascal_case(value: str, strict: bool = True) -> str:

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/src/betterproto2_compiler/compile/importing.py

@@ -83,7 +83,7 @@ def get_type_reference(
     if unwrap:
         if source_type in WRAPPER_TYPES:
             wrapped_type = type(WRAPPER_TYPES[source_type]().value)
-            return settings.typing_compiler.optional(wrapped_type.__name__)
+            return f"{wrapped_type.__name__} | None"
 
         if source_type == ".google.protobuf.Duration":
             return "datetime.timedelta"
@@ -114,7 +114,7 @@ def reference_absolute(imports: set[str], py_package: list[str], py_type: str) -
     Returns a reference to a python type located in the root, i.e. sys.path.
     """
     string_import = ".".join(py_package)
-    string_alias = safe_snake_case(string_import)
+    string_alias = "__".join([safe_snake_case(name) for name in py_package])
     imports.add(f"import {string_import} as {string_alias}")
     return f"{string_alias}.{py_type}"
 
@@ -175,6 +175,11 @@ def reference_cousin(current_package: list[str], imports: set[str], py_package:
     string_from = f".{'.' * distance_up}" + ".".join(py_package[len(shared_ancestry) : -1])
     string_import = py_package[-1]
     # Add trailing __ to avoid name mangling (python.org/dev/peps/pep-0008/#id34)
-    string_alias = f"{'_' * distance_up}" + safe_snake_case(".".join(py_package[len(shared_ancestry) :])) + "__"
+    # string_alias = f"{'_' * distance_up}" + safe_snake_case(".".join(py_package[len(shared_ancestry) :])) + "__"
+    string_alias = (
+        f"{'_' * distance_up}"
+        + "__".join([safe_snake_case(name) for name in py_package[len(shared_ancestry) :]])
+        + "__"
+    )
     imports.add(f"from {string_from} import {string_import} as {string_alias}")
     return f"{string_alias}.{py_type}"

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/src/betterproto2_compiler/plugin/models.py

@@ -57,7 +57,6 @@ from betterproto2_compiler.lib.google.protobuf import (
     ServiceDescriptorProto,
 )
 from betterproto2_compiler.lib.google.protobuf.compiler import CodeGeneratorRequest
-from betterproto2_compiler.plugin.typing_compiler import TypingCompiler
 from betterproto2_compiler.settings import Settings
 
 # Organize proto types into categories
@@ -251,14 +250,6 @@ class MessageCompiler(ProtoContentBase):
     def has_oneof_fields(self) -> bool:
         return any(isinstance(field, OneOfFieldCompiler) for field in self.fields)
 
-    @property
-    def has_message_field(self) -> bool:
-        return any(
-            field.proto_obj.type in PROTO_MESSAGE_TYPES
-            for field in self.fields
-            if isinstance(field.proto_obj, FieldDescriptorProto)
-        )
-
     @property
     def custom_methods(self) -> list[str]:
         """
@@ -298,7 +289,6 @@ def is_oneof(proto_field_obj: FieldDescriptorProto) -> bool:
 
 @dataclass(kw_only=True)
 class FieldCompiler(ProtoContentBase):
-    typing_compiler: TypingCompiler
     builtins_types: set[str] = field(default_factory=set)
 
     message: MessageCompiler
@@ -413,9 +403,9 @@ class FieldCompiler(ProtoContentBase):
         if self.use_builtins:
             py_type = f"builtins.{py_type}"
         if self.repeated:
-            return self.typing_compiler.list(py_type)
+            return f"list[{py_type}]"
         if self.optional:
-            return self.typing_compiler.optional(py_type)
+            return f"{py_type} | None"
         return py_type
 
 
@@ -449,14 +439,12 @@ class MapEntryCompiler(FieldCompiler):
                 self.py_k_type = FieldCompiler(
                     source_file=self.source_file,
                     proto_obj=nested.field[0],  # key
-                    typing_compiler=self.typing_compiler,
                     path=[],
                     message=self.message,
                 ).py_type
                 self.py_v_type = FieldCompiler(
                     source_file=self.source_file,
                     proto_obj=nested.field[1],  # value
-                    typing_compiler=self.typing_compiler,
                     path=[],
                     message=self.message,
                 ).py_type
@@ -482,7 +470,7 @@ class MapEntryCompiler(FieldCompiler):
 
     @property
     def annotation(self) -> str:
-        return self.typing_compiler.dict(self.py_k_type, self.py_v_type)
+        return f"dict[{self.py_k_type}, {self.py_v_type}]"
 
     @property
     def repeated(self) -> bool:
@@ -600,17 +588,6 @@ class ServiceMethodCompiler(ProtoContentBase):
 
         return not bool(msg.fields)
 
-    @property
-    def py_input_message_param(self) -> str:
-        """Param name corresponding to py_input_message_type.
-
-        Returns
-        -------
-        str
-            Param name corresponding to py_input_message_type.
-        """
-        return pythonize_field_name(self.py_input_message_type)
-
     @property
     def py_output_message_type(self) -> str:
         """String representation of the Python type corresponding to the

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/src/betterproto2_compiler/plugin/parser.py

@@ -31,11 +31,6 @@ from .models import (
     is_map,
     is_oneof,
 )
-from .typing_compiler import (
-    DirectImportTypingCompiler,
-    NoTyping310TypingCompiler,
-    TypingImportTypingCompiler,
-)
 
 
 def traverse(
@@ -65,25 +60,7 @@ def traverse(
 
 
 def get_settings(plugin_options: list[str]) -> Settings:
-    # Gather any typing generation options.
-    typing_opts = [opt[len("typing.") :] for opt in plugin_options if opt.startswith("typing.")]
-
-    if len(typing_opts) > 1:
-        raise ValueError("Multiple typing options provided")
-
-    # Set the compiler type.
-    typing_opt = typing_opts[0] if typing_opts else "direct"
-    if typing_opt == "direct":
-        typing_compiler = DirectImportTypingCompiler()
-    elif typing_opt == "root":
-        typing_compiler = TypingImportTypingCompiler()
-    elif typing_opt == "310":
-        typing_compiler = NoTyping310TypingCompiler()
-    else:
-        raise ValueError("Invalid typing option provided")
-
     return Settings(
-        typing_compiler=typing_compiler,
         pydantic_dataclasses="pydantic_dataclasses" in plugin_options,
     )
 
@@ -203,7 +180,6 @@ def read_protobuf_type(
                         message=message_data,
                         proto_obj=field,
                         path=path + [2, index],
-                        typing_compiler=output_package.settings.typing_compiler,
                     )
                 )
             elif is_oneof(field):
@@ -213,7 +189,6 @@ def read_protobuf_type(
                         message=message_data,
                         proto_obj=field,
                         path=path + [2, index],
-                        typing_compiler=output_package.settings.typing_compiler,
                     )
                 )
             else:
@@ -223,7 +198,6 @@ def read_protobuf_type(
                         message=message_data,
                         proto_obj=field,
                         path=path + [2, index],
-                        typing_compiler=output_package.settings.typing_compiler,
                     )
                 )
 

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/src/betterproto2_compiler/settings.py

@@ -1,9 +1,6 @@
 from dataclasses import dataclass
 
-from .plugin.typing_compiler import TypingCompiler
-
 
 @dataclass
 class Settings:
     pydantic_dataclasses: bool
-    typing_compiler: TypingCompiler

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/src/betterproto2_compiler/templates/header.py.j2

@@ -21,6 +21,8 @@ __all__ = (
 import builtins
 import datetime
 import warnings
+from collections.abc import AsyncIterable, AsyncIterator, Iterable
+from typing import TYPE_CHECKING
 
 {% if output_file.settings.pydantic_dataclasses %}
 from pydantic.dataclasses import dataclass
@@ -29,21 +31,12 @@ from pydantic import model_validator
 from dataclasses import dataclass
 {% endif %}
 
-{% set typing_imports = output_file.settings.typing_compiler.imports() %}
-{% if typing_imports %}
-{% for line in output_file.settings.typing_compiler.import_lines() %}
-{{ line }}
-{% endfor %}
-{% endif %}
-
 import betterproto2
 {% if output_file.services %}
 from betterproto2.grpc.grpclib_server import ServiceBase
 import grpclib
 {% endif %}
 
-from typing import TYPE_CHECKING
-
 {# Import the message pool of the generated code. #}
 {% if output_file.package %}
 from {{ "." * output_file.package.count(".") }}..message_pool import default_message_pool

{betterproto2_compiler-0.2.1 → betterproto2_compiler-0.2.3}/src/betterproto2_compiler/templates/template.py.j2

@@ -98,22 +98,22 @@ class {{ service.py_name }}Stub(betterproto2.ServiceStub):
     {% for method in service.methods %}
     async def {{ method.py_name }}(self
         {%- if not method.client_streaming -%}
-            , {{ method.py_input_message_param }}:
+            , message:
                 {%- if method.is_input_msg_empty -%}
-                    "{{ output_file.settings.typing_compiler.optional(method.py_input_message_type) }}" = None
+                    "{{ method.py_input_message_type }} | None" = None
                 {%- else -%}
                     "{{ method.py_input_message_type }}"
                 {%- endif -%}
         {%- else -%}
             {# Client streaming: need a request iterator instead #}
-            , {{ method.py_input_message_param }}_iterator: "{{ output_file.settings.typing_compiler.union(output_file.settings.typing_compiler.async_iterable(method.py_input_message_type), output_file.settings.typing_compiler.iterable(method.py_input_message_type)) }}"
+            , messages: "AsyncIterable[{{ method.py_input_message_type }}] | Iterable[{{ method.py_input_message_type }}]"
         {%- endif -%}
             ,
             *
-            , timeout: {{ output_file.settings.typing_compiler.optional("float") }} = None
-            , deadline: "{{ output_file.settings.typing_compiler.optional("Deadline") }}" = None
-            , metadata: "{{ output_file.settings.typing_compiler.optional("MetadataLike") }}" = None
-            ) -> "{% if method.server_streaming %}{{ output_file.settings.typing_compiler.async_iterator(method.py_output_message_type ) }}{% else %}{{ method.py_output_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) }}
@@ -128,7 +128,7 @@ class {{ service.py_name }}Stub(betterproto2.ServiceStub):
             {% if method.client_streaming %}
         async for response in self._stream_stream(
             "{{ method.route }}",
-            {{ method.py_input_message_param }}_iterator,
+            messages,
             {{ method.py_input_message_type }},
             {{ method.py_output_message_type }},
             timeout=timeout,
@@ -138,13 +138,13 @@ class {{ service.py_name }}Stub(betterproto2.ServiceStub):
             yield response
             {% else %}{# i.e. not client streaming #}
         {% if method.is_input_msg_empty %}
-        if {{ method.py_input_message_param }} is None:
-            {{ method.py_input_message_param }} = {{ method.py_input_message_type }}()
+        if message is None:
+            message = {{ method.py_input_message_type }}()
 
         {% endif %}
         async for response in self._unary_stream(
             "{{ method.route }}",
-            {{ method.py_input_message_param }},
+            message,
             {{ method.py_output_message_type }},
             timeout=timeout,
             deadline=deadline,
@@ -157,7 +157,7 @@ class {{ service.py_name }}Stub(betterproto2.ServiceStub):
             {% if method.client_streaming %}
         return await self._stream_unary(
             "{{ method.route }}",
-            {{ method.py_input_message_param }}_iterator,
+            messages,
             {{ method.py_input_message_type }},
             {{ method.py_output_message_type }},
             timeout=timeout,
@@ -166,13 +166,13 @@ class {{ service.py_name }}Stub(betterproto2.ServiceStub):
         )
             {% else %}{# i.e. not client streaming #}
         {% if method.is_input_msg_empty %}
-        if {{ method.py_input_message_param }} is None:
-            {{ method.py_input_message_param }} = {{ method.py_input_message_type }}()
+        if message is None:
+            message = {{ method.py_input_message_type }}()
 
         {% endif %}
         return await self._unary_unary(
             "{{ method.route }}",
-            {{ method.py_input_message_param }},
+            message,
             {{ method.py_output_message_type }},
             timeout=timeout,
             deadline=deadline,
@@ -199,12 +199,12 @@ class {{ service.py_name }}Base(ServiceBase):
     {% for method in service.methods %}
     async def {{ method.py_name }}(self
         {%- if not method.client_streaming -%}
-            , {{ method.py_input_message_param }}: "{{ method.py_input_message_type }}"
+            , message: "{{ method.py_input_message_type }}"
         {%- else -%}
             {# Client streaming: need a request iterator instead #}
-            , {{ method.py_input_message_param }}_iterator: {{ output_file.settings.typing_compiler.async_iterator(method.py_input_message_type) }}
+            , messages: "AsyncIterator[{{ method.py_input_message_type }}]"
         {%- endif -%}
-            ) -> {% if method.server_streaming %}{{ output_file.settings.typing_compiler.async_iterator(method.py_output_message_type) }}{% else %}"{{ method.py_output_message_type }}"{% endif %}:
+            ) -> {% if method.server_streaming %}"AsyncIterator[{{ method.py_output_message_type }}]"{% else %}"{{ method.py_output_message_type }}"{% endif %}:
         {% if method.comment %}
         """
         {{ method.comment | indent(8) }}
@@ -235,7 +235,7 @@ class {{ service.py_name }}Base(ServiceBase):
 
     {% endfor %}
 
-    def __mapping__(self) -> {{ output_file.settings.typing_compiler.dict("str", "grpclib.const.Handler") }}:
+    def __mapping__(self) -> "dict[str, grpclib.const.Handler":
         return {
         {% for method in service.methods %}
         "{{ method.route }}": grpclib.const.Handler(

betterproto2_compiler-0.2.1/src/betterproto2_compiler/plugin/typing_compiler.py

@@ -1,163 +0,0 @@
-import abc
-import builtins
-from collections import defaultdict
-from collections.abc import Iterator
-from dataclasses import (
-    dataclass,
-    field,
-)
-
-
-class TypingCompiler(metaclass=abc.ABCMeta):
-    @abc.abstractmethod
-    def optional(self, type_: str) -> str:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def list(self, type_: str) -> str:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def dict(self, key: str, value: str) -> str:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def union(self, *types: str) -> str:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def iterable(self, type_: str) -> str:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def async_iterable(self, type_: str) -> str:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def async_iterator(self, type_: str) -> str:
-        raise NotImplementedError
-
-    @abc.abstractmethod
-    def imports(self) -> builtins.dict[str, set[str] | None]:
-        """
-        Returns either the direct import as a key with none as value, or a set of
-        values to import from the key.
-        """
-        raise NotImplementedError
-
-    def import_lines(self) -> Iterator:
-        imports = self.imports()
-        for key, value in imports.items():
-            if value is None:
-                yield f"import {key}"
-            else:
-                yield f"from {key} import ("
-                for v in sorted(value):
-                    yield f"    {v},"
-                yield ")"
-
-
-@dataclass
-class DirectImportTypingCompiler(TypingCompiler):
-    _imports: dict[str, set[str]] = field(default_factory=lambda: defaultdict(set))
-
-    def optional(self, type_: str) -> str:
-        self._imports["typing"].add("Optional")
-        return f"Optional[{type_}]"
-
-    def list(self, type_: str) -> str:
-        self._imports["typing"].add("List")
-        return f"List[{type_}]"
-
-    def dict(self, key: str, value: str) -> str:
-        self._imports["typing"].add("Dict")
-        return f"Dict[{key}, {value}]"
-
-    def union(self, *types: str) -> str:
-        self._imports["typing"].add("Union")
-        return f"Union[{', '.join(types)}]"
-
-    def iterable(self, type_: str) -> str:
-        self._imports["typing"].add("Iterable")
-        return f"Iterable[{type_}]"
-
-    def async_iterable(self, type_: str) -> str:
-        self._imports["typing"].add("AsyncIterable")
-        return f"AsyncIterable[{type_}]"
-
-    def async_iterator(self, type_: str) -> str:
-        self._imports["typing"].add("AsyncIterator")
-        return f"AsyncIterator[{type_}]"
-
-    def imports(self) -> builtins.dict[str, set[str] | None]:
-        return {k: v if v else None for k, v in self._imports.items()}
-
-
-@dataclass
-class TypingImportTypingCompiler(TypingCompiler):
-    _imported: bool = False
-
-    def optional(self, type_: str) -> str:
-        self._imported = True
-        return f"typing.Optional[{type_}]"
-
-    def list(self, type_: str) -> str:
-        self._imported = True
-        return f"typing.List[{type_}]"
-
-    def dict(self, key: str, value: str) -> str:
-        self._imported = True
-        return f"typing.Dict[{key}, {value}]"
-
-    def union(self, *types: str) -> str:
-        self._imported = True
-        return f"typing.Union[{', '.join(types)}]"
-
-    def iterable(self, type_: str) -> str:
-        self._imported = True
-        return f"typing.Iterable[{type_}]"
-
-    def async_iterable(self, type_: str) -> str:
-        self._imported = True
-        return f"typing.AsyncIterable[{type_}]"
-
-    def async_iterator(self, type_: str) -> str:
-        self._imported = True
-        return f"typing.AsyncIterator[{type_}]"
-
-    def imports(self) -> builtins.dict[str, set[str] | None]:
-        if self._imported:
-            return {"typing": None}
-        return {}
-
-
-@dataclass
-class NoTyping310TypingCompiler(TypingCompiler):
-    _imports: dict[str, set[str]] = field(default_factory=lambda: defaultdict(set))
-
-    def optional(self, type_: str) -> str:
-        return f"{type_} | None"
-
-    def list(self, type_: str) -> str:
-        return f"list[{type_}]"
-
-    def dict(self, key: str, value: str) -> str:
-        return f"dict[{key}, {value}]"
-
-    def union(self, *types: str) -> str:
-        return f"{' | '.join(types)}"
-
-    def iterable(self, type_: str) -> str:
-        self._imports["collections.abc"].add("Iterable")
-        return f"Iterable[{type_}]"
-
-    def async_iterable(self, type_: str) -> str:
-        self._imports["collections.abc"].add("AsyncIterable")
-        return f"AsyncIterable[{type_}]"
-
-    def async_iterator(self, type_: str) -> str:
-        self._imports["collections.abc"].add("AsyncIterator")
-        return f"AsyncIterator[{type_}]"
-
-    def imports(self) -> builtins.dict[str, set[str] | None]:
-        return {k: v if v else None for k, v in self._imports.items()}