Merge pull request #2421 from zas/get_rid_of_custom_builtins

PICARD-2870: Get rid of monkeypatched gettext-related builtins

.pylintrc

@@ -283,8 +283,7 @@ min-similarity-lines=4
 
 # List of additional names supposed to be defined in builtins. Remember that
 # you should avoid defining new builtins when possible.
-additional-builtins=_, N_, ngettext, gettext_attributes, pgettext_attributes,
-                    gettext_constants, gettext_countries
+additional-builtins=
 
 # Tells whether unused global variables should be treated as a violation.
 allow-global-unused-variables=yes

picard/acoustid/__init__.py

@@ -43,6 +43,7 @@
 )
 from picard.const.sys import IS_WIN
 from picard.file import File
+from picard.i18n import N_
 from picard.util import (
     find_executable,
     win_prefix_longpath,

picard/acoustid/manager.py

@@ -29,6 +29,7 @@
 from PyQt6 import QtCore
 
 from picard import log
+from picard.i18n import N_
 from picard.util import load_json
 
 

picard/album.py

@@ -59,6 +59,10 @@
 from picard.const import VARIOUS_ARTISTS_ID
 from picard.dataobj import DataObject
 from picard.file import File
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
 from picard.mbjson import (
     medium_to_metadata,
     release_group_to_metadata,

picard/browser/addrelease.py

@@ -28,6 +28,7 @@
 from PyQt6.QtCore import QCoreApplication
 
 from picard import log
+from picard.i18n import gettext as _
 from picard.util import format_time
 from picard.util.mbserver import build_submission_url
 from picard.util.webbrowser2 import open

picard/cluster.py

@@ -46,6 +46,10 @@
 
 from picard.config import get_config
 from picard.file import File
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
 from picard.metadata import (
     Metadata,
     SimMatchRelease,

picard/collection.py

@@ -30,6 +30,10 @@
 
 from picard import log
 from picard.config import get_config
+from picard.i18n import (
+    N_,
+    ngettext,
+)
 from picard.webservice.api_helpers import MBAPIHelper
 
 

picard/config_upgrade.py

@@ -52,6 +52,10 @@
     DEFAULT_SCRIPT_NAME,
 )
 from picard.const.sys import IS_FROZEN
+from picard.i18n import (
+    gettext as _,
+    gettext_constants,
+)
 from picard.util import unique_numbered_title
 from picard.version import (
     Version,

picard/const/__init__.py

@@ -32,16 +32,12 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
 
-import builtins
 from collections import OrderedDict
 
 from picard import PICARD_VERSION
 from picard.const import appdirs
 from picard.const.attributes import MB_ATTRIBUTES
-
-
-# Install gettext "noop" function in case const.py gets imported directly.
-builtins.__dict__['N_'] = lambda a: a
+from picard.i18n import N_
 
 
 # Config directory

picard/const/languages.py

@@ -22,6 +22,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
+from picard.i18n import N_
+
 
 # List of available user interface languages
 UI_LANGUAGES = [

picard/const/locales.py

@@ -21,6 +21,8 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
+from picard.i18n import N_
+
 
 # List of alias locales
 ALIAS_LOCALES = {

picard/const/scripts.py

@@ -20,6 +20,11 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
+
 
 # List of available scripts (character sets)
 SCRIPTS = {

picard/coverart/__init__.py

@@ -40,6 +40,7 @@
     CoverArtProvider,
     cover_art_providers,
 )
+from picard.i18n import N_
 from picard.metadata import register_album_metadata_processor
 
 

picard/coverart/providers/caa.py

@@ -59,6 +59,10 @@
     CAA_TYPES,
     translate_caa_type,
 )
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
 from picard.webservice import ratecontrol
 
 from picard.ui.caa_types_selector import display_caa_types_selector

picard/coverart/providers/caa_release_group.py

@@ -26,6 +26,7 @@
     CaaThumbnailCoverArtImage,
 )
 from picard.coverart.providers.caa import CoverArtProviderCaa
+from picard.i18n import N_
 
 
 class CaaCoverArtImageRg(CaaCoverArtImage):

picard/coverart/providers/local.py

@@ -35,6 +35,7 @@
     ProviderOptions,
 )
 from picard.coverart.utils import CAA_TYPES
+from picard.i18n import N_
 
 from picard.ui.ui_provider_options_local import Ui_LocalOptions
 

picard/coverart/providers/urlrels.py

@@ -28,6 +28,7 @@
 from picard import log
 from picard.coverart.image import CoverArtImage
 from picard.coverart.providers.provider import CoverArtProvider
+from picard.i18n import N_
 
 
 class CoverArtProviderUrlRelationships(CoverArtProvider):

picard/coverart/utils.py

@@ -25,6 +25,11 @@
 from enum import IntEnum
 
 from picard.const import MB_ATTRIBUTES
+from picard.i18n import (
+    N_,
+    gettext as _,
+    pgettext_attributes,
+)
 
 
 # list of types from http://musicbrainz.org/doc/Cover_Art/Types

picard/debug_opts.py

@@ -20,6 +20,8 @@
 
 from enum import Enum
 
+from picard.i18n import N_
+
 
 class DebugOptEnum(int, Enum):
     __registry__ = set()

picard/file.py

@@ -71,6 +71,10 @@
     IS_MACOS,
     IS_WIN,
 )
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
 from picard.metadata import (
     Metadata,
     SimMatchTrack,

picard/i18n.py

@@ -21,9 +21,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
-
-import builtins
-import gettext
+import gettext as module_gettext
 import locale
 import os
 
@@ -35,11 +33,16 @@
 )
 
 
-builtins.__dict__['N_'] = lambda a: a
-
-
 _logger = None
 
+_null_translations = module_gettext.NullTranslations()
+_translation = {
+    'main':  _null_translations,
+    'attributes': _null_translations,
+    'constants': _null_translations,
+    'countries': _null_translations,
+}
+
 
 def set_locale_from_env():
     """
@@ -116,10 +119,10 @@ def _try_locales(language):
 def _load_translation(domain, localedir, language):
     try:
         _logger("Loading gettext translation for %s, localedir=%r, language=%r", domain, localedir, language)
-        return gettext.translation(domain, localedir, languages=[language])
+        return module_gettext.translation(domain, localedir, languages=[language])
     except OSError as e:
         _logger(e)
-        return gettext.NullTranslations()
+        return module_gettext.NullTranslations()
 
 
 def _log_lang_env_vars():
@@ -171,20 +174,46 @@ def setup_gettext(localedir, ui_language=None, logger=None):
     _logger("Using locale: %r", current_locale)
     QLocale.setDefault(QLocale(current_locale))
 
-    trans = _load_translation('picard', localedir, language=current_locale)
-    trans_attributes = _load_translation('picard-attributes', localedir, language=current_locale)
-    trans_constants = _load_translation('picard-constants', localedir, language=current_locale)
-    trans_countries = _load_translation('picard-countries', localedir, language=current_locale)
-
-    trans.install(['ngettext'])
-    builtins.__dict__['gettext_attributes'] = trans_attributes.gettext
-    builtins.__dict__['gettext_constants'] = trans_constants.gettext
-    builtins.__dict__['gettext_countries'] = trans_countries.gettext
-    builtins.__dict__['pgettext_attributes'] = trans_attributes.pgettext
-
-    _logger("_ = %r", _)
-    _logger("N_ = %r", N_)
-    _logger("ngettext = %r", ngettext)
-    _logger("gettext_countries = %r", gettext_countries)
-    _logger("gettext_attributes = %r", gettext_attributes)
-    _logger("pgettext_attributes = %r", pgettext_attributes)
+    global _translation
+    _translation = {
+        'main': _load_translation('picard', localedir, language=current_locale),
+        'attributes': _load_translation('picard-attributes', localedir, language=current_locale),
+        'constants': _load_translation('picard-constants', localedir, language=current_locale),
+        'countries': _load_translation('picard-countries', localedir, language=current_locale),
+    }
+    _logger(_translation)
+
+
+def gettext(message: str) -> str:
+    """Translate the messsage using the current translator."""
+    return _translation['main'].gettext(message)
+
+
+def _(message: str) -> str:
+    """Alias for gettext"""
+    return gettext(message)
+
+
+def N_(message: str) -> str:
+    """No-op marker for translatable strings"""
+    return message
+
+
+def ngettext(singular: str, plural: str, n: int) -> str:
+    return _translation['main'].ngettext(singular, plural, n)
+
+
+def pgettext_attributes(context: str, message: str) -> str:
+    return _translation['attributes'].pgettext(context, message)
+
+
+def gettext_attributes(message: str) -> str:
+    return _translation['attributes'].gettext(message)
+
+
+def gettext_countries(message: str) -> str:
+    return _translation['countries'].gettext(message)
+
+
+def gettext_constants(message: str) -> str:
+    return _translation['constants'].gettext(message)

picard/log.py

@@ -48,6 +48,7 @@
     IS_FROZEN,
 )
 from picard.debug_opts import DebugOpt
+from picard.i18n import N_
 
 
 # Get the absolute path for the picard module

picard/oauth.py

@@ -36,6 +36,7 @@
     MUSICBRAINZ_OAUTH_CLIENT_ID,
     MUSICBRAINZ_OAUTH_CLIENT_SECRET,
 )
+from picard.i18n import gettext as _
 from picard.util import (
     build_qurl,
     load_json,

picard/pluginmanager.py

@@ -44,6 +44,10 @@
     USER_PLUGIN_DIR,
 )
 from picard.const.sys import IS_FROZEN
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
 from picard.plugin import (
     _PLUGIN_MODULE_PREFIX,
     PluginData,

picard/profile.py

@@ -28,8 +28,7 @@
     namedtuple,
 )
 
-# Imported to trigger inclusion of N_() in builtins
-from picard import i18n  # noqa: F401,E402 # pylint: disable=unused-import
+from picard.i18n import N_
 
 
 SettingDesc = namedtuple('SettingDesc', ('name', 'fields'))

picard/releasegroup.py

@@ -32,6 +32,11 @@
 
 from picard import log
 from picard.dataobj import DataObject
+from picard.i18n import (
+    N_,
+    gettext as _,
+    pgettext_attributes,
+)
 from picard.mbjson import (
     countries_from_node,
     label_info_from_node,

picard/script/__init__.py

@@ -41,6 +41,10 @@
     DEFAULT_FILE_NAMING_FORMAT,
     DEFAULT_NAMING_PRESET_ID,
 )
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
 from picard.script.functions import (  # noqa: F401 # pylint: disable=unused-import
     register_script_function,
     script_function,

picard/script/functions.py

@@ -45,6 +45,11 @@
 import unicodedata
 
 from picard.const.countries import RELEASE_COUNTRIES
+from picard.i18n import (
+    N_,
+    gettext as _,
+    gettext_countries,
+)
 from picard.metadata import MULTI_VALUED_JOINER
 from picard.script.parser import (
     MultiValue,

picard/script/serializer.py

@@ -43,6 +43,10 @@
     DEFAULT_SCRIPT_NAME,
     SCRIPT_LANGUAGE_VERSION,
 )
+from picard.i18n import (
+    N_,
+    gettext as _,
+)
 from picard.util import make_filename_from_title