webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Public Member Functions | Public Attributes | List of all members
google.protobuf.descriptor.Descriptor Class Reference
Inheritance diagram for google.protobuf.descriptor.Descriptor:
google.protobuf.descriptor._NestedDescriptorBase google.protobuf.descriptor.DescriptorBase google.protobuf.descriptor.DescriptorMetaclass

Public Member Functions

def __new__ (cls, name, full_name, filename, containing_type, fields, nested_types, enum_types, extensions, 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, is_extendable=True, extension_ranges=None, oneofs=None, file=None, serialized_start=None, serialized_end=None, syntax=None)
 
def fields_by_camelcase_name (self)
 
def EnumValueName (self, enum, value)
 
def CopyToProto (self, proto)
 
- 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)
 
def GetTopLevelContainingType (self)
 
def CopyToProto (self, proto)
 
- Public Member Functions inherited from google.protobuf.descriptor.DescriptorBase
def __init__ (self, options, options_class_name)
 
def GetOptions (self)
 
- Public Member Functions inherited from google.protobuf.descriptor.DescriptorMetaclass
def __instancecheck__ (cls, obj)
 

Public Attributes

 fields
 
 fields_by_number
 
 fields_by_name
 
 nested_types
 
 nested_types_by_name
 
 enum_types
 
 enum_types_by_name
 
 enum_values_by_name
 
 extensions
 
 extensions_by_name
 
 is_extendable
 
 extension_ranges
 
 oneofs
 
 oneofs_by_name
 
 syntax
 
- Public Attributes inherited from google.protobuf.descriptor._NestedDescriptorBase
 name
 
 full_name
 
 file
 
 containing_type
 
- Public Attributes inherited from google.protobuf.descriptor.DescriptorBase
 has_options
 

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.

Constructor & Destructor Documentation

◆ __init__()

def google.protobuf.descriptor.Descriptor.__init__ (   self,
  name,
  full_name,
  filename,
  containing_type,
  fields,
  nested_types,
  enum_types,
  extensions,
  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.

Member Function Documentation

◆ __new__()

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

◆ CopyToProto()

def google.protobuf.descriptor.Descriptor.CopyToProto (   self,
  proto 
)
Copies this to a descriptor_pb2.DescriptorProto.

Args:
  proto: An empty descriptor_pb2.DescriptorProto.

◆ EnumValueName()

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.

◆ fields_by_camelcase_name()

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

Member Data Documentation

◆ enum_types

google.protobuf.descriptor.Descriptor.enum_types

◆ enum_types_by_name

google.protobuf.descriptor.Descriptor.enum_types_by_name

◆ enum_values_by_name

google.protobuf.descriptor.Descriptor.enum_values_by_name

◆ extension_ranges

google.protobuf.descriptor.Descriptor.extension_ranges

◆ extensions

google.protobuf.descriptor.Descriptor.extensions

◆ extensions_by_name

google.protobuf.descriptor.Descriptor.extensions_by_name

◆ fields

google.protobuf.descriptor.Descriptor.fields

◆ fields_by_name

google.protobuf.descriptor.Descriptor.fields_by_name

◆ fields_by_number

google.protobuf.descriptor.Descriptor.fields_by_number

◆ is_extendable

google.protobuf.descriptor.Descriptor.is_extendable

◆ nested_types

google.protobuf.descriptor.Descriptor.nested_types

◆ nested_types_by_name

google.protobuf.descriptor.Descriptor.nested_types_by_name

◆ oneofs

google.protobuf.descriptor.Descriptor.oneofs

◆ oneofs_by_name

google.protobuf.descriptor.Descriptor.oneofs_by_name

◆ syntax

google.protobuf.descriptor.Descriptor.syntax

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