chartremotely 0.2.7__tar.gz → 0.2.8__tar.gz

{chartremotely-0.2.7 → chartremotely-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chartremotely
-Version: 0.2.7
+Version: 0.2.8
 Summary: Remote control of desktop charting applications on macOS
 Author: Lonnie VanZandt
 License: 

{chartremotely-0.2.7 → chartremotely-0.2.8}/chartremotely/answer.py

@@ -10,12 +10,14 @@ from typing import NamedTuple
 
 
 class Answer(NamedTuple):
-    """A command's reply, plus the symbol it put on the chart when it did.
+    """A command's reply, plus the symbol and scale it put on the chart when it did.
 
     ``symbol`` is set only by a successful chart change that named one; the
     picture of that change is labelled with it, so a label never depends on
-    how the reply happens to be worded.
+    how the reply happens to be worded. ``scale`` is the time frame the reply
+    states ("half", "30 minutes"), or None when the change could not tell.
     """
 
     reply: str
     symbol: str | None = None
+    scale: str | None = None

{chartremotely-0.2.7 → chartremotely-0.2.8}/chartremotely/push.py

@@ -3,9 +3,9 @@
 A chart changed by voice goes straight to this machine over the tailnet, so
 the operator never hears of it. Once a change is answered — after the reply
 ("… Good luck.") has been sent — one picture of the chart pane is pushed up so
-the patron's browser can offer it, labelled with the symbol the last command
-of the burst put on the chart (the symbol field is read only as a fallback:
-it can be stale). The operator keeps the newest picture per symbol,
+the patron's browser can offer it, labelled with the symbol and scale the
+last command of the burst put on the chart (the symbol field is read only as
+a fallback: it can be stale; the scale is never read back). The operator keeps the newest picture per symbol,
 encrypted, for an hour each.
 
 Three rules keep it out of the way:
@@ -44,10 +44,16 @@ _NOT_A_CHANGE = frozenset({"resolve", "scale", "read", "snapshot"})
 #: the same shape; anything else is left off rather than sent.
 SYMBOL = re.compile(r"^[A-Z0-9./^$-]{1,15}$")
 
+#: What a scale label may look like on the wire: the words a reply states
+#: ("half", "30 minutes", "1 day"). The operator checks the same shape.
+SCALE = re.compile(r"^[A-Za-z0-9][A-Za-z0-9 .:/-]{0,23}$")
+
 _state = threading.Condition()
 #: The symbol the last successful chart-changing command put on the chart.
 #: A burst's picture carries the LAST one; a change that names none keeps it.
 _named: str | None = None
+#: The scale the last chart-changing command stated; kept the same way.
+_scaled: str | None = None
 _due: float | None = None
 _worker: threading.Thread | None = None
 
@@ -66,12 +72,22 @@ def symbol_label(raw: object) -> str | None:
     return label if SYMBOL.match(label) else None
 
 
-def payload(cfg: dict, image: str, symbol: str | None = None) -> tuple[str, dict] | None:
+def scale_label(raw: object) -> str | None:
+    """The chart's scale as sent to the operator, or None when it is not scale-shaped."""
+    if not isinstance(raw, str):
+        return None
+    label = " ".join(raw.split())
+    return label if SCALE.match(label) else None
+
+
+def payload(cfg: dict, image: str, symbol: str | None = None,
+            scale: str | None = None) -> tuple[str, dict] | None:
     """Where to send a picture and what to send, or None when not paired.
 
     ``symbol`` is what the chart showed when the picture was taken; it is left
     out when unknown or not symbol-shaped, and the operator files the picture
-    under a plain "Chart".
+    under a plain "Chart". ``scale`` is the time frame the last change stated;
+    it is left out the same way.
     """
     base = (cfg.get("operator_url") or "").rstrip("/")
     agent_id, secret = cfg.get("agent_id"), cfg.get("agent_secret")
@@ -81,6 +97,9 @@ def payload(cfg: dict, image: str, symbol: str | None = None) -> tuple[str, dict
     label = symbol_label(symbol)
     if label:
         body["symbol"] = label
+    scaled = scale_label(scale)
+    if scaled:
+        body["scale"] = scaled
     return f"{base}/agent/snapshot", body
 
 
@@ -98,16 +117,19 @@ def _showing() -> str | None:
         return None
 
 
-def after_reply(request: str, reply: str, symbol: str | None = None) -> None:
+def after_reply(request: str, reply: str, symbol: str | None = None,
+                scale: str | None = None) -> None:
     """Call once a reply has been sent. Schedules a picture if the chart changed.
 
-    ``symbol`` is what the command put on the chart (vocab.Answer.symbol), when
-    it named one; a change that names none keeps the previous command's.
+    ``symbol`` and ``scale`` are what the command put on the chart
+    (vocab.Answer), when it named them; a change that names neither keeps the
+    previous command's.
     """
-    global _named
+    global _named, _scaled
     if changes_chart(request, reply):
         with _state:
             _named = symbol_label(symbol) or _named
+            _scaled = scale_label(scale) or _scaled
         schedule()
 
 
@@ -144,9 +166,9 @@ def push_now() -> None:
         with guilock.driving():
             image = snapshot.as_reply(snapshot.shrink(window.capture()))
             with _state:
-                label = _named
+                label, scaled = _named, _scaled
             label = label or _showing()
-        url, body = payload(cfg, image, label)
+        url, body = payload(cfg, image, label, scaled)
         relay._post(url, body, timeout=30)
     except Exception:  # noqa: BLE001, S110 - deliberate: see the module docstring
         pass

{chartremotely-0.2.7 → chartremotely-0.2.8}/chartremotely/relay.py

@@ -147,6 +147,6 @@ def run(operator_url: str | None = None, once: bool = False) -> None:
             requestlog.request("relay", command, "", reply)
             # After the reply, never before: the picture of a changed chart.
             from . import push
-            push.after_reply(command, reply, result.symbol)
+            push.after_reply(command, reply, result.symbol, result.scale)
         if once:
             return

{chartremotely-0.2.7 → chartremotely-0.2.8}/chartremotely/server.py

@@ -77,7 +77,7 @@ class Handler(BaseHTTPRequestHandler):
         result = answer(request)
         self._reply(200, result.reply)
         requestlog.request("serve", request, where, result.reply)
-        push.after_reply(request, result.reply, result.symbol)
+        push.after_reply(request, result.reply, result.symbol, result.scale)
 
     def log_message(self, *args) -> None:
         """Silence the stock access log: its request line can carry ``?t=<token>``.

{chartremotely-0.2.7 → chartremotely-0.2.8}/chartremotely/vocab.py

@@ -83,10 +83,10 @@ def set_chart(ticker: str, scale: str = "") -> Answer:
         pass
 
     if word:
-        return Answer(f"Showing {ticker} at {word}. Good luck.", shown)
+        return Answer(f"Showing {ticker} at {word}. Good luck.", shown, word)
     try:
         _, current = timeframe.current()
-        return Answer(f"Showing {ticker} at {current}, as is. Good luck.", shown)
+        return Answer(f"Showing {ticker} at {current}, as is. Good luck.", shown, current)
     except Exception:
         return Answer(f"Showing {ticker}. Good luck.", shown)
 

{chartremotely-0.2.7 → chartremotely-0.2.8}/chartremotely.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chartremotely
-Version: 0.2.7
+Version: 0.2.8
 Summary: Remote control of desktop charting applications on macOS
 Author: Lonnie VanZandt
 License: 

{chartremotely-0.2.7 → chartremotely-0.2.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "chartremotely"
-version = "0.2.7"
+version = "0.2.8"
 description = "Remote control of desktop charting applications on macOS"
 readme = "README.md"
 requires-python = ">=3.12"

{chartremotely-0.2.7 → chartremotely-0.2.8}/tests/test_push.py

@@ -15,6 +15,7 @@ PAIRED = {"operator_url": "https://op.test/", "agent_id": "a1", "agent_secret":
 def isolated_config(tmp_path, monkeypatch):
     monkeypatch.setattr(guilock.config, "CONFIG_DIR", tmp_path)
     monkeypatch.setattr(push, "_named", None)
+    monkeypatch.setattr(push, "_scaled", None)
 
 
 def test_an_unpaired_mac_pushes_nothing():
@@ -44,6 +45,17 @@ def test_an_unreadable_symbol_is_left_off_rather_than_sent(raw):
     assert "symbol" not in body
 
 
+def test_the_push_names_the_scale_the_reply_stated():
+    _, body = push.payload(PAIRED, "img", "PLTR", "  30  minutes ")
+    assert body["scale"] == "30 minutes"
+
+
+@pytest.mark.parametrize("raw", [None, "", "   ", "x" * 25, "<b>half</b>", "half;", "half\x07", 30])
+def test_an_unreadable_scale_is_left_off_rather_than_sent(raw):
+    _, body = push.payload(PAIRED, "img", "PLTR", raw)
+    assert "scale" not in body
+
+
 @pytest.fixture
 def labelled(monkeypatch):
     """Capture stubbed out; returns the bodies pushed. The symbol field reads OLD."""
@@ -92,6 +104,21 @@ def test_the_label_comes_from_the_command_not_the_wording(monkeypatch, labelled)
     assert labelled[-1]["symbol"] == "TSLA"
 
 
+def test_the_picture_carries_the_scale_the_last_change_stated(monkeypatch, labelled):
+    monkeypatch.setattr(push, "schedule", lambda: None)
+    push.after_reply("set PLTR | half", "Showing PLTR at half. Good luck.", "PLTR", "half")
+    push.after_reply("set MSFT", "Showing MSFT. Good luck.", "MSFT")  # scale unknown: kept
+    push.push_now()
+    assert labelled[-1]["symbol"] == "MSFT" and labelled[-1]["scale"] == "half"
+
+
+def test_no_scale_is_sent_when_none_was_ever_stated(monkeypatch, labelled):
+    monkeypatch.setattr(push, "schedule", lambda: None)
+    push.after_reply("set NVDA", "Showing NVDA. Good luck.", "NVDA")
+    push.push_now()
+    assert "scale" not in labelled[-1]
+
+
 def test_the_symbol_field_is_only_the_fallback(labelled):
     push.push_now()
     assert labelled[-1]["symbol"] == "OLD"

{chartremotely-0.2.7 → chartremotely-0.2.8}/tests/test_relay.py

@@ -165,7 +165,7 @@ def test_the_picture_is_scheduled_only_after_the_result_is_posted(operator, monk
     StubOperator.claimed = True
     relay.pair(operator, on_code=lambda c: None)
     StubOperator.commands.append({"id": "r2", "command": "set PLTR"})
-    monkeypatch.setattr(relay, "execute", lambda cmd: Answer("Showing PLTR. Good luck.", "PLTR"))
+    monkeypatch.setattr(relay, "execute", lambda cmd: Answer("Showing PLTR at half. Good luck.", "PLTR", "half"))
     real_post = relay._post
 
     def post(url, payload, timeout):
@@ -173,6 +173,6 @@ def test_the_picture_is_scheduled_only_after_the_result_is_posted(operator, monk
             events.append("result")
         return real_post(url, payload, timeout)
     monkeypatch.setattr(relay, "_post", post)
-    monkeypatch.setattr(push, "after_reply", lambda c, r, s: events.append(("picture", c, s)))
+    monkeypatch.setattr(push, "after_reply", lambda c, r, s, sc: events.append(("picture", c, s, sc)))
     relay.run(once=True)
-    assert events == ["result", ("picture", "set PLTR", "PLTR")]
+    assert events == ["result", ("picture", "set PLTR", "PLTR", "half")]