API Documentation

Compiler

class pyprotobuf.compiler.Compiler

Nodes

class pyprotobuf.nodes.ParseNode

children = None

Type:list[pyprotobuf.nodes.ParseNode]

parent = None

name = None

comment = None

A comment associated with this node.

Type:pyprotobuf.nodes.CommentNode

get_file()

add_child(c)

get_children()

get_child(index)

get_full_typename()

add_dependency(dep)

Parameters:dep (pyprotobuf.nodes.ParseNode) – The node to add a dependency to.

get_dependencies()

Return type:list[pyprotobuf.nodes.ParseNode]

get_parents()

Return type:list[pyprotobuf.nodes.ParseNode]

get_root()

get_full_name()

get_children_of_type(node_class)

Return type:list[V <= T]

resolve_name(name)

has_option(name)

set_option(name, value)

get_option(*args)

to_proto()

exception pyprotobuf.nodes.InvalidChildTypeError(child, accepted_types)

class pyprotobuf.nodes.RootNode

get_package(name)

add_child(c)

class pyprotobuf.nodes.FileNode

filename = None

package_name = None

get_imports()

class pyprotobuf.nodes.CommentNode

class pyprotobuf.nodes.Package

name = ''

add_child(c)

is_named()

class pyprotobuf.nodes.PackageDefinition

name = None

to_proto()

class pyprotobuf.nodes.ServiceNode

name = None

to_proto()

class pyprotobuf.nodes.MethodNode

name = None

request_type = None

response_type = None

class pyprotobuf.nodes.MessageNode

name = None

tostr(depth)

to_proto()

class pyprotobuf.nodes.FieldDescriptorNode

Properties:

label: One of “repeated”, “optional” or “required”. number: The tag/number/id of the field. name: The name of the field. type: Can be a string (Enum of proto types), MessageNode or EnumNode.

label = None

number = None

name = None

type = None

class LabelType

REPEATED = 'repeated'

OPTIONAL = 'optional'

REQUIRED = 'required'

FieldDescriptorNode.to_proto()

class pyprotobuf.nodes.EnumNode

name = None

has(key)

get(key)

to_proto()

class pyprotobuf.nodes.EnumAssignmentNode

name = None

value = None

to_proto()

class pyprotobuf.nodes.OptionNode

name = None

value = None

to_proto()

class pyprotobuf.nodes.ExtendNode

name = None

message_node

Return type:MessageNode

to_proto()

class pyprotobuf.nodes.OptionalNode

type = None

to_proto()

class pyprotobuf.nodes.SyntaxNode

to_proto()

class pyprotobuf.nodes.ImportNode

value: path

value = None

file_node = None

public = False

to_proto()

class pyprotobuf.nodes.ExtensionsNode

to_proto()

class pyprotobuf.nodes.Types

BOOL = 'bool'

STRING = 'string'

INT32 = 'int32'

INT64 = 'int64'

UINT32 = 'uint32'

UINT64 = 'uint64'

SINT32 = 'sint32'

SINT64 = 'sint64'

FIXED32 = 'fixed32'

FIXED64 = 'fixed64'

SFIXED32 = 'sfixed32'

SFIXED64 = 'sfixed64'

DOUBLE = 'double'

FLOAT = 'float'

BYTES = 'bytes'

ENUM = 'enum'

MESSAGE = 'messsage'

GROUP = 'group'