update annotations for python 3.12

Author: eternal-sorrow

i3ipc/con.py

@@ -1,17 +1,17 @@
 import re
 import sys
-from .model import Rect, Gaps
-from . import replies
 from collections import deque
-from typing import Any, cast, Generic, Literal, Optional, TypeVar, TYPE_CHECKING
+from collections.abc import Iterator
+from typing import TYPE_CHECKING, Any, Literal, Optional, Self
+
+from . import replies
+from .model import Gaps, Rect
 
 if TYPE_CHECKING:
     from .connection import Connection
 
-_Con = TypeVar('_Con', bound='Con')
-
 
-class Con(Generic[_Con]):
+class Con:
     """A container of a window and child containers gotten from :func:`i3ipc.Connection.get_tree()` or events.
 
     .. seealso:: https://i3wm.org/docs/ipc.html#_tree_reply
@@ -123,7 +123,7 @@ class Con(Generic[_Con]):
     representation: str
     visible: bool
 
-    def __init__(self: _Con, data: dict[str, Any], parent: _Con, conn: 'Connection'):
+    def __init__(self, data: dict[str, Any], parent: Self, conn: 'Connection'):
         self.ipc_data = data
         self._conn = conn
         self.parent = parent
@@ -142,7 +142,7 @@ def __init__(self: _Con, data: dict[str, Any], parent: _Con, conn: 'Connection')
                 setattr(self, attr, None)
 
         # XXX in 4.12, marks is an array (old property was a string "mark")
-        if self.marks is None:
+        if self.marks is None:  # type: ignore reportUnnecessaryComparison
             self.marks = []
             if 'mark' in data and data['mark']:
                 self.marks.append(data['mark'])
@@ -161,15 +161,15 @@ def __init__(self: _Con, data: dict[str, Any], parent: _Con, conn: 'Connection')
                 self.type = "dockarea"
 
         # set complex properties
-        self.nodes = []
+        self.nodes: list[Self] = []
         if 'nodes' in data:
             for n in data['nodes']:
-                self.nodes.append(cast(_Con, self.__class__(n, self, conn)))
+                self.nodes.append(self.__class__(n, self, conn))
 
-        self.floating_nodes = []
+        self.floating_nodes: list[Self] = []
         if 'floating_nodes' in data:
             for n in data['floating_nodes']:
-                self.floating_nodes.append(cast(_Con, self.__class__(n, self, conn)))
+                self.floating_nodes.append(self.__class__(n, self, conn))
 
         self.window_class = None
         self.window_instance = None
@@ -201,7 +201,7 @@ def __init__(self: _Con, data: dict[str, Any], parent: _Con, conn: 'Connection')
         if 'gaps' in data:
             self.gaps = Gaps(data['gaps'])
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[Self]:
         """Iterate through the descendents of this node (breadth-first tree traversal)
         """
         queue = deque(self.nodes)
@@ -223,15 +223,15 @@ def is_floating(self) -> bool:
             return True
         return False
 
-    def root(self) -> _Con:
+    def root(self) -> Self:
         """Gets the root container.
 
         :returns: The root container.
         :rtype: :class:`Con`
         """
 
         if not self.parent:
-            return cast(_Con, self)
+            return self
 
         con = self.parent
 
@@ -240,7 +240,7 @@ def root(self) -> _Con:
 
         return con
 
-    def descendants(self) -> list[_Con]:
+    def descendants(self) -> list[Self]:
         """Gets a list of all child containers for the container in
         breadth-first order.
 
@@ -249,7 +249,7 @@ def descendants(self) -> list[_Con]:
         """
         return [c for c in self]
 
-    def descendents(self) -> list[_Con]:
+    def descendents(self) -> list[Self]:
         """Gets a list of all child containers for the container in
         breadth-first order.
 
@@ -262,15 +262,15 @@ def descendents(self) -> list[_Con]:
         print('WARNING: descendents is deprecated. Use `descendants()` instead.', file=sys.stderr)
         return self.descendants()
 
-    def leaves(self) -> list[_Con]:
+    def leaves(self) -> list[Self]:
         """Gets a list of leaf child containers for this container in
         breadth-first order. Leaf containers normally contain application
         windows.
 
         :returns: A list of leaf descendants.
         :rtype: list(:class:`Con`)
         """
-        leaves = []
+        leaves: list[Self] = []
 
         for c in self:
             if not c.nodes and c.type == "con" and c.parent.type != "dockarea":
@@ -299,21 +299,21 @@ def command_children(self, command: str) -> list[replies.CommandReply]:
         :rtype: list(:class:`CommandReply <i3ipc.CommandReply>`)
         """
 
-        commands = []
+        commands: list[str] = []
         for c in self.nodes:
             commands.append('[con_id="{}"] {};'.format(c.id, command))
 
         return self._conn.command(' '.join(commands))
 
-    def workspaces(self) -> list[_Con]:
+    def workspaces(self) -> list[Self]:
         """Gets a list of workspace containers for this tree.
 
         :returns: A list of workspace containers.
         :rtype: list(:class:`Con`)
         """
-        workspaces = []
+        workspaces: list[Self] = []
 
-        def collect_workspaces(con):
+        def collect_workspaces(con: Self):
             if con.type == "workspace" and not con.name.startswith('__'):
                 workspaces.append(con)
                 return
@@ -324,7 +324,7 @@ def collect_workspaces(con):
         collect_workspaces(self.root())
         return workspaces
 
-    def find_focused(self) -> Optional[_Con]:
+    def find_focused(self) -> Optional[Self]:
         """Finds the focused container under this container if it exists.
 
         :returns: The focused container if it exists.
@@ -336,7 +336,7 @@ def find_focused(self) -> Optional[_Con]:
         except StopIteration:
             return None
 
-    def find_by_id(self, id: int) -> Optional[_Con]:
+    def find_by_id(self, id: int) -> Optional[Self]:
         """Finds a container with the given container id under this node.
 
         :returns: The container with this container id if it exists.
@@ -348,15 +348,15 @@ def find_by_id(self, id: int) -> Optional[_Con]:
         except StopIteration:
             return None
 
-    def find_by_pid(self, pid: int) -> list[_Con]:
+    def find_by_pid(self, pid: int) -> list[Self]:
         """Finds all the containers under this node with this pid.
 
         :returns: A list of containers with this pid.
         :rtype: list(:class:`Con`)
         """
         return [c for c in self if c.pid == pid]
 
-    def find_by_window(self, window: int) -> Optional[_Con]:
+    def find_by_window(self, window: int) -> Optional[Self]:
         """Finds a container with the given window id under this node.
 
         :returns: The container with this window id if it exists.
@@ -368,7 +368,7 @@ def find_by_window(self, window: int) -> Optional[_Con]:
         except StopIteration:
             return None
 
-    def find_by_role(self, pattern: str) -> list[_Con]:
+    def find_by_role(self, pattern: str) -> list[Self]:
         """Finds all the containers under this node with a window role that
         matches the given regex pattern.
 
@@ -378,7 +378,7 @@ def find_by_role(self, pattern: str) -> list[_Con]:
         """
         return [c for c in self if c.window_role and re.search(pattern, c.window_role)]
 
-    def find_named(self, pattern: str) -> list[_Con]:
+    def find_named(self, pattern: str) -> list[Self]:
         """Finds all the containers under this node with a name that
         matches the given regex pattern.
 
@@ -388,7 +388,7 @@ def find_named(self, pattern: str) -> list[_Con]:
         """
         return [c for c in self if c.name and re.search(pattern, c.name)]
 
-    def find_titled(self, pattern: str) -> list[_Con]:
+    def find_titled(self, pattern: str) -> list[Self]:
         """Finds all the containers under this node with a window title that
         matches the given regex pattern.
 
@@ -398,7 +398,7 @@ def find_titled(self, pattern: str) -> list[_Con]:
         """
         return [c for c in self if c.window_title and re.search(pattern, c.window_title)]
 
-    def find_classed(self, pattern: str) -> list[_Con]:
+    def find_classed(self, pattern: str) -> list[Self]:
         """Finds all the containers under this node with a window class,
         or app_id that matches the given regex pattern.
 
@@ -411,7 +411,7 @@ def find_classed(self, pattern: str) -> list[_Con]:
 
         return x11_windows + wayland_windows
 
-    def find_instanced(self, pattern: str) -> list[_Con]:
+    def find_instanced(self, pattern: str) -> list[Self]:
         """Finds all the containers under this node with a window instance that
         matches the given regex pattern.
 
@@ -421,7 +421,7 @@ def find_instanced(self, pattern: str) -> list[_Con]:
         """
         return [c for c in self if c.window_instance and re.search(pattern, c.window_instance)]
 
-    def find_marked(self, pattern: str = ".*") -> list[_Con]:
+    def find_marked(self, pattern: str = ".*") -> list[Self]:
         """Finds all the containers under this node with a mark that
         matches the given regex pattern.
 
@@ -432,7 +432,7 @@ def find_marked(self, pattern: str = ".*") -> list[_Con]:
         cpattern = re.compile(pattern)
         return [c for c in self if any(cpattern.search(mark) for mark in c.marks)]
 
-    def find_fullscreen(self) -> list[_Con]:
+    def find_fullscreen(self) -> list[Self]:
         """Finds all the containers under this node that are in fullscreen
         mode.
 
@@ -441,7 +441,7 @@ def find_fullscreen(self) -> list[_Con]:
         """
         return [c for c in self if c.type == 'con' and c.fullscreen_mode]
 
-    def workspace(self) -> Optional[_Con]:
+    def workspace(self) -> Optional[Self]:
         """Finds the workspace container for this node if this container is at
         or below the workspace level.
 
@@ -450,7 +450,7 @@ def workspace(self) -> Optional[_Con]:
             workspace level.
         """
         if self.type == 'workspace':
-            return cast(_Con, self)
+            return self
 
         ret = self.parent
 
@@ -461,7 +461,7 @@ def workspace(self) -> Optional[_Con]:
 
         return ret
 
-    def scratchpad(self) -> Optional[_Con]:
+    def scratchpad(self) -> Optional[Self]:
         """Finds the scratchpad container.
 
         :returns: The scratchpad container.