Merge pull request #3 from danielgtaylor/imports

Implement imports, simplified default value handling

Author: danielgtaylor

Pipfile

@@ -18,5 +18,6 @@ jinja2 = "*"
 python_version = "3.7"
 
 [scripts]
+plugin = "protoc --plugin=protoc-gen-custom=protoc-gen-betterpy.py --custom_out=output"
 generate = "python betterproto/tests/generate.py"
 test = "pytest ./betterproto/tests"

README.md

@@ -13,6 +13,7 @@ This project aims to provide an improved experience when using Protobuf / gRPC i
 
 This project is heavily inspired by, and borrows functionality from:
 
+- https://github.com/protocolbuffers/protobuf/tree/master/python
 - https://github.com/eigenein/protobuf/
 - https://github.com/vmagamedov/grpclib
 
@@ -27,8 +28,8 @@ This project is heavily inspired by, and borrows functionality from:
 - [x] Maps
   - [x] Maps of message fields
 - [ ] Support passthrough of unknown fields
-- [ ] Refs to nested types
-- [ ] Imports in proto files
+- [x] Refs to nested types
+- [x] Imports in proto files
 - [ ] Well-known Google types
 - [ ] JSON that isn't completely naive.
 - [ ] Async service stubs

betterproto/__init__.py

@@ -92,6 +92,18 @@
 WIRE_LEN_DELIM_TYPES = [TYPE_STRING, TYPE_BYTES, TYPE_MESSAGE, TYPE_MAP]
 
 
+def get_default(proto_type: int) -> Any:
+    """Get the default (zero value) for a given type."""
+    return {
+        TYPE_BOOL: False,
+        TYPE_FLOAT: 0.0,
+        TYPE_DOUBLE: 0.0,
+        TYPE_STRING: "",
+        TYPE_BYTES: b"",
+        TYPE_MAP: {},
+    }.get(proto_type, 0)
+
+
 @dataclasses.dataclass(frozen=True)
 class FieldMetadata:
     """Stores internal metadata used for parsing & serialization."""
@@ -114,7 +126,7 @@ def get(field: dataclasses.Field) -> "FieldMetadata":
 def dataclass_field(
     number: int,
     proto_type: str,
-    default: Any,
+    default: Any = None,
     map_types: Optional[Tuple[str, str]] = None,
     **kwargs: dict,
 ) -> dataclasses.Field:
@@ -141,6 +153,10 @@ def enum_field(number: int, default: Union[int, Type[Iterable]] = 0) -> Any:
     return dataclass_field(number, TYPE_ENUM, default=default)
 
 
+def bool_field(number: int, default: Union[bool, Type[Iterable]] = 0) -> Any:
+    return dataclass_field(number, TYPE_BOOL, default=default)
+
+
 def int32_field(number: int, default: Union[int, Type[Iterable]] = 0) -> Any:
     return dataclass_field(number, TYPE_INT32, default=default)
 
@@ -193,8 +209,12 @@ def string_field(number: int, default: str = "") -> Any:
     return dataclass_field(number, TYPE_STRING, default=default)
 
 
-def message_field(number: int, default: Type["Message"]) -> Any:
-    return dataclass_field(number, TYPE_MESSAGE, default=default)
+def bytes_field(number: int, default: bytes = b"") -> Any:
+    return dataclass_field(number, TYPE_BYTES, default=default)
+
+
+def message_field(number: int) -> Any:
+    return dataclass_field(number, TYPE_MESSAGE)
 
 
 def map_field(number: int, key_type: str, value_type: str) -> Any:
@@ -345,6 +365,29 @@ class Message(ABC):
     to go between Python, binary and JSON protobuf message representations.
     """
 
+    def __post_init__(self) -> None:
+        # Set a default value for each field in the class after `__init__` has
+        # already been run.
+        for field in dataclasses.fields(self):
+            meta = FieldMetadata.get(field)
+
+            t = self._cls_for(field, index=-1)
+
+            value = 0
+            if meta.proto_type == TYPE_MAP:
+                # Maps cannot be repeated, so we check these first.
+                value = {}
+            elif hasattr(t, "__args__") and len(t.__args__) == 1:
+                # Anything else with type args is a list.
+                value = []
+            elif meta.proto_type == TYPE_MESSAGE:
+                # Message means creating an instance of the right type.
+                value = t()
+            else:
+                value = get_default(meta.proto_type)
+
+            setattr(self, field.name, value)
+
     def __bytes__(self) -> bytes:
         """
         Get the binary encoded Protobuf representation of this instance.
@@ -356,6 +399,7 @@ def __bytes__(self) -> bytes:
 
             if isinstance(value, list):
                 if not len(value):
+                    # Empty values are not serialized
                     continue
 
                 if meta.proto_type in PACKED_TYPES:
@@ -371,14 +415,16 @@ def __bytes__(self) -> bytes:
                         output += _serialize_single(meta.number, meta.proto_type, item)
             elif isinstance(value, dict):
                 if not len(value):
+                    # Empty values are not serialized
                     continue
 
                 for k, v in value.items():
                     sk = _serialize_single(1, meta.map_types[0], k)
                     sv = _serialize_single(2, meta.map_types[1], v)
                     output += _serialize_single(meta.number, meta.proto_type, sk + sv)
             else:
-                if value == field.default:
+                if value == get_default(meta.proto_type):
+                    # Default (zero) values are not serialized
                     continue
 
                 output += _serialize_single(meta.number, meta.proto_type, value)
@@ -390,7 +436,7 @@ def _cls_for(self, field: dataclasses.Field, index: int = 0) -> Type:
         module = inspect.getmodule(self)
         type_hints = get_type_hints(self, vars(module))
         cls = type_hints[field.name]
-        if hasattr(cls, "__args__"):
+        if hasattr(cls, "__args__") and index >= 0:
             cls = type_hints[field.name].__args__[index]
         return cls
 
@@ -522,7 +568,7 @@ def from_dict(self, value: dict) -> T:
         """
         for field in dataclasses.fields(self):
             meta = FieldMetadata.get(field)
-            if field.name in value:
+            if field.name in value and value[field.name] is not None:
                 if meta.proto_type == "message":
                     v = getattr(self, field.name)
                     # print(v, value[field.name])

betterproto/templates/main.py

@@ -0,0 +1,5 @@
+{
+  "greeting": {
+    "greeting": "hello"
+  }
+}

betterproto/tests/ref.json

@@ -0,0 +1,9 @@
+syntax = "proto3";
+
+package ref;
+
+import "repeatedmessage.proto";
+
+message Test {
+  repeatedmessage.Sub greeting = 1;
+}

betterproto/tests/ref.proto

@@ -1,5 +1,7 @@
 syntax = "proto3";
 
+package repeatedmessage;
+
 message Test {
   repeated Sub greetings = 1;
 }

betterproto/tests/repeatedmessage.proto

@@ -2,15 +2,15 @@
 import pytest
 import json
 
-from generate import get_files, get_base
+from .generate import get_files, get_base
 
 inputs = get_files(".bin")
 
 
 @pytest.mark.parametrize("filename", inputs)
 def test_sample(filename: str) -> None:
     module = get_base(filename).split("-")[0]
-    imported = importlib.import_module(module)
+    imported = importlib.import_module(f"betterproto.tests.{module}")
     data_binary = open(filename, "rb").read()
     data_dict = json.loads(open(filename.replace(".bin", ".json")).read())
     t1 = imported.Test().parse(data_binary)