chore(all): fix type hints, add doc strings to all functions

Author: vile

convert.py

@@ -15,6 +15,18 @@
 
 
 def parse_ofac_xml(path: Path) -> list[DigitalCurrencyAddress]:
+    """
+    Parse out all cryptocurrency addresses from OFAC's SDN XML list.
+
+    Params
+    ------
+        path (Path): Path to the XML file
+
+    Returns
+    -------
+        list[DigitalCurrencyAddress]: List of parsed cryptocurrency addresses
+
+    """
     tree = etree.parse(path)
     root = tree.getroot()
     entities_parent = root.find("ofac:entities", NS)
@@ -52,7 +64,7 @@ def parse_args() -> argparse.Namespace:
 
     Returns
     -------
-        argparse.Namespace
+        argparse.Namespace: Args
     """
     parser = argparse.ArgumentParser()
     parser.add_argument(

util/writers.py

@@ -2,31 +2,52 @@
 import json
 from abc import ABC, abstractmethod
 from dataclasses import asdict
+from pathlib import Path
+from typing import Union
 
 import toml
 
 from .digital_currency_address import DigitalCurrencyAddress
 
+PathOrStrPath = Union[Path, str]
+
 
 class Writer(ABC):
     @abstractmethod
-    def write(self, data: list[DigitalCurrencyAddress], output_path: str) -> None: ...
+    def write(
+        self, data: list[DigitalCurrencyAddress], output_path: PathOrStrPath
+    ) -> None:
+        """
+        Format content and write file.
+
+        Params
+        ------
+            data (list[DigitalCurrencyAddress]): List of parsed cryptocurrency address entries
+            output_path (PathOrStrPath): Path to file to write formatted content
+        """
+        ...
 
 
 class JSONWriter(Writer):
-    def write(self, data: list[DigitalCurrencyAddress], output_path: str) -> None:
+    def write(
+        self, data: list[DigitalCurrencyAddress], output_path: PathOrStrPath
+    ) -> None:
         with open(output_path, "w", encoding="utf-8") as f:
             json.dump([asdict(entry) for entry in data], f, indent=2)
 
 
 class TOMLWriter(Writer):
-    def write(self, data: list[DigitalCurrencyAddress], output_path: str) -> None:
+    def write(
+        self, data: list[DigitalCurrencyAddress], output_path: PathOrStrPath
+    ) -> None:
         with open(output_path, "w", encoding="utf-8") as f:
             toml.dump({"entries": [asdict(entry) for entry in data]}, f)
 
 
 class CSVWriter(Writer):
-    def write(self, data: list[DigitalCurrencyAddress], output_path: str) -> None:
+    def write(
+        self, data: list[DigitalCurrencyAddress], output_path: PathOrStrPath
+    ) -> None:
         if not data:
             return
 
@@ -39,7 +60,9 @@ def write(self, data: list[DigitalCurrencyAddress], output_path: str) -> None:
 
 
 class TextWriter(Writer):
-    def write(self, data: list[DigitalCurrencyAddress], output_path: str) -> None:
+    def write(
+        self, data: list[DigitalCurrencyAddress], output_path: PathOrStrPath
+    ) -> None:
         with open(output_path, "w", encoding="utf-8") as f:
             for entry in data:
                 for key, value in asdict(entry).items():