refactor: add Final and TypeAlias annotations

TotallyNotRobots · Apr 15, 2024 · 612ba7f · 612ba7f
1 parent c4034c8
commit 612ba7f
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 21 deletions.
diff --git a/irclib/parser.py b/irclib/parser.py
@@ -8,6 +8,7 @@
 from abc import ABCMeta, abstractmethod
 from typing import (
     Dict,
+    Final,
     Iterable,
     Iterator,
     List,
@@ -19,7 +20,7 @@
     cast,
 )
 
-from typing_extensions import Self
+from typing_extensions import Self, TypeAlias
 
 from irclib.errors import ParseError
 
@@ -32,37 +33,37 @@
     "ParamList",
     "Message",
 )
-MsgTagList = Optional["TagList"]
-MsgPrefix = Optional["Prefix"]
-MessageTuple = Tuple[MsgTagList, MsgPrefix, str, "ParamList"]
+MsgTagList: TypeAlias = Optional["TagList"]
+MsgPrefix: TypeAlias = Optional["Prefix"]
+MessageTuple: TypeAlias = Tuple[MsgTagList, MsgPrefix, str, "ParamList"]
 
-TAGS_SENTINEL = "@"
-TAGS_SEP = ";"
-TAG_VALUE_SEP = "="
+TAGS_SENTINEL: Final = "@"
+TAGS_SEP: Final = ";"
+TAG_VALUE_SEP: Final = "="
 
-PREFIX_SENTINEL = ":"
-PREFIX_USER_SEP = "!"
-PREFIX_HOST_SEP = "@"
+PREFIX_SENTINEL: Final = ":"
+PREFIX_USER_SEP: Final = "!"
+PREFIX_HOST_SEP: Final = "@"
 
-PARAM_SEP = " "
-TRAIL_SENTINEL = ":"
+PARAM_SEP: Final = " "
+TRAIL_SENTINEL: Final = ":"
 
-CAP_SEP = " "
-CAP_VALUE_SEP = "="
+CAP_SEP: Final = " "
+CAP_VALUE_SEP: Final = "="
 
-PREFIX_RE = re.compile(
+PREFIX_RE: Final = re.compile(
     r"^:?(?P<nick>.*?)(?:!(?P<user>.*?))?(?:@(?P<host>.*?))?$"
 )
 
-TAG_VALUE_ESCAPES = {
+TAG_VALUE_ESCAPES: Final = {
     "\\s": " ",
     "\\:": ";",
     "\\r": "\r",
     "\\n": "\n",
     "\\\\": "\\",
 }
 
-TAG_VALUE_UNESCAPES = {
+TAG_VALUE_UNESCAPES: Final = {
     unescaped: escaped for escaped, unescaped in TAG_VALUE_ESCAPES.items()
 }
 

diff --git a/irclib/util/compare.py b/irclib/util/compare.py
@@ -3,10 +3,11 @@
 """
 
 import re
+from typing import Final
 
 __all__ = ("match_mask",)
 
-GLOB_MAP = {"?": ".", "*": ".*"}
+GLOB_MAP: Final = {"?": ".", "*": ".*"}
 
 
 def match_mask(mask: str, pattern: str) -> bool:

diff --git a/irclib/util/string.py b/irclib/util/string.py
@@ -7,6 +7,7 @@
 from typing import (
     Callable,
     Dict,
+    Final,
     List,
     NamedTuple,
     Optional,
@@ -39,13 +40,13 @@ def upper_table(self) -> Dict[int, int]:
         return str.maketrans(self.upper, self.lower)
 
 
-RFC1459 = Casemap(
+RFC1459: Final = Casemap(
     "".join(map(chr, range(65, 95))), "".join(map(chr, range(97, 127)))
 )
-STRICT_RFC1459 = Casemap(
+STRICT_RFC1459: Final = Casemap(
     "".join(map(chr, range(65, 94))), "".join(map(chr, range(97, 126)))
 )
-ASCII = Casemap(
+ASCII: Final = Casemap(
     "".join(map(chr, range(65, 91))), "".join(map(chr, range(97, 123)))
 )