add raw ipc data to classes

Author: Tony Crisci

i3ipc/aio/connection.py

@@ -123,6 +123,9 @@ class Con(con.Con):
     :vartype pid: int
     :ivar gaps: (gaps only)
     :vartype gaps: :class:`Gaps <i3ipc.Gaps>`
+
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     async def command(self, command: str) -> List[CommandReply]:

i3ipc/con.py

@@ -73,9 +73,13 @@ class Con:
     :vartype pid: int
     :ivar gaps: (gaps only)
     :vartype gaps: :class:`Gaps <i3ipc.Gaps>`
+
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data, parent, conn):
+        self.ipc_data = data
         self._conn = conn
         self.parent = parent
 

i3ipc/events.py

@@ -62,9 +62,12 @@ class WorkspaceEvent(IpcBaseEvent):
     :ivar old: When the change is "focus", an old (object) property will be
         present with the previous workspace if it exists.
     :vartype old: :class:`Con` or :class:`None`
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data, conn, _Con=con.Con):
+        self.ipc_data = data
         self.change = data['change']
         self.current = None
         self.old = None
@@ -84,9 +87,12 @@ class OutputEvent(IpcBaseEvent):
 
     :ivar change: The type of change (currently only "unspecified").
     :vartype change: str
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data):
+        self.ipc_data = data
         self.change = data['change']
 
 
@@ -100,9 +106,12 @@ class ModeEvent(IpcBaseEvent):
     :ivar pango_markup: Whether pango markup should be used for displaying this
         mode.
     :vartype pango_markup: bool
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data):
+        self.ipc_data = data
         self.change = data['change']
         self.pango_markup = data.get('pango_markup', False)
 
@@ -117,9 +126,12 @@ class WindowEvent(IpcBaseEvent):
     :ivar change: The type of change.
     :vartype change: str
     :ivar container: The window's parent container.
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data, conn, _Con=con.Con):
+        self.ipc_data = data
         self.change = data['change']
         self.container = _Con(data['container'], None, conn)
 
@@ -150,6 +162,8 @@ class BarconfigUpdateEvent(IpcBaseEvent, BarConfigReply):
     :ivar colors: Contains key/value pairs of colors. Each value is a color
         code in hex, formatted #rrggbb (like in HTML).
     :vartype colors: dict
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     pass
 
@@ -172,9 +186,12 @@ class BindingInfo:
     :ivar input_type: This will be "keyboard" or "mouse" depending on whether
         or not this was a keyboard or a mouse binding.
     :vartype input_type: str
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data):
+        self.ipc_data = data
         self.command = data['command']
         self.event_state_mask = data.get('event_state_mask', [])
         self.input_code = data['input_code']
@@ -196,9 +213,12 @@ class BindingEvent(IpcBaseEvent):
     :vartype change: str
     :ivar binding: Contains details about the binding that was run.
     :vartype binding: :class:`BindingInfo <i3ipc.BindingInfo>`
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data):
+        self.ipc_data = data
         self.change = data['change']
         self.binding = BindingInfo(data['binding'])
 
@@ -211,9 +231,12 @@ class ShutdownEvent(IpcBaseEvent):
 
     :ivar change: The type of change.
     :vartype change: str
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data):
+        self.ipc_data = data
         self.change = data['change']
 
 
@@ -229,9 +252,12 @@ class TickEvent(IpcBaseEvent):
         i3 (<=4.15).
     :ivar payload: The payload that was sent with the tick.
     :vartype payload: str
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data):
+        self.ipc_data = data
         # i3 didn't include the 'first' field in 4.15. See i3/i3#3271.
         self.first = data.get('first', None)
         self.payload = data['payload']
@@ -244,8 +270,11 @@ class InputEvent(IpcBaseEvent):
     :vartype change: str
     :ivar input: Information about the input that changed.
     :vartype input: :class:`InputReply <i3ipc.InputReply>`
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
 
     def __init__(self, data):
+        self.ipc_data = data
         self.change = data['change']
         self.input = InputReply(data['input'])

i3ipc/replies.py

@@ -3,6 +3,7 @@
 
 class _BaseReply:
     def __init__(self, data):
+        self.ipc_data = data
         for member in self.__class__._members:
             value = data.get(member[0], None)
             if value is not None:
@@ -24,6 +25,8 @@ class CommandReply(_BaseReply):
     :vartype success: bool
     :ivar error: A human-readable error message.
     :vartype error: str or :class:`None` if no error message was set.
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('success', bool),
@@ -55,6 +58,8 @@ class WorkspaceReply(_BaseReply):
     :vartype rect: :class:`Rect`
     :ivar output: The video output this workspace is on (LVDS1, VGA1, ...).
     :vartype output: str
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('num', int),
@@ -84,6 +89,8 @@ class OutputReply(_BaseReply):
     :ivar rect: The rectangle of this output (equals the rect of the output it
         is on).
     :vartype rect: :class:`Rect`
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('name', str),
@@ -131,6 +138,8 @@ class BarConfigReply(_BaseReply):
     :ivar colors: Contains key/value pairs of colors. Each value is a color
         code in hex, formatted #rrggbb (like in HTML).
     :vartype colors: dict
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('id', str),
@@ -161,6 +170,8 @@ class VersionReply(_BaseReply):
     :vartype human_readable: str
     :ivar loaded_config_file_name: The current config path.
     :vartype loaded_config_file_name: str
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('major', int),
@@ -179,6 +190,8 @@ class ConfigReply(_BaseReply):
     :ivar config: A string containing the config file as loaded by i3 most
         recently.
     :vartype config: str
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('config', str),
@@ -192,6 +205,8 @@ class TickReply(_BaseReply):
 
     :ivar success: Whether the tick succeeded.
     :vartype success: bool
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('success', bool),
@@ -222,6 +237,8 @@ class InputReply(_BaseReply):
     :vartype xkb_active_layout_index: int
     :ivar libinput: (Only libinput devices) An object describing the current device settings.
     :vartype libinput: dict
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [
         ('identifier', str),
@@ -251,6 +268,8 @@ class SeatReply(_BaseReply):
     :vartype focus: int
     :ivar devices: An array of input devices that are attached to the seat.
     :vartype devices: list(:class:`InputReply`)
+    :ivar ipc_data: The raw data from the i3 ipc.
+    :vartype ipc_data: dict
     """
     _members = [('name', str), ('capabilities', int), ('focus', int),
                 ('devices', InputReply._parse_list)]