quantpad-data 0.3.0__tar.gz → 0.3.1__tar.gz

{quantpad_data-0.3.0 → quantpad_data-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quantpad-data
-Version: 0.3.0
+Version: 0.3.1
 Summary: Official Python client for the QuantPad market-data API
 Project-URL: Documentation, https://api.quantpad.ai/external/docs
 Author: QuantPad

{quantpad_data-0.3.0 → quantpad_data-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quantpad-data"
-version = "0.3.0"
+version = "0.3.1"
 description = "Official Python client for the QuantPad market-data API"
 readme = "README.md"
 requires-python = ">=3.10"

{quantpad_data-0.3.0 → quantpad_data-0.3.1}/quantpad_data/client.py

@@ -57,7 +57,7 @@ _V2_GATE_REPLIES = frozenset(
 )
 
 V2_NOT_AVAILABLE = (
-    "The /v2 API is not open yet. Your credentials are fine — /v2 is "
+    "The /v2 API is not open yet. Your credentials are fine - /v2 is "
     "limited to a small allowlist while it is finished, so qpd.v2 and "
     "qpd.Historical will not work for you regardless of what you pass "
     "them. The documented /v1 helpers (get_bars, get_ticks, get_universe, "
@@ -65,7 +65,7 @@ V2_NOT_AVAILABLE = (
     "data. Contact QuantPad support if you need /v2 access."
 )
 
-VERSION = "0.3.0"
+VERSION = "0.3.1"
 USER_AGENT = f"quantpad-data-python/{VERSION}"
 TICK_SCHEMAS = (
     "trades", "mbp-1", "mbp-10", "cmbp-1", "tcbbo", "cbbo-1s",

quantpad_data-0.3.1/tests/test_message_encoding.py

@@ -0,0 +1,85 @@
+"""Runtime strings stay ASCII, because they are read on real terminals.
+
+Found by running the SDK against production and watching the em-dash in
+``V2_NOT_AVAILABLE`` come back as a replacement character on a Windows
+console. The message exists to be legible; a message that renders as
+mojibake on a chunk of our users' terminals is not doing its job, and
+the irony of it being the "here is what actually went wrong" string was
+the tell.
+
+Scoped to runtime string *literals*. Docstrings and comments are read in
+an editor and keep their typography.
+"""
+
+from __future__ import annotations
+
+import ast
+import pathlib
+
+import pytest
+
+PACKAGE = pathlib.Path(__file__).resolve().parent.parent / "quantpad_data"
+
+
+def _runtime_strings(path: pathlib.Path):
+    """Every string constant that is not a docstring, with its line."""
+    tree = ast.parse(path.read_text(encoding="utf-8"))
+    docstrings = set()
+    for node in ast.walk(tree):
+        if isinstance(
+            node, (ast.Module, ast.ClassDef, ast.FunctionDef, ast.AsyncFunctionDef)
+        ):
+            text = ast.get_docstring(node, clean=False)
+            if text:
+                docstrings.add(text)
+    for node in ast.walk(tree):
+        if isinstance(node, ast.Constant) and isinstance(node.value, str):
+            if node.value not in docstrings:
+                yield node.lineno, node.value
+
+
+@pytest.mark.parametrize(
+    "module", sorted(PACKAGE.rglob("*.py")), ids=lambda p: p.name
+)
+def test_no_runtime_string_needs_a_utf8_terminal(module: pathlib.Path):
+    offenders = [
+        (line, sorted({c for c in value if ord(c) > 127}), value[:60])
+        for line, value in _runtime_strings(module)
+        if any(ord(c) > 127 for c in value)
+    ]
+    assert not offenders, (
+        f"{module.name} has runtime strings that need a UTF-8 terminal: "
+        f"{offenders}. Use ASCII - these are printed to consoles we do "
+        f"not control."
+    )
+
+
+def test_the_check_can_actually_see_a_violation():
+    """A guard that passes on everything is not a guard.
+
+    The trap this repo keeps hitting: a diagnostic built to confirm a
+    change will confirm it. So prove the detector fires.
+    """
+    source = 'X = "an em dash \u2014 here"\n'
+    tree = ast.parse(source)
+    found = [
+        n.value
+        for n in ast.walk(tree)
+        if isinstance(n, ast.Constant) and isinstance(n.value, str)
+    ]
+    assert any(any(ord(c) > 127 for c in v) for v in found)
+
+
+def test_prose_is_deliberately_exempt():
+    """The scoping is the whole design, so pin it both ways.
+
+    ``client.py`` is full of em-dashes in comments and docstrings and
+    must stay passing. If the check ever widens to the raw file, that is
+    a false positive on prose nobody prints.
+    """
+    source = (PACKAGE / "client.py").read_text(encoding="utf-8")
+    assert "\u2014" in source, "expected this module's prose to use em-dashes"
+
+    runtime = [v for _, v in _runtime_strings(PACKAGE / "client.py")]
+    assert runtime, "parser returned nothing - it would pass vacuously"
+    assert not [v for v in runtime if any(ord(c) > 127 for c in v)]