test: bind canonical futures examples per client

Author: karlwaldman

oilpriceapi/async_resources.py

@@ -320,6 +320,12 @@ class AsyncFuturesResource:
     Methods accept either a slug or a friendly contract code (``"BZ"``,
     ``"CL"``, ``"NG"``, ...), normalized via
     :func:`normalize_futures_slug`.
+
+    Examples:
+        >>> await client.futures.latest("brent")
+        >>> await client.futures.latest("wti")
+        >>> await client.futures.latest("gasoil")
+        >>> await client.futures.latest("eu-carbon")
     """
 
     def __init__(self, client):

oilpriceapi/resources/futures.py

@@ -13,6 +13,12 @@
 Valid slugs: ``brent``, ``wti``, ``gasoil``, ``natural-gas``,
 ``ttf-gas``, ``lng-jkm``, ``eu-carbon``, ``uk-carbon`` (+ continuous slugs
 ``continuous/brent`` and ``continuous/wti``).
+
+Examples:
+    >>> client.futures.latest("brent")
+    >>> client.futures.latest("wti")
+    >>> client.futures.latest("gasoil")
+    >>> client.futures.latest("eu-carbon")
 """
 
 from datetime import date, datetime

tests/test_release_readiness.py

@@ -88,18 +88,20 @@ def test_examples_defer_mutable_allowances_to_product_facts() -> None:
 
 
 def test_packaged_futures_examples_prefer_instrument_generic_slugs() -> None:
-    futures_sources = "\n".join(
-        (ROOT / path).read_text()
-        for path in (
-            "oilpriceapi/resources/futures.py",
-            "oilpriceapi/async_resources.py",
-        )
-    )
-
-    for example_line in re.findall(r"(?m)^\s*(?:>>>|\.\.\.)\s+.*$", futures_sources):
-        assert not re.search(r"[\"'](?:ice|eua)-", example_line)
-    assert 'client.futures.latest("brent")' in futures_sources
-    assert 'client.futures.curve("wti")' in futures_sources
+    for path in (
+        "oilpriceapi/resources/futures.py",
+        "oilpriceapi/async_resources.py",
+    ):
+        source = (ROOT / path).read_text()
+        example_lines = re.findall(r"(?m)^\s*(?:>>>|\.\.\.)\s+.*$", source)
+        examples = "\n".join(example_lines)
+
+        for example_line in example_lines:
+            assert not re.search(r"[\"'](?:ice|eua)-", example_line)
+        for canonical_slug in ("brent", "wti", "gasoil", "eu-carbon"):
+            assert canonical_slug in examples, (
+                f"{path} examples omit {canonical_slug}"
+            )
 
 
 def test_publish_gate_audits_and_installs_the_built_wheel() -> None: