ttktui: add experimental TermTk based text user interface

Launch in a terminal with command line argument `nicotine --tui`

Author: slook

pynicotine/__init__.py

@@ -68,6 +68,10 @@ def check_arguments():
         "-n", "--headless", action="store_true",
         help=_("start the program in headless mode (no GUI)")
     )
+    parser.add_argument(
+        "-t", "--tui", action="store_true",
+        help=_("start experimental text user interface (TermTk TUI)")
+    )
     parser.add_argument(
         "-v", "--version", action="version", version=f"{__application_name__} {__version__}",
         help=_("display version and exit")
@@ -95,7 +99,7 @@ def check_arguments():
     core.cli_listen_port = args.port
     core.cli_rescanning = args.rescan
 
-    return args.headless, args.hidden, args.ci_mode, args.isolated, args.rescan, multi_instance
+    return args.headless, args.tui, args.hidden, args.ci_mode, args.isolated, args.rescan, multi_instance
 
 
 def check_python_version():
@@ -187,14 +191,15 @@ def run():
     set_up_python()
     rename_process(b"nicotine")
 
-    headless, hidden, ci_mode, isolated_mode, rescan, multi_instance = check_arguments()
+    headless, tui, hidden, ci_mode, isolated_mode, rescan, multi_instance = check_arguments()
     error = check_python_version()
 
     if error:
         print(error)
         return 1
 
     core.init_components(
+        disabled_components={"cli"} if tui else None,  # "error_handler",
         enabled_components={"signal_handler", "cli", "shares"} if rescan else None,
         isolated_mode=isolated_mode
     )
@@ -213,8 +218,16 @@ def run():
     if rescan:
         return rescan_shares()
 
-    # Initialize GTK-based GUI
-    if not headless:
+    if tui:
+        # Initialize TTk-based TUI
+        from pynicotine import ttktui as application
+        exit_code = application.run(ci_mode, isolated_mode)
+
+        if exit_code is not None:
+            return exit_code
+
+    elif not headless:
+        # Initialize GTK-based GUI
         from pynicotine import gtkgui as application
         exit_code = application.run(hidden, ci_mode, isolated_mode, multi_instance)
 

pynicotine/core.py

@@ -51,18 +51,15 @@ def __init__(self):
 
         self.enabled_components = set()
 
-    def init_components(self, enabled_components=None, isolated_mode=False):
+    def init_components(self, disabled_components=None, enabled_components=None, isolated_mode=False):
 
         # Enable all components by default
-        if enabled_components is None:
-            enabled_components = {
-                "error_handler", "signal_handler", "cli", "portmapper", "network_thread", "shares", "users",
-                "notifications", "network_filter", "now_playing", "statistics", "port_checker", "update_checker",
-                "search", "downloads", "uploads", "interests", "userbrowse", "userinfo", "buddies",
-                "chatrooms", "privatechat", "pluginhandler"
-            }
-
-        self.enabled_components = enabled_components
+        self.enabled_components = enabled_components = enabled_components or {
+            "error_handler", "signal_handler", "cli", "portmapper", "network_thread", "shares", "users",
+            "notifications", "network_filter", "now_playing", "statistics", "port_checker", "update_checker",
+            "search", "downloads", "uploads", "interests", "userbrowse", "userinfo", "buddies",
+            "chatrooms", "privatechat", "pluginhandler"
+        } - (disabled_components or set())
 
         if "error_handler" in enabled_components:
             self._init_error_handler()

pynicotine/external/pyTermTk/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Eugenio Parodi <ceccopierangiolieugenio AT googlemail DOT com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pynicotine/external/pyTermTk/TermTk/TTkAbstract/__init__.py

@@ -0,0 +1,5 @@
+from .abstractscrollview import *
+from .abstractscrollarea import *
+from .abstractitemmodel  import *
+from .abstracttablemodel import *
+from .abstract_list_item  import *

pynicotine/external/pyTermTk/TermTk/TTkAbstract/abstract_list_item.py

@@ -0,0 +1,58 @@
+# MIT License
+#
+# Copyright (c) 2026 Eugenio Parodi <ceccopierangiolieugenio AT googlemail DOT com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+__all__  =['_TTkAbstractListItem']
+
+from typing import Any
+
+from TermTk.TTkCore.signal import pyTTkSignal
+from TermTk.TTkCore.string import TTkString
+
+class _TTkAbstractListItem():
+    '''_TTkAbstractListItem:
+
+    .. note::
+        This is the future abstract base interface for list items.
+
+    This class defines the minimal interface that list items must implement.
+    In a future version, :py:class:`TTkAbstractListItem` will be converted to
+    inherit from this abstract interface, requiring custom implementations to
+    provide these methods if they don't use the default :py:class:`TTkListItem`.
+
+    Currently used as an internal marker for the planned architecture migration.
+    '''
+    __slots__ = ('dataChanged')
+
+    def __init__(self):
+       self.dataChanged = pyTTkSignal()
+
+    def data(self) -> Any:
+        '''
+        Returns the user data associated with this item.
+
+        :return: The custom data object
+        :rtype: Any
+        '''
+        raise NotImplementedError
+
+    def toTTkString(self) -> TTkString:
+        return TTkString(str(self.data()))

pynicotine/external/pyTermTk/TermTk/TTkAbstract/abstractitemmodel.py

@@ -0,0 +1,34 @@
+# MIT License
+#
+# Copyright (c) 2021 Eugenio Parodi <ceccopierangiolieugenio AT googlemail DOT com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+__all__ = ['TTkAbstractItemModel']
+
+from TermTk.TTkCore.signal import pyTTkSignal
+
+class TTkAbstractItemModel():
+    '''TTkAbstractItemModel'''
+    __slots__ = (
+        # Signals
+        'dataChanged'
+    )
+    def __init__(self) -> None:
+        self.dataChanged = pyTTkSignal()