Oneof for non primitive types about protobuf_to_pydantic HOT 3 CLOSED

@anotherchudov

If want fields a,b to be optional, then the contents of the protobuf should be changed to the following:

syntax = "proto3";
message A {
  bool a = 1;
}
message B {
  bool b = 1;
}
message C {
  oneof z {
    optional A a = 1;
    optional B b = 2;
  }
  optional B c = 3;
}

But Protobuf doesn't support this syntax, I will consider another way to support a,b fields as optional, as follows:

syntax = "proto3";
message A {
  bool a = 1;
}
message B {
  bool b = 1;
}
message C {
  oneof z {
    option (p2p_validate.optional) = ["a", "b"];

    A a = 1;
    B b = 2;
  }
  optional B c = 3;
}

This feature will be implemented in the next version.

from protobuf_to_pydantic.

@so1n by definition, doesn't oneof mean that all fields should be optional given one exists?

from protobuf_to_pydantic.

@ditsuke In Protobuf, oneof simply restricts a set of fields to only one that has a value, while other fields have default values (not null).

For example:

message OneOfOptionalTest {
  string header = 1;
  oneof id {
    string x = 2;
    int32  y = 3;
    bool z = 4;
  }
  optional string name = 5;
  optional int32 age= 6;
  repeated string str_list = 7;
  map<string, int32> int_map = 8;
}

The type of each property in the Python object generated by OneOfOptional is as follows:

At runtime:

>>> demo1 = OneOfOptionalTest(x="1")
>>> demo1.x
... '1'
>>> demo2 = OneOfOptionalTest(x="1", y=2)
>>> demo2.x
... ''
>>> demo2.y
... 2
>>> demo3 = OneOfOptionalTest(name=None, age=3)
>>> demo3.name
... ''
>>> demo3.age
... 3

from protobuf_to_pydantic.