danielgtaylor / danielgtaylor/python-betterproto

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

Aperta
#676 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
bug investigation needed
Lingua principale
Python
Stelle
1.8k
Fork
234
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.