cfi-decoder 0.1.0__py3-none-any.whl

cfi_decoder/_decode.py

@@ -0,0 +1,57 @@
+"""Core decode function for ISO 10962 CFI codes."""
+
+from ._data import ATTRIBUTES, CATEGORIES, GROUPS
+
+
+def decode(cfi_code: str) -> str:
+    """Decode an ISO 10962 CFI code into human-readable descriptions.
+
+    Args:
+        cfi_code: A 6-character CFI code string.
+
+    Returns:
+        Pipe-separated description string, e.g.
+        ``"Equities | Shares (Common/Ordinary) | Voting | ..."``.
+
+    Raises:
+        TypeError: If *cfi_code* is not a string.
+        ValueError: If the code length is not 6 or any character is unrecognised.
+    """
+    if not isinstance(cfi_code, str):
+        raise TypeError(f"Expected str, got {type(cfi_code).__name__}")
+
+    code = cfi_code.upper()
+
+    if len(code) != 6:
+        raise ValueError(f"CFI code must be exactly 6 characters, got {len(code)}")
+
+    cat_char = code[0]
+    grp_char = code[1]
+
+    category = CATEGORIES.get(cat_char)
+    if category is None:
+        raise ValueError(f"Unknown category: {cat_char!r}")
+
+    group_map = GROUPS.get(cat_char)
+    if group_map is None or grp_char not in group_map:
+        raise ValueError(f"Unknown group {grp_char!r} for category {cat_char!r}")
+    group = group_map[grp_char]
+
+    attr_defs = ATTRIBUTES.get((cat_char, grp_char))
+    if attr_defs is None:
+        raise ValueError(
+            f"No attribute definitions for category {cat_char!r}, group {grp_char!r}"
+        )
+
+    parts: list[str] = [category, group]
+    for i, (label, values) in enumerate(attr_defs):
+        char = code[i + 2]
+        desc = values.get(char)
+        if desc is None:
+            raise ValueError(
+                f"Unknown attribute {char!r} at position {i + 3} "
+                f"({label}) for category {cat_char!r}, group {grp_char!r}"
+            )
+        parts.append(desc)
+
+    return " | ".join(parts)

cfi_decoder-0.1.0.dist-info/METADATA

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: cfi-decoder
+Version: 0.1.0
+Summary: Offline decoder for ISO 10962 CFI (Classification of Financial Instruments) codes
+Keywords: cfi,decoder,iso-10962,finance,classification,financial-instruments
+Author: Arian Šajina
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/ariansajina/cfi-decoder
+Project-URL: Issues, https://github.com/ariansajina/cfi-decoder/issues
+Description-Content-Type: text/markdown
+
+# cfi-decoder
+
+Offline decoder for ISO 10962 CFI (Classification of Financial Instruments) codes.
+
+## How It Works
+
+The decoder takes a 6-character CFI code and maps each position to human-readable descriptions:
+
+- **Position 1:** Financial instrument category (e.g., `E` = Equities, `D` = Debt)
+- **Position 2:** Subcategory/group within that category (e.g., `S` = Shares for Equities)
+- **Positions 3-6:** Specific attributes based on the category-group combination
+
+The `decode()` function returns a pipe-separated string of descriptions for each position.
+
+### Example
+
+```python
+from cfi_decoder import decode
+
+result = decode("ESVUFR")
+# Output: "Equities | Shares (Common/Ordinary) | Voting | Free | Fully Paid | Registered"
+```
+
+### Implementation
+
+The decoder is implemented as a series of dictionary lookups against lookup tables defined in [`src/cfi_decoder/_data.py`](src/cfi_decoder/_data.py). The tables map CFI code characters to their human-readable descriptions for each position.
+
+## Models Used
+
+This project was developed using Claude AI:
+
+- Claude Opus 4.6
+- Claude Sonnet 4.6
+- Claude Haiku 4.5

cfi_decoder-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+cfi_decoder/__init__.py,sha256=ddWAJcJk4IlbG72pKPMZS4Lmd1UnyysBpkpwWTBiCb8,50
+cfi_decoder/_data.py,sha256=FuS8tQ1hlmyKTRaCM1kS2jEFRgieMXEJTUrejPfd72A,28165
+cfi_decoder/_decode.py,sha256=ZbT5E7I97zZTt6_XBcQJAzM4ktvHgCotQNVbeuVcKr8,1800
+cfi_decoder/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cfi_decoder-0.1.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+cfi_decoder-0.1.0.dist-info/WHEEL,sha256=s_zqWxHFEH8b58BCtf46hFCqPaISurdB9R1XJ8za6XI,80
+cfi_decoder-0.1.0.dist-info/METADATA,sha256=UHdrBegdKQtDRNVts6UPsh3W3rtlTpRaoKmqUqEcD5w,2183
+cfi_decoder-0.1.0.dist-info/RECORD,,

cfi_decoder-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.6
+Root-Is-Purelib: true
+Tag: py3-none-any