google.protobuf.descriptor.FileDescriptor Class Reference

Inheritance diagram for google.protobuf.descriptor.FileDescriptor:

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	__new__ (cls, name, package, options=None, serialized_options=None, serialized_pb=None, dependencies=None, public_dependencies=None, syntax=None, pool=None)
def	CopyToProto (self, proto)
Public Member Functions inherited from google.protobuf.descriptor.DescriptorBase
def	__init__ (self, options, serialized_options, options_class_name)
def	GetOptions (self)
Public Member Functions inherited from google.protobuf.descriptor.DescriptorMetaclass
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.

Definition at line 844 of file descriptor.py.

Constructor & Destructor Documentation

__init__()

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 descriptor.py.

Member Function Documentation

__new__()

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 descriptor.py.

CopyToProto()

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 descriptor.py.

Member Data Documentation

_C_DESCRIPTOR_CLASS

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

staticprivate

Definition at line 868 of file descriptor.py.

dependencies

google.protobuf.descriptor.FileDescriptor.dependencies

Definition at line 901 of file descriptor.py.

enum_types_by_name

google.protobuf.descriptor.FileDescriptor.enum_types_by_name

Definition at line 898 of file descriptor.py.

extensions_by_name

google.protobuf.descriptor.FileDescriptor.extensions_by_name

Definition at line 899 of file descriptor.py.

message_types_by_name

google.protobuf.descriptor.FileDescriptor.message_types_by_name

Definition at line 892 of file descriptor.py.

name

google.protobuf.descriptor.FileDescriptor.name

Definition at line 893 of file descriptor.py.

package

google.protobuf.descriptor.FileDescriptor.package

Definition at line 894 of file descriptor.py.

pool

google.protobuf.descriptor.FileDescriptor.pool

Definition at line 891 of file descriptor.py.

public_dependencies

google.protobuf.descriptor.FileDescriptor.public_dependencies

Definition at line 902 of file descriptor.py.

serialized_pb

google.protobuf.descriptor.FileDescriptor.serialized_pb

Definition at line 896 of file descriptor.py.

services_by_name

google.protobuf.descriptor.FileDescriptor.services_by_name

Definition at line 900 of file descriptor.py.

syntax

google.protobuf.descriptor.FileDescriptor.syntax

Definition at line 895 of file descriptor.py.

---

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

• descriptor.py