Introduce types.Final annotation

Author: rocky

trepan/api.py

@@ -37,14 +37,14 @@
 import os
 import sys
 import traceback
-from typing import Callable, Literal, Optional
+from typing import Callable, Final, Optional
 
 from trepan.debugger import Trepan, debugger_obj
 from trepan.interfaces.server import ServerInterface
 from trepan.lib.default import DEBUGGER_SETTINGS
 from trepan.post_mortem import post_mortem_excepthook, uncaught_exception
 
-DEFAULT_DEBUG_PORT: Literal[1955] = 1955
+DEFAULT_DEBUG_PORT: Final[int] = 1955
 
 
 def debug(

trepan/bwprocessor/main.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-#   Copyright (C) 2008-2010, 2013-2016, 2023 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2008-2010, 2013-2016, 2023, 2025 Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -19,6 +19,7 @@
 import sys
 import traceback
 from reprlib import Repr
+from typing import Final
 
 import pyficache
 
@@ -76,7 +77,7 @@ def resolve_name(obj, command_name):
 
 
 # Default settings for command processor method call
-DEFAULT_PROC_OPTS = {
+DEFAULT_PROC_OPTS: Final = {
     # A list of debugger initialization files to read on first command
     # loop entry.  Often this something like [~/.trepanrc] which the
     # front-end sets.

trepan/client.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-#   Copyright (C) 2009, 2013-2017, 2021, 2023-2024 Rocky Bernstein
+#   Copyright (C) 2009, 2013-2017, 2021, 2023-2025 Rocky Bernstein
 #
 #    This program is free software; you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -21,6 +21,7 @@
 import sys
 import time
 from optparse import OptionParser
+from typing import Final
 
 # Our local modules
 from trepan.api import DEFAULT_DEBUG_PORT
@@ -88,7 +89,7 @@ def process_options(pkg_version, sys_argv, option_list=None):
 #
 
 # DEFAULT_CLIENT_CONNECTION_OPTS = {'open': True, 'IO': 'FIFO'}
-DEFAULT_CLIENT_CONNECTION_OPTS = {
+DEFAULT_CLIENT_CONNECTION_OPTS: Final = {
     "open": True,
     "IO": "TCP",
     "HOST": "127.0.0.1",

trepan/inout/fifoclient.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-#   Copyright (C) 2009, 2013-2015, 2023 Rocky Bernstein
+#   Copyright (C) 2009, 2013-2015, 2023, 2025 Rocky Bernstein
 #   <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
@@ -20,6 +20,7 @@
 import os
 import tempfile
 
+from typing import Final
 from trepan import misc as Mmisc
 from trepan.inout.base import DebuggerInOutBase
 from trepan.lib import default as Mdefault, file as Mfile
@@ -28,7 +29,7 @@
 class FIFOClient(DebuggerInOutBase):
     """Debugger Client Input/Output Socket."""
 
-    DEFAULT_INIT_OPTS = {"open": True}
+    DEFAULT_INIT_OPTS: Final = {"open": True}
 
     def __init__(self, inp=None, opts=None):
         get_option = lambda key: Mmisc.option_set(

trepan/inout/fifoserver.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2009, 2013-2015 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2009, 2013-2015, 2025 Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -13,25 +13,26 @@
 #
 #   You should have received a copy of the GNU General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Debugger FIFO Input/Output interface. """
+"""Debugger FIFO Input/Output interface."""
 
 import os
+from typing import Final
 
 if hasattr(os, "mkfifo"):
     import atexit
     import tempfile
 
-    from trepan import misc as Mmisc
+    from trepan.misc import option_set
     from trepan.inout.base import DebuggerInOutBase
 
     # FIXME: Consider using Python's socketserver/SocketServer?
     class FIFOServer(DebuggerInOutBase):
         """Debugger Server Input/Output Socket."""
 
-        DEFAULT_INIT_OPTS = {"open": True}
+        DEFAULT_INIT_OPTS: Final = {"open": True}
 
         def __init__(self, opts=None):
-            get_option = lambda key: Mmisc.option_set(opts, key, self.DEFAULT_INIT_OPTS)
+            get_option = lambda key: option_set(opts, key, self.DEFAULT_INIT_OPTS)
             atexit.register(self.close)
             self.flush_after_write = True
             self.line_edit = False  # Our name for GNU readline capability

trepan/inout/tcpclient.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2009, 2013-2015 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2009, 2013-2015, 2025 Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -16,8 +16,9 @@
 """Debugger Socket Input/Output Interface."""
 
 import socket
+from typing import Final
 
-from trepan.lib import default as Mdefault
+from trepan.lib.default import CLIENT_SOCKET_OPTS
 from trepan.inout import tcpfns as Mtcpfns
 from trepan.inout.base import DebuggerInOutBase
 from trepan.misc import option_set
@@ -26,10 +27,10 @@
 class TCPClient(DebuggerInOutBase):
     """Debugger Client Input/Output Socket."""
 
-    DEFAULT_INIT_OPTS = {"open": True}
+    DEFAULT_INIT_OPTS: Final = {"open": True}
 
     def __init__(self, inout=None, opts=None):
-        get_option = lambda key: option_set(opts, key, Mdefault.CLIENT_SOCKET_OPTS)
+        get_option = lambda key: option_set(opts, key, CLIENT_SOCKET_OPTS)
         self.inout = None
         self.addr = None
         self.buf = ""
@@ -52,13 +53,13 @@ def close(self):
 
     def open(self, opts=None):
 
-        get_option = lambda key: option_set(opts, key, Mdefault.CLIENT_SOCKET_OPTS)
+        get_option = lambda key: option_set(opts, key, CLIENT_SOCKET_OPTS)
 
         HOST = get_option("HOST")
         PORT = get_option("PORT")
         self.inout = None
         for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
-            af, socktype, proto, canonname, sa = res
+            af, socktype, proto, _, sa = res
             try:
                 self.inout = socket.socket(af, socktype, proto)
                 self.state = "connected"
@@ -72,7 +73,6 @@ def open(self, opts=None):
                 self.inout.close()
                 self.inout = None
                 continue
-                break
         if self.inout is None:
             raise IOError("could not open client socket on port %s" % PORT)
         return

trepan/inout/tcpserver.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#   Copyright (C) 2009, 2013-2014, 2016-2017 Rocky Bernstein <rocky@gnu.org>
+#   Copyright (C) 2009, 2013-2014, 2016-2017, 2025 Rocky Bernstein <rocky@gnu.org>
 #
 #   This program is free software: you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -17,6 +17,7 @@
 
 import socket, errno
 
+from typing import Final
 from trepan.lib import default as Mdefault
 from trepan import misc as Mmisc
 from trepan.inout import tcpfns as Mtcpfns
@@ -27,7 +28,7 @@
 class TCPServer(DebuggerInOutBase):
     """Debugger Server Input/Output Socket."""
 
-    DEFAULT_INIT_OPTS = {"open": True, "socket": None}
+    DEFAULT_INIT_OPTS: Final = {"open": True, "socket": None}
 
     def __init__(self, inout=None, opts=None):
         get_option = lambda key: Mmisc.option_set(opts, key, self.DEFAULT_INIT_OPTS)

trepan/processor/parse/parser.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2018 Rocky Bernstein
+#  Copyright (c) 2017-2018, 2025 Rocky Bernstein
 """
 Parsing for a trepan2/trepan3k debugger
 "breakpoint' or "list" command arguments
@@ -8,7 +8,7 @@
  - a range or count for "list" commands
 """
 
-from __future__ import print_function
+from typing import Final
 
 import sys
 from spark_parser.ast import AST
@@ -17,7 +17,7 @@
 
 from spark_parser import GenericASTBuilder
 
-DEFAULT_DEBUG = {
+DEFAULT_DEBUG: Final = {
     "rules": False,
     "transition": False,
     "reduce": False,