Genericize utility examples

Author: Ghraven

README.md

@@ -19,14 +19,14 @@ A collection of practical, production-ready Python utilities built while working
 | `utils/logger.py` | Structured logging with colour + file rotation |
 | `utils/env.py` | Typed `.env` / environment variable loader |
 | `utils/string_utils.py` | slugify, truncate, camel_to_snake |
-| `utils/datetime_utils.py` | UTC helpers, humanize_delta, market hours |
+| `utils/datetime_utils.py` | UTC helpers, humanize_delta, business-hour helpers |
 | `utils/number_utils.py` | Currency format, tick rounding, pct_change |
 | `utils/list_utils.py` | chunk, flatten, deduplicate, batch_by |
 | `utils/dict_utils.py` | deep_merge, safe_get, flatten_dict |
 | `utils/cache_utils.py` | TTLCache + @memoize for API caching |
 | `utils/async_utils.py` | async retry, timeout, gather_safe |
 | `utils/crypto_utils.py` | HMAC-SHA256 signing, nonce generation |
-| `utils/validation_utils.py` | Guard clauses, symbol/email validation |
+| `utils/validation_utils.py` | Guard clauses, identifier/email validation |
 
 ## Install
 

tests/test_crypto_utils.py

@@ -4,10 +4,11 @@
 
 
 def test_hmac_sha256_known_value():
-    # Known reference: echo -n "symbol=BTCUSDT" | openssl dgst -sha256 -hmac "secret"
-    result = hmac_sha256("secret", "symbol=BTCUSDT")
+    # Known reference: echo -n "client=ACME42" | openssl dgst -sha256 -hmac "secret"
+    result = hmac_sha256("secret", "client=ACME42")
     assert isinstance(result, str)
     assert len(result) == 64  # hex-encoded SHA-256 is always 64 chars
+    assert result == "0000b930a1653351394e4a4edea00aeb530e4198fe634ebdd557b7d7d3dccb28"
 
 
 def test_hmac_sha256_deterministic():

tests/test_validation_utils.py

@@ -28,13 +28,13 @@ def test_string_excluded(self):
 
 class TestIsValidSymbol:
     def test_valid_no_slash(self):
-        assert is_valid_symbol("BTCUSDT") is True
+        assert is_valid_symbol("CLIENT42") is True
 
     def test_valid_with_slash(self):
-        assert is_valid_symbol("BTC/USDT") is True
+        assert is_valid_symbol("TEAM/API") is True
 
     def test_lowercase_normalised(self):
-        assert is_valid_symbol("btcusdt") is True
+        assert is_valid_symbol("client42") is True
 
     def test_empty_string(self):
         assert is_valid_symbol("") is False

utils/crypto_utils.py

@@ -1,4 +1,4 @@
-"""Hashing and HMAC utilities — useful for exchange API request signing."""
+"""Hashing and HMAC utilities for signed API requests."""
 
 from __future__ import annotations
 import hashlib
@@ -8,7 +8,7 @@
 
 
 def hmac_sha256(secret: str, message: str) -> str:
-    """Generate HMAC-SHA256 signature (used by Binance, Bybit, etc.).
+    """Generate an HMAC-SHA256 signature.
 
     Args:
         secret: Your API secret key.
@@ -18,7 +18,7 @@ def hmac_sha256(secret: str, message: str) -> str:
         Hex-encoded HMAC-SHA256 signature.
 
     Example:
-        >>> sig = hmac_sha256("my_secret", "symbol=BTCUSDT&side=BUY")
+        >>> sig = hmac_sha256("my_secret", "client=ACME42&action=export")
     """
     return hmac.new(
         secret.encode("utf-8"),

utils/datetime_utils.py

@@ -1,4 +1,4 @@
-"""Date and time utilities for trading and automation.
+"""Date and time utilities for operations and automation.
 
 Usage
 -----

utils/validation_utils.py

@@ -11,11 +11,11 @@ def is_positive_number(value: Any) -> bool:
 
 
 def is_valid_symbol(symbol: str) -> bool:
-    """Check if string looks like a valid trading symbol (e.g. BTCUSDT, BTC/USDT).
+    """Check if a compact uppercase identifier uses a safe symbol format.
 
-    >>> is_valid_symbol("BTCUSDT")
+    >>> is_valid_symbol("CLIENT42")
     True
-    >>> is_valid_symbol("BTC/USDT")
+    >>> is_valid_symbol("TEAM/API")
     True
     >>> is_valid_symbol("")
     False