Commodities category merged into the others category (#5)

* Commodities category merged into the others category

README.md

@@ -3,8 +3,7 @@ Comprehensive Python package for managing currency codes across different types
 The package provides currency codes for different types of assets. Such as 
 - fiat (US dollar, UAE Dirham, ...)
 - crypto (Bitcoin, Solana, ...)
-- commodity (Palladium, Gold, ...)
-- others (WIR Franc, CFP Franc, ...) 
+- others (Palladium, Gold, WIR Franc, CFP Franc, ...) 
 
 ## Sources
  - [Coinmarketcap website](https://coinmarketcap.com) for crypto
@@ -86,14 +85,6 @@ from currency_codes import get_crypto_currencies, Currency
 crypto_currencies: list[Currency] = get_crypto_currencies()
 ```
 
-### Get the list of commodity currencies
-If you want to get information only about commodity currencies, you can use `get_commodity_currencies` function
-```python
-from currency_codes import get_commodity_currencies, Currency
-
-commodity_currencies: list[Currency] = get_commodity_currencies()
-```
-
 ### Get the list of other currencies
 If you want to get information only about other currencies, you can use `get_other_currencies` function
 ```python

currency_codes/__init__.py

@@ -1,4 +1,3 @@
-from currency_codes.assets.commodity import get_commodity_currencies
 from currency_codes.assets.crypto import get_crypto_currencies
 from currency_codes.assets.fiat import get_fiat_currencies
 from currency_codes.assets.other import get_other_currencies

currency_codes/assets/other.py

@@ -14,6 +14,10 @@ def get_other_currencies() -> List[Currency]:
 
 
 _other_currencies: List[Currency] = [
+    Currency(name="Palladium", code="XPD", numeric_code="964", minor_units=None),
+    Currency(name="Platinum", code="XPT", numeric_code="962", minor_units=None),
+    Currency(name="Gold", code="XAU", numeric_code="959", minor_units=None),
+    Currency(name="Silver", code="XAG", numeric_code="961", minor_units=None),
     Currency(name="Sucre", code="XSU", numeric_code="994", minor_units=None),
     Currency(name="CFP Franc", code="XPF", numeric_code="953", minor_units=0),
     Currency(name="CFA Franc BEAC", code="XAF", numeric_code="950", minor_units=0),

currency_codes/main.py

@@ -1,6 +1,5 @@
 from typing import List
 
-from currency_codes.assets.commodity import get_commodity_currencies
 from currency_codes.assets.crypto import get_crypto_currencies
 from currency_codes.assets.fiat import get_fiat_currencies
 from currency_codes.assets.other import get_other_currencies
@@ -17,9 +16,8 @@ def get_all_currencies() -> List[Currency]:
 
     fiat = get_fiat_currencies()
     crypto = get_crypto_currencies()
-    commodity = get_commodity_currencies()
     other = get_other_currencies()
-    return fiat + crypto + commodity + other
+    return fiat + crypto + other
 
 
 def get_currency_by_code(code: str, case_sensitive: bool = False) -> Currency:

currency_codes/models.py

@@ -9,13 +9,12 @@ class Currency:
     Args:
         name (str): currency name
         code (str): three-letter code
+            None if a currency never went public
         numeric_code (str): three-digit numeric code
-            None for cryptos
         minor_units (int): shows the relationship between the minor unit and the currency itself
-            None for commodities
     """
 
     name: str
-    code: str
+    code: Optional[str]
     numeric_code: Optional[str]
     minor_units: Optional[int]

tests/assets/test_common.py

@@ -18,10 +18,6 @@ def test_when_no_code_duplicates_found_for_fiats(fiat_currencies) -> None:
     assert_no_code_duplicates_found(fiat_currencies)
 
 
-def test_when_no_code_duplicates_found_for_commodities(commodity_currencies) -> None:
-    assert_no_code_duplicates_found(commodity_currencies)
-
-
 def assert_no_numeric_code_duplicates_found(currencies: Iterable[Currency]) -> None:
     codes = set()
     for currency in currencies:
@@ -31,7 +27,3 @@ def assert_no_numeric_code_duplicates_found(currencies: Iterable[Currency]) -> N
 
 def test_when_no_numeric_code_duplicates_found_for_fiats(fiat_currencies) -> None:
     assert_no_numeric_code_duplicates_found(fiat_currencies)
-
-
-def test_when_no_numeric_code_duplicates_found_for_commodities(commodity_currencies) -> None:
-    assert_no_numeric_code_duplicates_found(commodity_currencies)

tests/assets/test_other.py

@@ -9,4 +9,4 @@ def test_get_other_currencies() -> None:
 
     # Then
     assert isinstance(currencies, Iterable)
-    assert len(currencies) == 19
+    assert len(currencies) == 23

tests/conftest.py

@@ -2,7 +2,6 @@
 
 import pytest
 
-from currency_codes.assets.commodity import get_commodity_currencies
 from currency_codes.assets.crypto import get_crypto_currencies
 from currency_codes.assets.fiat import get_fiat_currencies
 from currency_codes.assets.other import get_other_currencies
@@ -19,11 +18,6 @@ def crypto_currencies() -> Iterable[Currency]:
     return get_crypto_currencies()
 
 
-@pytest.fixture
-def commodity_currencies() -> Iterable[Currency]:
-    return get_commodity_currencies()
-
-
 @pytest.fixture
 def other_currencies() -> Iterable[Currency]:
     return get_other_currencies()

tests/test_main.py

@@ -25,16 +25,11 @@
     ("Chilean Peso", "CLP", "152", 0),
 )
 
-commodity_test_cases = (
-    # name, code, numeric_code
-    ("Palladium", "XPD", "964"),
-    ("Platinum", "XPT", "962"),
-    ("Gold", "XAU", "959"),
-    ("Silver", "XAG", "961"),
-)
 
 other_test_cases = (
     # name, code, numeric_code
+    ("Palladium", "XPD", "964", None),
+    ("Silver", "XAG", "961", None),
     ("Uruguay Peso en Unidades Indexadas (UI)", "UYI", "940", 0),
     ("WIR Euro", "CHE", "947", 2),
     ("Unidad de Fomento", "CLF", "990", 4),
@@ -106,22 +101,6 @@ def test_get_currency_by_code_when_currency_is_fiat(name, code, numeric_code, mi
     assert currency.minor_units == minor_units
 
 
-@pytest.mark.parametrize(
-    ids=(c[0] for c in commodity_test_cases),
-    argvalues=commodity_test_cases,
-    argnames="name, code, numeric_code",
-)
-def test_get_currency_by_code_when_currency_is_commodity(name, code, numeric_code) -> None:
-    # When
-    currency = get_currency_by_code(code)
-
-    # Then
-    assert currency.name == name
-    assert currency.code == code
-    assert currency.numeric_code == numeric_code
-    assert currency.minor_units is None
-
-
 @pytest.mark.parametrize(
     ids=(c[0] for c in other_test_cases),
     argvalues=other_test_cases,
@@ -137,7 +116,10 @@ def test_get_currency_by_code_when_currency_is_other(
     assert currency.name == name
     assert currency.code == code
     assert currency.numeric_code == numeric_code
-    assert currency.minor_units == minor_units
+    if minor_units is None:
+        assert currency.minor_units is minor_units
+    else:
+        assert currency.minor_units == minor_units
 
 
 def test_get_currency_by_numeric_code_when_currency_is_not_found() -> None:
@@ -170,22 +152,6 @@ def test_get_currency_by_numeric_code_when_currency_is_fiat(
     assert currency.minor_units == minor_units
 
 
-@pytest.mark.parametrize(
-    ids=(c[0] for c in commodity_test_cases),
-    argvalues=commodity_test_cases,
-    argnames="name, code, numeric_code",
-)
-def test_get_currency_by_numeric_code_when_currency_is_commodity(name, code, numeric_code) -> None:
-    # When
-    currency = get_currency_by_numeric_code(numeric_code)
-
-    # Then
-    assert currency.name == name
-    assert currency.code == code
-    assert currency.numeric_code == numeric_code
-    assert currency.minor_units is None
-
-
 @pytest.mark.parametrize(
     ids=(c[0] for c in other_test_cases),
     argvalues=other_test_cases,
@@ -201,4 +167,7 @@ def test_get_currency_by_numeric_code_when_currency_is_other(
     assert currency.name == name
     assert currency.code == code
     assert currency.numeric_code == numeric_code
-    assert currency.minor_units == minor_units
+    if minor_units is None:
+        assert currency.minor_units is minor_units
+    else:
+        assert currency.minor_units == minor_units