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

Public Member Functions

def __init__ (self, name, package, options=None, serialized_options=None, serialized_pb=None, dependencies=None, public_dependencies=None, syntax=None, pool=None)
 
def __init__ (self, name, package, options=None, serialized_options=None, serialized_pb=None, dependencies=None, public_dependencies=None, syntax=None, pool=None, create_key=None)
 
def __new__ (cls, name, package, options=None, serialized_options=None, serialized_pb=None, dependencies=None, public_dependencies=None, syntax=None, pool=None)
 
def __new__ (cls, name, package, options=None, serialized_options=None, serialized_pb=None, dependencies=None, public_dependencies=None, syntax=None, pool=None, create_key=None)
 
def CopyToProto (self, proto)
 
def CopyToProto (self, proto)
 
- 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

 dependencies
 
 enum_types_by_name
 
 extensions_by_name
 
 message_types_by_name
 
 name
 
 package
 
 pool
 
 public_dependencies
 
 serialized_pb
 
 services_by_name
 
 syntax
 
- Public Attributes inherited from google.protobuf.descriptor.DescriptorBase
 has_options
 

Static Private Attributes

 _C_DESCRIPTOR_CLASS = _message.FileDescriptor
 

Detailed Description

Descriptor for a file. Mimics the descriptor_pb2.FileDescriptorProto.

Note that enum_types_by_name, extensions_by_name, and dependencies
fields are only set by the message_factory module, and not by the
generated proto code.

name: name of file, relative to root of source tree.
package: name of the package
syntax: string indicating syntax of the file (can be "proto2" or "proto3")
serialized_pb: (str) Byte string of serialized
  descriptor_pb2.FileDescriptorProto.
dependencies: List of other FileDescriptors this FileDescriptor depends on.
public_dependencies: A list of FileDescriptors, subset of the dependencies
  above, which were declared as "public".
message_types_by_name: Dict of message names and their descriptors.
enum_types_by_name: Dict of enum names and their descriptors.
extensions_by_name: Dict of extension names and their descriptors.
services_by_name: Dict of services names and their descriptors.
pool: the DescriptorPool this descriptor belongs to.  When not passed to the
  constructor, the global default pool is used.

Descriptor for a file. Mimics the descriptor_pb2.FileDescriptorProto.

Note that :attr:`enum_types_by_name`, :attr:`extensions_by_name`, and
:attr:`dependencies` fields are only set by the
:py:mod:`google.protobuf.message_factory` module, and not by the generated
proto code.

Attributes:
  name (str): Name of file, relative to root of source tree.
  package (str): Name of the package
  syntax (str): string indicating syntax of the file (can be "proto2" or
    "proto3")
  serialized_pb (bytes): Byte string of serialized
    :class:`descriptor_pb2.FileDescriptorProto`.
  dependencies (list[FileDescriptor]): List of other :class:`FileDescriptor`
    objects this :class:`FileDescriptor` depends on.
  public_dependencies (list[FileDescriptor]): A subset of
    :attr:`dependencies`, which were declared as "public".
  message_types_by_name (dict(str, Descriptor)): Mapping from message names
    to their :class:`Descriptor`.
  enum_types_by_name (dict(str, EnumDescriptor)): Mapping from enum names to
    their :class:`EnumDescriptor`.
  extensions_by_name (dict(str, FieldDescriptor)): Mapping from extension
    names declared at file scope to their :class:`FieldDescriptor`.
  services_by_name (dict(str, ServiceDescriptor)): Mapping from services'
    names to their :class:`ServiceDescriptor`.
  pool (DescriptorPool): The pool this descriptor belongs to.  When not
    passed to the constructor, the global default pool is used.

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

Constructor & Destructor Documentation

◆ __init__() [1/2]

def google.protobuf.descriptor.FileDescriptor.__init__ (   self,
  name,
  package,
  options = None,
  serialized_options = None,
  serialized_pb = None,
  dependencies = None,
  public_dependencies = None,
  syntax = None,
  pool = None 
) 
Constructor.

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

◆ __init__() [2/2]

def google.protobuf.descriptor.FileDescriptor.__init__ (   self,
  name,
  package,
  options = None,
  serialized_options = None,
  serialized_pb = None,
  dependencies = None,
  public_dependencies = None,
  syntax = None,
  pool = None,
  create_key = None 
) 
Constructor.

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

Member Function Documentation

◆ __new__() [1/2]

def google.protobuf.descriptor.FileDescriptor.__new__ (   cls,
  name,
  package,
  options = None,
  serialized_options = None,
  serialized_pb = None,
  dependencies = None,
  public_dependencies = None,
  syntax = None,
  pool = None 
)

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

◆ __new__() [2/2]

def google.protobuf.descriptor.FileDescriptor.__new__ (   cls,
  name,
  package,
  options = None,
  serialized_options = None,
  serialized_pb = None,
  dependencies = None,
  public_dependencies = None,
  syntax = None,
  pool = None,
  create_key = None 
)

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

◆ CopyToProto() [1/2]

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

Args:
  proto: An empty descriptor_pb2.FileDescriptorProto.

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

◆ CopyToProto() [2/2]

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

Args:
  proto: An empty descriptor_pb2.FileDescriptorProto.

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

Member Data Documentation

◆ _C_DESCRIPTOR_CLASS

google.protobuf.descriptor.FileDescriptor._C_DESCRIPTOR_CLASS = _message.FileDescriptor
staticprivate

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

◆ dependencies

google.protobuf.descriptor.FileDescriptor.dependencies

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

◆ enum_types_by_name

google.protobuf.descriptor.FileDescriptor.enum_types_by_name

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

◆ extensions_by_name

google.protobuf.descriptor.FileDescriptor.extensions_by_name

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

◆ message_types_by_name

google.protobuf.descriptor.FileDescriptor.message_types_by_name

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

◆ name

google.protobuf.descriptor.FileDescriptor.name

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

◆ package

google.protobuf.descriptor.FileDescriptor.package

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

◆ pool

google.protobuf.descriptor.FileDescriptor.pool

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

◆ public_dependencies

google.protobuf.descriptor.FileDescriptor.public_dependencies

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

◆ serialized_pb

google.protobuf.descriptor.FileDescriptor.serialized_pb

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

◆ services_by_name

google.protobuf.descriptor.FileDescriptor.services_by_name

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

◆ syntax

google.protobuf.descriptor.FileDescriptor.syntax

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

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

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