Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
google.protobuf.descriptor.DescriptorBase Class Reference
Inheritance diagram for google.protobuf.descriptor.DescriptorBase:
Inheritance graph
[legend]

Public Member Functions

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

 has_options
 

Private Member Functions

def _SetOptions (self, options, options_class_name)
 
def _SetOptions (self, options, options_class_name)
 

Private Attributes

 _options
 
 _options_class_name
 
 _serialized_options
 

Static Private Attributes

tuple _C_DESCRIPTOR_CLASS = ()
 

Detailed Description

Descriptors base class.

This class is the base of all descriptor classes. It provides common options
related functionality.

Attributes:
  has_options:  True if the descriptor has non-default options.  Usually it
      is not necessary to read this -- just call GetOptions() which will
      happily return the default instance.  However, it's sometimes useful
      for efficiency, and also useful inside the protobuf implementation to
      avoid some bootstrapping issues.

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

def google.protobuf.descriptor.DescriptorBase.__init__ (   self,
  options,
  serialized_options,
  options_class_name 
)
Initialize the descriptor given its options message and the name of the
class of the options message. The name of the class is required in case
the options message is None and has to be created.

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

◆ __init__() [2/2]

def google.protobuf.descriptor.DescriptorBase.__init__ (   self,
  options,
  serialized_options,
  options_class_name 
)
Initialize the descriptor given its options message and the name of the
class of the options message. The name of the class is required in case
the options message is None and has to be created.

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

Member Function Documentation

◆ _SetOptions() [1/2]

def google.protobuf.descriptor.DescriptorBase._SetOptions (   self,
  options,
  options_class_name 
)
private
Sets the descriptor's options

This function is used in generated proto2 files to update descriptor
options. It must not be used outside proto2.

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

◆ _SetOptions() [2/2]

def google.protobuf.descriptor.DescriptorBase._SetOptions (   self,
  options,
  options_class_name 
)
private
Sets the descriptor's options

This function is used in generated proto2 files to update descriptor
options. It must not be used outside proto2.

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

◆ GetOptions() [1/2]

def google.protobuf.descriptor.DescriptorBase.GetOptions (   self)
Retrieves descriptor options.

This method returns the options set or creates the default options for the
descriptor.

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

◆ GetOptions() [2/2]

def google.protobuf.descriptor.DescriptorBase.GetOptions (   self)
Retrieves descriptor options.

This method returns the options set or creates the default options for the
descriptor.

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

Member Data Documentation

◆ _C_DESCRIPTOR_CLASS

tuple google.protobuf.descriptor.DescriptorBase._C_DESCRIPTOR_CLASS = ()
staticprivate

◆ _options

google.protobuf.descriptor.DescriptorBase._options
private

◆ _options_class_name

google.protobuf.descriptor.DescriptorBase._options_class_name
private

◆ _serialized_options

google.protobuf.descriptor.DescriptorBase._serialized_options
private

◆ has_options

google.protobuf.descriptor.DescriptorBase.has_options

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


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:23