breaking: redo reply structures

Use Rect for workspace and output rects.

Use InputReply for seat input devices.

Add docs.

Author: Tony Crisci

i3ipc/aio/connection.py

@@ -483,7 +483,8 @@ async def command(self, cmd: str) -> List[CommandReply]:
         data = await self._message(MessageType.COMMAND, cmd)
 
         if data:
-            return json.loads(data, object_hook=CommandReply)
+            data = json.loads(data)
+            return [CommandReply(d) for d in data]
         else:
             return []
 
@@ -494,7 +495,8 @@ async def get_version(self) -> VersionReply:
         :rtype: :class:`i3ipc.VersionReply`
         """
         data = await self._message(MessageType.GET_VERSION)
-        return json.loads(data, object_hook=VersionReply)
+        data = json.loads(data)
+        return VersionReply(data)
 
     async def get_bar_config_list(self) -> List[str]:
         """Gets the names of all bar configurations.
@@ -523,7 +525,8 @@ async def get_bar_config(self, bar_id=None) -> Optional[BarConfigReply]:
             bar_id = bar_config_list[0]
 
         data = await self._message(MessageType.GET_BAR_CONFIG, bar_id)
-        return json.loads(data, object_hook=BarConfigReply)
+        data = json.loads(data)
+        return BarConfigReply(data)
 
     async def get_outputs(self) -> List[OutputReply]:
         """Gets the list of current outputs.
@@ -532,7 +535,8 @@ async def get_outputs(self) -> List[OutputReply]:
         :rtype: list(:class:`i3ipc.OutputReply`)
         """
         data = await self._message(MessageType.GET_OUTPUTS)
-        return json.loads(data, object_hook=OutputReply)
+        data = json.loads(data)
+        return [OutputReply(d) for d in data]
 
     async def get_workspaces(self) -> List[WorkspaceReply]:
         """Gets the list of current workspaces.
@@ -541,7 +545,8 @@ async def get_workspaces(self) -> List[WorkspaceReply]:
         :rtype: list(:class:`i3ipc.WorkspaceReply`)
         """
         data = await self._message(MessageType.GET_WORKSPACES)
-        return json.loads(data, object_hook=WorkspaceReply)
+        data = json.loads(data)
+        return [WorkspaceReply(d) for d in data]
 
     async def get_tree(self) -> Con:
         """Gets the root container of the i3 layout tree.
@@ -577,7 +582,8 @@ async def get_config(self) -> ConfigReply:
         :rtype: :class:`i3ipc.ConfigReply`
         """
         data = await self._message(MessageType.GET_CONFIG)
-        return json.loads(data, object_hook=ConfigReply)
+        data = json.loads(data)
+        return ConfigReply(data)
 
     async def send_tick(self, payload: str = "") -> TickReply:
         """Sends a tick with the specified payload.
@@ -586,7 +592,8 @@ async def send_tick(self, payload: str = "") -> TickReply:
         :rtype: :class:`i3ipc.TickReply`
         """
         data = await self._message(MessageType.SEND_TICK, payload)
-        return json.loads(data, object_hook=TickReply)
+        data = json.loads(data)
+        return TickReply(data)
 
     async def get_inputs(self) -> InputReply:
         """(sway only) Gets the inputs connected to the compositor.
@@ -595,7 +602,8 @@ async def get_inputs(self) -> InputReply:
         :rtype: :class:`i3ipc.InputReply`
         """
         data = await self._message(MessageType.GET_INPUTS)
-        return json.loads(data, object_hook=InputReply)
+        data = json.loads(data)
+        return [InputReply(d) for d in data]
 
     async def get_seats(self) -> SeatReply:
         """(sway only) Gets the seats configured on the compositor
@@ -604,7 +612,8 @@ async def get_seats(self) -> SeatReply:
         :rtype: :class:`i3ipc.SeatReply`
         """
         data = await self._message(MessageType.GET_SEATS)
-        return json.loads(data, object_hook=SeatReply)
+        data = json.loads(data)
+        return [SeatReply(d) for d in data]
 
     def main_quit(self, _error=None):
         """Quits the running main loop for this connection."""

i3ipc/connection.py

@@ -185,7 +185,8 @@ def command(self, payload):
         """
         data = self._message(MessageType.COMMAND, payload)
         if data:
-            return json.loads(data, object_hook=CommandReply)
+            data = json.loads(data)
+            return [CommandReply(d) for d in data]
         else:
             return []
 
@@ -196,7 +197,8 @@ def get_version(self):
         :rtype: :class:`i3ipc.VersionReply`
         """
         data = self._message(MessageType.GET_VERSION, '')
-        return json.loads(data, object_hook=VersionReply)
+        data = json.loads(data)
+        return VersionReply(data)
 
     def get_bar_config(self, bar_id=None):
         """Gets the bar configuration specified by the id.
@@ -216,7 +218,8 @@ def get_bar_config(self, bar_id=None):
             bar_id = bar_config_list[0]
 
         data = self._message(MessageType.GET_BAR_CONFIG, bar_id)
-        return json.loads(data, object_hook=BarConfigReply)
+        data = json.loads(data)
+        return BarConfigReply(data)
 
     def get_bar_config_list(self):
         """Gets the names of all bar configurations.
@@ -234,7 +237,8 @@ def get_outputs(self):
         :rtype: list(:class:`i3ipc.OutputReply`)
         """
         data = self._message(MessageType.GET_OUTPUTS, '')
-        return json.loads(data, object_hook=OutputReply)
+        data = json.loads(data)
+        return [OutputReply(d) for d in data]
 
     def get_inputs(self):
         """(sway only) Gets the inputs connected to the compositor.
@@ -243,7 +247,8 @@ def get_inputs(self):
         :rtype: :class:`i3ipc.InputReply`
         """
         data = self._message(MessageType.GET_INPUTS, '')
-        return json.loads(data, object_hook=InputReply)
+        data = json.loads(data)
+        return [InputReply(d) for d in data]
 
     def get_seats(self):
         """(sway only) Gets the seats configured on the compositor
@@ -252,7 +257,8 @@ def get_seats(self):
         :rtype: :class:`i3ipc.SeatReply`
         """
         data = self._message(MessageType.GET_SEATS, '')
-        return json.loads(data, object_hook=SeatReply)
+        data = json.loads(data)
+        return [SeatReply(d) for d in data]
 
     def get_workspaces(self):
         """Gets the list of current workspaces.
@@ -261,7 +267,8 @@ def get_workspaces(self):
         :rtype: list(:class:`i3ipc.WorkspaceReply`)
         """
         data = self._message(MessageType.GET_WORKSPACES, '')
-        return json.loads(data, object_hook=WorkspaceReply)
+        data = json.loads(data)
+        return [WorkspaceReply(ws) for ws in data]
 
     def get_tree(self):
         """Gets the root container of the i3 layout tree.
@@ -297,7 +304,8 @@ def get_config(self):
         :rtype: :class:`i3ipc.ConfigReply`
         """
         data = self._message(MessageType.GET_CONFIG, '')
-        return json.loads(data, object_hook=ConfigReply)
+        data = json.loads(data)
+        return ConfigReply(data)
 
     def send_tick(self, payload=""):
         """Sends a tick with the specified payload.
@@ -306,7 +314,8 @@ def send_tick(self, payload=""):
         :rtype: :class:`i3ipc.TickReply`
         """
         data = self._message(MessageType.SEND_TICK, payload)
-        return json.loads(data, object_hook=TickReply)
+        data = json.loads(data)
+        return TickReply(data)
 
     def _subscribe(self, events):
         events_obj = []
@@ -332,7 +341,8 @@ def _subscribe(self, events):
             data = self._ipc_send(self._sub_socket, MessageType.SUBSCRIBE, json.dumps(events_obj))
         finally:
             self._sub_lock.release()
-        result = json.loads(data, object_hook=CommandReply)
+        data = json.loads(data)
+        result = CommandReply(data)
         self.subscriptions |= events
         return result