Merge pull request #1692 from rodrigobnogueira/feature/decimal-support-finance

feat(finance): add Decimal support with precision control

Author: lk-geimfari

mimesis/providers/finance.py

@@ -1,5 +1,7 @@
 """Business data provider."""
 
+from decimal import Decimal
+
 from mimesis.datasets import (
     CRYPTOCURRENCY_ISO_CODES,
     CRYPTOCURRENCY_SYMBOLS,
@@ -82,31 +84,51 @@ def cryptocurrency_symbol(self) -> str:
         """
         return self.random.choice(CRYPTOCURRENCY_SYMBOLS)
 
-    def price(self, minimum: float = 500, maximum: float = 1500) -> float:
+    def price(
+        self,
+        minimum: float = 500,
+        maximum: float = 1500,
+        precision: int = 2,
+        as_decimal: bool = False,
+    ) -> float | Decimal:
         """Generate a random price.
 
         :param minimum: Minimum value of price.
         :param maximum: Maximum value of price.
-        :return: Price.
+        :param precision: Number of decimal places (default 2).
+        :param as_decimal: If True, returns Decimal for high-precision.
+        :return: Price as float or Decimal.
         """
-        return self.random.uniform(
-            minimum,
-            maximum,
-            precision=2,
-        )
-
-    def price_in_btc(self, minimum: float = 0, maximum: float = 2) -> float:
+        if as_decimal:
+            factor = Decimal(10) ** precision
+            min_units = int(Decimal(str(minimum)) * factor)
+            max_units = int(Decimal(str(maximum)) * factor)
+            units = self.random.randint(min_units, max_units)
+            return Decimal(units) / factor
+        return self.random.uniform(minimum, maximum, precision=precision)
+
+    def price_in_btc(
+        self,
+        minimum: float = 0,
+        maximum: float = 2,
+        precision: int = 8,
+        as_decimal: bool = False,
+    ) -> float | Decimal:
         """Generates a random price in BTC.
 
         :param minimum: Minimum value of price.
         :param maximum: Maximum value of price.
-        :return: Price in BTC.
+        :param precision: Number of decimal places (default 8 for satoshi).
+        :param as_decimal: If True, returns Decimal for high-precision.
+        :return: Price in BTC as float or Decimal.
         """
-        return self.random.uniform(
-            minimum,
-            maximum,
-            precision=7,
-        )
+        if as_decimal:
+            factor = Decimal(10) ** precision
+            min_units = int(Decimal(str(minimum)) * factor)
+            max_units = int(Decimal(str(maximum)) * factor)
+            units = self.random.randint(min_units, max_units)
+            return Decimal(units) / factor
+        return self.random.uniform(minimum, maximum, precision=precision)
 
     def stock_ticker(self) -> str:
         """Generates a random stock ticker.

tests/test_providers/test_localized/test_finance.py

@@ -1,4 +1,5 @@
 import re
+from decimal import Decimal
 
 import pytest
 
@@ -79,6 +80,12 @@ def test_price(self, finance):
         result = finance.price(minimum=100.00, maximum=1999.99)
         assert isinstance(result, float)
 
+    def test_price_as_decimal(self, finance):
+        result = finance.price(minimum=100.00, maximum=1999.99, as_decimal=True)
+        assert isinstance(result, Decimal)
+        assert result >= Decimal("100.00")
+        assert result <= Decimal("1999.99")
+
     @pytest.mark.parametrize(
         "minimum, maximum",
         [
@@ -92,6 +99,26 @@ def test_price_in_btc(self, _finance, minimum, maximum):
         assert float(price) >= minimum
         assert float(price) <= maximum
 
+    def test_price_in_btc_as_decimal(self, _finance):
+        result = _finance.price_in_btc(minimum=0.5, maximum=1.5, as_decimal=True)
+        assert isinstance(result, Decimal)
+        assert result >= Decimal("0.5")
+        assert result <= Decimal("1.5")
+
+    def test_price_precision(self, _finance):
+        result = _finance.price(minimum=10, maximum=100, precision=4, as_decimal=True)
+        assert isinstance(result, Decimal)
+        decimal_places = abs(result.as_tuple().exponent)
+        assert decimal_places <= 4
+
+    def test_price_in_btc_precision(self, _finance):
+        result = _finance.price_in_btc(
+            minimum=0, maximum=1, precision=4, as_decimal=True
+        )
+        assert isinstance(result, Decimal)
+        decimal_places = abs(result.as_tuple().exponent)
+        assert decimal_places <= 4
+
 
 class TestSeededFinance:
     @pytest.fixture()
@@ -138,5 +165,11 @@ def test_price_in_btc(self, f1, f2):
         assert f1.price_in_btc() == f2.price_in_btc()
         assert f1.price_in_btc(1.11, 22.2) == f2.price_in_btc(1.11, 22.2)
 
+    def test_price_as_decimal(self, f1, f2):
+        assert f1.price(as_decimal=True) == f2.price(as_decimal=True)
+
+    def test_price_in_btc_as_decimal(self, f1, f2):
+        assert f1.price_in_btc(as_decimal=True) == f2.price_in_btc(as_decimal=True)
+
     def test_bank(self, f1, f2):
         assert f1.bank() == f2.bank()