ortools.sat.boolean_problem_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file Protocol buffer to encode a Boolean satisfiability/optimization problem.

 1# -*- coding: utf-8 -*-
 2# Generated by the protocol buffer compiler.  DO NOT EDIT!
 3# NO CHECKED-IN PROTOBUF GENCODE
 4# source: ortools/sat/boolean_problem.proto
 5# Protobuf Python Version: 5.29.3
 6"""Generated protocol buffer code."""
 7from google.protobuf import descriptor as _descriptor
 8from google.protobuf import descriptor_pool as _descriptor_pool
 9from google.protobuf import runtime_version as _runtime_version
10from google.protobuf import symbol_database as _symbol_database
11from google.protobuf.internal import builder as _builder
12_runtime_version.ValidateProtobufRuntimeVersion(
13    _runtime_version.Domain.PUBLIC,
14    5,
15    29,
16    3,
17    '',
18    'ortools/sat/boolean_problem.proto'
19)
20# @@protoc_insertion_point(imports)
21
22_sym_db = _symbol_database.Default()
23
24
25
26
27DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n!ortools/sat/boolean_problem.proto\x12\x17operations_research.sat\"{\n\x17LinearBooleanConstraint\x12\x10\n\x08literals\x18\x01 \x03(\x05\x12\x14\n\x0c\x63oefficients\x18\x02 \x03(\x03\x12\x13\n\x0blower_bound\x18\x03 \x01(\x03\x12\x13\n\x0bupper_bound\x18\x04 \x01(\x03\x12\x0e\n\x04name\x18\x05 \x01(\t:\x00\"g\n\x0fLinearObjective\x12\x10\n\x08literals\x18\x01 \x03(\x05\x12\x14\n\x0c\x63oefficients\x18\x02 \x03(\x03\x12\x11\n\x06offset\x18\x03 \x01(\x01:\x01\x30\x12\x19\n\x0escaling_factor\x18\x04 \x01(\x01:\x01\x31\"%\n\x11\x42ooleanAssignment\x12\x10\n\x08literals\x18\x01 \x03(\x05\"\xb4\x02\n\x14LinearBooleanProblem\x12\x0e\n\x04name\x18\x01 \x01(\t:\x00\x12\x15\n\rnum_variables\x18\x03 \x01(\x05\x12\x45\n\x0b\x63onstraints\x18\x04 \x03(\x0b\x32\x30.operations_research.sat.LinearBooleanConstraint\x12;\n\tobjective\x18\x05 \x01(\x0b\x32(.operations_research.sat.LinearObjective\x12\x11\n\tvar_names\x18\x06 \x03(\t\x12>\n\nassignment\x18\x07 \x01(\x0b\x32*.operations_research.sat.BooleanAssignment\x12\x1e\n\x16original_num_variables\x18\x08 \x01(\x05\x42/\n\x16\x63om.google.ortools.satP\x01\xaa\x02\x12Google.OrTools.Sat')
28
29_globals = globals()
30_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
31_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'ortools.sat.boolean_problem_pb2', _globals)
32if not _descriptor._USE_C_DESCRIPTORS:
33  _globals['DESCRIPTOR']._loaded_options = None
34  _globals['DESCRIPTOR']._serialized_options = b'\n\026com.google.ortools.satP\001\252\002\022Google.OrTools.Sat'
35  _globals['_LINEARBOOLEANCONSTRAINT']._serialized_start=62
36  _globals['_LINEARBOOLEANCONSTRAINT']._serialized_end=185
37  _globals['_LINEAROBJECTIVE']._serialized_start=187
38  _globals['_LINEAROBJECTIVE']._serialized_end=290
39  _globals['_BOOLEANASSIGNMENT']._serialized_start=292
40  _globals['_BOOLEANASSIGNMENT']._serialized_end=329
41  _globals['_LINEARBOOLEANPROBLEM']._serialized_start=332
42  _globals['_LINEARBOOLEANPROBLEM']._serialized_end=640
43# @@protoc_insertion_point(module_scope)
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor = <google.protobuf.descriptor.FileDescriptor object>
class LinearBooleanConstraint(google.protobuf.message.Message):

A linear Boolean constraint which is a bounded sum of linear terms. Each term beeing a literal times an integer coefficient. If we assume that a literal takes the value 1 if it is true and 0 otherwise, the constraint is: lower_bound <= ... + coefficients[i] * literals[i] + ... <= upper_bound

LinearBooleanConstraint( *, literals: Iterable[int] | None = Ellipsis, coefficients: Iterable[int] | None = Ellipsis, lower_bound: int | None = Ellipsis, upper_bound: int | None = Ellipsis, name: str | 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 != None:
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)
DESCRIPTOR: google.protobuf.descriptor.Descriptor = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, other_msg): 
1364  def MergeFrom(self, msg):
1365    if not isinstance(msg, cls):
1366      raise TypeError(
1367          'Parameter to MergeFrom() must be instance of same class: '
1368          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1369                                   _FullyQualifiedClassName(msg.__class__)))
1370
1371    assert msg is not self
1372    self._Modified()
1373
1374    fields = self._fields
1375
1376    for field, value in msg._fields.items():
1377      if field.label == LABEL_REPEATED:
1378        field_value = fields.get(field)
1379        if field_value is None:
1380          # Construct a new object to represent this field.
1381          field_value = field._default_constructor(self)
1382          fields[field] = field_value
1383        field_value.MergeFrom(value)
1384      elif field.cpp_type == CPPTYPE_MESSAGE:
1385        if value._is_present_in_parent:
1386          field_value = fields.get(field)
1387          if field_value is None:
1388            # Construct a new object to represent this field.
1389            field_value = field._default_constructor(self)
1390            fields[field] = field_value
1391          field_value.MergeFrom(value)
1392      else:
1393        self._fields[field] = value
1394        if field.containing_oneof:
1395          self._UpdateOneofState(field)
1396
1397    if msg._unknown_fields:
1398      if not self._unknown_fields:
1399        self._unknown_fields = []
1400      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): 
1423def _Clear(self):
1424  # Clear fields.
1425  self._fields = {}
1426  self._unknown_fields = ()
1427
1428  self._oneofs = {}
1429  self._Modified()

Clears all data that was set in the message.

def SetInParent(self): 
1489  def Modified(self):
1490    """Sets the _cached_byte_size_dirty bit to true,
1491    and propagates this to our listener iff this was a state change.
1492    """
1493
1494    # Note:  Some callers check _cached_byte_size_dirty before calling
1495    #   _Modified() as an extra optimization.  So, if this method is ever
1496    #   changed such that it does stuff even when _cached_byte_size_dirty is
1497    #   already true, the callers need to be updated.
1498    if not self._cached_byte_size_dirty:
1499      self._cached_byte_size_dirty = True
1500      self._listener_for_children.dirty = True
1501      self._is_present_in_parent = True
1502      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): 
1265  def IsInitialized(self, errors=None):
1266    """Checks if all required fields of a message are set.
1267
1268    Args:
1269      errors:  A list which, if provided, will be populated with the field
1270               paths of all missing required fields.
1271
1272    Returns:
1273      True iff the specified message has all required fields set.
1274    """
1275
1276    # Performance is critical so we avoid HasField() and ListFields().
1277
1278    for field in required_fields:
1279      if (field not in self._fields or
1280          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1281           not self._fields[field]._is_present_in_parent)):
1282        if errors is not None:
1283          errors.extend(self.FindInitializationErrors())
1284        return False
1285
1286    for field, value in list(self._fields.items()):  # dict can change size!
1287      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1288        if field.label == _FieldDescriptor.LABEL_REPEATED:
1289          if (field.message_type._is_map_entry):
1290            continue
1291          for element in value:
1292            if not element.IsInitialized():
1293              if errors is not None:
1294                errors.extend(self.FindInitializationErrors())
1295              return False
1296        elif value._is_present_in_parent and not value.IsInitialized():
1297          if errors is not None:
1298            errors.extend(self.FindInitializationErrors())
1299          return False
1300
1301    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): 
1180  def MergeFromString(self, serialized):
1181    serialized = memoryview(serialized)
1182    length = len(serialized)
1183    try:
1184      if self._InternalParse(serialized, 0, length) != length:
1185        # The only reason _InternalParse would return early is if it
1186        # encountered an end-group tag.
1187        raise message_mod.DecodeError('Unexpected end-group tag.')
1188    except (IndexError, TypeError):
1189      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1190      raise message_mod.DecodeError('Truncated message.')
1191    except struct.error as e:
1192      raise message_mod.DecodeError(e)
1193    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): 
1133  def SerializeToString(self, **kwargs):
1134    # Check if the message has all of its required fields set.
1135    if not self.IsInitialized():
1136      raise message_mod.EncodeError(
1137          'Message %s is missing required fields: %s' % (
1138          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1139    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): 
1146  def SerializePartialToString(self, **kwargs):
1147    out = BytesIO()
1148    self._InternalSerialize(out.write, **kwargs)
1149    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['lower_bound', b'lower_bound', 'name', b'name', 'upper_bound', b'upper_bound']) -> 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_name is not a member of this message.
def ClearField( self, field_name: Literal['coefficients', b'coefficients', 'literals', b'literals', 'lower_bound', b'lower_bound', 'name', b'name', 'upper_bound', b'upper_bound']) -> 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_name is not a member of this message.
def WhichOneof(self, oneof_group): 
1406  def WhichOneof(self, oneof_name):
1407    """Returns the name of the currently set field inside a oneof, or None."""
1408    try:
1409      field = message_descriptor.oneofs_by_name[oneof_name]
1410    except KeyError:
1411      raise ValueError(
1412          'Protocol message has no oneof "%s" field.' % oneof_name)
1413
1414    nested_field = self._oneofs.get(field, None)
1415    if nested_field is not None and self.HasField(nested_field.name):
1416      return nested_field.name
1417    else:
1418      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): 
1438def _DiscardUnknownFields(self):
1439  self._unknown_fields = []
1440  for field, value in self.ListFields():
1441    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1442      if _IsMapField(field):
1443        if _IsMessageMapField(field):
1444          for key in value:
1445            value[key].DiscardUnknownFields()
1446      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1447        for sub_message in value:
1448          sub_message.DiscardUnknownFields()
1449      else:
1450        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self): 
1101  def ByteSize(self):
1102    if not self._cached_byte_size_dirty:
1103      return self._cached_byte_size
1104
1105    size = 0
1106    descriptor = self.DESCRIPTOR
1107    if descriptor._is_map_entry:
1108      # Fields of map entry should always be serialized.
1109      key_field = descriptor.fields_by_name['key']
1110      _MaybeAddEncoder(cls, key_field)
1111      size = key_field._sizer(self.key)
1112      value_field = descriptor.fields_by_name['value']
1113      _MaybeAddEncoder(cls, value_field)
1114      size += value_field._sizer(self.value)
1115    else:
1116      for field_descriptor, field_value in self.ListFields():
1117        _MaybeAddEncoder(cls, field_descriptor)
1118        size += field_descriptor._sizer(field_value)
1119      for tag_bytes, value_bytes in self._unknown_fields:
1120        size += len(tag_bytes) + len(value_bytes)
1121
1122    self._cached_byte_size = size
1123    self._cached_byte_size_dirty = False
1124    self._listener_for_children.dirty = False
1125    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(cls, s): 
826  def FromString(s):
827    message = cls()
828    message.MergeFromString(s)
829    return message
LITERALS_FIELD_NUMBER: int = 1
literals: 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

Linear terms involved in this constraint.

literals[i] is the signed representation of the i-th literal of the constraint and coefficients[i] its coefficients. The signed representation is as follow: for a 0-based variable index x, (x + 1) represents the variable x and -(x + 1) represents its negation.

Note that the same variable shouldn't appear twice and that zero coefficients are not allowed.

COEFFICIENTS_FIELD_NUMBER: int = 2
coefficients: 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

Getter for coefficients.

LOWER_BOUND_FIELD_NUMBER: int = 3
lower_bound: int 
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 lower (resp. upper) bound of the constraint. If not present, it means that the constraint is not bounded in this direction. The bounds are INCLUSIVE.

UPPER_BOUND_FIELD_NUMBER: int = 4
upper_bound: int 
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)

Getter for upper_bound.

NAME_FIELD_NUMBER: int = 5
name: str 
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)

The name of this constraint.

def FindInitializationErrors(self): 
1305  def FindInitializationErrors(self):
1306    """Finds required fields which are not initialized.
1307
1308    Returns:
1309      A list of strings.  Each string is a path to an uninitialized field from
1310      the top-level message, e.g. "foo.bar[5].baz".
1311    """
1312
1313    errors = []  # simplify things
1314
1315    for field in required_fields:
1316      if not self.HasField(field.name):
1317        errors.append(field.name)
1318
1319    for field, value in self.ListFields():
1320      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1321        if field.is_extension:
1322          name = '(%s)' % field.full_name
1323        else:
1324          name = field.name
1325
1326        if _IsMapField(field):
1327          if _IsMessageMapField(field):
1328            for key in value:
1329              element = value[key]
1330              prefix = '%s[%s].' % (name, key)
1331              sub_errors = element.FindInitializationErrors()
1332              errors += [prefix + error for error in sub_errors]
1333          else:
1334            # ScalarMaps can't have any initialization errors.
1335            pass
1336        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1337          for i in range(len(value)):
1338            element = value[i]
1339            prefix = '%s[%d].' % (name, i)
1340            sub_errors = element.FindInitializationErrors()
1341            errors += [prefix + error for error in sub_errors]
1342        else:
1343          prefix = name + '.'
1344          sub_errors = value.FindInitializationErrors()
1345          errors += [prefix + error for error in sub_errors]
1346
1347    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".

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

The objective of an optimization problem.

LinearObjective( *, literals: Iterable[int] | None = Ellipsis, coefficients: Iterable[int] | None = Ellipsis, offset: float | None = Ellipsis, scaling_factor: 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 != None:
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)
DESCRIPTOR: google.protobuf.descriptor.Descriptor = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, other_msg): 
1364  def MergeFrom(self, msg):
1365    if not isinstance(msg, cls):
1366      raise TypeError(
1367          'Parameter to MergeFrom() must be instance of same class: '
1368          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1369                                   _FullyQualifiedClassName(msg.__class__)))
1370
1371    assert msg is not self
1372    self._Modified()
1373
1374    fields = self._fields
1375
1376    for field, value in msg._fields.items():
1377      if field.label == LABEL_REPEATED:
1378        field_value = fields.get(field)
1379        if field_value is None:
1380          # Construct a new object to represent this field.
1381          field_value = field._default_constructor(self)
1382          fields[field] = field_value
1383        field_value.MergeFrom(value)
1384      elif field.cpp_type == CPPTYPE_MESSAGE:
1385        if value._is_present_in_parent:
1386          field_value = fields.get(field)
1387          if field_value is None:
1388            # Construct a new object to represent this field.
1389            field_value = field._default_constructor(self)
1390            fields[field] = field_value
1391          field_value.MergeFrom(value)
1392      else:
1393        self._fields[field] = value
1394        if field.containing_oneof:
1395          self._UpdateOneofState(field)
1396
1397    if msg._unknown_fields:
1398      if not self._unknown_fields:
1399        self._unknown_fields = []
1400      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): 
1423def _Clear(self):
1424  # Clear fields.
1425  self._fields = {}
1426  self._unknown_fields = ()
1427
1428  self._oneofs = {}
1429  self._Modified()

Clears all data that was set in the message.

def SetInParent(self): 
1489  def Modified(self):
1490    """Sets the _cached_byte_size_dirty bit to true,
1491    and propagates this to our listener iff this was a state change.
1492    """
1493
1494    # Note:  Some callers check _cached_byte_size_dirty before calling
1495    #   _Modified() as an extra optimization.  So, if this method is ever
1496    #   changed such that it does stuff even when _cached_byte_size_dirty is
1497    #   already true, the callers need to be updated.
1498    if not self._cached_byte_size_dirty:
1499      self._cached_byte_size_dirty = True
1500      self._listener_for_children.dirty = True
1501      self._is_present_in_parent = True
1502      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): 
1265  def IsInitialized(self, errors=None):
1266    """Checks if all required fields of a message are set.
1267
1268    Args:
1269      errors:  A list which, if provided, will be populated with the field
1270               paths of all missing required fields.
1271
1272    Returns:
1273      True iff the specified message has all required fields set.
1274    """
1275
1276    # Performance is critical so we avoid HasField() and ListFields().
1277
1278    for field in required_fields:
1279      if (field not in self._fields or
1280          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1281           not self._fields[field]._is_present_in_parent)):
1282        if errors is not None:
1283          errors.extend(self.FindInitializationErrors())
1284        return False
1285
1286    for field, value in list(self._fields.items()):  # dict can change size!
1287      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1288        if field.label == _FieldDescriptor.LABEL_REPEATED:
1289          if (field.message_type._is_map_entry):
1290            continue
1291          for element in value:
1292            if not element.IsInitialized():
1293              if errors is not None:
1294                errors.extend(self.FindInitializationErrors())
1295              return False
1296        elif value._is_present_in_parent and not value.IsInitialized():
1297          if errors is not None:
1298            errors.extend(self.FindInitializationErrors())
1299          return False
1300
1301    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): 
1180  def MergeFromString(self, serialized):
1181    serialized = memoryview(serialized)
1182    length = len(serialized)
1183    try:
1184      if self._InternalParse(serialized, 0, length) != length:
1185        # The only reason _InternalParse would return early is if it
1186        # encountered an end-group tag.
1187        raise message_mod.DecodeError('Unexpected end-group tag.')
1188    except (IndexError, TypeError):
1189      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1190      raise message_mod.DecodeError('Truncated message.')
1191    except struct.error as e:
1192      raise message_mod.DecodeError(e)
1193    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): 
1133  def SerializeToString(self, **kwargs):
1134    # Check if the message has all of its required fields set.
1135    if not self.IsInitialized():
1136      raise message_mod.EncodeError(
1137          'Message %s is missing required fields: %s' % (
1138          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1139    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): 
1146  def SerializePartialToString(self, **kwargs):
1147    out = BytesIO()
1148    self._InternalSerialize(out.write, **kwargs)
1149    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['offset', b'offset', 'scaling_factor', b'scaling_factor']) -> 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_name is not a member of this message.
def ClearField( self, field_name: Literal['coefficients', b'coefficients', 'literals', b'literals', 'offset', b'offset', 'scaling_factor', b'scaling_factor']) -> 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_name is not a member of this message.
def WhichOneof(self, oneof_group): 
1406  def WhichOneof(self, oneof_name):
1407    """Returns the name of the currently set field inside a oneof, or None."""
1408    try:
1409      field = message_descriptor.oneofs_by_name[oneof_name]
1410    except KeyError:
1411      raise ValueError(
1412          'Protocol message has no oneof "%s" field.' % oneof_name)
1413
1414    nested_field = self._oneofs.get(field, None)
1415    if nested_field is not None and self.HasField(nested_field.name):
1416      return nested_field.name
1417    else:
1418      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): 
1438def _DiscardUnknownFields(self):
1439  self._unknown_fields = []
1440  for field, value in self.ListFields():
1441    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1442      if _IsMapField(field):
1443        if _IsMessageMapField(field):
1444          for key in value:
1445            value[key].DiscardUnknownFields()
1446      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1447        for sub_message in value:
1448          sub_message.DiscardUnknownFields()
1449      else:
1450        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self): 
1101  def ByteSize(self):
1102    if not self._cached_byte_size_dirty:
1103      return self._cached_byte_size
1104
1105    size = 0
1106    descriptor = self.DESCRIPTOR
1107    if descriptor._is_map_entry:
1108      # Fields of map entry should always be serialized.
1109      key_field = descriptor.fields_by_name['key']
1110      _MaybeAddEncoder(cls, key_field)
1111      size = key_field._sizer(self.key)
1112      value_field = descriptor.fields_by_name['value']
1113      _MaybeAddEncoder(cls, value_field)
1114      size += value_field._sizer(self.value)
1115    else:
1116      for field_descriptor, field_value in self.ListFields():
1117        _MaybeAddEncoder(cls, field_descriptor)
1118        size += field_descriptor._sizer(field_value)
1119      for tag_bytes, value_bytes in self._unknown_fields:
1120        size += len(tag_bytes) + len(value_bytes)
1121
1122    self._cached_byte_size = size
1123    self._cached_byte_size_dirty = False
1124    self._listener_for_children.dirty = False
1125    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(cls, s): 
826  def FromString(s):
827    message = cls()
828    message.MergeFromString(s)
829    return message
LITERALS_FIELD_NUMBER: int = 1
literals: 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

The goal is always to minimize the linear Boolean formula defined by these two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff literal_i is true in a given assignment.

Note that the same variable shouldn't appear twice and that zero coefficients are not allowed.

COEFFICIENTS_FIELD_NUMBER: int = 2
coefficients: 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

Getter for coefficients.

OFFSET_FIELD_NUMBER: int = 3
offset: 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)

For a given variable assignment, the "real" problem objective value is 'scaling_factor * (minimization_objective + offset)' where 'minimization_objective is the one defined just above.

Note that this is not what we minimize, but it is what we display. In particular if scaling_factor is negative, then the "real" problem is a maximization problem, even if the "internal" objective is minimized.

SCALING_FACTOR_FIELD_NUMBER: int = 4
scaling_factor: 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)

Getter for scaling_factor.

def FindInitializationErrors(self): 
1305  def FindInitializationErrors(self):
1306    """Finds required fields which are not initialized.
1307
1308    Returns:
1309      A list of strings.  Each string is a path to an uninitialized field from
1310      the top-level message, e.g. "foo.bar[5].baz".
1311    """
1312
1313    errors = []  # simplify things
1314
1315    for field in required_fields:
1316      if not self.HasField(field.name):
1317        errors.append(field.name)
1318
1319    for field, value in self.ListFields():
1320      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1321        if field.is_extension:
1322          name = '(%s)' % field.full_name
1323        else:
1324          name = field.name
1325
1326        if _IsMapField(field):
1327          if _IsMessageMapField(field):
1328            for key in value:
1329              element = value[key]
1330              prefix = '%s[%s].' % (name, key)
1331              sub_errors = element.FindInitializationErrors()
1332              errors += [prefix + error for error in sub_errors]
1333          else:
1334            # ScalarMaps can't have any initialization errors.
1335            pass
1336        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1337          for i in range(len(value)):
1338            element = value[i]
1339            prefix = '%s[%d].' % (name, i)
1340            sub_errors = element.FindInitializationErrors()
1341            errors += [prefix + error for error in sub_errors]
1342        else:
1343          prefix = name + '.'
1344          sub_errors = value.FindInitializationErrors()
1345          errors += [prefix + error for error in sub_errors]
1346
1347    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".

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

Stores an assignment of variables as a list of true literals using their signed representation. There will be at most one literal per variable. The literals will be sorted by increasing variable index. The assignment may be partial in the sense that some variables may not appear and thus not be assigned.

BooleanAssignment(*, literals: 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 != None:
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)
DESCRIPTOR: google.protobuf.descriptor.Descriptor = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, other_msg): 
1364  def MergeFrom(self, msg):
1365    if not isinstance(msg, cls):
1366      raise TypeError(
1367          'Parameter to MergeFrom() must be instance of same class: '
1368          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1369                                   _FullyQualifiedClassName(msg.__class__)))
1370
1371    assert msg is not self
1372    self._Modified()
1373
1374    fields = self._fields
1375
1376    for field, value in msg._fields.items():
1377      if field.label == LABEL_REPEATED:
1378        field_value = fields.get(field)
1379        if field_value is None:
1380          # Construct a new object to represent this field.
1381          field_value = field._default_constructor(self)
1382          fields[field] = field_value
1383        field_value.MergeFrom(value)
1384      elif field.cpp_type == CPPTYPE_MESSAGE:
1385        if value._is_present_in_parent:
1386          field_value = fields.get(field)
1387          if field_value is None:
1388            # Construct a new object to represent this field.
1389            field_value = field._default_constructor(self)
1390            fields[field] = field_value
1391          field_value.MergeFrom(value)
1392      else:
1393        self._fields[field] = value
1394        if field.containing_oneof:
1395          self._UpdateOneofState(field)
1396
1397    if msg._unknown_fields:
1398      if not self._unknown_fields:
1399        self._unknown_fields = []
1400      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): 
1423def _Clear(self):
1424  # Clear fields.
1425  self._fields = {}
1426  self._unknown_fields = ()
1427
1428  self._oneofs = {}
1429  self._Modified()

Clears all data that was set in the message.

def SetInParent(self): 
1489  def Modified(self):
1490    """Sets the _cached_byte_size_dirty bit to true,
1491    and propagates this to our listener iff this was a state change.
1492    """
1493
1494    # Note:  Some callers check _cached_byte_size_dirty before calling
1495    #   _Modified() as an extra optimization.  So, if this method is ever
1496    #   changed such that it does stuff even when _cached_byte_size_dirty is
1497    #   already true, the callers need to be updated.
1498    if not self._cached_byte_size_dirty:
1499      self._cached_byte_size_dirty = True
1500      self._listener_for_children.dirty = True
1501      self._is_present_in_parent = True
1502      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): 
1265  def IsInitialized(self, errors=None):
1266    """Checks if all required fields of a message are set.
1267
1268    Args:
1269      errors:  A list which, if provided, will be populated with the field
1270               paths of all missing required fields.
1271
1272    Returns:
1273      True iff the specified message has all required fields set.
1274    """
1275
1276    # Performance is critical so we avoid HasField() and ListFields().
1277
1278    for field in required_fields:
1279      if (field not in self._fields or
1280          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1281           not self._fields[field]._is_present_in_parent)):
1282        if errors is not None:
1283          errors.extend(self.FindInitializationErrors())
1284        return False
1285
1286    for field, value in list(self._fields.items()):  # dict can change size!
1287      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1288        if field.label == _FieldDescriptor.LABEL_REPEATED:
1289          if (field.message_type._is_map_entry):
1290            continue
1291          for element in value:
1292            if not element.IsInitialized():
1293              if errors is not None:
1294                errors.extend(self.FindInitializationErrors())
1295              return False
1296        elif value._is_present_in_parent and not value.IsInitialized():
1297          if errors is not None:
1298            errors.extend(self.FindInitializationErrors())
1299          return False
1300
1301    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): 
1180  def MergeFromString(self, serialized):
1181    serialized = memoryview(serialized)
1182    length = len(serialized)
1183    try:
1184      if self._InternalParse(serialized, 0, length) != length:
1185        # The only reason _InternalParse would return early is if it
1186        # encountered an end-group tag.
1187        raise message_mod.DecodeError('Unexpected end-group tag.')
1188    except (IndexError, TypeError):
1189      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1190      raise message_mod.DecodeError('Truncated message.')
1191    except struct.error as e:
1192      raise message_mod.DecodeError(e)
1193    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): 
1133  def SerializeToString(self, **kwargs):
1134    # Check if the message has all of its required fields set.
1135    if not self.IsInitialized():
1136      raise message_mod.EncodeError(
1137          'Message %s is missing required fields: %s' % (
1138          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1139    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): 
1146  def SerializePartialToString(self, **kwargs):
1147    out = BytesIO()
1148    self._InternalSerialize(out.write, **kwargs)
1149    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): 
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_name is not a member of this message.
def ClearField(self, field_name: Literal['literals', b'literals']) -> 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_name is not a member of this message.
def WhichOneof(self, oneof_group): 
1406  def WhichOneof(self, oneof_name):
1407    """Returns the name of the currently set field inside a oneof, or None."""
1408    try:
1409      field = message_descriptor.oneofs_by_name[oneof_name]
1410    except KeyError:
1411      raise ValueError(
1412          'Protocol message has no oneof "%s" field.' % oneof_name)
1413
1414    nested_field = self._oneofs.get(field, None)
1415    if nested_field is not None and self.HasField(nested_field.name):
1416      return nested_field.name
1417    else:
1418      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): 
1438def _DiscardUnknownFields(self):
1439  self._unknown_fields = []
1440  for field, value in self.ListFields():
1441    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1442      if _IsMapField(field):
1443        if _IsMessageMapField(field):
1444          for key in value:
1445            value[key].DiscardUnknownFields()
1446      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1447        for sub_message in value:
1448          sub_message.DiscardUnknownFields()
1449      else:
1450        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self): 
1101  def ByteSize(self):
1102    if not self._cached_byte_size_dirty:
1103      return self._cached_byte_size
1104
1105    size = 0
1106    descriptor = self.DESCRIPTOR
1107    if descriptor._is_map_entry:
1108      # Fields of map entry should always be serialized.
1109      key_field = descriptor.fields_by_name['key']
1110      _MaybeAddEncoder(cls, key_field)
1111      size = key_field._sizer(self.key)
1112      value_field = descriptor.fields_by_name['value']
1113      _MaybeAddEncoder(cls, value_field)
1114      size += value_field._sizer(self.value)
1115    else:
1116      for field_descriptor, field_value in self.ListFields():
1117        _MaybeAddEncoder(cls, field_descriptor)
1118        size += field_descriptor._sizer(field_value)
1119      for tag_bytes, value_bytes in self._unknown_fields:
1120        size += len(tag_bytes) + len(value_bytes)
1121
1122    self._cached_byte_size = size
1123    self._cached_byte_size_dirty = False
1124    self._listener_for_children.dirty = False
1125    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(cls, s): 
826  def FromString(s):
827    message = cls()
828    message.MergeFromString(s)
829    return message
LITERALS_FIELD_NUMBER: int = 1
literals: 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

Getter for literals.

def FindInitializationErrors(self): 
1305  def FindInitializationErrors(self):
1306    """Finds required fields which are not initialized.
1307
1308    Returns:
1309      A list of strings.  Each string is a path to an uninitialized field from
1310      the top-level message, e.g. "foo.bar[5].baz".
1311    """
1312
1313    errors = []  # simplify things
1314
1315    for field in required_fields:
1316      if not self.HasField(field.name):
1317        errors.append(field.name)
1318
1319    for field, value in self.ListFields():
1320      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1321        if field.is_extension:
1322          name = '(%s)' % field.full_name
1323        else:
1324          name = field.name
1325
1326        if _IsMapField(field):
1327          if _IsMessageMapField(field):
1328            for key in value:
1329              element = value[key]
1330              prefix = '%s[%s].' % (name, key)
1331              sub_errors = element.FindInitializationErrors()
1332              errors += [prefix + error for error in sub_errors]
1333          else:
1334            # ScalarMaps can't have any initialization errors.
1335            pass
1336        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1337          for i in range(len(value)):
1338            element = value[i]
1339            prefix = '%s[%d].' % (name, i)
1340            sub_errors = element.FindInitializationErrors()
1341            errors += [prefix + error for error in sub_errors]
1342        else:
1343          prefix = name + '.'
1344          sub_errors = value.FindInitializationErrors()
1345          errors += [prefix + error for error in sub_errors]
1346
1347    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".

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

A linear Boolean problem.

LinearBooleanProblem( *, name: str | None = Ellipsis, num_variables: int | None = Ellipsis, constraints: Iterable[LinearBooleanConstraint] | None = Ellipsis, objective: LinearObjective | None = Ellipsis, var_names: Iterable[str] | None = Ellipsis, assignment: BooleanAssignment | None = Ellipsis, original_num_variables: 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 != None:
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)
DESCRIPTOR: google.protobuf.descriptor.Descriptor = <google.protobuf.descriptor.Descriptor object>
def MergeFrom(self, other_msg): 
1364  def MergeFrom(self, msg):
1365    if not isinstance(msg, cls):
1366      raise TypeError(
1367          'Parameter to MergeFrom() must be instance of same class: '
1368          'expected %s got %s.' % (_FullyQualifiedClassName(cls),
1369                                   _FullyQualifiedClassName(msg.__class__)))
1370
1371    assert msg is not self
1372    self._Modified()
1373
1374    fields = self._fields
1375
1376    for field, value in msg._fields.items():
1377      if field.label == LABEL_REPEATED:
1378        field_value = fields.get(field)
1379        if field_value is None:
1380          # Construct a new object to represent this field.
1381          field_value = field._default_constructor(self)
1382          fields[field] = field_value
1383        field_value.MergeFrom(value)
1384      elif field.cpp_type == CPPTYPE_MESSAGE:
1385        if value._is_present_in_parent:
1386          field_value = fields.get(field)
1387          if field_value is None:
1388            # Construct a new object to represent this field.
1389            field_value = field._default_constructor(self)
1390            fields[field] = field_value
1391          field_value.MergeFrom(value)
1392      else:
1393        self._fields[field] = value
1394        if field.containing_oneof:
1395          self._UpdateOneofState(field)
1396
1397    if msg._unknown_fields:
1398      if not self._unknown_fields:
1399        self._unknown_fields = []
1400      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): 
1423def _Clear(self):
1424  # Clear fields.
1425  self._fields = {}
1426  self._unknown_fields = ()
1427
1428  self._oneofs = {}
1429  self._Modified()

Clears all data that was set in the message.

def SetInParent(self): 
1489  def Modified(self):
1490    """Sets the _cached_byte_size_dirty bit to true,
1491    and propagates this to our listener iff this was a state change.
1492    """
1493
1494    # Note:  Some callers check _cached_byte_size_dirty before calling
1495    #   _Modified() as an extra optimization.  So, if this method is ever
1496    #   changed such that it does stuff even when _cached_byte_size_dirty is
1497    #   already true, the callers need to be updated.
1498    if not self._cached_byte_size_dirty:
1499      self._cached_byte_size_dirty = True
1500      self._listener_for_children.dirty = True
1501      self._is_present_in_parent = True
1502      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): 
1265  def IsInitialized(self, errors=None):
1266    """Checks if all required fields of a message are set.
1267
1268    Args:
1269      errors:  A list which, if provided, will be populated with the field
1270               paths of all missing required fields.
1271
1272    Returns:
1273      True iff the specified message has all required fields set.
1274    """
1275
1276    # Performance is critical so we avoid HasField() and ListFields().
1277
1278    for field in required_fields:
1279      if (field not in self._fields or
1280          (field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE and
1281           not self._fields[field]._is_present_in_parent)):
1282        if errors is not None:
1283          errors.extend(self.FindInitializationErrors())
1284        return False
1285
1286    for field, value in list(self._fields.items()):  # dict can change size!
1287      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1288        if field.label == _FieldDescriptor.LABEL_REPEATED:
1289          if (field.message_type._is_map_entry):
1290            continue
1291          for element in value:
1292            if not element.IsInitialized():
1293              if errors is not None:
1294                errors.extend(self.FindInitializationErrors())
1295              return False
1296        elif value._is_present_in_parent and not value.IsInitialized():
1297          if errors is not None:
1298            errors.extend(self.FindInitializationErrors())
1299          return False
1300
1301    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): 
1180  def MergeFromString(self, serialized):
1181    serialized = memoryview(serialized)
1182    length = len(serialized)
1183    try:
1184      if self._InternalParse(serialized, 0, length) != length:
1185        # The only reason _InternalParse would return early is if it
1186        # encountered an end-group tag.
1187        raise message_mod.DecodeError('Unexpected end-group tag.')
1188    except (IndexError, TypeError):
1189      # Now ord(buf[p:p+1]) == ord('') gets TypeError.
1190      raise message_mod.DecodeError('Truncated message.')
1191    except struct.error as e:
1192      raise message_mod.DecodeError(e)
1193    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): 
1133  def SerializeToString(self, **kwargs):
1134    # Check if the message has all of its required fields set.
1135    if not self.IsInitialized():
1136      raise message_mod.EncodeError(
1137          'Message %s is missing required fields: %s' % (
1138          self.DESCRIPTOR.full_name, ','.join(self.FindInitializationErrors())))
1139    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): 
1146  def SerializePartialToString(self, **kwargs):
1147    out = BytesIO()
1148    self._InternalSerialize(out.write, **kwargs)
1149    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['assignment', b'assignment', 'name', b'name', 'num_variables', b'num_variables', 'objective', b'objective', 'original_num_variables', b'original_num_variables']) -> 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_name is not a member of this message.
def ClearField( self, field_name: Literal['assignment', b'assignment', 'constraints', b'constraints', 'name', b'name', 'num_variables', b'num_variables', 'objective', b'objective', 'original_num_variables', b'original_num_variables', 'var_names', b'var_names']) -> 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_name is not a member of this message.
def WhichOneof(self, oneof_group): 
1406  def WhichOneof(self, oneof_name):
1407    """Returns the name of the currently set field inside a oneof, or None."""
1408    try:
1409      field = message_descriptor.oneofs_by_name[oneof_name]
1410    except KeyError:
1411      raise ValueError(
1412          'Protocol message has no oneof "%s" field.' % oneof_name)
1413
1414    nested_field = self._oneofs.get(field, None)
1415    if nested_field is not None and self.HasField(nested_field.name):
1416      return nested_field.name
1417    else:
1418      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): 
1438def _DiscardUnknownFields(self):
1439  self._unknown_fields = []
1440  for field, value in self.ListFields():
1441    if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1442      if _IsMapField(field):
1443        if _IsMessageMapField(field):
1444          for key in value:
1445            value[key].DiscardUnknownFields()
1446      elif field.label == _FieldDescriptor.LABEL_REPEATED:
1447        for sub_message in value:
1448          sub_message.DiscardUnknownFields()
1449      else:
1450        value.DiscardUnknownFields()

Clears all fields in the UnknownFieldSet.

This operation is recursive for nested message.

def ByteSize(self): 
1101  def ByteSize(self):
1102    if not self._cached_byte_size_dirty:
1103      return self._cached_byte_size
1104
1105    size = 0
1106    descriptor = self.DESCRIPTOR
1107    if descriptor._is_map_entry:
1108      # Fields of map entry should always be serialized.
1109      key_field = descriptor.fields_by_name['key']
1110      _MaybeAddEncoder(cls, key_field)
1111      size = key_field._sizer(self.key)
1112      value_field = descriptor.fields_by_name['value']
1113      _MaybeAddEncoder(cls, value_field)
1114      size += value_field._sizer(self.value)
1115    else:
1116      for field_descriptor, field_value in self.ListFields():
1117        _MaybeAddEncoder(cls, field_descriptor)
1118        size += field_descriptor._sizer(field_value)
1119      for tag_bytes, value_bytes in self._unknown_fields:
1120        size += len(tag_bytes) + len(value_bytes)
1121
1122    self._cached_byte_size = size
1123    self._cached_byte_size_dirty = False
1124    self._listener_for_children.dirty = False
1125    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(cls, s): 
826  def FromString(s):
827    message = cls()
828    message.MergeFromString(s)
829    return message
NAME_FIELD_NUMBER: int = 1
name: str 
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)

The name of the problem.

NUM_VARIABLES_FIELD_NUMBER: int = 3
num_variables: int 
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)

The number of variables in the problem. All the signed representation of the problem literals must be in [-num_variables, num_variables], excluding 0.

CONSTRAINTS_FIELD_NUMBER: int = 4
constraints: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[LinearBooleanConstraint] 
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

The constraints of the problem.

OBJECTIVE_FIELD_NUMBER: int = 5
objective: LinearObjective 
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

The objective of the problem. If left empty, we just have a satisfiability problem.

VAR_NAMES_FIELD_NUMBER: int = 6
var_names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] 
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

The names of the problem variables. The variables index are 0-based and var_names[i] will be the name of the i-th variable which correspond to literals +(i + 1) or -(i + 1). This is optional and can be left empty.

ASSIGNMENT_FIELD_NUMBER: int = 7
assignment: BooleanAssignment 
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

Stores an assignment of the problem variables. That may be an initial feasible solution, just a partial assignment or the optimal solution.

ORIGINAL_NUM_VARIABLES_FIELD_NUMBER: int = 8
original_num_variables: int 
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)

Hack: When converting a wcnf formulat to a LinearBooleanProblem, extra variables need to be created. This stores the number of variables in the original problem (which are in one to one correspondence with the first variables of this problem).

def FindInitializationErrors(self): 
1305  def FindInitializationErrors(self):
1306    """Finds required fields which are not initialized.
1307
1308    Returns:
1309      A list of strings.  Each string is a path to an uninitialized field from
1310      the top-level message, e.g. "foo.bar[5].baz".
1311    """
1312
1313    errors = []  # simplify things
1314
1315    for field in required_fields:
1316      if not self.HasField(field.name):
1317        errors.append(field.name)
1318
1319    for field, value in self.ListFields():
1320      if field.cpp_type == _FieldDescriptor.CPPTYPE_MESSAGE:
1321        if field.is_extension:
1322          name = '(%s)' % field.full_name
1323        else:
1324          name = field.name
1325
1326        if _IsMapField(field):
1327          if _IsMessageMapField(field):
1328            for key in value:
1329              element = value[key]
1330              prefix = '%s[%s].' % (name, key)
1331              sub_errors = element.FindInitializationErrors()
1332              errors += [prefix + error for error in sub_errors]
1333          else:
1334            # ScalarMaps can't have any initialization errors.
1335            pass
1336        elif field.label == _FieldDescriptor.LABEL_REPEATED:
1337          for i in range(len(value)):
1338            element = value[i]
1339            prefix = '%s[%d].' % (name, i)
1340            sub_errors = element.FindInitializationErrors()
1341            errors += [prefix + error for error in sub_errors]
1342        else:
1343          prefix = name + '.'
1344          sub_errors = value.FindInitializationErrors()
1345          errors += [prefix + error for error in sub_errors]
1346
1347    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".