Merge pull request #477 from jcwinkler/improved_setup

jcwinkler · web-flow · commit 9402ea50deca · 2025-07-11T06:25:14.000+02:00
Improved setup
diff --git a/docs/source/install/advanced.rst b/docs/source/install/advanced.rst
@@ -38,6 +38,13 @@ options to adapt the installation process to your system configuration:
 --typst-executable TYPST_EXECUTABLE
     Full path to typst executable.
 
+--use-tk
+    Use the Tk Interface (tkinter) for the user interface instead of the GTK3 UI.
+    This might be useful in cases where the GTK3 installation is broken, i.e.
+    when loading of the framework works but execution errors occur. In that case
+    TexText will not fall back to tkinter automatically. Hence, this switch can
+    be used to bypass the GTK3 framework.
+
 --portable-apps-dir INSTALLATION_DIRECTORY_OF_PORTABLEAPPS
     Windows only: If you use Inkscape from PortableApps use this parameter
     to specifiy the directory into which PortableApps has been installed, e.g.
@@ -58,7 +65,8 @@ options to adapt the installation process to your system configuration:
     Don't install extension (just check the requirements).
 
 --keep-previous-installation-files
-    Keep/discard files from previous installation, suppress prompt.
+    Keep files from previous installation which might have been modified
+    by the user (e.g. preamble files) without prompting the user
 
 --all-users
     Install globally for all users (sudo/ admin privileges required)
@@ -71,3 +79,6 @@ options to adapt the installation process to your system configuration:
 
 --color always, --color never
     Enables/disable console colors.
+
+--verbose
+    Print additional messages during setup
diff --git a/setup.py b/setup.py
@@ -24,7 +24,7 @@
     set_logging_levels, \
     TexTextRequirementsChecker, \
     defaults, \
-    LoggingColors, \
+    TexTextLogFormatter, \
     SUCCESS
 
 from textext.utility import Settings, Cache
@@ -60,10 +60,7 @@ def query_yes_no(question, default="yes"):
         prompt = " [y/N] "
     else:
         raise ValueError("invalid default answer: '%s'" % default)
-    if sys.version_info[0] > 2:
-        read_input = input
-    else:
-        read_input = raw_input
+    read_input = input
     while True:
         sys.stdout.write(question + prompt)
         choice = read_input().lower()
@@ -108,9 +105,9 @@ def __enter__(self):
             dst = os.path.join(self.tmp_dir, old_name)
             if os.path.isfile(src):
                 if not os.path.isdir(os.path.dirname(dst)):
-                    logger.info("Creating directory `%s`" % os.path.dirname(dst) )
+                    logger.debug("Creating directory `%s`" % os.path.dirname(dst) )
                     os.makedirs(os.path.dirname(dst))
-                logger.info("Stashing `%s`" % dst)
+                logger.debug("Stashing `%s`" % dst)
                 shutil.copy2(src, dst)
 
     def __exit__(self, exc_type, exc_val, exc_tb):
@@ -119,9 +116,9 @@ def __exit__(self, exc_type, exc_val, exc_tb):
             dst = os.path.join(self.unstash_to, new_name)
             if os.path.isfile(src):
                 if not os.path.isdir(os.path.dirname(dst)):
-                    logger.info("Creating directory `%s`" % os.path.dirname(dst) )
+                    logger.debug("Creating directory `%s`" % os.path.dirname(dst) )
                     os.makedirs(os.path.dirname(dst))
-                logger.info("Restoring old `%s` -> `%s`" % (old_name, dst))
+                logger.debug("Restoring old `%s` -> `%s`" % (old_name, dst))
                 shutil.copy2(src, dst)
 
 
@@ -159,7 +156,7 @@ def copy_extension_files(src, dst, if_already_exists="raise"):
             logger.critical("Can't copy files to `%s`: it's not a directory")
             raise CopyFileOverDirectoryError("Can't copy files to `%s`: it's not a directory")
     else:
-        logger.info("Creating directory `%s`" % dst)
+        logger.debug("Creating directory `%s`" % dst)
         os.makedirs(dst)
 
     for file in glob.glob(src):
@@ -174,17 +171,17 @@ def copy_extension_files(src, dst, if_already_exists="raise"):
                 logger.critical("Can't copy `%s`: `%s` already exists" % (file, destination))
                 raise CopyFileAlreadyExistsError("Can't copy `%s`: `%s` already exists" % (file, destination))
             elif if_already_exists == "skip":
-                logger.info("Skipping `%s`" % file)
+                logger.debug("Skipping `%s`" % file)
                 continue
             elif if_already_exists == "overwrite":
-                logger.info("Overwriting `%s`" % destination)
+                logger.debug("Overwriting `%s`" % destination)
                 pass
 
         if os.path.isfile(file):
-            logger.info("Copying `%s` to `%s`" % (file, destination))
+            logger.debug(f"Copying '{file}' to '{destination}'")
             shutil.copy(file, destination)
         else:
-            logger.info("Creating directory `%s`" % destination)
+            logger.debug("Creating directory '{destination}'")
 
             if os.path.exists(destination):
                 if not os.path.isdir(destination):
@@ -199,10 +196,10 @@ def copy_extension_files(src, dst, if_already_exists="raise"):
 
 def remove_previous_installation(extension_dir):
     previous_installation_files_and_folders = [
-        "asktext.py",
+        "textext",                  # <- Whole textext directory (more recent versions of TexText)
+        "asktext.py",               # <- Files directly in the extension directory (old versions of TexText)
         "default_packages.tex",
         "latexlogparser.py",
-        "textext",
         "textext.inx",
         "textext.py",
         "typesetter.py",
@@ -211,10 +208,10 @@ def remove_previous_installation(extension_dir):
     for file_or_dir in previous_installation_files_and_folders:
         file_or_dir = os.path.abspath(os.path.join(extension_dir, file_or_dir))
         if os.path.isfile(file_or_dir) or os.path.islink(file_or_dir):
-            logger.info("Removing `%s`" % file_or_dir)
+            logger.debug("Removing `%s`" % file_or_dir)
             os.remove(file_or_dir)
         elif os.path.isdir(file_or_dir):
-            logger.info("Removing `%s`" % file_or_dir)
+            logger.debug("Removing `%s`" % file_or_dir)
             shutil.rmtree(file_or_dir)
         else:
             logger.debug("`%s` is not found" % file_or_dir)
@@ -223,15 +220,14 @@ def remove_previous_installation(extension_dir):
 if __name__ == "__main__":
 
     EXIT_SUCCESS = 0
-    EXIT_REQUIREMENT_CHECK_UNKNOWN = 64
     EXIT_REQUIREMENT_CHECK_FAILED = 65
     EXIT_BAD_COMMAND_LINE_ARGUMENT_VALUE = 2
 
     parser = argparse.ArgumentParser(description='Install TexText')
 
     parser.add_argument(
         "--inkscape-extensions-path",
-        default=defaults.inkscape_user_extensions_path,
+        default=None,
         type=str,
         help="Path to inkscape extensions directory"
     )
@@ -285,6 +281,13 @@ def remove_previous_installation(extension_dir):
         help="Bypass minimal requirements check"
     )
 
+    parser.add_argument(
+        "--use-tk",
+        default=False,
+        action='store_true',
+        help="Use the Tk Interface (tkinter) for the user interface instead of the GTK3 UI"
+    )
+
     parser.add_argument(
         "--skip-extension-install",
         default=False,
@@ -296,7 +299,8 @@ def remove_previous_installation(extension_dir):
         "--keep-previous-installation-files",
         default=None,
         action='store_true',
-        help="Keep/discard files from previous installation, suppress prompt"
+        help="Keep files from previous installation which maybe modified by the user "
+             "(e.g. preamble files) without prompting the user"
     )
 
     parser.add_argument(
@@ -313,34 +317,51 @@ def remove_previous_installation(extension_dir):
         help="Enables/disable console colors"
     )
 
+    parser.add_argument(
+        "--verbose",
+        default=False,
+        action="store_true",
+        help="Print additional messages during setup"
+    )
+
+    # Files which maybe modified by the user and which, be default, should
+    # be kept upon user request
     files_to_keep = {  # old_name : new_name
         "default_packages.tex": "textext/default_packages.tex",  # old layout
-        "textext/default_packages.tex": "textext/default_packages.tex"
+        "textext/default_packages.tex": "textext/default_packages.tex",
+        "textext/default_preamble_typst.typ": "textext/default_preamble_typst.typ"
     }
 
     args = parser.parse_args()
 
+    if args.inkscape_extensions_path is None:
+        args.inkscape_extensions_path = defaults.inkscape_user_extensions_path
+
     if args.color == "always":
-        LoggingColors.enable_colors = True
+        TexTextLogFormatter.enable_colors = True
     elif args.color == "never":
-        LoggingColors.enable_colors = False
+        TexTextLogFormatter.enable_colors = False
 
     set_logging_levels()
     logger = logging.getLogger('TexText')
     logger.setLevel(logging.DEBUG)
     ch = logging.StreamHandler()
-    ch.setLevel(logging.INFO)
-    formatter = logging.Formatter('[%(name)s][%(levelname)6s]: %(message)s')
-    ch.setFormatter(formatter)
+    ch.setLevel(logging.INFO if not args.verbose else logging.DEBUG)
+    ch_formatter = TexTextLogFormatter("%(message)s")
+    ch.setFormatter(ch_formatter)
     logger.addHandler(ch)
 
     # Explicit path spec since on Windows working directory must be the python.exe directory
     # which is usually read-only for standard users
-    fh = logging.FileHandler(os.path.join(os.path.dirname(__file__), "textextsetup.log"))
-    fh.setLevel(ch.level)
-    fh.setFormatter(formatter)
+    fh = logging.FileHandler(os.path.join(os.path.dirname(__file__), "textextsetup.log"), mode="w")
+    fh.setLevel(logging.DEBUG)
+    fh_formatter = logging.Formatter("[%(name)s][%(levelname)6s]: %(message)s")
+    fh.setFormatter(fh_formatter)
     logger.addHandler(fh)
 
+    logger.info("Installing TexText with the following arguments:")
+    logger.info("".join(f"{key}: {value}, " for key, value in vars(args).items())[:-2])
+
     # Address special Portable Apps directory structure
     if args.portable_apps_dir:
         if not os.path.isdir(args.portable_apps_dir):
@@ -362,13 +383,7 @@ def remove_previous_installation(extension_dir):
 
     checker = TexTextRequirementsChecker(logger, settings)
 
-    for executable_name in [
-                                "inkscape",
-                                "lualatex",
-                                "pdflatex",
-                                "xelatex",
-                                "typst",
-                            ]:
+    for executable_name in ["inkscape", "lualatex", "pdflatex", "xelatex", "typst"]:
         executable_path = getattr(args, "%s_executable" % executable_name)
         if executable_path is not None:
             if not checker.check_executable(executable_path):
@@ -382,16 +397,12 @@ def remove_previous_installation(extension_dir):
     if not args.skip_requirements_check:
 
         check_result = checker.check()
-        if check_result == None:
-            logger.error("Automatic requirements check is incomplete")
-            logger.error("Please check requirements list manually and run:")
-            logger.error(" ".join(sys.argv + ["--skip-requirements-check"]))
-            exit(EXIT_REQUIREMENT_CHECK_UNKNOWN)
-
-        if check_result == False:
+        if not check_result:
             logger.error("Automatic requirements check found issue")
             logger.error("Follow instruction above and run install script again")
-            logger.error("To bypass requirement check pass `--skip-requirements-check` to setup.py")
+            logger.error("--> To bypass requirement check and force installation of TexText")
+            logger.error("--> pass the `--skip-requirements-check` option to setup.py:")
+            logger.error("--> setup.py --skip-requirements-check")
             exit(EXIT_REQUIREMENT_CHECK_FAILED)
 
     if not args.skip_extension_install:
@@ -441,14 +452,15 @@ def remove_previous_installation(extension_dir):
             args.inkscape_extensions_path = os.path.expanduser(args.inkscape_extensions_path)
 
         if args.keep_previous_installation_files is None:
+            logger.debug("Checking for previous installation files which have been modified by the user")
             found_files_to_keep = {}
             for old_filename, new_filename in files_to_keep.items():
                 if not os.path.isfile(os.path.join(args.inkscape_extensions_path, old_filename)):
                     logger.debug("%s not found" % old_filename)
                 else:
                     logger.debug("%s found" % old_filename)
                     if not os.path.isfile(os.path.join("extension", new_filename)):
-                        logger.info("`%s` is not found in distribution, keep old file" % new_filename)
+                        logger.debug("`%s` is not found in distribution, keep old file" % new_filename)
                         found_files_to_keep[old_filename] = new_filename
                         continue
                     with open(os.path.join(args.inkscape_extensions_path, old_filename)) as f_old, \
@@ -465,7 +477,7 @@ def remove_previous_installation(extension_dir):
                 file_s = "file" if len(found_files_to_keep) == 1 else "files"
                 for old_filename, new_filename in found_files_to_keep.items():
                     if os.path.isfile(os.path.join("extension", new_filename)):
-                        logger.warn("Existing `%s` differs from newer version in distribution" % old_filename)
+                        logger.warning("Existing `%s` differs from newer version in distribution" % old_filename)
                         if query_yes_no("Keep `%s` from previous installation?" % old_filename):
                             files_to_keep[old_filename] = new_filename
 
@@ -481,6 +493,7 @@ def remove_previous_installation(extension_dir):
                            rel_filenames=files_to_keep,
                            tmp_dir=tmp_dir
                            ):
+            logger.info(f"Starting installation of TexText into {args.inkscape_extensions_path}...")
             source_path = os.path.dirname(os.path.abspath(__file__))
             if os.path.dirname(source_path) == args.inkscape_extensions_path:
                 logger.error("Can't install extension from itself")
@@ -491,6 +504,16 @@ def remove_previous_installation(extension_dir):
                 dst=args.inkscape_extensions_path,
                 if_already_exists="overwrite"
             )
+
+        if args.use_tk:
+            logger.info("Force usage of Tk Interface (tkinter), setting 'gui_toolkit' to 'tk'")
+            settings["gui"]["toolkit"] = "tk"
+        else:
+            try:
+                del(settings["gui"]["toolkit"])
+            except (KeyError, TypeError) as _:
+                pass
+
         settings.save()
 
     logger.log(SUCCESS, "--> TexText has been SUCCESSFULLY installed on your system <--")
diff --git a/test_installation_script.py b/test_installation_script.py
@@ -47,9 +47,8 @@ def __call__(self, name, output="", channel='stdout'):
         command_name = os.path.join(self.dirname, name)
         with open(command_name, "w") as fout:
             fout.write("#!%s\n" % sys.executable)
-            fout.write("from __future__ import print_function\n")
             fout.write("import sys\n")
-            fout.write("print(%s, file=sys.%s)" % (repr(output), channel))
+            fout.write(f"print({repr(output)}, file=sys.{channel})")
         os.chmod(command_name, 0o755)
 
 
@@ -71,15 +70,18 @@ def test_configuration(fake_commands, expected_exit_code):
 
 
 REQUIREMENT_CHECK_SUCCESS = 0
-REQUIREMENT_CHECK_UNKNOWN = 64
 REQUIREMENT_CHECK_ERROR = 65
 
 good_configurations = []
 
-# Definition of working combinations of Inkscape and LaTeX
-for latex in [("pdflatex",), ("lualatex",), ("xelatex",)]:
+# Definition of working combinations of Inkscape (without release number) and LaTeX
+for latex in [("pdflatex",), ("lualatex",), ("xelatex",), ("typst",)]:
     good_configurations.append([("inkscape", "Inkscape 1.4 (1:1.4+202410161351+e7c3feb100)"), latex])
 
+# Definition of working combinations of Inkscape (with release number) and LaTeX
+for latex in [("pdflatex",), ("lualatex",), ("xelatex",), ("typst",)]:
+    good_configurations.append([("inkscape", "Inkscape 1.4.2 (1:1.4.2+202505120737+ebf0e940d0)"), latex])
+
 # Test: Installation of working combinations must succeed
 for good_configuration in good_configurations:
     test_configuration(good_configuration, REQUIREMENT_CHECK_SUCCESS)
@@ -98,6 +100,11 @@ def test_configuration(fake_commands, expected_exit_code):
     ("inkscape", "Inkscape 0.92.3 (2405546, 2018-03-11)"),
 ], REQUIREMENT_CHECK_ERROR)
 
+# Test wrong Inkscape version and no pdflatex installed
+test_configuration([
+    ("inkscape", "Inkscape 1.3.2 (1:1.4+202410161351+e7c3feb100)"),
+], REQUIREMENT_CHECK_ERROR)
+
 # Test wrong Inkscape version and pdflatex installed
 test_configuration([
     ("inkscape", "Inkscape 0.92.3 (2405546, 2018-03-11)"),
@@ -109,7 +116,7 @@ def test_configuration(fake_commands, expected_exit_code):
 test_configuration([
     ("inkscape",),
     ("pdflatex",),
-], REQUIREMENT_CHECK_UNKNOWN)
+], REQUIREMENT_CHECK_ERROR)
 
 # Test: Nothing is installed -> Installation must fail
 test_configuration([
diff --git a/textext/requirements_check.py b/textext/requirements_check.py
