ortools.linear_solver.linear_solver_pb2

Generated protocol buffer code.

  1# -*- coding: utf-8 -*-
  2# Generated by the protocol buffer compiler.  DO NOT EDIT!
  3# source: ortools/linear_solver/linear_solver.proto
  4# Protobuf Python Version: 4.25.3
  5"""Generated protocol buffer code."""
  6from google.protobuf import descriptor as _descriptor
  7from google.protobuf import descriptor_pool as _descriptor_pool
  8from google.protobuf import symbol_database as _symbol_database
  9from google.protobuf.internal import builder as _builder
 10# @@protoc_insertion_point(imports)
 11
 12_sym_db = _symbol_database.Default()
 13
 14
 15from ortools.util import optional_boolean_pb2 as ortools_dot_util_dot_optional__boolean__pb2
 16
 17
 18DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n)ortools/linear_solver/linear_solver.proto\x12\x13operations_research\x1a#ortools/util/optional_boolean.proto\"\xb2\x01\n\x0fMPVariableProto\x12\x19\n\x0blower_bound\x18\x01 \x01(\x01:\x04-inf\x12\x18\n\x0bupper_bound\x18\x02 \x01(\x01:\x03inf\x12 \n\x15objective_coefficient\x18\x03 \x01(\x01:\x01\x30\x12\x19\n\nis_integer\x18\x04 \x01(\x08:\x05\x66\x61lse\x12\x0e\n\x04name\x18\x05 \x01(\t:\x00\x12\x1d\n\x12\x62ranching_priority\x18\x06 \x01(\x05:\x01\x30\"\xa0\x01\n\x11MPConstraintProto\x12\x15\n\tvar_index\x18\x06 \x03(\x05\x42\x02\x10\x01\x12\x17\n\x0b\x63oefficient\x18\x07 \x03(\x01\x42\x02\x10\x01\x12\x19\n\x0blower_bound\x18\x02 \x01(\x01:\x04-inf\x12\x18\n\x0bupper_bound\x18\x03 \x01(\x01:\x03inf\x12\x0e\n\x04name\x18\x04 \x01(\t:\x00\x12\x16\n\x07is_lazy\x18\x05 \x01(\x08:\x05\x66\x61lse\"\xf7\x04\n\x18MPGeneralConstraintProto\x12\x0e\n\x04name\x18\x01 \x01(\t:\x00\x12J\n\x14indicator_constraint\x18\x02 \x01(\x0b\x32*.operations_research.MPIndicatorConstraintH\x00\x12>\n\x0esos_constraint\x18\x03 \x01(\x0b\x32$.operations_research.MPSosConstraintH\x00\x12J\n\x14quadratic_constraint\x18\x04 \x01(\x0b\x32*.operations_research.MPQuadraticConstraintH\x00\x12>\n\x0e\x61\x62s_constraint\x18\x05 \x01(\x0b\x32$.operations_research.MPAbsConstraintH\x00\x12@\n\x0e\x61nd_constraint\x18\x06 \x01(\x0b\x32&.operations_research.MPArrayConstraintH\x00\x12?\n\ror_constraint\x18\x07 \x01(\x0b\x32&.operations_research.MPArrayConstraintH\x00\x12L\n\x0emin_constraint\x18\x08 \x01(\x0b\x32\x32.operations_research.MPArrayWithConstantConstraintH\x00\x12L\n\x0emax_constraint\x18\t \x01(\x0b\x32\x32.operations_research.MPArrayWithConstantConstraintH\x00\x42\x14\n\x12general_constraint\"y\n\x15MPIndicatorConstraint\x12\x11\n\tvar_index\x18\x01 \x01(\x05\x12\x11\n\tvar_value\x18\x02 \x01(\x05\x12:\n\nconstraint\x18\x03 \x01(\x0b\x32&.operations_research.MPConstraintProto\"\x9f\x01\n\x0fMPSosConstraint\x12\x45\n\x04type\x18\x01 \x01(\x0e\x32).operations_research.MPSosConstraint.Type:\x0cSOS1_DEFAULT\x12\x11\n\tvar_index\x18\x02 \x03(\x05\x12\x0e\n\x06weight\x18\x03 \x03(\x01\"\"\n\x04Type\x12\x10\n\x0cSOS1_DEFAULT\x10\x00\x12\x08\n\x04SOS2\x10\x01\"\xb4\x01\n\x15MPQuadraticConstraint\x12\x11\n\tvar_index\x18\x01 \x03(\x05\x12\x13\n\x0b\x63oefficient\x18\x02 \x03(\x01\x12\x13\n\x0bqvar1_index\x18\x03 \x03(\x05\x12\x13\n\x0bqvar2_index\x18\x04 \x03(\x05\x12\x14\n\x0cqcoefficient\x18\x05 \x03(\x01\x12\x19\n\x0blower_bound\x18\x06 \x01(\x01:\x04-inf\x12\x18\n\x0bupper_bound\x18\x07 \x01(\x01:\x03inf\"A\n\x0fMPAbsConstraint\x12\x11\n\tvar_index\x18\x01 \x01(\x05\x12\x1b\n\x13resultant_var_index\x18\x02 \x01(\x05\"C\n\x11MPArrayConstraint\x12\x11\n\tvar_index\x18\x01 \x03(\x05\x12\x1b\n\x13resultant_var_index\x18\x02 \x01(\x05\"a\n\x1dMPArrayWithConstantConstraint\x12\x11\n\tvar_index\x18\x01 \x03(\x05\x12\x10\n\x08\x63onstant\x18\x02 \x01(\x01\x12\x1b\n\x13resultant_var_index\x18\x03 \x01(\x05\"U\n\x14MPQuadraticObjective\x12\x13\n\x0bqvar1_index\x18\x01 \x03(\x05\x12\x13\n\x0bqvar2_index\x18\x02 \x03(\x05\x12\x13\n\x0b\x63oefficient\x18\x03 \x03(\x01\"I\n\x19PartialVariableAssignment\x12\x15\n\tvar_index\x18\x01 \x03(\x05\x42\x02\x10\x01\x12\x15\n\tvar_value\x18\x02 \x03(\x01\x42\x02\x10\x01\"\xe4\x05\n\x0cMPModelProto\x12\x36\n\x08variable\x18\x03 \x03(\x0b\x32$.operations_research.MPVariableProto\x12:\n\nconstraint\x18\x04 \x03(\x0b\x32&.operations_research.MPConstraintProto\x12I\n\x12general_constraint\x18\x07 \x03(\x0b\x32-.operations_research.MPGeneralConstraintProto\x12\x17\n\x08maximize\x18\x01 \x01(\x08:\x05\x66\x61lse\x12\x1b\n\x10objective_offset\x18\x02 \x01(\x01:\x01\x30\x12\x46\n\x13quadratic_objective\x18\x08 \x01(\x0b\x32).operations_research.MPQuadraticObjective\x12\x0e\n\x04name\x18\x05 \x01(\t:\x00\x12\x45\n\rsolution_hint\x18\x06 \x01(\x0b\x32..operations_research.PartialVariableAssignment\x12@\n\nannotation\x18\t \x03(\x0b\x32,.operations_research.MPModelProto.Annotation\x1a\xfd\x01\n\nAnnotation\x12L\n\x0btarget_type\x18\x01 \x01(\x0e\x32\x37.operations_research.MPModelProto.Annotation.TargetType\x12\x14\n\x0ctarget_index\x18\x02 \x01(\x05\x12\x13\n\x0btarget_name\x18\x03 \x01(\t\x12\x13\n\x0bpayload_key\x18\x04 \x01(\t\x12\x15\n\rpayload_value\x18\x05 \x01(\t\"J\n\nTargetType\x12\x14\n\x10VARIABLE_DEFAULT\x10\x00\x12\x0e\n\nCONSTRAINT\x10\x01\x12\x16\n\x12GENERAL_CONSTRAINT\x10\x02\"\x1f\n\x0eOptionalDouble\x12\r\n\x05value\x18\x01 \x01(\x01\"\xbd\x04\n\x18MPSolverCommonParameters\x12=\n\x10relative_mip_gap\x18\x01 \x01(\x0b\x32#.operations_research.OptionalDouble\x12=\n\x10primal_tolerance\x18\x02 \x01(\x0b\x32#.operations_research.OptionalDouble\x12;\n\x0e\x64ual_tolerance\x18\x03 \x01(\x0b\x32#.operations_research.OptionalDouble\x12j\n\x0clp_algorithm\x18\x04 \x01(\x0e\x32?.operations_research.MPSolverCommonParameters.LPAlgorithmValues:\x13LP_ALGO_UNSPECIFIED\x12H\n\x08presolve\x18\x05 \x01(\x0e\x32$.operations_research.OptionalBoolean:\x10\x42OOL_UNSPECIFIED\x12G\n\x07scaling\x18\x07 \x01(\x0e\x32$.operations_research.OptionalBoolean:\x10\x42OOL_UNSPECIFIED\"g\n\x11LPAlgorithmValues\x12\x17\n\x13LP_ALGO_UNSPECIFIED\x10\x00\x12\x10\n\x0cLP_ALGO_DUAL\x10\x01\x12\x12\n\x0eLP_ALGO_PRIMAL\x10\x02\x12\x13\n\x0fLP_ALGO_BARRIER\x10\x03\"\xb3\x03\n\x11MPModelDeltaProto\x12 \n\x18\x62\x61seline_model_file_path\x18\x01 \x01(\t\x12Y\n\x12variable_overrides\x18\x02 \x03(\x0b\x32=.operations_research.MPModelDeltaProto.VariableOverridesEntry\x12]\n\x14\x63onstraint_overrides\x18\x03 \x03(\x0b\x32?.operations_research.MPModelDeltaProto.ConstraintOverridesEntry\x1a^\n\x16VariableOverridesEntry\x12\x0b\n\x03key\x18\x01 \x01(\x05\x12\x33\n\x05value\x18\x02 \x01(\x0b\x32$.operations_research.MPVariableProto:\x02\x38\x01\x1a\x62\n\x18\x43onstraintOverridesEntry\x12\x0b\n\x03key\x18\x01 \x01(\x05\x12\x35\n\x05value\x18\x02 \x01(\x0b\x32&.operations_research.MPConstraintProto:\x02\x38\x01\"\x9b\x08\n\x0eMPModelRequest\x12\x30\n\x05model\x18\x01 \x01(\x0b\x32!.operations_research.MPModelProto\x12\\\n\x0bsolver_type\x18\x02 \x01(\x0e\x32..operations_research.MPModelRequest.SolverType:\x17GLOP_LINEAR_PROGRAMMING\x12!\n\x19solver_time_limit_seconds\x18\x03 \x01(\x01\x12,\n\x1d\x65nable_internal_solver_output\x18\x04 \x01(\x08:\x05\x66\x61lse\x12\"\n\x1asolver_specific_parameters\x18\x05 \x01(\t\x12\x38\n)ignore_solver_specific_parameters_failure\x18\t \x01(\x08:\x05\x66\x61lse\x12;\n\x0bmodel_delta\x18\x08 \x01(\x0b\x32&.operations_research.MPModelDeltaProto\x12.\n#populate_additional_solutions_up_to\x18\x0b \x01(\x05:\x01\x30\"\xdc\x04\n\nSolverType\x12\x1a\n\x16\x43LP_LINEAR_PROGRAMMING\x10\x00\x12\x1b\n\x17GLOP_LINEAR_PROGRAMMING\x10\x02\x12\x1b\n\x17GLPK_LINEAR_PROGRAMMING\x10\x01\x12\x1d\n\x19GUROBI_LINEAR_PROGRAMMING\x10\x06\x12\x1d\n\x19XPRESS_LINEAR_PROGRAMMING\x10\x65\x12\x1c\n\x18\x43PLEX_LINEAR_PROGRAMMING\x10\n\x12\x1c\n\x18HIGHS_LINEAR_PROGRAMMING\x10\x0f\x12\"\n\x1eSCIP_MIXED_INTEGER_PROGRAMMING\x10\x03\x12\"\n\x1eGLPK_MIXED_INTEGER_PROGRAMMING\x10\x04\x12!\n\x1d\x43\x42\x43_MIXED_INTEGER_PROGRAMMING\x10\x05\x12$\n GUROBI_MIXED_INTEGER_PROGRAMMING\x10\x07\x12$\n XPRESS_MIXED_INTEGER_PROGRAMMING\x10\x66\x12#\n\x1f\x43PLEX_MIXED_INTEGER_PROGRAMMING\x10\x0b\x12#\n\x1fHIGHS_MIXED_INTEGER_PROGRAMMING\x10\x10\x12\x1b\n\x17\x42OP_INTEGER_PROGRAMMING\x10\x0c\x12\x1b\n\x17SAT_INTEGER_PROGRAMMING\x10\x0e\x12\x1b\n\x17PDLP_LINEAR_PROGRAMMING\x10\x08\x12&\n\"KNAPSACK_MIXED_INTEGER_PROGRAMMING\x10\r\"A\n\nMPSolution\x12\x17\n\x0fobjective_value\x18\x01 \x01(\x01\x12\x1a\n\x0evariable_value\x18\x02 \x03(\x01\x42\x02\x10\x01\"O\n\x0bMPSolveInfo\x12\x1f\n\x17solve_wall_time_seconds\x18\x01 \x01(\x01\x12\x1f\n\x17solve_user_time_seconds\x18\x02 \x01(\x01\"\x96\x03\n\x12MPSolutionResponse\x12T\n\x06status\x18\x01 \x01(\x0e\x32+.operations_research.MPSolverResponseStatus:\x17MPSOLVER_UNKNOWN_STATUS\x12\x12\n\nstatus_str\x18\x07 \x01(\t\x12\x17\n\x0fobjective_value\x18\x02 \x01(\x01\x12\x1c\n\x14\x62\x65st_objective_bound\x18\x05 \x01(\x01\x12\x1a\n\x0evariable_value\x18\x03 \x03(\x01\x42\x02\x10\x01\x12\x34\n\nsolve_info\x18\n \x01(\x0b\x32 .operations_research.MPSolveInfo\x12\x1c\n\x14solver_specific_info\x18\x0b \x01(\x0c\x12\x16\n\ndual_value\x18\x04 \x03(\x01\x42\x02\x10\x01\x12\x18\n\x0creduced_cost\x18\x06 \x03(\x01\x42\x02\x10\x01\x12=\n\x14\x61\x64\x64itional_solutions\x18\x08 \x03(\x0b\x32\x1f.operations_research.MPSolution*\xbd\x03\n\x16MPSolverResponseStatus\x12\x14\n\x10MPSOLVER_OPTIMAL\x10\x00\x12\x15\n\x11MPSOLVER_FEASIBLE\x10\x01\x12\x17\n\x13MPSOLVER_INFEASIBLE\x10\x02\x12\x16\n\x12MPSOLVER_UNBOUNDED\x10\x03\x12\x15\n\x11MPSOLVER_ABNORMAL\x10\x04\x12\x17\n\x13MPSOLVER_NOT_SOLVED\x10\x06\x12\x1b\n\x17MPSOLVER_MODEL_IS_VALID\x10\x61\x12\x1e\n\x1aMPSOLVER_CANCELLED_BY_USER\x10\x62\x12\x1b\n\x17MPSOLVER_UNKNOWN_STATUS\x10\x63\x12\x1a\n\x16MPSOLVER_MODEL_INVALID\x10\x05\x12(\n$MPSOLVER_MODEL_INVALID_SOLUTION_HINT\x10T\x12,\n(MPSOLVER_MODEL_INVALID_SOLVER_PARAMETERS\x10U\x12$\n MPSOLVER_SOLVER_TYPE_UNAVAILABLE\x10\x07\x12!\n\x1dMPSOLVER_INCOMPATIBLE_OPTIONS\x10qB#\n\x1f\x63om.google.ortools.linearsolverP\x01')
 19
 20_globals = globals()
 21_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 22_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'ortools.linear_solver.linear_solver_pb2', _globals)
 23if _descriptor._USE_C_DESCRIPTORS == False:
 24  _globals['DESCRIPTOR']._options = None
 25  _globals['DESCRIPTOR']._serialized_options = b'\n\037com.google.ortools.linearsolverP\001'
 26  _globals['_MPCONSTRAINTPROTO'].fields_by_name['var_index']._options = None
 27  _globals['_MPCONSTRAINTPROTO'].fields_by_name['var_index']._serialized_options = b'\020\001'
 28  _globals['_MPCONSTRAINTPROTO'].fields_by_name['coefficient']._options = None
 29  _globals['_MPCONSTRAINTPROTO'].fields_by_name['coefficient']._serialized_options = b'\020\001'
 30  _globals['_PARTIALVARIABLEASSIGNMENT'].fields_by_name['var_index']._options = None
 31  _globals['_PARTIALVARIABLEASSIGNMENT'].fields_by_name['var_index']._serialized_options = b'\020\001'
 32  _globals['_PARTIALVARIABLEASSIGNMENT'].fields_by_name['var_value']._options = None
 33  _globals['_PARTIALVARIABLEASSIGNMENT'].fields_by_name['var_value']._serialized_options = b'\020\001'
 34  _globals['_MPMODELDELTAPROTO_VARIABLEOVERRIDESENTRY']._options = None
 35  _globals['_MPMODELDELTAPROTO_VARIABLEOVERRIDESENTRY']._serialized_options = b'8\001'
 36  _globals['_MPMODELDELTAPROTO_CONSTRAINTOVERRIDESENTRY']._options = None
 37  _globals['_MPMODELDELTAPROTO_CONSTRAINTOVERRIDESENTRY']._serialized_options = b'8\001'
 38  _globals['_MPSOLUTION'].fields_by_name['variable_value']._options = None
 39  _globals['_MPSOLUTION'].fields_by_name['variable_value']._serialized_options = b'\020\001'
 40  _globals['_MPSOLUTIONRESPONSE'].fields_by_name['variable_value']._options = None
 41  _globals['_MPSOLUTIONRESPONSE'].fields_by_name['variable_value']._serialized_options = b'\020\001'
 42  _globals['_MPSOLUTIONRESPONSE'].fields_by_name['dual_value']._options = None
 43  _globals['_MPSOLUTIONRESPONSE'].fields_by_name['dual_value']._serialized_options = b'\020\001'
 44  _globals['_MPSOLUTIONRESPONSE'].fields_by_name['reduced_cost']._options = None
 45  _globals['_MPSOLUTIONRESPONSE'].fields_by_name['reduced_cost']._serialized_options = b'\020\001'
 46  _globals['_MPSOLVERRESPONSESTATUS']._serialized_start=5348
 47  _globals['_MPSOLVERRESPONSESTATUS']._serialized_end=5793
 48  _globals['_MPVARIABLEPROTO']._serialized_start=104
 49  _globals['_MPVARIABLEPROTO']._serialized_end=282
 50  _globals['_MPCONSTRAINTPROTO']._serialized_start=285
 51  _globals['_MPCONSTRAINTPROTO']._serialized_end=445
 52  _globals['_MPGENERALCONSTRAINTPROTO']._serialized_start=448
 53  _globals['_MPGENERALCONSTRAINTPROTO']._serialized_end=1079
 54  _globals['_MPINDICATORCONSTRAINT']._serialized_start=1081
 55  _globals['_MPINDICATORCONSTRAINT']._serialized_end=1202
 56  _globals['_MPSOSCONSTRAINT']._serialized_start=1205
 57  _globals['_MPSOSCONSTRAINT']._serialized_end=1364
 58  _globals['_MPSOSCONSTRAINT_TYPE']._serialized_start=1330
 59  _globals['_MPSOSCONSTRAINT_TYPE']._serialized_end=1364
 60  _globals['_MPQUADRATICCONSTRAINT']._serialized_start=1367
 61  _globals['_MPQUADRATICCONSTRAINT']._serialized_end=1547
 62  _globals['_MPABSCONSTRAINT']._serialized_start=1549
 63  _globals['_MPABSCONSTRAINT']._serialized_end=1614
 64  _globals['_MPARRAYCONSTRAINT']._serialized_start=1616
 65  _globals['_MPARRAYCONSTRAINT']._serialized_end=1683
 66  _globals['_MPARRAYWITHCONSTANTCONSTRAINT']._serialized_start=1685
 67  _globals['_MPARRAYWITHCONSTANTCONSTRAINT']._serialized_end=1782
 68  _globals['_MPQUADRATICOBJECTIVE']._serialized_start=1784
 69  _globals['_MPQUADRATICOBJECTIVE']._serialized_end=1869
 70  _globals['_PARTIALVARIABLEASSIGNMENT']._serialized_start=1871
 71  _globals['_PARTIALVARIABLEASSIGNMENT']._serialized_end=1944
 72  _globals['_MPMODELPROTO']._serialized_start=1947
 73  _globals['_MPMODELPROTO']._serialized_end=2687
 74  _globals['_MPMODELPROTO_ANNOTATION']._serialized_start=2434
 75  _globals['_MPMODELPROTO_ANNOTATION']._serialized_end=2687
 76  _globals['_MPMODELPROTO_ANNOTATION_TARGETTYPE']._serialized_start=2613
 77  _globals['_MPMODELPROTO_ANNOTATION_TARGETTYPE']._serialized_end=2687
 78  _globals['_OPTIONALDOUBLE']._serialized_start=2689
 79  _globals['_OPTIONALDOUBLE']._serialized_end=2720
 80  _globals['_MPSOLVERCOMMONPARAMETERS']._serialized_start=2723
 81  _globals['_MPSOLVERCOMMONPARAMETERS']._serialized_end=3296
 82  _globals['_MPSOLVERCOMMONPARAMETERS_LPALGORITHMVALUES']._serialized_start=3193
 83  _globals['_MPSOLVERCOMMONPARAMETERS_LPALGORITHMVALUES']._serialized_end=3296
 84  _globals['_MPMODELDELTAPROTO']._serialized_start=3299
 85  _globals['_MPMODELDELTAPROTO']._serialized_end=3734
 86  _globals['_MPMODELDELTAPROTO_VARIABLEOVERRIDESENTRY']._serialized_start=3540
 87  _globals['_MPMODELDELTAPROTO_VARIABLEOVERRIDESENTRY']._serialized_end=3634
 88  _globals['_MPMODELDELTAPROTO_CONSTRAINTOVERRIDESENTRY']._serialized_start=3636
 89  _globals['_MPMODELDELTAPROTO_CONSTRAINTOVERRIDESENTRY']._serialized_end=3734
 90  _globals['_MPMODELREQUEST']._serialized_start=3737
 91  _globals['_MPMODELREQUEST']._serialized_end=4788
 92  _globals['_MPMODELREQUEST_SOLVERTYPE']._serialized_start=4184
 93  _globals['_MPMODELREQUEST_SOLVERTYPE']._serialized_end=4788
 94  _globals['_MPSOLUTION']._serialized_start=4790
 95  _globals['_MPSOLUTION']._serialized_end=4855
 96  _globals['_MPSOLVEINFO']._serialized_start=4857
 97  _globals['_MPSOLVEINFO']._serialized_end=4936
 98  _globals['_MPSOLUTIONRESPONSE']._serialized_start=4939
 99  _globals['_MPSOLUTIONRESPONSE']._serialized_end=5345
100# @@protoc_insertion_point(module_scope)
DESCRIPTOR = <google.protobuf.descriptor.FileDescriptor object>
class MPVariableProto(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPVariableProto(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
LOWER_BOUND_FIELD_NUMBER = 1
lower_bound
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for lower_bound.

UPPER_BOUND_FIELD_NUMBER = 2
upper_bound
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for upper_bound.

OBJECTIVE_COEFFICIENT_FIELD_NUMBER = 3
objective_coefficient
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for objective_coefficient.

IS_INTEGER_FIELD_NUMBER = 4
is_integer
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for is_integer.

NAME_FIELD_NUMBER = 5
name
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for name.

BRANCHING_PRIORITY_FIELD_NUMBER = 6
branching_priority
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for branching_priority.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPConstraintProto(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPConstraintProto(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VAR_INDEX_FIELD_NUMBER = 6
var_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for var_index.

COEFFICIENT_FIELD_NUMBER = 7
coefficient
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for coefficient.

LOWER_BOUND_FIELD_NUMBER = 2
lower_bound
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for lower_bound.

UPPER_BOUND_FIELD_NUMBER = 3
upper_bound
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for upper_bound.

NAME_FIELD_NUMBER = 4
name
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for name.

IS_LAZY_FIELD_NUMBER = 5
is_lazy
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for is_lazy.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPGeneralConstraintProto(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPGeneralConstraintProto(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
NAME_FIELD_NUMBER = 1
name
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for name.

INDICATOR_CONSTRAINT_FIELD_NUMBER = 2
indicator_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for indicator_constraint.

SOS_CONSTRAINT_FIELD_NUMBER = 3
sos_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for sos_constraint.

QUADRATIC_CONSTRAINT_FIELD_NUMBER = 4
quadratic_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for quadratic_constraint.

ABS_CONSTRAINT_FIELD_NUMBER = 5
abs_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for abs_constraint.

AND_CONSTRAINT_FIELD_NUMBER = 6
and_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for and_constraint.

OR_CONSTRAINT_FIELD_NUMBER = 7
or_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for or_constraint.

MIN_CONSTRAINT_FIELD_NUMBER = 8
min_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for min_constraint.

MAX_CONSTRAINT_FIELD_NUMBER = 9
max_constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for max_constraint.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPIndicatorConstraint(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPIndicatorConstraint(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VAR_INDEX_FIELD_NUMBER = 1
var_index
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for var_index.

VAR_VALUE_FIELD_NUMBER = 2
var_value
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for var_value.

CONSTRAINT_FIELD_NUMBER = 3
constraint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for constraint.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPSosConstraint(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPSosConstraint(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
Type = <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object>
SOS1_DEFAULT = 0
SOS2 = 1
TYPE_FIELD_NUMBER = 1
type
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for type.

VAR_INDEX_FIELD_NUMBER = 2
var_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for var_index.

WEIGHT_FIELD_NUMBER = 3
weight
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for weight.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPQuadraticConstraint(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPQuadraticConstraint(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VAR_INDEX_FIELD_NUMBER = 1
var_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for var_index.

COEFFICIENT_FIELD_NUMBER = 2
coefficient
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for coefficient.

QVAR1_INDEX_FIELD_NUMBER = 3
qvar1_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for qvar1_index.

QVAR2_INDEX_FIELD_NUMBER = 4
qvar2_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for qvar2_index.

QCOEFFICIENT_FIELD_NUMBER = 5
qcoefficient
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for qcoefficient.

LOWER_BOUND_FIELD_NUMBER = 6
lower_bound
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for lower_bound.

UPPER_BOUND_FIELD_NUMBER = 7
upper_bound
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for upper_bound.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPAbsConstraint(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPAbsConstraint(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VAR_INDEX_FIELD_NUMBER = 1
var_index
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for var_index.

RESULTANT_VAR_INDEX_FIELD_NUMBER = 2
resultant_var_index
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for resultant_var_index.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPArrayConstraint(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPArrayConstraint(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VAR_INDEX_FIELD_NUMBER = 1
var_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for var_index.

RESULTANT_VAR_INDEX_FIELD_NUMBER = 2
resultant_var_index
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for resultant_var_index.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPArrayWithConstantConstraint(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPArrayWithConstantConstraint(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VAR_INDEX_FIELD_NUMBER = 1
var_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for var_index.

CONSTANT_FIELD_NUMBER = 2
constant
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for constant.

RESULTANT_VAR_INDEX_FIELD_NUMBER = 3
resultant_var_index
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for resultant_var_index.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPQuadraticObjective(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPQuadraticObjective(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
QVAR1_INDEX_FIELD_NUMBER = 1
qvar1_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for qvar1_index.

QVAR2_INDEX_FIELD_NUMBER = 2
qvar2_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for qvar2_index.

COEFFICIENT_FIELD_NUMBER = 3
coefficient
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for coefficient.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class PartialVariableAssignment(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

PartialVariableAssignment(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VAR_INDEX_FIELD_NUMBER = 1
var_index
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for var_index.

VAR_VALUE_FIELD_NUMBER = 2
var_value
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for var_value.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPModelProto(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPModelProto(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VARIABLE_FIELD_NUMBER = 3
variable
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for variable.

CONSTRAINT_FIELD_NUMBER = 4
constraint
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for constraint.

GENERAL_CONSTRAINT_FIELD_NUMBER = 7
general_constraint
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for general_constraint.

MAXIMIZE_FIELD_NUMBER = 1
maximize
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for maximize.

OBJECTIVE_OFFSET_FIELD_NUMBER = 2
objective_offset
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for objective_offset.

QUADRATIC_OBJECTIVE_FIELD_NUMBER = 8
quadratic_objective
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for quadratic_objective.

NAME_FIELD_NUMBER = 5
name
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for name.

SOLUTION_HINT_FIELD_NUMBER = 6
solution_hint
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for solution_hint.

ANNOTATION_FIELD_NUMBER = 9
annotation
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for annotation.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPModelProto.Annotation(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class OptionalDouble(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

OptionalDouble(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
VALUE_FIELD_NUMBER = 1
value
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for value.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPSolverCommonParameters(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPSolverCommonParameters(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
LPAlgorithmValues = <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object>
LP_ALGO_UNSPECIFIED = 0
LP_ALGO_DUAL = 1
LP_ALGO_PRIMAL = 2
LP_ALGO_BARRIER = 3
RELATIVE_MIP_GAP_FIELD_NUMBER = 1
relative_mip_gap
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for relative_mip_gap.

PRIMAL_TOLERANCE_FIELD_NUMBER = 2
primal_tolerance
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for primal_tolerance.

DUAL_TOLERANCE_FIELD_NUMBER = 3
dual_tolerance
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for dual_tolerance.

LP_ALGORITHM_FIELD_NUMBER = 4
lp_algorithm
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for lp_algorithm.

PRESOLVE_FIELD_NUMBER = 5
presolve
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for presolve.

SCALING_FIELD_NUMBER = 7
scaling
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for scaling.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPModelDeltaProto(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPModelDeltaProto(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
BASELINE_MODEL_FILE_PATH_FIELD_NUMBER = 1
baseline_model_file_path
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for baseline_model_file_path.

VARIABLE_OVERRIDES_FIELD_NUMBER = 2
variable_overrides
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for variable_overrides.

CONSTRAINT_OVERRIDES_FIELD_NUMBER = 3
constraint_overrides
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for constraint_overrides.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPModelDeltaProto.VariableOverridesEntry(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class MPModelDeltaProto.ConstraintOverridesEntry(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class MPModelRequest(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPModelRequest(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
SolverType = <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object>
CLP_LINEAR_PROGRAMMING = 0
GLOP_LINEAR_PROGRAMMING = 2
GLPK_LINEAR_PROGRAMMING = 1
GUROBI_LINEAR_PROGRAMMING = 6
XPRESS_LINEAR_PROGRAMMING = 101
CPLEX_LINEAR_PROGRAMMING = 10
HIGHS_LINEAR_PROGRAMMING = 15
SCIP_MIXED_INTEGER_PROGRAMMING = 3
GLPK_MIXED_INTEGER_PROGRAMMING = 4
CBC_MIXED_INTEGER_PROGRAMMING = 5
GUROBI_MIXED_INTEGER_PROGRAMMING = 7
XPRESS_MIXED_INTEGER_PROGRAMMING = 102
CPLEX_MIXED_INTEGER_PROGRAMMING = 11
HIGHS_MIXED_INTEGER_PROGRAMMING = 16
BOP_INTEGER_PROGRAMMING = 12
SAT_INTEGER_PROGRAMMING = 14
PDLP_LINEAR_PROGRAMMING = 8
KNAPSACK_MIXED_INTEGER_PROGRAMMING = 13
MODEL_FIELD_NUMBER = 1
model
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for model.

SOLVER_TYPE_FIELD_NUMBER = 2
solver_type
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for solver_type.

SOLVER_TIME_LIMIT_SECONDS_FIELD_NUMBER = 3
solver_time_limit_seconds
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for solver_time_limit_seconds.

ENABLE_INTERNAL_SOLVER_OUTPUT_FIELD_NUMBER = 4
enable_internal_solver_output
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for enable_internal_solver_output.

SOLVER_SPECIFIC_PARAMETERS_FIELD_NUMBER = 5
solver_specific_parameters
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for solver_specific_parameters.

IGNORE_SOLVER_SPECIFIC_PARAMETERS_FAILURE_FIELD_NUMBER = 9
ignore_solver_specific_parameters_failure
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for ignore_solver_specific_parameters_failure.

MODEL_DELTA_FIELD_NUMBER = 8
model_delta
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for model_delta.

POPULATE_ADDITIONAL_SOLUTIONS_UP_TO_FIELD_NUMBER = 11
populate_additional_solutions_up_to
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for populate_additional_solutions_up_to.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPSolution(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPSolution(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
OBJECTIVE_VALUE_FIELD_NUMBER = 1
objective_value
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for objective_value.

VARIABLE_VALUE_FIELD_NUMBER = 2
variable_value
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for variable_value.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPSolveInfo(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPSolveInfo(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
SOLVE_WALL_TIME_SECONDS_FIELD_NUMBER = 1
solve_wall_time_seconds
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for solve_wall_time_seconds.

SOLVE_USER_TIME_SECONDS_FIELD_NUMBER = 2
solve_user_time_seconds
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for solve_user_time_seconds.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension
class MPSolutionResponse(google.protobuf.message.Message):

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

MPSolutionResponse(**kwargs)
496  def init(self, **kwargs):
497    self._cached_byte_size = 0
498    self._cached_byte_size_dirty = len(kwargs) > 0
499    self._fields = {}
500    # Contains a mapping from oneof field descriptors to the descriptor
501    # of the currently set field in that oneof field.
502    self._oneofs = {}
503
504    # _unknown_fields is () when empty for efficiency, and will be turned into
505    # a list if fields are added.
506    self._unknown_fields = ()
507    # _unknown_field_set is None when empty for efficiency, and will be
508    # turned into UnknownFieldSet struct if fields are added.
509    self._unknown_field_set = None      # pylint: disable=protected-access
510    self._is_present_in_parent = False
511    self._listener = message_listener_mod.NullMessageListener()
512    self._listener_for_children = _Listener(self)
513    for field_name, field_value in kwargs.items():
514      field = _GetFieldByName(message_descriptor, field_name)
515      if field is None:
516        raise TypeError('%s() got an unexpected keyword argument "%s"' %
517                        (message_descriptor.name, field_name))
518      if field_value is None:
519        # field=None is the same as no field at all.
520        continue
521      if field.label == _FieldDescriptor.LABEL_REPEATED:
522        copy = field._default_constructor(self)
523        if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:  # Composite
524          if _IsMapField(field):
525            if _IsMessageMapField(field):
526              for key in field_value:
527                copy[key].MergeFrom(field_value[key])
528            else:
529              copy.update(field_value)
530          else:
531            for val in field_value:
532              if isinstance(val, dict):
533                copy.add(**val)
534              else:
535                copy.add().MergeFrom(val)
536        else:  # Scalar
537          if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
538            field_value = [_GetIntegerEnumValue(field.enum_type, val)
539                           for val in field_value]
540          copy.extend(field_value)
541        self._fields[field] = copy
542      elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
543        copy = field._default_constructor(self)
544        new_val = field_value
545        if isinstance(field_value, dict):
546          new_val = field.message_type._concrete_class(**field_value)
547        try:
548          copy.MergeFrom(new_val)
549        except TypeError:
550          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
551        self._fields[field] = copy
552      else:
553        if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM:
554          field_value = _GetIntegerEnumValue(field.enum_type, field_value)
555        try:
556          setattr(self, field_name, field_value)
557        except TypeError:
558          _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
DESCRIPTOR = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, msg):
1312  def MergeFrom(self, msg):
1313    if not isinstance(msg, cls):
1314      raise TypeError(
1315          'Parameter to MergeFrom() must be instance of same class: '
1316          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1317                                   _FullyQualifiedClassName(msg.__class__)))
1318
1319    assert msg is not self
1320    self._Modified()
1321
1322    fields = self._fields
1323
1324    for field, value in msg._fields.items():
1325      if field.label == LABEL_REPEATED:
1326        field_value = fields.get(field)
1327        if field_value is None:
1328          # Construct a new object to represent this field.
1329          field_value = field._default_constructor(self)
1330          fields[field] = field_value
1331        field_value.MergeFrom(value)
1332      elif field.cpp_type == CPPTYPE_MESSAGE:
1333        if value._is_present_in_parent:
1334          field_value = fields.get(field)
1335          if field_value is None:
1336            # Construct a new object to represent this field.
1337            field_value = field._default_constructor(self)
1338            fields[field] = field_value
1339          field_value.MergeFrom(value)
1340      else:
1341        self._fields[field] = value
1342        if field.containing_oneof:
1343          self._UpdateOneofState(field)
1344
1345    if msg._unknown_fields:
1346      if not self._unknown_fields:
1347        self._unknown_fields = []
1348      self._unknown_fields.extend(msg._unknown_fields)
1349      # pylint: disable=protected-access
1350      if self._unknown_field_set is None:
1351        self._unknown_field_set = containers.UnknownFieldSet()
1352      self._unknown_field_set._extend(msg._unknown_field_set)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Singular sub-messages and groups are recursively merged.

Arguments:
  • other_msg (Message): A message to merge into the current message.
def Clear(self):
1375def _Clear(self):
1376  # Clear fields.
1377  self._fields = {}
1378  self._unknown_fields = ()
1379  # pylint: disable=protected-access
1380  if self._unknown_field_set is not None:
1381    self._unknown_field_set._clear()
1382    self._unknown_field_set = None
1383
1384  self._oneofs = {}
1385  self._Modified()

Clears all data that was set in the message.

def SetInParent(self):
1452  def Modified(self):
1453    """Sets the _cached_byte_size_dirty bit to true,
1454    and propagates this to our listener iff this was a state change.
1455    """
1456
1457    # Note:  Some callers check _cached_byte_size_dirty before calling
1458    #   _Modified() as an extra optimization.  So, if this method is ever
1459    #   changed such that it does stuff even when _cached_byte_size_dirty is
1460    #   already true, the callers need to be updated.
1461    if not self._cached_byte_size_dirty:
1462      self._cached_byte_size_dirty = True
1463      self._listener_for_children.dirty = True
1464      self._is_present_in_parent = True
1465      self._listener.Modified()

Sets the _cached_byte_size_dirty bit to true, and propagates this to our listener iff this was a state change.

def IsInitialized(self, errors=None):
1213  def IsInitialized(self, errors=None):
1214    """Checks if all required fields of a message are set.
1215
1216    Args:
1217      errors:  A list which, if provided, will be populated with the field
1218               paths of all missing required fields.
1219
1220    Returns:
1221      True iff the specified message has all required fields set.
1222    """
1223
1224    # Performance is critical so we avoid HasField() and ListFields().
1225
1226    for field in required_fields:
1227      if (field not in self._fields or
1228          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1229           not self._fields[field]._is_present_in_parent)):
1230        if errors is not None:
1231          errors.extend(self.FindInitializationErrors())
1232        return False
1233
1234    for field, value in list(self._fields.items()):  # dict can change size!
1235      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1236        if field.label == _FieldDescriptor.LABEL_REPEATED:
1237          if (field.message_type._is_map_entry):
1238            continue
1239          for element in value:
1240            if not element.IsInitialized():
1241              if errors is not None:
1242                errors.extend(self.FindInitializationErrors())
1243              return False
1244        elif value._is_present_in_parent and not value.IsInitialized():
1245          if errors is not None:
1246            errors.extend(self.FindInitializationErrors())
1247          return False
1248
1249    return True

Checks if all required fields of a message are set.

Arguments:
  • errors: A list which, if provided, will be populated with the field paths of all missing required fields.
Returns:

True iff the specified message has all required fields set.

def MergeFromString(self, serialized):
1119  def MergeFromString(self, serialized):
1120    serialized = memoryview(serialized)
1121    length = len(serialized)
1122    try:
1123      if self._InternalParse(serialized, 0, length) != length:
1124        # The only reason _InternalParse would return early is if it
1125        # encountered an end-group tag.
1126        raise message_mod.DecodeError('Unexpected end-group tag.')
1127    except (IndexError, TypeError):
1128      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1129      raise message_mod.DecodeError('Truncated message.')
1130    except struct.error as e:
1131      raise message_mod.DecodeError(e)
1132    return length   # Return this for legacy reasons.

Merges serialized protocol buffer data into this message.

When we find a field in serialized that is already present in this message:

  • If it's a "repeated" field, we append to the end of our list.
  • Else, if it's a scalar, we overwrite our field.
  • Else, (it's a nonrepeated composite), we recursively merge into the existing composite.
Arguments:
  • serialized (bytes): Any object that allows us to call memoryview(serialized) to access a string of bytes using the buffer interface.
Returns:

int: The number of bytes read from serialized. For non-group messages, this will always be len(serialized), but for messages which are actually groups, this will generally be less than len(serialized), since we must stop when we reach an END_GROUP tag. Note that if we do stop because of an END_GROUP tag, the number of bytes returned does not include the bytes for the END_GROUP tag information.

Raises:
  • DecodeError: if the input cannot be parsed.
def SerializeToString(self, **kwargs):
1072  def SerializeToString(self, **kwargs):
1073    # Check if the message has all of its required fields set.
1074    if not self.IsInitialized():
1075      raise message_mod.EncodeError(
1076          'Message %s is missing required fields: %s' % (
1077          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1078    return self.SerializePartialToString(**kwargs)

Serializes the protocol message to a binary string.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

A binary string representation of the message if all of the required fields in the message are set (i.e. the message is initialized).

Raises:
def SerializePartialToString(self, **kwargs):
1085  def SerializePartialToString(self, **kwargs):
1086    out = BytesIO()
1087    self._InternalSerialize(out.write, **kwargs)
1088    return out.getvalue()

Serializes the protocol message to a binary string.

This method is similar to SerializeToString but doesn't check if the message is initialized.

Keyword Args:

deterministic (bool): If true, requests deterministic serialization of the protobuf, with predictable ordering of map keys.

Returns:

bytes: A serialized representation of the partial message.

def ListFields(self):
814  def ListFields(self):
815    all_fields = [item for item in self._fields.items() if _IsPresent(item)]
816    all_fields.sort(key = lambda item: item[0].number)
817    return all_fields

Returns a list of (FieldDescriptor, value) tuples for present fields.

A message field is non-empty if HasField() would return true. A singular primitive field is non-empty if HasField() would return true in proto2 or it is non zero in proto3. A repeated field is non-empty if it contains at least one element. The fields are ordered by field number.

Returns:

list[tuple(FieldDescriptor, value)]: field descriptors and values for all fields in the message which are not empty. The values vary by field type.

def HasField(self, field_name):
838  def HasField(self, field_name):
839    try:
840      field = hassable_fields[field_name]
841    except KeyError as exc:
842      raise ValueError('Protocol message %s has no non-repeated field "%s" '
843                       'nor has presence is not available for this field.' % (
844                           message_descriptor.full_name, field_name)) from exc
845
846    if isinstance(field, descriptor_mod.OneofDescriptor):
847      try:
848        return HasField(self, self._oneofs[field].name)
849      except KeyError:
850        return False
851    else:
852      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
853        value = self._fields.get(field)
854        return value is not None and value._is_present_in_parent
855      else:
856        return field in self._fields

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Returns:

bool: Whether a value has been set for the named field.

Raises:
  • ValueError: if the field_name is not a member of this message.
def ClearField(self, field_name):
863  def ClearField(self, field_name):
864    try:
865      field = message_descriptor.fields_by_name[field_name]
866    except KeyError:
867      try:
868        field = message_descriptor.oneofs_by_name[field_name]
869        if field in self._oneofs:
870          field = self._oneofs[field]
871        else:
872          return
873      except KeyError:
874        raise ValueError('Protocol message %s has no "%s" field.' %
875                         (message_descriptor.name, field_name))
876
877    if field in self._fields:
878      # To match the C++ implementation, we need to invalidate iterators
879      # for map fields when ClearField() happens.
880      if hasattr(self._fields[field], 'InvalidateIterators'):
881        self._fields[field].InvalidateIterators()
882
883      # Note:  If the field is a sub-message, its listener will still point
884      #   at us.  That's fine, because the worst than can happen is that it
885      #   will call _Modified() and invalidate our byte size.  Big deal.
886      del self._fields[field]
887
888      if self._oneofs.get(field.containing_oneof, None) is field:
889        del self._oneofs[field.containing_oneof]
890
891    # Always call _Modified() -- even if nothing was changed, this is
892    # a mutating method, and thus calling it should cause the field to become
893    # present in the parent message.
894    self._Modified()

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Arguments:
  • field_name (str): The name of the field to check for presence.
Raises:
  • ValueError: if the field_name is not a member of this message.
def WhichOneof(self, oneof_name):
1358  def WhichOneof(self, oneof_name):
1359    """Returns the name of the currently set field inside a oneof, or None."""
1360    try:
1361      field = message_descriptor.oneofs_by_name[oneof_name]
1362    except KeyError:
1363      raise ValueError(
1364          'Protocol message has no oneof "%s" field.' % oneof_name)
1365
1366    nested_field = self._oneofs.get(field, None)
1367    if nested_field is not None and self.HasField(nested_field.name):
1368      return nested_field.name
1369    else:
1370      return None

Returns the name of the currently set field inside a oneof, or None.

def UnknownFields(self):
1388def _UnknownFields(self):
1389  warnings.warn(
1390      'message.UnknownFields() is deprecated. Please use the add one '
1391      'feature unknown_fields.UnknownFieldSet(message) in '
1392      'unknown_fields.py instead.'
1393  )
1394  if self._unknown_field_set is None:  # pylint: disable=protected-access
1395    # pylint: disable=protected-access
1396    self._unknown_field_set = containers.UnknownFieldSet()
1397  return self._unknown_field_set    # pylint: disable=protected-access

Returns the UnknownFieldSet.

Returns:

UnknownFieldSet: The unknown fields stored in this message.

def DiscardUnknownFields(self):
1400def _DiscardUnknownFields(self):
1401  self._unknown_fields = []
1402  self._unknown_field_set = None      # pylint: disable=protected-access
1403  for field, value in self.ListFields():
1404    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1405      if _IsMapField(field):
1406        if _IsMessageMapField(field):
1407          for key in value:
1408            value[key].DiscardUnknownFields()
1409      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1410        for sub_message in value:
1411          sub_message.DiscardUnknownFields()
1412      else:
1413        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self):
1040  def ByteSize(self):
1041    if not self._cached_byte_size_dirty:
1042      return self._cached_byte_size
1043
1044    size = 0
1045    descriptor = self.DESCRIPTOR
1046    if descriptor._is_map_entry:
1047      # Fields of map entry should always be serialized.
1048      key_field = descriptor.fields_by_name['key']
1049      _MaybeAddEncoder(cls, key_field)
1050      size = key_field._sizer(self.key)
1051      value_field = descriptor.fields_by_name['value']
1052      _MaybeAddEncoder(cls, value_field)
1053      size += value_field._sizer(self.value)
1054    else:
1055      for field_descriptor, field_value in self.ListFields():
1056        _MaybeAddEncoder(cls, field_descriptor)
1057        size += field_descriptor._sizer(field_value)
1058      for tag_bytes, value_bytes in self._unknown_fields:
1059        size += len(tag_bytes) + len(value_bytes)
1060
1061    self._cached_byte_size = size
1062    self._cached_byte_size_dirty = False
1063    self._listener_for_children.dirty = False
1064    return size

Returns the serialized size of this message.

Recursively calls ByteSize() on all contained messages.

Returns:

int: The number of bytes required to serialize this message.

def FromString(s):
792  def FromString(s):
793    message = cls()
794    message.MergeFromString(s)
795    return message
def RegisterExtension(field_descriptor):
784  def RegisterExtension(field_descriptor):
785    field_descriptor.containing_type = cls.DESCRIPTOR
786    # TODO: Use cls.MESSAGE_FACTORY.pool when available.
787    # pylint: disable=protected-access
788    cls.DESCRIPTOR.file.pool._AddExtensionDescriptor(field_descriptor)
789    _AttachFieldHelpers(cls, field_descriptor)
STATUS_FIELD_NUMBER = 1
status
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for status.

STATUS_STR_FIELD_NUMBER = 7
status_str
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for status_str.

OBJECTIVE_VALUE_FIELD_NUMBER = 2
objective_value
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for objective_value.

BEST_OBJECTIVE_BOUND_FIELD_NUMBER = 5
best_objective_bound
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for best_objective_bound.

VARIABLE_VALUE_FIELD_NUMBER = 3
variable_value
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for variable_value.

SOLVE_INFO_FIELD_NUMBER = 10
solve_info
741  def getter(self):
742    field_value = self._fields.get(field)
743    if field_value is None:
744      # Construct a new object to represent this field.
745      field_value = field._default_constructor(self)
746
747      # Atomically check if another thread has preempted us and, if not, swap
748      # in the new object we just created.  If someone has preempted us, we
749      # take that object and discard ours.
750      # WARNING:  We are relying on setdefault() being atomic.  This is true
751      #   in CPython but we haven't investigated others.  This warning appears
752      #   in several other locations in this file.
753      field_value = self._fields.setdefault(field, field_value)
754    return field_value

Getter for solve_info.

SOLVER_SPECIFIC_INFO_FIELD_NUMBER = 11
solver_specific_info
685  def getter(self):
686    # TODO: This may be broken since there may not be
687    # default_value.  Combine with has_default_value somehow.
688    return self._fields.get(field, default_value)

Getter for solver_specific_info.

DUAL_VALUE_FIELD_NUMBER = 4
dual_value
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for dual_value.

REDUCED_COST_FIELD_NUMBER = 6
reduced_cost
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for reduced_cost.

ADDITIONAL_SOLUTIONS_FIELD_NUMBER = 8
additional_solutions
642  def getter(self):
643    field_value = self._fields.get(field)
644    if field_value is None:
645      # Construct a new object to represent this field.
646      field_value = field._default_constructor(self)
647
648      # Atomically check if another thread has preempted us and, if not, swap
649      # in the new object we just created.  If someone has preempted us, we
650      # take that object and discard ours.
651      # WARNING:  We are relying on setdefault() being atomic.  This is true
652      #   in CPython but we haven't investigated others.  This warning appears
653      #   in several other locations in this file.
654      field_value = self._fields.setdefault(field, field_value)
655    return field_value

Getter for additional_solutions.

def FindInitializationErrors(self):
1253  def FindInitializationErrors(self):
1254    """Finds required fields which are not initialized.
1255
1256    Returns:
1257      A list of strings.  Each string is a path to an uninitialized field from
1258      the top-level message, e.g. "foo.bar[5].baz".
1259    """
1260
1261    errors = []  # simplify things
1262
1263    for field in required_fields:
1264      if not self.HasField(field.name):
1265        errors.append(field.name)
1266
1267    for field, value in self.ListFields():
1268      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1269        if field.is_extension:
1270          name = '(%s)' % field.full_name
1271        else:
1272          name = field.name
1273
1274        if _IsMapField(field):
1275          if _IsMessageMapField(field):
1276            for key in value:
1277              element = value[key]
1278              prefix = '%s[%s].' % (name, key)
1279              sub_errors = element.FindInitializationErrors()
1280              errors += [prefix + error for error in sub_errors]
1281          else:
1282            # ScalarMaps can't have any initialization errors.
1283            pass
1284        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1285          for i in range(len(value)):
1286            element = value[i]
1287            prefix = '%s[%d].' % (name, i)
1288            sub_errors = element.FindInitializationErrors()
1289            errors += [prefix + error for error in sub_errors]
1290        else:
1291          prefix = name + '.'
1292          sub_errors = value.FindInitializationErrors()
1293          errors += [prefix + error for error in sub_errors]
1294
1295    return errors

Finds required fields which are not initialized.

Returns:

A list of strings. Each string is a path to an uninitialized field from the top-level message, e.g. "foo.bar[5].baz".

Inherited Members
google.protobuf.message.Message
CopyFrom
ParseFromString
HasExtension
ClearExtension