Inheritance diagram for google.protobuf.descriptor.Descriptor:

[legend]

Public Member Functions
def	__init__ (self, name, full_name, filename, containing_type, fields, nested_types, enum_types, extensions, options=None, serialized_options=None, is_extendable=True, extension_ranges=None, oneofs=None, file=None, serialized_start=None, serialized_end=None, syntax=None)

def	__init__ (self, name, full_name, filename, containing_type, fields, nested_types, enum_types, extensions, options=None, serialized_options=None, is_extendable=True, extension_ranges=None, oneofs=None, file=None, serialized_start=None, serialized_end=None, syntax=None, create_key=None)

def	__new__ (cls, name, full_name, filename, containing_type, fields, nested_types, enum_types, extensions, options=None, serialized_options=None, is_extendable=True, extension_ranges=None, oneofs=None, file=None, serialized_start=None, serialized_end=None, syntax=None)

def	__new__ (cls, name=None, full_name=None, filename=None, containing_type=None, fields=None, nested_types=None, enum_types=None, extensions=None, options=None, serialized_options=None, is_extendable=True, extension_ranges=None, oneofs=None, file=None, serialized_start=None, serialized_end=None, syntax=None, create_key=None)

def	CopyToProto (self, proto)

def	CopyToProto (self, proto)

def	EnumValueName (self, enum, value)

def	EnumValueName (self, enum, value)

def	fields_by_camelcase_name (self)

def	fields_by_camelcase_name (self)

Public Member Functions inherited from google.protobuf.descriptor._NestedDescriptorBase
def	__init__ (self, options, options_class_name, name, full_name, file, containing_type, serialized_start=None, serialized_end=None, serialized_options=None)

def	__init__ (self, options, options_class_name, name, full_name, file, containing_type, serialized_start=None, serialized_end=None, serialized_options=None)

Public Member Functions inherited from google.protobuf.descriptor.DescriptorBase
def	__init__ (self, options, serialized_options, options_class_name)

def	__init__ (self, options, serialized_options, options_class_name)

def	GetOptions (self)

def	GetOptions (self)

Public Member Functions inherited from google.protobuf.descriptor.DescriptorMetaclass
def	__instancecheck__ (cls, obj)

def	__instancecheck__ (cls, obj)

Public Attributes
	enum_types

	enum_types_by_name

	enum_values_by_name

	extension_ranges

	extensions

	extensions_by_name

	fields

	fields_by_name

	fields_by_number

	is_extendable

	nested_types

	nested_types_by_name

	oneofs

	oneofs_by_name

	syntax

Public Attributes inherited from google.protobuf.descriptor._NestedDescriptorBase
	containing_type

	file

	full_name

	name

Public Attributes inherited from google.protobuf.descriptor.DescriptorBase
	has_options

Private Attributes
	_fields_by_camelcase_name

Static Private Attributes
	_C_DESCRIPTOR_CLASS = _message.Descriptor

Detailed Description

Descriptor for a protocol message type.

A Descriptor instance has the following attributes:

  name: (str) Name of this protocol message type.
  full_name: (str) Fully-qualified name of this protocol message type,
    which will include protocol "package" name and the name of any
    enclosing types.

  containing_type: (Descriptor) Reference to the descriptor of the
    type containing us, or None if this is top-level.

  fields: (list of FieldDescriptors) Field descriptors for all
    fields in this type.
  fields_by_number: (dict int -> FieldDescriptor) Same FieldDescriptor
    objects as in |fields|, but indexed by "number" attribute in each
    FieldDescriptor.
  fields_by_name: (dict str -> FieldDescriptor) Same FieldDescriptor
    objects as in |fields|, but indexed by "name" attribute in each
    FieldDescriptor.
  fields_by_camelcase_name: (dict str -> FieldDescriptor) Same
    FieldDescriptor objects as in |fields|, but indexed by
    "camelcase_name" attribute in each FieldDescriptor.

  nested_types: (list of Descriptors) Descriptor references
    for all protocol message types nested within this one.
  nested_types_by_name: (dict str -> Descriptor) Same Descriptor
    objects as in |nested_types|, but indexed by "name" attribute
    in each Descriptor.

  enum_types: (list of EnumDescriptors) EnumDescriptor references
    for all enums contained within this type.
  enum_types_by_name: (dict str ->EnumDescriptor) Same EnumDescriptor
    objects as in |enum_types|, but indexed by "name" attribute
    in each EnumDescriptor.
  enum_values_by_name: (dict str -> EnumValueDescriptor) Dict mapping
    from enum value name to EnumValueDescriptor for that value.

  extensions: (list of FieldDescriptor) All extensions defined directly
    within this message type (NOT within a nested type).
  extensions_by_name: (dict, string -> FieldDescriptor) Same FieldDescriptor
    objects as |extensions|, but indexed by "name" attribute of each
    FieldDescriptor.

  is_extendable:  Does this type define any extension ranges?

  oneofs: (list of OneofDescriptor) The list of descriptors for oneof fields
    in this message.
  oneofs_by_name: (dict str -> OneofDescriptor) Same objects as in |oneofs|,
    but indexed by "name" attribute.

  file: (FileDescriptor) Reference to file descriptor.

Descriptor for a protocol message type.

Attributes:
    name (str): Name of this protocol message type.
    full_name (str): Fully-qualified name of this protocol message type,
        which will include protocol "package" name and the name of any
        enclosing types.
    containing_type (Descriptor): Reference to the descriptor of the type
        containing us, or None if this is top-level.
    fields (list[FieldDescriptor]): Field descriptors for all fields in
        this type.
    fields_by_number (dict(int, FieldDescriptor)): Same
        :class:`FieldDescriptor` objects as in :attr:`fields`, but indexed
        by "number" attribute in each FieldDescriptor.
    fields_by_name (dict(str, FieldDescriptor)): Same
        :class:`FieldDescriptor` objects as in :attr:`fields`, but indexed by
        "name" attribute in each :class:`FieldDescriptor`.
    nested_types (list[Descriptor]): Descriptor references
        for all protocol message types nested within this one.
    nested_types_by_name (dict(str, Descriptor)): Same Descriptor
        objects as in :attr:`nested_types`, but indexed by "name" attribute
        in each Descriptor.
    enum_types (list[EnumDescriptor]): :class:`EnumDescriptor` references
        for all enums contained within this type.
    enum_types_by_name (dict(str, EnumDescriptor)): Same
        :class:`EnumDescriptor` objects as in :attr:`enum_types`, but
        indexed by "name" attribute in each EnumDescriptor.
    enum_values_by_name (dict(str, EnumValueDescriptor)): Dict mapping
        from enum value name to :class:`EnumValueDescriptor` for that value.
    extensions (list[FieldDescriptor]): All extensions defined directly
        within this message type (NOT within a nested type).
    extensions_by_name (dict(str, FieldDescriptor)): Same FieldDescriptor
        objects as :attr:`extensions`, but indexed by "name" attribute of each
        FieldDescriptor.
    is_extendable (bool):  Does this type define any extension ranges?
    oneofs (list[OneofDescriptor]): The list of descriptors for oneof fields
        in this message.
    oneofs_by_name (dict(str, OneofDescriptor)): Same objects as in
        :attr:`oneofs`, but indexed by "name" attribute.
    file (FileDescriptor): Reference to file descriptor.

Definition at line 222 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

Constructor & Destructor Documentation

◆ init() [1/2]

def google.protobuf.descriptor.Descriptor.__init__	(	self,
		name,
		full_name,
		filename,
		containing_type,
		fields,
		nested_types,
		enum_types,
		extensions,
		options = `None`,
		serialized_options = `None`,
		is_extendable = `True`,
		extension_ranges = `None`,
		oneofs = `None`,
		file = `None`,
		serialized_start = `None`,
		serialized_end = `None`,
		syntax = `None`
	)

Arguments to __init__() are as described in the description
of Descriptor fields above.

Note that filename is an obsolete argument, that is not used anymore.
Please use file.name to access this as an attribute.

Definition at line 293 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ init() [2/2]

def google.protobuf.descriptor.Descriptor.__init__	(	self,
		name,
		full_name,
		filename,
		containing_type,
		fields,
		nested_types,
		enum_types,
		extensions,
		options = `None`,
		serialized_options = `None`,
		is_extendable = `True`,
		extension_ranges = `None`,
		oneofs = `None`,
		file = `None`,
		serialized_start = `None`,
		serialized_end = `None`,
		syntax = `None`,
		create_key = `None`
	)

Arguments to __init__() are as described in the description
of Descriptor fields above.

Note that filename is an obsolete argument, that is not used anymore.
Please use file.name to access this as an attribute.

Definition at line 315 of file protobuf/python/google/protobuf/descriptor.py.

Member Function Documentation

◆ new() [1/2]

def google.protobuf.descriptor.Descriptor.__new__	(	cls,
		name,
		full_name,
		filename,
		containing_type,
		fields,
		nested_types,
		enum_types,
		extensions,
		options = `None`,
		serialized_options = `None`,
		is_extendable = `True`,
		extension_ranges = `None`,
		oneofs = `None`,
		file = `None`,
		serialized_start = `None`,
		serialized_end = `None`,
		syntax = `None`
	)

Definition at line 281 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ new() [2/2]

def google.protobuf.descriptor.Descriptor.__new__	(	cls,
		name = `None`,
		full_name = `None`,
		filename = `None`,
		containing_type = `None`,
		fields = `None`,
		nested_types = `None`,
		enum_types = `None`,
		extensions = `None`,
		options = `None`,
		serialized_options = `None`,
		is_extendable = `True`,
		extension_ranges = `None`,
		oneofs = `None`,
		file = `None`,
		serialized_start = `None`,
		serialized_end = `None`,
		syntax = `None`,
		create_key = `None`
	)

Definition at line 289 of file protobuf/python/google/protobuf/descriptor.py.

◆ CopyToProto() [1/2]

def google.protobuf.descriptor.Descriptor.CopyToProto	(	self,
		proto
	)

Copies this to a descriptor_pb2.DescriptorProto.

Args:
  proto: An empty descriptor_pb2.DescriptorProto.

Reimplemented from google.protobuf.descriptor._NestedDescriptorBase.

Definition at line 371 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ CopyToProto() [2/2]

def google.protobuf.descriptor.Descriptor.CopyToProto	(	self,
		proto
	)

Copies this to a descriptor_pb2.DescriptorProto.

Args:
  proto: An empty descriptor_pb2.DescriptorProto.

Reimplemented from google.protobuf.descriptor._NestedDescriptorBase.

Definition at line 399 of file protobuf/python/google/protobuf/descriptor.py.

◆ EnumValueName() [1/2]

def google.protobuf.descriptor.Descriptor.EnumValueName	(	self,
		enum,
		value
	)

Returns the string name of an enum value.

This is just a small helper method to simplify a common operation.

Args:
  enum: string name of the Enum.
  value: int, value of the enum.

Returns:
  string name of the enum value.

Raises:
  KeyError if either the Enum doesn't exist or the value is not a valid
value for the enum.

Definition at line 353 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ EnumValueName() [2/2]

def google.protobuf.descriptor.Descriptor.EnumValueName	(	self,
		enum,
		value
	)

Returns the string name of an enum value.

This is just a small helper method to simplify a common operation.

Args:
  enum: string name of the Enum.
  value: int, value of the enum.

Returns:
  string name of the enum value.

Raises:
  KeyError if either the Enum doesn't exist or the value is not a valid
value for the enum.

Definition at line 381 of file protobuf/python/google/protobuf/descriptor.py.

◆ fields_by_camelcase_name() [1/2]

def google.protobuf.descriptor.Descriptor.fields_by_camelcase_name ( self )

Definition at line 347 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ fields_by_camelcase_name() [2/2]

def google.protobuf.descriptor.Descriptor.fields_by_camelcase_name ( self )

Same FieldDescriptor objects as in :attr:`fields`, but indexed by
:attr:`FieldDescriptor.camelcase_name`.

Definition at line 372 of file protobuf/python/google/protobuf/descriptor.py.

Member Data Documentation

◆ _C_DESCRIPTOR_CLASS

google.protobuf.descriptor.Descriptor._C_DESCRIPTOR_CLASS = _message.Descriptor

staticprivate

Definition at line 279 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ _fields_by_camelcase_name

google.protobuf.descriptor.Descriptor._fields_by_camelcase_name

private

Definition at line 315 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ enum_types

google.protobuf.descriptor.Descriptor.enum_types

Definition at line 322 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ enum_types_by_name

google.protobuf.descriptor.Descriptor.enum_types_by_name

Definition at line 325 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ enum_values_by_name

google.protobuf.descriptor.Descriptor.enum_values_by_name

Definition at line 326 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ extension_ranges

google.protobuf.descriptor.Descriptor.extension_ranges

Definition at line 334 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ extensions

google.protobuf.descriptor.Descriptor.extensions

Definition at line 329 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ extensions_by_name

google.protobuf.descriptor.Descriptor.extensions_by_name

Definition at line 332 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ fields

google.protobuf.descriptor.Descriptor.fields

Definition at line 310 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ fields_by_name

google.protobuf.descriptor.Descriptor.fields_by_name

Definition at line 314 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ fields_by_number

google.protobuf.descriptor.Descriptor.fields_by_number

Definition at line 313 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ is_extendable

google.protobuf.descriptor.Descriptor.is_extendable

Definition at line 333 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ nested_types

google.protobuf.descriptor.Descriptor.nested_types

Definition at line 317 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ nested_types_by_name

google.protobuf.descriptor.Descriptor.nested_types_by_name

Definition at line 320 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ oneofs

google.protobuf.descriptor.Descriptor.oneofs

Definition at line 335 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ oneofs_by_name

google.protobuf.descriptor.Descriptor.oneofs_by_name

Definition at line 336 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

◆ syntax

google.protobuf.descriptor.Descriptor.syntax

Definition at line 339 of file bloaty/third_party/protobuf/python/google/protobuf/descriptor.py.

The documentation for this class was generated from the following file:

bloaty/third_party/protobuf/python/google/protobuf/descriptor.py

Public Member Functions

Public Attributes

Private Attributes

Static Private Attributes