ruyi 0.44.0b20251219__py3-none-any.whl → 0.45.0__py3-none-any.whl

ruyi/__main__.py

@@ -1,9 +1,11 @@
 #!/usr/bin/env python3
 
 import os
+import pathlib
 import sys
 
 import ruyi
+from ruyi.i18n import _, ADAPTER
 from ruyi.utils.ci import is_running_in_ci
 from ruyi.utils.global_mode import (
     EnvGlobalModeProvider,
@@ -41,6 +43,8 @@ def _is_allowed_to_run_as_root() -> bool:
 
 def entrypoint() -> None:
     gm = EnvGlobalModeProvider(os.environ, sys.argv)
+    ADAPTER.init_from_env(os.environ)
+    ADAPTER.hook()
 
     # NOTE: import of `ruyi.log` takes ~90ms on my machine, so initialization
     # of logging is deferred as late as possible
@@ -50,11 +54,16 @@ def entrypoint() -> None:
 
         logger = RuyiConsoleLogger(gm)
 
-        logger.F("refusing to run as super user outside CI without explicit consent")
+        logger.F(_("refusing to run as super user outside CI without explicit consent"))
 
         choices = ", ".join(f"'{x}'" for x in TRUTHY_ENV_VAR_VALUES)
         logger.I(
-            f"re-run with environment variable [yellow]{ENV_FORCE_ALLOW_ROOT}[/] set to one of [yellow]{choices}[/] to signify consent"
+            _(
+                "re-run with environment variable [yellow]{env_var}[/] set to one of [yellow]{choices}[/] to signify consent"
+            ).format(
+                env_var=ENV_FORCE_ALLOW_ROOT,
+                choices=choices,
+            )
         )
         sys.exit(1)
 
@@ -63,7 +72,7 @@ def entrypoint() -> None:
 
         logger = RuyiConsoleLogger(gm)
 
-        logger.F("no argv?")
+        logger.F(_("no argv?"))
         sys.exit(1)
 
     if gm.is_packaged and ruyi.__compiled__.standalone:
@@ -85,8 +94,11 @@ def entrypoint() -> None:
     #
     # we assume the one-file build if Nuitka is detected; sys.argv[0] does NOT
     # work if it's just `ruyi` so we have to check our parent process in that case
-    self_exe = get_nuitka_self_exe() if gm.is_packaged else __file__
     sys.argv[0] = get_argv0()
+    if gm.is_packaged:
+        self_exe = get_nuitka_self_exe()
+    else:
+        self_exe = str(pathlib.Path(sys.argv[0]).resolve())
     gm.record_self_exe(sys.argv[0], __file__, self_exe)
 
     from ruyi.config import GlobalConfig

ruyi/cli/cmd.py

@@ -1,6 +1,7 @@
 import argparse
 from typing import Callable, IO, Protocol, TYPE_CHECKING
 
+from ..i18n import _
 from . import RUYI_ENTRYPOINT_NAME
 
 if TYPE_CHECKING:
@@ -114,7 +115,7 @@ class BaseCommand:
             return
 
         sp = p.add_subparsers(
-            title="subcommands",
+            title=_("subcommands"),
             required=cls.is_subcommand_required,
         )
         for subcmd_cls in cls.parsers:
@@ -158,7 +159,7 @@ class RootCommand(
     has_subcommands=True,
     has_main=True,
     prog=RUYI_ENTRYPOINT_NAME,
-    description="RuyiSDK Package Manager",
+    description=_("RuyiSDK Package Manager"),
 ):
     @classmethod
     def configure_args(cls, gc: "GlobalConfig", p: "ArgumentParser") -> None:
@@ -170,12 +171,12 @@ class RootCommand(
             action="store_const",
             dest="func",
             const=cli_version,
-            help="Print version information",
+            help=_("Print version information"),
         )
         p.add_argument(
             "--porcelain",
             action="store_true",
-            help="Give the output in a machine-friendly format if applicable",
+            help=_("Give the output in a machine-friendly format if applicable"),
         )
 
         # https://github.com/python/cpython/issues/67037 prevents the registration
@@ -219,7 +220,7 @@ class AdminCommand(
     has_subcommands=True,
     # https://github.com/python/cpython/issues/67037
     # help=argparse.SUPPRESS,
-    help="(NOT FOR REGULAR USERS) Subcommands for managing Ruyi repos",
+    help=_("(NOT FOR REGULAR USERS) Subcommands for managing Ruyi repos"),
 ):
     @classmethod
     def configure_args(cls, gc: "GlobalConfig", p: "ArgumentParser") -> None:

ruyi/cli/config_cli.py

@@ -1,6 +1,7 @@
 import argparse
 from typing import TYPE_CHECKING
 
+from ..i18n import _
 from .cmd import RootCommand
 
 if TYPE_CHECKING:
@@ -13,7 +14,7 @@ class ConfigCommand(
     RootCommand,
     cmd="config",
     has_subcommands=True,
-    help="Manage Ruyi's config options",
+    help=_("Manage Ruyi's config options"),
 ):
     @classmethod
     def configure_args(
@@ -27,7 +28,7 @@ class ConfigCommand(
 class ConfigGetCommand(
     ConfigCommand,
     cmd="get",
-    help="Query the value of a Ruyi config option",
+    help=_("Query the value of a Ruyi config option"),
 ):
     @classmethod
     def configure_args(
@@ -38,7 +39,7 @@ class ConfigGetCommand(
         p.add_argument(
             "key",
             type=str,
-            help="The Ruyi config option to query",
+            help=_("The Ruyi config option to query"),
         )
 
     @classmethod
@@ -66,7 +67,7 @@ class ConfigGetCommand(
 class ConfigSetCommand(
     ConfigCommand,
     cmd="set",
-    help="Set the value of a Ruyi config option",
+    help=_("Set the value of a Ruyi config option"),
 ):
     @classmethod
     def configure_args(
@@ -77,12 +78,12 @@ class ConfigSetCommand(
         p.add_argument(
             "key",
             type=str,
-            help="The Ruyi config option to set",
+            help=_("The Ruyi config option to set"),
         )
         p.add_argument(
             "value",
             type=str,
-            help="The value to set the option to",
+            help=_("The value to set the option to"),
         )
 
     @classmethod
@@ -100,7 +101,9 @@ class ConfigSetCommand(
                 ed.set_value(key, pyval)
             except ProtectedGlobalConfigError:
                 cfg.logger.F(
-                    f"the config [yellow]{key}[/] is protected and not meant to be overridden by users",
+                    _(
+                        "the config [yellow]{key}[/] is protected and not meant to be overridden by users"
+                    ).format(key=key)
                 )
                 return 2
 
@@ -112,7 +115,7 @@ class ConfigSetCommand(
 class ConfigUnsetCommand(
     ConfigCommand,
     cmd="unset",
-    help="Unset a Ruyi config option",
+    help=_("Unset a Ruyi config option"),
 ):
     @classmethod
     def configure_args(
@@ -123,7 +126,7 @@ class ConfigUnsetCommand(
         p.add_argument(
             "key",
             type=str,
-            help="The Ruyi config option to unset",
+            help=_("The Ruyi config option to unset"),
         )
 
     @classmethod
@@ -142,7 +145,7 @@ class ConfigUnsetCommand(
 class ConfigRemoveSectionCommand(
     ConfigCommand,
     cmd="remove-section",
-    help="Remove a section from the Ruyi config",
+    help=_("Remove a section from the Ruyi config"),
 ):
     @classmethod
     def configure_args(
@@ -153,7 +156,7 @@ class ConfigRemoveSectionCommand(
         p.add_argument(
             "section",
             type=str,
-            help="The section to remove",
+            help=_("The section to remove"),
         )
 
     @classmethod

ruyi/cli/main.py

@@ -4,6 +4,7 @@ import sys
 from typing import Final, TYPE_CHECKING
 
 from ..config import GlobalConfig
+from ..i18n import _
 from ..telemetry.scope import TelemetryScope
 from ..utils.global_mode import GlobalModeProvider
 from ..version import RUYI_SEMVER
@@ -50,10 +51,19 @@ def main(gm: GlobalModeProvider, gc: GlobalConfig, argv: list[str]) -> int:
     if not is_called_as_ruyi(gm.argv0):
         if should_prompt_for_renaming(gm.argv0):
             logger.F(
-                f"the {RUYI_ENTRYPOINT_NAME} executable must be named [green]'{RUYI_ENTRYPOINT_NAME}'[/] to work"
+                _(
+                    "the {ruyi_exe} executable must be named [green]'{expected_name}'[/] to work"
+                ).format(
+                    ruyi_exe=RUYI_ENTRYPOINT_NAME,
+                    expected_name=RUYI_ENTRYPOINT_NAME,
+                )
             )
-            logger.I(f"it is now [yellow]'{gm.argv0}'[/]")
-            logger.I("please rename the command file and retry")
+            logger.I(
+                _("it is now [yellow]'{current_name}'[/]").format(
+                    current_name=gm.argv0,
+                )
+            )
+            logger.I(_("please rename the command file and retry"))
             return 1
 
         from ..mux.runtime import mux_main
@@ -115,7 +125,7 @@ def main(gm: GlobalModeProvider, gc: GlobalConfig, argv: list[str]) -> int:
     try:
         telemetry_key: str = args.tele_key
     except AttributeError:
-        logger.F("internal error: CLI entrypoint was added without a telemetry key")
+        logger.F(_("internal error: CLI entrypoint was added without a telemetry key"))
         return 1
 
     # Special-case the `--output-completion-script` argument; treat it as if

ruyi/cli/oobe.py

@@ -2,13 +2,16 @@
 
 import os
 import sys
-from typing import Callable, TYPE_CHECKING
+from typing import Callable, Final, TYPE_CHECKING
+
+from ..i18n import _, d_
 
 if TYPE_CHECKING:
     from ..config import GlobalConfig
 
 
-SHELL_AUTO_COMPLETION_TIP = """
+SHELL_AUTO_COMPLETION_TIP: Final = d_(
+    """
 [bold green]tip[/]: you can enable shell auto-completion for [yellow]ruyi[/] by adding the
 following line to your [green]{shrc}[/], if you have not done so already:
 
@@ -18,6 +21,7 @@ You can do so by running the following command later:
 
     [green]echo 'eval "$(ruyi --output-completion-script={shell})"' >> {shrc}[/]
 """
+)
 
 
 class OOBE:
@@ -74,7 +78,7 @@ class OOBE:
             return
 
         self._gc.logger.stdout(
-            SHELL_AUTO_COMPLETION_TIP.format(
+            _(SHELL_AUTO_COMPLETION_TIP).format(
                 shell=shell,
                 shrc=f"~/.{shell}rc",
             )

ruyi/cli/self_cli.py

@@ -4,13 +4,16 @@ import pathlib
 import shutil
 from typing import Final, TYPE_CHECKING
 
+from ..i18n import _, d_
 from .cmd import RootCommand
 
 if TYPE_CHECKING:
     from .completion import ArgumentParser
     from .. import config
 
-UNINSTALL_NOTICE: Final = """
+
+UNINSTALL_NOTICE: Final = d_(
+    """
 [bold]Thanks for hacking with [yellow]Ruyi[/]![/]
 
 This will uninstall [yellow]Ruyi[/] from your system, and optionally remove
@@ -21,6 +24,7 @@ Note that your [yellow]Ruyi[/] virtual environments [bold]will become unusable[/
 [yellow]Ruyi[/] is uninstalled. You should take care of migrating or cleaning
 them yourselves afterwards.
 """
+)
 
 
 # Self-management commands
@@ -28,7 +32,7 @@ class SelfCommand(
     RootCommand,
     cmd="self",
     has_subcommands=True,
-    help="Manage this Ruyi installation",
+    help=_("Manage this Ruyi installation"),
 ):
     @classmethod
     def configure_args(
@@ -42,7 +46,7 @@ class SelfCommand(
 class SelfCleanCommand(
     SelfCommand,
     cmd="clean",
-    help="Remove various Ruyi-managed data to reclaim storage",
+    help=_("Remove various Ruyi-managed data to reclaim storage"),
 ):
     @classmethod
     def configure_args(
@@ -54,42 +58,42 @@ class SelfCleanCommand(
             "--quiet",
             "-q",
             action="store_true",
-            help="Do not print out the actions being performed",
+            help=_("Do not print out the actions being performed"),
         )
         p.add_argument(
             "--all",
             action="store_true",
-            help="Remove all covered data",
+            help=_("Remove all covered data"),
         )
         p.add_argument(
             "--distfiles",
             action="store_true",
-            help="Remove all downloaded distfiles if any",
+            help=_("Remove all downloaded distfiles if any"),
         )
         p.add_argument(
             "--installed-pkgs",
             action="store_true",
-            help="Remove all installed packages if any",
+            help=_("Remove all installed packages if any"),
         )
         p.add_argument(
             "--news-read-status",
             action="store_true",
-            help="Mark all news items as unread",
+            help=_("Mark all news items as unread"),
         )
         p.add_argument(
             "--progcache",
             action="store_true",
-            help="Clear the Ruyi program cache",
+            help=_("Clear the Ruyi program cache"),
         )
         p.add_argument(
             "--repo",
             action="store_true",
-            help="Remove the Ruyi repo if located in Ruyi-managed cache directory",
+            help=_("Remove the Ruyi repo if located in Ruyi-managed cache directory"),
         )
         p.add_argument(
             "--telemetry",
             action="store_true",
-            help="Remove all telemetry data recorded if any",
+            help=_("Remove all telemetry data recorded if any"),
         )
 
     @classmethod
@@ -122,9 +126,11 @@ class SelfCleanCommand(
                 telemetry,
             ]
         ):
-            logger.F("no data specified for cleaning")
+            logger.F(_("no data specified for cleaning"))
             logger.I(
-                "please check [yellow]ruyi self clean --help[/] for a list of cleanable data"
+                _(
+                    "please check [yellow]ruyi self clean --help[/] for a list of cleanable data"
+                )
             )
             return 1
 
@@ -149,7 +155,7 @@ class SelfCleanCommand(
 class SelfUninstallCommand(
     SelfCommand,
     cmd="uninstall",
-    help="Uninstall Ruyi",
+    help=_("Uninstall Ruyi"),
 ):
     @classmethod
     def configure_args(
@@ -160,13 +166,15 @@ class SelfUninstallCommand(
         p.add_argument(
             "--purge",
             action="store_true",
-            help="Remove all installed packages and Ruyi-managed remote repo data",
+            help=_("Remove all installed packages and Ruyi-managed remote repo data"),
         )
         p.add_argument(
             "-y",
             action="store_true",
             dest="consent",
-            help="Give consent for uninstallation on CLI; do not ask for confirmation",
+            help=_(
+                "Give consent for uninstallation on CLI; do not ask for confirmation"
+            ),
         )
 
     @classmethod
@@ -180,24 +188,28 @@ class SelfUninstallCommand(
 
         if cfg.is_installation_externally_managed:
             logger.F(
-                "this [yellow]ruyi[/] is externally managed, for example, by the system package manager, and cannot be uninstalled this way"
+                _(
+                    "this [yellow]ruyi[/] is externally managed, for example, by the system package manager, and cannot be uninstalled this way"
+                )
             )
-            logger.I("please uninstall via the external manager instead")
+            logger.I(_("please uninstall via the external manager instead"))
             return 1
 
         if not cfg.is_packaged:
             logger.F(
-                "this [yellow]ruyi[/] is not in standalone form, and cannot be uninstalled this way"
+                _(
+                    "this [yellow]ruyi[/] is not in standalone form, and cannot be uninstalled this way"
+                )
             )
             return 1
 
         if not consent:
-            logger.stdout(UNINSTALL_NOTICE)
-            if not user_input.ask_for_yesno_confirmation(logger, "Continue?"):
-                logger.I("aborting uninstallation")
+            logger.stdout(_(UNINSTALL_NOTICE))
+            if not user_input.ask_for_yesno_confirmation(logger, _("Continue?")):
+                logger.I(_("aborting uninstallation"))
                 return 0
         else:
-            logger.I("uninstallation consent given over CLI, proceeding")
+            logger.I(_("uninstallation consent given over CLI, proceeding"))
 
         _do_reset(
             cfg,
@@ -208,7 +220,7 @@ class SelfUninstallCommand(
             self_binary=True,
         )
 
-        logger.I("[yellow]ruyi[/] is uninstalled")
+        logger.I(_("[yellow]ruyi[/] is uninstalled"))
 
         return 0
 
@@ -235,7 +247,7 @@ def _do_reset(
         logger.I(s)
 
     if installed_pkgs:
-        status("removing installed packages")
+        status(_("removing installed packages"))
         shutil.rmtree(cfg.data_root, True)
         cfg.ruyipkg_global_state.purge_installation_info()
 
@@ -244,28 +256,28 @@ def _do_reset(
         cfg.telemetry.discard_events(True)
 
     if all_state:
-        status("removing state data")
+        status(_("removing state data"))
         shutil.rmtree(cfg.state_root, True)
     else:
         if news_read_status:
-            status("removing read status of news items")
+            status(_("removing read status of news items"))
             cfg.news_read_status.remove()
 
         if telemetry:
-            status("removing all telemetry data")
+            status(_("removing all telemetry data"))
             shutil.rmtree(cfg.telemetry_root, True)
 
     if all_cache:
-        status("removing cached data")
+        status(_("removing cached data"))
         shutil.rmtree(cfg.cache_root, True)
     else:
         if distfiles:
-            status("removing downloaded distfiles")
+            status(_("removing downloaded distfiles"))
             # TODO: deduplicate the path derivation
             shutil.rmtree(os.path.join(cfg.cache_root, "distfiles"), True)
 
         if progcache:
-            status("clearing the Ruyi program cache")
+            status(_("clearing the Ruyi program cache"))
             # TODO: deduplicate the path derivation
             shutil.rmtree(os.path.join(cfg.cache_root, "progcache"), True)
 
@@ -283,14 +295,16 @@ def _do_reset(
 
             if not repo_is_below_cache_root:
                 logger.W(
-                    "not removing the Ruyi repo: it is outside of the Ruyi cache directory"
+                    _(
+                        "not removing the Ruyi repo: it is outside of the Ruyi cache directory"
+                    )
                 )
             else:
-                status("removing the Ruyi repo")
+                status(_("removing the Ruyi repo"))
                 shutil.rmtree(repo_dir, True)
 
     if self_binary:
-        status("removing the ruyi binary")
+        status(_("removing the ruyi binary"))
         try:
             os.unlink(cfg.self_exe)
         except FileNotFoundError:

ruyi/cli/user_input.py

@@ -1,5 +1,6 @@
 import os.path
 
+from ..i18n import _
 from ..log import RuyiLogger
 
 
@@ -10,7 +11,7 @@ def pause_before_continuing(
 
     EOFError should be handled by the caller."""
 
-    logger.stdout("Press [green]<ENTER>[/] to continue: ", end="")
+    logger.stdout(_("Press [green]<ENTER>[/] to continue: "), end="")
     input()
 
 
@@ -26,9 +27,11 @@ def ask_for_yesno_confirmation(
             logger.stdout(f"{prompt} {choices_help} ", end="")
             user_input = input()
         except EOFError:
-            yesno = "YES" if default else "NO"
+            yesno = _("YES") if default else _("NO")
             logger.W(
-                f"EOF while reading user input, assuming the default choice {yesno}"
+                _(
+                    "EOF while reading user input, assuming the default choice {yesno}"
+                ).format(yesno=yesno)
             )
             return default
 
@@ -39,8 +42,12 @@ def ask_for_yesno_confirmation(
         if user_input in {"N", "n", "no"}:
             return False
         else:
-            logger.stdout(f"Unrecognized input [yellow]'{user_input}'[/].")
-            logger.stdout("Accepted choices: Y/y/yes for YES, N/n/no for NO.")
+            logger.stdout(
+                _("Unrecognized input [yellow]'{user_input}'[/].").format(
+                    user_input=user_input
+                )
+            )
+            logger.stdout(_("Accepted choices: Y/y/yes for YES, N/n/no for NO."))
 
 
 def ask_for_kv_choice(
@@ -81,12 +88,19 @@ def ask_for_choice(
     if default_idx is not None:
         if not (0 <= default_idx < nr_choices):
             raise ValueError(f"Default choice index {default_idx} out of range")
-        choices_help = f"(1-{nr_choices}, default {default_idx + 1})"
+        choices_help = _("(1-{nr_choices}, default {default})").format(
+            nr_choices=nr_choices,
+            default=default_idx + 1,
+        )
     else:
-        choices_help = f"(1-{nr_choices})"
+        choices_help = _("(1-{nr_choices})").format(nr_choices=nr_choices)
     while True:
         try:
-            user_input = input(f"Choice? {choices_help} ")
+            user_input = input(
+                _("Choice? {choices_help} ").format(
+                    choices_help=choices_help,
+                )
+            )
         except EOFError:
             raise ValueError("EOF while reading user choice")
 
@@ -96,18 +110,34 @@ def ask_for_choice(
         try:
             choice_int = int(user_input)
         except ValueError:
-            logger.stdout(f"Unrecognized input [yellow]'{user_input}'[/].")
             logger.stdout(
-                f"Accepted choices: an integer number from 1 to {nr_choices} inclusive."
+                _("Unrecognized input [yellow]'{user_input}'[/].").format(
+                    user_input=user_input,
+                )
+            )
+            logger.stdout(
+                _(
+                    "Accepted choices: an integer number from 1 to {nr_choices} inclusive."
+                ).format(
+                    nr_choices=nr_choices,
+                )
             )
             continue
 
         if 1 <= choice_int <= nr_choices:
             return choice_int - 1
 
-        logger.stdout(f"Out-of-range input [yellow]'{user_input}'[/].")
         logger.stdout(
-            f"Accepted choices: an integer number from 1 to {nr_choices} inclusive."
+            _("Out-of-range input [yellow]'{user_input}'[/].").format(
+                user_input=user_input,
+            )
+        )
+        logger.stdout(
+            _(
+                "Accepted choices: an integer number from 1 to {nr_choices} inclusive."
+            ).format(
+                nr_choices=nr_choices,
+            )
         )
 
 

ruyi/cli/version_cli.py

@@ -1,6 +1,7 @@
 import argparse
 from typing import TYPE_CHECKING
 
+from ..i18n import _
 from .cmd import RootCommand
 
 if TYPE_CHECKING:
@@ -11,7 +12,7 @@ if TYPE_CHECKING:
 class VersionCommand(
     RootCommand,
     cmd="version",
-    help="Print version information",
+    help=_("Print version information"),
 ):
     @classmethod
     def configure_args(cls, gc: "GlobalConfig", p: "ArgumentParser") -> None:
@@ -27,19 +28,24 @@ def cli_version(cfg: "GlobalConfig", args: argparse.Namespace) -> int:
     from ..ruyipkg.host import get_native_host
     from ..version import COPYRIGHT_NOTICE, MPL_REDIST_NOTICE, RUYI_SEMVER
 
-    print(f"Ruyi {RUYI_SEMVER}\n\nRunning on {get_native_host()}.")
+    print(
+        _("Ruyi {version}\n\nRunning on {host}.").format(
+            version=RUYI_SEMVER,
+            host=get_native_host(),
+        )
+    )
 
     if cfg.is_installation_externally_managed:
-        print("This Ruyi installation is externally managed.")
+        print(_("This Ruyi installation is externally managed."))
 
     print()
 
-    cfg.logger.stdout(COPYRIGHT_NOTICE)
+    cfg.logger.stdout(_(COPYRIGHT_NOTICE))
 
     # Output the MPL notice only when we actually bundle and depend on the
     # MPL component(s), which right now is only certifi. Keep the condition
     # synced with __main__.py.
     if hasattr(ruyi, "__compiled__") and ruyi.__compiled__.standalone:
-        cfg.logger.stdout(MPL_REDIST_NOTICE)
+        cfg.logger.stdout(_(MPL_REDIST_NOTICE))
 
     return 0