ortools.math_opt.model_parameters_pb2
@generated by mypy-protobuf. Do not edit manually! isort:skip_file Solve parameters that are specific to the model.
1# -*- coding: utf-8 -*- 2# Generated by the protocol buffer compiler. DO NOT EDIT! 3# source: ortools/math_opt/model_parameters.proto 4# Protobuf Python Version: 5.26.1 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.math_opt import solution_pb2 as ortools_dot_math__opt_dot_solution__pb2 16from ortools.math_opt import sparse_containers_pb2 as ortools_dot_math__opt_dot_sparse__containers__pb2 17 18 19DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\'ortools/math_opt/model_parameters.proto\x12\x1coperations_research.math_opt\x1a\x1fortools/math_opt/solution.proto\x1a(ortools/math_opt/sparse_containers.proto\"\xaf\x01\n\x11SolutionHintProto\x12N\n\x0fvariable_values\x18\x01 \x01(\x0b\x32\x35.operations_research.math_opt.SparseDoubleVectorProto\x12J\n\x0b\x64ual_values\x18\x02 \x01(\x0b\x32\x35.operations_research.math_opt.SparseDoubleVectorProto\"\xe2\x01\n\x18ObjectiveParametersProto\x12\x35\n(objective_degradation_absolute_tolerance\x18\x07 \x01(\x01H\x00\x88\x01\x01\x12\x35\n(objective_degradation_relative_tolerance\x18\x08 \x01(\x01H\x01\x88\x01\x01\x42+\n)_objective_degradation_absolute_toleranceB+\n)_objective_degradation_relative_tolerance\"\xd8\x07\n\x19ModelSolveParametersProto\x12U\n\x16variable_values_filter\x18\x01 \x01(\x0b\x32\x35.operations_research.math_opt.SparseVectorFilterProto\x12Q\n\x12\x64ual_values_filter\x18\x02 \x01(\x0b\x32\x35.operations_research.math_opt.SparseVectorFilterProto\x12[\n\x1cquadratic_dual_values_filter\x18\n \x01(\x0b\x32\x35.operations_research.math_opt.SparseVectorFilterProto\x12S\n\x14reduced_costs_filter\x18\x03 \x01(\x0b\x32\x35.operations_research.math_opt.SparseVectorFilterProto\x12?\n\rinitial_basis\x18\x04 \x01(\x0b\x32(.operations_research.math_opt.BasisProto\x12G\n\x0esolution_hints\x18\x05 \x03(\x0b\x32/.operations_research.math_opt.SolutionHintProto\x12R\n\x14\x62ranching_priorities\x18\x06 \x01(\x0b\x32\x34.operations_research.math_opt.SparseInt32VectorProto\x12\\\n\x1cprimary_objective_parameters\x18\x07 \x01(\x0b\x32\x36.operations_research.math_opt.ObjectiveParametersProto\x12\x81\x01\n\x1e\x61uxiliary_objective_parameters\x18\x08 \x03(\x0b\x32Y.operations_research.math_opt.ModelSolveParametersProto.AuxiliaryObjectiveParametersEntry\x12\"\n\x1alazy_linear_constraint_ids\x18\t \x03(\x03\x1a{\n!AuxiliaryObjectiveParametersEntry\x12\x0b\n\x03key\x18\x01 \x01(\x03\x12\x45\n\x05value\x18\x02 \x01(\x0b\x32\x36.operations_research.math_opt.ObjectiveParametersProto:\x02\x38\x01\x42\x1e\n\x1a\x63om.google.ortools.mathoptP\x01\x62\x06proto3') 20 21_globals = globals() 22_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals) 23_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'ortools.math_opt.model_parameters_pb2', _globals) 24if not _descriptor._USE_C_DESCRIPTORS: 25 _globals['DESCRIPTOR']._loaded_options = None 26 _globals['DESCRIPTOR']._serialized_options = b'\n\032com.google.ortools.mathoptP\001' 27 _globals['_MODELSOLVEPARAMETERSPROTO_AUXILIARYOBJECTIVEPARAMETERSENTRY']._loaded_options = None 28 _globals['_MODELSOLVEPARAMETERSPROTO_AUXILIARYOBJECTIVEPARAMETERSENTRY']._serialized_options = b'8\001' 29 _globals['_SOLUTIONHINTPROTO']._serialized_start=149 30 _globals['_SOLUTIONHINTPROTO']._serialized_end=324 31 _globals['_OBJECTIVEPARAMETERSPROTO']._serialized_start=327 32 _globals['_OBJECTIVEPARAMETERSPROTO']._serialized_end=553 33 _globals['_MODELSOLVEPARAMETERSPROTO']._serialized_start=556 34 _globals['_MODELSOLVEPARAMETERSPROTO']._serialized_end=1540 35 _globals['_MODELSOLVEPARAMETERSPROTO_AUXILIARYOBJECTIVEPARAMETERSENTRY']._serialized_start=1417 36 _globals['_MODELSOLVEPARAMETERSPROTO_AUXILIARYOBJECTIVEPARAMETERSENTRY']._serialized_end=1540 37# @@protoc_insertion_point(module_scope)
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor =
<google.protobuf.descriptor.FileDescriptor object>
class
SolutionHintProto(google.protobuf.message.Message):
A suggested starting solution for the solver.
MIP solvers generally only want primal information (variable_values), while
LP solvers want both primal and dual information (dual_values).
Many MIP solvers can work with: (1) partial solutions that do not specify all variables or (2) infeasible solutions. In these cases, solvers typically solve a sub-MIP to complete/correct the hint.
How the hint is used by the solver, if at all, is highly dependent on the solver, the problem type, and the algorithm used. The most reliable way to ensure your hint has an effect is to read the underlying solvers logs with and without the hint.
Simplex-based LP solvers typically prefer an initial basis to a solution hint (they need to crossover to convert the hint to a basic feasible solution otherwise).
TODO(b/183616124): Add hint-priorities to variable_values.
SolutionHintProto( *, variable_values: ortools.math_opt.sparse_containers_pb2.SparseDoubleVectorProto | None = Ellipsis, dual_values: ortools.math_opt.sparse_containers_pb2.SparseDoubleVectorProto | None = Ellipsis)
498 def init(self, **kwargs): 499 self._cached_byte_size = 0 500 self._cached_byte_size_dirty = len(kwargs) > 0 501 self._fields = {} 502 # Contains a mapping from oneof field descriptors to the descriptor 503 # of the currently set field in that oneof field. 504 self._oneofs = {} 505 506 # _unknown_fields is () when empty for efficiency, and will be turned into 507 # a list if fields are added. 508 self._unknown_fields = () 509 self._is_present_in_parent = False 510 self._listener = message_listener_mod.NullMessageListener() 511 self._listener_for_children = _Listener(self) 512 for field_name, field_value in kwargs.items(): 513 field = _GetFieldByName(message_descriptor, field_name) 514 if field is None: 515 raise TypeError('%s() got an unexpected keyword argument "%s"' % 516 (message_descriptor.name, field_name)) 517 if field_value is None: 518 # field=None is the same as no field at all. 519 continue 520 if field.label == _FieldDescriptor.LABEL_REPEATED: 521 field_copy = field._default_constructor(self) 522 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: # Composite 523 if _IsMapField(field): 524 if _IsMessageMapField(field): 525 for key in field_value: 526 field_copy[key].MergeFrom(field_value[key]) 527 else: 528 field_copy.update(field_value) 529 else: 530 for val in field_value: 531 if isinstance(val, dict): 532 field_copy.add(**val) 533 else: 534 field_copy.add().MergeFrom(val) 535 else: # Scalar 536 if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM: 537 field_value = [_GetIntegerEnumValue(field.enum_type, val) 538 for val in field_value] 539 field_copy.extend(field_value) 540 self._fields[field] = field_copy 541 elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 542 field_copy = field._default_constructor(self) 543 new_val = None 544 if isinstance(field_value, message_mod.Message): 545 new_val = field_value 546 elif isinstance(field_value, dict): 547 if field.message_type.full_name == _StructFullTypeName: 548 field_copy.Clear() 549 if len(field_value) == 1 and 'fields' in field_value: 550 try: 551 field_copy.update(field_value) 552 except: 553 # Fall back to init normal message field 554 field_copy.Clear() 555 new_val = field.message_type._concrete_class(**field_value) 556 else: 557 field_copy.update(field_value) 558 else: 559 new_val = field.message_type._concrete_class(**field_value) 560 elif hasattr(field_copy, '_internal_assign'): 561 field_copy._internal_assign(field_value) 562 else: 563 raise TypeError( 564 'Message field {0}.{1} must be initialized with a ' 565 'dict or instance of same class, got {2}.'.format( 566 message_descriptor.name, 567 field_name, 568 type(field_value).__name__, 569 ) 570 ) 571 572 if new_val: 573 try: 574 field_copy.MergeFrom(new_val) 575 except TypeError: 576 _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name) 577 self._fields[field] = field_copy 578 else: 579 if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM: 580 field_value = _GetIntegerEnumValue(field.enum_type, field_value) 581 try: 582 setattr(self, field_name, field_value) 583 except TypeError: 584 _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
def
MergeFrom(self, other_msg):
1361 def MergeFrom(self, msg): 1362 if not isinstance(msg, cls): 1363 raise TypeError( 1364 'Parameter to MergeFrom() must be instance of same class: ' 1365 'expected %s got %s.' % (_FullyQualifiedClassName(cls), 1366 _FullyQualifiedClassName(msg.__class__))) 1367 1368 assert msg is not self 1369 self._Modified() 1370 1371 fields = self._fields 1372 1373 for field, value in msg._fields.items(): 1374 if field.label == LABEL_REPEATED: 1375 field_value = fields.get(field) 1376 if field_value is None: 1377 # Construct a new object to represent this field. 1378 field_value = field._default_constructor(self) 1379 fields[field] = field_value 1380 field_value.MergeFrom(value) 1381 elif field.cpp_type == CPPTYPE_MESSAGE: 1382 if value._is_present_in_parent: 1383 field_value = fields.get(field) 1384 if field_value is None: 1385 # Construct a new object to represent this field. 1386 field_value = field._default_constructor(self) 1387 fields[field] = field_value 1388 field_value.MergeFrom(value) 1389 else: 1390 self._fields[field] = value 1391 if field.containing_oneof: 1392 self._UpdateOneofState(field) 1393 1394 if msg._unknown_fields: 1395 if not self._unknown_fields: 1396 self._unknown_fields = [] 1397 self._unknown_fields.extend(msg._unknown_fields)
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):
1420def _Clear(self): 1421 # Clear fields. 1422 self._fields = {} 1423 self._unknown_fields = () 1424 1425 self._oneofs = {} 1426 self._Modified()
Clears all data that was set in the message.
def
SetInParent(self):
1486 def Modified(self): 1487 """Sets the _cached_byte_size_dirty bit to true, 1488 and propagates this to our listener iff this was a state change. 1489 """ 1490 1491 # Note: Some callers check _cached_byte_size_dirty before calling 1492 # _Modified() as an extra optimization. So, if this method is ever 1493 # changed such that it does stuff even when _cached_byte_size_dirty is 1494 # already true, the callers need to be updated. 1495 if not self._cached_byte_size_dirty: 1496 self._cached_byte_size_dirty = True 1497 self._listener_for_children.dirty = True 1498 self._is_present_in_parent = True 1499 self._listener.Modified()
Mark this as present in the parent.
This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.
def
IsInitialized(self):
1262 def IsInitialized(self, errors=None): 1263 """Checks if all required fields of a message are set. 1264 1265 Args: 1266 errors: A list which, if provided, will be populated with the field 1267 paths of all missing required fields. 1268 1269 Returns: 1270 True iff the specified message has all required fields set. 1271 """ 1272 1273 # Performance is critical so we avoid HasField() and ListFields(). 1274 1275 for field in required_fields: 1276 if (field not in self._fields or 1277 (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and 1278 not self._fields[field]._is_present_in_parent)): 1279 if errors is not None: 1280 errors.extend(self.FindInitializationErrors()) 1281 return False 1282 1283 for field, value in list(self._fields.items()): # dict can change size! 1284 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1285 if field.label == _FieldDescriptor.LABEL_REPEATED: 1286 if (field.message_type._is_map_entry): 1287 continue 1288 for element in value: 1289 if not element.IsInitialized(): 1290 if errors is not None: 1291 errors.extend(self.FindInitializationErrors()) 1292 return False 1293 elif value._is_present_in_parent and not value.IsInitialized(): 1294 if errors is not None: 1295 errors.extend(self.FindInitializationErrors()) 1296 return False 1297 1298 return True
Checks if the message is initialized.
Returns:
bool: The method returns True if the message is initialized (i.e. all of its required fields are set).
def
MergeFromString(self, serialized):
1177 def MergeFromString(self, serialized): 1178 serialized = memoryview(serialized) 1179 length = len(serialized) 1180 try: 1181 if self._InternalParse(serialized, 0, length) != length: 1182 # The only reason _InternalParse would return early is if it 1183 # encountered an end-group tag. 1184 raise message_mod.DecodeError('Unexpected end-group tag.') 1185 except (IndexError, TypeError): 1186 # Now ord(buf[p:p+1]) == ord('') gets TypeError. 1187 raise message_mod.DecodeError('Truncated message.') 1188 except struct.error as e: 1189 raise message_mod.DecodeError(e) 1190 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 belen(serialized), but for messages which are actually groups, this will generally be less thanlen(serialized), since we must stop when we reach anEND_GROUPtag. Note that if we do stop because of anEND_GROUPtag, the number of bytes returned does not include the bytes for theEND_GROUPtag information.
Raises:
- DecodeError: if the input cannot be parsed.
def
SerializeToString(self, **kwargs):
1130 def SerializeToString(self, **kwargs): 1131 # Check if the message has all of its required fields set. 1132 if not self.IsInitialized(): 1133 raise message_mod.EncodeError( 1134 'Message %s is missing required fields: %s' % ( 1135 self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors()))) 1136 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:
- EncodeError: if the message isn't initialized (see
IsInitialized()).
def
SerializePartialToString(self, **kwargs):
1143 def SerializePartialToString(self, **kwargs): 1144 out = BytesIO() 1145 self._InternalSerialize(out.write, **kwargs) 1146 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):
848 def ListFields(self): 849 all_fields = [item for item in self._fields.items() if _IsPresent(item)] 850 all_fields.sort(key = lambda item: item[0].number) 851 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: Literal['dual_values', b'dual_values', 'variable_values', b'variable_values']) -> bool:
872 def HasField(self, field_name): 873 try: 874 field = hassable_fields[field_name] 875 except KeyError as exc: 876 raise ValueError('Protocol message %s has no non-repeated field "%s" ' 877 'nor has presence is not available for this field.' % ( 878 message_descriptor.full_name, field_name)) from exc 879 880 if isinstance(field, descriptor_mod.OneofDescriptor): 881 try: 882 return HasField(self, self._oneofs[field].name) 883 except KeyError: 884 return False 885 else: 886 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 887 value = self._fields.get(field) 888 return value is not None and value._is_present_in_parent 889 else: 890 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_nameis not a member of this message.
def
ClearField( self, field_name: Literal['dual_values', b'dual_values', 'variable_values', b'variable_values']) -> None:
897 def ClearField(self, field_name): 898 try: 899 field = message_descriptor.fields_by_name[field_name] 900 except KeyError: 901 try: 902 field = message_descriptor.oneofs_by_name[field_name] 903 if field in self._oneofs: 904 field = self._oneofs[field] 905 else: 906 return 907 except KeyError: 908 raise ValueError('Protocol message %s has no "%s" field.' % 909 (message_descriptor.name, field_name)) 910 911 if field in self._fields: 912 # To match the C++ implementation, we need to invalidate iterators 913 # for map fields when ClearField() happens. 914 if hasattr(self._fields[field], 'InvalidateIterators'): 915 self._fields[field].InvalidateIterators() 916 917 # Note: If the field is a sub-message, its listener will still point 918 # at us. That's fine, because the worst than can happen is that it 919 # will call _Modified() and invalidate our byte size. Big deal. 920 del self._fields[field] 921 922 if self._oneofs.get(field.containing_oneof, None) is field: 923 del self._oneofs[field.containing_oneof] 924 925 # Always call _Modified() -- even if nothing was changed, this is 926 # a mutating method, and thus calling it should cause the field to become 927 # present in the parent message. 928 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_nameis not a member of this message.
def
WhichOneof(self, oneof_group):
1403 def WhichOneof(self, oneof_name): 1404 """Returns the name of the currently set field inside a oneof, or None.""" 1405 try: 1406 field = message_descriptor.oneofs_by_name[oneof_name] 1407 except KeyError: 1408 raise ValueError( 1409 'Protocol message has no oneof "%s" field.' % oneof_name) 1410 1411 nested_field = self._oneofs.get(field, None) 1412 if nested_field is not None and self.HasField(nested_field.name): 1413 return nested_field.name 1414 else: 1415 return None
Returns the name of the field that is set inside a oneof group.
If no field is set, returns None.
Arguments:
- oneof_group (str): the name of the oneof group to check.
Returns:
str or None: The name of the group that is set, or None.
Raises:
- ValueError: no group with the given name exists
def
DiscardUnknownFields(self):
1435def _DiscardUnknownFields(self): 1436 self._unknown_fields = [] 1437 for field, value in self.ListFields(): 1438 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1439 if _IsMapField(field): 1440 if _IsMessageMapField(field): 1441 for key in value: 1442 value[key].DiscardUnknownFields() 1443 elif field.label == _FieldDescriptor.LABEL_REPEATED: 1444 for sub_message in value: 1445 sub_message.DiscardUnknownFields() 1446 else: 1447 value.DiscardUnknownFields()
Clears all fields in the UnknownFieldSet.
This operation is recursive for nested message.
def
ByteSize(self):
1098 def ByteSize(self): 1099 if not self._cached_byte_size_dirty: 1100 return self._cached_byte_size 1101 1102 size = 0 1103 descriptor = self.DESCRIPTOR 1104 if descriptor._is_map_entry: 1105 # Fields of map entry should always be serialized. 1106 key_field = descriptor.fields_by_name['key'] 1107 _MaybeAddEncoder(cls, key_field) 1108 size = key_field._sizer(self.key) 1109 value_field = descriptor.fields_by_name['value'] 1110 _MaybeAddEncoder(cls, value_field) 1111 size += value_field._sizer(self.value) 1112 else: 1113 for field_descriptor, field_value in self.ListFields(): 1114 _MaybeAddEncoder(cls, field_descriptor) 1115 size += field_descriptor._sizer(field_value) 1116 for tag_bytes, value_bytes in self._unknown_fields: 1117 size += len(tag_bytes) + len(value_bytes) 1118 1119 self._cached_byte_size = size 1120 self._cached_byte_size_dirty = False 1121 self._listener_for_children.dirty = False 1122 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.
variable_values: ortools.math_opt.sparse_containers_pb2.SparseDoubleVectorProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
A possibly partial assignment of values to the primal variables of the problem. The solver-independent requirements for this sub-message are:
- variable_values.ids are elements of VariablesProto.ids.
- variable_values.values must all be finite.
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
A (potentially partial) assignment of values to the linear constraints of the problem.
Requirements:
- dual_values.ids are elements of LinearConstraintsProto.ids.
- dual_values.values must all be finite.
def
FindInitializationErrors(self):
1302 def FindInitializationErrors(self): 1303 """Finds required fields which are not initialized. 1304 1305 Returns: 1306 A list of strings. Each string is a path to an uninitialized field from 1307 the top-level message, e.g. "foo.bar[5].baz". 1308 """ 1309 1310 errors = [] # simplify things 1311 1312 for field in required_fields: 1313 if not self.HasField(field.name): 1314 errors.append(field.name) 1315 1316 for field, value in self.ListFields(): 1317 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1318 if field.is_extension: 1319 name = '(%s)' % field.full_name 1320 else: 1321 name = field.name 1322 1323 if _IsMapField(field): 1324 if _IsMessageMapField(field): 1325 for key in value: 1326 element = value[key] 1327 prefix = '%s[%s].' % (name, key) 1328 sub_errors = element.FindInitializationErrors() 1329 errors += [prefix + error for error in sub_errors] 1330 else: 1331 # ScalarMaps can't have any initialization errors. 1332 pass 1333 elif field.label == _FieldDescriptor.LABEL_REPEATED: 1334 for i in range(len(value)): 1335 element = value[i] 1336 prefix = '%s[%d].' % (name, i) 1337 sub_errors = element.FindInitializationErrors() 1338 errors += [prefix + error for error in sub_errors] 1339 else: 1340 prefix = name + '.' 1341 sub_errors = value.FindInitializationErrors() 1342 errors += [prefix + error for error in sub_errors] 1343 1344 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
- UnknownFields
class
ObjectiveParametersProto(google.protobuf.message.Message):
Parameters for an individual objective in a multi-objective model.
ObjectiveParametersProto( *, objective_degradation_absolute_tolerance: float | None = Ellipsis, objective_degradation_relative_tolerance: float | None = Ellipsis)
498 def init(self, **kwargs): 499 self._cached_byte_size = 0 500 self._cached_byte_size_dirty = len(kwargs) > 0 501 self._fields = {} 502 # Contains a mapping from oneof field descriptors to the descriptor 503 # of the currently set field in that oneof field. 504 self._oneofs = {} 505 506 # _unknown_fields is () when empty for efficiency, and will be turned into 507 # a list if fields are added. 508 self._unknown_fields = () 509 self._is_present_in_parent = False 510 self._listener = message_listener_mod.NullMessageListener() 511 self._listener_for_children = _Listener(self) 512 for field_name, field_value in kwargs.items(): 513 field = _GetFieldByName(message_descriptor, field_name) 514 if field is None: 515 raise TypeError('%s() got an unexpected keyword argument "%s"' % 516 (message_descriptor.name, field_name)) 517 if field_value is None: 518 # field=None is the same as no field at all. 519 continue 520 if field.label == _FieldDescriptor.LABEL_REPEATED: 521 field_copy = field._default_constructor(self) 522 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: # Composite 523 if _IsMapField(field): 524 if _IsMessageMapField(field): 525 for key in field_value: 526 field_copy[key].MergeFrom(field_value[key]) 527 else: 528 field_copy.update(field_value) 529 else: 530 for val in field_value: 531 if isinstance(val, dict): 532 field_copy.add(**val) 533 else: 534 field_copy.add().MergeFrom(val) 535 else: # Scalar 536 if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM: 537 field_value = [_GetIntegerEnumValue(field.enum_type, val) 538 for val in field_value] 539 field_copy.extend(field_value) 540 self._fields[field] = field_copy 541 elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 542 field_copy = field._default_constructor(self) 543 new_val = None 544 if isinstance(field_value, message_mod.Message): 545 new_val = field_value 546 elif isinstance(field_value, dict): 547 if field.message_type.full_name == _StructFullTypeName: 548 field_copy.Clear() 549 if len(field_value) == 1 and 'fields' in field_value: 550 try: 551 field_copy.update(field_value) 552 except: 553 # Fall back to init normal message field 554 field_copy.Clear() 555 new_val = field.message_type._concrete_class(**field_value) 556 else: 557 field_copy.update(field_value) 558 else: 559 new_val = field.message_type._concrete_class(**field_value) 560 elif hasattr(field_copy, '_internal_assign'): 561 field_copy._internal_assign(field_value) 562 else: 563 raise TypeError( 564 'Message field {0}.{1} must be initialized with a ' 565 'dict or instance of same class, got {2}.'.format( 566 message_descriptor.name, 567 field_name, 568 type(field_value).__name__, 569 ) 570 ) 571 572 if new_val: 573 try: 574 field_copy.MergeFrom(new_val) 575 except TypeError: 576 _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name) 577 self._fields[field] = field_copy 578 else: 579 if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM: 580 field_value = _GetIntegerEnumValue(field.enum_type, field_value) 581 try: 582 setattr(self, field_name, field_value) 583 except TypeError: 584 _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
def
MergeFrom(self, other_msg):
1361 def MergeFrom(self, msg): 1362 if not isinstance(msg, cls): 1363 raise TypeError( 1364 'Parameter to MergeFrom() must be instance of same class: ' 1365 'expected %s got %s.' % (_FullyQualifiedClassName(cls), 1366 _FullyQualifiedClassName(msg.__class__))) 1367 1368 assert msg is not self 1369 self._Modified() 1370 1371 fields = self._fields 1372 1373 for field, value in msg._fields.items(): 1374 if field.label == LABEL_REPEATED: 1375 field_value = fields.get(field) 1376 if field_value is None: 1377 # Construct a new object to represent this field. 1378 field_value = field._default_constructor(self) 1379 fields[field] = field_value 1380 field_value.MergeFrom(value) 1381 elif field.cpp_type == CPPTYPE_MESSAGE: 1382 if value._is_present_in_parent: 1383 field_value = fields.get(field) 1384 if field_value is None: 1385 # Construct a new object to represent this field. 1386 field_value = field._default_constructor(self) 1387 fields[field] = field_value 1388 field_value.MergeFrom(value) 1389 else: 1390 self._fields[field] = value 1391 if field.containing_oneof: 1392 self._UpdateOneofState(field) 1393 1394 if msg._unknown_fields: 1395 if not self._unknown_fields: 1396 self._unknown_fields = [] 1397 self._unknown_fields.extend(msg._unknown_fields)
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):
1420def _Clear(self): 1421 # Clear fields. 1422 self._fields = {} 1423 self._unknown_fields = () 1424 1425 self._oneofs = {} 1426 self._Modified()
Clears all data that was set in the message.
def
SetInParent(self):
1486 def Modified(self): 1487 """Sets the _cached_byte_size_dirty bit to true, 1488 and propagates this to our listener iff this was a state change. 1489 """ 1490 1491 # Note: Some callers check _cached_byte_size_dirty before calling 1492 # _Modified() as an extra optimization. So, if this method is ever 1493 # changed such that it does stuff even when _cached_byte_size_dirty is 1494 # already true, the callers need to be updated. 1495 if not self._cached_byte_size_dirty: 1496 self._cached_byte_size_dirty = True 1497 self._listener_for_children.dirty = True 1498 self._is_present_in_parent = True 1499 self._listener.Modified()
Mark this as present in the parent.
This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.
def
IsInitialized(self):
1262 def IsInitialized(self, errors=None): 1263 """Checks if all required fields of a message are set. 1264 1265 Args: 1266 errors: A list which, if provided, will be populated with the field 1267 paths of all missing required fields. 1268 1269 Returns: 1270 True iff the specified message has all required fields set. 1271 """ 1272 1273 # Performance is critical so we avoid HasField() and ListFields(). 1274 1275 for field in required_fields: 1276 if (field not in self._fields or 1277 (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and 1278 not self._fields[field]._is_present_in_parent)): 1279 if errors is not None: 1280 errors.extend(self.FindInitializationErrors()) 1281 return False 1282 1283 for field, value in list(self._fields.items()): # dict can change size! 1284 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1285 if field.label == _FieldDescriptor.LABEL_REPEATED: 1286 if (field.message_type._is_map_entry): 1287 continue 1288 for element in value: 1289 if not element.IsInitialized(): 1290 if errors is not None: 1291 errors.extend(self.FindInitializationErrors()) 1292 return False 1293 elif value._is_present_in_parent and not value.IsInitialized(): 1294 if errors is not None: 1295 errors.extend(self.FindInitializationErrors()) 1296 return False 1297 1298 return True
Checks if the message is initialized.
Returns:
bool: The method returns True if the message is initialized (i.e. all of its required fields are set).
def
MergeFromString(self, serialized):
1177 def MergeFromString(self, serialized): 1178 serialized = memoryview(serialized) 1179 length = len(serialized) 1180 try: 1181 if self._InternalParse(serialized, 0, length) != length: 1182 # The only reason _InternalParse would return early is if it 1183 # encountered an end-group tag. 1184 raise message_mod.DecodeError('Unexpected end-group tag.') 1185 except (IndexError, TypeError): 1186 # Now ord(buf[p:p+1]) == ord('') gets TypeError. 1187 raise message_mod.DecodeError('Truncated message.') 1188 except struct.error as e: 1189 raise message_mod.DecodeError(e) 1190 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 belen(serialized), but for messages which are actually groups, this will generally be less thanlen(serialized), since we must stop when we reach anEND_GROUPtag. Note that if we do stop because of anEND_GROUPtag, the number of bytes returned does not include the bytes for theEND_GROUPtag information.
Raises:
- DecodeError: if the input cannot be parsed.
def
SerializeToString(self, **kwargs):
1130 def SerializeToString(self, **kwargs): 1131 # Check if the message has all of its required fields set. 1132 if not self.IsInitialized(): 1133 raise message_mod.EncodeError( 1134 'Message %s is missing required fields: %s' % ( 1135 self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors()))) 1136 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:
- EncodeError: if the message isn't initialized (see
IsInitialized()).
def
SerializePartialToString(self, **kwargs):
1143 def SerializePartialToString(self, **kwargs): 1144 out = BytesIO() 1145 self._InternalSerialize(out.write, **kwargs) 1146 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):
848 def ListFields(self): 849 all_fields = [item for item in self._fields.items() if _IsPresent(item)] 850 all_fields.sort(key = lambda item: item[0].number) 851 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: Literal['_objective_degradation_absolute_tolerance', b'_objective_degradation_absolute_tolerance', '_objective_degradation_relative_tolerance', b'_objective_degradation_relative_tolerance', 'objective_degradation_absolute_tolerance', b'objective_degradation_absolute_tolerance', 'objective_degradation_relative_tolerance', b'objective_degradation_relative_tolerance']) -> bool:
872 def HasField(self, field_name): 873 try: 874 field = hassable_fields[field_name] 875 except KeyError as exc: 876 raise ValueError('Protocol message %s has no non-repeated field "%s" ' 877 'nor has presence is not available for this field.' % ( 878 message_descriptor.full_name, field_name)) from exc 879 880 if isinstance(field, descriptor_mod.OneofDescriptor): 881 try: 882 return HasField(self, self._oneofs[field].name) 883 except KeyError: 884 return False 885 else: 886 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 887 value = self._fields.get(field) 888 return value is not None and value._is_present_in_parent 889 else: 890 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_nameis not a member of this message.
def
ClearField( self, field_name: Literal['_objective_degradation_absolute_tolerance', b'_objective_degradation_absolute_tolerance', '_objective_degradation_relative_tolerance', b'_objective_degradation_relative_tolerance', 'objective_degradation_absolute_tolerance', b'objective_degradation_absolute_tolerance', 'objective_degradation_relative_tolerance', b'objective_degradation_relative_tolerance']) -> None:
897 def ClearField(self, field_name): 898 try: 899 field = message_descriptor.fields_by_name[field_name] 900 except KeyError: 901 try: 902 field = message_descriptor.oneofs_by_name[field_name] 903 if field in self._oneofs: 904 field = self._oneofs[field] 905 else: 906 return 907 except KeyError: 908 raise ValueError('Protocol message %s has no "%s" field.' % 909 (message_descriptor.name, field_name)) 910 911 if field in self._fields: 912 # To match the C++ implementation, we need to invalidate iterators 913 # for map fields when ClearField() happens. 914 if hasattr(self._fields[field], 'InvalidateIterators'): 915 self._fields[field].InvalidateIterators() 916 917 # Note: If the field is a sub-message, its listener will still point 918 # at us. That's fine, because the worst than can happen is that it 919 # will call _Modified() and invalidate our byte size. Big deal. 920 del self._fields[field] 921 922 if self._oneofs.get(field.containing_oneof, None) is field: 923 del self._oneofs[field.containing_oneof] 924 925 # Always call _Modified() -- even if nothing was changed, this is 926 # a mutating method, and thus calling it should cause the field to become 927 # present in the parent message. 928 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_nameis not a member of this message.
def
WhichOneof(*args, **kwds):
1403 def WhichOneof(self, oneof_name): 1404 """Returns the name of the currently set field inside a oneof, or None.""" 1405 try: 1406 field = message_descriptor.oneofs_by_name[oneof_name] 1407 except KeyError: 1408 raise ValueError( 1409 'Protocol message has no oneof "%s" field.' % oneof_name) 1410 1411 nested_field = self._oneofs.get(field, None) 1412 if nested_field is not None and self.HasField(nested_field.name): 1413 return nested_field.name 1414 else: 1415 return None
Returns the name of the currently set field inside a oneof, or None.
def
DiscardUnknownFields(self):
1435def _DiscardUnknownFields(self): 1436 self._unknown_fields = [] 1437 for field, value in self.ListFields(): 1438 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1439 if _IsMapField(field): 1440 if _IsMessageMapField(field): 1441 for key in value: 1442 value[key].DiscardUnknownFields() 1443 elif field.label == _FieldDescriptor.LABEL_REPEATED: 1444 for sub_message in value: 1445 sub_message.DiscardUnknownFields() 1446 else: 1447 value.DiscardUnknownFields()
Clears all fields in the UnknownFieldSet.
This operation is recursive for nested message.
def
ByteSize(self):
1098 def ByteSize(self): 1099 if not self._cached_byte_size_dirty: 1100 return self._cached_byte_size 1101 1102 size = 0 1103 descriptor = self.DESCRIPTOR 1104 if descriptor._is_map_entry: 1105 # Fields of map entry should always be serialized. 1106 key_field = descriptor.fields_by_name['key'] 1107 _MaybeAddEncoder(cls, key_field) 1108 size = key_field._sizer(self.key) 1109 value_field = descriptor.fields_by_name['value'] 1110 _MaybeAddEncoder(cls, value_field) 1111 size += value_field._sizer(self.value) 1112 else: 1113 for field_descriptor, field_value in self.ListFields(): 1114 _MaybeAddEncoder(cls, field_descriptor) 1115 size += field_descriptor._sizer(field_value) 1116 for tag_bytes, value_bytes in self._unknown_fields: 1117 size += len(tag_bytes) + len(value_bytes) 1118 1119 self._cached_byte_size = size 1120 self._cached_byte_size_dirty = False 1121 self._listener_for_children.dirty = False 1122 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.
objective_degradation_absolute_tolerance: float
711 def getter(self): 712 # TODO: This may be broken since there may not be 713 # default_value. Combine with has_default_value somehow. 714 return self._fields.get(field, default_value)
Optional objective degradation absolute tolerance. For a hierarchical
multi-objective solver, each objective fⁱ is processed in priority order:
the solver determines the optimal objective value Γⁱ, if it exists, subject
to all constraints in the model and the additional constraints that
fᵏ(x) = Γᵏ (within tolerances) for each k < i. If set, a solution is
considered to be "within tolerances" for this objective fᵏ if
|fᵏ(x) - Γᵏ| ≤ objective_degradation_absolute_tolerance.
See also objective_degradation_relative_tolerance; if both parameters are
set for a given objective, the solver need only satisfy one to be
considered "within tolerances".
If set, must be nonnegative.
objective_degradation_relative_tolerance: float
711 def getter(self): 712 # TODO: This may be broken since there may not be 713 # default_value. Combine with has_default_value somehow. 714 return self._fields.get(field, default_value)
Optional objective degradation relative tolerance. For a hierarchical
multi-objective solver, each objective fⁱ is processed in priority order:
the solver determines the optimal objective value Γⁱ, if it exists, subject
to all constraints in the model and the additional constraints that
fᵏ(x) = Γᵏ (within tolerances) for each k < i. If set, a solution is
considered to be "within tolerances" for this objective fᵏ if
|fᵏ(x) - Γᵏ| ≤ objective_degradation_relative_tolerance * |Γᵏ|.
See also objective_degradation_absolute_tolerance; if both parameters are
set for a given objective, the solver need only satisfy one to be
considered "within tolerances".
If set, must be nonnegative.
def
FindInitializationErrors(self):
1302 def FindInitializationErrors(self): 1303 """Finds required fields which are not initialized. 1304 1305 Returns: 1306 A list of strings. Each string is a path to an uninitialized field from 1307 the top-level message, e.g. "foo.bar[5].baz". 1308 """ 1309 1310 errors = [] # simplify things 1311 1312 for field in required_fields: 1313 if not self.HasField(field.name): 1314 errors.append(field.name) 1315 1316 for field, value in self.ListFields(): 1317 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1318 if field.is_extension: 1319 name = '(%s)' % field.full_name 1320 else: 1321 name = field.name 1322 1323 if _IsMapField(field): 1324 if _IsMessageMapField(field): 1325 for key in value: 1326 element = value[key] 1327 prefix = '%s[%s].' % (name, key) 1328 sub_errors = element.FindInitializationErrors() 1329 errors += [prefix + error for error in sub_errors] 1330 else: 1331 # ScalarMaps can't have any initialization errors. 1332 pass 1333 elif field.label == _FieldDescriptor.LABEL_REPEATED: 1334 for i in range(len(value)): 1335 element = value[i] 1336 prefix = '%s[%d].' % (name, i) 1337 sub_errors = element.FindInitializationErrors() 1338 errors += [prefix + error for error in sub_errors] 1339 else: 1340 prefix = name + '.' 1341 sub_errors = value.FindInitializationErrors() 1342 errors += [prefix + error for error in sub_errors] 1343 1344 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
- UnknownFields
class
ModelSolveParametersProto(google.protobuf.message.Message):
TODO(b/183628247): follow naming convention in fields below. Parameters to control a single solve that are specific to the input model (see SolveParametersProto for model independent parameters).
ModelSolveParametersProto( *, variable_values_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto | None = Ellipsis, dual_values_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto | None = Ellipsis, quadratic_dual_values_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto | None = Ellipsis, reduced_costs_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto | None = Ellipsis, initial_basis: ortools.math_opt.solution_pb2.BasisProto | None = Ellipsis, solution_hints: Iterable[SolutionHintProto] | None = Ellipsis, branching_priorities: ortools.math_opt.sparse_containers_pb2.SparseInt32VectorProto | None = Ellipsis, primary_objective_parameters: ObjectiveParametersProto | None = Ellipsis, auxiliary_objective_parameters: Mapping[int, ObjectiveParametersProto] | None = Ellipsis, lazy_linear_constraint_ids: Iterable[int] | None = Ellipsis)
498 def init(self, **kwargs): 499 self._cached_byte_size = 0 500 self._cached_byte_size_dirty = len(kwargs) > 0 501 self._fields = {} 502 # Contains a mapping from oneof field descriptors to the descriptor 503 # of the currently set field in that oneof field. 504 self._oneofs = {} 505 506 # _unknown_fields is () when empty for efficiency, and will be turned into 507 # a list if fields are added. 508 self._unknown_fields = () 509 self._is_present_in_parent = False 510 self._listener = message_listener_mod.NullMessageListener() 511 self._listener_for_children = _Listener(self) 512 for field_name, field_value in kwargs.items(): 513 field = _GetFieldByName(message_descriptor, field_name) 514 if field is None: 515 raise TypeError('%s() got an unexpected keyword argument "%s"' % 516 (message_descriptor.name, field_name)) 517 if field_value is None: 518 # field=None is the same as no field at all. 519 continue 520 if field.label == _FieldDescriptor.LABEL_REPEATED: 521 field_copy = field._default_constructor(self) 522 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: # Composite 523 if _IsMapField(field): 524 if _IsMessageMapField(field): 525 for key in field_value: 526 field_copy[key].MergeFrom(field_value[key]) 527 else: 528 field_copy.update(field_value) 529 else: 530 for val in field_value: 531 if isinstance(val, dict): 532 field_copy.add(**val) 533 else: 534 field_copy.add().MergeFrom(val) 535 else: # Scalar 536 if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM: 537 field_value = [_GetIntegerEnumValue(field.enum_type, val) 538 for val in field_value] 539 field_copy.extend(field_value) 540 self._fields[field] = field_copy 541 elif field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 542 field_copy = field._default_constructor(self) 543 new_val = None 544 if isinstance(field_value, message_mod.Message): 545 new_val = field_value 546 elif isinstance(field_value, dict): 547 if field.message_type.full_name == _StructFullTypeName: 548 field_copy.Clear() 549 if len(field_value) == 1 and 'fields' in field_value: 550 try: 551 field_copy.update(field_value) 552 except: 553 # Fall back to init normal message field 554 field_copy.Clear() 555 new_val = field.message_type._concrete_class(**field_value) 556 else: 557 field_copy.update(field_value) 558 else: 559 new_val = field.message_type._concrete_class(**field_value) 560 elif hasattr(field_copy, '_internal_assign'): 561 field_copy._internal_assign(field_value) 562 else: 563 raise TypeError( 564 'Message field {0}.{1} must be initialized with a ' 565 'dict or instance of same class, got {2}.'.format( 566 message_descriptor.name, 567 field_name, 568 type(field_value).__name__, 569 ) 570 ) 571 572 if new_val: 573 try: 574 field_copy.MergeFrom(new_val) 575 except TypeError: 576 _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name) 577 self._fields[field] = field_copy 578 else: 579 if field.cpp_type == _FieldDescriptor.CPPTYPE_ENUM: 580 field_value = _GetIntegerEnumValue(field.enum_type, field_value) 581 try: 582 setattr(self, field_name, field_value) 583 except TypeError: 584 _ReraiseTypeErrorWithFieldName(message_descriptor.name, field_name)
def
MergeFrom(self, other_msg):
1361 def MergeFrom(self, msg): 1362 if not isinstance(msg, cls): 1363 raise TypeError( 1364 'Parameter to MergeFrom() must be instance of same class: ' 1365 'expected %s got %s.' % (_FullyQualifiedClassName(cls), 1366 _FullyQualifiedClassName(msg.__class__))) 1367 1368 assert msg is not self 1369 self._Modified() 1370 1371 fields = self._fields 1372 1373 for field, value in msg._fields.items(): 1374 if field.label == LABEL_REPEATED: 1375 field_value = fields.get(field) 1376 if field_value is None: 1377 # Construct a new object to represent this field. 1378 field_value = field._default_constructor(self) 1379 fields[field] = field_value 1380 field_value.MergeFrom(value) 1381 elif field.cpp_type == CPPTYPE_MESSAGE: 1382 if value._is_present_in_parent: 1383 field_value = fields.get(field) 1384 if field_value is None: 1385 # Construct a new object to represent this field. 1386 field_value = field._default_constructor(self) 1387 fields[field] = field_value 1388 field_value.MergeFrom(value) 1389 else: 1390 self._fields[field] = value 1391 if field.containing_oneof: 1392 self._UpdateOneofState(field) 1393 1394 if msg._unknown_fields: 1395 if not self._unknown_fields: 1396 self._unknown_fields = [] 1397 self._unknown_fields.extend(msg._unknown_fields)
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):
1420def _Clear(self): 1421 # Clear fields. 1422 self._fields = {} 1423 self._unknown_fields = () 1424 1425 self._oneofs = {} 1426 self._Modified()
Clears all data that was set in the message.
def
SetInParent(self):
1486 def Modified(self): 1487 """Sets the _cached_byte_size_dirty bit to true, 1488 and propagates this to our listener iff this was a state change. 1489 """ 1490 1491 # Note: Some callers check _cached_byte_size_dirty before calling 1492 # _Modified() as an extra optimization. So, if this method is ever 1493 # changed such that it does stuff even when _cached_byte_size_dirty is 1494 # already true, the callers need to be updated. 1495 if not self._cached_byte_size_dirty: 1496 self._cached_byte_size_dirty = True 1497 self._listener_for_children.dirty = True 1498 self._is_present_in_parent = True 1499 self._listener.Modified()
Mark this as present in the parent.
This normally happens automatically when you assign a field of a sub-message, but sometimes you want to make the sub-message present while keeping it empty. If you find yourself using this, you may want to reconsider your design.
def
IsInitialized(self):
1262 def IsInitialized(self, errors=None): 1263 """Checks if all required fields of a message are set. 1264 1265 Args: 1266 errors: A list which, if provided, will be populated with the field 1267 paths of all missing required fields. 1268 1269 Returns: 1270 True iff the specified message has all required fields set. 1271 """ 1272 1273 # Performance is critical so we avoid HasField() and ListFields(). 1274 1275 for field in required_fields: 1276 if (field not in self._fields or 1277 (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and 1278 not self._fields[field]._is_present_in_parent)): 1279 if errors is not None: 1280 errors.extend(self.FindInitializationErrors()) 1281 return False 1282 1283 for field, value in list(self._fields.items()): # dict can change size! 1284 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1285 if field.label == _FieldDescriptor.LABEL_REPEATED: 1286 if (field.message_type._is_map_entry): 1287 continue 1288 for element in value: 1289 if not element.IsInitialized(): 1290 if errors is not None: 1291 errors.extend(self.FindInitializationErrors()) 1292 return False 1293 elif value._is_present_in_parent and not value.IsInitialized(): 1294 if errors is not None: 1295 errors.extend(self.FindInitializationErrors()) 1296 return False 1297 1298 return True
Checks if the message is initialized.
Returns:
bool: The method returns True if the message is initialized (i.e. all of its required fields are set).
def
MergeFromString(self, serialized):
1177 def MergeFromString(self, serialized): 1178 serialized = memoryview(serialized) 1179 length = len(serialized) 1180 try: 1181 if self._InternalParse(serialized, 0, length) != length: 1182 # The only reason _InternalParse would return early is if it 1183 # encountered an end-group tag. 1184 raise message_mod.DecodeError('Unexpected end-group tag.') 1185 except (IndexError, TypeError): 1186 # Now ord(buf[p:p+1]) == ord('') gets TypeError. 1187 raise message_mod.DecodeError('Truncated message.') 1188 except struct.error as e: 1189 raise message_mod.DecodeError(e) 1190 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 belen(serialized), but for messages which are actually groups, this will generally be less thanlen(serialized), since we must stop when we reach anEND_GROUPtag. Note that if we do stop because of anEND_GROUPtag, the number of bytes returned does not include the bytes for theEND_GROUPtag information.
Raises:
- DecodeError: if the input cannot be parsed.
def
SerializeToString(self, **kwargs):
1130 def SerializeToString(self, **kwargs): 1131 # Check if the message has all of its required fields set. 1132 if not self.IsInitialized(): 1133 raise message_mod.EncodeError( 1134 'Message %s is missing required fields: %s' % ( 1135 self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors()))) 1136 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:
- EncodeError: if the message isn't initialized (see
IsInitialized()).
def
SerializePartialToString(self, **kwargs):
1143 def SerializePartialToString(self, **kwargs): 1144 out = BytesIO() 1145 self._InternalSerialize(out.write, **kwargs) 1146 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):
848 def ListFields(self): 849 all_fields = [item for item in self._fields.items() if _IsPresent(item)] 850 all_fields.sort(key = lambda item: item[0].number) 851 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: Literal['branching_priorities', b'branching_priorities', 'dual_values_filter', b'dual_values_filter', 'initial_basis', b'initial_basis', 'primary_objective_parameters', b'primary_objective_parameters', 'quadratic_dual_values_filter', b'quadratic_dual_values_filter', 'reduced_costs_filter', b'reduced_costs_filter', 'variable_values_filter', b'variable_values_filter']) -> bool:
872 def HasField(self, field_name): 873 try: 874 field = hassable_fields[field_name] 875 except KeyError as exc: 876 raise ValueError('Protocol message %s has no non-repeated field "%s" ' 877 'nor has presence is not available for this field.' % ( 878 message_descriptor.full_name, field_name)) from exc 879 880 if isinstance(field, descriptor_mod.OneofDescriptor): 881 try: 882 return HasField(self, self._oneofs[field].name) 883 except KeyError: 884 return False 885 else: 886 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 887 value = self._fields.get(field) 888 return value is not None and value._is_present_in_parent 889 else: 890 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_nameis not a member of this message.
def
ClearField( self, field_name: Literal['auxiliary_objective_parameters', b'auxiliary_objective_parameters', 'branching_priorities', b'branching_priorities', 'dual_values_filter', b'dual_values_filter', 'initial_basis', b'initial_basis', 'lazy_linear_constraint_ids', b'lazy_linear_constraint_ids', 'primary_objective_parameters', b'primary_objective_parameters', 'quadratic_dual_values_filter', b'quadratic_dual_values_filter', 'reduced_costs_filter', b'reduced_costs_filter', 'solution_hints', b'solution_hints', 'variable_values_filter', b'variable_values_filter']) -> None:
897 def ClearField(self, field_name): 898 try: 899 field = message_descriptor.fields_by_name[field_name] 900 except KeyError: 901 try: 902 field = message_descriptor.oneofs_by_name[field_name] 903 if field in self._oneofs: 904 field = self._oneofs[field] 905 else: 906 return 907 except KeyError: 908 raise ValueError('Protocol message %s has no "%s" field.' % 909 (message_descriptor.name, field_name)) 910 911 if field in self._fields: 912 # To match the C++ implementation, we need to invalidate iterators 913 # for map fields when ClearField() happens. 914 if hasattr(self._fields[field], 'InvalidateIterators'): 915 self._fields[field].InvalidateIterators() 916 917 # Note: If the field is a sub-message, its listener will still point 918 # at us. That's fine, because the worst than can happen is that it 919 # will call _Modified() and invalidate our byte size. Big deal. 920 del self._fields[field] 921 922 if self._oneofs.get(field.containing_oneof, None) is field: 923 del self._oneofs[field.containing_oneof] 924 925 # Always call _Modified() -- even if nothing was changed, this is 926 # a mutating method, and thus calling it should cause the field to become 927 # present in the parent message. 928 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_nameis not a member of this message.
def
WhichOneof(self, oneof_group):
1403 def WhichOneof(self, oneof_name): 1404 """Returns the name of the currently set field inside a oneof, or None.""" 1405 try: 1406 field = message_descriptor.oneofs_by_name[oneof_name] 1407 except KeyError: 1408 raise ValueError( 1409 'Protocol message has no oneof "%s" field.' % oneof_name) 1410 1411 nested_field = self._oneofs.get(field, None) 1412 if nested_field is not None and self.HasField(nested_field.name): 1413 return nested_field.name 1414 else: 1415 return None
Returns the name of the field that is set inside a oneof group.
If no field is set, returns None.
Arguments:
- oneof_group (str): the name of the oneof group to check.
Returns:
str or None: The name of the group that is set, or None.
Raises:
- ValueError: no group with the given name exists
def
DiscardUnknownFields(self):
1435def _DiscardUnknownFields(self): 1436 self._unknown_fields = [] 1437 for field, value in self.ListFields(): 1438 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1439 if _IsMapField(field): 1440 if _IsMessageMapField(field): 1441 for key in value: 1442 value[key].DiscardUnknownFields() 1443 elif field.label == _FieldDescriptor.LABEL_REPEATED: 1444 for sub_message in value: 1445 sub_message.DiscardUnknownFields() 1446 else: 1447 value.DiscardUnknownFields()
Clears all fields in the UnknownFieldSet.
This operation is recursive for nested message.
def
ByteSize(self):
1098 def ByteSize(self): 1099 if not self._cached_byte_size_dirty: 1100 return self._cached_byte_size 1101 1102 size = 0 1103 descriptor = self.DESCRIPTOR 1104 if descriptor._is_map_entry: 1105 # Fields of map entry should always be serialized. 1106 key_field = descriptor.fields_by_name['key'] 1107 _MaybeAddEncoder(cls, key_field) 1108 size = key_field._sizer(self.key) 1109 value_field = descriptor.fields_by_name['value'] 1110 _MaybeAddEncoder(cls, value_field) 1111 size += value_field._sizer(self.value) 1112 else: 1113 for field_descriptor, field_value in self.ListFields(): 1114 _MaybeAddEncoder(cls, field_descriptor) 1115 size += field_descriptor._sizer(field_value) 1116 for tag_bytes, value_bytes in self._unknown_fields: 1117 size += len(tag_bytes) + len(value_bytes) 1118 1119 self._cached_byte_size = size 1120 self._cached_byte_size_dirty = False 1121 self._listener_for_children.dirty = False 1122 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.
variable_values_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
Filter that is applied to all returned sparse containers keyed by variables in PrimalSolutionProto and PrimalRayProto (PrimalSolutionProto.variable_values, PrimalRayProto.variable_values).
Requirements:
- filtered_ids are elements of VariablesProto.ids.
dual_values_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
Filter that is applied to all returned sparse containers keyed by linear constraints in DualSolutionProto and DualRay (DualSolutionProto.dual_values, DualRay.dual_values).
Requirements:
- filtered_ids are elements of LinearConstraints.ids.
quadratic_dual_values_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
Filter that is applied to all returned sparse containers keyed by quadratic constraints in DualSolutionProto and DualRay (DualSolutionProto.quadratic_dual_values, DualRay.quadratic_dual_values).
Requirements:
- filtered_ids are keys of ModelProto.quadratic_constraints.
reduced_costs_filter: ortools.math_opt.sparse_containers_pb2.SparseVectorFilterProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
Filter that is applied to all returned sparse containers keyed by variables in DualSolutionProto and DualRay (DualSolutionProto.reduced_costs, DualRay.reduced_costs).
Requirements:
- filtered_ids are elements of VariablesProto.ids.
initial_basis: ortools.math_opt.solution_pb2.BasisProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
Optional initial basis for warm starting simplex LP solvers. If set, it is
expected to be valid according to ValidateBasis in
validators/solution_validator.h for the current ModelSummary.
solution_hints: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[SolutionHintProto]
668 def getter(self): 669 field_value = self._fields.get(field) 670 if field_value is None: 671 # Construct a new object to represent this field. 672 field_value = field._default_constructor(self) 673 674 # Atomically check if another thread has preempted us and, if not, swap 675 # in the new object we just created. If someone has preempted us, we 676 # take that object and discard ours. 677 # WARNING: We are relying on setdefault() being atomic. This is true 678 # in CPython but we haven't investigated others. This warning appears 679 # in several other locations in this file. 680 field_value = self._fields.setdefault(field, field_value) 681 return field_value
Optional solution hints. If the underlying solver only accepts a single hint, the first hint is used.
branching_priorities: ortools.math_opt.sparse_containers_pb2.SparseInt32VectorProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
Optional branching priorities. Variables with higher values will be branched on first. Variables for which priorities are not set get the solver's default priority (usually zero).
Requirements:
- branching_priorities.values must be finite.
- branching_priorities.ids must be elements of VariablesProto.ids.
primary_objective_parameters: ObjectiveParametersProto
767 def getter(self): 768 field_value = self._fields.get(field) 769 if field_value is None: 770 # Construct a new object to represent this field. 771 field_value = field._default_constructor(self) 772 773 # Atomically check if another thread has preempted us and, if not, swap 774 # in the new object we just created. If someone has preempted us, we 775 # take that object and discard ours. 776 # WARNING: We are relying on setdefault() being atomic. This is true 777 # in CPython but we haven't investigated others. This warning appears 778 # in several other locations in this file. 779 field_value = self._fields.setdefault(field, field_value) 780 return field_value
Optional parameters for the primary objective in a multi-objective model.
auxiliary_objective_parameters: google.protobuf.internal.containers.MessageMap[int, ObjectiveParametersProto]
668 def getter(self): 669 field_value = self._fields.get(field) 670 if field_value is None: 671 # Construct a new object to represent this field. 672 field_value = field._default_constructor(self) 673 674 # Atomically check if another thread has preempted us and, if not, swap 675 # in the new object we just created. If someone has preempted us, we 676 # take that object and discard ours. 677 # WARNING: We are relying on setdefault() being atomic. This is true 678 # in CPython but we haven't investigated others. This warning appears 679 # in several other locations in this file. 680 field_value = self._fields.setdefault(field, field_value) 681 return field_value
Optional parameters for the auxiliary objectives in a multi-objective model.
Requirements:
- Map keys must also be map keys of ModelProto.auxiliary_objectives.
lazy_linear_constraint_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int]
668 def getter(self): 669 field_value = self._fields.get(field) 670 if field_value is None: 671 # Construct a new object to represent this field. 672 field_value = field._default_constructor(self) 673 674 # Atomically check if another thread has preempted us and, if not, swap 675 # in the new object we just created. If someone has preempted us, we 676 # take that object and discard ours. 677 # WARNING: We are relying on setdefault() being atomic. This is true 678 # in CPython but we haven't investigated others. This warning appears 679 # in several other locations in this file. 680 field_value = self._fields.setdefault(field, field_value) 681 return field_value
Optional lazy constraint annotations. Included linear constraints will be marked as "lazy" with supporting solvers, meaning that they will only be added to the working model as-needed as the solver runs.
Note that this an algorithmic hint that does not affect the model's feasible region; solvers not supporting these annotations will simply ignore it.
Requirements:
- Each entry must be an element of VariablesProto.ids.
- Entries must be in strictly increasing order (i.e., sorted, no repeats).
def
FindInitializationErrors(self):
1302 def FindInitializationErrors(self): 1303 """Finds required fields which are not initialized. 1304 1305 Returns: 1306 A list of strings. Each string is a path to an uninitialized field from 1307 the top-level message, e.g. "foo.bar[5].baz". 1308 """ 1309 1310 errors = [] # simplify things 1311 1312 for field in required_fields: 1313 if not self.HasField(field.name): 1314 errors.append(field.name) 1315 1316 for field, value in self.ListFields(): 1317 if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE: 1318 if field.is_extension: 1319 name = '(%s)' % field.full_name 1320 else: 1321 name = field.name 1322 1323 if _IsMapField(field): 1324 if _IsMessageMapField(field): 1325 for key in value: 1326 element = value[key] 1327 prefix = '%s[%s].' % (name, key) 1328 sub_errors = element.FindInitializationErrors() 1329 errors += [prefix + error for error in sub_errors] 1330 else: 1331 # ScalarMaps can't have any initialization errors. 1332 pass 1333 elif field.label == _FieldDescriptor.LABEL_REPEATED: 1334 for i in range(len(value)): 1335 element = value[i] 1336 prefix = '%s[%d].' % (name, i) 1337 sub_errors = element.FindInitializationErrors() 1338 errors += [prefix + error for error in sub_errors] 1339 else: 1340 prefix = name + '.' 1341 sub_errors = value.FindInitializationErrors() 1342 errors += [prefix + error for error in sub_errors] 1343 1344 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
- UnknownFields
class
ModelSolveParametersProto.AuxiliaryObjectiveParametersEntry(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.
Inherited Members
- AuxiliaryObjectiveParametersEntry
- AuxiliaryObjectiveParametersEntry
- DESCRIPTOR
- MergeFrom
- Clear
- SetInParent
- IsInitialized
- MergeFromString
- SerializeToString
- SerializePartialToString
- ListFields
- HasField
- ClearField
- WhichOneof
- DiscardUnknownFields
- ByteSize
- FromString
- KEY_FIELD_NUMBER
- key
- VALUE_FIELD_NUMBER
- value
- FindInitializationErrors
- google.protobuf.message.Message
- CopyFrom
- ParseFromString
- HasExtension
- ClearExtension
- UnknownFields