teritorio 2021.10.22__py3-none-any.whl → 2024.7.17__py3-none-any.whl

teritorio/main.py

@@ -1,58 +1,53 @@
+from __future__ import annotations
+
 import json
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Optional
-
+from typing import Any, Generic, TypeVar
 
-class Singleton(type):
-    def __init__(cls, name, bases, dict_):
-        super().__init__(name, bases, dict_)
-        cls.instance = None
+from pyutilkit.classes import Singleton
 
-    def __call__(cls, *args, **kwargs):
-        if cls.instance is None:
-            cls.instance = super().__call__(*args, **kwargs)
-        return cls.instance
+T = TypeVar("T")
 
 
-class DataListIterator:
-    def __init__(self, data):
+class DataListIterator(Generic[T]):
+    def __init__(self, data: dict[str, T]) -> None:
         self.values = (data[key] for key in sorted(data))
 
-    def __iter__(self):
+    def __iter__(self) -> DataListIterator[T]:
         return self
 
-    def __next__(self):
+    def __next__(self) -> T:
         return next(self.values)
 
 
-class DataList:
+class DataList(Generic[T]):
     _data_path: Path
-    _object_class: Any
+    _object_class: type[T]
 
-    def __init__(self):
-        with open(self._data_path) as file:
-            data = json.load(file)
+    def __init__(self) -> None:
+        with self._data_path.open() as file:
+            data = json.load(file, object_hook=_list_to_tuple)
 
-        self._data = {}
-        for key, value in data.items():
-            obj = self._object_class(**value)
+        self._data: dict[str, T] = {}
+        for key, raw_obj in data.items():
+            obj = self._object_class(**raw_obj)
             self._data[key] = obj
             setattr(self, key, obj)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.__class__.__name__}()"
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"{self.__class__.__name__}()"
 
-    def __len__(self):
+    def __len__(self) -> int:
         return len(self._data)
 
-    def __getitem__(self, key):
+    def __getitem__(self, key: str) -> T:
         return self._data[key]
 
-    def __iter__(self):
+    def __iter__(self) -> DataListIterator[T]:
         return DataListIterator(self._data)
 
 
@@ -65,7 +60,7 @@ class Country:
     numeric_code: int
 
 
-class Countries(DataList, metaclass=Singleton):
+class Countries(DataList[Country], metaclass=Singleton):
     _data_path = Path(__file__).parent.joinpath("_data/country.json")
     _object_class = Country
 
@@ -74,11 +69,19 @@ class Countries(DataList, metaclass=Singleton):
 class Currency:
     code: str
     name: str
-    entities: list
+    entities: tuple[str, ...]
     numeric_code: int
-    minor_units: Optional[int]
+    minor_units: int | None
 
 
-class Currencies(DataList, metaclass=Singleton):
+class Currencies(DataList[Currency], metaclass=Singleton):
     _data_path = Path(__file__).parent.joinpath("_data/currency.json")
     _object_class = Currency
+
+
+def _list_to_tuple(obj: Any) -> Any:
+    if isinstance(obj, list):
+        return tuple(obj)
+    if isinstance(obj, dict):
+        return {key: _list_to_tuple(value) for key, value in obj.items()}
+    return obj

teritorio/main.pyi

@@ -0,0 +1,476 @@
+from __future__ import annotations
+
+from collections.abc import Iterator
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Generic, TypeVar
+
+from pyutilkit.classes import Singleton
+
+T = TypeVar("T")
+
+class DataListIterator(Generic[T]):
+    values: Iterator[T]
+    def __init__(self, data: dict[str, T]) -> None: ...
+    def __iter__(self) -> DataListIterator[T]: ...
+    def __next__(self) -> T: ...
+
+class DataList(Generic[T]):
+    _data_path: Path
+    _object_class: type[T]
+    _data: dict[str, T]
+
+    def __init__(self) -> None: ...
+    def __str__(self) -> str: ...
+    def __repr__(self) -> str: ...
+    def __len__(self) -> int: ...
+    def __getitem__(self, key: str) -> T: ...
+    def __iter__(self) -> DataListIterator[T]: ...
+
+@dataclass(frozen=True, order=True)
+class Country:
+    english_name: str
+    french_name: str
+    alpha_2_code: str
+    alpha_3_code: str
+    numeric_code: int
+
+class Countries(DataList[Country], metaclass=Singleton):
+    ABW: Country
+    AFG: Country
+    AGO: Country
+    AIA: Country
+    ALA: Country
+    ALB: Country
+    AND: Country
+    ARE: Country
+    ARG: Country
+    ARM: Country
+    ASM: Country
+    ATA: Country
+    ATF: Country
+    ATG: Country
+    AUS: Country
+    AUT: Country
+    AZE: Country
+    BDI: Country
+    BEL: Country
+    BEN: Country
+    BES: Country
+    BFA: Country
+    BGD: Country
+    BGR: Country
+    BHR: Country
+    BHS: Country
+    BIH: Country
+    BLM: Country
+    BLR: Country
+    BLZ: Country
+    BMU: Country
+    BOL: Country
+    BRA: Country
+    BRB: Country
+    BRN: Country
+    BTN: Country
+    BVT: Country
+    BWA: Country
+    CAF: Country
+    CAN: Country
+    CCK: Country
+    CHE: Country
+    CHL: Country
+    CHN: Country
+    CIV: Country
+    CMR: Country
+    COD: Country
+    COG: Country
+    COK: Country
+    COL: Country
+    COM: Country
+    CPV: Country
+    CRI: Country
+    CUB: Country
+    CUW: Country
+    CXR: Country
+    CYM: Country
+    CYP: Country
+    CZE: Country
+    DEU: Country
+    DJI: Country
+    DMA: Country
+    DNK: Country
+    DOM: Country
+    DZA: Country
+    ECU: Country
+    EGY: Country
+    ERI: Country
+    ESH: Country
+    ESP: Country
+    EST: Country
+    ETH: Country
+    FIN: Country
+    FJI: Country
+    FLK: Country
+    FRA: Country
+    FRO: Country
+    FSM: Country
+    GAB: Country
+    GBR: Country
+    GEO: Country
+    GGY: Country
+    GHA: Country
+    GIB: Country
+    GIN: Country
+    GLP: Country
+    GMB: Country
+    GNB: Country
+    GNQ: Country
+    GRC: Country
+    GRD: Country
+    GRL: Country
+    GTM: Country
+    GUF: Country
+    GUM: Country
+    GUY: Country
+    HKG: Country
+    HMD: Country
+    HND: Country
+    HRV: Country
+    HTI: Country
+    HUN: Country
+    IDN: Country
+    IMN: Country
+    IND: Country
+    IOT: Country
+    IRL: Country
+    IRN: Country
+    IRQ: Country
+    ISL: Country
+    ISR: Country
+    ITA: Country
+    JAM: Country
+    JEY: Country
+    JOR: Country
+    JPN: Country
+    KAZ: Country
+    KEN: Country
+    KGZ: Country
+    KHM: Country
+    KIR: Country
+    KNA: Country
+    KOR: Country
+    KWT: Country
+    LAO: Country
+    LBN: Country
+    LBR: Country
+    LBY: Country
+    LCA: Country
+    LIE: Country
+    LKA: Country
+    LSO: Country
+    LTU: Country
+    LUX: Country
+    LVA: Country
+    MAC: Country
+    MAF: Country
+    MAR: Country
+    MCO: Country
+    MDA: Country
+    MDG: Country
+    MDV: Country
+    MEX: Country
+    MHL: Country
+    MKD: Country
+    MLI: Country
+    MLT: Country
+    MMR: Country
+    MNE: Country
+    MNG: Country
+    MNP: Country
+    MOZ: Country
+    MRT: Country
+    MSR: Country
+    MTQ: Country
+    MUS: Country
+    MWI: Country
+    MYS: Country
+    MYT: Country
+    NAM: Country
+    NCL: Country
+    NER: Country
+    NFK: Country
+    NGA: Country
+    NIC: Country
+    NIU: Country
+    NLD: Country
+    NOR: Country
+    NPL: Country
+    NRU: Country
+    NZL: Country
+    OMN: Country
+    PAK: Country
+    PAN: Country
+    PCN: Country
+    PER: Country
+    PHL: Country
+    PLW: Country
+    PNG: Country
+    POL: Country
+    PRI: Country
+    PRK: Country
+    PRT: Country
+    PRY: Country
+    PSE: Country
+    PYF: Country
+    QAT: Country
+    REU: Country
+    ROU: Country
+    RUS: Country
+    RWA: Country
+    SAU: Country
+    SDN: Country
+    SEN: Country
+    SGP: Country
+    SGS: Country
+    SHN: Country
+    SJM: Country
+    SLB: Country
+    SLE: Country
+    SLV: Country
+    SMR: Country
+    SOM: Country
+    SPM: Country
+    SRB: Country
+    SSD: Country
+    STP: Country
+    SUR: Country
+    SVK: Country
+    SVN: Country
+    SWE: Country
+    SWZ: Country
+    SXM: Country
+    SYC: Country
+    SYR: Country
+    TCA: Country
+    TCD: Country
+    TGO: Country
+    THA: Country
+    TJK: Country
+    TKL: Country
+    TKM: Country
+    TLS: Country
+    TON: Country
+    TTO: Country
+    TUN: Country
+    TUR: Country
+    TUV: Country
+    TWN: Country
+    TZA: Country
+    UGA: Country
+    UKR: Country
+    UMI: Country
+    URY: Country
+    USA: Country
+    UZB: Country
+    VAT: Country
+    VCT: Country
+    VEN: Country
+    VGB: Country
+    VIR: Country
+    VNM: Country
+    VUT: Country
+    WLF: Country
+    WSM: Country
+    YEM: Country
+    ZAF: Country
+    ZMB: Country
+    ZWE: Country
+
+@dataclass(frozen=True, order=True)
+class Currency:
+    code: str
+    name: str
+    entities: tuple[str, ...]
+    numeric_code: int
+    minor_units: int | None
+
+class Currencies(DataList[Currency], metaclass=Singleton):
+    AED: Currency
+    AFN: Currency
+    ALL: Currency
+    AMD: Currency
+    ANG: Currency
+    AOA: Currency
+    ARS: Currency
+    AUD: Currency
+    AWG: Currency
+    AZN: Currency
+    BAM: Currency
+    BBD: Currency
+    BDT: Currency
+    BGN: Currency
+    BHD: Currency
+    BIF: Currency
+    BMD: Currency
+    BND: Currency
+    BOB: Currency
+    BOV: Currency
+    BRL: Currency
+    BSD: Currency
+    BTN: Currency
+    BWP: Currency
+    BYN: Currency
+    BZD: Currency
+    CAD: Currency
+    CDF: Currency
+    CHE: Currency
+    CHF: Currency
+    CHW: Currency
+    CLF: Currency
+    CLP: Currency
+    CNY: Currency
+    COP: Currency
+    COU: Currency
+    CRC: Currency
+    CUC: Currency
+    CUP: Currency
+    CVE: Currency
+    CZK: Currency
+    DJF: Currency
+    DKK: Currency
+    DOP: Currency
+    DZD: Currency
+    EGP: Currency
+    ERN: Currency
+    ETB: Currency
+    EUR: Currency
+    FJD: Currency
+    FKP: Currency
+    GBP: Currency
+    GEL: Currency
+    GHS: Currency
+    GIP: Currency
+    GMD: Currency
+    GNF: Currency
+    GTQ: Currency
+    GYD: Currency
+    HKD: Currency
+    HNL: Currency
+    HTG: Currency
+    HUF: Currency
+    IDR: Currency
+    ILS: Currency
+    INR: Currency
+    IQD: Currency
+    IRR: Currency
+    ISK: Currency
+    JMD: Currency
+    JOD: Currency
+    JPY: Currency
+    KES: Currency
+    KGS: Currency
+    KHR: Currency
+    KMF: Currency
+    KPW: Currency
+    KRW: Currency
+    KWD: Currency
+    KYD: Currency
+    KZT: Currency
+    LAK: Currency
+    LBP: Currency
+    LKR: Currency
+    LRD: Currency
+    LSL: Currency
+    LYD: Currency
+    MAD: Currency
+    MDL: Currency
+    MGA: Currency
+    MKD: Currency
+    MMK: Currency
+    MNT: Currency
+    MOP: Currency
+    MRU: Currency
+    MUR: Currency
+    MVR: Currency
+    MWK: Currency
+    MXN: Currency
+    MXV: Currency
+    MYR: Currency
+    MZN: Currency
+    NAD: Currency
+    NGN: Currency
+    NIO: Currency
+    NOK: Currency
+    NPR: Currency
+    NZD: Currency
+    OMR: Currency
+    PAB: Currency
+    PEN: Currency
+    PGK: Currency
+    PHP: Currency
+    PKR: Currency
+    PLN: Currency
+    PYG: Currency
+    QAR: Currency
+    RON: Currency
+    RSD: Currency
+    RUB: Currency
+    RWF: Currency
+    SAR: Currency
+    SBD: Currency
+    SCR: Currency
+    SDG: Currency
+    SEK: Currency
+    SGD: Currency
+    SHP: Currency
+    SLE: Currency
+    SOS: Currency
+    SRD: Currency
+    SSP: Currency
+    STN: Currency
+    SVC: Currency
+    SYP: Currency
+    SZL: Currency
+    THB: Currency
+    TJS: Currency
+    TMT: Currency
+    TND: Currency
+    TOP: Currency
+    TRY: Currency
+    TTD: Currency
+    TWD: Currency
+    TZS: Currency
+    UAH: Currency
+    UGX: Currency
+    USD: Currency
+    USN: Currency
+    UYI: Currency
+    UYU: Currency
+    UYW: Currency
+    UZS: Currency
+    VED: Currency
+    VES: Currency
+    VND: Currency
+    VUV: Currency
+    WST: Currency
+    XAF: Currency
+    XAG: Currency
+    XAU: Currency
+    XBA: Currency
+    XBB: Currency
+    XBC: Currency
+    XBD: Currency
+    XCD: Currency
+    XDR: Currency
+    XOF: Currency
+    XPD: Currency
+    XPF: Currency
+    XPT: Currency
+    XSU: Currency
+    XTS: Currency
+    XUA: Currency
+    XXX: Currency
+    YER: Currency
+    ZAR: Currency
+    ZMW: Currency
+    ZWL: Currency

teritorio-2024.7.17.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.3
+Name: teritorio
+Version: 2024.7.17
+Summary: A library for country and currency ISO codes
+Home-page: https://teritorio.readthedocs.io/en/stable/
+License: BSD-3-Clause
+Keywords: country,currency,iso
+Author: Stephanos Kuma
+Author-email: "Stephanos Kuma" <stephanos@kuma.ai>
+Requires-Python: >=3.9
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Requires-Dist: pyutilkit (~=0.4)
+Project-URL: Documentation, https://teritorio.readthedocs.io/en/stable/
+Project-URL: Repository, https://github.com/spapanik/teritorio
+Description-Content-Type: text/markdown
+
+# teritorio: ISO codes for countries and currencies
+
+[![tests][test_badge]][test_url]
+[![license][licence_badge]][licence_url]
+[![pypi][pypi_badge]][pypi_url]
+[![downloads][pepy_badge]][pepy_url]
+[![code style: black][black_badge]][black_url]
+[![build automation: yam][yam_badge]][yam_url]
+[![Lint: ruff][ruff_badge]][ruff_url]
+
+`teritorio` two iterable singletons that `Countries` and `Currencies`,
+that contain all the relevant ISO information about countries and
+currencies, respectively.
+
+## Versioning
+
+The project project adheres to [Calendar Versioning](https://calver.org). The reason is that the data are
+dominated by political decisions, making semantic versioning largely irrelevant.
+
+## Links
+
+-   [Documentation]
+-   [Changelog]
+
+[test_badge]: https://github.com/spapanik/teritorio/actions/workflows/tests.yml/badge.svg
+[test_url]: https://github.com/spapanik/teritorio/actions/workflows/tests.yml
+[licence_badge]: https://img.shields.io/pypi/l/teritorio
+[licence_url]: https://github.com/spapanik/teritorio/blob/main/docs/LICENSE.md
+[pypi_badge]: https://img.shields.io/pypi/v/teritorio
+[pypi_url]: https://pypi.org/project/teritorio
+[pepy_badge]: https://pepy.tech/badge/teritorio
+[pepy_url]: https://pepy.tech/project/teritorio
+[black_badge]: https://img.shields.io/badge/code%20style-black-000000.svg
+[black_url]: https://github.com/psf/black
+[yam_badge]: https://img.shields.io/badge/build%20automation-yamk-success
+[yam_url]: https://github.com/spapanik/yamk
+[ruff_badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json
+[ruff_url]: https://github.com/charliermarsh/ruff
+[Documentation]: https://teritorio.readthedocs.io/en/stable/
+[Changelog]: https://github.com/spapanik/teritorio/blob/main/docs/CHANGELOG.md
+[Calendar Versioning]: https://calver.org

teritorio-2024.7.17.dist-info/RECORD

@@ -0,0 +1,9 @@
+teritorio/__init__.py,sha256=sP9e4uVdaAe2-FYeoO_Yv1Sx_-08G68lK695bO4kapE,115
+teritorio/_data/country.json,sha256=X9zFAvkKdcU0rvncwVwdQdAAMAfpt663AXp05Hcjaks,48421
+teritorio/_data/currency.json,sha256=PKnc-qpKj9wKnWXmS7OXS5WiHoUdwNp3-guDbtpGTCc,33422
+teritorio/main.py,sha256=U342OeuNMRXg8sUKpD3DFa6g9PVtj-OB48OSx-alE70,2143
+teritorio/main.pyi,sha256=Nc2lLWDas9TCm7iXjVTgAa_fsYbtCMucrrbHfnfnL5g,8661
+teritorio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+teritorio-2024.7.17.dist-info/METADATA,sha256=8AnuqqGTLHTA-aQzhxqbo-CNENTM8aeI3GKzWNzvm3o,2533
+teritorio-2024.7.17.dist-info/WHEEL,sha256=k5X_cv0nlsobEJ2RWm08o6BGpyHHSLnOdq47ItFx1Pg,87
+teritorio-2024.7.17.dist-info/RECORD,,

{teritorio-2021.10.22.dist-info → teritorio-2024.7.17.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry 1.0.3
+Generator: phosphorus 0.4.1
 Root-Is-Purelib: true
 Tag: py3-none-any

CHANGELOG.md

@@ -1,37 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog][clog], and this project adheres to [Calendar Versioning][calver].
-
-## [Unreleased]
-
-## [2021.10.22]
-### Added
-- Added python310 support
-- Added VED
-
-### Changed
-- Changed versioning scheme to calendar versioning
-
-## [1.1.0] - 2020-08-31
-### Added
-- Add support for python 3.6
-
-## [1.0.1] - 2019-11-21
-### Fixed
-- Fixed some typos
-
-## [1.0.0] - 2019-11-14
-### Added
-- Added currency ISO codes (ISO-4217)
-- Added country ISO codes (ISO-3166)
-
-
-[unreleased]: https://github.com/spapanik/teritorio/compare/v2021.10.22...master
-[2021.10.22]: https://github.com/spapanik/teritorio/compare/v1.1.0...v2021.10.22
-[1.0.1]: https://github.com/spapanik/teritorio/compare/v1.0.1...v1.1.0
-[1.0.1]: https://github.com/spapanik/teritorio/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/spapanik/teritorio/releases/tag/v1.0.0
-
-[clog]: https://keepachangelog.com/en/1.0.0/
-[calver]: https://calver.org