danielgtaylor / danielgtaylor/python-betterproto

Zeroes are not serialized with bytes() in proto2 syntax with required field

Open
#676 3 comments 0 reactions 0 assignees View on GitHub
bug investigation needed
Dominant language
Python
Stars
1.8k
Forks
234
PR merge metrics
No merged PRs in 30d

Description

### Summary

There should be an alternative __bytes__ method that allows to serialize zeroes for proto2 syntax. Currently zeroes enums are skipped as they are "default" values which is incorrect because unless the field is optional, it must be present in encoded form.

### Reproduction Steps

1. Create a simple proto2 file:
```proto
message MyMessage {
enum MyEnum {
FOOBAR = 0;
BAZ = 1;
}
}
```
2. Compile to python:
```python3
@dataclass
class MyMessage(betterproto.Message):
# @required
action: "MyEnum" = betterproto.enum_field(1)

class MyEnum(betterproto.Enum):
FOOBAR = 0
BAZ = 1
```
3. Use the `FOOBAR` value (0):
```python3
print(
MyMessage(
action=MyEnum.FOOBAR,
)
)
```
You can see the MyEnum.FOOBAR here. However when you try to serialize it, the encoder skips this value incorrectly thinking it's default and hence shouldn't be added:
```python3
print(
MyMessage(
action=MyEnum.FOOBAR,
).to_json()
)
# or
print(
MyMessage(
action=MyEnum.FOOBAR,
).to_dict()
)
# or
print(
bytes(MyMessage(
action=MyEnum.FOOBAR,
))
)
```

This can only be "fixed" by passing include_default_values=True in to_json or to_dict:

```python3
print(
MyMessage(
action=MyEnum.FOOBAR,
).to_json(include_default_values=True)
)
```

But I need binary representation of the MyMessage class

### Expected Results

N/A

### Actual Results

N/A

### System Information

Latest beta version

### Checklist

- [x] I have searched the issues for duplicates.
- [x] I have shown the entire traceback, if possible.
- [x] I have verified this issue occurs on the latest prelease of betterproto which can be installed using `pip install -U --pre betterproto`, if possible.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.