def test_basewritebatch_update():
from google.cloud.firestore_v1.types import common
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import write
client = _make_client()
batch = _make_derived_write_batch(client)
assert batch._write_pbs == []
reference = client.document("cats", "cradle")
field_path = "head.foot"
value = u"knees toes shoulders"
field_updates = {field_path: value}
ret_val = batch.update(reference, field_updates)
assert ret_val is None
map_pb = document.MapValue(fields={"foot": _value_pb(string_value=value)})
new_write_pb = write.Write(
update=document.Document(
name=reference._document_path, fields={"head": _value_pb(map_value=map_pb)},
),
update_mask=common.DocumentMask(field_paths=[field_path]),
current_document=common.Precondition(exists=True),
)
assert batch._write_pbs == [new_write_pb]
def encode_value(value) -> types.document.Value:
"""Converts a native Python value into a Firestore protobuf ``Value``.
Args:
value (Union[NoneType, bool, int, float, datetime.datetime, \
str, bytes, dict, ~google.cloud.Firestore.GeoPoint]): A native
Python value to convert to a protobuf field.
Returns:
~google.cloud.firestore_v1.types.Value: A
value encoded as a Firestore protobuf.
Raises:
TypeError: If the ``value`` is not one of the accepted types.
"""
if value is None:
return document.Value(null_value=struct_pb2.NULL_VALUE)
# Must come before int since ``bool`` is an integer subtype.
if isinstance(value, bool):
return document.Value(boolean_value=value)
if isinstance(value, int):
return document.Value(integer_value=value)
if isinstance(value, float):
return document.Value(double_value=value)
if isinstance(value, DatetimeWithNanoseconds):
return document.Value(timestamp_value=value.timestamp_pb())
if isinstance(value, datetime.datetime):
return document.Value(timestamp_value=_datetime_to_pb_timestamp(value))
if isinstance(value, str):
return document.Value(string_value=value)
if isinstance(value, bytes):
return document.Value(bytes_value=value)
# NOTE: We avoid doing an isinstance() check for a Document
# here to avoid import cycles.
document_path = getattr(value, "_document_path", None)
if document_path is not None:
return document.Value(reference_value=document_path)
if isinstance(value, GeoPoint):
return document.Value(geo_point_value=value.to_protobuf())
if isinstance(value, (list, tuple, set, frozenset)):
value_list = tuple(encode_value(element) for element in value)
value_pb = document.ArrayValue(values=value_list)
return document.Value(array_value=value_pb)
if isinstance(value, dict):
value_dict = encode_dict(value)
value_pb = document.MapValue(fields=value_dict)
return document.Value(map_value=value_pb)
raise TypeError(
"Cannot convert to a Firestore Value", value, "Invalid type", type(value)
)