PYTHON-2682 Add support for the comment field to all helpers (mongodb#847)

Author: juliusgeo

pymongo/aggregation.py

@@ -39,6 +39,7 @@ def __init__(
  let=None,
  user_fields=None,
  result_processor=None,
+ comment=None,
  ):
  if "explain" in options:
  raise ConfigurationError(
@@ -57,6 +58,8 @@ def __init__(
  if let:
  common.validate_is_mapping("let", let)
  options["let"] = let
+ if comment is not None:
+ options["comment"] = comment
  self._options = options
 
  # This is the batchSize that will be used for setting the initial

pymongo/bulk.py

@@ -138,13 +138,14 @@ def _raise_bulk_write_error(full_result):
 class _Bulk(object):
  """The private guts of the bulk write API."""
 
- def __init__(self, collection, ordered, bypass_document_validation):
+ def __init__(self, collection, ordered, bypass_document_validation, comment=None):
  """Initialize a _Bulk instance."""
  self.collection = collection.with_options(
  codec_options=collection.codec_options._replace(
  unicode_decode_error_handler="replace", document_class=dict
  )
  )
+ self.comment = comment
  self.ordered = ordered
  self.ops = []
  self.executed = False
@@ -308,6 +309,8 @@ def _execute_command(
  write_concern = final_write_concern or write_concern
 
  cmd = SON([(cmd_name, self.collection.name), ("ordered", self.ordered)])
+ if self.comment:
+ cmd["comment"] = self.comment
  if not write_concern.is_server_default:
  cmd["writeConcern"] = write_concern.document
  if self.bypass_doc_val:

pymongo/change_stream.py

@@ -95,6 +95,7 @@ def __init__(
  start_at_operation_time: Optional[Timestamp],
  session: Optional["ClientSession"],
  start_after: Optional[Mapping[str, Any]],
+ comment: Optional[Any] = None,
  ) -> None:
  if pipeline is None:
  pipeline = []
@@ -125,7 +126,7 @@ def __init__(
  self._collation = collation
  self._start_at_operation_time = start_at_operation_time
  self._session = session
-
+ self._comment = comment
  # Initialize cursor.
  self._cursor = self._create_cursor()
 
@@ -209,8 +210,8 @@ def _run_aggregation_cmd(self, session, explicit_session):
  self._command_options(),
  explicit_session,
  result_processor=self._process_result,
+ comment=self._comment,
  )
-
  return self._client._retryable_read(
  cmd.get_cursor, self._target._read_preference_for(session), session
  )