Skip to content

Commit fe17e56

Browse files
ohmayrohmayr
authored
feat(firestore): add BSONDecimal128 support
1 parent 4f302c4 commit fe17e56

7 files changed

Lines changed: 194 additions & 0 deletions

File tree

‎.librarian/generator-input/client-post-processing/firestore-integration.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ replacements:
7171
from google.cloud.firestore_v1.batch import WriteBatch
7272
from google.cloud.firestore_v1.bson import (
7373
BSONBinary,
74+
BSONDecimal128,
7475
BSONInt32,
7576
BSONMaxKey,
7677
BSONMinKey,
@@ -180,6 +181,7 @@ replacements:
180181
"AsyncTransaction",
181182
"AsyncWriteBatch",
182183
"BSONBinary",
184+
"BSONDecimal128",
183185
"BSONInt32",
184186
"BSONMaxKey",
185187
"BSONMinKey",
@@ -259,6 +261,7 @@ replacements:
259261
AsyncTransaction,
260262
AsyncWriteBatch,
261263
BSONBinary,
264+
BSONDecimal128,
262265
BSONInt32,
263266
BSONMaxKey,
264267
BSONMinKey,
@@ -323,6 +326,7 @@ replacements:
323326
"AsyncTransaction",
324327
"AsyncWriteBatch",
325328
"BSONBinary",
329+
"BSONDecimal128",
326330
"BSONInt32",
327331
"BSONMaxKey",
328332
"BSONMinKey",

‎packages/google-cloud-firestore/google/cloud/firestore/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
AsyncTransaction,
3737
AsyncWriteBatch,
3838
BSONBinary,
39+
BSONDecimal128,
3940
BSONInt32,
4041
BSONMaxKey,
4142
BSONMinKey,
@@ -100,6 +101,7 @@
100101
"AsyncTransaction",
101102
"AsyncWriteBatch",
102103
"BSONBinary",
104+
"BSONDecimal128",
103105
"BSONInt32",
104106
"BSONMaxKey",
105107
"BSONMinKey",

‎packages/google-cloud-firestore/google/cloud/firestore_v1/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
from google.cloud.firestore_v1.batch import WriteBatch
4949
from google.cloud.firestore_v1.bson import (
5050
BSONBinary,
51+
BSONDecimal128,
5152
BSONInt32,
5253
BSONMaxKey,
5354
BSONMinKey,
@@ -157,6 +158,7 @@
157158
"AsyncTransaction",
158159
"AsyncWriteBatch",
159160
"BSONBinary",
161+
"BSONDecimal128",
160162
"BSONInt32",
161163
"BSONMaxKey",
162164
"BSONMinKey",

‎packages/google-cloud-firestore/google/cloud/firestore_v1/bson.py‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
"""
2626

2727
import abc
28+
import decimal
2829
import re
2930
from typing import Any, Dict, Union
3031

@@ -36,6 +37,7 @@
3637
"BSONBinary",
3738
"BSONTimestamp",
3839
"BSONRegex",
40+
"BSONDecimal128",
3941
]
4042

4143
_OBJECT_ID_BYTES_LEN = 12
@@ -425,3 +427,84 @@ def __eq__(self, other: Any) -> bool:
425427

426428
def __hash__(self) -> int:
427429
return hash((type(self), self._pattern, self._options))
430+
431+
432+
class BSONDecimal128(_BSONType):
433+
"""Represents a BSON 128-bit Decimal container for Firestore.
434+
435+
Args:
436+
value (Union[str, int, float, decimal.Decimal, BSONDecimal128]):
437+
The decimal value as a string, integer, float, decimal.Decimal,
438+
or BSONDecimal128 instance.
439+
440+
Raises:
441+
TypeError: If value is a boolean or unsupported type.
442+
ValueError: If value cannot be parsed as a valid decimal number.
443+
444+
Example:
445+
>>> dec = BSONDecimal128("123.45")
446+
>>> dec.value
447+
'123.45'
448+
>>> dec.to_decimal
449+
Decimal('123.45')
450+
"""
451+
452+
__slots__ = ("_value",)
453+
454+
def __init__(
455+
self,
456+
value: Union[str, int, float, decimal.Decimal, "BSONDecimal128"],
457+
):
458+
if isinstance(value, BSONDecimal128):
459+
self._value: str = value._value
460+
elif isinstance(value, (str, int, float, decimal.Decimal)) and not isinstance(
461+
value, bool
462+
):
463+
self._value = str(value)
464+
else:
465+
raise TypeError(
466+
"BSONDecimal128 value must be a Decimal, str, int, or float."
467+
)
468+
469+
@property
470+
def value(self) -> str:
471+
"""str: The string representation of the 128-bit decimal value."""
472+
return self._value
473+
474+
@property
475+
def to_decimal(self) -> decimal.Decimal:
476+
"""decimal.Decimal: Convert to Python standard library Decimal instance."""
477+
return decimal.Decimal(self._value)
478+
479+
def _to_map_value(self) -> Dict[str, str]:
480+
"""Returns map dictionary representation for wire serialization."""
481+
return {"__decimal128__": self._value}
482+
483+
def __repr__(self) -> str:
484+
return f"BSONDecimal128({self._value!r})"
485+
486+
def __str__(self) -> str:
487+
return self._value
488+
489+
def __eq__(self, other: Any) -> bool:
490+
if isinstance(other, BSONDecimal128):
491+
if self._value.upper() == "NAN" and other._value.upper() == "NAN":
492+
return True
493+
try:
494+
return self.to_decimal == other.to_decimal
495+
except decimal.InvalidOperation:
496+
return self._value == other._value
497+
if isinstance(other, decimal.Decimal):
498+
try:
499+
return self.to_decimal == other
500+
except decimal.InvalidOperation:
501+
return False
502+
return NotImplemented
503+
504+
def __hash__(self) -> int:
505+
if self._value.upper() == "NAN":
506+
return hash((type(self), "NAN"))
507+
try:
508+
return hash(self.to_decimal)
509+
except decimal.InvalidOperation:
510+
return hash((type(self), self._value))

‎packages/google-cloud-firestore/tests/system/test_system.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
from google.cloud.firestore_v1.base_vector_query import DistanceMeasure
5151
from google.cloud.firestore_v1.bson import (
5252
BSONBinary,
53+
BSONDecimal128,
5354
BSONInt32,
5455
BSONMaxKey,
5556
BSONMinKey,
@@ -1298,6 +1299,7 @@ def test_bson_document_writes(client, cleanup, database):
12981299
"binary_val_sub128": BSONBinary(b"world", subtype=128),
12991300
"timestamp_val": BSONTimestamp(1700000000, 1),
13001301
"regex_val": BSONRegex("^hello.*$", options="i"),
1302+
"decimal128_val": BSONDecimal128("123.45"),
13011303
}
13021304

13031305
doc_ref.set(bson_payload)
@@ -1322,6 +1324,7 @@ def test_bson_document_writes(client, cleanup, database):
13221324
"options": "i",
13231325
}
13241326
},
1327+
"decimal128_val": {"__decimal128__": "123.45"},
13251328
}
13261329

13271330

‎packages/google-cloud-firestore/tests/system/test_system_async.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
from google.cloud.firestore_v1.base_vector_query import DistanceMeasure
5454
from google.cloud.firestore_v1.bson import (
5555
BSONBinary,
56+
BSONDecimal128,
5657
BSONInt32,
5758
BSONMaxKey,
5859
BSONMinKey,
@@ -1271,6 +1272,7 @@ async def test_async_bson_document_writes(client, cleanup, database):
12711272
"binary_val_sub128": BSONBinary(b"world", subtype=128),
12721273
"timestamp_val": BSONTimestamp(1700000000, 1),
12731274
"regex_val": BSONRegex("^hello.*$", options="i"),
1275+
"decimal128_val": BSONDecimal128("123.45"),
12741276
}
12751277

12761278
await doc_ref.set(bson_payload)
@@ -1295,6 +1297,7 @@ async def test_async_bson_document_writes(client, cleanup, database):
12951297
"options": "i",
12961298
}
12971299
},
1300+
"decimal128_val": {"__decimal128__": "123.45"},
12981301
}
12991302

13001303

‎packages/google-cloud-firestore/tests/unit/v1/test_bson.py‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@
1616
"""Unit tests for google.cloud.firestore_v1.bson classes."""
1717

1818
import copy
19+
import decimal
1920
import pickle
2021
import re
2122

2223
import pytest
2324

2425
from google.cloud.firestore_v1.bson import (
2526
BSONBinary,
27+
BSONDecimal128,
2628
BSONInt32,
2729
BSONMaxKey,
2830
BSONMinKey,
@@ -482,3 +484,98 @@ def test_bson_regex_copy():
482484
def test_bson_regex_pickle():
483485
rx = BSONRegex("^abc", options="i")
484486
assert pickle.loads(pickle.dumps(rx)) == rx
487+
488+
489+
def test_bson_decimal128_valid():
490+
dec1 = BSONDecimal128("123.45")
491+
assert dec1.value == "123.45"
492+
assert dec1.to_decimal == decimal.Decimal("123.45")
493+
assert dec1._to_map_value() == {"__decimal128__": "123.45"}
494+
assert repr(dec1) == "BSONDecimal128('123.45')"
495+
assert str(dec1) == "123.45"
496+
497+
dec2 = BSONDecimal128(42)
498+
assert dec2.value == "42"
499+
500+
dec3 = BSONDecimal128(1.5)
501+
assert dec3.value == "1.5"
502+
503+
dec4 = BSONDecimal128(decimal.Decimal("99.99"))
504+
assert dec4.value == "99.99"
505+
506+
dec5 = BSONDecimal128(dec1)
507+
assert dec5.value == "123.45"
508+
509+
510+
def test_bson_decimal128_special_values():
511+
nan_dec = BSONDecimal128("NaN")
512+
assert nan_dec.value == "NaN"
513+
assert nan_dec._to_map_value() == {"__decimal128__": "NaN"}
514+
515+
inf_dec = BSONDecimal128("Infinity")
516+
assert inf_dec.value == "Infinity"
517+
518+
neg_inf_dec = BSONDecimal128("-Infinity")
519+
assert neg_inf_dec.value == "-Infinity"
520+
521+
522+
@pytest.mark.parametrize(
523+
"val_input, exc_type, match_msg",
524+
[
525+
(True, TypeError, "value must be a Decimal, str, int, or float"),
526+
(False, TypeError, "value must be a Decimal, str, int, or float"),
527+
([1, 2], TypeError, "value must be a Decimal, str, int, or float"),
528+
],
529+
)
530+
def test_bson_decimal128_invalid_inputs(val_input, exc_type, match_msg):
531+
with pytest.raises(exc_type, match=match_msg):
532+
BSONDecimal128(val_input)
533+
534+
535+
def test_bson_decimal128_equality():
536+
d1 = BSONDecimal128("123.45")
537+
d2 = BSONDecimal128("123.45")
538+
d3 = BSONDecimal128("678.90")
539+
assert d1 == d2
540+
assert d1 != d3
541+
assert d1 == decimal.Decimal("123.45")
542+
assert d1 != "123.45"
543+
544+
# Transitivity test: BSONDecimal128("1.0") == Decimal("1") == BSONDecimal128("1")
545+
d_trail = BSONDecimal128("1.0")
546+
d_int = BSONDecimal128("1")
547+
dec_int = decimal.Decimal("1")
548+
assert d_trail == dec_int
549+
assert d_int == dec_int
550+
assert d_trail == d_int # Transitivity enforced!
551+
552+
nan1 = BSONDecimal128("NaN")
553+
nan2 = BSONDecimal128("NaN")
554+
assert nan1 == nan2
555+
556+
557+
def test_bson_decimal128_hash_and_dict_key():
558+
d1 = BSONDecimal128("123.45")
559+
d2 = BSONDecimal128("123.45")
560+
dec_val = decimal.Decimal("123.45")
561+
562+
# Hash invariant test: if a == b, then hash(a) == hash(b)
563+
assert hash(d1) == hash(d2)
564+
assert hash(d1) == hash(dec_val)
565+
assert len({d1, d2, dec_val}) == 1
566+
567+
nan1 = BSONDecimal128("NaN")
568+
nan2 = BSONDecimal128("NaN")
569+
assert hash(nan1) == hash(nan2)
570+
assert len({nan1, nan2}) == 1
571+
572+
573+
def test_bson_decimal128_copy():
574+
d = BSONDecimal128("123.45")
575+
assert copy.copy(d) == d
576+
assert copy.deepcopy(d) == d
577+
578+
579+
def test_bson_decimal128_pickle():
580+
d = BSONDecimal128("123.45")
581+
assert pickle.loads(pickle.dumps(d)) == d

0 commit comments

Comments
 (0)