class CodeGeneratorResponse(Message): (source)
Constructor: CodeGeneratorResponse(initial_message, error, supported_features, minimum_edition, ...)
The plugin writes an encoded CodeGeneratorResponse to stdout.
| Class | |
Sync with code_generator.h. |
| Class | |
Represents a single generated file. |
| Method | __init__ |
Create a message from a source message and field values. |
| Method | error |
Set or clear the generated error field. |
| Method | file |
Set or clear the generated file field. |
| Method | maximum |
Set or clear the generated maximum_edition field. |
| Method | minimum |
Set or clear the generated minimum_edition field. |
| Method | supported |
Set or clear the generated supported_features field. |
| Property | error |
Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way. |
| Property | file |
Undocumented |
| Property | maximum |
The maximum edition this plugin supports. This will be treated as an Edition enum, but we want to allow unknown values. It should be specified according the edition enum value, not the edition number... |
| Property | minimum |
The minimum edition this plugin supports. This will be treated as an Edition enum, but we want to allow unknown values. It should be specified according the edition enum value, not the edition number... |
| Property | supported |
A bitmask of supported features that the code generator supports. This is a bitwise "or" of values from the Feature enum. |
Inherited from Message:
| Class Method | from |
Create a message from protobuf JSON mapping. |
| Class Method | |
Create a message by parsing protobuf wire-format bytes. |
| Class Method | get |
Return the message descriptor from the registry. |
| Class Method | is |
Return True if a Python field contains credentials. |
| Class Method | is |
Return True if a Python field has the sensitive annotation. |
| Method | __dir__ |
List generated fields, oneofs, and nested declarations. |
| Method | __repr__ |
Render non-default fields without disclosing annotated secrets. |
| Method | |
Return the serialized protobuf wire size in bytes. |
| Method | check |
Check presence using a generated Python field name. |
| Method | |
Clear all fields, extensions, unknown fields, and the reset mask. |
| Method | clear |
Clear an extension value. |
| Method | |
Clear a protobuf field or oneof and record it in the reset mask. |
| Method | |
Replace this message with an independent copy of another message. |
| Method | |
Return paths of missing required fields. |
| Method | get |
Return an extension value. |
| Method | get |
Create a reset mask from the current protobuf state. |
| Method | get |
Return the reset mask for field changes. |
| Method | has |
Return True if an extension has explicit presence. |
| Method | |
Return True if a protobuf field or oneof has explicit presence. |
| Method | is |
Return True if a generated field has its default value. |
| Method | |
Return True if every required field is initialized. |
| Method | |
Merge fields from another message of the same generated type. |
| Method | |
Merge protobuf wire-format bytes into this message. |
| Method | |
Parse protobuf wire-format bytes and replace this message. |
| Method | |
Serialize the message using protobuf wire format. |
| Method | set |
Set an extension value. |
| Method | set |
Set the reset mask for this message. |
| Method | to |
Serialize this message using protobuf JSON mapping. |
| Method | which |
Return the selected Python field name for a protobuf oneof. |
| Method | |
Return the selected protobuf field name for a oneof. |
| Constant | __DEPRECATION |
Undocumented |
| Constant | __EXTENSION |
Registry that decodes protobuf extensions. |
| Constant | __FIELDS__ |
Runtime field data that the generator creates. |
| Constant | __MAX |
Maximum protobuf nesting depth for serialization, parsing, and initialization checks. |
| Constant | __PB2 |
Alias for code that expects a protobuf descriptor. |
| Constant | __PROTO |
Message descriptor from the registry. |
| Constant | __PY |
Mapping from Python names to protobuf names. |
| Constant | __REGISTRY__ |
Registry for the message and its descriptor. |
| Class Variable | __PROTO |
Fully qualified protobuf message name. |
| Property | |
Provide protobuf-compatible mapping access to extension values. |
| Class Method | _fields |
Undocumented |
| Class Method | _fields |
Undocumented |
| Class Method | _fields |
Undocumented |
| Class Method | _from |
Deserialize internally without invoking generated user warnings. |
| Class Method | _oneof |
Undocumented |
| Class Method | _public |
Undocumented |
| Class Method | _public |
Undocumented |
| Static Method | _format |
Undocumented |
| Static Method | _repr |
Undocumented |
| Method | _bind |
Undocumented |
| Method | _bind |
Undocumented |
| Method | _check |
Undocumented |
| Method | _child |
Undocumented |
| Method | _clear |
Undocumented |
| Method | _closed |
Undocumented |
| Method | _converted |
Undocumented |
| Method | _decode |
Undocumented |
| Method | _detach |
Undocumented |
| Method | _field |
Undocumented |
| Method | _field |
Undocumented |
| Method | _find |
Undocumented |
| Method | _get |
Undocumented |
| Method | _initialize |
Initialize message state, optionally suppressing generated warnings. |
| Method | _map |
Undocumented |
| Method | _merge |
Undocumented |
| Method | _nesting |
Undocumented |
| Method | _notify |
Undocumented |
| Method | _record |
Undocumented |
| Method | _repeated |
Undocumented |
| Method | _select |
Undocumented |
| Method | _serialize |
Undocumented |
| Method | _set |
Undocumented |
| Method | _suspend |
Undocumented |
| Method | _suspend |
Undocumented |
| Method | _try |
Undocumented |
| Method | _write |
Undocumented |
| Instance Variable | _extensions |
Undocumented |
| Instance Variable | _mutation |
Undocumented |
| Instance Variable | _on |
Undocumented |
| Instance Variable | _oneofs |
Undocumented |
| Instance Variable | _present |
Undocumented |
| Instance Variable | _reset |
Undocumented |
| Instance Variable | _reset |
Undocumented |
| Instance Variable | _unknown |
Undocumented |
| Instance Variable | _values |
Undocumented |
| Instance Variable | _views |
Undocumented |
SerializableMessage | None = None, *, error: str | None | UnsetType = ..., supported_features: int | None | UnsetType = ..., minimum_edition: int | None | UnsetType = ..., maximum_edition: int | None | UnsetType = ..., file: Iterable[ File] | None | UnsetType = ...):
(source)
¶
Create a message from a source message and field values.
Error message. If non-empty, code generation failed. The plugin process should exit with status code zero even if it reports an error in this way.
This should be used to indicate errors in .proto files which prevent the code generator from generating correct code. Errors which indicate a problem in protoc itself -- such as the input CodeGeneratorRequest being unparseable -- should be reported by writing a message to stderr and exiting with a non-zero status code.
The maximum edition this plugin supports. This will be treated as an Edition enum, but we want to allow unknown values. It should be specified according the edition enum value, not the edition number. Only takes effect for plugins that have FEATURE_SUPPORTS_EDITIONS set.