Merge pull request #1 from seba3c/alpha-2

Alpha 2

Author: seba3c

.gitignore

@@ -1,4 +1,4 @@
 .idea/
-__pycache__/
+**/__pycache__/**
 .coverage
 .DS_Store

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "cryptils"
-version = "0.1.0a1"
+version = "0.1.0a2"
 description = "A simple python utility library for representing cryptocurrency amounts"
 readme = "README.md"
 license = {text = "MIT"}

src/cryptils/_core.py

@@ -4,44 +4,48 @@
 from decimal import Decimal
 from typing import Any, ClassVar, TypeAlias
 
-_number_or_str: TypeAlias = Decimal | int | float | str
+_arithmetic_comparison_compatible: TypeAlias = Decimal | int | float
+_instance_compatible: TypeAlias = _arithmetic_comparison_compatible | str
 
 
 class CryptoAmount(metaclass=ABCMeta):  # noqa: B024
     _name: ClassVar[str] = ""
-    _symbol: ClassVar[str] = ""
+    _code: ClassVar[str] = ""
     _decimals: ClassVar[int] = 0
 
     @property
     def name(self) -> str:
         return self._name
 
     @property
-    def symbol(self) -> str:
-        return self._symbol
+    def code(self) -> str:
+        return self._code
 
-    def __init__(self, value: _number_or_str) -> None:
+    def __init__(self, value: _instance_compatible) -> None:
         if type(self) is CryptoAmount:
             raise TypeError("CryptoAmount is an abstract class and cannot be instantiated directly")
-        self._value = self._to_decimal(value)
+        if type(value) is self.__class__:
+            self._value = self._to_decimal(value.as_decimal())
+        else:
+            self._value = self._to_decimal(value)
 
-    def _to_decimal(self, value: _number_or_str) -> Decimal:
+    def _to_decimal(self, value: _arithmetic_comparison_compatible) -> Decimal:
         return Decimal(value).quantize(Decimal(10) ** -self._decimals)
 
     def as_decimal(self) -> Decimal:
         return self._value
 
     def to_string(self):
-        return f"{self._value:.{self._decimals}f} {self._symbol}"
+        return f"{self._value:.{self._decimals}f} {self._code}"
 
     def __str__(self) -> str:
         return str(self._value)
 
     def __repr__(self) -> str:
-        return f"{self.__class__.__name__}({self.to_string()})"
+        return f"{self.__class__.__name__}({self.as_decimal()})"
 
     def _is_compatible(self, other: Any) -> bool:
-        return isinstance(other, _number_or_str)
+        return isinstance(other, _arithmetic_comparison_compatible)
 
     def _compare(self, other: Any) -> Decimal:
         if isinstance(other, self.__class__):

src/cryptils/btc.py

@@ -5,5 +5,5 @@
 
 class BTC(CryptoAmount):
     _name = "Bitcoin"
-    _symbol = "BTC"
+    _code = "BTC"
     _decimals = 8

src/cryptils/eth.py

@@ -5,5 +5,5 @@
 
 class ETH(CryptoAmount):
     _name = "Ethereum"
-    _symbol = "ETH"
+    _code = "ETH"
     _decimals = 18

src/cryptils/usdc.py

@@ -5,5 +5,5 @@
 
 class USDC(CryptoAmount):
     _name = "USD Coin"
-    _symbol = "USDC"
+    _code = "USDC"
     _decimals = 6

src/cryptils/usdt.py

@@ -5,5 +5,5 @@
 
 class USDT(CryptoAmount):
     _name = "Tether"
-    _symbol = "USDT"
+    _code = "USDT"
     _decimals = 6

tests/__pycache__/__init__.cpython-310.pyc

@@ -6,11 +6,17 @@
 
 
 def test_btc_name():
-    assert BTC._name == "Bitcoin"
+    assert BTC(0).name == "Bitcoin"
 
 
-def test_btc_symbol():
-    assert BTC._symbol == "BTC"
+def test_btc_code():
+    assert BTC(0).code == "BTC"
+
+
+def test_btc_new_instance():
+    assert BTC("1.5") == BTC(1.5)
+    assert BTC("1") == BTC(1)
+    assert BTC("1.5") == BTC(Decimal("1.5"))
 
 
 def test_btc_precision():
@@ -27,7 +33,7 @@ def test_btc_str():
 
 
 def test_btc_repr():
-    assert repr(BTC("1.5")) == "BTC(1.50000000 BTC)"
+    assert repr(BTC("1.5")) == "BTC(1.50000000)"
 
 
 def test_btc_hash():
@@ -62,7 +68,8 @@ def test_btc_addition_with_float():
 
 
 def test_btc_addition_with_str():
-    assert BTC("0.5") + "0.5" == BTC("1.0")
+    with pytest.raises(TypeError):
+        assert BTC("0.5") + "0.5"
 
 
 def test_btc_reverse_addition_with_int():
@@ -85,8 +92,9 @@ def test_btc_subtraction_with_float():
     assert BTC("1.5") - 0.5 == BTC("1.0")
 
 
-def test_btc_subtraction_with_str():
-    assert BTC("1.5") - "0.5" == BTC("1.0")
+def test_btc_subtraction_with_str_raises():
+    with pytest.raises(TypeError):
+        BTC("1.5") - "0.5"
 
 
 def test_btc_reverse_subtraction_with_int():
@@ -105,8 +113,9 @@ def test_btc_multiplication_with_float():
     assert BTC("1") * 2.0 == BTC("2")
 
 
-def test_btc_multiplication_with_str():
-    assert BTC("1") * "2" == BTC("2")
+def test_btc_multiplication_with_str_raises():
+    with pytest.raises(TypeError):
+        assert BTC("1") * "2"
 
 
 def test_btc_reverse_multiplication_with_int():
@@ -130,8 +139,9 @@ def test_btc_division_with_float():
     assert BTC("2") / 2.0 == BTC("1")
 
 
-def test_btc_division_with_str():
-    assert BTC("2") / "2" == BTC("1")
+def test_btc_division_with_str_raises():
+    with pytest.raises(TypeError):
+        assert BTC("2") / "2"
 
 
 def test_btc_reverse_division_with_int():
@@ -159,8 +169,7 @@ def test_btc_equality_with_float():
 
 
 def test_btc_equality_with_str():
-    assert BTC("1.5") == "1.5"
-    assert (BTC("1.5") == "2.5") is False
+    assert (BTC("1.5") == "1.5") is False
 
 
 def test_btc_equality_with_same_class():
@@ -193,9 +202,9 @@ def test_btc_less_than_with_float():
     assert not BTC("1") < 1.0
 
 
-def test_btc_less_than_with_str():
-    assert BTC("1") < "2"
-    assert not BTC("1") < "1"
+def test_btc_less_than_with_str_raises():
+    with pytest.raises(TypeError):
+        assert BTC("1") < "2"
 
 
 def test_btc_less_than_with_same_class():
@@ -224,9 +233,9 @@ def test_btc_greater_than_with_float():
     assert not BTC("1") > 1.0
 
 
-def test_btc_greater_than_with_str():
-    assert BTC("2") > "1"
-    assert not BTC("1") > "1"
+def test_btc_greater_than_with_str_raises():
+    with pytest.raises(TypeError):
+        assert BTC("2") > "1"
 
 
 def test_btc_greater_than_with_same_class():
@@ -244,7 +253,6 @@ def test_btc_comparison_with_zero():
     assert BTC("0") == 0
     assert BTC("0") == Decimal("0")
     assert BTC("0") == 0.0
-    assert BTC("0") == "0"
     assert BTC("0") == BTC("0")
     assert BTC("1") > 0
     assert BTC("-1") < 0
@@ -306,7 +314,6 @@ def test_btc_comparison_with_negative():
     assert BTC("-1") == -1
     assert BTC("-1.5") == Decimal("-1.5")
     assert BTC("-1.5") == -1.5
-    assert BTC("-1.5") == "-1.5"
     assert BTC("-1.5") == BTC("-1.5")
     assert BTC("-1") < 0
     assert BTC("-1") < BTC("0")