ruff: Fix RUF012 Mutable class attributes should be annotated with typing.ClassVar.

Signed-off-by: Anders Kaseorg <[email protected]>

Author: andersk

zulip/integrations/bridge_with_matrix/matrix_bridge.py

@@ -12,7 +12,7 @@
 from collections import OrderedDict
 from concurrent.futures import ThreadPoolExecutor
 from io import BytesIO
-from typing import Any, Dict, List, Match, Optional, Set, Tuple, Type, Union
+from typing import Any, ClassVar, Dict, List, Match, Optional, Set, Tuple, Type, Union
 
 import nio
 from nio.responses import (
@@ -52,7 +52,7 @@ class MatrixToZulip:
     Matrix -> Zulip
     """
 
-    non_formatted_messages: Dict[Type[nio.Event], str] = {
+    non_formatted_messages: ClassVar[Dict[Type[nio.Event], str]] = {
         nio.StickerEvent: "sticker",
     }
 

zulip/integrations/bridge_with_matrix/test_matrix.py

@@ -5,7 +5,7 @@
 from contextlib import contextmanager
 from subprocess import PIPE, Popen
 from tempfile import mkdtemp
-from typing import Any, Awaitable, Callable, Iterator, List
+from typing import Any, Awaitable, Callable, Final, Iterator, List
 from unittest import TestCase, mock
 
 import nio
@@ -209,13 +209,13 @@ def __init__(self, sender: str = self.user_uid) -> None:
 
 class MatrixBridgeZulipToMatrixTests(TestCase):
     room = mock.MagicMock()
-    valid_zulip_config = dict(
+    valid_zulip_config: Final = dict(
         stream="some stream",
         topic="some topic",
         email="some@email",
         bridges={("some stream", "some topic"): room},
     )
-    valid_msg = dict(
+    valid_msg: Final = dict(
         sender_email="[email protected]",  # must not be equal to config:email
         sender_id=42,
         type="stream",  # Can only mirror Zulip streams

zulip/integrations/zephyr/zephyr_ctypes.py

@@ -32,10 +32,10 @@
 
 
 class sockaddr(Structure):
-    _fields_ = [
+    _fields_ = (
         ("sa_family", sa_family_t),
         ("sa_data", c_char * 14),
-    ]
+    )
 
 
 # --- glibc/inet/netinet/in.h ---
@@ -45,34 +45,30 @@ class sockaddr(Structure):
 
 
 class in_addr(Structure):
-    _fields_ = [
-        ("s_addr", in_addr_t),
-    ]
+    _fields_ = (("s_addr", in_addr_t),)
 
 
 class sockaddr_in(Structure):
-    _fields_ = [
+    _fields_ = (
         ("sin_family", sa_family_t),
         ("sin_port", in_port_t),
         ("sin_addr", in_addr),
         ("sin_zero", c_uint8 * 8),
-    ]
+    )
 
 
 class in6_addr(Structure):
-    _fields_ = [
-        ("s6_addr", c_uint8 * 16),
-    ]
+    _fields_ = (("s6_addr", c_uint8 * 16),)
 
 
 class sockaddr_in6(Structure):
-    _fields_ = [
+    _fields_ = (
         ("sin6_family", sa_family_t),
         ("sin6_port", in_port_t),
         ("sin6_flowinfo", c_uint32),
         ("sin6_addr", in6_addr),
         ("sin6_scope_id", c_uint32),
-    ]
+    )
 
 
 # --- glibc/stdlib/stdlib.h ---
@@ -93,32 +89,32 @@ class sockaddr_in6(Structure):
 
 
 class _ZTimeval(Structure):
-    _fields_ = [
+    _fields_ = (
         ("tv_sec", c_int),
         ("tv_usec", c_int),
-    ]
+    )
 
 
 class ZUnique_Id_t(Structure):
-    _fields_ = [
+    _fields_ = (
         ("zuid_addr", in_addr),
         ("tv", _ZTimeval),
-    ]
+    )
 
 
 ZChecksum_t = c_uint
 
 
 class _ZSenderSockaddr(Union):
-    _fields_ = [
+    _fields_ = (
         ("sa", sockaddr),
         ("ip4", sockaddr_in),
         ("ip6", sockaddr_in6),
-    ]
+    )
 
 
 class ZNotice_t(Structure):
-    _fields_ = [
+    _fields_ = (
         ("z_packet", c_char_p),
         ("z_version", c_char_p),
         ("z_kind", ZNotice_Kind_t),
@@ -147,15 +143,15 @@ class ZNotice_t(Structure):
         ("z_message_len", c_int),
         ("z_num_hdr_fields", c_uint),
         ("z_hdr_fields", POINTER(c_char_p)),
-    ]
+    )
 
 
 class ZSubscription_t(Structure):
-    _fields_ = [
+    _fields_ = (
         ("zsub_recipient", c_char_p),
         ("zsub_class", c_char_p),
         ("zsub_classinst", c_char_p),
-    ]
+    )
 
 
 Code_t = c_int

zulip/integrations/zephyr/zephyr_mirror_backend.py

@@ -14,6 +14,7 @@
 import textwrap
 import time
 from ctypes import POINTER, byref, c_char, c_int, c_ushort
+from enum import Enum, auto
 from pathlib import Path
 from queue import Queue
 from threading import Thread
@@ -29,8 +30,10 @@
 DEFAULT_SITE = "https://api.zulip.com"
 
 
-class States:
-    Startup, ZulipToZephyr, ZephyrToZulip = list(range(3))
+class States(Enum):
+    Startup = auto()
+    ZulipToZephyr = auto()
+    ZephyrToZulip = auto()
 
 
 CURRENT_STATE = States.Startup

zulip_bots/zulip_bots/bots/beeminder/test_beeminder.py

@@ -1,3 +1,4 @@
+from typing import Final
 from unittest.mock import patch
 
 from requests.exceptions import ConnectionError
@@ -8,7 +9,7 @@
 
 class TestBeeminderBot(BotTestCase, DefaultTests):
     bot_name = "beeminder"
-    normal_config = {"auth_token": "XXXXXX", "username": "aaron", "goalname": "goal"}
+    normal_config: Final = {"auth_token": "XXXXXX", "username": "aaron", "goalname": "goal"}
 
     help_message = """
 You can add datapoints towards your beeminder goals \

zulip_bots/zulip_bots/bots/connect_four/connect_four.py

@@ -5,7 +5,7 @@
 
 
 class ConnectFourMessageHandler:
-    tokens = [":blue_circle:", ":red_circle:"]
+    tokens = (":blue_circle:", ":red_circle:")
 
     def parse_board(self, board: Any) -> str:
         # Header for the top of the board

zulip_bots/zulip_bots/bots/connect_four/test_connect_four.py

@@ -1,4 +1,4 @@
-from typing import Dict, List
+from typing import Dict, Final, List
 
 from typing_extensions import override
 
@@ -99,7 +99,7 @@ def test_game_message_handler_responses(self) -> None:
 The first player to get 4 in a row wins!\n Good Luck!",
         )
 
-    blank_board = [
+    blank_board: Final = [
         [0, 0, 0, 0, 0, 0, 0],
         [0, 0, 0, 0, 0, 0, 0],
         [0, 0, 0, 0, 0, 0, 0],
@@ -108,7 +108,7 @@ def test_game_message_handler_responses(self) -> None:
         [0, 0, 0, 0, 0, 0, 0],
     ]
 
-    almost_win_board = [
+    almost_win_board: Final = [
         [0, 0, 0, 0, 0, 0, 0],
         [0, 0, 0, 0, 0, 0, 0],
         [0, 0, 0, 0, 0, 0, 0],
@@ -117,7 +117,7 @@ def test_game_message_handler_responses(self) -> None:
         [1, -1, 0, 0, 0, 0, 0],
     ]
 
-    almost_draw_board = [
+    almost_draw_board: Final = [
         [1, -1, 1, -1, 1, -1, 0],
         [0, 0, 0, 0, 0, 0, 1],
         [0, 0, 0, 0, 0, 0, -1],

zulip_bots/zulip_bots/bots/dropbox_share/test_dropbox_share.py

@@ -1,3 +1,4 @@
+from typing import Final
 from unittest.mock import patch
 
 from zulip_bots.bots.dropbox_share.test_util import (
@@ -75,7 +76,7 @@ def get_help() -> str:
 
 class TestDropboxBot(BotTestCase, DefaultTests):
     bot_name = "dropbox_share"
-    config_info = {"access_token": "1234567890"}
+    config_info: Final = {"access_token": "1234567890"}
 
     def test_bot_responds_to_empty_message(self):
         with self.mock_config_info(self.config_info):

zulip_bots/zulip_bots/bots/flock/test_flock.py

@@ -1,3 +1,4 @@
+from typing import Final
 from unittest.mock import patch
 
 from requests.exceptions import ConnectionError
@@ -7,9 +8,9 @@
 
 class TestFlockBot(BotTestCase, DefaultTests):
     bot_name = "flock"
-    normal_config = {"token": "12345"}
+    normal_config: Final = {"token": "12345"}
 
-    message_config = {"token": "12345", "text": "Ricky: test message", "to": "u:somekey"}
+    message_config: Final = {"token": "12345", "text": "Ricky: test message", "to": "u:somekey"}
 
     help_message = """
 You can send messages to any Flock user associated with your account from Zulip.

zulip_bots/zulip_bots/bots/front/front.py

@@ -8,13 +8,13 @@
 
 class FrontHandler:
     FRONT_API = "https://api2.frontapp.com/conversations/{}"
-    COMMANDS = [
+    COMMANDS = (
         ("archive", "Archive a conversation."),
         ("delete", "Delete a conversation."),
         ("spam", "Mark a conversation as spam."),
         ("open", "Restore a conversation."),
         ("comment <text>", "Leave a comment."),
-    ]
+    )
     CNV_ID_REGEXP = "cnv_(?P<id>[0-9a-z]+)"
     COMMENT_PREFIX = "comment "