Beginnings of typed accessors for client data and outputs

shiny/session/_session.py

@@ -138,6 +138,73 @@ def __instancecheck__(self, __instance: Any) -> bool:
         return isinstance(__instance, SessionProxy)
 
 
+class OutputInfo:
+    _input: Inputs
+    _id: Id
+
+    def __init__(self, input: Inputs, id: Id):
+        self._input = input
+        self._id = id
+
+    # TODO: Consider what to do if the outputs are not present right now. Should we
+    # allow a default value? Cause by default, it will throw a silent error.
+
+    def width(self):
+        return self._input[f".clientdata_output_{self._id}_width"]()
+
+    def height(self):
+        return self._input[f".clientdata_output_{self._id}_height"]()
+
+    def hidden(self):
+        return self._input[f".clientdata_output_{self._id}_hidden"]()
+
+    def color_fg(self):
+        return self._input[f".clientdata_output_{self._id}_fg"]()
+
+    def color_bg(self):
+        return self._input[f".clientdata_output_{self._id}_bg"]()
+
+    def color_accent(self):
+        return self._input[f".clientdata_output_{self._id}_accent"]()
+
+    def font(self):
+        return self._input[f".clientdata_output_{self._id}_font"]()
+
+
+class ClientData:
+    _input: Inputs
+
+    def __init__(self, input: Inputs):
+        self._input = input
+
+    # TODO: Consider allowing these properties to be read even if there is no reactive
+    # context (i.e. implicit isolate() rather than throw a "context not found" error). I
+    # think it's reasonable to think people would want to interrogate the path and URL
+    # as part of session initialization, not even being aware that those can change
+    # reactively.
+
+    def url_protocol(self):
+        return self._input[".clientdata_url_protocol"]()
+
+    def url_hostname(self):
+        return self._input[".clientdata_url_hostname"]()
+
+    def url_port(self):
+        return self._input[".clientdata_url_port"]()
+
+    def url_pathname(self):
+        return self._input[".clientdata_url_pathname"]()
+
+    def url_search(self):
+        return self._input[".clientdata_url_search"]()
+
+    def url_hash(self):
+        return self._input[".clientdata_url_hash"]()
+
+    def pixel_ratio(self):
+        return self._input[".clientdata_pixelratio"]()
+
+
 class Session(object, metaclass=SessionMeta):
     """
     A class representing a user session.
@@ -171,6 +238,7 @@ def __init__(
 
         self.input: Inputs = Inputs(dict())
         self.output: Outputs = Outputs(self, self.ns, dict(), dict())
+        self.client_data = ClientData(self.input)
 
         self.user: str | None = None
         self.groups: list[str] | None = None